Versions Compared

Key

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

Content Layout Macro

Panel

On this page

Table of Contents
exclude(On this page).*
typeflat
separatorpipe


UI Text Box
sizemedium
typeinfo

The JWT for Jira Cloud expression parser provides a huge set of functionalities to read and manipulate data from Jira issues, users, projects and more.

The main point of contact with the expression parser for the end user is the JWT expression editor.

Depending on what you are doing, you will be presented with different options and functionalities, but in the end it always comes down to writing an expression, which the JWT expression parser will evaluate.

UI Text Box
sizemedium
typeinfo

The parser expression editor saves you time by checking your expression before adding it to a post function, validator, or condition.

No, that's not a nice layout - but just as a hint that an overview of the expression editor (including hints to the different features) right at the top of the page would be a good idea 

Image Removed

will be evaluated on runtime.

 

Image Added



UI Expand
titleSyntax check

Multimedia
nameparser-field-parser-error.mp4
width700

  1. As you type in your expression the syntax check button is synchronized with your expression and you can see if your expression is valid or not.
  2. Click on the syntax check button to review your expression.
OutputDescription

Image Added

Valid expression: The parser expression entered is valid.

Image Added

Parsing error: The parser expression entered is not valid and you can do the following to fix the issue:

  • Check your selected Parsing mode
  • Try an example configuration from the right hand side of the configuration interface



UI Expand
titleParsing mode selectionselector

Excerpt Include
Parsing modes
Parsing modes
nopaneltrue

Read more about all available parsing modes.


UI Expand
titleField code injector


Excerpt

Screencast about The field code injector

Select a field code from the available list to insert the desired field values automatically.

UI Expand
titleExpression editing area

This is where you can enter a plain text and optionally use Field codes and JWT expression parser functions.

Which options you will actually have depend on the selected Parsing modes.

UI Text Box
typetip

A powerful feature of the editing area is auto-completion.

Pressing <CTRL> + <space> will show a searchable list ofJWT expression parser functions and available field codes.

Image Removed

Highlighting makes it easy to recognize essential parts of the expression.

is a dynamic select list that lists all available field codes. The fields, or their values, will be be replaced with actual values at runtime.

The available fields and their notation depend on the selected Parsing mode. Custom fields are shown if they are defined for a global context or if the "Jira Workflow Toolbox Cloud" user has browse permissions for the respective project. 

Learn more about field codes!

JWT expressionsJira expressions


Center

Multimedia
nameparser-field-jwt-expression.mp4
width300
height300



Center

Multimedia
nameparser-field-jira-expression.mp4
width300
height300




Image AddedA few basic examples

Field nameField code (JWT expression)

Field code (Jira expressions)

Summary

%{issue.summary}

issue.summary

Description

%{issue.description}

issue.description

Assignee

%{issue.assignee}

issue.assignee.accountId

Reporter

%{parent.reporter}

issue.parent.reporter.accountId



Syntax check
UI Expand
titleExample injector

Image Added

Need inspiration? Each parsing mode comes with built-in example expressions. If you choose an example from the dropdown menu, the expression will be automatically added to the editing area of the expression editor.

UI Expand
title


UI Expand
titleThe run Run button

Image RemovedImage Added

By clicking on the run button, a test expression panel is displayed under your expression. To test your expression, do the following:

  1. Select an issue as the current issue
  2. Click on Run

Image RemovedImage Added

The result of the expression is displayed. For more detailed test scenarios, please have a look at: Test your expression.


UI Expand
titleSyntax check
UI Expand
titleIn-line handbook
UI Expand
titleBuilt-in examples
Handbook

Multimedia
nameparser-field-parser-handbook.mp4
width700

Help is just a click away. If you click on the Help button, an in-line handbook will pop up, which provides information about almost any feature of JWT for Jira Cloud - from field codes, to Parsing modes and JWT expression parser functionsIn case you have selected the Jira expression mode, the documentation will be opened in a new browser window.


UI Expand
titleExpression area

This is where you can enter a plain text and optionally use Field codes and functions belonging to the selected parsing mode. 

Which options you will actually have depend on the selected Parsing mode.

Multimedia
nameparser-field-auto-complete.mp4
width700


Syntax check

Image Removed

Image Removed: Valid parsing i.e. The parser expression entered is valid for usage.

Image Removed: Parsing error i.e. The parser expression entered is not valid and you can do the following to fix the issue:

  • Check your expression

UI Expand
titleAuto-complete

Tech tip: Auto-complete

The expression editor comes with a built-in auto-complete feature. 

Simply press <CTRL> + <space> and get a searchable list of JWT expression parser functions and available field codes.

Image Added

UI Steps
UI Step
Expand
titlemore info...
UI Text Box
typeinfo
  1. As you type in your expression the parser check button is synchronized with your expression and you can see if it is valid or not so far.
  2. Click on the parser check button to review your expression.
  • Check your selected parsing mode
  • Try an example by clicking on the example button
  • Try an example configuration from the right hand side of the configuration interface.
  • UI Step

    Parsing mode selector

    Image Removed

    The following parsing modes are available (depending on the respective parameter):

    • General - works for any text/number/list parameter in post functions, i.e. for adding a comment text
    • Logical - works for conditions in post functions
    • Jira expression - works for every parameter
    UI Step

    Field code injector

    Image Removed

    Add a field code from the available list to insert the desired field values automatically. The selector allows searching for a specific field.

    UI Step

    Example selector

    Image Removed

    Insert the parser expression content directly from one of the built-in examples.

    UI Step

    Help button

    Image Removed

    By clicking on the help button the Expression parser handbook is displayed and you can go through the basics of the JWT for Jira Cloud expression parser and the function library.

    Input area

    Image Removed

    please

    This is where you can enter a plain text and optionally use Field codes.

    One of the features the input area offers is autocompletion: pressing <ctrl><space> shows a searchable list of functions and field codes which are available (see example above).
    UI Step
    UI Text Box
    typetip

    Highlighting makes it easy to recognize essential parts of the expression.




    Excerpt Include
    DECADIS:Contact support
    DECADIS:Contact support
    nopaneltrue