BPMCreateOfflinePackage command

Edit online

 Traditional: 
Use this command to create an installation package for a process application snapshot on the Workflow Center server. You cannot use the BPMCreateOfflinePackage command to set the migration plan.

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

When this command is called, unless the -skipGovernance parameter is set to true, the governance process that is defined for the process application runs asynchronously. Therefore, the command might successfully return before the governance process finishes.

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:
  • To run this command successfully, you must have Business Automation Workflow administrative privileges. Make sure that you are a member of the default tw_admins group, or the group defined by the bpmAdminGroup properties if the default group has been modified.

  • If you want to install a snapshot on an offline Workflow Server, use the BPMCreateOfflinePackage command in connected mode from a Workflow Center server to create an installation package of a snapshot. This package is stored in the database. You can extract the package to a zip file with the BPMExtractOfflinePackage command, and then install the zip file on the offline Workflow Server with the BPMInstallOfflinePackage command.

  • In a network deployment environment, you must run this command on the node containing the application cluster member on the Workflow Center server. 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

BPMCreateOfflinePackage 
-containerAcronym process_application_acronym
-containerSnapshotAcronym process_application_snapshot_acronym
[-containerTrackAcronym track_acronym]
-serverName offline_process_server
-skipGovernance true|false

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.

For detailed information about the process applications in Workflow Center, use the BPMListProcessApplications command. Use the BPMShowProcessApplication command to know about the process application snapshots, including acronyms.

-containerTrackAcronym track_acronym
On a Workflow Center server, an optional parameter that identifies the acronym of the track associated with the process application.
-serverName offline_process_server
A required parameter that identifies the offline Workflow Server instance. You can use this command only if the offline server has already been created. If an offline server already exists, in the Workflow Center, go to the Servers tab to locate the server name parameter for the existing offline servers. You can also use the BPMListServers command to locate this parameter
Tip: If you want to create a new offline server in Workflow Center and want to know the name of the actual workflow server, open the 99Local.xml file and search for <environment-type>Test</environment-type> to locate the server name parameter. For information on locating the 99Local.xml file, see The 100Custom.xml file and configuration. In case of multiple offline servers, for each server that you want to install the snapshot on, a separate installation package needs to be created.
-skipGovernance true|false
This parameter is set to false by default. If you want to create an installation package for a process application snapshot on the Workflow Center server that skips all governance processes, change the value to true. Governance processes add human approvals into the processing of a snapshot installation. For more information, see Applying governance to a process application. Skipping a governance process should be used rarely, because it bypasses whatever approval process you have established. For example, you might decide to skip the governance process if an updated snapshot is needed to fix a product problem but the approver is not available.

Example

The following example illustrates how to establish a SOAP connection to the Workflow Center server, and then create an installation package for the snapshot of the BillingDispute process application.

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Workflow Center server. 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.BPMCreateOfflinePackage('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName processServer315 -skipGovernance false]')