BPMInstallOfflinePackage command

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
This command uses a custom installation package to install a process application snapshot from Workflow Center to an offline workflow server.

Use the BPMInstallOfflinePackage command in connected mode from a workflow server to install a snapshot from a custom installation package on the workflow server. Use the BPMInstallPackage command to install a snapshot from a custom installation package or a generic installation package. For information, see BPMInstallPackage command.

The BPMInstallOfflinePackage 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.
Draft comment:
Are the following statements correct? What is the securty role information? Should it be run in connected or not connnected mode?
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.

If the process application contains advanced content, advanced deployment may complete after the command has successfully returned. The state of the snapshot should be checked to confirm it has been deployed. The server logs should be checked for errors if the state does not change to active.

Location

Draft comment:
Is the following statement correct?

Start the wsadmin scripting client from the profile_root/bin directory.

Syntax

BPMInstallOfflinePackage 
-inputFile input_file_path
-inactive true or false

Parameters

-inputFile input_file_path
A required parameter that identifies the absolute path of the offline installation package you created and extracted on the Workflow Center server and transferred to the offline server.
-inactive Boolean
An optional parameter that, when true, disables automatic activation of a snapshot after it is deployed.

Example

The following example illustrates how to install a snapshot of the BillingDispute process application. The snapshot installation package (BillingDispute.zip) was created and extracted on the Workflow Center server and is being installed on the offline Workflow Server.

In the example, the user establishes a SOAP connection to the Workflow 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.BPMInstallOfflinePackage('[-inputFile C:/myProcessApps/BillingDispute.zip]')
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.BPMInstallOfflinePackage('[-inputFile C:/myProcessApps/BillingDispute.zip -inactive true]')