Invoke Workflow

Runs another workflow and maps its arguments.

Behaviour

Built-in workflow activity · type id velophex.invokeworkflow

Properties#

Input#

Workflow#

WorkflowId · String · Required · Default: Not specified

The workflow to run, chosen from the project's workflows. Linked by workflow ID, so renaming or moving the file keeps the link.

Arguments#

One row per argument#

Input:{name}, Output:{name} or InOut:{name} · The argument's type · Required when the child declares it required · Default: Not specified

One row per argument of the chosen workflow. An In row is the value passed to the workflow. An Out row is the variable or argument that receives the result; it is not returned while the invocation is Detached. An In/Out row is a variable passed in and updated when the workflow completes.

Output#

Child instance#

ChildInstanceTarget · String · Optional · Default: Not specified

Variable or argument (string) that receives the child workflow's instance ID. Only meaningful for Detached. Shown when Mode is Detached.

Options#

Mode#

Mode · String · Optional · Default: Synchronous

Synchronous waits for the child workflow and binds its outputs; Detached starts it and continues at once. Choices: Synchronous, Detached.

Target session#

TargetSession · String · Optional · Default: Current

Where the workflow runs. A job runs in one session, so Current and Main both run it there. Choices: Current, Main.

Log entry#

LogEntry · Boolean · Optional · Default: False

Logs a line when the workflow starts.

Log exit#

LogExit · Boolean · Optional · Default: False

Logs a line when the workflow completes.

Log level#

LogLevel · String · Optional · Default: Information

Level of the entry and exit lines. Choices: Information, Trace, Warning, Error, Critical.

Arguments variable#

ArgumentsVariable · Dictionary<string, object> · Optional · Default: Not specified

A Dictionary<string, object> of arguments: its entries are inputs, and the workflow's outputs are written back into it.

Isolated#

Isolated · Boolean · Optional · Default: False

Runs the workflow in a separate process. Inputs and outputs must be JSON-serializable; Mode must be Synchronous.

Run as administrator#

Elevated · Boolean · Optional · Default: False

Runs the workflow in a separate elevated process. A Robot job that is not elevated refuses it.

Common#

Timeout#

Timeout · TimeSpan · Optional · Default: Not specified

How long the activity may take, all attempts and retry waits included; e.g. 00:00:30. When it elapses the activity fails with VXF-ACTIVITY-TIMEOUT, which is not retried. Cooperative: an activity that ignores the cancellation is abandoned and may still finish its work. Empty: no limit.

Continue on error#

ContinueOnError · Boolean · Optional · Default: False

When True and the activity fails (after its retries), the fault is logged as a warning and the workflow continues with the next activity; its output variables keep their values. A stop is never swallowed. Empty: False.

How it works#

In Synchronous mode the parent waits, durably, until the child completes. The child's outputs are bound, its fault becomes the parent's, and canceling the parent cancels the child. In Detached mode the parent starts the child and continues; the child's outputs are not bound and canceling the parent does not cancel it. An argument row wins over the same entry in Arguments variable. Isolated runs the child in a separate executor process, so a crash or a leak in the child does not take the parent down.

Properties

Input

Arguments

Output

Options

Common

How it works