WMTerminateProcessInstances WMTerminateProcessInstancesThis call allows terminating the process instances of the named process definition that match the specified filter criterion. This command provides the capability of terminating a set of process instances associated with a process definition. Execution of this command will cause a set of process instances of the named process definition to be terminated.
You can view the XML input and output parameters, which have to be passed for terminating process instance. There is a list of errors and warning that can occur in the execution.
|
|
|
Name |
Parent Tag |
Description |
Valid Value |
|
Option |
Root |
It refers to the case sensitive call name. |
case sensitive call name. |
|
EngineName |
Root |
It is the cabinet or database name, which has to be connected. |
NA
|
|
SessionID |
Root |
It is the logged in user session id |
NA
|
|
ProcessDefinitionId |
Root |
It refers to the id of the process definition |
NA
|
|
Type |
Filter |
Type of the filter criteria specified. Filter type can be SQL string or an attribute. If you are filtering on attributes, then filter string contains the value of the attribute. 0-255 are reserved , if it is 256 than its SQL type filter. Then you Filter string will contains an SQL query. |
NA
|
|
AttributeName |
Filter |
It is the name of attribute for filtering. |
NA
|
|
Comparison |
Filter |
It is operator for the filter |
1 for > ; 2 for >= ;3 for =; 4 <> ; 5 for <; 6 for <=; 7 for like, 8 for not like. |
|
FilterString |
Filter |
It is string specified for the filtering |
NA
|
|
Length |
Filter |
It is the length of the attribute for filtering |
NA
|
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
|
502 |
WM_INVALID_PROCESS_DEFINITION |
The process definition ID was not valid. |
|
15 |
WM_INVALID_FILTER |
The requested filter is invalid. |