wfstart(4.3)
- Jenni Wallin
Usage
usage: wfstart <pattern matching expression for workflow names> ... [-w <timeout s>] [-b]
-w <timeout> = await workflow completion, times out after <timeout> seconds if wf is not completed
-b = blocks until wf is completedThis command executes one or more workflows.
Example - Run wfstart
Example interactive mode:
$ java -jar mzcli.jar wfstart MyFolder.MyConfiguration.MyWorkflow --password MyPassword --port MyPortNumber
Note that you must specify the location of the workflow to be started in the format <folder name>.<workflow configuration name>.<workflow name>
Example non-interactive mode:
$ mzcli wfstart MyFolder.MyConfiguration.MyWorkflow --password MyPassword --port MyPortNumber Note!
If the workflow(s) is/are in building state when running the wfstart command, "Configuration is building." will be displayed and the workflow(s) will not start unless you have used any of the -w or -b options described below.
Example - Activate Multiple Workflows
In this example we activate all workflows in the folder myFolder starting with the letter 'D'.
mzcli wfstart myFolder.D*Only workflows in Idle or Waiting state will be started. If the workflow is in another state, an error message will be shown stating why it did not start.
Options
Option | Description |
|---|---|
[-w] | Use this option to wait for workflow 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) . If the workflow is in building state, "Configuration is building." will be displayed, and the workflow will not be started until finished building. A timeout may then occur if the building takes too long. |
[-b] | Use this option (block) to wait for the return code that indicates that workflow has for example completed, aborted or another code. For further information about exit codes, see Exit Codes(4.3). If the workflow is in building state, "Configuration is building." will be displayed, and the workflow will not be started until finished building. |
Return Codes
Listed below are the different return codes for the wfstart command:
Code | Description |
|---|---|
0 | Will be returned if the command was successful. |
50 | Will be returned if the argument count is incorrect. |
51 | Will be returned if the argument parse fails. |
70 | Will be returned if the workflow is not found.* |
80 | Will be returned if no user is logged in. |
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 workflow does not exist.* |
240 | Will be returned if the workflow is invalid |
Â