cleanupDocumentStoreEventSubscriptions command

Event subscriptions are created by Process Designer for document and folder classes. The event subscriptions are stored in the IBM® BPM document store. When named snapshots, branches or process applications are deleted, or an event subscription is modified or removed in Process Designer, the corresponding subscription in the IBM BPM document store is not removed. Another event subscription might still exist in another process application that remains subscribed to the same event.

This command checks all event subscriptions in all process applications and synchronizes the event subscriptions with the IBM BPM document store. Subscriptions that are no longer needed are removed. The command reduces the load on the system as the system does not need to handle events where event subscriptions no longer exist.

Case management functions are only available if you have IBM BPM Advanced with the Basic Case Management feature installed.

The cleanupDocumentStoreEventSubscriptions command is run by using the AdminTask object of the wsadmin scripting client.

Prerequisites

The following conditions must be met:

• The command must be run on the deployment manager node.
• One or more application cluster members must be running.
• The command must be run in connected mode. Do not specify the wsadmin -conntype none option.
• You must connect to the deployment manager with a user ID that has WebSphere Application Server operator privileges.

Location

Start the wsadmin scripting client from the profile_root/bin directory of the deployment manager profile (or the stand-alone server profile of IBM BPM Express). The cleanupDocumentStoreEventSubscriptions command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you find exception stack traces and other information.

Syntax

cleanupDocumentStoreEventSubscriptions
-serverName server_name
-nodeName node_name
-clusterName cluster_name
-deName deployment_environment_name

Required parameters

-serverName server_name

A required parameter that specifies the Process Center server name of the IBM BPM document store. If you specify the -serverName parameter, you must also specify the -nodeName parameter.

-nodeName node_name

A required parameter that specifies the Process Center node name of the IBM BPM document store. If you specify the -nodeName parameter, you must also specify the -serverName parameter.

-clusterName cluster_name

A required parameter that specifies the Process Center cluster name of the IBM BPM document store.

-deName deployment_environment_name

A required parameter that specifies the Process Center deployment environment name of IBM Business Process Manager.

You must specify the -clusterName parameter, or the -deName parameter, or both the -serverName and -nodeName parameters. As an alternative to specifying those parameters, you can run the command on a target object of type BPMDeploymentEnvironment, ServerCluster, or Server.

Output

• If event subscriptions are removed, then the number of changes is reported.

  CWTDS2060I: The cleanup finished successfully. '{0}' changes were made.

  Otherwise, if there are no event subscriptions to remove, the command outputs the following message:

  CWTDS2059I: The cleanup finished successfully without making any changes.