IBM Enterprise Records, Version 5.1.+              

Configuring the Hold Sweep tool

To configure the Hold Sweep tool, open the Configuration settings page through a command prompt, and enter the values that apply to your environment, such as the Content Engine server name, port number, and file plan object store name. Before the configuration, you must log into IBM® FileNet® Enterprise Manager to increase the value of the QueryPageMaxSize property. Windows users must change the timeout value for Microsoft Distributed Transaction Coordinator (MS DTC) on the Content Engine server before starting the configuration.

The application server or application server client must be installed and available on the server where you installed the Hold Sweep tool. You can use a command prompt to access the Configuration settings page, and use a command prompt to run the tool for a hold sweep.
Important:

Running sweep applications on your system might affect the general system performance. You should configure your system to run the sweep process when the system usage is low. For more information, see the link at the end of this topic.

To configure and run the Hold Sweep tool:

  1. (Windows) Set the Microsoft Distributed Transaction Coordinator (MS DTC) timeout to 0 so that the the Hold Sweep tool can process large amounts of data:
    1. On the Content Engine server, go to Start > Programs > Administrative Tools > Component Services.
    2. Select Component Services > Computers.
    3. Click My Computer and select Properties.
    4. Select the Options tab.
    5. Set Transaction Timeout to 0 seconds and click OK.
    6. Restart the Content Engine server.
  2. Set the QueryPageMaxSize property to a value that is larger than the value set for Retrieval Batch Size:
    1. In IBM FileNet Enterprise Manager, open the domain properties page by right-clicking on the top node and selecting Properties.
    2. Select the Properties tab.
    3. From the Subsystem Configuration list, select Server Cache Configuration.
    4. Select the Properties tab and set an appropriate value for the QueryPageMaxSize property. Set the value to a number that is larger than the Retrieval Batch Size value. The default value for Retrieval Batch Size is 100000.
  3. Log on to the server where you installed the Hold Sweep tool.
  4. With a command prompt, navigate to the following directory: ier_install_path/RecordsManagerSweep/
  5. Open the Configuration settings page for the Hold Sweep tool by running the following command:
    UNIX
    ./RecordsManagerSweep.sh -HoldSweep -configure [-profile "profile name"]
    Windows
    RecordsManagerSweep.bat -HoldSweep -configure [-profile "profile name"]
    Profiles allow you to save different configurations and run Hold 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.
  6. In the Configuration settings page, enter the appropriate values for your environment and click Configure. When the configuration finishes, you can run the Hold Sweep tool.
    Table 1. Configuration values to set for your environment
    Field Required? Provide this information
    CE 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 Data Service port number.
    FPOS 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 that are associated with the specified Content Engine server.
    User ID Yes Provide the user name that Disposition Sweep uses to log on to Content Engine for performing calculations and to log on to the Process Engine for launching workflows. The user must belong to the Content Engine Administrators group, be an object store administrator for the FPOS, and have the Records Administrator role.
    Password Yes Provide the password for the user ID.
    HOLD Names/GUIDs No Provide the hold names or GUIDs separated by the ‘|' character. If you enter any holds, the sweep process affects only the specified dynamic holds. If no hold names are provided, then Hold Sweep processes all the active holds. For cases where there can be more than one hold with same name, then all the holds with the same name are applied on the entities.
    Processing Batch Size No Enter the number of entities to be processed as a batch using the Hold Sweep process. By default, this value has been set to 1000. For example, if this value is 1000 and there are 20,000 entities to be processed, then the Hold Sweep processes all entities in 20 batches, with 1000 entities in each batch.
    Retrieval Batch Size No Enter the number of entities to be retrieved per batch using the Hold Sweep process. By default, this value has been 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 No Enter the number of processing threads that IBM Enterprise Records uses during the hold 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.
    Error Log File Name No Provide the name and path of the error file to be created by the Hold Sweep process. By default, an error log file called ErrorFile is created in the ier_install_path/RecordsManagerSweep folder, which is created by the Hold Sweep process. If the Hold Sweep process runs without error, the log file is zero bytes in length.
  7. To run the Hold Sweep tool, execute the following command:
    UNIX (From a Cron job or command prompt)
    ./RecordsManagerSweep.sh -HoldSweep
    Windows (From Windows Scheduler or command prompt)
    RecordsManagerSweep.bat -HoldSweep
  8. Verify that the Hold Sweep tool ran correctly by viewing the log file at ier_install_path/RecordsManagerSweep/HoldSweepActivity.log. If the log file contains no error, the Hold Sweep process was successful.
You do not need to re-configure a configured Disposition Sweep or Hold Sweep unless you want to change some of the values that were specified during the configuration process, such as the object store, user ID, or password.


Feedback

Last updated: August 2011


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