BPMExportInstallPackage 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 creates a generic install package (.zip file) for a process application or case solution snapshot. The generic install package is not targeted at any specific workflow server.

Use the BPMExportInstallPackage command to install a process application or case solution on any workflow server.

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

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:

In a network deployment environment, you must run this command on the node containing the application cluster member that handles Workflow Center applications. Do not run this command from the deployment manager profile. The generated file is saved on the machine where the connected server is running. In order to save the generated file on another machine, establish a remote wsadmin session from the current machine to the server on the machine where you want to save the file.
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

Draft comment:
Is the following statement correct?

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

Syntax

BPMExportInstallPackage 
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
[-containerTrackAcronym track_acronym]
-outputFile file_path

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.
If you are not working with a snapshot, use Tip as the value for this parameter.
-containerTrackAcronym track_acronym: On a Workflow Center server, an optional parameter that identifies the acronym of the track associated with the process application.
-outputFile file_path: A required parameter that identifies the absolute path for the export file you are creating. This name must be unique and must have a .zip extension.

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 export a snapshot of the BillingDispute process application. 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.BPMExportInstallPackage('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -outputFile C:\processApps\BILLDISP201.zip]')