Wednesday, April 23, 2014

UCM Archive Auto Replication

Goal 

In UCM we can setup Archive Replication in multiple ways. The push method is the most common method used.


Archive Replication Methods:


    • Archive Replication using the Push Method
    • Archive Replication using the File System
    • Archive Replication Using the Pull method   

This article provides instructions on how to setup Archive Replication between a Source System and a Target system using the Push method of transfer.

Setting up Archive Replication using the Push Method

Archiver can transfer documents between two different content servers. These servers do not need to be the same version. It can also be used when the Source system can talk to the Target but the Target can not talk to the Source because of firewall or network issues.
  •  The Source is the instance that the content is coming from, usually a production instance. An easy way to think of it is that the Source has the information
  • The Target is where the content will end up, usually a development or backup instance. The Target receives the information.

Prerequisite
  • When using Content Server version 6.x or higher the Source box’s IP address needs to be listed on the Target box’s Security Filter, for example:
SocketHostAddressSecurityFilter=127.0.0.1|102.158.*.*|*.*.*.*
  • This can be done in the config.cfg file or by using the System Properties application. Consult the Content Server’s Admin guide for more information on this step.
  • If there is large archive with thousands of documents it is best to test/debug the process using a small archive that has less than 100 documents. Once this process is working move on to the full archive.
  • The system times for the Source and Target Content Servers should be synchronized. This includes the time zones.
  • Archiver should be run as an application not an applet.
Overview of the Steps

There are 7 steps to complete to get the Archive Replication process running.
  1. Create an outgoing provider on the Source.
  2. Create an Archive on the Target.
  3. Create an Archive on the Source.
  4. Perform an initial Export and Transfer of the Archive.
  5. Importing the Archive on the Target.
  6. Setup Auto-Transfer.
  7. Test the replication process.

Outgoing Provider on the Source

The process only needs an outgoing Provider on the Source box. There is no need to setup any providers on the Target box to get this process working.  For performance monitoring of a push transfer, an outgoing provider from the Target Content Server back to the Source Content Server can be created. This “talkback” provider can then notify the Source Content Server when each transfer is complete. A push transfer will work without the talkback provider, but the Source Content Server would not be aware of transfer completion or problems.

1. From the Administration Page select Providers.
2. Under the Action column click Add for the Provider Type of outgoing:


3. Fill in the following Fields:
  • Provider Name = the name of the Target box.
  • Provider Description = this can be anything, use a descriptive . . . description.
The rest of the information is gathered from the config.cfg file on the Target box. This file is located in the /config folder.  The names below are only an example, do not include the words in the parentheses.
  • Server Host Name = TargetSCS62 (your HttpServerAddress)
  • HTTP Server Address = (Leave this field blank)
  • Server Port = 4444 (your IntradocServerPort)
  • Instance Name = Master_on_targetscs62 (your IDC_Name)
  • Relative Web Root = /stellent/ (your HttpRelativeWebRoot – Slash marks included)
Do not change anything below Relative Web Root. Leave the Server Options, Search Options, Required Roles and Account Filter blank.

The following screen shot shows how the provider should look once finished.  This might look different depending on the version of the Content Server being used.


4. Click on the Add button to add the provider.

5. From the Administration page go to the Admin Server then stop and start the Source Server.

6. Go back to the provider page and under the Providers section click the Test link next to the provider you just created.




Create the Archive on the Target

Create the Archive on the Target box first. Now is a good time to check the SocketHostAddressSecurityFilter to make sure it includes the IP address of the Source box.
Open the Archiver on the Target box from the Administration page by clicking the appropriate link.

a. Make sure the local collection is selected.
  • Go to the Options menu and select Open Archive Collection.
  • Choose the local collection. (Probably already selected).
b. Create a new Archive on Target.
  • Select the Edit menu then Add - add the new archive.
  • Enter the Archive Name and a Description.
  • Click OK.
  • Ensure the newly created archive is highlighted in the list of Current Archives.

Select the Transfer To tab in the Transfer Options choose the Edit button.
  • In the Transfer Options window select the Is Targetable check box.
Caution: Do not make the Archive Automated until step 6.

Create the Archive on the Source

On the Source box start the Archiver as an application using Start/Program Files/Stellent Content Server//Applications/Archiver. Login with a user that has Admin rights.
a. Make sure the local collection is selected.
  • Go to the Options menu select Open Archive Collection.
  • Choose the local collection. (Probably already selected).
b. Create a new Archive on SOURCE.
  • Select the Edit menu then Add to add the new archive             

                             
  • Enter the Archive Name, this should be the same as the one created on the Target.
  • Enter a Description.
c. Set the criteria for the query.
  • Select the Export Data Tab. A full export does not need any information in this field. It will export everything.
  • On the Query screen check the box for Export Revisions with Release Date later than most recent Export to create an incremental export.
d. Set up the Source so it can see the archive on the TARGET Content Server. This step is needed so that the Archive on the Target box will show up on the list of available Archives.
Note: Content Server and/or Archiver might need to be restarted at this point. If the new Archive collection does not show up on the list close out Archiver and Restart both Content Servers.
  • Under the Options menu select Open Archive Collection.


  • Select the Browse Proxied button.


  • Select the Target instance in the Proxied Servers section.
  • Select the correct collection in the Collections section.
  • Click OK to close the Browse For Proxied Collection window.
  • Close the Open Archive Collections window.
Now that the Target Archive shows up on the list you need to select the Local, Source Archive again. Follow the steps in d. only this time select the Source Archive.

e. Select the Transfer To tab, in the Transfer Destination section click the Edit button.



f. Highlight the Target Instance in the Collections window then select the Target archive in the Archives window.
g. Click OK.

Perform an initial Export and Transfer

The Export will create the Archive and the Transfer will copy it over to the Target box. This step is done on the Source.

a. Highlight your Archive in the Current Archives window.
b. From the menu select Actions then Export.
c. The Export Archive window will pop up asking if you want to delete revision after successful archive. Do not check this box.



The progress of the archive is reported in percentage completed in the bottom of the Archive window.
d. Click OK to close this window. The status bar will indicate Finished when it’s done creating the Archive.
e. From the menu select Actions then Transfer to move the archive to the Target.
The progress of the transfer is reported in percentage complete in the bottom of the Archive window.

Importing the Archive on the Target

The Archive batch file is now on the Target box, now Import the information into the Content Server.
Note: If the metadata fields do not match between servers you will need to use Field Mapping on the Import Maps Tab.

a. With the correct archive selected, select Actions then Import from the Archiver menu
b. Click OK. The status bar will indicate Finished when done

Setup Auto-Transfer

Auto-Replication should only be turned on once the initial Export, Transfer and Import steps have been completed. After this is turned on any documents checked into the Source or updated on the Source that match the criteria for the Archive will automatically be sent to the Target.

a. On the Source click the Replication tab and in the Registered Exporters section click the Edit button.


b. Check the box for Enable Automated Export.
c. Click the Register button to register the Source instance as an exporter.
d. Click OK to close the window.
e. Select the Transfer To tab then in the Transfer Options section click the Edit buttons.
f. Select the Is Transfer Automated option.
g. Click OK to close the window.

On the Target archive -
a. On the Replication tab in the Registered Importer section click the Register Self button. A message box will pop up, select OK to close that window.

Test the Replication Process

On the Source check-in a new document that matches the Archive Export criteria. Within a few minutes that document should be transferred to the Target. It can take a while for this document to make it over because it has to go through the standard check-in process on two different content servers. A broad overview of the process goes something like this:

  • Check in on the Source system
  • PDF Converter
  • Index
  • Release on Source
  • Create archive batch file on Source
  • Transfer Batch to Target CS
  • Import on Target
  • Index
  • Release on Target