BPMArchive command
This command archives a process application snapshot on the Process Center server.
Use the BPMArchive command in connected mode to stop deactivated snapshots and then archive them.
Only the business process definition (BPD) is activated when you activate a process application. If the process application uses BPEL processes and the templates were stopped (as described in "Administering BPEL process and task templates"), follow the instructions in that section to start the templates.
The BPMArchive command is run using the AdminTask object of the wsadmin scripting client.
Prerequisites
- In a network deployment environment, an application cluster member runs the Process 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 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.
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
- On a Process Center server, an optional 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. Snapshots installed on a Process Server do not have tracks.
Example
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]')