wfgroupstart(4.3)
- Jenni Wallin
Usage
usage: wfgroupstart <pattern matching expression for workflow group names> ... [-w <timeout s>] [-b]
-w <timeout> = await group completion, times out after <timeout> seconds if group is not completed
-b = blocks until group is completedStarts one or more workflow groups.
Example - Run wfgroupstart
Example interactive mode:
$ java -jar mzcli.jar wfgroupstart MyFolder.MyWorkflowGroup --password MyPassword --port MyPortNumber
Note that you must specify the location of the workflow group to be started in the format <folder name>.<workflow group name>
To start the workflow group instantly it should be in the Idle state. Otherwise, start occurs once processing is finished and the group is back in Idle state.
A workflow group in Invalid state can not be started as the configuration is invalid.
Options
If the wfgroupstart command is used in combination with any of the options when the Platform is restarted, Usage Engine cannot retain the workflow group state, so the wfgroupstart command will immediate return the exit code 101 - 'Platform down group aborted'
Option | Description |
|---|---|
[-w] | Use this option to wait for workflow group completion, that is wait for whichever comes first of either a timeout or received exit code declaring the status of the workflow; completed, aborted etc. For further information about exit codes, see Exit Codes(4.3). Note!The [-w] option does only allow one workflow group to be started at the time. |
[-b] | Use this option (block) to wait for the return code that indicates that workflow group has for example completed, aborted or another code. For further information about exit codes, see Exit Codes(4.3). Note!The [-b] option only allows one workflow group to be started at the time. The [-w] option has precedence over the [-b] option. If both are used at the same time the [-w] will be active. |
Return Codes
Listed below are the different return codes for the wfgroupstart command:
Code | Description |
|---|---|
0 | Will be returned if the command was successful. |
50 | Will be returned if the number of arguments is incorrect. |
51 | Will be returned if an error occurred when parsing arguments. |
60 | Will be returned if the command line timed out. |
70 | Will be returned if the group was not found. |
71 | Will be returned when trying to start more than one group, or if there was an exception due to no user being logged in. |
80 | Will be returned if there was an exception due to no group being started |
90 | Will be returned if an unexpected error occurred. |
230 | Will be returned if the workflow is already running. |
231 | Will be returned if permission is denied (no execute permission). |
232 | Will be returned if the group does not exist. |
240 | Will be returned if the group is invalid. |
Â