Automation Toolbox for JiraĀ provides a set of special fields called Virtual Fields, making the most interesting 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.
Writable virtual fields
When a value is written into these fields, a feature or system field of the issue the field belongs to will be modified. These fields are also readable.
| Field Name | Field code | Effect of Writing | Allowed String Values | Allowed Numeric Values | Examples |
|---|---|---|---|---|---|
| Summary | summary | Sets issue Summary | text string trimmed to 255 characters | numbers are cast to string | - |
| Description | description | Sets issue Description | unlimited text string | numbers are cast to string | - |
| Assignee | assignee | Assigns the issue to a user | user name (not user's full name) | n/a | - |
| Reporter | reporter | Updates issue Reporter to a different user | user name (not user's full name) | n/a | - |
| Due date | dueDate | Sets issue's system field Due Date | date-time in format defined at jira.date.time.picker.java.format, or as in JQL (yyyy/MM/dd HH:mm, yyyy-MM-dd HH:mm, yyyy/MM/dd, yyyy-MM-dd, or relative to current time using "w" (weeks), "d" (days), "h" (hours) or "m" (minutes) | number of minutes relative to current time. | 2014-03-25 : date example2015-01-31 14:35 : date with time example- 4d 1h : 4 days and 1 hour before current time.2w, 3d, 4h, 5m : 2 weeks, 3 days, 4 hours and 5 minutes after current time. |
| Priority | priority | Updates the issue Priority | name of a Priority (e.g., Blocker, Critical, Major,...) | (0 = highest priority, 1 = second highest,... n = lowest | |
| Original estimate (minutes) | originalEstimate | Sets original estimate | cast from string to number will be attempted | number of minutes | 30 : sets Original estimate to 30 minutes.Original estimate (minutes) can be increased or decreased using expression parserĀ with formulas like: {00024} + 60 for increasing remaining estimate in 1 hour, or {00024} - {10000} for decreasing remaining estimate by the amount of minutes stored in custom field with code {10000}. |
| Remaining estimate (minutes) | estimate | Sets remaining estimate | cast from string to number will be attempted | number of minutes | 30 : sets Remaining estimate to 30 minutes.Remaining estimate (minutes) can be increased or decreased using expression parser with formulas like: {00024} + 60 for increasing remaining estimate in 1 hour, or {00024} - {10000} for decreasing remaining estimate by the amount of minutes stored in custom field with code {10000}. |
| Total time spent (minutes) | timeSpent | Sets time spent.+ | cast from string to number will be attempted | number of minutes | 30 : sets Time spent to 30 minutes.Total time spent (minutes) can be increased or decreased using expression parserĀ with formulas like: {00024} + 60 for increasing remaining estimate in 1 hour, or {00024} - {10000} for decreasing remaining estimate by the a mount of minutes stored in custom field with code {10000}. |
| Add to time spent (minutes) | addTimeSpent | Adds a number of minutes to current value of field "Total time spent (minutes)" | cast from string to number will be attempted | number of minutes | 60 : increases time spent in 1 hour. |
| Components | component | Sets issue Components | Comma separated list of component names. Prefixes + and - can be used to add or remove (check or uncheck) single values or set of values. | n/a | + Web Site, User Management : adds the components Web Site and User Management to current issue, provided they exist in the project.- Library A, Component B : removes the components Library A and Component B from current issue, provided they exist in the project. |
| Fixed versions | fixVersion | Sets Fixed versions | Comma separated list of version names. Prefixes + and - can be used to add or remove (check or uncheck) single values or set of values. | numbers are cast to string | + 1.0, 1.1 : adds versions 1.0 and 1.1 to field Fixed versions.- 2.0, 2.2 : removes versions 2.0 and 2.2 from field Fixed versions. |
| Affected versions | version | Sets Affected versions | Comma separated list of version names. Prefixes + and - can be used to add or remove (check or uncheck) single values or set of values. | numbers are cast to string | + 1.0, 1.1 : adds versions 1.0 and 1.1 to field Affected versions.- 2.0, 2.2 : removes versions 2.0 and 2.2 from field Affected versions. |
| Environment | environment | Sets issue Environment | unlimited text string | numbers are cast to string | - |
| Issue status | status | Will make the issue progress through the workflow to the written status, provided there is transition in the workflow from current status to the written status. It requires that all conditions and validations in the transition are satisfied. | name of a Status (e.g., Open, In Progress, Resolved,...) | n/a | Resolved : will search for a transition from current issue's status to Resolved status. If conditions are satisfied, it will try to execute the transition. Then if validators are satisfied in that transition are satisfied, it will be executed, resulting in moving issue to Resolved status. Every post-function in the executed transition is also executed. |
| Resolution | resolution | Sets issue Resolution | name of issue Resolution (e.g., Fixed, Won't Fix, Duplicate, Incomplete,...) | n/a | - |
| Labels | labels | Sets Labels | Comma separated list of labels. If label doesn't exist it is created. Prefixes + and - can be used to add or remove (check or uncheck) single values or set of values. | numbers are cast to string | + jira, plugin : adds labels "jira" and "plugin" to the issue.- scrum, web : removes labels "scrum" and "web" from the issue. |
| Attachments (only new attachments will be added) | attachmentsAdd | Adds new attachments coming from another issue keeping current attachments. Rejects duplicated attachments. | Comma or blank separated list of issue keys whose attachments will be copied to current issue. | n/a | CMR-1 : adds to current issue the attachments in issue CRM-1 except if attachments are already in current issue.CRM-2, HR-34, HR-50 : adds to current issue the attachments in issues CRM-2, HR-34 and HR-50 except if attachments are already in current issue. |
| Attachments with details | attachment.details | Text string | Comma separated list of file names with its mime types and sizes in Kbytes, for every file attached to the issue. | file1.txt (text/plain, 5.14 KB), readme.pdf (application/pdf, 179.8 KB), screenshot.png (image/png, 5.449 KB) | |
| Security level | securityLevel | Sets issue Security Level | name of a Security Level | n/a | Public : sets security level to Public, provided this security level exists in the Security Scheme of the project.Reserved : sets security level to Reserved, provided this security level exists in the Security Scheme of the project. |
| Last comment | lastComment | Updates the last comment added to the issue if it exists | unlimited text string Optionally parameter visibility can be added for setting comment visibility. To do it add : {visibility=visibility_value} at the end of the text. This parameter permits same values as "Last comment's visibility restriction". | numbers are cast to string | WARNING: When writing into this field, please add your writer post-function AFTER "Add a comment to an issue if one is entered during a transition." post-function, since otherwise updated comment will be the one before last, instead of the last one. |
| Last comment's visibility restriction | lastComment.visibility | Updates the visibility of the last comment in the issue if it exists. Can be used to set the visibility of a comment introduced with virtual field New comment | name of a Project Role or name of a Group. In Jira Service Desk it also admits values public and internal (without doble quotes), or alternatively jsd_public and jsd_internal to avoid name collision with existing project roles and user groups. | n/a | Developers : for setting visibility to project role or group with name Developers.jsd_internal : for setting JSD internal visibility.jira-developers : for setting visibility to "jira-developers" user group. |
| Watchers | watcher | Sets watchers of an issue. Can be used to add or remove watchers to linked issues, sub-tasks or issues returned by JQL, but requires to use operator '+' and '-'. Also can be used to copy watchers between issues. | comma separated list of user names, group names or project roles names. Prefixes + and - can be used to add or remove single users or set of users. | n/a | albert, richard, john : sets 3 users as watchers replacing current ones.+ Developers, Administrators : adds every user in project roles or groups Developers and Administrators to current watchers.- Testers, Administrators, + albert, richard : removes users in project roles or groups Testers and Administrators and adds users albert and richard as watchers. |
Values returned when reading virtual fields
| Field name | Field Code | Type | Value returned when cast to string | Examples |
|---|---|---|---|---|
| Summary | summary | Text string | Issue summary. | - |
| Description | description | Text string | Issue description. | - |
| Assignee | assignee | User | The name of the user who has the issue assigned. | albert.einstein |
| Assignee's full name | assignee.fullName | Text string | Name and surname of the user who currently has the issue assigned | Albert Einstein |
| Assignee's email | assignee.email | Text string | Email address of the user who currently has the issue assigned | albert.einstein@yahoo.com |
| Reporter | reporter | User | The name of the user who reported the issue. This field is editable, while Creator field isn't. | albert.einstein |
| Reporter's full name | reporter.fullName | Text string | Name and surname of the user who created the issue | Albert Einstein |
| Reporter's email | reporter.email | Text string | Email address of the user who created the issue | albert.einstein@yahoo.com |
| Creator | creator | User | User name of the user who actually creates the issue in JIRA. This field, unlike Reporter, can't be edited. | richard.feynman |
| Creator's full name | creator.fullName | Text string | Name and surname of the user who actually created the issue in JIRA | Richard Feynman |
| Creator's email | creator.email | Text string | Email address of the user who actually created the issue in JIRA | richard.feynman@gmail.com |
| Current user | currentUser | User | Name of the user who is executing the transition. | isaac.newton |
| Current user's full name | currentUserFullName | Text string | Name and surname of the user who is executing the transition. | Isaac Newton |
| Current user's email | currentUserEmail | Text string | Email address of the user who leads the project the issue belongs to. | albert.einstein@yahoo.com, isaac.newton@gmail.com |
| Current date and time | currentDateTime | Date and Time | Current date and time of JIRA server's clock. When cast to string format defined at jira.date.time.picker.java.format is used. | 19/Mar/14 1:38 PM for jira.date.time.picker.java.format = dd/MMM/yy h:mm a |
| Date and time of creation | created | Date and time | Date and time when issue has been created. When cast to string format defined at jira.date.time.picker.java.format is used. | 19/Mar/14 1:38 PM for jira.date.time.picker.java.format = dd/MMM/yy h:mm a |
| Date and time of last update | updated | Date and time | Date and time of the most recent issue update. When cast to string format defined at jira.date.time.picker.java.format is used. | 19/Mar/14 1:38 PM for jira.date.time.picker.java.format = dd/MMM/yy h:mm a |
| Date and time of latest status change | lastStatusChange | Date and time | Date and time of the most recent status change in the issue. When cast to string format defined at jira.date.time.picker.java.format is used. | 19/Mar/14 1:38 PM for jira.date.time.picker.java.format = dd/MMM/yy h:mm aUseful to find out for how much time is the issue in current status using expression: {00057} - {000158}, where {00057} = Current date and time and {000158} is Date and time of latest status change. |
| Due date | dueDate | Date | Field that can store a date with no time part, and is used to schedule issues. When cast to string format defined at jira.date.time.picker.java.format is used. | 19/Mar/14 for jira.date.time.picker.java.format = dd/MMM/yy h:mm a, since this field doesn't store time part. |
| Date and time of resolution | resolutionDate | Date and time | Date and time of the most recent update of field Resolution. When cast to string format defined at jira.date.time.picker.java.format is used. | 19/Mar/14 1:38 PM for jira.date.time.picker.java.format = dd/MMM/yy h:mm a |
| Priority | priority | Priority | Name of the priority in Default language configured in the JIRA instance | Blocker Critical Major |
| Original estimate (minutes) | originalEstimate | Number | Time originally estimated for the issue expressed in minutes. It's a real number, so it may have a non-zero fractional part. | - |
| Remaining estimate (minutes) | estimate | Number | Remaining time estimated for the issue expressed in minutes. It's a real number, so it may have a non-zero fractional part. | - |
| Total time spent (minutes) | timeSpent | Number | Work time currently spent at the issue expressed in minutes. It's a real number, so it may have a non-zero fractional part. | - |
| Work logged in transition (minutes) | transition.worklog | Number | Number of minutes logged in current transition screen. | This field can be used to enforce logging some time in transition screen. |
| Components | component | Components | Comma separated list of component names | Web Site, Authenticator, Statistics |
| Components leaders | component.leads | Multi user | Comma separated list of user names | albert.einstein@yahoo.com, richard.feynman@gmail.com |
| Fixed versions | fixVersion | Versions | Comma separated list of fixed versions | 1.0, 2.0, 2.1 |
| Fixed versions with details | fixVersion.details | Text string | A text with a line for each fixed versions. Each line contains the following information separated by characters '#': name of version, description, release date and archive situation | 1.0 # First release # RELEASED ON 28/Mar/14 12:00 AM # ARCHIVED |
| Number of fixed versions | fixVersion.count | Number | Number of fixed versions in current issue. | - |
| Affected versions | version | Versions | Comma separated list of fixed versions | 1.0, 2.0, 2.1 |
| Affected versions with details | version.details | Text string | A text with a line for each affected versions. Each line contains the following information separated by characters '#': name of version, description, release date and archive situation | 1.0 # First release # RELEASED ON 28/Mar/14 12:00 AM # ARCHIVED |
| Number of affected versions | version.count | Number | Number of affected versions in current issue. | - |
| Number of votes received | votes | Number | Number of votes received by the issue. | - |
| Keys of subtasks | subtasks | Text string | Comma separated list of issue keys. | CRM-23, CRM-26, CRM-31 |
| Number of subtasks | subtasks.count | Number | Number of subtasks of current issue. | - |
| Keys of linked issues | linkedIssues | Text string | Comma separated list of issue keys. | CRM-13, HR-12, SDESK-45 |
| Number of linked issues | linkedIssues.count | Number | Number of issues linked to current issue. | - |
| Environment | environment | String | Field to describe the environment where the issue has occurred. | - |
| Attachments | attachment | Attachments | Comma separated list of file names of all files attached to the issue. | file1.txt, readme.pdf, screenshot.png |
| Number of attachments | attachment.count | Number | Number of files attached to current issue. | - |
| Labels | labels | Labels | Blank separated list with all the labels of the issue. | web customer java mobile |
| Number of labels | labels.count | Number | Number of labels in current issue. | - |
| Issue key | key | Text string | Issue key | CRM-25 HR-52 SDESK-1 |
| Issue type | issueType | Issue type | Name of issue's Issue Type in Jira's default language | Bug Improvement New Feature Task |
| Issue status | status | Issue status | Name of current status of the issue in Jira's default language. | Open In Progress Resolved |
| Issue status category | statusCategory | Status category | Name of the category in Jira's default language. | To Do In Progress Done |
| Previous issue status | status.previous | Issue status | Name of the status the issue was just before current one. The name is shown in Jira's default language. | Open In Progress Closed |
| Previous issue status category | statusCategory.previous | Status category | Name of the category of the status the issue was just before current one. The name is shown in Jira's default language. | To Do In Progress Done |
| Available transitions | transitions.achievable | Text string | A comma separated list with the names of transitions with origin in current issue status. | If current issue is in Open status of classic Jira workflow, then field Available transitions will return: Start Progress, Resolve Issue, Close Issue |
| Available target statuses | status.achievable | Text string | A comma separated list with the names of target status of those transitions with origin in current issue status. | If current issue is in Open status of classic Jira workflow, then field Available target statuses will return: In Progress, Resolved, Closed |
| Resolution | resolution | Resolution | The name of the resolution currently set at the issue, or empty string if Resolution is not set. The name of the resolution is shown in Jira's default language. | Resolved Won't fix Cancelled |
| Security level | securityLevel | Security level | Name of the security level the issue currently has. | Classified |
| Last comment | lastComment | Text string | Last comment entered in the issue. | - |
| Last comment's visibility restriction | lastComment.visibility | Text string | Name of a group or project role the visibility of the last comment entered in the issue is restricted to. If no restriction is applied to the comment, this field is returns an empty string. For Service Desk's special Internal visibility restriction, string | - |
| Last commenter (since version 2.1.33) | lastComment.author | User | Name of the user who entered the last comment in the issue. | galileo.galilei |
| Transition's comment | transition.comment | Text string | Comment entered in transition screen. This field can be used to make comment mandatory in transition screen, or to validate the content of comment entered in a transition. | - |
| Watchers | watcher | Multi-user | Comma separated list of user names of current watchers of the issue. | albert.einstein, richard.feynman, galileo.galilei |
| Project key | project.key | Text string | Project Key of the project the issue belongs to. | CRM, HR, SDESK |
| Project name | project.name | Text string | Name of the project the issue belongs to. | Customer Relationship Management |
| Project description | project.description | Text string | Field Description of the project the issue belongs to. | - |
| Project URL | project.url | Text string | Field URL of the project belongs to. | https://www.decadis.de |
| Project category | project.category | Text string | Name of the Category of the project the issue belongs to. | - |
| Project leader | project.lead | User | Name of the user who leads the project the issue belongs to. | galileo.galilei |
| Project leader's full name | project.leadFullName | Text string | Name and surname of the user who leads the project the issue belongs to. | Galileo Galilei |
| Project leader's email | project.leadEmail | Text string | Email address of the user who leads the project the issue belongs to. | galileo.galilei@me.com |
| Rest of issues in the project | remainingIssuesInProject | Text string | Comma separated list of issue keys in the project except current issue's key. | CRM-1, CRM-2, CRM-3, CRM-4 |
| Workflow scheme | workflowScheme | Text string | The name of the workflow scheme of the project current issue belongs to. | - |
| JIRA base URL | baseUrl | Text string | Returns the base URL of current JIRA instance. | - |
| Sprint ID | sprintId | Text string | The internal ID for the sprint of current issue. This value can be used for setting field Sprint in other issues. | - |
| Sprint Start Date | sprintStartDate | Date | Sprint's start date. | - |
| Sprint End Date | sprintEndDate | Date | Sprint's end date. | - |
For every virtual and custom field in a sub-task, there is also another virtual field representing the same field in its parent issue, making it very easy to read and write parent's issue fields.
