BPMCreateSnapshot command

Edit online

Traditional:
Use this command to create snapshots for process applications or toolkits. You might want to run the command, for example, to automate the creation of an off-line backup of the current snapshots of your process applications and toolkits.

Use the BPMCreateSnapshot command in connected mode from Workflow Center to create snapshots for process applications or toolkits. You can run this command only on Workflow Center.

The BPMCreateSnapshot 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, an application cluster member runs the Workflow Server and Workflow Center applications. Therefore, you must run this command on the node that contains that application cluster member. Do not run the command from the deployment manager profile.
You can run the command for only one process application or toolkit at a time.

Attention: 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

BPMCreateSnapshot 
-containerAcronym process_application_or_toolkit_acronym
[-containerTrackAcronym track_acronym]
-snapshotName snapshot_name
-snapshotDescription snapshot_description

Parameters

-containerAcronym String: A required parameter that identifies the process application or toolkit acronym. For example, the BillingDispute process application might have an acronym of BILLDISP.
-containerTrackAcronym String: On a Workflow Center server, an optional parameter that identifies the acronym of the track associated with the process application. If not specified, the default track is used. Projects can have a non-default track if track development is enabled in Workflow Center. Snapshots installed on a Workflow Server do not have tracks.
-snapshotName String: A required parameter that identifies the snapshot. You can include any of the following characters in the name: A-Z 0-9 _
-snapshotDescription String: An optional parameter that describes the snapshot.

Example

The following example shows how to establish a SOAP connection to Workflow Server and create a snapshot, SS1, for the TPA process application.

wsadmin -conntype SOAP -port 8880 -host ProcessCenterServer01.mycompany.com -user admin -password admin -lang jython

wsadmin>AdminTask.BPMCreateSnapshot("[-containerAcronym TPA -containerSnapshotName SS1 -containerSnapshotDescription '0824snapshot']")

If you don't provide a track acronym, the default track, Main, is used.

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).