JIRA Issue Fields
Reference
The fields parameter of the jira Macro lists the issue fields to display, in display order, separated by commas. Each entry has the form id:label!type, in which only the id is mandatory.
| Part | Mandatory | Description |
|---|---|---|
| id | Yes | The field to display. Use one of the standard ids below, or the display name of a custom JIRA field. The special id note displays the text written after an issue key in the Macro content when the list source is used. |
| label | No | The column header used by the table style. Wrap it in single quotes when it contains spaces. This is the replacement for the deprecated fieldNames parameter, and it is also the way to translate a header. |
| type | No | The type deciding how the value is rendered, for fields that have no rendering of their own. Wrap the id in single quotes and prefix the type with an exclamation mark, as in 'Custom Link'!url. |
Standard Fields
| Id | Label | Type |
|---|---|---|
| summary | Summary | text |
| key | Key | text |
| type | Type | text |
| status | Status | text |
| assignee | Assignee | text |
| reporter | Reporter | text |
| created | Created Date | date |
| updated | Updated Date | date |
| resolved | Resolved Date | date |
| fixVersion | Fixed in | text |
| version | Affected Versions | text |
| component | Component | text |
| votes | Votes | number |
| resolution | Resolution | text |
| link | Link | url |
| labels | Labels | list |
Any other field JIRA exposes can be displayed by using its display name as the id, which is how custom JIRA fields are reached. The complete list of fields available in a given instance is the one JIRA itself documents for JQL.
Default Fields per Style
When fields is left out, each style displays its own default set, in this order:
| Style | Fields |
|---|---|
| table | type, key, summary, status, created |
| list | status, key, summary |
| enum | status, key |
Field Types
A field is rendered by the renderer registered for its id. Seven standard fields have one: created, key, labels, resolved, status, type and updated. For every other field the renderer registered for the field type is used, and when the type has none either, the value is displayed exactly as JIRA returned it.
| Type | Rendering |
|---|---|
| text | The value as JIRA returned it. |
| date | The value rendered as a date. |
| url | A link pointing at the value. The link label defaults to the value itself and can be changed with the field.url.label entry of the parameters Macro parameter. |
| html | The value treated as HTML and injected as such. |
| number | The value as JIRA returned it. There is no dedicated renderer for this type. |
| list | The value as JIRA returned it, except for labels, which has its own renderer. |
Only date, html and url have a type renderer, so those are the three types worth setting explicitly on a field.
FAQ
How do I display a custom JIRA field?
Use its display name as the id, quoting it when it contains spaces, as in fields="key,'Flickering Test'".
Why is my custom field displayed as raw text or raw HTML markup?
Because no renderer matches it. Give it an explicit type, as in 'Custom Link'!url or 'Release Notes'!html.
Why does the note field display nothing?
Notes exist only with the list source, where they are written after the issue key and separated from it by a pipe character; with the jql source there is no note to display.
