Page History
This page will help you to get familiar with the powerful expression parser. We provide several use cases that will guide you to write simple expressions as well as high complex expression. To understand the expression parser, work through the sections on this page and you will be able to use it like a pro.
Table of Contents
Introduction
...
...
Virtual Fields
The concept behind virtual fields is to make it possible to write several issue fields and virtual fields that are standard fields like the issue summary and fields that are not writable by default. You can for example trigger the execution of a transition using the virtual field "Issue Status" or add a new comment using the virtual field "New Comment".
Reading virtual fields to use their values to update other fields is possible with field codes. We support string and number field values. An example of a string field code is: %{issue.summary} and a number field code is {issue.dueDate}. Every feature in our app supporting expressions provide dropdown fields to search for the available field codes and insert the field code in your expression. So you don't need to remember the field codes. You always can search for the right field code.
Sample string field codes
...
...
...
...
Sample number field codes
- {issue.dueDate}
- {issue.createdDate}
- {issue.votes}
- {parent.dueDate}
...
...
Functions
The expression parser provides over 200 functions to read, manipulate and filter data from Jira issues, users, groups and more. The functions support issue filtering, date calculation, string manipulation and more. A great set of operators allows you to write conditional functions, mathematical operations and comparison expressions.
The following list shows the overview of operators and function provided by the parser:
Operator
- Boolean operator
- Mathematical operator
- List operator
- Logical operator
- Conditional operator
Functions
- Issue data functions
- User, Group & Role functions
- Version functions
- Field history functions
- Selectable fields functions
- Mathematical functions
- Date-Time functions
- String functions
- String list functions
- Issue list functions
- Number list functions
- Cast functions
You can find all functions here.
The Expression Parser Syntax Specification
Automation Toolbox for Jira uses a powerful expression parser for interpreting expressions with logical, mathematical, date-time and string-text terms.
This parser is a fundamental part of the app, and is used by various features in the app. The parser offers very similar functionality to the expression parser known to Jira Workflow Toolbox users. There are some differences, mainly in field code usage and the lack of ephemeral fields.
You can use the provided parser functionality with a number of triggers, conditions, actions and selectors.
The following is a simple example of parser usage for the Condition → Boolean Condition .
The condition will return true if the issues Due date is greater than the current date.
...
| Code Block | ||
|---|---|---|
| ||
#basic parsing mode
%{trigger.issue.description}
Last comment:
%{trigger.issue.comment.last}
#advanced parsing mode
%{trigger.issue.description} + "\nLast comment: \n" + %{trigger.issue.comment.last} |
Parsing modes
The Expression Parser offers you different modes to provide a flexible usage in certain places. You can calculate an issue due date depending on the current date or filter the issue sub-tasks by status to add a comment to those.
To update issue fields the parsing result will be cast to the expected value e.g. a user name will be cast to a user to update a user field like the assignee field.
...
String
Object
The basic parsing mode supports the usage of field codes. Field codes can be used to access issue field values.
| Code Block | ||
|---|---|---|
| ||
This is the issue summary: %{trigger.issue.summary} |
...
Field codes
Parser Functions
...
String
Object
The advanced parsing mode has a defined syntax that allows you to write functions to read and manipulate data from any issue in Jira. Field codes are supported as well as clear text, written in quotation marks.
| Code Block | ||
|---|---|---|
| ||
"This is the issue summary:" + %{trigger.issue.summary} + " and the assignee mail is: " + userEmail(%{trigger.issue.assignee}) |
...
Field codes
Parser Functions
...
Number
Date
Date Time
The mathematical and date time parsing mode works like the advanced mode but expect a number as result instead of a string. The resulting number is used to updated numeric or date time fields. In case of date or date time fields the number will be cast to a date.
| Code Block | ||
|---|---|---|
| ||
{trigger.issue.resolutionDate} - {trigger.issue.createdDate} |
...
Field codes
Parser Functions
...
true
false
The logical parsing mode works like the advanced parsing mode but expression result must return true or false.
| Code Block | ||
|---|---|---|
| ||
{trigger.issue.assingee} = {trigger.issue.reporter} |
...
Field codes
Parser Functions
...
issue list
...
Field codes
Parser Functions
...
Field codes
Parser Functions written in three curly braces
...
