Configuring the IBM InfoSphere Enterprise Records Transfer tool
To configure the IBM InfoSphere Enterprise Records Transfer tool, you need to complete one or all of the following three tasks:
- Configure the IBM InfoSphere Enterprise Records Transfer tool command file. Complete this task if you upgrade your Web application server and you need to specify the Web application server for the IBM InfoSphere Enterprise Records Transfer tool. For details, see the IBM InfoSphere Enterprise Records Installation and Upgrade Guide.
- Specify Content Engine server information. Complete this task if there are changes to the Content Engine server connection information, such as the Content Engine server name, a user name, or password. For details, see Specify Content Engine server information.
- Specify transfer parameters. Complete this task if you need to change the transfer parameters. For example, you want to run IBM InfoSphere Enterprise Records Transfer against a different File Plan Object Store (FPOS), use a different mapping object, change the retrieval batch size, or modify the level of subcategories to include in a transfer. See Specify transfer parameters.
Specify CE server information
- From the command line, open the IBM InfoSphere Enterprise Records Transfer Connection window by executing one of the following commands from the \RMTransfer directory:
Windows: RMTransfer.bat –configure Connection
UNIX: RMTransfer.sh -configure Connection
- In the IBM InfoSphere Enterprise Records Transfer Connection window, provide the relevant data for your site in the following fields:
- Click one of the following:
- Configure to save the changes and close the Records IBM InfoSphere Enterprise Records Transfer Connection window. IBM InfoSphere Enterprise Records Transfer saves the changes to the <RM_install_dir>/RMTransfer/lib/config/RMTransferConnection.xml file.
- Reset to restore the fields to their previous values. IBM InfoSphere Enterprise Records Transfer restores the fields with values saved in the RMTransferConnection.xml file. If this is the initial configuration of the IBM InfoSphere Enterprise Records Transfer tool, the fields are empty.
- Exit to close the IBM InfoSphere Enterprise Records Transfer Connection window without saving any changes.
Specify transfer parameters
- At the command line, open the IBM InfoSphere Enterprise Records Transfer Configuration window by executing one of the following commands from the <rm_install_dir>\RMTransfer directory:
Windows: RMTransfer.bat –configure Configuration
UNIX: RMTransfer.sh -configure Configuration
- In the IBM InfoSphere Enterprise Records Transfer Configuration window, provide the relevant data for your site:
- If you are exporting records or record folders, enter values for the corresponding fields:
- File Plan Object Store - Enter the name of the file plan object store (FPOS) where the IBM InfoSphere Enterprise Records entities to be transferred reside.
- Transfer Mapping Name - Enter the name of the mapping object that the transfer tool will use for exporting the IBM InfoSphere Enterprise Records entities. The mapping object is an XML file that maps user-defined IBM InfoSphere Enterprise Records object properties to the DoD V3 schema. For details about mapping objects, see Transfer Mappings.
- Export Directory Path - Enter the location where the IBM InfoSphere Enterprise Records Transfer tool will save the export XML files.
- Export File Prefix - Enter a prefix to prepend to the name of the export XML file. Because the transfer tool saves the export XML file by using a date and time stamp, a prefix allows you to more easily identify transfers. For example, entering a value of ABC creates the file, R_ABC_20080228145956_0.xml.
- Child Container Level - Enter the level of categories to process. The transfer tool uses this field only when you are processing categories. Enter -1 to include all subcategories in the transfer, or 0 to include only the immediate category records. The default value is -1.
- Retrieval Batch Size - Enter a value relative to the performance requirements at your site. The default is 1000.
- If you are importing, enter values for the corresponding fields
- File Plan Object Store - Enter the name of the file plan object store to which IBM InfoSphere Enterprise Records Transfer will import IBM InfoSphere Enterprise Records entities.
- Transfer Mapping Name - Enter the name of the mapping object that the transfer tool will use for importing the IBM InfoSphere Enterprise Records entities. The mapping object is an XML file that maps Content Engine property names to XML property names. For details about mapping objects, see Transfer Mappings.
- File Plan Name - Enter the name of the file plan into which IBM InfoSphere Enterprise Records Transfer will place the imported records and record folders. The name of the file plan is the containment name in FileNet Enterprise Manager. The default is File Plan.
- Default Record Folder Parent - Enter the GUID or the full path string of a file plan object store record category that the transfer tool uses as the default parent container for imported record folders. The transfer tool uses this default value when an imported record folder’s parent container is either not designated in the XML source file or does not exist on the target file plan object store.
- Default Record Parent - Enter the GUID or the full path string of a file plan object store record category or record folder that the transfer tool uses as the default parent container for imported records. The transfer tool uses this default value when an imported record’s parent container is either not designated in the XML source file or does not exist on the target file plan object store.
- Records Object Store - Enter the name of the records object store to which the transfer tool will import records.
- Default ROS Content Folder - Enter the GUID or full path string of a records object store folder that the transfer tool uses as the default container for imported record content that does not indicate such information.
- Create Batch Size - Enter a value relative to the performance requirements at your site. The default is 10.
- Enter the appropriate values when you are exporting or importing:
- Log File Name - Enter a name for the transfer activity log file. The default name is RMTransferActivityLogging.log. The transfer tool saves this file in the \RMTransfer directory.
- Stop On Error - Select True or False to indicate whether IBM InfoSphere Enterprise Records Transfer stops when an error occurs. The default value is False, meaning the Transfer tool does not stop when an error occurs.
- Click one of the following:
- Configure to save the changes and close the IBM InfoSphere Enterprise Records Transfer Configuration window. IBM InfoSphere Enterprise Records Transfer saves the changes to the <RM_install_dir>/RMTransfer/lib/config/RMTransferConfiguration.xml file.
- Reset to restore the fields to their previous values. The transfer tool restores the fields with values saved in the RMTransferConfiguration.xml file. If this is the initial configuration of the IBM InfoSphere Enterprise Records Transfer tool, the fields are empty.
- Exit to close the IBM InfoSphere Enterprise Records Transfer Configuration window without saving any changes.
Tip You can override the File Plan Object Store and Transfer Mapping Name fields through the command line. See Override configuration options.