BPMDeactivate command

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

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.

The BPMDeactivate 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, an application cluster member runs the Process Server and Process Center applications. Therefore, you must run this command on the node that contains that application cluster member. Do not run the command from the deployment manager profile.

Using 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."

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.

Syntax

BPMDeactivate 
-containerAcronym process_application_or_toolkit_acronym
-containerSnapshotAcronym snapshot_acronym
-containerTrackAcronym track_acronym
[-force]

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 are not working with a snapshot, use Tip as the value for this parameter.
-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.
-force: An optional parameter that specifies that you want to deactivate the default snapshot of a process application. Default snapshots are not deactivated unless you include the force 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 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.

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.BPMDeactivate('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main]')