Synchronizing cases with solution data

If you modify a solution after it is deployed, run the case synchronizer utility to update existing instances to match the changes that you made.

By using the case synchronizer utility, you can update case instances to match changes that you make to the case type, such as:

Adding new activities
Creating a new folder structure
Updating the state of existing activity instances in the case instances

The case synchronizer utility is in the IBM® Business Automation Workflow installation folder.

Table 1. Case synchronizer file name and location
Platform	File name	Location
AIX®	caseSynchronizer.sh	/opt/IBM/CaseManagement
Linux®	caseSynchronizer.sh	/opt/IBM/CaseManagement
Linux for System z	caseSynchronizer.sh	/opt/IBM/CaseManagement
Windows	caseSynchronizer.bat	C:\Program Files (x86)\IBM\CaseManagement

Syntax

caseSynchronizer command parameter-list

parameter-list consists of a set of pairs, where each pair has a parameter and a value, separated by a space.

Commands

launch: Start the case synchronizer utility. The launch command requires parameters.
suspend: Stop the case synchronizer utility. The suspend command does not require parameters.

Parameters

-cews_uri: The web services URI to connect to Content Platform Engine, for example, http: //myserver:9080/wsi/FNCEWS40MTOM. This parameter is required.
-username: The user ID to connect to Content Platform Engine. This parameter is required.
-password: The password for the specified user ID to connect to Content Platform Engine. If the password is not specified, the case synchronizer utility will prompt for the password. This parameter is required.
-target_os: The target object store that the case synchronizer will check. This parameter is required
-caseType: The symbolic name of the case type for the tool to update. This parameter is required.; If the name of the case type includes spaces, surround the name with single quotation marks, for example, -caseType 'Accident report'.
-caseTypeFilter: The filter criteria to use when retrieving the case instances to update. This parameter is optional.
-includedTaskTypes: A comma-separated list of the activity type symbolic names to add to the case instances. This parameter is optional.
-excludedTaskTypes: A comma-separated list of the activity type symbolic names to exclude from the update to the case instances. This parameter is optional.
-file: The path to an input file that contains the parameters to run the tool. This parameter is optional.; If specified, the input file must include the cews_uri, username, password, target_os, and caseTypeparameters without leading hyphens.
-batchSize: The number of items to retrieve and process at one time. This parameter is optional. If not specified, the default batch size is 1000 items.
-threadPoolSize: The number of active threads for the tool to use when it processes case instances. This parameter is optional. The default value is 4.

For example, the following command starts the case synchronizer for cases of the type Accident Report and updates every case instance of that type with any changes that have been made to that case type.

caseSynchronizer launch -cews_uri http://myserver:9080/wsi/FNCEWS40MTOM 
-username administrator -password mypassword 
-target_os MyTargetOS -caseType 'Accident Report'