IBM Enterprise Records, Version 5.1.2    

Configuring Hold Sweep

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

About this task

Restriction: If you are going to run the IBM Enterprise Records Hold Sweep tool in the Windows operating system, to correctly show the information in European languages (except English), apply the following 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 topic.

Procedure

To configure Hold Sweep:

  1. In IBM Administration Console for Content Platform Engine, open the FileNet P8 domain properties page. Right-click the first node and select Properties
  2. Select the Properties tab.
  3. From the Subsystem Configuration menu, select Server Cache Configuration.
  4. Select the Properties tab and change the value for the [QueryPageMaxSize] property from 1000 to 100,000.
    Important: Query Page Max Size is a system-wide parameter and the parameter affects the overall Content Platform Engine performance. The documented IBM Enterprise Records value is for optimal performance of the IBM Enterprise Records sweep processes. However, you might need to adjust the parameter value based on the overall Content Platform Engine usage and performance of your system.
  5. Browse to and right-click the file plan object store and select Properties.
  6. From the Properties dialog, click the Query tab.
  7. Set the Max Query Time Limit value to 0.
  8. Save the settings and exit from IBM Administration Console for Content Platform Engine.
  9. From a command prompt on the server where you installed Hold Sweep, go to the RecordsManagerSweep folder.
  10. Enter one of the following commands:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -HoldSweep -configure [-profile "profile name"]
    Windows RecordsManagerSweep.bat -HoldSweep -configure [-profile "profile name"]
  11. Specify the appropriate values for the following fields. Fields with an asterisk (*) are required. (You can clear existing values by clicking Reset.)
    • At the top of the configuration console window, there is a Profile: profile name label that indicates which profile you are configuring. The default profile is Profile: RMHoldSweepConfiguration.
    • Connection: Select http or https to specify the protocol for communication with the Content Platform Engine server. The default protocol is http. For secured communication, select https.
    • CE Server Name*: Provide the name or IP address of the Content Platform Engine server.
    • WSI Port Number*: Provide the WSI port number used by your Content Platform Engine server. For example, the default port number for Content Platform Engine running under a WebLogic Application Server is 7001. For Content Platform Engine running under a WebSphere Application Server, the default is 9080.
    • 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.
    • File Plan ObjectStore Name: Provide the GUID or Name of the file plan object store (FPOS) on which you want to run Hold Sweep. If you do not provide a value, the Hold Sweep process runs on all the file plan object stores associated with the specified Content Platform Engine server. If the name of the object store contains extended characters, use the GUID instead of the name.
    • User ID*: Provide the user name that Hold Sweep uses to log on to Content Platform Engine for performing calculations. The user must 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: 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), and IBM Crypto for C (ICC (certificate 384) for cryptography. 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 Configuring FIPS 140-2 mode topic. IBM Enterprise Records supports FIPS 140-2 encryption only on WebSphere Application Server.
    • Hold Names/GUIDs: Provide the name or GUID of up to five holds, separated by the ‘|' character. The sweep process uses only the specified holds. If no holds are provided, then Hold Sweep processes all the active holds. If you upgrade from an earlier release where you can create more than one hold with the same name, using such a hold name processes all holds with that name. If the name of the hold contains extended characters, use the GUID instead of the name.
    • Update Batch Size: Provide the number of entities to be processed as a batch using the Hold Sweep process. By default, this value is set to 1000. For example, if this value is 1000 and there are 20,000 entities to be processed, then Hold Sweep processes all entities in 20 batches with 1000 entities in each batch.
    • Retrieval Batch Size: Provide the number of entities to be retrieved per batch using the Hold Sweep process. By default, this value is set to 100000. For example, if this value is 100000 and there are 1,000,000 entities to be processed, then all the entities are retrieved in 10 batches with 100000 entities in each batch.
    • Thread Count: Enter the number of processing threads that IBM Enterprise Records uses during the Hold 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.
    • Log File Name: Provide the name and path of the error file to be created by the Hold Sweep process or accept the default. By default, a file called HoldSweepActivity.log is created in the ../EnterpriseRecords/RecordsManagerSweep folder. If the Hold Sweep process runs without error, the error file is zero bytes.
  12. Click Configure.


Feedback

Last updated: November 2013
configure_hold_sweep.htm

© Copyright IBM Corporation 2013