Configure Disposition Sweep
Before you run Disposition Sweep, you must configure it for the appropriate values. For example, you must specify the name of the Content Engine server that contains the records, and you can limit the sweep to just one file plan object store. Disposition Sweep configuration values are also used by Declassification Sweep. However, in addition to the fields that are required by Disposition Sweep, Declassification Sweep also requires an ObjectStore Name value and ignores the fields that are not required.
Important If IBM Enterprise Records is deployed on IBM Websphere Application Server, any of the IBM Enterprise Records tools that rely upon JACE EJB transport protocol should use the JRE that comes with the same version Websphere Application Server or IBM Websphere Application Client. If IBM Enterprise Records is deployed on JBOSS or WebLogic Application Server, it is recommended that any of the IBM Enterprise Records tools that rely upon JACE EJB transport protocol use the JRE that comes with the same version application server.
You also must edit the JAVA_HOME environment variable in the appropriate application server section of the tool's BAT and SH file so the variable is pointing to the same JRE version as the application server where IBM Enterprise Records software is installed. For example, the Websphere Application Server entry might look like the following entry: set JAVA_HOME=%WS_DIR%/java.
To configure Disposition Sweep
- From a command prompt, navigate to the RecordsManagerSweep folder.
- Enter one of the following commands:
- Windows
RecordsManagerSweep.bat -DispositionSweep -configure
- UNIX ./RecordsManagerSweep.sh -DispositionSweep -configure
- Specify the appropriate values for the following fields. You can clear existing values by clicking Reset.
- Connection Specify the network protocol you will be using:
- http, https if you are using a WSI protocol
- iiop, t3, jnp if you are using an EJB protocol (for example iiop should be selected when the Content Engine is IBM WebSphere)
- CE Server Name Provide the name or IP address of the Content Engine server where the records are stored.
- Port Number Provide the WSI or EJB port number used by your Content Engine server.
- If http or https is selected in the Connection field, you must specify a WSI port number like 7001 for WebLogic, 9080 for WebSphere, and 8080 for JBoss.
- If any of the EJB protocols is selected in the Connection field, you must specify the default EJB port number for the Application server you are using, for example, 2809 for WebSphere.
- Url Path Provide the user-defined path to the URL that the tool is configured to use to communicate with the Content Engine server. For example, /wsi is the path generally used and is the default value.
If any of the EJB protocols is selected, the default URL is FileNet/Engine.
- File Plan ObjectStore Name (Optional) Provide the name of the file plan object store (FPOS) on which you want to run Disposition Sweep. If you do not provide a value, the Disposition Sweep process runs on all the file plan object stores associated with the specified Content Engine server.
Restriction: A value for the ObjectStore name is required for running Declassification Sweep.
- Run For Record Types (Optional)
- Specify the value as True if you want the Disposition Sweep process to check all record types for any
modifications made to the associated disposition schedules. If the disposition schedule of any record type is modified, the Disposition Sweep process updates all the entities that are associated with that record type.
- Specify the value as False if you want the record types to be ignored. By default, record types are not processed.
- Entity GUID (Optional) Provide the GUID of the IBM InfoSphere Enterprise Records container for which you want to run the Disposition Sweep process.
The Disposition Sweep process runs against the specified container and all of its children. By
default, this node is empty and all entities are processed.
Declassification Sweep ignores the Entity GUID value, and always runs against the entire object store.
- User ID Provide the user ID that Disposition Sweep uses to log on to Content Engine for
performing calculations and to log on to the Process Engine for starting workflows. The user
must belong to the Process Administrators group, have object store administrative rights on the FPOS, and possess Records
Administrator privileges.
- Password Provide the password for the user ID.
- FIPS 140-2 Mode (Optional) Select On or Off. When in FIPS 140-2 mode, IBM InfoSphere Enterprise Records uses the FIPS 140-2 approved cryptographic providers; IBMJCEFIPS (certificate 376), IBMJSSEFIPS (certificate 409), or IBM Crypto for C (ICC) (certificate 384) for cryptography. The certificates are listed on the NIST Web site at http://csrc.nist.gov/cryptval/140-1/1401val2004.htm.
If you select On and the security administrator does not configure the system for FIPS 140-2 mode, IBM InfoSphere Enterprise Records displays an error message. The security administrator must modify the java.security file. For details, see the task, Configure IBM InfoSphere Enterprise Records for FIPS 140-2 mode in the IBM InfoSphere Enterprise Records Installation and Upgrade Guide.
IBM InfoSphere Enterprise Records supports FIPS 140-2 encryption only on WebSphere Application Server.
- PE Connection Point Enter the name of the connection point that was created at the Content Engine server during installation. This value is required for connection to the Process Engine server. The person doing the installation creates this name.
- Update Batch Size (Optional) Enter the number of entities to be updated in one batch. The default is 1000.
- Read Batch Size (Optional) Enter the number of entities to be read in one batch. The default is 10,000.
- Thread Count (Optional) Enter the number of processing threads that IBM InfoSphere Enterprise Records uses during the disposition sweep process. The best practice is to specify one thread for each logical processor on the Content Engine server. For example, enter 8 if there are eight logical processors on your Content Engine server. The default is 1.
- Multi-Filed Records Cache Size Configure your own cache size for these multi-filed records. The default value is 10,000.
By default, sweep saves up to 10,000 multi-filed records' ids in cache. To achieve optimal performance, the number you put in the Multi-Filed Records Cache Size field should be greater than the total number of multi-filed records in the system to avoid having to check the Content Engine server for ids not found in the cache. However, setting sweep to cache a huge number of multi-filed records may exhaust the memory on the server.
- Click Configure.
To reset all values to default values, click Reset. To close the Sweep Configuration Console without making any changes, click Exit.