Versions Compared

Key

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

...

Excerpt Include
Field Codes and Usage
Field Codes and Usage



Automation Toolbox for Jira provides a set of special fields called virtual fields, making almost all properties of issues, projects and users accessible to every feature in the app.

Virtual fields may be read and written by Automation Toolbox for Jira in the same way ordinary custom fields are.

Virtual fields and their associated field codes, were created to

...

Code Block
titleappend the last comment to the issue desciption
#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

There are multiple parsing modes available in the expression parser. The two most commonly used parsing modes are:

  • Basic: with this simple parsing mode you can write free text and insert field codes with format %{nnnnn} or %{nnnnn.i} anywhere in your text. These field codes will be replaced at runtime with the corresponding field values of the issue currently being processed
  • Advanced: with this parsing mode we can do much more complex text composition thanks to the usage of functions for replacing substrings, changing case, reading fields in linked issues, sub-tasks, JQL selected issues, and much more. It requires the text to be parsed to be written as string expression respecting the parser syntax.

  • Automatic parsing mode converter: You can write your text in basic mode, and then switch to advanced mode. The text to be parsed will be automatically rewritten as a string expression. Now, you can simply make the modifications you require, making use of text formatting functions, or inserting math or time expressions where needed.

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.

...

ModeSupported featuresReturn typeExample
basicBasicField codes

String

Object


The basic parsing mode supports the usage of field codes. Field codes can be used to access issue field values.

Code Block
titlesimple text using a field code to read the summary
This is the issue summary: %{trigger.issue.summary}


advancedAdvanced

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
titleAdvanced expression to read the issue summary and use a function to get the assignee mail address
"This is the issue summary:" + %{trigger.issue.summary} + " and the assignee mail is: " + userEmail(%{trigger.issue.assignee})


mathMath/date time

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
titleTime to resolve the issue
{trigger.issue.resolutionDate} - {trigger.issue.createdDate}


logicalLogical

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
titleCheck if the assignee is equals the reporter
{trigger.issue.assingee} = {trigger.issue.reporter}
issue list


Issue List

Field codes

Parser Functions

issue list

string list

String List

Field codes

Parser Functions

string list
mixedMixed

Field codes

Parser Functions written in three curly braces

String


...