Merge Tags

Gravity Flow uses merge tags to allow you to dynamically populate submitted field values and other dynamic information in notification emails, field mappings, content templates and other areas.

A merge tag uses curly braces and looks like this: {workflow_entry_link}.

In addition to all the Gravity Forms merge tags, Gravity Flow has some merge tags that are specific to certain contexts. The complete list of merge tags available to each context can be found by clicking the merge tag icon to the right of the text box.

The merge tag dropdown open on a notification for an assignee in the step settings panel.

In addition to the merge tags available in the list, there's another merge tag which can be used to display information for the WordPress user account of the entry submitter.

The {created_by:[property]} merge tags will lookup the user account in the created_by field of the current entry and display the specified property. Please note that this is different from the Gravity Forms {user:[property]} merge tag which looks up the user account for the current user.

  • :display_name

    Displays the Display Name of the submitting user.  {created_by:display_name}

  • :user_email

    Displays the email of the submitting user.  {created_by:user_email}

  • :user_login

    Displays the user login of the submitting user.  {created_by:user_login}

  • :ID

    Displays the ID of the submitting user.  {created_by:ID}

The {assignees} merge tag

The {assignees} merge tags will output the details of the current step's assignees. The assignee display name, email, and status are displayed by default. The following modifiers can be used to prevent them being displayed

  • :display_name

    Displays the Display Name of the assignee.  {assignees:display_name=false}

  • :user_email

    Displays the email of the assignee.  {assignees:user_email=false}

  • :status

    Displays the assignee status.   {assignees:status=false}

The above modifiers can also be used together  {assignees:display_name=true user_email=false status=true}

The {workflow_note} merge tag

The note merge tag will display the most recent user submitted note. The following modifiers can be used to customize the behaviour of the merge tag.

  • step_id

    Displays all the user submitted notes for the specified step, including previous occurrences of the step   {workflow_note:step_id=5}. The step name can also be used instead of the ID.

  • display_name

    Displays the name of the user who submitted the note  {workflow_note:display_name=true}

  • display_date

    Displays the date and time the note was submitted  {workflow_note:display_date=true}

  • history
    Controls whether notes from previous occurrences of the step are displayed.  {workflow_note:step_id=5 history=true}

The above modifiers can also be used together  {workflow_note:step_id=5 display_name=true display_date=true}

The {workflow_timeline} merge tag

The timeline will display the date, user, step and notes from the timeline in a simple, compact list.

Selecting the Timeline merge tag for a notification in the step settings panel.

{current_step}

The current step supports the following modifiers: duration (time), expiration (date/time), ID, name (default), schedule (date/time), start (date/time) and type.

Examples:

  • {current_step:duration}
  • {current_step:expiration}
  • {current_step:ID}
  • {current_step:name}
  • {current_step:schedule}
  • {current_step:start}
  • {current_step:type}
  • {current_step:due_date} - When a step due date has been specified, this will return the due date.
  • {current_step:due_status} - This will return "Pending" or "Overdue" when compared to the due date if it has been set.

The {workflow_fields} Merge Tag

The {workflow_fields} merge tag supports the following identifiers : empty, value, admin, editable, display. All these modifiers take Boolean values.

Examples :

  • {workflow_fields:empty = false} // Output empty fields.
  • {workflow_fields:value = false} // Output choice values.
  • {workflow_fields:admin = false} // Output admin labels.
  • {workflow_fields:editable = true} // Output the steps editable fields.
  • {workflow_fields:display = true} // Output the steps display fields.

Note: workflow_fields is just a wrapper for the all_fields merge tag. It filters out any field which isn’t set as display only or editable on the current step. Only then their behavior can be modified by using {workflow_fields} identifiers.