BPMInstallPackage command

Edit online

 Traditional: 
This command installs a process application or case solution snapshot from Workflow Center to a workflow server, which involves importing and deploying a process application or case solution to the workflow server.

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

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

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.
  • You must have write access to the temporary directory where the installation package is stored.
  • 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
-inactive true or false
-caseDosName input_dos_name
-caseProjectArea input_project_area
-caseOverwrite 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 Workflow Center server and transferred to the offline workflow server.
-showSnapshotInfo Boolean
An optional parameter that, when true, has the command return the acronyms of the process application, case solution, track, and snapshot that were installed.
-inactive Boolean
An optional parameter that, when true, disables automatic activation of a snapshot after it is deployed.
-caseDosName String
The design object store for case artifacts. You must provide the caseDosName parameter if the deployment package contains a case solution and the design object store is not named dos.
-caseProjectArea String
The target environment or project area for case artifacts. You can omit this value if the default project area is defined. you must provide the caseProjectArea parameter if the deployment package contains a case solution and no default project area is configured.
-caseOverwrite Boolean
An optional parameter that specifies to overwrite artifacts in the case store if they already exist. The default value is false.

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 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 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.
The following example illustrates how to install a snapshot of the BillingDispute process application with automatic activation disabled.
wsadmin>AdminTask.BPMInstallPackage('[-inputFile C:/myProcessApps/BillingDispute.zip -inactive true]')