Create a variable

You can create variables from:

  • The action configuration panel, when you're configuring a workflow action.
  • The toolbar of the workflow designer.
  • The start event configuration panel when you're configuring the start event.

Jump to:

Create a variable from the action configuration panel

You can create and insert workflow and workflow object variables into a field that accepts variables in the action configuration panel of an action.

  1. In a field that accepts variables, click + Insert or Add variable from the drop-down list.

    The Insert variables panel is displayed.

  2. In the Name field, type the internal name you want to call the variable when designing your workflow.

  3. In the Type field, select a variable type corresponding to the type of data you want to store. See Variable data types.

  4. (Optional) If you want to provide a default value for the variable, enter the value in the Default value field.

  5. (Optional) If you want to set the default value of the variable to null, click in the Default value field and select Set value as null.

  6. (Optional; not applicable to start event variables) For Component workflows A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.: To mark the variable as a workflow output Variable to store a value or file on completion of the workflow. Set up as a user-defined variable., select the check box for Output.

    Note: The Output check box is only available when the workflow's selected Start event is Component workflows.

  7. Click Create or Create & insert if you want to use it in an action.

Create a variable from the toolbar

You can create workflow and start event variables you want to use for a workflow using the Variables option available in the toolbar. You cannot create workflow object variables from the toolbar; for more information on using workflow object variables, see Workflow object variable. After you create a variable, you can use it in configuration fields of actions.

  1. Click Variables.

    The Variables panel is displayed. The Workflow tab is selected by default.

  2. In the Name field, type the internal name you want to call the variable when designing your workflow.

  3. In the Type field, select a variable type corresponding to the type of data you want to store. See Variable data types.

  4. (Optional) If you want to provide a default value for the variable, enter the value in the Default value field.

  5. (Optional) If you want to set the default value of the variable to null, click in the Default value field and select Set value as null.

  6. (Optional; not applicable to start event variables) For Component workflows A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event.: To mark the variable as a workflow output Variable to store a value or file on completion of the workflow. Set up as a user-defined variable., select the check box for Output.

    Note: The Output check box is only available when the workflow's selected Start event is Component workflows.

  7. Click Create or Create & insert if you want to use it in an action.

Create a variable from the start configuration panel

The Nintex - Component workflow start event allows you to create 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 Start event configuration panel is displayed.

  2. Click Create variable.
  3. In the Name field, type the internal name you want to call the variable when designing your workflow.

  4. In the Type field, select a variable type corresponding to the type of data you want to store. See Variable data types.

  5. Click Create or Create & insert if you want to use it in an action.
Section Tab, button, or field Description

Variable type

Workflow

Displays existing variables of the workflow type, which you can edit or delete. You can also create new variables to use throughout your workflow.

 

Start event

Displays the start event variables of the workflow. You cannot edit start event variables.

The following Start event variables are provided:

  • Workflow initiator (Object)
    • First name (Text)
    • Last name (Text)
    • Email (Text)
  • Form variables: (Object)
    • An object variable that includes all the form variables in Nintex - Form.

 

Context

Displays the context variables of the workflow. You cannot edit context variables.

By default, the following context variables are provided:

  • Current date (type: DateTime; returns values in format YYYY-MM-DD; available for fields that accept text or date input)
  • Current date and time (type: DateTime; returns values in format YYYY-MM-DD HH:MM:SS +0000; available for fields that accept text or date input)
  • Workflow instance ID (type: Text; returns the ID of the running workflow instance, as displayed on the Instance details page ["Instance ID"])
  • Workflow name (type: Text; returns the name of the workflow, as displayed on the Workflows page for the workflow and on the Instance details page for the instance ["Name"])

  • Workflow ID (type: Text; returns the identifier of the workflow, as displayed in workflow URLs Endpoint for calling a workflow. used for forms and Component workflows)

 

(The name of a Form-based task)

Displays the variables created and generated in a form as part of the Form-based task. In addition, form-based task variables also include the task name and form URL, both generated automatically and available for use throughout the workflow.

You cannot edit Form-based task variables in the Variables pane.

Workflow

Name

Name of the workflow variable.

 

Type

Data types of variables. Possible values for workflow variables are:

  • 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 nested variables, 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 objects 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.

 

Default value

The default value to use for the variable. Available for the following variable types: Boolean, DateTime, Decimal, Integer, Text. Provided default values are:

  • Boolean: No
  • DateTime: (empty)
  • Decimal: 0.0
  • Integer: 0
  • Text: (empty)

 

Output

Displayed for Component workflows A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event. only. When selected, marks the variable as an output. Output variables are passed to the parent workflow when the current workflow has completed.

 

Used in

Displays the number of actions that use the specific variable.

 

Create

Saves the workflow variable and makes it available for selection or insertion.

 

Insert

Only available in the Insert variable pane. Inserts the highlighted or selected variable into the action field you are editing.

 

Create & insert

Only available in the Insert variable pane. Saves the workflow variable and adds it to a field from where you accessed the Insert variables pane.

 

Details

Option to edit the selected workflow variable.

 

Save

Option to save the workflow variable you are creating or editing.

 

(Close)

Option to discard the variable you are creating, or discard the changes to a variable you are editing.

 

Delete

Removes the selected variable. Variables in use cannot be deleted.