BPMShowProcessApplication command

This command lists information about a process application on a Process Center or a Process Server.

Use the BPMShowProcessApplication command in connected mode from either a Process Center server or a Process Server to return detailed information about a process application, including a list of all its snapshots.

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

Prerequisites

Note: 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, 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.

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 deployment_manager_profile/bin directory.

Syntax

BPMShowProcessApplication 
-containerAcronym process_application_acronym

Parameters

-containerAcronym process_application_acronym: A required parameter that identifies the process application acronym. For example, the BillingDispute process application might have an acronym of BILLDISP.

Example

The following example illustrates how establish a SOAP connection to the Process Center server and then show the details of the BillingDispute process application.

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Process Server or Process Center applications. To determine the correct port number, see the WebSphere administrative console Ports collection page (click Servers > Server Types > WebSphere application servers > server_name > Communications > Ports and find the value for SOAP_CONNECTOR_ADDRESS).

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

wsadmin>AdminTask.BPMShowProcessApplication('[-containerAcronym BILLDISP]')

Tip: Add the Jython print statement before the command when you want to see formatted output.

The output is similar to the following example.

Name: Credit Card Dispute Management
Acronym: CCDMDIP
Description: Main Process Application of the Credit Card Dispute Management Application.


Contains:

- the Manage Dispute Case type
- the related Launch UI
- related Activities
Toolkit: false
Tracks:

Track Name: Main
Track Acronym: Main
Default: true

Tip:
Created On: 2014-05-13 11:21:30.289
Created By: User.1
State: State[Inactive]
Capability: Capability[Standard]
No of running instances: 0

List of Snapshots:
Name: sn_for_Hursley
Acronym: SFH
Created On: 2014-05-12 14:05:08.563
Created By: User.9
Is Default: false
State: State[Inactive]
Capability: Capability[Standard]
No of running instances: 0

Name: ws_changed_smtpServer2
Acronym: WCSS2
Created On: 2014-05-13 11:21:30.289
Created By: User.1
Is Default: false
State: State[Inactive]
Capability: Capability[Standard]
No of running instances: 0