Page History
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
On this page
|
Overview
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.
UI Text Box | ||
---|---|---|
| ||
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 description of the current issue. | |||||
parent | The parent of the issue that is processed by a workflow post function or an automation rule. Only valid for sub-tasks. |
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). | |||||
UI Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
These additional contexts are available for automation rules:
The prefix is a referential part of the field code and will be inserted into the expression whenever you select a field from a dropdown list (as shown below). INSERT SCREENCAST
|
ui-text-boxexpand | ||||
---|---|---|---|---|
| ||||
Wherever field codes are used in the documentation, they will be notated with three periods (...) instead of a prefix.
|
UI Text Box | ||
---|---|---|
| ||
Field codes for Jira standard or system fields will display the attribute in a legible form like All selected for Jira standard or system fields will display the attribute in a legible form like The purpose of using the |
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}
UI Text Box | ||
---|---|---|
| ||
A complete list of all available data types can be found here. | ||
UI Expand | ||
| ||
Wherever field codes are used in the documentation, they will be notated with three periods (...) instead of a prefix. %{...summary} %{...cf10021} |
Readable fields
The list below contains all fields that can be read by JWT.
Issue-related fields
Field name | Field code | Type | Output | Example output | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Affects version/s |
| Comma separated list of version IDs | 10010,10020,10030 | |||||||||
Number of affects version/s |
|
| Number of affected versions in current issue | 3 | ||||||||
Assignee |
|
| The Atlassian account ID of the user who has the issue assigned | 10007 | ||||||||
Assignee's full name |
|
| Name and surname of the user who currently has the issue assigned | Albert Einstein | ||||||||
Assignee's email |
|
| Email address of the user who currently has the issue assigned | albert.einstein@yahoo.com | ||||||||
Attachments |
|
| Comma separated list of file names of all files attached to the issue | file1.txt,readme.pdf,screenshot.png | ||||||||
Number of attachments |
|
| Number of files attached to current issue | 3 | ||||||||
Custom field | %{issue.cf10100} |
| Value of the given custom field as a string. All custom fields will be notated like this %{issue.cfnnnnn} where nnnnn contains the Jira custom field id, that can be determined of the Jira custom field administration | Your customfield value | ||||||||
Custom field | {issue.cf10133} |
| Value of the given custom field as a number. All custom fields will be notated like this {issue.cfnnnnn} where nnnnn contains the Jira custom field id, that can be determined of the Jira custom field administration | 47 | ||||||||
Component/s |
|
| Comma separated list of component names | Web Site,Authenticator,Statistics | ||||||||
Component/s ID |
| Comma separated list of component IDs | 10010,10020,10030 | |||||||||
Component/s leads |
|
| Comma separated list of the Atlassian account IDs of the leads for the components | 557068:145e0983-5707-439c-80e4-1160dd57g114,777068:145e0983-5707-439c-80e4-1160dd57x554,765428:168p0983-5987-444e-80e4-1160dd57g114 | ||||||||
Date and time of creation |
|
| Date and time when issue has been created. It's formatted as follows: YYYY-MM-DDTH24:MM:SS.msTZ | 2019-04-01T14:19:07.060+0200 | ||||||||
Creator |
|
| Atlassian account ID of the user who actually creates the issue in JIRA | 765428:168p0983-5987-444e-80e4-1160dd57g114 | ||||||||
Creator's full name |
|
| Name and surname of the user who actually created the issue in JIRA | Richard Feynman | ||||||||
Creator's email |
|
| Email address of the user who actually created the issue in JIRA | richard.feynman@gmail.com | ||||||||
Description |
|
| Issue description | Take your Jira to the next level by using JWT for Jira Cloud | ||||||||
Due date |
|
| Field that stores a date with no time part and is used to schedule issues. It's formatted as follows: YYYY-MM-DD | 2019-10-22 | ||||||||
Environment |
|
| Field to describe the environment where the issue has occurred | Take your Jira to the next level by using JWT for Jira Cloud | ||||||||
Fix version/s |
|
| Comma separated list of fix version names | 1.0,2.0,2.1 | ||||||||
Fix version/s ID |
| Comma separated list of fix versions IDs | 10010,10020,10030 | |||||||||
Number of fix version/s |
|
| Number of fixed versions in current issue | 5 | ||||||||
Issue ID |
|
| ID of the current issue | 10001 | ||||||||
Issue key |
|
| Issue key of the current issue | CRM-25 | ||||||||
Issue type |
|
| Name of issue's Issue Type in the user's language set in his profile | Improvement | ||||||||
Issue type ID |
| ID of issue's Issue Type | 10056 | |||||||||
Labels |
|
| Comma separated list with all the labels of the issue | web,customer,java,mobile | ||||||||
Number of labels |
|
| Number of labels in current issue | 4 | ||||||||
Last comment |
|
| Last comment entered in the issue | Take your Jira to the next level by using JWT for Jira Cloud | ||||||||
Last commenter |
|
| Atlassian account ID of the user who entered the last comment in the issue | 557068:145e0983-5707-439c-80e4-1160dd57g114 | ||||||||
Issue status |
|
| Name of current status of the issuein the user's language set in his profile | Open | ||||||||
Issue status ID | %{issue.status.id} |
| ID of current status of the issue | 10100 | ||||||||
Issue status category |
|
| Name of the category in the user's language set in his profile | Done | ||||||||
Previous issue status |
|
| Name of the status the issue was just before current one The name is shown in the user's language set in his profile | Closed | ||||||||
Keys of linked issues |
|
| Comma separated list of issue keys | CRM-13,HR-25,SD-12 | ||||||||
Number of linked issues |
|
| Number of issues linked to current issue | 3 | ||||||||
Original estimate (minutes) |
|
| Time originally estimated for the issue expressed in minutes It's a real number, so it may have a non-zero fractional part | 360 | ||||||||
Remaining estimate (minutes) |
|
| Remaining time estimated for the issue expressed in minutes It's a real number, so it may have a non-zero fractional part | 270 | ||||||||
Total time spent (minutes) |
|
| Work time currently spent at the issue expressed in minutes It's a real number, so it may have a non-zero fractional part | 90 | ||||||||
Priority |
|
| Name of the priority in the user's language set in his profile | Critical | ||||||||
Priority ID |
|
| ID of the priority the issue belongs to | 10010 | ||||||||
Project |
|
| Project Key of the project the issue belongs to | HR | ||||||||
Project ID |
|
| Project ID of the project the issue belongs to | 10100 | ||||||||
Project key |
|
| Project Key of the project the issue belongs to (identically to Project, i.e %{issue.project} ) | HR | ||||||||
Project name |
|
| Name of the project the issue belongs to | Customer Relationship Management | ||||||||
Project description |
|
| Field description of the project the issue belongs to | Take your Jira to the next level by using JWT for Jira Cloud | ||||||||
Project URL |
|
| Field URL of the project the issue belongs to | https://www.decadis.de/x | ||||||||
Project category |
|
| Name of the Category of the project the issue belongs to | Take your Jira to the next level by using JWT for Jira Cloud | ||||||||
Project lead |
|
| Atlassian account ID of the user who leads the project the issue belongs to | 557068:145e0983-5707-439c-80e4-1160dd57g114 | ||||||||
Project lead's full name |
|
| Name and surname of the user who leads the project the issue belongs to | Galileo Galilei | ||||||||
Project lead's email |
|
| Email address of the user who leads the project the issue belongs to | galileo.galilei@me.com | ||||||||
Reporter |
|
| Atlassian account ID of the user who reported the issue | 557068:145e0983-5707-439c-80e4-1160dd57g114 | ||||||||
Reporter's full name |
|
| Name and surname of the user who created the issue | Albert Einstein | ||||||||
Reporter's email |
|
| Email address of the user who created the issue | albert.einstein@yahoo.com | ||||||||
Resolution |
|
| The name of the resolution currently set at the issue. The name of the resolution is shown in the user's language set in his profile | Won't fix | ||||||||
Date and time of resolution |
|
| Date and time of the most recent update of field Resolution. It's formatted as follows: YYYY-MM-DDTH24:MM:SS.msTZ | 2019-04-01T14:19:07.060+0200 | ||||||||
Security level |
|
| Name of the security level the issue currently has | Classified | ||||||||
Security level ID |
|
| ID of the security level the issue currently has | 10001 | ||||||||
Keys of sub-tasks |
|
| Comma separated list of issue keys | CRM-23,CRM-26,CRM-31 | ||||||||
Number of sub-tasks |
|
| Number of subtasks of current issue | 3 | ||||||||
Summary |
|
| The issue summary | Take your Jira to the next level by using JWT for Jira Cloud | ||||||||
Available transitions |
|
| A comma separated list with the names of transitions with origin in current issue status | Start Progress,Resolve Issue,Close Issue | ||||||||
Date and time of last update |
|
| Date and time of the most recent issue update It's formatted as follows: YYYY-MM-DDTH24:MM:SS.msTZ | 2019-04-01T14:19:07.060+0200 | ||||||||
Number of votes received |
|
| Number of votes received by the issue | 5 | ||||||||
Date and time of latest status change |
|
| Date and time of the most recent status change in the issue. It's formatted as follows: YYYY-MM-DDTH24:MM:SS.msTZ | 2019-04-01T14:19:07.060+0200 | ||||||||
Watchers |
|
| Comma separated list of Atlassian account IDs of current watchers of the issue | 557068:145e0983-5707-439c-80e4-1160dd57g114,777068:145e0983-5707-439c-80e4-1160dd57x554 | ||||||||