IBM Enterprise Records, Version 5.1.2    

Running Hold Sweep

Hold Sweep is a daemon process. To limit the performance impact on your system, schedule the process to run when the system usage is low. To run the hold sweep, ensure that you have the required JRE level.

About this task

Important: Before running Hold Sweep, an Administrator must set the QueryPageMaxSize property value to 100,000, and the Max Query Time Limit value to 0. For more information, see the configuring hold sweep topic.

Procedure

To run Hold Sweep:

  1. Run Hold Sweep or run a specific profile from the RecordsManagerSweep folder on the computer where you installed the Hold Sweep component. Profiles allow you to save different configurations and run sweep using these configurations without the need to reconfigure them. Use one of the following methods to run the Hold Sweep process:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -HoldSweep [-profile "profile name"]
    Windows RecordsManagerSweep.bat -HoldSweep [-profile "profile name"]
  2. Run Hold Sweep on an object store from the RecordsManagerSweep folder on the computer where you installed the Hold Sweep component to remove holds. Use the -ForceRemoveHold parameter. Running Hold Sweep on an object store allows you to remove listed record holds from a specified object store. You can remove up to a maximum of five holds. Running hold sweep on an object store allows you to remove all holds from within a specified object store. Running hold sweep on an object store allows you to remove holds from a specific object store located within a specific profile. When you remove holds using the -ForceRemoveHold parameter, active holds, inactive holds, manually applied holds, or holds applied using Hold Sweep are removed. Use one of the following methods to remove holds on an object store:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -HoldSweep -ObjectStore objectstorename|objectstoreID -ForceRemoveHold holdlist [-profile "profile name"]

    For example:

    ./RecordsManagerSweep.sh -HoldSweep -ObjectStore "MyFPOS" -ForceRemoveHold "Hold1|Hold2|{E4F6F8F9-4E1A-4762-B062-344980B2B92}" -profile "profile1"

    Windows RecordsManagerSweep.bat -HoldSweep -ObjectStore objectstorename|objectstoreID -ForceRemoveHold holdlist [-profile "profile name"]

    For example:

    ./RecordsManagerSweep.bat -HoldSweep -ObjectStore "MyFPOS" -ForceRemoveHold "Hold1|Hold2|{E4F6F8F9-4E1A-4762-B062-344980B2B92}" -profile "profile1"

    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -HoldSweep -ObjectStore objectstorename -ForceRemoveHold -All [-profile "profile name"]
    Attention: This option would be used only for a special purpose
    Windows RecordsManagerSweep.bat -HoldSweep -ObjectStore objectstorename -ForceRemoveHold -All [-profile "profile name"]
    Attention: This option would be used only for a special purpose
  3. Alternatively, you can run the Hold Sweep process from a command prompt by going to the ..\FileNet\RecordsManagerSweep\lib folder and entering the following command: java -jar rmHoldSweep.jar.
  4. To stop Hold Sweep, add the -stop parameter:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -HoldSweep -stop
    Windows RecordsManagerSweep.bat -HoldSweep -stop
    You see a message when the Hold Sweep processes are stopped.
  5. Verify whether Hold Sweep ran successfully by viewing the error log file created in the RecordsManagerSweep folder. If the error file is empty, the Hold Sweep process ran successfully. Otherwise, the file contains errors that you can use to troubleshoot the problem.


Feedback

Last updated: November 2013
run_hold_sweep.htm

© Copyright IBM Corporation 2013