IBM Enterprise Records, Version 5.1.2    

Running Disposition Sweep

Disposition 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 disposition sweep, ensure that you have the required JRE level.

Procedure

To run Disposition Sweep:

  1. Run Disposition Sweep or run a specific profile from the RecordsManagerSweep folder on the server where you installed the Disposition 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 commands to run Disposition Sweep:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep [-profile "profile name"]
    Windows RecordsManagerSweep.bat -DispositionSweep [-profile "profile name"]
    Alternatively, you can run Disposition Sweep from a command prompt by going to the ..\FileNet\RecordsManagerSweep\lib folder and entering the following command: java -jar rmsweep.jar.
  2. You can verify whether Disposition Sweep ran successfully by viewing the DispositionSweepActivity.log file created in the RecordsManagerSweep folder. If the error file is empty, the Disposition Sweep process ran successfully. Otherwise, the file contains errors that you can use to troubleshoot the problem.
    Important: Because Disposition Sweep shares some properties with Declassification Sweep, Disposition Sweep also writes some information into the DeclassificationSweepActivity.log file.
  3. To stop Disposition Sweep, use the -stop parameter:
    Option Description
    AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -stop [-profile "profile name"]
    Windows RecordsManagerSweep.bat -DispositionSweep -stop [-profile "profile name"]
    You see a message when the Disposition Sweep processes stop.

What to do next

Generate reports of entities due for Full Disposition, Destroy, Auto Destroy, Transfer, or Interim Transfer

You can use Disposition Sweep to generate reports that include a list of entities that are due for Full Disposition, Destroy, Auto Destroy, Transfer, or Interim Transfer. Disposition Sweep saves the reports as text files in the RecordsManagerSweep directory.

To generate these reports, run one of the following commands depending upon report type.

Where:

Generate a report of entities due for Full Disposition
Operating system Command
AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -Report "schedule name" [-o "output filename"] [-profile "profile name"]
Windows RecordsManagerSweep.bat -DispositionSweep -Report "schedule name" [-o "output filename"] [-profile "profile name"]
Generate a report of entities due for Destroy
Operating system Command
AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -Destroy "destroy due date" [-o "output filename"] [-profile "profile name"]
Windows RecordsManagerSweep.bat -DispositionSweep -Destroy "destroy due date" [-o "output filename"] [-profile "profile name"]
Generate a report of entities due for Auto Destroy
Operating system Command
AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -Autodelete "auto destroy due date" [-o "output filename"] [-profile "profile name"]
Windows RecordsManagerSweep.bat -DispositionSweep -autodelete "auto destroy due date" [-o "output filename"] [-profile "profile name"]
Generate a report of entities due for Transfer
Operating system Command
AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -Transfer "transfer due date" [-o "output filename"] [-profile "profile name"]
Windows RecordsManagerSweep.bat -DispositionSweep -Transfer "transfer due date" [-o "output filename"] [-profile "profile name"]
Generate a report of entities due for Interim Transfer
Operating system Command
AIX, HP-UX, Linux, and Solaris ./RecordsManagerSweep.sh -DispositionSweep -Interimtransfer "interim transfer due date" [-o "output filename"] [-profile "profile name"]
Windows RecordsManagerSweep.bat -DispositionSweep -InterimTransfer "interim transfer due date" [-o "output filename"] [-profile "profile name"]

Check the log file

After Disposition Sweep runs, check the activity log you configured. The log file shows:
  • When various types of processes start and end
  • Entities that were processed and updated.
  • A trace if there are errors.
Restriction: The log file does not include a list of records that failed because Content Platform Engine does not supply that information.


Feedback

Last updated: November 2013
run_disposition_sweep.htm

© Copyright IBM Corporation 2013