BPMExport command

This command exports a process application or toolkit snapshot as a .twx file that you can import into a Process Center server.

Use the BPMExport command to exchange a process application or toolkit between Process Center servers. You must run the command in connected mode from a Process Center server.

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

Prerequisites

Important: 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:
  • In a network deployment environment, you must run this command on the node containing the application cluster member that handles Process 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. 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.

  • Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
  • To access the wsadmin command, the ID being used must have a WebSphere® Application Server role with more privileges than the monitor role. See Administrative roles for information about roles.
  • To access the IBM® BPM API used by this command, the ID being used must belong to either the bpmAdminGroup or bpmAuthorGroup. The default name for the bpmAdminGroup is tw_admins and the default name for the bpmAuthorGroup is tw_authors. See IBM Business Process Manager default group types for information about groups.
    Tip: By default, only the DeAdmin user has both the WebSphere Application Server administrator role and membership in the bpmAdminGroup.
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.

You can check the status of the command in the server SystemOut.log file.

Syntax

BPMExport 
-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.
-containerTrackAcronym track_acronym
A required parameter that identifies the acronym of the track associated with the process application. Snapshots can have a track if track development is enabled in the Process Center and is applied for playback on the Process Center server; by default, the value is Main.
-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 .twx 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 Process Center server.

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Process Server or Process 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.BPMExport('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -outputFile C:\processApps\BILLDISP201.twx]')