Nintex - Orchestration

Use the Nintex - Orchestration start event An event that triggers a workflow to run when it occurs. An example is Box - New file, which triggers the workflow to run when a new file is uploaded to the specified folder. to start an orchestration workflow.

For more information about Orchestrations, see Orchestrations.

Configure the orchestration start event

1. Open the Workflow designer. For more information, see Open the Workflow designer.

2. If the Start event configuration panel does not automatically open, click Start event. For more information, see Start event configuration panel.

   Important: 

   If invalid variables are detected, a message is displayed at the top of the Start event configuration panel. It can be due to changes that have been made to the start event, such as:

   • The start event configuration may have been changed.

   • The start event may have been changed completely. For example, the start event connector changed to a new connector or changed from a connector to a Nintex event.

   • The source configured in the start event configuration may have been changed or deleted. For example, after a workflow is configured to start when a new item is added to a SharePoint list, a column in the SharePoint list is deleted or the list is deleted.

   If you see this message it is recommended that you update the variables. You can update the variables or delete them as required in the Variables panel.

   If there are invalid references they will be deleted when the workflow is published. Deleting variables may result in unconfigured actions and you will have to update the configuration of the impacted actions.

3. In Start from, select Orchestration.

   Caution: After you have selected and configured your start event and you begin designing the workflow and using start event variables in any of your actions, you can no longer change Start from.

   A warning message appears when one or more start event variables are referenced by actions within the workflow. The connector cannot be changed until the variables are no longer referenced within the workflow.

4. Create and add variables that can be passed as parameters in the HTTP call to start the workflow. To view existing variables, see View start event variables. To create new variables, see Create start event variables.

5. Select Tables to associate with the orchestration.

View start event variables

Start event variables A variable associated with the start event. Often referenced by actions in the workflow. For example, a start event variable might capture input in a form field. are automatically added to the workflow. They are passed as parameters in the HTTP call to start the workflow.

At the top of the Start event configuration panel, click Show variables. The list of start event variables is populated.

Alternatively, click Hide variables to hide them.

To create variables, see Create start event variables.

Create start event variables

Start event variables A variable associated with the start event. Often referenced by actions in the workflow. For example, a start event variable might capture input in a form field. are automatically added to the workflow. They are passed as parameters in the HTTP call to start the workflow.

1. Open the Start event configuration panel. For more information, see Start event configuration panel.

2. Click Create variable.

3. If you have previously created a variable, click Create.

Tip: Click Reorder to reorder the list of variables. The order of start event variables determines the order of the associated fields in a generated form.

4. Enter a user-friendly Name for the new variable.

5. Select the variable Type.

   Data types of variables

   Variable type	Usage
   Text	String value, such as John.
   Decimal	Decimal value, such as 1.2.
   Integer	Integer value, such as 1.
   Boolean	Boolean value (Yes or No).
   DateTime	Date or date and time value.
   Collection	Set of files or array of values.
   File	File.

6. Click Create. Every start event variable is rendered as a workflow input and is available later in the workflow.

7. Close the Variables panel after creating variables.