Expression functions
Every function you can use in the expressions of a Report Builder report
Browse this sectionMiscellaneous / Expression functions
Planning
Reports
Miscellaneous
Expression functions
Expressions calculate the values a report shows: the text of a header, the value of a column, whether a row is shown, the JQL of a datasource and more. A property that starts with = is an expression, such as =Concat(Field.key, " - ", Field.summary).
This page lists every function of the Report Builder of Jira Assistant 3, available in the Jira Cloud app. The same list is inside the Report Builder: open the Functions panel on the left, or select the book button in any expression field to search the functions and insert one where you are typing. While you type a function, the field shows its parameters and marks the one you are on. Function names are not case sensitive.
Aggregate · Logic · Text · Number · Formatting · Date · List · Row · Conversion · Jira · Your preferences · Time tracking
Writing an expression
Values you can use
| Write | To get |
|---|---|
Field.name | A field of the current row. Nested fields use dots, such as Field.status.name. |
Parameters.name | The value the viewer chose for a report parameter. |
Variables.name | The current value of a report variable. |
BuiltInFields.name | A value given by the application, such as the signed-in user. |
Datasources.Name | Every row of a datasource, for use with functions such as Sum or Count. |
Datasources.Name.field | The values of one field across every row of a datasource. |
RowGroup("name").key | Inside a table group: the group value. Use .values for its rows. |
Operators
| Operator | Meaning |
|---|---|
+ - * / | Arithmetic. + also joins texts. |
== != < > <= >= | Comparison. Gives true or false. |
&& || ! | And, or, not. |
"text" 'text' | A text value, in double or single quotes. |
true false null | Fixed values. |
Parameter types
| Type | Accepts |
|---|---|
string | Text. |
number | A number. |
boolean | true or false. |
date | A date, or a text such as 2026-11-22 or 2026-11-22T10:30:00Z. |
array | A list of values. |
rows | A list of rows, such as Datasources.Name or RowGroup("name").values. |
any | Any kind of value. |
Aggregate
Sum(values: array, field?: string) → number
Adds up the numbers in a list. Values that are not numbers are skipped.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
Sum(Datasources.Worklogs, "hours")Sum(RowGroup("project").values, "hours")Sum(Split("1,2,3", ","))gives6
Count(values: array, field?: string) → number
Number of items in a list. With a field, only the rows where that field has a value are counted.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
Count(RowGroup("status").values)Count(Datasources.Issues, "assignee")Count(Split("a,b", ","))gives2
CountDistinct(values: array, field?: string) → number
Number of different values in a list. Empty values are not counted.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
CountDistinct(Datasources.Issues, "assignee.displayName")CountDistinct(Split("a,b,a", ","))gives2
Avg(values: array, field?: string) → number
Average of the numbers in a list. Gives 0 when there are no numbers.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
Avg(Datasources.Issues, "storyPoints")Avg(Split("2,4,9", ","))gives5
Median(values: array, field?: string) → number
Middle value of the numbers in a list. Gives 0 when there are no numbers.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
Median(Pluck(Datasources.Issues, "storyPoints"))Median(Split("1,5,9", ","))gives5
Min(values: array, field?: string) → number
Smallest number in a list. Gives 0 when there are no numbers.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
Min(Datasources.Worklogs, "hours")Min(Split("4,2,8", ","))gives2
Max(values: array, field?: string) → number
Largest number in a list. Gives 0 when there are no numbers.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: number
Max(Datasources.Worklogs, "hours")Max(Split("4,2,8", ","))gives8
Percent(part: number, total: number, decimals?: number) → number
Part as a percentage of the total, rounded. Gives 0 when the total is 0.
| Parameter | Type | Description |
|---|---|---|
part | number | The share to measure. |
total | number | The whole the part belongs to. |
decimals | numberoptional | Number of digits after the decimal point, from 0 to 10. Default 0. |
Returns: number
Percent(3, 8, 1)gives37.5
Logic
IIf(condition: boolean, trueValue: any, falseValue: any) → any
Gives one value when the condition is true and another when it is false.
| Parameter | Type | Description |
|---|---|---|
condition | boolean | The test to check. |
trueValue | any | Given when the condition is true. |
falseValue | any | Given when the condition is false. |
Returns: any
IIf(Field.hours > 8, "Overtime", "Normal")IIf(3 > 2, "yes", "no")givesyes
Switch(value: any, ...caseAndResult: any[]) → any
Compares a value with each case in turn and gives the result paired with the first case that matches. A last unpaired argument is the result when nothing matches; without it the result is null.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to compare. |
...caseAndResult | anyany number | Pairs of a case and its result, then an optional fallback. |
Returns: any
Switch(Field.priority.name, "Highest", 1, "High", 2, 3)Switch("High", "Highest", 1, "High", 2, 3)gives2
Coalesce(...values: any[]) → any
First argument that is not null. Gives null when all of them are null.
| Parameter | Type | Description |
|---|---|---|
...values | anyany number | Values to try in order. |
Returns: any
Coalesce(Field.assignee.displayName, Field.reporter.displayName, "Nobody")Coalesce(null, "second")givessecond
IfNull(value: any, fallback: any) → any
Gives the fallback when the value is null, otherwise the value itself.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to check. |
fallback | any | Given when the value is null. |
Returns: any
IfNull(Field.storyPoints, 0)IfNull(null, 0)gives0
IsNull(value: any) → boolean
True when the value is null or missing.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to check. |
Returns: boolean
IsNull(Variables.selectedStatus)IsNull(null)givestrue
IsEmpty(value: any) → boolean
True when the value is null, an empty text or an empty list.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to check. |
Returns: boolean
IsEmpty(Parameters.projects)IsEmpty("")givestrue
InList(value: any, list: array) → boolean
True when the value is one of the items in the list. Items are also compared as text, so 5 matches "5".
| Parameter | Type | Description |
|---|---|---|
value | any | The value to look for. |
list | array | The list to look in. |
Returns: boolean
InList(Field.status.name, Split("Done,Closed", ","))InList("b", Split("a,b", ","))givestrue
Between(value: any, min: any, max: any) → boolean
True when the value lies between min and max, both included. Numbers are compared as numbers and everything else as text, which also works for yyyy-MM-dd dates.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to check. |
min | any | Lowest allowed value. |
max | any | Highest allowed value. |
Returns: boolean
Between(Field.date, StartOf("month", Today()), EndOf("month", Today()))Between(5, 1, 10)givestrue
Not(value: boolean) → boolean
Turns true into false and false into true. The same as writing ! before a value.
| Parameter | Type | Description |
|---|---|---|
value | boolean | The value to negate. |
Returns: boolean
Not(IsEmpty(Field.labels))Not(1 > 2)givestrue
Any(values: array) → boolean
True when the list has at least one item.
| Parameter | Type | Description |
|---|---|---|
values | array | The list to check. |
Returns: boolean
Any(Field.labels)Any(Split("a", ","))givestrue
All(values: array) → boolean
True when the list has items and every item is truthy.
| Parameter | Type | Description |
|---|---|---|
values | array | The list to check. |
Returns: boolean
All(Pluck(Datasources.Checks, "passed"))All(Split("a,b", ","))givestrue
Text
Concat(...values: any[]) → string
Joins all the arguments into one text.
| Parameter | Type | Description |
|---|---|---|
...values | anyany number | Values to join, in order. |
Returns: string
Concat(Field.key, " - ", Field.summary)Concat("JSP", "-", 12)givesJSP-12
Upper(value: string) → string
The text in capital letters.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to change. |
Returns: string
Upper("done")givesDONE
Lower(value: string) → string
The text in small letters.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to change. |
Returns: string
Lower("DONE")givesdone
Trim(value: string) → string
The text without spaces at the start and end.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to trim. |
Returns: string
Trim(" done ")givesdone
Len(value: string) → number
Number of characters in the text.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to measure. |
Returns: number
Len("Sprint")gives6
Length(value: any) → number
Number of items in a list, or number of characters in a text. Gives 0 for null.
| Parameter | Type | Description |
|---|---|---|
value | any | A list or a text. |
Returns: number
Length(Field.labels)Length(Split("a,b,c", ","))gives3
Mid(value: string, start: number, length: number) → string
Part of the text, starting at a position counted from 1.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to take from. |
start | number | Position of the first character to take. The first character is 1. |
length | number | Number of characters to take. |
Returns: string
Mid("JSP-123", 5, 3)gives123
Replace(value: string, find: string, replaceWith: string) → string
The text with every occurrence of find replaced.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to change. |
find | string | The text to look for. |
replaceWith | string | The text to put in its place. |
Returns: string
Replace("In Progress", " ", "-")givesIn-Progress
StartsWith(value: string, prefix: string) → boolean
True when the text starts with the prefix. Letter case matters.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to check. |
prefix | string | The start to look for. |
Returns: boolean
StartsWith(Field.key, "JSP-")StartsWith("JSP-12", "JSP")givestrue
EndsWith(value: string, suffix: string) → boolean
True when the text ends with the suffix. Letter case matters.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to check. |
suffix | string | The end to look for. |
Returns: boolean
EndsWith(Field.summary, "?")EndsWith("Ready?", "?")givestrue
Contains(value: string, search: string) → boolean
True when the text contains the other text. Letter case matters.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to search. |
search | string | The text to look for. |
Returns: boolean
Contains(Lower(Field.summary), "login")Contains("login page", "login")givestrue
PadLeft(value: any, length: number, char?: string) → string
The value as text, filled on the left up to the given length.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to pad. |
length | number | Length of the result. |
char | stringoptional | Character to fill with. Default " ". |
Returns: string
PadLeft(7, 3, "0")gives007
PadRight(value: any, length: number, char?: string) → string
The value as text, filled on the right up to the given length.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to pad. |
length | number | Length of the result. |
char | stringoptional | Character to fill with. Default " ". |
Returns: string
PadRight("A", 3, ".")givesA..
Split(value: string, separator?: string) → array
Splits a text into a list. Gives an empty list for an empty text.
| Parameter | Type | Description |
|---|---|---|
value | string | The text to split. |
separator | stringoptional | The text between the parts. Default ",". |
Returns: array The parts of the text.
Split("a,b,c", ",")gives["a", "b", "c"]
Join(values: array, separator?: string) → string
Joins the items of a list into one text. Null items are skipped.
| Parameter | Type | Description |
|---|---|---|
values | array | The list to join. |
separator | stringoptional | Text put between the items. Default ", ". |
Returns: string
Join(Field.labels, " | ")Join(Split("a,b", ","), " | ")givesa | b
Number
Round(value: number, decimals?: number) → number
The number rounded to the given number of decimals.
| Parameter | Type | Description |
|---|---|---|
value | number | The number to round. |
decimals | numberoptional | Number of digits to keep after the decimal point. Default 0. |
Returns: number
Round(2.456, 2)gives2.46
Floor(value: number) → number
The number rounded down to a whole number.
| Parameter | Type | Description |
|---|---|---|
value | number | The number to round. |
Returns: number
Floor(2.9)gives2
Ceil(value: number) → number
The number rounded up to a whole number.
| Parameter | Type | Description |
|---|---|---|
value | number | The number to round. |
Returns: number
Ceil(2.1)gives3
Abs(value: number) → number
The number without its minus sign.
| Parameter | Type | Description |
|---|---|---|
value | number | The number. |
Returns: number
Abs(-4)gives4
Formatting
FormatNumber(value: number, decimals?: number, thousandsSeparator?: string) → string
The number as text with a fixed number of decimals and a thousands separator. Gives an empty text when the value is not a number.
| Parameter | Type | Description |
|---|---|---|
value | number | The number to format. |
decimals | numberoptional | Number of digits after the decimal point, from 0 to 10. Default 2. |
thousandsSeparator | stringoptional | Text put between groups of thousands. Default ",". |
Returns: string
FormatNumber(1234.5)gives1,234.50FormatNumber(Field.hours, 1)
FormatCurrency(value: number, symbol?: string, decimals?: number) → string
The number as an amount of money.
| Parameter | Type | Description |
|---|---|---|
value | number | The amount. |
symbol | stringoptional | Currency symbol put in front. Default "$". |
decimals | numberoptional | Number of digits after the decimal point, from 0 to 10. Default 2. |
Returns: string
FormatCurrency(1500, "€")gives€1,500.00
FormatPercent(value: number, decimals?: number) → string
A fraction as a percentage, so 0.25 becomes 25%.
| Parameter | Type | Description |
|---|---|---|
value | number | The fraction, where 1 is 100%. |
decimals | numberoptional | Number of digits after the decimal point, from 0 to 10. Default 0. |
Returns: string
FormatPercent(0.256, 1)gives25.6%
FormatDate(date: date, format?: string) → string
The date as text in the given pattern. Patterns use yyyy, yy, MMMM, MMM, MM, M, dddd, ddd, dd, d, HH, H, hh, h, mm, ss and a.
| Parameter | Type | Description |
|---|---|---|
date | date | A date, a yyyy-MM-dd text or a date and time text. |
format | stringoptional | The pattern to write the date in. Default "yyyy-MM-dd". |
Returns: string
FormatDate("2026-11-22", "dd MMM yyyy")gives22 Nov 2026
Date
Today() → string
Today's date in your time zone.
Takes no parameters.
Returns: string The date as yyyy-MM-dd.
Today()
Now() → string
The current date and time.
Takes no parameters.
Returns: string The date and time as an ISO text in UTC.
FormatDate(Now(), "HH:mm")
DateAdd(unit: string, amount: number, date: date) → string
The date moved forward by an amount of time. Use a negative amount to move back. A yyyy-MM-dd date stays yyyy-MM-dd unless hours are added.
| Parameter | Type | Description |
|---|---|---|
unit | string | One of "day" (d), "week" (w), "month" (m), "year" (y) or "hour" (h). |
amount | number | How many units to add. |
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: string
DateAdd("day", 7, Today())DateAdd("month", 1, "2026-01-15")gives2026-02-15
DateDiff(unit: string, from: date, to: date) → number
Time from the first date to the second, in whole units. Days count calendar days. Gives null when a date is not valid.
| Parameter | Type | Description |
|---|---|---|
unit | string | One of "day" (d), "week" (w), "month" (m), "year" (y), "hour" (h) or "minute" (mi). Any other unit gives milliseconds. |
from | date | The start date. |
to | date | The end date. |
Returns: number
DateDiff("day", Field.created, Today())DateDiff("day", "2026-11-01", "2026-11-22")gives21
StartOf(unit: string, date: date) → string
First day of the week, month, quarter or year the date is in.
| Parameter | Type | Description |
|---|---|---|
unit | string | One of "week" (w), "month" (m), "quarter" (q) or "year" (y). Weeks start on Sunday. |
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: string The date as yyyy-MM-dd.
StartOf("month", "2026-11-22")gives2026-11-01
EndOf(unit: string, date: date) → string
Last day of the week, month, quarter or year the date is in.
| Parameter | Type | Description |
|---|---|---|
unit | string | One of "week" (w), "month" (m), "quarter" (q) or "year" (y). Weeks start on Sunday. |
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: string The date as yyyy-MM-dd.
EndOf("quarter", "2026-11-22")gives2026-12-31
Year(date: date) → number
The year of the date. Gives 0 when the date is not valid.
| Parameter | Type | Description |
|---|---|---|
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: number
Year("2026-11-22")gives2026
Month(date: date) → number
The month of the date, from 1 for January to 12. Gives 0 when the date is not valid.
| Parameter | Type | Description |
|---|---|---|
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: number
Month("2026-11-22")gives11
Day(date: date) → number
The day of the month, from 1 to 31. Gives 0 when the date is not valid.
| Parameter | Type | Description |
|---|---|---|
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: number
Day("2026-11-22")gives22
WeekDay(date: date) → number
The day of the week, from 0 for Sunday to 6 for Saturday.
| Parameter | Type | Description |
|---|---|---|
date | date | A date, a yyyy-MM-dd text or a date and time text. |
Returns: number
WeekDay("2026-11-22")gives0
List
Pluck(rows: rows, field: string) → array
The value of one field from every row.
| Parameter | Type | Description |
|---|---|---|
rows | rows | The rows to read. |
field | string | The field to read from each row. Nested paths are allowed. |
Returns: array One value for each row.
Pluck(Datasources.Issues, "key")
Distinct(values: array, field?: string) → array
The different values of a list in the order they first appear. Null values are left out.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: array Each value once.
Join(Distinct(Datasources.Issues, "status.name"))Join(Distinct(Split("a,b,a", ",")))givesa, b
First(values: array, field?: string) → any
The first item of a list. Gives null for an empty list.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: any
First(RowGroup("project").values, "project.name")First(Split("a,b", ","))givesa
Last(values: array, field?: string) → any
The last item of a list. Gives null for an empty list.
| Parameter | Type | Description |
|---|---|---|
values | array | A list of values, or a list of rows such as a datasource or the rows of a group. |
field | stringoptional | When values is a list of rows, the field to read from each row. Nested paths such as "fields.status.name" are allowed. |
Returns: any
Last(Datasources.Sprints, "name")Last(Split("a,b", ","))givesb
Row
Field(path: string) → any
Reads a field of the current row by its path. Useful when the path contains characters Field.name cannot hold. Gives null outside a row.
| Parameter | Type | Description |
|---|---|---|
path | string | The path of the field, with nested parts separated by dots. |
Returns: any
Field("fields.customfield_10016")
Conversion
ToString(value: any) → string
The value as text. Null becomes an empty text.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to convert. |
Returns: string
Concat("Sprint ", ToString(Field.id))ToString(12)gives12
ToNumber(value: any) → number
The value as a number.
| Parameter | Type | Description |
|---|---|---|
value | any | The value to convert. |
Returns: number
ToNumber("12.5")gives12.5
Jira
IssueUrl(key: string) → string
Address of the issue in Jira. Gives an empty text when there is no key.
| Parameter | Type | Description |
|---|---|---|
key | string | The issue key, such as JSP-12. |
Returns: string
IssueUrl(Field.key)
ProfileUrl(user: any) → string
Address of the Jira profile page of a user.
| Parameter | Type | Description |
|---|---|---|
user | any | A user, such as Field.assignee. |
Returns: string
ProfileUrl(Field.assignee)
GroupUsers(groupNames: any) → array
The members of the user groups you created in Jira Assistant.
| Parameter | Type | Description |
|---|---|---|
groupNames | any | A group name or a list of them, such as the value of a User groups parameter. |
Returns: array The users of every group named. It loads data, so it can take a moment to give its result.
UserIds(GroupUsers(Parameters.teams))
UserIds(users: any) → array
Account ids of users, or user names on Jira Server and Data Center. The members of a user group are included.
| Parameter | Type | Description |
|---|---|---|
users | any | A user, a user group or a list of them, such as the value of a Users parameter. |
Returns: array Each id once.
JqlList(UserIds(Parameters.users))
SprintIds(sprints: any) → array
Ids of the sprints chosen in a Sprints parameter.
| Parameter | Type | Description |
|---|---|---|
sprints | any | The value of a Sprints parameter. |
Returns: array The sprint ids. It loads data, so it can take a moment to give its result.
Join(SprintIds(Parameters.sprints), ",")
JqlList(values: any) → string
Values quoted and separated by commas, ready to put in a JQL query.
| Parameter | Type | Description |
|---|---|---|
values | any | A value or a list of values. |
Returns: string
Concat("project in (", JqlList(Parameters.projects), ")")
Your preferences
FormatUserDate(date: date) → string
The date in the date format chosen in your settings. Gives an empty text when there is no date.
| Parameter | Type | Description |
|---|---|---|
date | date | The date to show. |
Returns: string
FormatUserDate(Field.created)FormatUserDate(Today())
FormatUserDateTime(date: date) → string
The date and time in the formats chosen in your settings.
| Parameter | Type | Description |
|---|---|---|
date | date | The date and time to show. |
Returns: string
FormatUserDateTime(Field.updated)
FormatUserTime(date: date) → string
The time of day in the time format chosen in your settings.
| Parameter | Type | Description |
|---|---|---|
date | date | The date and time to take the time from. |
Returns: string
FormatUserTime(Field.started)
IsHoliday(date: date) → boolean
True when the date is not one of the working days chosen in your settings.
| Parameter | Type | Description |
|---|---|---|
date | date | The date to check. |
Returns: boolean
IsHoliday(Field.date)
WorkingDays(from: date, to: date) → number
Number of your working days from one date to another, both included. Gives 0 when from is after to.
| Parameter | Type | Description |
|---|---|---|
from | date | The first date. |
to | date | The last date. |
Returns: number
WorkingDays(Today(), Field.duedate)
Time tracking
Hours(seconds: number, decimals?: number) → number
Seconds, such as time spent or an estimate, as hours.
| Parameter | Type | Description |
|---|---|---|
seconds | number | The time in seconds. |
decimals | numberoptional | Number of digits after the decimal point, from 0 to 6. Default 2. |
Returns: number
Hours(5400)gives1.5Hours(Field.timeSpentSeconds, 1)
FormatDuration(seconds: number) → string
Seconds as hours and minutes.
| Parameter | Type | Description |
|---|---|---|
seconds | number | The time in seconds. |
Returns: string
FormatDuration(27000)gives7:30