BPMInstall command

This command installs a process application snapshot from a Process Center to a Process Server in a test or production environment.

Use the BPMInstall command in connected mode from a Process Center server to install a process application snapshot on an online Process Server.

The BPMInstall 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.
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

BPMInstall 
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
-serverName server_name
-skipGovernance true|false

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.
-serverName server_name: A required parameter that specifies the name of the Process Server instance where you are installing the snapshot.
-skipGovernance true|false: This parameter is set to false by default. If you want to install a process application snapshot to a test or production environment that skips all governance processes, change the value to true. Governance processes add human approvals into the processing of a snapshot installation. For more information, see Applying governance to a process application. Skipping a governance process should be used rarely, because it bypasses whatever approval process you have established. For example, you might decide to skip the governance process if an updated snapshot is needed to fix a product problem but the approver is not available.

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 install a snapshot of the BillingDispute process application on the online Process Server ProcessServer01. 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.BPMInstall('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName ProcessServer01 -skipGovernance false]')