BPMInstallPackage command

This command installs a process application snapshot from Process Center to a process server.

Use the BPMInstallPackage command in connected mode from a process server to install a process application snapshot installation package on the process server.

The BPMInstallPackage 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 installation package must already be created and extracted on the server. After this command is complete, the installed snapshot is active.
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

BPMInstallPackage
-inputFile input_file_path
-showSnapshotInfo true or false

Parameters

-inputFile String: A required parameter that identifies the absolute path of the offline installation package that you created and extracted on the Process Center server and transferred to the offline process server.
-showSnapshotInfo Boolean: An optional parameter that, when true, has the command return the acronyms of the process application, track, and snapshot that were installed.

Example

The following example illustrates how to install a snapshot of the BillingDispute process application.

In the example, the user establishes a SOAP connection to the Process 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 ProcessServer.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMInstallPackage('[-inputFile C:/myProcessApps/BillingDispute.zip -showSnapshotInfo true]')

Important: In a clustered environment, the SOAP connection parameters used for the wsadmin command should point to one of the cluster members where the application is to be deployed, and not to the deployment manager.