This topic applies only to the IBM Business Process Manager Advanced configuration.

cleanupDocumentStoreProperties command

The cleanupDocumentStoreProperties command deletes all properties that are currently specified in the case and document classes for a specific application but are no longer used. (An unused property is one that is no longer referenced in any named snapshot or tip in any branch of a process application or toolkit.) After the properties are removed, the command also removes any unused property templates.

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

The cleanupDocumentStoreProperties command is run 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 cleanupDocumentStoreProperties 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 will find exception stack traces and other information.

Syntax

cleanupDocumentStoreProperties
-containerAcronym container_acronym
-serverName server_name
-nodeName node_name
-clusterName cluster_name
-deName deployment_environment_name

Required parameters

-containerAcronym container_acronym: A required parameter that specifies the acronym of the process application or toolkit that is to be cleaned up.
-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

The cleanupDocumentStoreProperties command reports the status when deleting the following types of information:

For each property property that is removed from a case folder type case_type, the property name and the case type name are reported.
```
CWTDS2052I: The property 'property' was removed from the case type 'case_type'.
```
Otherwise, if there are no properties to delete, the command outputs the following message:
```
CWTDS2054I: There was no property to be deleted from any case type.
```
For each property property that is removed from a document type document_type, the property name and the document type name are reported.
```
CWTDS2053I: The property 'property' was removed from the document type 'document_type'.
```
Otherwise, if there are no properties to delete, the command outputs the following message:
```
CWTDS2055I: There was no property to be deleted from any document type.
```
For each property template property_template that is deleted, the property template name is reported.
```
CWTDS2049I: The property template 'property_template' was deleted.
```
Otherwise, if there are no property templates to delete, the command outputs the following message:
```
CWTDS2050I: No property template was deleted.
```

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.

The following Jython example uses the cleanupDocumentStoreProperties command to remove unused properties for the MYAPP application for a specified node and server:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.cleanupDocumentStoreProperties(['-nodeName', 'myNodeName', '-serverName', 'myServerName', '-containerAcronym', 'MYAPP'])

The following Jython example uses the cleanupDocumentStoreProperties command to remove unused properties for the MYAPP application for a specified cluster:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.cleanupDocumentStoreProperties(['clusterName', 'myClusterName', '-containerAcronym', 'MYAPP'])

The following Jython example uses the cleanupDocumentStoreProperties command to remove unused properties for the MYAPP application for a specified deployment environment:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.cleanupDocumentStoreProperties(['-deName', 'myDeName', '-containerAcronym', 'MYAPP'])

The following Jython example uses the cleanupDocumentStoreProperties command to remove unused properties for the MYAPP application for a specified server target object:

wsadmin -user admin -password admin -lang jython
wsadmin>server = AdminConfig.getid('/Cell:/Node:myNodeName/Server:myServerName')
wsadmin>AdminTask.cleanupDocumentStoreProperties(server, ['-containerAcronym', 'MYAPP'])

The following Jython example uses the cleanupDocumentStoreProperties command to remove unused properties for the MYAPP application for a specified cluster target object:

wsadmin -user admin -password admin -lang jython
wsadmin>cluster = AdminConfig.getid('/Cell:/ServerCluster:myClusterName')
wsadmin>AdminTask.cleanupDocumentStoreProperties(cluster, ['-containerAcronym', 'MYAPP'])