Call a workflow

Use the Call a workflow action A tool for building the processes, logic, and direction within workflows. to call a Component workflow A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event., which handles a common task or sub-process.

Parent and children workflows are tied together. When a parent workflow is terminated, related child workflows also terminate. If a child workflow configured to complete before the parent resumes is terminated, then the parent will also terminate.

For example, many HR processes may involve the task of looking up IDs for employees. In this case, you can set up a child Component workflow for ID lookup and call that child workflow from each relevant HR workflow using this action.

Before you begin: 

  • Understand Variables. File variables are not supported.

  • Understand component workflows. These can be triggered by other workflows or by REST calls. For setup details, see Nintex - Component workflow.

  • Understand workflow inputs and outputs. These are set up in the child workflow that the Call a workflow action is configured to start. Workflow inputs allow you to include data when starting the child workflow while workflow outputs allow you to capture data that is present when the child workflow is complete. For setup details, see Nintex - Component workflow.

  • Learn about Handling files in your workflow

Jump to:

Configure the Call a workflow action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  2. For Workflow, select the Component workflow A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event. you want to call. When inserting a variable use the workflow ID of the workflow.

    Important:  Before adding a variable to this field, you must select a component workflow from the drop-down list to retrieve the input and output fields for configuration. After the input and output fields are configured, you can replace the workflow with a variable.

  1. Select if you want the workflows to run concurrently or wait for this workflow to complete before continuing.

  2. Complete the fields for any inputs Variable to store a value or file when the workflow starts. Set up as a start event variable. and outputs Variable to store a value or file on completion of the workflow. Set up as a user-defined variable. that are rendered for the selected workflow. In addition, if desired, in the Instance ID field, specify a variable to store the ID of the initiated instance; this can be helpful if you want task data or timing information from the instance or if you want to stop the instance.

    Important: File variables are not supported.

Call a workflow action fields, buttons, and settings

Section

Field

Description

 Variable type

(unlabeled)

Workflow

The component workflow to call using this action.

When inserting a variable use the workflow ID of the workflow you want to call.

Important:  Before adding a variable to this field, you must select a component workflow from the drop-down list to retrieve the input and output fields for configuration. After the input and output fields are configured, you can replace the workflow with a variable.

If you use a variable, the workflow you trigger should have the same inputs and outputs.

For information about getting the workflow ID of a component workflow from the base URL, see Endpoints and responses.

 Text

 

Run both workflows concurrently

When selected, the current parent workflow will keep running after the selected component workflow starts.

When this option is selected, the Output variables will not be populated.

 (n/a)

 

Wait for this workflow to complete before continuing

When selected, pauses the current (parent) workflow until the selected component workflow is completed. Use this option to reference outputs of the selected workflow later in the current workflow.

 (n/a)

Inputs

(start event variable for selected workflow)

Value to pass to the selected workflow as the workflow input Variable to store a value or file when the workflow starts. Set up as a start event variable.. For setup details within the Component workflow to be called, see Nintex - Component workflow.

varies

Outputs

(output for selected workflow)

Variable to store the value received from the selected workflow as the workflow output Variable to store a value or file on completion of the workflow. Set up as a user-defined variable.. For setup details within the Component workflow to be called, see Nintex - Component workflow.

For Instance ID, if desired, specify a variable to store the ID of the initiated instance; this can be helpful if you want task data or timing information from the instance or if you want to stop the instance.

 varies