This command extracts the process application snapshot
installation package from Process Center.
Purpose
If you want to install a snapshot
on an offline Process Server, use the BPMExtractOfflinePackage command
in connected mode from a Process Center server to extract the installation
package to a file. The extracted file can then be installed on the
offline Process Server.
In a network deployment
environment, you must run this command on the node containing the
application cluster member that handles Process 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.
Parameters
- -containerAcronym containerAcronym
- A required parameter that identifies the process application acronym.
For example, the BillingDispute process application might have an
acronym of BILLDISP.
- -containerSnapshotAcronym containerSnapshotAcronym
- 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 containerTrackAcronym
- On a Process Center server, 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.
- -serverName serverName
- A required parameter that identifies the offline Process Server
instance.
- -outputFile outputFilePath
- 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.
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 the Process Center console.
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 and find the value for
SOAP_CONNECTOR_ADDRESS).
- Jython example
wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython
AdminTask.BPMExtractOfflinePackage('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName processServer315 -outputFile C:/myProcessApps/BILLDISP201.zip]')
- Jacl example
wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin
$AdminTask BPMExtractOfflinePackage {-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main -serverName processServer315 -outputFile C:/myProcessApps/BILLDISP201.zip}