Branch by Value

The data types of variables are as follows:

• Text: Text string (with optional default value)
• Decimal: Integer numerical with a decimal point (with optional default value)
• Integer: Integer numerical with no decimal (with optional default value)
• Boolean: Yes or No (with optional default value)
• DateTime: YYYY-MM-DD, HH:MM AM/PM (with optional default value)
• Collection: A variable that groups one or more related variables of the same type into an ordered list.

For example, a collection variable named Company name can hold a list of names, such as Safalo, Nintex, and Drawloop.

• File: Path to a file. Use this variable type to attach files to email messages. A file path must start with the root folder and end with the file name. Example: /Draft/Contracts/ACME.docx
• Object: A variable that groups several related variables of any type into a hierarchical structure. Objects can contain other Objects.

For example, an Object variable named Company can hold a list of parameters, such as Company name, Email, Address, and Phone number.

Note: Objects can't be created or modified in the Variables panel.

• Collection of objects: A variable that groups a list of Objects of the same variable structure into a list.

For example, a Collection of object variable named Company details can hold a series of objects, detailing Company name, Email, Address, and Phone number for each Company name Safalo, Nintex, and Drawloop.

Note: You can assign only the variable type that a workflow expects. For example, if you want to capture a Date entry in a form, then you must create a variable of the DateTime type.

In Nintex Workflow Cloud, variables are classified as follows:

• Workflow variable

Workflow variables include those that you create and define when you configure an action. These variables store values such as collections, path to files, workflow outputsVariable to store a value or file on completion of the workflow. Set up as a user-defined variable., and other data for use throughout the workflow.

• Start event variable

  These variables capture data that are present when the workflow starts.

  Range of Start event variables

  Depending on the Start events you select, one or more of the following start event variables may be available.

  • Form field variables capture data that user enters in the fields of a form. These variables are generated when you create a form control. An example is a variable that holds an email address entered into a web form (Nintex - Form).

  • Start event context variables, such as an identifier for the selected object (app start events). These variables are passed to the workflow as Start event context variables. Example: an object variable called Workflow Initiator that corresponds to the user who triggered to start a workflow. (Available only in Nintex - Form start event)

  • Variables with applied formulas are variables that hold calculated values based on the formula defined in the Formula builder. An example is a variable that holds the calculated number of days between two DateTime variables.
  • Provided start event variables such as the names of new files that trigger the workflow to run (new file start events; these variables must be explicitly added for use later in the workflow). (Available only in start events using third-party connectors such as Salesforce and Box.)
  • Custom start event variables that you create, such as files or data that you want to pass as inputsVariable to store a value or file when the workflow starts. Set up as a start event variable. to a Component workflowA workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.. (Available only in Nintex - Component Workflow start event)

• Context variable

  These variables represent data that are related to the current workflow instanceAn occurrence of a workflow. such as Current date (DateTime), Current date and time (DateTime), Workflow instance ID (Text), Workflow name (Text), and Workflow ID (Text).

• Form-based task variable

These variables capture data that are entered in forms as part of a Form-based task. The following form-based task variables are generated automatically when you configure the Form field for the action:

• Form variables - Variables that correspond to controls that you add to a form. Form variables are used only when assignees respond to a task, wherein they select an outcome and fill in a form. Form variables for the Assign a task to multiple users action are found in the Task responses collection.

• Form URL - A variable that contains the form URL that an assignee can use to access a form.

• Task name (Form link) - A variable that contains a hyperlink to the form URL using the Task name.

Each field that accepts variables accommodates one or more methods for inserting variables. Some fields allow you to type ahead and select from a filtered list of existing variables while others require selection from a drop-down list or from the Insert variables dialog box.

In the Action configuration panel, do one of the following.

• Select an existing variable from a filtered list:
  1. In fields that accept variables, type [[.

  A drop-down list of existing variables appears.

  

  Note: If you want to type two opening square bracket characters instead of displaying existing variables from a filtered list, press Esc and the variables list disappears.

  2. Continue typing to filter the list of displayed variables.

  3. Click the variable you want.

• Select an existing variable from the drop-down list for the field.



• Select a new or existing variable from the Insert variables dialog box:

  1. Either click + Insert or click Add variable from the drop-down list.

     

     

     The Insert variables dialog box appears.

  2. To create and insert a variable

     1. Click the Workflow tab.

     The Insert variables panel appears.

     2. Click Create variable.

     Note: The Create variable button is available only if you have previously created a variable.

     The Create variable dialog box appears.

     3. For Name, type the internal name you want to use.

     4. For Type, select a variable type corresponding to the type of data you want to store.

        Variable types

        • Text: Text string (with optional default value)
        • Decimal: Integer numerical with a decimal point (with optional default value)
        • Integer: Integer numerical with no decimal (with optional default value)
        • Boolean: Yes or No (with optional default value)
        • DateTime: YYYY-MM-DD, HH:MM AM/PM (with optional default value)
        • Collection: A variable that groups one or more related variables of the same type into an ordered list.

        For example, a collection variable named Company name can hold a list of names, such as Safalo, Nintex, and Drawloop.

        • File: Path to a file. Use this variable type to attach files to email messages. A file path must start with the root folder and end with the file name. Example: /Draft/Contracts/ACME.docx
        • Object: A variable that groups several related variables of any type into a hierarchical structure. Objects can contain other Objects.

        For example, an Object variable named Company can hold a list of parameters, such as Company name, Email, Address, and Phone number.

        Note: Objects can't be created or modified in the Variables panel.

        • Collection of objects: A variable that groups a list of Objects of the same variable structure into a list.

        For example, a Collection of object variable named Company details can hold a series of objects, detailing Company name, Email, Address, and Phone number for each Company name Safalo, Nintex, and Drawloop.

     5. For Default value, if relevant, update the provided default value.

     6. For Component workflowsA workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.: To mark the variable as a workflow outputVariable to store a value or file on completion of the workflow. Set up as a user-defined variable., select the Output check box.

        For more information about these fields, see Toolbar.

     7. Click Create & insert.

     The new variable appears in the configuration field.

You can create user-defined variables from the action configuration panel when you're configuring a workflow action or from the toolbar of the workflow designer.

During action configuration

Each field that accepts variables accommodates one or more methods for inserting variables. Some fields allow you to type ahead and select from a filtered list of existing variables while others require selection from a drop-down list or from the Insert variables dialog box.

In the Action configuration panel, do one of the following.

• Select an existing variable from a filtered list:
  1. In fields that accept variables, type [[.

  A drop-down list of existing variables appears.

  

  Note: If you want to type two opening square bracket characters instead of displaying existing variables from a filtered list, press Esc and the variables list disappears.

  2. Continue typing to filter the list of displayed variables.

  3. Click the variable you want.

• Select an existing variable from the drop-down list for the field.



• Select a new or existing variable from the Insert variables dialog box:

  1. Either click + Insert or click Add variable from the drop-down list.

     

     

     The Insert variables dialog box appears.

  2. To create and insert a variable

     1. Click the Workflow tab.

     The Insert variables panel appears.

     2. Click Create variable.

     Note: The Create variable button is available only if you have previously created a variable.

     The Create variable dialog box appears.

     3. For Name, type the internal name you want to use.

     4. For Type, select a variable type corresponding to the type of data you want to store.

        Variable types

        • Text: Text string (with optional default value)
        • Decimal: Integer numerical with a decimal point (with optional default value)
        • Integer: Integer numerical with no decimal (with optional default value)
        • Boolean: Yes or No (with optional default value)
        • DateTime: YYYY-MM-DD, HH:MM AM/PM (with optional default value)
        • Collection: A variable that groups one or more related variables of the same type into an ordered list.

        For example, a collection variable named Company name can hold a list of names, such as Safalo, Nintex, and Drawloop.

        • File: Path to a file. Use this variable type to attach files to email messages. A file path must start with the root folder and end with the file name. Example: /Draft/Contracts/ACME.docx
        • Object: A variable that groups several related variables of any type into a hierarchical structure. Objects can contain other Objects.

        For example, an Object variable named Company can hold a list of parameters, such as Company name, Email, Address, and Phone number.

        Note: Objects can't be created or modified in the Variables panel.

        • Collection of objects: A variable that groups a list of Objects of the same variable structure into a list.

        For example, a Collection of object variable named Company details can hold a series of objects, detailing Company name, Email, Address, and Phone number for each Company name Safalo, Nintex, and Drawloop.

     5. For Default value, if relevant, update the provided default value.

     6. For Component workflowsA workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.: To mark the variable as a workflow outputVariable to store a value or file on completion of the workflow. Set up as a user-defined variable., select the Output check box.

        For more information about these fields, see Toolbar.

     7. Click Create & insert.

     The new variable appears in the configuration field.

From the toolbar

1. Click Variables.

   The Variables panel appears, displaying the Workflow tab that is selected by default.

2. To create a variable

   1. Click the Workflow tab.
   2. Click Create variable.

   Note: The Create variable button is available only if you have previously created a variable.

   3. For Name, type the internal name you want to use.

   4. For Type, select a variable type corresponding to the type of data you want to store.

      Variable types

      • Text: Text string (with optional default value)
      • Decimal: Integer numerical with a decimal point (with optional default value)
      • Integer: Integer numerical with no decimal (with optional default value)
      • Boolean: Yes or No (with optional default value)
      • DateTime: YYYY-MM-DD, HH:MM AM/PM (with optional default value)
      • Collection: A variable that groups one or more related variables of the same type into an ordered list.

      For example, a collection variable named Company name can hold a list of names, such as Safalo, Nintex, and Drawloop.

      • File: Path to a file. Use this variable type to attach files to email messages. A file path must start with the root folder and end with the file name. Example: /Draft/Contracts/ACME.docx
      • Object: A variable that groups several related variables of any type into a hierarchical structure. Objects can contain other Objects.

      For example, an Object variable named Company can hold a list of parameters, such as Company name, Email, Address, and Phone number.

      Note: Objects can't be created or modified in the Variables panel.

      • Collection of objects: A variable that groups a list of Objects of the same variable structure into a list.

      For example, a Collection of object variable named Company details can hold a series of objects, detailing Company name, Email, Address, and Phone number for each Company name Safalo, Nintex, and Drawloop.

   5. For Default value, if relevant, update the provided default value.

   6. For Component workflowsA workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.: To mark the variable as a workflow outputVariable to store a value or file on completion of the workflow. Set up as a user-defined variable., select the check box for Output.

      For more information about these fields, see Toolbar.

   7. Click Create.

Nintex provides start event variables for most third-party start events, such as Box - New file. If you add the provided variable, then you can use it later on in your workflow.

1. On the canvas, click Start event.

   The configuration panel for Start event appears.

2. From the Start from drop-down box, select a connector.

3. From the Event drop-down box that appears, select an event.

   The Source section appears.

   

   Note: The Source section is available only for some events.

4. Click Add variables.

A drop-down list appears, displaying a list of provided variables.

5. Select the predefined variables that you want to add to your workflow.
   Note: 

   • To select all variables, click Select All.

   • If you know the variable and you want to find it faster, type the variable name in the Filter options field.

6. Click Add.

   The Variables dialog box appears, displaying the variables you have selected.

   Note: If you want to edit the selection of variables, hover over the variable, click , and then click Show Details. Edit the variable name in the Name field or click .
   

The Nintex - Component workflow start event allows you to create your own start event variables in the Start event configuration panel. You can use these variables to capture required workflow inputs (files or other data needed to start the workflow).

1. On the canvas, click Start event.

   The configuration panel for Start event appears.

2. From the Start from drop-down box, select Component workflow.

   The Start event variables section appears.


3. Click Create variable.

The Variables dialog box appears, displaying the Start event tab that is selected by default.

4. Click Create.

Note: The Create button is available only if you have previously created a variable.

The Create variable box appears.

5. For Name, enter a user-friendly name for the new variable.

6. For Type, select the variable type you want.

   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. If using for file inputs, make sure your default file location is configured.
   File	File. Make sure your default file location is configured.

7. Click Create.