BPMGetSnapshotAcronym command

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
This command retrieves the snapshot acronym of a snapshot.

Use the BPMGetSnapshotAcronym command in connected mode from either Workflow Center server or Workflow Server to return the acronym of a snapshot of a process application on Workflow Center or Workflow Server.

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

Prerequisites

Important: In an environment with multiple security domains configured, use the PALService MBean instead of this wsadmin command. See The Process Application LifeCycle (PAL) MBean.
The following conditions must be met:
  • In a network deployment environment, an application cluster member runs the Workflow Server and Workflow Center applications. Therefore, you must run this command on the node that contains that application cluster member. Do not run the command from the deployment manager profile.
  • Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
  • To access the wsadmin command, the ID being used must have a WebSphere® Application Server role with more privileges than the monitor role. See Administrative roles External link opens a new window or tab for information about roles.
  • To access the Business Automation Workflow API used by this command, the ID being used must belong to either the bpmAdminGroup or bpmAuthorGroup. The default name for the bpmAdminGroup is tw_admins and the default name for the bpmAuthorGroup is tw_authors. See IBM Business Automation Workflow default group types for information about groups.
    Tip: By default, only the DeAdmin user has both the WebSphere Application Server administrator role and membership in the bpmAdminGroup.
Attention: If you are using a SOAP connection, the command can take longer to complete than the specified SOAP timeout value. Although the command continues to run until it is finished, you might see the exception java.net.SocketTimeoutException: Read timed out. To prevent this exception, set a higher value for the com.ibm.SOAP.requestTimeout property in the profile_root/properties/soap.client.props file.

Location

Start the wsadmin scripting client from the profile_root/bin directory.

You can check the status of the command in the server SystemOut.log file.

Syntax

BPMGetSnapshotAcronym 
-containerAcronym process_application_acronym
-containerSnapshotName snapshot_name

Parameters

-containerAcronym String
A required parameter that contains the acronym of the container that has the snapshot. For example, the BillingDispute process application might have an acronym of BILLDISP.
-containerSnapshotName String
A required parameter that contains the name of the snapshot.

Example

wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMGetSnapshotAcronym('[-containerAcronym BILLDISP -containerSnapshotName 1.1]')