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:
affectsversionoraffects_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 Field | Standard Variable Name | Type | Notes |
|---|---|---|---|
| Affects Version/s |
| Array<Version> | |
Assignee |
| User | |
| Comments | comments | Array<Comment> | |
| Components |
| Array<Component> | |
| Created |
| Number (Date/Time) | |
| Creator |
| User | |
| Description |
| Text | |
| Due Date |
| Number (Date) | |
| Environment |
| Text | |
| Epic Link |
| Issue | Can also use: epicLink |
Epic Stories |
| Array<Issue> | For epics, list issues belonging to the epic. For non-epics, undefined. Can also use: stories |
| Fix Version/s |
| Array<Version> | Can also use: versions |
| Key |
| Text | Can also use: issueKey |
| Issue ID |
| Number | |
| Issue Links |
| Array<Issue Link> | |
| Issue Type |
| Issue Type | |
| Labels |
| Array<Label> | Label items have no properties. Item's text representation is a label itself. |
| Original Estimate |
| Number (Duration) | |
| Parent Issue |
| Issue | |
Priority |
| Priority | |
| Project |
| Project | |
| Remaining Estimate |
| Number (Duration) | |
| Reporter |
| User | |
| Resolution |
| Resolution | |
| Resolved |
| Number (Date/Time) | Can also use: resolutionDate |
| Sprint |
| Sprint | |
| Sprint End Date |
| Number (Date/Time) | |
| Sprint Goal |
| Text | |
| Sprint Start Date |
| Number (Date/Time) | |
| Sub-Tasks |
| Array<Issue> | |
| Status |
| Status | |
| Status Category |
| Text | |
| Summary |
| Text | |
| Time Spent |
| Number (Duration) | |
| Updated |
| Number (Date/Time) | |
| Version Description |
| Text | |
| Version Start Date |
| Number (Date/Time) | |
| Version Release Date |
| Number (Date/Time) | |
| Votes |
| Number | |
| Watchers |
| Number | |
| Work Logs |
| Array<Work Log> |
Structure Attributes
The following variables are automatically mapped to Structure attributes.
| Variable Name | Type | Results |
|---|---|---|
| * | 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. |
itemid | Text | Returns the item type plus the item ID. Ex. "issue/10800" |
itemType | Text | Returns the item type: issue, project, user, folder, etc. |
| Number (Integer) | Returns the level of the item within the structure's hierarchy. Can also use: depth |
notes | Text | Returns the text entered into Notes column |
| Number (Boolean) | Returns a '1' if the issue is Done; otherwise, '0' |
| Number (Boolean) | Returns a '1' if the item can be edited; otherwise, '0' |
| 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) |