Run workflow
Starts another workflow as a child run and waits for it to finish. Use it to keep a job you do often, like "notify the family", in one place.
Kind
control:subWorkflowGroupFlow
Credits1 credit
Ports out1
How it looks
Settings
| Setting | Required | What it does |
|---|---|---|
| WorkflowworkflowRefId | Yes | The workflow to run. It needs a Run by hand trigger, which is how the child starts. A workflow can't call itself. |
| Pass ininput | No | Values for the child's inputs, worked out from this run. The child reads them like Run now inputs. |
| Correlation keycorrelationKey | No | Advanced. Groups child runs for the child's concurrency setting. |
Ports
| Port | The run leaves by it when |
|---|---|
default | The child run finished, however it ended. Check childResult.status to tell. |
What it adds to the run
Later nodes can read these, in a condition or as {{name}} in a text field.
| Value | Holds |
|---|---|
childResult | { childRunRefId, status, output }. output is what the child's End node handed back. |
CreditsThis step costs 1 credit. The child pays for itself from its own budget, its own run start included. Cancelling or failing this run cancels the child.
Problems you might see
| Code | Means |
|---|---|
SUBWORKFLOW_SELF_REFERENCE | The workflow calls itself. |
SUBWORKFLOW_DEPTH_EXCEEDED | Run workflow steps are nested more than 8 deep. |
SUBWORKFLOW_INPUT_KEY_RESERVED | An input is named parentRunRefId, correlationKey or depth. |
SUBWORKFLOW_WORKSPACE_BUSY | The workspace is at its limit of active runs. |
Problems found when you publish stop the publish and point at the node. Problems while a run is going fail the node, and its On failure setting decides what happens next. See the error codes for the API's own.
See also
Starts from the Run button in the console or from the API, with inputs you define.
Outdefaulttrigger:manualEnds this path as done, optionally handing a value back to the run that started it.
Outnone, it ends this pathcontrol:endParks the run until a named signal arrives from the console, the API or another run.
Outdefaultwith Give up aftertimeoutcontrol:awaitSignal