BPMExtractOfflinePackage command

Edit online

 Traditional: 
This command extracts the process application snapshot installation package from Workflow Center. The package is a .zip file that contains a .twx file.

If you want to install a snapshot on an offline Workflow Server, use the BPMExtractOfflinePackage command in connected mode from a Workflow Center server to extract the installation package to a file. The extracted file can then be installed on the offline Workflow Server.

The BPMExtractOfflinePackage 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 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

BPMExtractOfflinePackage 
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
[-containerTrackAcronym track_acronym]
-serverName server_name
-outputFile output_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.
Note: Use the BPMShowProcessApplication command to obtain process application information, including the 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.
-serverName server_name
A required parameter that identifies the offline Workflow Server instance.
-outputFile output_file_path
A required parameter that identifies the absolute path and file name of the file you want to create with this command. The file name must be unique and have the .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 extract an installation package for the snapshot of the BillingDispute process application. The package was created by using the BPMCreateOfflinePackage command or Workflow Center.

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

wsadmin>AdminTask.BPMExtractOfflinePackage('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName processServer315 -outputFile C:/myProcessApps/BILLDISP201.zip]')