| Warning |
|---|
Presented predefined variables are available for The Scheduler for Jira Server. If you are looking for variables for Jira Cloud visit this page: Predefined values in any issue fields |
The Scheduler has predefined variables which can be used in the Summary and Description. When Scheduled Issue is fired these variables are converted to the corresponding values:
| Variable | Meaning | Examples |
|---|---|---|
${fireCount} | Fire count | 5 |
${createdDate.month} | Creation month | February |
${createdDate.year} | Creation year | 2015 |
${dueDate.month} | Due month | February |
${dueDate.year} | Due year | 2015 |
${createdDate.date} | Creation date in format dd/MMM/YY | 10/Feb/15 |
${dueDate.date} | Due date in format dd/MMM/YY | 10/Feb/15 |
${createdDate.completeDateTime} | Creation date in format dd/MMM/YY hh:mm | 10/Feb/15 2:05 PM |
${dueDate.completeDateTime} | Due date in format dd/MMM/YY hh:mm | 10/Feb/15 2:05 PM |
${createdDate.format("dd-MM-YYYY HH:mm")} | Creation date in custom format | 10-02-2015 14:05 |
${dueDate.format("dd-MM-YYYY HH:mm")} | Due date in custom format | 10-02-2015 14:05 |
You can define your own date format using the last two variables - simply by replacing the dd-MM-YYYY HH:mm with the desired format. You can use following letters in date format:
| Symbol | Meaning | Presentation | Examples |
|---|---|---|---|
| G | Era designator | text | AD |
| C | Century of era (>=0) | number | 20 |
| Y | Year of era (>=0) | year | 2007 |
| y | Year | year | 2007 |
| x | Weekyear | year | 2007 |
| w | Week of weekyear | number | 27 |
| e | Day of week | number | 2 |
| E | Day of week | text | Tuesday; Tue |
| D | Day of year | number | 189 |
| M | Month of year | month | July; Jul; 07 |
| d | Day of month | number | 10 |
| a | Halfday of day | text | PM |
| K | Hour of halfday (0~11) | number | 0 |
| h | Clockhour of halfday (1~12) | number | 12 |
| H | Hour of day (0~23) | number | 0 |
| k | Clockhour of day (1~24) | number | 24 |
| m | Minute of hour | number | 30 |
| s | Second of minute | number | 55 |
| S | Milisecond | number | 978 |
| z | Time zone | text | Pacific Standard Time; PST |
| Z | Time zone offset/id | zone | -0800; -08:00; America/Los_Angeles |
Base usage example:
On the 2nd screen of the Scheduled Issue wizard, which is named "Set Issue Details" (1), there's a possibility to add above presented predefined variable, into the "Summary" and "Description" fields. In the below picture, I've presented a situation whee "fire count" (2) has been inserted into the "summary" and most of variables possible to enter I've placed in a table - it is possible to use it in "Visual" (6) mode. Left column contains variable meaning (3) and right (4) is a variable itself. In addition to that, the last row, marked in green contains customized own date format. After all was set, I've followed to the next screen by pressing "Next" (7) an saved newly created issue on the third, final screen.
%20-%202nd%20SI%20page%20wizard.png?version=1&modificationDate=1546614389775&cacheVersion=1&api=v2)
The built-in validator checks and makes impossible to create a scheduled issue with wrong variable input (after pressing next you receive an error in such case, pointing to what's incorrect).
After scheduled issue execution, I've received an expected outcome:
%20-%20outcome%20of%20variables%20after%20SI%20execution.png?version=1&modificationDate=1546615462232&cacheVersion=1&api=v2&width=1000)
All of the variables were successfully converted into desired values.
Predefined variables could be used in many ways, here is one of the complex usage examples allowing you to embed images (or link to some external resources), if you know the right pattern: Adding attachments to Scheduled Issues - workaround