BPMShowInstallMessages command

This command returns detailed messages from the snapshot installation on a Process Center or a Process Server.

You can use the information returned by the BPMShowInstallMessages command to troubleshoot a failed installation and also to determine the current step in the snapshot installation process.

The BPMShowInstallMessages 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.
Note: 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.

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.

Syntax

BPMShowInstallMessages 
-containerAcronym process_application
-containerSnapshotAcronym snapshot_acronym
-containerTrackAcronym track_acronym
-serverName  process_server_instance_name
[-verbose true|false]

Parameters

-containerAcronym process_application
A required parameter that identifies the process application. For example, the BillingDispute process application might have an acronym of BILLDISP.
-containerSnapshotAcronym snapshot_acronym
A required parameter that identifies the snapshot acronym. When you are not working with a snapshot, you can use Tip as the value for this parameter.
Tip: You can find the process application acronym on the snapshot page in Process Center or by using the BPMShowProcessApplication command.
-containerTrackAcronym track_acronym
On a Process Center server, a required parameter that identifies the acronym of the track associated with the process application or toolkit. Snapshots can have a track if track development is enabled in the Process Center and is applied for playback on the Process Center server; by default, the value is Main. Snapshots installed on a Process Server do not have tracks.
-serverNameserver_name
When executing on Process Center, a required parameter that specifies the name of the Process Server instance where you are installing the snapshot. This parameter is ignored when executing on a Process Server.
-verbose
An optional parameter that, when set to true, returns additional message details that include start time and end time, user information, thread name, and server name. The default value is false.

Example

The following example illustrates how to establish a SOAP connection to the Process Center server and then show messages from the installation of the BillingDispute process application. The snapshot is part of the Main track.

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
Basic command:
AdminTask.BPMShowInstallMessages('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName dev]')
Sample output:
[x] Initiate install of snapshot SS1 to server dev as tw_admin
    [i] Process Application uses govenance process DEFAULT
[x] Start governance process DEFAULT
[x] Assemble artifacts and send to server dev1
    [i] Use address http://localhost:9080/teamworks
[x] Process server dev received artifacts from Process Center
[x] Initiate install of snapshot SS1 as tw_author
[*] Install the necessary library items and assets for the process application and referenced toolkits
    [*] Install Toolkit TK1, snapshot SS1

Legend: (x = Complete, * = Running, f = Failed, e = Error, w = Warning, i = Informational, r = Recovery )
Command using -verbose parameter:
wsadmin>AdminTask.BPMShowInstallMessages('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName dev -verbose true]')
Sample output:
[x] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Initiate install of snapshot SS1 to server dev as tw_admin
    [i] [1123a,server1,05/23/2014 12:24:30.112 PM EST] Process Application uses govenance process DEFAULT
[x] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Start governance process DEFAULT
[x] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Assemble artifacts and send to server dev1
    [i] [1123a,server1,05/23/2014 12:24:30.112 PM EST] Use address http://localhost:9080/teamworks
[x] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Process server dev received artifacts from Process Center
[x] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Initiate install of snapshot SS1 as tw_author
[*] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Install the necessary library items and assets for the process application and referenced toolkits
    [*] [1123a,server1,05/23/2014 12:24:30.112 PM EST,05/23/2014 12:24:30.390 PM EST] Install Toolkit TK1, snapshot SS1

Legend: (x = Complete, * = Running, f = Failed, e = Error, w = Warning, i = Informational, r = Recovery )
Tip: Add the jython print statement before the command when you want to see formatted output.
Parent topic: Commands (wsadmin scripting)