Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

On this page

Table of Contents
maxLevel3
exclude(On this page|Get to know Automation rules).*
stylecircle
typeflat
separatorpipe

Page properties
hiddentrue
Status
Tech review

Status
colourRed
titleflagged

Style guide

Status
titletodo

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



UI Text Box
sizemedium
typeinfo

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 JWT expression editor. At the same time a field code is a safety feature that makes your expressions immune to custom field renaming.

Overview

Field codes will be automatically added to your expression when you insert them anywhere using the expression parser field picker.

SCREENCAST, but a better one

Potentially with text / like the getting started video? 

  • This is a text
  • This is a number
  • This is a value from the parent....

Multimedia
nameparser.mp4
width1000
autostarttrue

UI Text Boxtypetip

code injector.

Field codes for Jira standard or system fields will display the attribute in a legible form like  %{issue.summary}.

All

selected

 custom

field

fields will be notated like  %{

.

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.

UI Text Box
typetip

The purpose of using the cfnnnnn notation is quite simple - custom fields can be renamed .


Multimedia
namejwt-field-codes.mp4
width700
heighttrue


 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:

Example
ContextExampleDescription
issue

%{issue.description


The field value will be retrieved from the issue that currently being processed by a workflow function or automation rule.

UI Text Box
typetip

The most commonly used context in JWT.


parent

%{

issue

parent.

description

summary}

 

The description of the current issue.

parent


The

The field value will be retrieved from the

parent of the issue that is processed by a workflow post function or an automation rule.

(warning)

UI Text Box
typetip

 Only valid for sub-tasks.


seed

%{

parent

seed.issue.summary}

The summary of the parent issue.

seed.issue

%{seed.text}

%{seed.number}


The field value will be retrieved from the element The  issue currently being processed by a workflow function or automation rule that is capable of analyzing multiple issues elements (e.g. Create issue post function or the Create issue action).

Elements can be:

  • issues
  • texts
  • numbers

depending in your configuration. Read more about Seeds.

action

%{action.status}

The value will be retrieved from the response of the executed remote action. 

UI Text Box
typetip
Currently only available in the Execute remote action post function.


function

filterByPredicate(subtasks(){function.issue.dueDate} != null)

UI Text Box
typeinfo
This example returns a list of all sub-tasks of the current issue that have a due date set.


The field value will be retrieved from issue(s) returned by some JWT expression parser functions.

These issues are called seed issues.

Alternatively you can add ^ as a prefix. Read more about Seeds.

%{seed.issue.summary}

The summary of a seed issue.

Mostly these are functions that return an issue list (e.g. subtasks()).

UI Text Box
typetip

Some functions iterate (loop) over all elements returned by a list. As soon as each element of the list is being processed, this element is the temporary context.


created.parent

%{created.parent.summary}

The field value will be retrieved from the new parent issue of a sub-tasks being created in a workflow post function.

UI Text Box
typetip
Currently only available in the Create issue post function and only valid for sub-tasks.



UI Expand
titleAdditional contexts for automation rules

An issue is tied to a workflow. This is why most field codes in JWT workflow functions have their issue context. Automation rules are not tied to individual issues. This is why sometimes it is necessary to define their context separately.

Additional contexts
UI Expand
title

These additional contexts are available for automation rules:

ContextDescriptionExample
trigger The issueuser, version, component or project event that triggers the execution of the rule.

%{trigger.issue.description}

The description of the issue triggering the automation rule.

selector The  issue currently being processed by a selector  (e.g. an issue returned by a JQL query).

%{selector.issue.cf10021}

The value of the custom field with the ID 10021 from the issue currently being processed by a selector.

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).   

Multimedia
nameentering_parser_field_codes - cut.mp4
width1000


UI Text Box
typeinfo

The additional contexts can be used in combination with the standard contexts (e.g. parent, seed).

Example: %{trigger.parent.summary}

Find a full list of automation-only field code here: Field codes (automation-only)

Image RemovedNumbers


UI Expand
titleNumber vs. text
(strings)
field code notation

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
  • Numeric fields can be referenced as numbers using the following notation: {issue. somenumberfield }. (
(info)
  • (info) 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 .
String
  • Text fields : Any field type or data type
is susceptible of being
  • can be 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
    • text will be returned.
  • Cascading Select fields are treated as text 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
typetip

A complete list of all available data types can be found here.




Available field codes

Check out the following pages to familiarize yourself with the different types of field codes.

ui-children
styleh4
or search for a specific field code:

Search
placeholderTextSearch through available field codes
cqlancestor =
32212831
27066593

Page properties report
firstcolumnField name
headingsField code, Type, Example output, Labels
pageSize300
sortByTitle
cqllabel = "field-code" and space = currentSpace()


Page properties
hiddentrue



Status
Tech review

Status
colourGreen
titledone
 

Style guide

Status
colourGreen
titledone

Page status

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Excerpt Include
DECADIS:Contact support
DECADIS:Contact support
nopaneltrue