updateDocumentStoreApplication command

Use the updateDocumentStoreApplication command to check the status of the installed IBM_BPM_DocumentStore application in a deployment target. If the application is not current or the authentication alias used by the application does not match the one mapped in the EmbeddedECMTechnicalUser role, the application is updated.

If you configured IBM® Business Process Manager to use an external Enterprise Content Management server, then this command does not apply.

The updateDocumentStoreApplication 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.
Run the command in either local or connected mode.
When running the command in connected mode, you must specify a user ID that has WebSphere Application Server operator and deployer privileges.

Before running this command, you should review the task topic "Updating the IBM BPM document store application."

Location

Start the wsadmin scripting client from the deployment_manager_profile/bin directory on either IBM Process Server or Process Center. The updateDocumentStoreApplication 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

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

Required parameters

-serverName server_name: A required parameter that specifies the 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 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 cluster name of the IBM BPM document store.
-deName deployment_environment_name: A required parameter that specifies the deployment environment name of the IBM BPM document store.

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

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 updateDocumentStoreApplication can be run in either local mode or connected mode.

If you are running in local mode, you do not need to specify the -user and -password parameters when you run the wsadmin command to invoke the wsadmin scripting client. However, you must specify the -conntype parameter with a value of none. For example:

wsadmin -conntype none -lang jython

If you are running in connected mode, you must specify the -user and -password parameters when you run the wsadmin command to invoke the wsadmin scripting client. However, do not specify the -conntype parameter. For example:

wsadmin -user admin -password admin -lang jython

The examples that follow are based on the assumption that you are running in connected mode.

The following Jython example uses the updateDocumentStoreApplication command to update the installed application IBM_BPM_DocumentStore for a specified node and server:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.updateDocumentStoreApplication(['-nodeName', 'myNodeName', '-serverName', 'myServerName'])
wsadmin>AdminConfig.save()

The following Jython example uses the updateDocumentStoreApplication command to update the installed application IBM_BPM_DocumentStore for a specified cluster:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.updateDocumentStoreApplication(['-clusterName', 'myClusterName'])
wsadmin>AdminConfig.save()

The following Jython example uses the updateDocumentStoreApplication command to update the installed application IBM_BPM_DocumentStore for a specified deployment environment:

wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.updateDocumentStoreApplication(['-deName', 'myDeName'])
wsadmin>AdminConfig.save()

The following Jython example invokes the updateDocumentStoreApplication command on a specified target object:

wsadmin -user admin -password admin -lang jython
wsadmin>server = AdminConfig.getid('/Cell:/Node:myNodeName/Server:myServerName')
wsadmin>AdminTask.updateDocumentStoreApplication(server)
wsadmin>AdminConfig.save()

The following Jython example invokes the updateDocumentStoreApplication command on a specified target object:

wsadmin -user admin -password admin -lang jython
wsadmin>cluster = AdminConfig.getid('/Cell:/ServerCluster:myClusterName')
wsdmin>AdminTask.updateDocumentStoreApplication(cluster)
wsadmin>AdminConfig.save()

The following Jython example invokes the updateDocumentStoreApplication command on a specified target object:

wsadmin -user admin -password admin -lang jython
wsadmin>de = AdminConfig.getid("/Cell:/BPMCellConfigExtension:/BPMDeploymentEnvironment:myDeName/")
wsadmin>AdminTask.updateDocumentStoreApplication(de)
wsadmin>AdminConfig.save()