wfstart(3.0)

Owned by Former user (Deleted)
Last updated: May 05, 2023 by Former user (Deleted)
2 min read
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 completed

This command executes one or more workflows.

Example - How to 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 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

OptionDescription
[-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(3.0) .

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.

Note!

The [-w] option does only allow one workflow to be started at the time.

[-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(3.0) .

If the workflow is in building state, "Configuration is building." will be displayed, and the workflow will not be started until finished building.

Note!

The [-b] option only allows one workflow 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.

Note!

If the connection to the Platform is down the mzcli command will continue to run. The command will however not receive any exit codes until the Platform is up again. Timeouts will still occur. If the workflow is aborted or finished while the Platform was down, the correct exit code will be returned as soon as the Platform is up again.

If a connection problem with the EC occurs during the workflow execution causing the workflow to become unreachable the mzcli command will wait for the workflow to either complete or abort. If workflows do not reconnect and are automatically reachable again the workflow must be handled manually. The standard  alarm functionality can be used to detect unreachable workflows.