Child pages
  • JIRA Issues Macro

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

JIRA is the issue tracking and project management system supplied by Atlassian. The JIRA Issues macro allows you to display a list of issues from a JIRA site on a Confluence page.

This macro allows you to list publicly accessible issues from any JIRA site, as well as issues restricted to your user account on a JIRA site, assuming:

  • You are logged in to both the JIRA and Confluence sites, and
  • Your usernames on both of these sites match.

(tick) You can also create, find and insert JIRA issues directly within text on a Confluence page or blog post. For more information, refer to Inserting JIRA Issues.

Screenshot: Example of JIRA Issues shown on a Confluence page

On this page:

Table of Contents

Usage with the Macro Browser

To insert the JIRA issues macro into a page using the Macro Browser,

Excerpt Include
Navigating to the Macro Browser
Navigating to the Macro Browser

Once you've found the JIRA issues macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

To show a list of issues from any JIRA site to which you and your readers have access, the syntax is:

Code Block
{jiraissues:<URL of the XML view of a search conducted on any accessible JIRA site>}


Code Block
{jira:<URL of the XML view of a search conducted on any accessible JIRA site>}

Refer to the instructions below for details on obtaining this URL.


Displaying a List of JIRA Issues from any accessible JIRA site

Step 1 — Obtain the URL of the Issue Filter

  1. Log in to your JIRA system.
  2. Go to the 'Issues' screen and create a new filter. Do not modify an existing filter.
    (info) This is the 'Find Issues' screen in JIRA 3.13.x and earlier.
  3. Set up your search parameters and use 'View' to check the issues returned.
  4. Once the filter is finished, go to the Filter's 'View' tab/section in the top-left area of the JIRA interface.
  5. Copy the XML link. To do this, follow the appropriate steps below:
    • If you are using JIRA 4.0.x or later:
      • Click the 'Views' menu and use this menu to copy the XML link to your clipboard. For example, right-click the 'XML' menu item and choose the right-click menu option for copying that link.

    • If you are using JIRA 3.13.x or earlier:
      1. Locate the 'Current View' links section (see example below) and find the 'XML' link.

      2. Copy the 'XML' link to your clipboard.

Step 2 — Embed the Issue Filter URL onto your Confluence Page

  1. Log in to your Confluence system.
  2. Edit the page where you wish to display the list of JIRA issues.
  3. Type the following text into a new line at the appropriate location:
    Code Block
  4. Replace 'CONTENT' with the JIRA filter URL from your clipboard.
  5. Customise the macro output by adding optional parameters. See below.
  6. Save the Confluence page.



Excerpt Include

The JIRA Issues macro allows the following parameters:





Anonymous Retrieval



If this parameter is set to 'true', JIRA will return only the issues which allow unrestricted viewing i.e. the issues which are visible to anonymous viewers, as determined by JIRA's viewing restrictions. If this parameter is omitted or set to 'false', then the results depend on how your administrator has configured the communication between JIRA and Confluence. By default, Confluence will show only the JIRA issues which the user is authorised to view. See more details below.



The value of the 'url' parameter

If you specify a 'baseurl', then the link in the header, pointing to your JIRA site, will use this base URL instead of the value of the 'url' parameter. This is useful when Confluence connects to JIRA with a different URL from the one used by other users.

JIRA Field Columns to Display


By default, the following columns are shown:

  • type
  • key
  • summary
  • assignee
  • reporter
  • priority
  • status
  • resolution
  • created
  • updated
  • due

A list of JIRA column names, separated by semi-colons (;). Example columns are: key, summary, type, created, fixversion, updated, due, assignee, reporter, priority, status and resolution. You can include any columns recognised by your JIRA site, including custom columns. See the JIRA documentation for a list of names.

Display Total Numbers Only



If this parameter is set to 'true', the issue list will show the number of issues in JIRA. The count will be linked to your JIRA site.




The macro maintains a cache of the issues which result from the JIRA query. If the 'cache' parameter is set to 'off', the relevant part of the cache is cleared each time the macro is reloaded. (The value 'false' also works and has the same effect as 'off'.)

Height (Pixel Value Only)



The height in pixels of the table displaying the JIRA issues.
Note that this height specification is ignored in the following situations:

  • If you set the 'renderMode' parameter (see below) to 'static'.
  • When the JIRA issues are displayed in a PDF or Word document, in an email message or in an RSS feed.



In formats not mentioned below, the default is 'dynamic'.
The default is 'static' when the JIRA issues are displayed in a PDF or Word document, in an email message or in an RSS feed.

By default, the JIRA Issues macro offers a dynamic display with the following features:

  • Click the column headers to sort the output.
  • Drag and drop the columns into a different order.
  • Temporarily remove a column from the display.
  • View a page of issues at a time, for faster response times.
    Set the 'renderMode' parameter to 'static' if you want to disable the dynamic display features.



JIRA Issues

You can customise the title text at the top of the JIRA issues table with this parameter. For instance, setting the title to 'Bugs-to-fix' will replace the default 'JIRA Issues' text. This can help provide more context to the list of issues displayed.




The URL of the XML view of your selected issues in JIRA Issue Navigator.
Note: If the URL in the 'url' parameter does not contain a tempMax argument, then the value of tempMax will default to 500. If your JIRA server is version 3.12 or earlier, this means that the JIRA Issues macro will return a maximum of 500 issues. If your JIRA server is version 3.13 or later, a value of 500 means that the JIRA Issues macro will return a maximum of 500 issues per page.




The width of the table displaying the JIRA issues. Can be indicated either as a percentage (%) or in pixels (px).

Issues Displayed a Page at a Time

If you are using JIRA 3.13 or later, the JIRA Issues macro will retrieve and show a 'page' of issues at a time. The buttons underneath the table allow you to move to the next or previous page, or to the start or end of the list. The number of issues retrieved per page is determined by the url parameter — see the description of the macro parameters above.

If your version of JIRA is 3.12 or earlier, the JIRA Issues macro will retrieve all the issues at once and display them as a single 'page'.



Below is an example of some macro markup code, requesting a list of issues from the Atlassian public JIRA site:



The example code contains three parameters (see above parameter table for their meanings):

  • anonymous=true
  • url=<a long URL derived from the XML view of a JIRA filter>
  • columns=type;key;summary

Below are the results of the above macro markup, displayed on this Confluence page:


Displaying Issues which have Restricted Viewing

Maybe your JIRA instance is not visible to anonymous visitors — everyone has to log in before they can see JIRA issues. Or maybe some of the JIRA issues are restricted to viewing by certain users only. This section explains how to handle JIRA issues that have restricted viewing.

Using Confluence-to-JIRA Trusted Communication (Recommended)

For Confluence 2.7.0 and later and JIRA 3.12 and later, your administrator can set up trusted communication between Confluence and JIRA. The entire process is described in the Confluence Administrator's Guide. Provided that your administrator has set up trusted communication, you don't need to add any extra parameters. Confluence and JIRA will work out the security between them, ensuring that the user will see only the issues they are authorised to see. Read the section below if you want more detail.

Excerpt Include
Setting Up Trusted Communication between JIRA and Confluence
Setting Up Trusted Communication between JIRA and Confluence
Specifying Username and Password in the JIRA URL (Not Recommended)

If you have not set up trusted communication between JIRA and Confluence and if your JIRA issues have restricted viewing (i.e. JIRA requires a login before allowing access to the issues), then you need to type a JIRA username and password into the macro markup code and save it onto the Confluence page.

Append the following parameters to the end of the search URL:

Code Block

where MYNAME is a JIRA username and MYPASSWORD is the corresponding password for that username. This username and password should not include an ampersand (&) symbol.



The JIRA Issues macro can access a JIRA instance running under SSL as long as the Confluence server is set to accept the JIRA SSL certificate. Refer to the Confluence Knowledge Base article for more information about problems connecting to SSL services.

And see also:


Inserting JIRA Issues
JIRA Portlet Macro
Working with Macros

In the Administrator's Guide:

Take me back to the Wikis Help Guide.