Synchronizing cases with solution data

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15

Draft comment:
This page applies to the BAW-on prem and CP4BA KCs.

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. You can run the utility by using the Case Manager REST protocol.

When you change the case type of a solution and redeploy the solution, the changes are applied to new case instances. The changes are not applied to running case instances.

Use the case synchronizer utility to update the case instances to match the changes that you make to the following case type:

Creating a new folder structure
Case folder structure changes
New activities that are added to a case type
Changes to a container activity (Add or Delete) of subactivities that are associated with a container
Changes to activity launch modes (Manual, Automatic, Discretionary, Repeatable)
Changes to activity-required states (Required, Optional)
Changes to activity group modes (Inclusive, Exclusive)

The case synchronizer utility processes case instances in batches. The processed case instance ID is stored in the casesynchronizer.processed file in the path where the tool is run. If a batch runs without any errors, the tool deletes this file. If errors occur during the execution of the case synchronizer utility, the tool checks for the case instance IDs and so on.

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

Case Manager REST protocol for the case synchronizer

You can use the Case Manager REST protocol to run the case synchronizer. The following example is a URI for the POST method:

https://host_name:port_number/CaseManager/CASEREST/v1/casesynchronizer

Request content

The request for the POST method contains the following parameters in JSON in the body:

{
   "command" : "launch -Start the case synchronizer. Required.",
              "suspend -Stop the case synchronizer.",
   "cews_uri" : "The web services URI used to connect to Content Platform Engine. Required. For example: https://myserver:9080/wsi/FNCEWS40MTOM",
   "username" : "The user ID used to connect to Content Platform Engine. Required.",
   "password" : "The password for the specified user ID used to connect to Content Platform Engine. Required.",
   "target_os" : "The target object store. Required.",
   "caseType" : "The name of the case type for which the case synchronizer is to be run. 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 task type symbolic names to add to the case instances. This parameter is optional.",
   "excludedTaskTypes" : "A comma-separated list of the task type symbolic names to exclude from the update to the case instances. This parameter is optional.",
   "batchSize" : "The number of items to retrieve and process at one time. Optional. If not specified, the default batch size is 1000 items.",  
   "threadPoolSize" : "The number of active threads when processing activities. Optional. The default value is four threads."
}

The value of casesynchronizerresult in the response JSON indicates whether the case synchronizer ran successfully.

Note: To run the case synchronizer by using the REST protocol, the login modules for FileNetP8WSI must be configured on the application server.