Dynamic fields markup is a powerful way to reference values contained in other runbook and task properties (including standard fields) and custom fields.
This interpolated referencing can be used:
In runbook level custom fields (text type only)
For task name (with limited formatting options)
In task level custom fields (text type only)
In a message body in email task type
For example, if you had an integration with Jira that created a new Jira bug that was stored in a custom field, a proceeding task’s title could be set up to fully reference the Jira bug once it had been created.
Dynamic fields markup
Referencing properties
The markup is {{variable_name.property_name}}.
As an example, this is what it can look like in an email task type:
The recipient of the email reads it with the interpolated references as follows:
Referencing custom fields
The markup is {{CustomField['custom field name']}} to reference any runbook-level custom fields, or when referencing a task’s own custom field values.
The markup differs if you wish to reference a custom field value belonging to another task in the runbook.
Note: Any single-value custom field type can be referenced through dynamic fields markup. These types are:
Text
Textarea (note any formatting will show as html when referenced)
Select Menu (single-select)
Radio Box (single-select)
Checkboxes (multi-select) this only works for single values.
Date
User Select (multi-select) - this only works for single values and will display a users email address.
As an example, this is what referencing a custom field looks like in the task editing panel. When the referencing custom field is clicked on (is focused), the raw markup is shown:
When the custom field isn’t focused (isn't clicked on), the computed value is displayed:
If you hover over the code icon (< / >) to the right, it will display the custom field that is being referenced:
Referencing task-level custom field values belonging to another task
The markup is {{CustomField['custom field name###1']}}.
It differs to referencing runbook-level custom fields by adding ### followed by a task’s internal ID. In the above example, it’s referencing a custom field value that lives on a task with an internal ID of 1.
Note: You can also reference task-level custom fields within the current runbook through a JSONPath lookup. See Referenceable variables for more detail.
Restrictions
Dynamic fields can only reference properties and fields that exist within the current runbook you’re working with. Other runbooks’ properties and fields cannot be referenced.
A task can only reference the values of its own properties; it cannot reference the values of properties belonging to other tasks. However, you can reference task-level custom field values belonging to another task in the same runbook (see
CustomFieldin the Referenceable variables table for the markup).When merging runbooks, references to the runbook will mean referencing the source runbook. You cannot reference more than one runbook.
Duplicating completed runbooks that contain referencing custom fields
Any custom fields that reference another property or custom field get resolved to actual values once a runbook’s live run has completed. This means that any referencing markup (for example, {{CustomField['Task status']}}) is removed and fully replaced with the referenced value (for example, Complete).
This has an implication when duplicating runbooks. When you duplicate a completed runbook, the runbook will duplicate the resolved values only, as opposed to any referencing markup. However, duplicating in-planning runbooks will duplicate the markup.
Referenceable variables
Variable | Lookup | Description |
| Any runbook property, such as
Example: | This returns the property value for the runbook. |
| Any task property, such as
Example: | This returns the property value for the task. |
| Any runbook-level custom field or a task referencing any of its own custom fields -
Any task-level custom fields belonging to another task in the runbook -
Example: if the custom field to be referenced is called ‘Assignee’ and belongs to another task with an internal ID of 3, the syntax would be | This returns the value of a custom field associated with a runbook or task. Custom fields that cannot be accessed by the task will be ignored. Custom fields must match their name, including case and spaces. |
| Any of several objects serialised to be referenced using JSONPath syntax. For full documentation on this, see the ‘Using JSONPath lookups’ section in our Developer Portal’s Custom Integration page.
Example: | This returns the value of the referenced object or object property. |
Referenceable properties
Runbook properties
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Task properties
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|