Configuring basic disposition sweep by using command line
Use the basic sweep command line utility to configure disposition settings and to run disposition sweep on categories defined in a basic schedule file plan.
About this task
- AIX and Linux: <IER_install_path>/BasicSweep.sh
- Windows: <IER_install_path>\BasicSweep.bat
Procedure
Configuring the basic disposition sweep
Running the basic disposition sweep
What to do next
Image: Basic disposition sweep setup screen
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.
- The Profile: profile name label indicates which profile you are configuring.
- Connection*: If the CONNECTION_TYPE is WSI, this drop-down displays the WSI protocols. Otherwise, it displays the EJB protocols.
- 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*: For WSI, use /wsi/FNCEWS40MTOM and for EJB, use /FileNet/Engine.
- Report Review Period*: Enter the number of days you want to wait before the workflow disposition occurs. The number of days you enter is added to the retention due date for the report.
- FPOS Object Store: Provide the name of the file plan object stores (FPOS)
on which you want to run the disposition sweep. If you do not provide a value, the disposition sweep
process runs on all the FPOS associated with the specified Content Platform Engine server.
Note: A value for the Object Store name is required when running a declassification sweep.
- Always Declare Records: After the records are destroyed, two reports are
generated. One report shows all the deleted records, and the other report shows all the records that
cannot be deleted. The workflow automatically declares these two reports as one record.
If you set the value to Yes, the generated reports are added as a record in the repository.
If you set the value to No, no records are declared.
- Always Show Declare Results: If you select Yes, the declared record that contains the deletion reports no longer show the record GUID and name in the workflow review step.
- Container GUIDs*: Provide the GUIDs of the containers on which you want
to process with the disposition sweep.
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/test2Example 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 Name: 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.
- Read Batch Size: Enter the number of entities to be read in one batch. The default value is 10,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 disposition 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.
- Need Approval*: Indicates whether approval of the workflow is enabled.
- Enter Yes for enabling approval of the workflow. Reviewers must approve the workflow before records are disposed of.
- Enter No for skipping the approval process and proceed to the review step. Records are disposed of after the due date.
- Defensible Disposal Workflow ID*: Enter the ID of the Defensible Disposal Workflow that the sweep should use during the process. Do not change this ID.