IBM Enterprise Records, Version 5.1.+              

Configuring the Disposition Sweep tool for your environment

Configure the disposition sweep tool with your environment's values before you run it. You can use a command prompt to access the Configuration settings page, and you can also use a command prompt to run the tool for a disposition sweep. When you run the Disposition Sweep tool, there is an error log for troubleshooting.

To configure and run the Disposition Sweep tool:

  1. Log on to the server where you installed the Disposition Sweep tool.
  2. With a command prompt, navigate to the following directory: ier_install_path/RecordsManagerSweep/
  3. Open the Configuration settings page for the Disposition Sweep tool by running the following command:
    UNIX
    ./RecordsManagerSweep.sh -DispositionSweep -configure [-profile "profile name"]
    Windows
    RecordsManagerSweep.bat -DispositionSweep -configure [-profile "profile name"]
    Profiles allow you to save different configurations and run Disposition Sweep using these configurations without the need to reconfigure them. You can create a new profile or edit an existing profile by running the configure command and providing the profile name.
  4. In the Configuration settings page, enter the appropriate values for your environment. Click Configure to start the configuration.
    Table 1. Configuration values to set for your environment
    Field Required Provide this information
    Server Name Yes Provide the name or IP address of the Content Engine server where you want to run the Disposition Sweep process.
    Port Number Yes 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 Server, 9080 for WebSphere®, and 8080 for JBoss Application Server. 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 Yes Provide the user-defined path to the URL that the tool is configured to use to communicate with the Content Engine server.
    Object Store Name No Provide the GUID or Name of the FPOS on which you want to run Disposition Sweep. If you do not provide a value, the Disposition Sweep process will run on all the FPOSs associated with the specified Content Engine server.
    Run For Record Types No Specify the value as True to have the Disposition Sweep process check all record types for any modifications made to the associated disposition schedules. If the disposition schedule of any record type has been modified, the Disposition Sweep process updates all the entities associated with that record type. Specify the value as False to have the record types ignored.
    Entity GUID No Provide the GUID of the IBM® Enterprise Records entity (Classification Scheme, Record Category, or Record Folder) for which you want to run the Disposition Sweep process. The Disposition Sweep process will run against the specified entity and all of its children. By default, this node is empty and all entities are processed.
    User ID Yes Provide the user name that Disposition Sweep uses to log on toContent Engine for performing calculations and to log on to the Process Engine for launching workflows. The user must be assigned the Records Administrator role, be a member of the Content Engine Administrators group, and be an object store administrator for the FPOS.
    Password Yes Provide the password for the user ID.
    FIPS 140-2 Mode No Select On or Off. When in FIPS 140-2 mode, IBM 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.
    PE Connection Point Yes Enter the name of the connection point used by Application Engine or Workplace XT.

    When configured to only process auto-destroy actions, this field is not required and can be left blank.

    Update Batch Size No By default, IBM Enterprise Records stores a maximum of 1,000 entities in a batch for update.
    Read Batch Size No By default, IBM Enterprise Records stores a maximum of 10,000 entities in a batch for read.
    Thread Count No Enter the number of processing threads that IBM Enterprise Records uses during the disposition sweep process. The best practice is to specify one thread for each logical CPU on the Content Engine server. For example, enter “8” if there are eight logical CPUs on your Content Engine server. The default is 1.
    Multi-Filed Records Cache Size Yes 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.
    Activity Log File Name No Provide the name and path of the error file to be created by the Disposition Sweep process. By default, a file called ErrorFile is created in the ier_install_path/RecordsManagerSweep folder by the Disposition Sweep process. If the process runs without error, the error file is zero bytes in length.
    Run For Vital (Optional) No Set this to either False or True. (default: False)
    When the configuration finishes, you can run the Disposition Sweep tool.
  5. To run the tool, execute the following command:
    UNIX (From a Cron job or command prompt)
    ./RecordsManagerSweep.sh -DispositionSweep
    Windows (From Windows Scheduler or command prompt)
    RecordsManagerSweep.bat -DispositionSweep
  6. Verify that the Disposition Sweep tool ran correctly by viewing the log file at ier_install_path/RecordsManagerSweep/DispositionSweepActivity.log. If the log file is empty, the Disposition Sweep process was successful.


Feedback

Last updated: August 2011


© Copyright IBM Corporation 2011.
This information center is powered by Eclipse technology. (http://www.eclipse.org)