One of the most important features of JWT is the easy accessibility to Jira data stored in system fields, custom fields and a significant number of other virtual fields that are made available by the JWT implementation.
You can access, validate, do mathematical calculations and manipulate the values found in these fields through the use of field codes .
A field code is a unique identifier (key) that can be used in any parser expression. At the same time a field code is a safety feature that makes your expressions immune to custom field renaming.
Field codes are available for:
- readable fields
- writable fields
- virtual fields
- issue, project and user properties
Field code notation
Depending on the context in which they are being used, field codes will contain a prefix following this notation :
{origin.field}
.
What is a context?
A context basically determines where JWT will pull data from. Available contexts (or
origins
) in JWT are:
| Context | Description | Example |
|---|---|---|
issue
| The issue that currently being processed by a workflow function or automation rule. The most commonly used context in JWT. |
The description of the current issue. |
parent | The parent of the issue that is processed by a workflow post function or an automation rule.
|
The summary of the parent issue. |
seed.issue
| Seed issues of the issue that is processed by a workflow post function or an automation rule. More info... |
The summary of a seed issue. |
issue.project | ||
system
| Some data does not have an issue context (e.g. the currently logged in user or the system date and time). |
The current user (e.g. executing the post function). |
Only valid for sub-tasks.Field codes for Jira standard or system fields will display the attribute in a legible form like
%{trigger.issue.summary}
.
All selected custom fields will be notated like
%{trigger.issue.cfnnnnn}
where
nnnnn
contains the Jira custom field ID.
Once an expression has been saved, the real name will be displayed in the configuration element.
The purpose of using the cfnnnnn notation is quite simple - custom fields can be renamed .
Numbers vs. text (strings)
Field codes must always be enclosed by curly brackets {} but if they are used for text-strings, the brackets must be preceded by a percent sign % .
- Number fields can be referenced as numbers using the following notation: {issue.
somenumberfield}. (
no preceding % sign)- If a field is not set or does not return a number (e.g. a text field ), it is evaluated to
null.
- If a field is not set or does not return a number (e.g. a text field ), it is evaluated to
- String fields : Any field type or data type is susceptible of being transformed to text, so any field can be referenced as a text-string value using the following notation:
%{issue.somefield}.- If a field has no value (
null), an empty string will be returned.
- If a field has no value (
- Cascading Select fields are treated as string fields, where i is the index that represents the level to be accessed. ( i = 0 is used for base level) are notated as
%{issue.somefield.i}
A complete list of all available data types can be found here.
Readable fields
The list below contains all fields that can be read by JWT.
