BPMUndeploy command

This command undeploys a process application snapshot from a server. It is available only if the snapshot contains advanced content generated in IBM® Integration Designer and has a corresponding business-level application (BLA) deployed on the server.

A BLA is a WebSphere® Application Server configuration artifact that is created only for a snapshot that has advanced content generated in IBM Integration Designer.

Use the BPMUndeploy command in connected mode to undeploy a process application snapshot from a Process Center or Process Server.

Undeploying the snapshot removes any Service Component Architecture (SCA) modules, monitor models, and BLAs associated with the snapshot. If your process application contains BPEL processes, see the "Deactivating and stopping process applications" link at the end of this topic.

Note: If you undeploy a snapshot from Process Server, the snapshot is still listed in the Installed Apps tab of the Process Admin console. Similarly, in the Snapshots tab of Process Center, the snapshot is still listed, but it displays a Process Server installation status of Currently Installed because the content of the snapshot still exists in the Process Server repository. To delete the snapshot content on Process Server, you must run the BPMDeleteSnapshot command command.

The BPMUndeploy 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:

Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
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.
The BLA associated with the snapshot must be in the STOPPED state. For more information, see BPMStop command.

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

BPMUndeploy 
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
[-containerTrackAcronym track_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. If advanced content is used in the Process application, the Tip value triggers the deployment and start of the tip version of the BPEL application.
-containerTrackAcronym track_acronym: On a Process Center server, an optional parameter that identifies the acronym of the track associated with the process application. If not specified, the default track is used. Projects can have a non-default track if track development is enabled in the Process Center. 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 establish a SOAP connection to the Process Center server, and then undeploy 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 ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython

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