BPMArchive command

Edit online

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15

This command archives a process application snapshot on the Workflow Center server.

The archive function allows all active processes related to the snapshot to complete, but new processes cannot be started.

Use the BPMArchive command in connected mode to archive snapshots. The 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 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.
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 Business Automation Workflow 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 Automation Workflow 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.

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.

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

Syntax

BPMArchive 
-containerAcronym acronym
-containerSnapshotAcronym process_application_snapshot_acronym
[-containerTrackAcronym track_acronym]

Parameters

-containerAcronym String: A required parameter that identifies the process application or toolkit using its acronym. For example, the BillingDispute process application might have an acronym of BILLDISP.
Tip: If you do not know the acronym, use the BPMShowProcessApplication command to list the details of a process application, including acronyms.
-containerSnapshotAcronym String: A required parameter that identifies the process application snapshot acronym.
If you are not working with a snapshot, use Tip as the value for this parameter.
-containerTrackAcronym String: An optional parameter that identifies the acronym of the track associated with the process application.

Example

The following example illustrates how to archive a snapshot of the BillingDispute process application. The snapshot is part of the Main track. 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.BPMArchive('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main]')