IBM Enterprise Records, Version 5.1.2    

Configuring Disposition Sweep

Before you run Disposition Sweep, configure it for the appropriate values. For example, specify the name of the Content Platform Engine server that contains the records. Also, limit the sweep to just one file plan object store.

About this task

Disposition Sweep configuration values are also used by Declassification Sweep. In addition to the fields required by Disposition Sweep, Declassification Sweep also requires an ObjectStore Name value and ignores the fields that are not required.
Restriction: If you are going to run the IBM Enterprise Records Disposition Sweep tool in the Windows operating system, apply the following settings. Apply these settings in order to correctly show the information in European languages (except English). Apply the settings from the Command Prompt before running the tool:
  • Set the font property to Lucida Console.
  • Change the code page to relative Windows ANSI code page (from 1250 to 1257). For example, if you want to show French in DOS windows, run 'chcp 1252' to change the code page to 1252. Code page 1252 is the Windows ANSI code page for West European Latin. For a full list of code pages, see the Code Page Identifiers table.

Procedure

To configure Disposition Sweep:

  1. From a command prompt, go to the RecordsManagerSweep folder.
  2. Enter one of the following commands:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -configure [-profile "profile name"]
    Windows RecordsManagerSweep.bat -DispositionSweep -configure [-profile "profile name"]
  3. Specify the appropriate values for the following fields. You can clear existing values by clicking Reset.
    • In the configuration console window, there is a Profile: profile name label that indicates which profile you are configuring. The default profile is Profile: RMSweepConfiguration.
    • Connection: Specify the network protocol you are using:
      • http, https if you are using a WSI protocol
      • iiop, t3, jnp if you are using an EJB protocol (for example, iiop is selected when the Content Platform Engine is WebSphere)
    • CE Server Name: Provide the name or IP address of the Content Platform Engine server where the records are stored.
    • Port Number: Provide the WSI or EJB port number used by your Content Platform 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: Provide the user-defined path to the URL that the tool is configured to use to communicate with the Content Platform 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 Platform Engine server.

      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 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 Platform Engine for performing calculations. This ID is also used to log on to the Content Platform 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 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 WebSphere Application Server.
    • PE Connection Point: Enter the name of the connection point that was created at the Content Platform Engine server during installation. This value is required for connection to the Content Platform Engine server, except when configured to only process auto-destroy actions. When configured to only process auto-destroy actions, this field can be blank.
    • 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 Enterprise Records uses during the disposition sweep process. Specify one thread for each logical processor on the Content Platform Engine server. For example, enter 8 if there are eight logical processors on your Content Platform 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 record ids in cache. To achieve optimal performance, the number you put in the Multi-Filed Records Cache Size field must be greater than the total number of multi-filed records in the system. You can avoid checking the Content Platform Engine server for ids not found in the cache with this setting. However, setting sweep to cache a huge number of multi-filed records might exhaust the memory on the server.
    • Activity Log File (Optional): Provide the name of the error file to be created by the Disposition Sweep process. By default, Disposition Sweep creates a file called DispositionSweepActivity.log in the ../EnterpriseRecords/RecordsManagerSweep folder. If Disposition Sweep runs without an error, the error file is zero bytes. Because Disposition Sweep shares some properties with Declassification Sweep, Disposition Sweep also writes some information into the DeclassificationSweepActivity.log file.
    • Run For Vital (Optional):
      • Select True to check all record categories, record folders, volumes, and records for any modifications made to the associated vital metadata. If the disposition schedule of any entity is modified, the Disposition Sweep process updates all the entities accordingly.
      • Select False to ignore the vital metadata. By default, vital metadata is not checked.
  4. Click Configure.
  5. To reset all values to default values, click Reset. To close the Sweep Configuration Console without changes, click Exit.


Feedback

Last updated: November 2013
configure_disposition_sweep.htm

© Copyright IBM Corporation 2013