Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page propertiesStatusTech review

Status
titletodo

Style guide

Status
titletodo

Status
titletodo

Status
colourYellow
titleReady for review

Status
colourGreen
titledone

Status
colourRed
titleflagged


Panel

On this page

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



UI Text Box
sizemedium
typeinfo
Image RemovedOverview
info
UI Text Box
type

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. 

Image AddedOverview

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

Field codes

are available for:
  • readable fields
  • writable fields
  • virtual fields
  • issue, project and user properties

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

    All custom 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 vailable contexts (or  origins) in JWT are:

    ContextExampleDescription
    Example
    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

    The description of the current issue.

    parentThe

    summary}

     


    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 issues of the issue that is processed by a workflow post function or an automation rule. More info...

    %{seed.issue.summary}

    The summary of a seed issue.

    issue.projectsystemSome data does not have an issue context (e.g. the currently logged in user or the system date and time).

    %{seed.text}

    %{seed.number}


    The field value will be retrieved from the element currently being processed by a workflow function or automation rule that is capable of analyzing multiple 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.

    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

    %{system.currentUser}

    The current user (e.g. executing the post function)
    .



    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.

    These additional contexts are available for automation rules:

    ContextDescriptionExample
    trigger The issue, user, version, component or project event
     that 
    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 and will be inserted into the expression  whenever you select a field from a dropdown list (as shown below).   INSERT SCREENCAST

    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}

    UI Expand
    titleField codes in the documentation
    Info

    Wherever field codes are used in the documentation, they will be notated with three periods (...)  instead of a prefix. 

    • %{...summary} 

    • %{...cf10021}

    •   {...duedate}

    UI Text Box
    typeinfo

    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)

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


    UI Expand
    titleNumber vs. text 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
    string
    • 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.

    Anchorreadablereadable




    Image Modified

    Readable fields

    The list below contains all fields that can be read by JWT.

    Issue-related fields

    Table Filterinversefalse,false,sparkNameSparklinelimitHeightseparatorPoint (.)labels‚‚default,,cell-width,,userfilterField name,Field code,Outputdatepatterndd M yyid1583162791452_543661562worklog5|8|w d h m|w d h misORANDorder0,1,2Field nameField codeTypeOutputExample outputAffects version/s

    {issue.versions.id}

    Status
    subtletrue
    colourBlue
    titlenumber []

    Comma separated list of version IDs

    10010,10020,10030

    Number of affects version/s

    {issue.versions.length}

    StatuscolourBluetitlenumberNumber of affected versions in current issue3Assignee

    %{issue.assignee}

    StatuscolourGreytitleuserThe Atlassian account ID of the user who has the issue assigned10007Assignee's full name

    %{issue.assignee.displayName}

    Status
    colourYellow
    titlestring

    Name and surname of the user who currently has the issue assignedAlbert EinsteinAssignee's email

    %{issue.assignee.email}

    Status
    colourYellow
    titlestring

    Email address of the user who currently has the issue assignedalbert.einstein@yahoo.comAttachments

    %{issue.attachments}

    StatuscolourGreytitleattachment []Comma separated list of file names of all files attached to the issuefile1.txt,readme.pdf,screenshot.pngNumber of attachments

    {issue.attachments.length}

    StatuscolourBluetitlenumberNumber of files attached to current issue3

    Available field codes

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

    UI Children
    styleh4

    Search
    placeholderTextSearch through available field codes
    cqlancestor = 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

    Custom field%{issue.cf10100}

    Status
    colourYellow
    titlestring

    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 administrationYour customfield value
    Custom field{issue.cf10133} StatuscolourBluetitlenumberValue 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 administration47Component/s

    %{issue.components}

    StatuscolourGreytitlecomponent []Comma separated list of component namesWeb Site,Authenticator,StatisticsComponent/s ID

    {issue.components.id}

    Status
    subtletrue
    colourBlue
    titlenumber []

    Comma separated list of component IDs10010,10020,10030Component/s leads

    %{issue.components.leads}

    StatuscolourGreytitleuser []Comma separated list of the Atlassian account IDs of the leads for the components557068:145e0983-5707-439c-80e4-1160dd57g114,777068:145e0983-5707-439c-80e4-1160dd57x554,765428:168p0983-5987-444e-80e4-1160dd57g114Date and time of creation

    %{issue.created}

    StatuscolourGreytitledate_time

    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+0200Creator

    %{issue.creator}

    StatuscolourGreytitleuserAtlassian account ID of the user who actually creates the issue in JIRA765428:168p0983-5987-444e-80e4-1160dd57g114Creator's full name

    %{issue.creator.displayName}

    Status
    colourYellow
    titlestring

    Name and surname of the user who actually created the issue in JIRARichard FeynmanCreator's email

    %{issue.creator.email}

    Status
    colourYellow
    titlestring

    Email address of the user who actually created the issue in JIRArichard.feynman@gmail.comDescription

    %{issue.description}

    Status
    colourYellow
    titlestring

    Issue descriptionTake your Jira to the next level by using JWT for Jira CloudDue date

    %{issue.dueDate}

    StatuscolourGreytitledate

    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-22Environment

    %{issue.environment}

    Status
    colourYellow
    titlestring

    Field to describe the environment where the issue has occurredTake your Jira to the next level by using JWT for Jira CloudFix version/s

    %{issue.fixVersions}

    StatuscolourGreytitleversion []Comma separated list of fix version names1.0,2.0,2.1Fix version/s ID

    {issue.fixVersions.id}

    Status
    subtletrue
    colourBlue
    titlenumber []

    Comma separated list of fix versions IDs10010,10020,10030Number of fix version/s

    {issue.fixVersions.length}

    StatuscolourBluetitlenumberNumber of fixed versions in current issue5Issue ID

    {issue.id}

    StatuscolourBluetitlenumberID of the current issue10001Issue key

    %{issue.key}

    Status
    colourYellow
    titlestring

    Issue key of the current issueCRM-25Issue type

    %{issue.issueType}

    StatuscolourGreytitleissue typeName of issue's Issue Type in the user's language set in his profile

    Improvement 

    Issue type ID

    {issue.issueType.id}

    StatuscolourBluetitlenumberID of issue's Issue Type

    10056

    Labels

    %{issue.labels}

    StatuscolourGreytitlelabels []Comma separated list with all the labels of the issueweb,customer,java,mobileNumber of labels

    {issue.labels.length}

    StatuscolourBluetitlenumberNumber of labels in current issue4Last comment

    %{issue.lastComment}

    Status
    colourYellow
    titlestring

    Last comment entered in the issueTake your Jira to the next level by using JWT for Jira CloudLast commenter

    %{issue.lastComment.author}

    StatuscolourGreytitleuserAtlassian account ID of the user who entered the last comment in the issue557068:145e0983-5707-439c-80e4-1160dd57g114Issue status

    %{issue.status}

    StatuscolourGreytitlestatusName of current status of the issue in the user's language set in his profileOpenIssue status ID%{issue.status.id} StatuscolourBluetitlenumberID of current status of the issue10100Issue status category

    %{issue.status.category}

    StatuscolourGreytitlestatus categoryName of the category in the user's language set in his profileDonePrevious issue status

    %{issue.status.previous}

    StatuscolourGreytitlestatus

    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

    %{issue.links}

    Status
    subtletrue
    colourYellow
    titlestring []

    Comma separated list of issue keysCRM-13,HR-25,SD-12Number of linked issues

    {issue.links.length}

    StatuscolourBluetitlenumberNumber of issues linked to current issue3Original estimate (minutes)

    {issue.originalEstimate}

    StatuscolourBluetitlenumber

    Time originally estimated for the issue expressed in minutes

    It's a real number, so it may have a non-zero fractional part

    360Remaining estimate (minutes)

    {issue.remainingEstimate}

    StatuscolourBluetitlenumber

    Remaining time estimated for the issue expressed in minutes

    It's a real number, so it may have a non-zero fractional part

    270Total time spent (minutes)

    {issue.timeSpent}

    StatuscolourBluetitlenumber

    Work time currently spent at the issue expressed in minutes

    It's a real number, so it may have a non-zero fractional part

    90Priority

    %{issue.priority}

    StatuscolourGreytitlepriorityName of the priority in the user's language set in his profileCriticalPriority ID

    {issue.priority.id}

    StatuscolourBluetitlenumberID of the priority the issue belongs to10010Project

    %{issue.project}

    StatuscolourGreytitleprojectProject Key of the project the issue belongs toHRProject ID

    {issue.project.id}

    StatuscolourBluetitlenumberProject ID of the project the issue belongs to10100Project key

    %{issue.project.key}

    Status
    colourYellow
    titlestring

    Project Key of the project the issue belongs to (identically to Project, i.e %{issue.project})HRProject name

    %{issue.project.name}

    Status
    colourYellow
    titlestring

    Name of the project the issue belongs toCustomer Relationship ManagementProject description

    %{issue.project.description}

    Status
    colourYellow
    titlestring

    Field description of the project the issue belongs toTake your Jira to the next level by using JWT for Jira CloudProject URL

    %{issue.project.url}

    Status
    colourYellow
    titlestring

    Field URL of the project the issue belongs tohttps://www.decadis.de/xProject category

    %{issue.project.category}

    Status
    colourYellow
    titlestring

    Name of the Category of the project the issue belongs toTake your Jira to the next level by using JWT for Jira CloudProject lead

    %{issue.project.lead}

    StatuscolourGreytitleuserAtlassian account ID of the user who leads the project the issue belongs to557068:145e0983-5707-439c-80e4-1160dd57g114Project lead's full name

    %{issue.project.lead.displayName}

    Status
    colourYellow
    titlestring

    Name and surname of the user who leads the project the issue belongs toGalileo GalileiProject lead's email

    %{issue.project.lead.email}

    Status
    colourYellow
    titlestring

    Email address of the user who leads the project the issue belongs togalileo.galilei@me.comReporter

    %{issue.reporter}

    StatuscolourGreytitleuserAtlassian account ID of the user who reported the issue557068:145e0983-5707-439c-80e4-1160dd57g114Reporter's full name

    %{issue.reporter.displayName}

    Status
    colourYellow
    titlestring

    Name and surname of the user who created the issueAlbert EinsteinReporter's email

    %{issue.reporter.email}

    Status
    colourYellow
    titlestring

    Email address of the user who created the issuealbert.einstein@yahoo.comResolution

    %{issue.resolution}

    StatuscolourGreytitleresolutionThe name of the resolution currently set at the issue. The name of the resolution is shown in the user's language set in his profileWon't fix
    Date and time of resolution

    %{issue.resolutionDate}

    StatuscolourGreytitledate_time

    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+0200Security level

    %{issue.securityLevel}

    StatuscolourGreytitlesecurityName of the security level the issue currently hasClassifiedSecurity level ID

    {issue.securityLevel.id}

    StatuscolourBluetitlenumberID of the security level the issue currently has10001Keys of sub-tasks

    %{issue.subtasks}

    Status
    subtletrue
    colourYellow
    titlestring []

    Comma separated list of issue keysCRM-23,CRM-26,CRM-31Number of sub-tasks

    {issue.subtasks.length}

    StatuscolourBluetitlenumberNumber of subtasks of current issue3Summary

    %{issue.summary}

    Status
    colourYellow
    titlestring

    The issue summaryTake your Jira to the next level by using JWT for Jira CloudAvailable transitions

    %{issue.transitions.achievable}

    Status
    colourYellow
    titlestring

    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

    %{issue.updated}

    StatuscolourGreytitledate_time

    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+0200Number of votes received

    {issue.votes}

    StatuscolourBluetitlenumberNumber of votes received by the issue5Date and time of latest status change

    %{issue.lastStatusChange}

    StatuscolourGreytitledate_time

    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

    %{issue.watcher}

    StatuscolourGreytitleuser []Comma separated list of Atlassian account IDs of current watchers of the issue557068:145e0983-5707-439c-80e4-1160dd57g114,777068:145e0983-5707-439c-80e4-1160dd57x554