Configure the disposition sweep tool with your environment values before you run it. You can use a command prompt to access the Configuration settings page. You can also use a command prompt to run the tool for a disposition sweep. When you run the Disposition Sweep tool, you see an error log for troubleshooting.
To configure and run the Disposition Sweep tool:
Option | Description |
---|---|
AIX, HP-UX, Linux, and Solaris | ./RecordsManagerSweep.sh -DispositionSweep -configure [-profile "profile name"] |
Windows | RecordsManagerSweep.bat -DispositionSweep -configure [-profile "profile name"] |
Field | Required | Provide this information |
---|---|---|
Server Name | Yes | Provide the name or IP address of the Content Engine or Content Platform Engine server where you want to run the Disposition Sweep process. |
Port Number | Yes | Provide the WSI or EJB port number used by your Content Engine or Content Platform Engine server. If http or https is selected in the Connection field, you must specify a WSI port number such as 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 | Yes | Provide the user-defined path to the URL that the tool is configured to use to communicate with the Content Engine or Content Platform Engine server. |
Object Store 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 runs on all the FPOSs associated with the specified Content Engine or Content Platform Engine server. |
Run For Record Types | No | Specify the value as True to have the Disposition Sweep process 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 associated with that record type. Specify the value as False to have the record types ignored. |
Container GUIDs | No | Provide the GUID of the IBM® Enterprise Records container (Classification Scheme, Record Category, or Record Folder) where you want to run the Disposition Sweep process. For multiple GUIDs, you can use the “|” as the separator. You must start each GUID entry with an open brace and end each entry with a closed brace. You cannot have additional text outside of the braces, except for valid separators. You cannot have any parent or child relationships in the GUIDs. The Disposition Sweep process runs against the specified containers and all of their children. By default, this node is empty and all entities are processed. Declassification Sweep ignores the Container GUIDs value, and always runs against the entire object store. |
User ID | Yes | Provide the user name that Disposition Sweep uses to log on toContent Engine or Content Platform Engine for completing calculations and to log on to the Process Engine or Content Platform Engine for running workflows. The user must be assigned the Records Administrator role, be a member of the Content Engine or Content Platform Engine Administrators group, and be an object store administrator for the FPOS. |
Password | Yes | Provide the password for the user ID. |
FIPS 140-2 Mode | No | 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), or IBM Crypto for C (ICC) (certificate 384) for cryptography. |
PE Connection Point | Yes | Enter the name of the connection point used
by Application Engine or Workplace XT. When configured to only process auto-destroy actions, this field is not required and can be blank. |
Update Batch Size | No | By default, IBM Enterprise Records stores a maximum of 1,000 entities in a batch for update. |
Read Batch Size | No | By default, IBM Enterprise Records stores a maximum of 10,000 entities in a batch for read. |
Thread Count | No | Enter the number of processing threads that IBM Enterprise Records uses during the disposition sweep process. Specify 1 thread for each logical processor on the Content Engine or Content Platform Engine server. For example, enter “8” if you have eight logical processors on your Content Engine or Content Platform Engine server. The default is 1. |
Multi-Filed Records Cache Size | Yes | 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. |
Activity Log File Name | No | Provide the name and path of the error file to be created by the Disposition Sweep process. By default, a file called ErrorFile is created in the ier_install_path/RecordsManagerSweep folder by the Disposition Sweep process. If the process runs without error, the error file is zero bytes in length. |
Run For Vital (Optional) | No | Set this value to either False or True. (default: False) |