Variables types

There are different types of variables available in Nintex Automation Cloud. They are available in different tabs on the Variables panel to be used in your workflow as required.

Jump to: 

Workflow variable

Workflow variables stores data and is used in actions within the workflow. They can be manually created and defined when designing the workflow and can be used to pass data from one action to other actions in the same workflow. These variables are available in the Workflow tab of the Variables panel. See Create a variable.

Form-based task variable

These variables capture data that are entered in forms as part of a Form-based task. They are available in the Form-based task action tab of the Variables panel. This tab is only displayed if a Form-based task has been configured for the workflow. The following form-based task variables are generated automatically when you configure the Form for the action:

  • Form variables: Variables that correspond to controls that you add to a form. Form variables contain the information submitted when a user completes a form or task.

    Form variables include language variables that enable context passing to workflows for language-based branching. For example, variables that capture a translated language in the form can direct your workflow along a path with the Branch by condition action. These variables are available in the Form designer (Form translation tab > Variables panel) and are generated automatically when a translation language is added. Two helpful form translation variables are listed below: 

    • Language Code variable: This text variable informs the workflow if the form has been translated into a language identified by a code that assigns letters or numbers to identify or classify the language.

    • Language Name variable: This text variable informs the workflow if the form has been translated into a language identified by a name.

  • Form URL: A variable that contains the URL to access the form.

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

Start event variable

These variables capture data from the workflow start event. You can use these variables to reference data available in the associated start event. These variables are available in the Start event tab of the Variables panel. You cannot assign a different value to a start variable once the workflow starts. Depending on the Workflow start events you select, one or more of the following start event variables may be available.

  • Form field variables: These variables are available when Form is selected as the Start event and captures data that users enter in the fields of a form. The 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).

    • Form variables for the Assign a task to multiple users action are found in the Task responses collection and First response object.

    Form field variables include language variables that enable context passing to workflows for language-based branching. For example, variables that capture a translated language in the form can direct your workflow along a path with the Branch by condition action. These variables are available in the Form designer (Form translation tab > Variables panel) and are generated automatically when a translation language is added. Two helpful form translation variables are the Language Code variable, which informs the workflow if the form has been translated into a language identified by a code that assigns letters or numbers to identify or classify the language, and the Language Name variable, which informs the workflow if the form has been translated into a language identified by a name.

    Form field variables that are created for Start event forms are available as start event variables in the workflow. If a form variable is used in a workflow action and the form control is deleted subsequently, a warning message is displayed in the action configuration panel. You can resolve it by replacing the variable or deleting the variable. For more information, see Resolve deleted form control variables.

  • Start event context variables: These variables represent data related to the start event, such as an identifier for the selected object (app start events). For example, an object variable called Workflow Initiator that corresponds to the user that triggers the event to start the workflow. (Available only in Nintex - Form start event).

  • Variables with applied formulas: These variables 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.
  • Third-party start variables: These variables hold data from an event in a third-party platform, such as the name of the new file that triggered the workflow to run. These variables are only available for start events using third-party connectors, such as Box or Salesforce, and must be explicitly added for use later in the workflow.
  • Component Workflow input variables: Create these variables in order to pass files or data as inputs Variable to store a value or file when the workflow starts. Set up as a start event variable. to a Component workflow A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.. These variables are only available in Nintex - Component Workflow start events.

Context variable

These variables represent data that are related to the current workflow instance An occurrence of a workflow. and are automatically populated when the workflow runs. For example, variables that capture the date and time the workflow started. These variables are available in the Context tab of the Variables panel. One helpful context variable is listed below: 

Workflow type variable: This variable informs the workflow if it is in development or production mode. When this variable is used in a workflow, the data sources can be easily changed while testing it. For example, in development mode, a set of variables can be used to point to test data or sites. When you have completed your testing, you can switch to use a set of variables in production that point the actions in the workflow to real data or sites. Using this variable automates the transition between development and production mode.

Workflow object variable

These variables are output variables of workflow Connector actions and events. Use the object or its nested variables in other actions of your workflow or in task forms. For example, use the output variable of one action in your workflow as the input variable for another action. In task forms, you can use the data to populate a control, or you can drag and drop the variable on the designer canvas to display the data in your form. You can also use these objects in form rules and formulas. See Workflow objects for more information about using them in a form.