wfgroupstop
usage: wfgroupstop [ -immediate ] <pattern match expression for workflow group name>...
Stops one or more workflow groups. The workflow group does not stop instantly, but rather waits for all the workflow group members to stop running, before the whole group is fully stopped and return to the Idle
state.
With this command you compare a single pattern match expression, or several, with the full workflow group name, <folder>.<groupconfigurationname>.<workflowgroupname>, of all the workflows.
The command accepts wild cards, such as '*' and '?'. For further information see Textual Pattern Matches.
Option | Description |
---|---|
[-immediate] | When this option is used, the workflow group is stopped without waiting for a batch to finish. |
Return Codes
Listed below are the different return codes for the wfgroupstop
command:
Code | Decsription |
---|---|
0-> | Will indicate the number of failed group stops or the number of arguments that are incorrect. |
1 | Will be returned if no user is logged in. |