Configure Hold Sweep
Before you can run Hold Sweep, you must configure it for the appropriate values. For example, you must specify the name of the Content Engine server that contains the records, and you can limit the sweep to just one file plan object store.
Important If IBM Enterprise Records is deployed on IBM Websphere Application Server, any of the IBM Enterprise Records tools that rely upon JACE EJB transport protocol should use the JRE that comes with the same version Websphere Application Server or IBM Websphere Application Client. If IBM Enterprise Records is deployed on JBOSS or WebLogic Application Server, it is recommended that any of the IBM Enterprise Records tools that rely upon JACE EJB transport protocol use the JRE that comes with the same version application server.
You also must edit the JAVA_HOME environment variable in the appropriate application server section of the tool's BAT and SH file so the variable is pointing to the same JRE version as the application server where IBM Enterprise Records software is installed. For example, the Websphere Application Server entry might look like the following entry: set JAVA_HOME=%WS_DIR%/java.
To configure Hold Sweep
- In Enterprise Manager, open the P8 domain properties page. Right click on the top node and select Properties
- Select the Properties tab.
- From the Subsystem Configuration menu, select Server Cache Configuration.
- Select the Properties tab and change the value for the [QueryPageMaxSize] property from 1000 to 150,000.
- Browse to and right-click the file plan object store,and select Properties.
- From the Properties dialog, click the Query tab.
- Set the Max Query Time Limit value to 0.
- Save the settings and exit from Enterprise Manager.
- From a command prompt on the machine where you installed Hold Sweep, navigate to the RecordsManagerSweep folder.
- Enter one of the following:
- Windows
RecordsManagerSweep.bat
-HoldSweep -configure
- UNIX
./RecordsManagerSweep.sh
-HoldSweep -configure
- Specify the appropriate values for the following fields. Fields with an asterisk (*)
are required. (You can clear existing values by clicking Reset.)
- Connection Select http or https to specify the protocol for communication with the Content Engine server. The default protocol is http. For secured communication, select https.
- CE Server Name* Provide the name or IP address of the
Content Engine server.
- WSI Port Number* Provide the WSI port number used by your Content Engine server. For example, the default port number for Content Engine running under a WebLogic application server is 7001. For Content Engine running under WebSphere, the default is 9080.
- Url Path Provide the user-defined path to the URL that the tool is configured to use to communicate with the Content Engine server. For example, /wsi is the path generally used and is the default value.
- File Plan ObjectStore Name Provide the GUID or Name of the file plan object store
(FPOS) on which you want to run Hold Sweep. If you do not provide a value, the Hold Sweep process
will run on all the file plan object stores associated with the specified CE server. If
the name of the object store contains extended characters, use the GUID instead of the
name.
- User ID* Provide the user name that Hold Sweep uses to log on
to CE for performing calculations.
The user must have object store administrative
rights on the FPOS, and possess Records Administrator privileges.
- Password* Provide the password for the User ID.
- FIPS 140-2 Mode Select On or Off. When in FIPS 140-2 mode, IBM InfoSphere Enterprise Records uses the FIPS 140-2 approved cryptographic provider(s); IBMJCEFIPS (certificate 376) and/or IBMJSSEFIPS (certificate 409) and/or IBM Crypto for C (ICC (certificate 384) for cryptography. The certificates are listed on the NIST web site at http://csrc.nist.gov/cryptval/140-1/1401val2004.htm.
If you select On and the security administrator does not configure the system for FIPS 140-2 mode, IBM InfoSphere Enterprise Records displays an error message. The security administrator must modify the java.security file. For details, see the task, Configure IBM InfoSphere Enterprise Records for FIPS 140-2 mode in the IBM InfoSphere Enterprise Records Installation and Upgrade Guide.
IBM InfoSphere Enterprise Records supports FIPS 140-2 encryption only on WebSphere Application Server.
- Hold Names/GUIDs Provide the name or GUID of up to five holds,
separated by the ‘|’ character. The sweep process
will use only the specified holds. If no holds are provided, then Hold
Sweep processes all the active holds. If you upgraded from an earlier
release where you could create more than one hold with the same name, using such a hold
name will process all holds with that name. If the name of the hold contains extended characters,
use the GUID instead of the name.
- Update Batch Size Provide the number of entities to be processed
as a batch using the Hold Sweep process. By default, this value has been set to 1000. For
example, if this value is 1000 and there are 20,000 entities to be processed, then Hold
Sweep will process all entities in 20 batches, with 1000 entities in each batch.
- Retrieval Batch Size Provide the number of entities to be retrieved
per batch using the Hold Sweep process. By default, this value has been set to 100000.
For example, if this value is 100000 and there are 1,000,000 entities to be processed,
then all the entities will be retrieved in 10 batches, with 100000 entities in each batch.
- Thread Count Enter the number of processing threads that IBM InfoSphere Enterprise Records uses during the hold sweep process. The best practice is to specify one thread for each logical CPU on the CE server. For example, enter "8" if there are eight logical CPUs on your CE server. The default is 1.
- Log File Name Provide the name and path of the error file
to be created by the Hold Sweep process or accept the default. By default, a file called
HoldSweepActivity.log is created in the ../FileNet/RecordsManagerSweep folder. If the Hold
Sweep process runs without error, the error file is zero bytes.
- Click Configure..