BPMInstall command

Edit online

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

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

The BPMInstall command is run using the AdminTask object of the wsadmin scripting client.

When this command is called, unless the -skipGovernance parameter is set to true, the governance process that is defined for the process application runs asynchronously. Therefore, the command might successfully return before the governance process finishes. Also, if the process application contains advanced content, advanced deployment might complete after the command has successfully returned. Check the state of the snapshot to verify whether it has been deployed and check the server logs for errors if the state does not change to active.

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 Workflow 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
[-containerTrackAcronym track_acronym]
-serverName server_name
-skipGovernance true|false
-caseProjectArea input_project_area

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.
-containerTrackAcronym String
On a Workflow Center server, an optional parameter that identifies the acronym of the track associated with the process application.
-serverName server_name
A required parameter that specifies the name of the Workflow 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.
-caseProjectArea String
The target environment or project area for case artifacts. If the container being installed is a case solution, you must provide the caseProjectArea 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 install a snapshot of the BillingDispute process application on the online Workflow Server ProcessServer01. In the example, the user establishes a SOAP connection to the Workflow Center server.

This topic applies only to the IBM Business Automation Workflow Advanced configuration.
Important: In a network deployment environment, use the port configured for the application cluster member that runs the Workflow Server or Workflow 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]')