getDocumentStoreStatus command

Edit online
Use the getDocumentStoreStatus command to return information about theBPM document store in IBM® Business Automation Workflow. The command determines the availability of the BPM document store and returns detailed information about document migrations to the document store. It also returns information about whether the IBM_BPM_DocumentStore application is up-to-date in comparison to the authentication alias and the EAR file version.

The getDocumentStoreStatus 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.

Before running this command, you should review the task topic "Obtaining the status of the BPM document store."

Location

Start the wsadmin scripting client from the profile_root/bin directory of the deployment manager profile. The getDocumentStoreStatus command does not write to a log file, it directly responds with a message. However, 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

getDocumentStoreStatus
-serverName server_name
-nodeName node_name
-clusterName cluster_name
-deName deployment_environment_name
-authorizationDetails (optional)

Parameters

-serverName server_name
A required parameter that specifies the server name of the 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 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 BPM document store.
-deName deployment_environment_name
A required parameter that specifies the deployment environment name of Business Automation Workflow.
-authorizationDetails
An optional parameter that determines the user who is allowed to access the 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 following Jython example uses the getDocumentStoreStatus command to retrieve the status of the BPM document store for a specified node and server:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.getDocumentStoreStatus(['-nodeName', 'myNodeName', '-serverName', 'myServerName'])
The following Jython example uses the getDocumentStoreStatus command to retrieve the status of the BPM document store for a specified cluster:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.getDocumentStoreStatus(['-clusterName', 'myClusterName'])
The following Jython example uses the getDocumentStoreStatus command to retrieve the status of the BPM document store for a specified deployment environment:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.getDocumentStoreStatus(['-deName', 'myDeName'])
The following Jython example invokes the getDocumentStoreStatus command on a specified target object:
wsadmin -user admin -password admin -lang jython
wsadmin>server = AdminConfig.getid('/Cell:/Node:myNodeName/Server:myServerName')
wsadmin>AdminTask.getDocumentStoreStatus(server)
The following Jython example invokes the getDocumentStoreStatus command on a specified target object:
wsadmin -user admin -password admin -lang jython
wsadmin>cluster = AdminConfig.getid('/Cell:/ServerCluster:myClusterName')
wsadmin>AdminTask.getDocumentStoreStatus(cluster)
The following Jython example invokes the getDocumentStoreStatus command on a specified target object:
wsadmin -user admin -password admin -lang jython
wsadmin>de = AdminConfig.getid("/Cell:/BPMCellConfigExtension:/BPMDeploymentEnvironment:myDeName/")
wsadmin>AdminTask.getDocumentStoreStatus(de)
The following Jython example invokes the getDocumentStoreStatus command to retrieve the status of the BPM document store and authorization information such as the user who is allowed to communicate with the document store, for a specified deployment environment. This information is required to repair communication errors with the document store that manifest in CWTDS0021E/CWTDS0022E exceptions that are logged during start-up:
wsadmin -user admin -password admin -lang jython
wsadmin>AdminTask.getDocumentStoreStatus(['-deName', 'myDeName', '-authorizationDetails'])