Configuring advanced disposition sweeps

Advanced disposition sweeps automatically process and update entire batches of records.

Configuring the advanced disposition sweep

1. From a command line, go to the RecordsManagerSweep folder.
2. Enter one of the following commands:
   • AIX and Linux: ./RecordsManagerSweep.sh -DispositionSweep -configure -profile <profile_name>
   • Windows: RecordsManagerSweep.bat -DispositionSweep -configure -profile <profile_name>
3. 
   

   Use the fields on the setup screen as follows. Asterisks (*) identify required fields. To reset all values to default values, click Reset. To close the sweep configuration console without changes, click Exit.

   

   Image: Advanced disposition sweep setup screen

   • The Profile: profile name label indicates which profile you are configuring. The default profile name is RMSweepConfiguration.
   • Connection: If the CONNECTION_TYPE is WSI, the value should either be http or https.

     If the CONNECTION_TYPE is EJB, the value should be one of these: iiop, t3, jnp. For example, select iiop when the Content Platform Engine is WebSphere.

     If you choose the WSI protocol and select http or https, you must specify a WSI port number like 7001 for WebLogic Server and 9080 for WebSphere.

     If you choose the EJB protocol, you must specify the default EJB port number for the application server you are using. For example, 2809 for WebSphere.

   • CE Server Name*: Provide the Host name or IP address of the Content Platform Engine server where the records are stored.
   • Port Number*: Provide the WSI or EJB port number that is used by your Content Platform Engine server.
   • 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 that is used and is the default value. If any of the EJB protocols are selected, the default URL is FileNet/Engine.

   • File Plan Object Store Name: Provide the GUID or name of the file plan object stores (FPOS) on which you want to run the sweep. If you do not provide a value, the sweep runs on all the FPOS 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.

     Note: A value for the Object Store name is required when running a declassification sweep.

   • Run for RecordTypes: If you want the disposition sweep process to check all the record types for any modifications that are made to the associated disposition schedules, specify the value True. If the disposition schedule of any record type is modified, the disposition sweep process updates all the entities that are associated with that record type.

     If you want the record types to be ignored, specify the value False. By default, record types are not processed.

   • Run For Vital: By default, vital metadata is not checked.

     Select True to check all the record categories, record folders, volumes, and records for any modifications that are made to the associated vital metadata. If the disposition schedule of any entity is modified, the sweep process updates all the entities.

     Select False to ignore the vital metadata.

   • Container GUIDs: Provide the GUIDs of the containers on which you want to run the disposition sweep. Note that the sweep process runs on the specified container and its child processes. By default, this node is empty and all entities are processed.

     The declassification sweep ignores the Entity GUID value, and always runs on the entire object store.

     You can add multiple a) GUID values, b) different paths of the containers, or c) both GUID value(s) and different container path(s) by using comma (,) or the vertical bar (|). For example:

     Example for a): {21B34B89-D1D6-4B39-8F5C-4F797F32E4B1},{469AC6D0-7EF1-4913-B2FC-321DD062D04F} or
     {21B34B89-D1D6-4B39-8F5C-4F797F32E4B1}|{469AC6D0-7EF1-4913-B2FC-321DD062D04F}

     Example for b): /Records Management/File Plan/test1,/Records Management/File Plan/test2 or
     /Records Management/File Plan/test1|/Records Management/File Plan/test2

     Example for c): /Records Management/File Plan/test1,{469AC6D0-7EF1-4913-B2FC-321DD062D04F},/Records Management/File Plan/test2 or
     /Records Management/File Plan/test1|{469AC6D0-7EF1-4913-B2FC-321DD062D04F}|/Records Management/File Plan/test2

   • User ID*: Provide the User name or ID that the sweep should use to log on to the Content Platform Engine for performing calculations. This ID is also used to log on to the Content Platform Engine for starting workflows. The user must have object store administrative rights on the FPOS and possess Records Administrator privileges, or be a member of the Process Administrators group.
   • Password*: Enter the password the password for the user ID.
   • FIPS 140-2 Mode: Select On or Off. When in FIPS 140-2 mode, Enterprise Records uses the FIPS 140-2 approved cryptographic providers for cryptography. The providers are IBMJCEFIPS (certificate 376), IBMJSSEFIPS (certificate 409), or IBM Crypto for C (certificate 384).

     The certificates are listed on the National Institute of Standards and Technology (NIST) website. If you select On and the security administrator does not configure the system for FIPS 140-2 mode, Enterprise Records displays an error message. The security administrator must modify the java.security file. For details, see the FIPS 140-2 mode task. Enterprise Records supports FIPS 140-2 encryption only on WebSphere Application Server.

   • PE Connection Point: Enter the name of the connection point that was created on the Content Platform Engine server during installation. This value is needed to connect to the workflow system. When sweep is configured to only process auto-destroy actions, this field can be blank.
   • Update Batch Size: Enter the number of entities to be updated in one batch. The default value is 1,000.
   • Retrieval Batch Size: Enter the number of entities to be retrieved in one batch. The default value is 1,000.
   • Thread Count: Enter the number of processing threads that Enterprise Records can use during the sweep process. It is recommended to have the thread count equal to the number of processors on the system. The default value is 1.

     For example, if there are 8 logical processors on your Content Platform Engine server, set the count to 8.

   • Multi-filed Records Cache Size: 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. To achieve optimal performance, the value must be greater than the total number of multi-filed records in the system.

     With this setting, you can avoid checking the Content Platform Engine server for IDs that are not found in the cache. However, setting sweep to cache a huge number of multi-filed records might exhaust the memory on the server.

   • Log File Name: Provide the name and path of the error file to be created by the sweep process. By default, the sweep creates a file named DispositionSweepActivity.log in the ../EnterpriseRecords/RecordsManagerSweep folder.

     If the disposition sweep runs without an error, the size of the error file is 0 byte.

     The disposition sweep also writes some information in the DeclassificationSweepActivity.log file because the sweep shares some properties with the declassification sweep.

4. Click Configure to save and apply the settings.