BPMStop command

This command stops a process application snapshot that has already been deactivated on a process server. It is available only for snapshots that have Advanced Integration Services.

Use the BPMStop command in connected mode to stop a deactivated snapshot on a process server.

This command does not stop any running process and task templates that belong to the process application. Use the bpcTemplates.jacl administrative script to stop these before you use the BPMStop command. If there are still running BPEL templates when you run the BPMStop command, it fails. For more information, see "bpcTemplates,jacl administrative script" at the end of this topic.

The BPMStop 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, you must run this command on the node containing the application cluster member that handles Process Server applications. Do not run this command from the deployment manager profile.
In a network deployment environment, make sure that all the nodes are active before running the command. If a cluster member is inactive, the underlying invocations fail and cause errors when you undeploy a process application. However, because the command runs asynchronously, meaning it is not blocked if underlying invocations fail, you're still informed that the command completed successfully despite the errors. Therefore, check the SystemOut.log file to ensure that the command succeeded.
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.

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

Syntax

BPMStop
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_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.
-containerSnapshotAcronym process_application_snapshot_acronym: A required parameter that identifies the process application snapshot acronym.
If you are not working with a snapshot, use Tip as the value for this parameter.

Tip: If you do not know the acronym for a required parameter, use the BPMShowProcessApplication command to list the details of a process application, including acronyms.

Example

The following example illustrates how to establish a SOAP connection to the Process Center server, and then stop a snapshot 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 ProcessServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMStop('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1]')