Document toolboxDocument toolbox

This article is for Data Center. Visit Cloud

Standard Variable Reference


As you write your formula, Structure attempts to map your variables to well-known attributes:

  • Variables with the same name as an attribute are mapped to those attributes. For multi-word attributes, you can write the words without spaces, or place a _ between each word: affectsversion or affects_version
  • Many commonly-used variations of attribute names are mapped to the corresponding attribute.
  • In addition to Jira fields, some variable names are automatically mapped to common Structure attributes. See Structure Attributes.

When naming variables:

  • Do not include spaces. Omit spaces or use an underscore.
  • Case is ignored (AffectsVersion is the same as affectsversion)

Jira Fields

The following list contains the most commonly-used variables that are automatically be linked to a Jira field. This is not a complete list.

Jira FieldStandard Variable NameTypeNotes
Affects Version/s

affectsVersions

Array<Version>


Assignee

assignee

User
CommentscommentsArray<Comment>
Components

components

Array<Component>
Created

created

Number (Date/Time)
Creator

creator

User
Description

description

Text
Due Date

dueDate

Number (Date)
Environment

environment

Text
Epic Link

epic

IssueCan also use: epicLink

Epic Stories

epicStories

Array<Issue>

For epics, list issues belonging to the epic.

For non-epics, undefined.

Can also use: stories

Fix Version/s

fixVersions

Array<Version>Can also use: versions
Key

key

TextCan also use: issueKey
Issue ID

issueid

Number
Issue Links

issueLinks

Array<Issue Link>
Issue Type

issueType

Issue Type
Labels

labels

Array<Label>Label items have no properties. Item's text representation is a label itself.
Original Estimate

originalEstimate

Number (Duration)
Parent Issue

parentTask

Issue

Priority

priority

Priority
Project

project

Project
Remaining Estimate

remainingEstimate

Number (Duration)
Reporter

reporter

User
Resolution

resolution

Resolution
Resolved

resolved

Number (Date/Time)Can also use: resolutionDate
Sprint

sprint

Sprint
Sprint End Date

sprint_end_date

Number (Date/Time)
Sprint Goal

sprint_goal

Text
Sprint Start Date

sprint_start_date

Number (Date/Time)
Sub-Tasks

subtasks

Array<Issue>
Status

status

Status
Status Category

statusCategory

Text
Summary

summary

Text
Time Spent

timeSpent

Number (Duration)
Updated

updated

Number (Date/Time)
Version Description

version_description

Text
Version Start Date

version_start_date

Number (Date/Time)
Version Release Date

version_release_date

Number (Date/Time)
Votes

votes

Number
Watchers

watchers

Number
Work Logs

workLogs

Array<Work Log>

Structure Attributes

The following variables are automatically mapped to Structure attributes.

Variable NameTypeResults

item

this

*

Returns the value of type "Item" representing the item for which the formula is calculated.

If the formula is calculated for an issue, it will be of type Issue.

If, for example, you group issues by Sprint, you will have rows in the structure representing sprints. For those rows, the "item" variable will return items of type Sprint.

itemidTextReturns the item type plus the item ID. Ex. "issue/10800"
itemTypeTextReturns the item type: issue, project, user, folder, etc.

level

Number (Integer)Returns the level of the item within the structure's hierarchy. Can also use: depth
notesTextReturns the text entered into Notes column

done

Number (Boolean)Returns a '1' if the issue is Done; otherwise, '0'

editable

Number (Boolean)Returns a '1' if the item can be edited; otherwise, '0'

sum_

total_

Number

Either prefix, attached to a well-known variable name afterwards, such as Sum_Story_Points or Total_Estimate,

are converted to a Sum attribute of the given value (without the duplicate removal option)