BPMShowSnapshot command
This command lists information about a process application or toolkit snapshot, or information about the tip if you are not working with a snapshot.
Use the BPMShowSnapshot command in connected mode from either a Process Center server or a Process Server to return detailed information about a snapshot or tip, including any dependencies.
The BPMShowSnapshot command is run using the AdminTask object of the wsadmin scripting client.
Prerequisites
In a network deployment environment, you must run this command on the node containing the application cluster member that handles Process Server or Process Center applications. Do not run this 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 for information about roles.
- To access the IBM® BPM 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 Process Manager 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.
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
BPMShowSnapshot
-containerAcronym process_application_or_toolkit_acronym
-containerSnapshotAcronym snapshot_acronym
[-containerTrackAcronym track_acronym]
[-showDependents]
Parameters
- -containerAcronym process_application_acronym
- A required parameter that identifies the process application or toolkit acronym. For example, the BillingDispute process application might have an acronym of BILLDISP.
- -containerSnapshotAcronym process_application_snapshot_acronym
- A required parameter that identifies the snapshot acronym. If you want to see the details for the current tip, use Tip as the value for this parameter.
- -containerTrackAcronym track_acronym
- On a Process Center server, an optional parameter that identifies the acronym of the track associated with the process application. If not specified, the default track is used. Projects can have a non-default track if track development is enabled in the Process Center. Snapshots installed on a Process Server do not have tracks.
- -showDependents
- An optional parameter that identifies all dependencies on the specified snapshot. Running this parameter displays a list of toolkit and process application snapshots that have dependencies on the snapshot.
Example
The following example illustrates how to establish a SOAP connection to the Process Center server and return information about the process application snapshot called BILLDISPSS02
wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython
wsadmin>AdminTask.BPMShowSnapshot('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main]')
Name: Main - JSActivate
Acronym : MJSA
Created On :2013-09-01 14:05:03.207
Created By :User1
State : State[Archived]
Depends on snapshot Main - JSActivate:
Process App Acronym: PA1
Process App Name: PA1
Snapshot Name: PA1S1
Snapshot Acronym: PA1S1
Created On: 2014-02-26 14:25:31.016
Created By: User.2