DocsNodesFlowRun workflow

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.

Kindcontrol:subWorkflow
GroupFlow
Credits1 credit
Ports out1

How it looks

Settings

SettingRequiredWhat it does
WorkflowworkflowRefIdYesThe workflow to run. It needs a Run by hand trigger, which is how the child starts. A workflow can't call itself.
Pass ininputNoValues for the child's inputs, worked out from this run. The child reads them like Run now inputs.
Correlation keycorrelationKeyNoAdvanced. Groups child runs for the child's concurrency setting.

Ports

PortThe run leaves by it when
defaultThe 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.

ValueHolds
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

CodeMeans
SUBWORKFLOW_SELF_REFERENCEThe workflow calls itself.
SUBWORKFLOW_DEPTH_EXCEEDEDRun workflow steps are nested more than 8 deep.
SUBWORKFLOW_INPUT_KEY_RESERVEDAn input is named parentRunRefId, correlationKey or depth.
SUBWORKFLOW_WORKSPACE_BUSYThe 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.