BPMProcessInstancesResumption command

Edit online
Use this command to resume process instances that are in a suspended state on IBM® Workflow Center and IBM Workflow Server.
Using this command resumes a process instance and its associated tasks based on the information specified by the command parameters. Progress and other information is logged in a standard SystemOut.log file.
Restriction: You cannot use this command to resume process instances that belong to a Tip.
The BPMProcessInstancesResumption command is run using the AdminTask object of the wsadmin scripting client.
Note: In an environment with multiple security domains configured, use the PALService MBean instead of this wsadmin command. See The Process Application LifeCycle (PAL) MBean.

Prerequisites

The following conditions must be met:
  • Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
  • You can run the command from any cluster member in a network deployment environment. However, you must first establish the wsadmin session to the SOAP port of the cluster member from where you are running the command.
  • 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 External link opens a new window or tab 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.

Location

Start the wsadmin scripting client from the install_root/bin directory.

Syntax

BPMProcessInstancesResumption
-containerAcronym process_application__or_toolkit_acronym
-containerSnapshotAcronym snapshot_acronym
[-maxNumberOfInstances n]
[-getNumberOfInstances]

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.
-containerSnapshotAcronym String
A required parameter that identifies the process application or toolkit snapshot acronym.
Tip: You can find the process application acronym on the snapshot page in Workflow Center or by using the BPMShowProcessApplication command.
-maxNumberOfInstances Integer
An optional parameter that limits the maximum number of instances to resume. If this parameter is not used, all suspended process instances of the specified context are resumed by default.
-getNumberOfInstances
This is an optional parameter that returns the suspended instances associated with the given context. This parameter and the -maxNumberOfInstances parameter are mutually exclusive.

Examples

In the following example, you first establish a SOAP connection to the server and then use the BPMProcessInstancesResumption command to resume a maximum of 500 suspended process instances in a snapshot of the BillingDispute process application. The snapshot is part of the Main track.

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.BPMProcessInstancesResumption('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -maxNumberOfInstances 500]')
This example returns the number of suspended instances that are in the specified snapshot of the process application or toolkit.
wsadmin>AdminTask.BPMProcessInstancesResumption('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -getNumberOfInstances]')