IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)

BPMDeactivate command

This command deactivates a running process application snapshot on the Process Center server or a Process Server.

Purpose

Use the BPMDeactivate command to deactivate a snapshot. Deactivating allows all existing instances to complete processing, but no new requests are processed. 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.

You might need to deactivate a snapshot if you want to undeploy it from a Process Center server, or if you want to stop it or undeploy it from a Process Server.

Use this command does not stop a BPEL process. Unless you are running the server in development mode or you are running the process application on a Process Center server, you might need to perform additional actions for process applications that include BPEL processes:

• If your process application uses a BPEL process as the main entry component, you must stop the corresponding BPEL template in the WebSphere administrative console. See "Administering BPEL process and task templates."

• Additionally, if this BPEL process invokes a BPD, you must allow any existing instances to complete after you stop the template but before you deactivate the snapshot. See "Administering BPEL process and task templates."

• In all cases, you must clean up the associated process instance data from the Business Process Choreographer database, as described in "Cleanup procedures for Business Process Choreographer."

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.

Parameters

-containerAcronym containerAcronym

A required parameter that identifies the process application acronym.

For example, the BillingDispute process application might have an acronym of BILLDISP.

-containerSnapshotAcronym containerSnapshotAcronym

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.

-containerTrackAcronym containerTrackAcronym

On a Process Center server, a required parameter that identifies the acronym of the track associated with the process application. 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.

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 deactivate a snapshot of the BillingDispute process application. The snapshot is part of the MAIN track. In the example, the user establishes a SOAP connection to the Process Center server.

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).

• Jython example

  wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython
  
  AdminTask.BPMDeactivate('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main]')
  

• Jacl example

  wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin
  
  $AdminTask BPMDeactivate {-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main}
  

Parent topic: Commands (wsadmin scripting)

Related tasks:

Deactivating and stopping process applications

Related information:

Administer BPEL process and task templates
Cleanup procedures for Business Process Choreographer
BPEL process administration - frequently asked questions