You must complete up to three separate tasks to configure
the IBM® Enterprise
Records Transfer
tool.
About this task
Complete one or all of the following tasks:
- Configure the IBM 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 Enterprise
Records Transfer tool. For details,
see the IBM Enterprise
Records Installation
and Upgrade Guide.
- Specify Content Platform Engine server information. Complete this task if
there are changes to the Content Platform Engine server connection information, such as the Content Platform Engine server name, a user
name, or password.
- Specify transfer parameters. Complete this
task if you need to change the transfer parameters. For example, run IBM Enterprise
Records Transfer against a different
File Plan Object Store (FPOS). Use a different mapping object. Change
the retrieval batch size. Modify the level of subcategories to include
in a transfer.
Specify Content Platform Engine server information
Procedure
To specify Content Platform Engine server information:
- From the command line, open the IBM Enterprise
Records Transfer Connection window by running one of the following commands from the \RMTransfer directory:
- Windows: RMTransfer.bat -configure Connection
- AIX, HP-UX, Linux, and Solaris: RMTransfer.sh -configure
Connection
- In the IBM Enterprise
Records Transfer Connection window, provide the relevant
data for your site in the following fields:
- Content Platform Engine URL: Enter the URL to the Content Platform Engine server for the File
Plan Object Store. The URL is in the format: connection_type://content_engine_server_name:port#.
- For WebSphere®: iiop://ce-rm-win02:2809.
For WebSphere Application Server V6.1, you must disable the secure
sockets layer (SSL). For details about how to disable the SSL, see
the IBM Enterprise
Records Installation
and Upgrade Guide.
- For WebLogic: t3://ce-rm-win02:7001
- For JBoss: jnp://ce-rm-win02:1099
The port numbers are the default values. You can change the default
port value to match the port on which the Applications Server listens.
This port number must match the port for your Content Platform Engine client.
- User Name: Enter the login name of an authorized
user with read and write access rights to the IBM Enterprise
Records file plan object store.
- Password: Enter the password associated
with the user name. The transfer tool encrypts the password.
- FIPS 140-2 Mode:Select On or Off. When in FIPS 140-2 mode, IBM Enterprise
Records uses the FIPS 140-2 approved
cryptographic providers for cryptography. The providers are IBMJCEFIPS
(certificate 376), IBMJSSEFIPS (certificate 409), or IBM Crypto for
C (ICC (certificate 384). The certificates are listed on the NIST
website. If you select On and the security
administrator does not configure the system for FIPS 140-2 mode, IBM Enterprise
Records displays an error message.
The security administrator must modify the java.security file. For details, see the FIPS 140-2 mode task. IBM Enterprise
Records supports FIPS 140-2 encryption
only on a WebSphere Application
Server.
- Click one of the following options:
- Configure to save the changes and close
the IBM Enterprise
Records Transfer Connection window of the record. IBM Enterprise
Records Transfer saves the changes
to the RM_install_dir/RMTransfer/lib/config/RMTransferConnection.xml file.
- Reset to restore the fields to their earlier
values. IBM Enterprise
Records Transfer
restores the fields with values saved in the RMTransferConnection.xml file. If you are completing the initial configuration of the IBM Enterprise
Records Transfer tool, the fields
are blank.
- Exit to close the IBM Enterprise
Records Transfer Connection window without saving any changes.
Results
To specify transfer parameters:
- At the command line, open the IBM Enterprise
Records Transfer Configuration window by running one of the following commands from the rm_install_dir\RMTransfer directory:
- Windows: RMTransfer.bat -configure Configuration
- AIX, HP-UX, Linux, and Solaris: RMTransfer.sh -configure
Configuration
- In the IBM 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) for the IBM Enterprise
Records entities to be transferred.
- Transfer Mapping Name: Enter the name of
the mapping object that the Transfer tool uses for exporting the IBM Enterprise
Records entities. The mapping
object is an XML file that maps user-defined IBM Enterprise
Records object properties to the
DoD V3 schema. For details about mapping objects, see the transfer
mappings topic.
- Export Directory Path: Enter the location
where the IBM Enterprise
Records Transfer
tool saves the export XML files.
- Export File Prefix: Enter a prefix 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 Enterprise
Records Transfer imports IBM Enterprise
Records entities.
- Transfer Mapping Name: Enter the name of
the mapping object that the transfer tool uses for importing the IBM Enterprise
Records entities. The mapping
object is an XML file that maps Content Platform Engine property names to XML
property names. For details about mapping objects, see the transfer
mappings topic.
- File Plan Name: Enter the name of the file
plan into which IBM Enterprise
Records Transfer places the imported records and record folders. The name
of the file plan is the containment name in IBM Administration
Console for Content Platform Engine. 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 the
parent container of an imported record folder is not designated in
the XML source file. This default value is also used if the parent
container 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
the parent container of an imported record folder is not designated
in the XML source file. This default value is also used if the parent
container 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 imports 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 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 options:
- Configure to save the changes and close
the IBM Enterprise
Records Transfer Configuration window. IBM 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 you
are completing the initial configuration of the IBM Enterprise
Records Transfer tool, the fields
are empty.
- Exit to close the IBM Enterprise
Records Transfer Configuration window without saving any changes.
You can override the File Plan Object Store and Transfer Mapping Name fields through
the command line. See the override configuration options topic.