Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.process.instanceControl Folder | pub.monitor.process.instanceControl:changeInstanceStatus
 
pub.monitor.process.instanceControl:changeInstanceStatus
Stops, suspends, or resumes a specified process instance.
Input Parameters
The following table lists the input parameters.
instanceID
String Instance ID for the process instance that you want to stop, suspend, or resume. Specify the complete, exact ID.
Note: Whether Monitor treats instanceID as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
instanceIteration
Number Specific process iteration that you want to stop, suspend, or resume.
modelID
String Complete model ID of the model that the process instance uses. You can retrieve model IDs by invoking the pub.monitor.process.instance:getProcessList service and using the value returned in the processNames/PROCESSKEY output parameter.
Note: Whether Monitor treats modelID as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
controlAction
String Control action that you want to take against the specified process instance.
*CANCEL Stop the running process iteration.
*SUSPEND Suspend the running process iteration.
*RESUME Resume the suspended process iteration.
*String x
modelVersion
String The version of the process model that the process instance uses. The model version for externally executed process models is always 1.
Output Parameters
The following table lists the output parameters.
controlMessage
String Message that indicates the success of the status change.
Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release