This documentation is in maintenance status and may not reflect the latest product updates. Please see the release notes for product updates.

Run Workflow

The Run Workflow action A feature that supplies the instructions in a botflow. runs a workflow from the Nintex Workflow Cloud Cloud-based capability on the Nintex platform for designing workflows that automate processes. tenant based on the Workflow connection the action uses.

Using the Run Workflow action, you can:

Initiate a Nintex Workflow Cloud external start event from within Nintex RPA.

For example, from within a Nintex RPA botflow, you can start a workflow in Nintex Workflow Cloud that automates document approvals.

Create variable values for use in your Nintex RPA botflow that starts a workflow in Nintex Workflow Cloud.

For example, you can create a variable, such as [%Date], for use in a Nintex RPA botflow. Nintex RPA evaluates the variable value making it available for use in the Start Data drop-down list of available Nintex Workflow Cloud workflows.

Review the Nintex Workflow Cloud help documentation for more information about working with Nintex Workflow Cloud.

Important: You must first create a Workflow connection to use the Run Workflow action. Otherwise, a warning message displays instructing you to create the Workflow connection.

Nintex Workflow Cloud workflow requirements

A Nintex Workflow Cloud workflow must meet the following requirements in order to be available for selection in the Nintex RPA Run Workflow action Workflow drop-down list:

Start event: The workflow must be a Component workflow start event.
Type: The Assigned use can be either Production or Development.
Status: The workflow must have a Published status. The workflow can be Paused after it is published and it will still be available for use in the Nintex RPA Run Workflow action.
Permissions: The workflow must be Shared with the user logged into Nintex RPA.

Add a Run Workflow action to a botflow

These are the steps necessary to add a Run Workflow action to a botflow A file that stores the actions and variables designed to automate tasks..

To add a Run Workflow action to a botflow:

Create a Workflow connection.
On the Actions list, click Flow and then click Run Workflow from the Workflow list.

The Run Workflow Action Builder window displays.

Set the Run Workflow settings.

Workflow: Select a workflow from the Workflow drop-down list.

Note: A workflow must meet the criteria listed in Nintex Workflow Cloud workflow requirements to be available in the Workflow drop-down list.

The Start Data fields display. These are the Start event variables created when designing the Nintex Workflow Cloud workflow and display when manually starting the workflow in the Nintex Workflow Cloud dashboard.

Enter the required information in the Start Data fields required to run the Run Workflow action and Nintex Workflow Cloud workflow.

If needed, adjust the Rule settings to modify how Nintex RPA finds the application target.
If needed, adjust the Run Error Task settings to fine tune how the action runs.

View the action Details settings.
If needed, adjust the Run Switch setting to create the action without running it.
Optionally, add an action note.
Click OK to add the Run Workflow action to the botflow.

Run Workflow Action Builder field and button descriptions

Field or button	Description
Run Workflow Options/Settings	General Workflow: Select a workflow from the Workflow drop-down list. Note: A workflow must meet the criteria listed in Nintex Workflow Cloud workflow requirements to be available in the Workflow drop-down list. The Start Data fields display. These are the Start event variables created when designing the Nintex Workflow Cloud workflow and display when manually starting the workflow in the Nintex Workflow Cloud dashboard. Enter the required information in the Start Data fields required to run the Run Workflow action and Nintex Workflow Cloud workflow.
Rules	Click Rules from the Action Builder The Action Builder window provides access to the tools needed to create and modify Actions or instructions within a botflow. window to adjust the Connection Letter A specific letter used by Nintex RPA to communicate with an external application when a Nintex RPA action runs.. Enter the required Connection Letter. Click OK.
Details	When directed by Nintex Support, click Details from the Preview Panel of the Action Builder. If needed, Nintex Support will supply additional information.
Run error task	Click Run error task. Open the On Error drop-down list and select the required setting: Run error task: A botflow containing an error task automatically runs the error task in the event of an error. If the botflow does not contain an error task, the botflow stops in the event of an error. Stop on error: The botflow stops in the event of an error. Ignore errors: The action is skipped in the event of an error and the botflow attempts to execute the next action Click X to close the drop-down and save the setting.
Note	(Optional) Type a Note to document any special instructions or functionality.
Run Switch	The Run Switch toggle controls how Nintex RPA runs an action when adding or editing an action in a botflow. Run: To run the action automatically when you click OK, turn the toggle to Run. Don't Run: If you do not want to run the action automatically when you click OK, turn the toggle to Don't Run.
OK/Cancel	Click OK to save the action or click Cancel to discard the action or any changes.