JIRA is the issue tracking and project management system supplied by Atlassian. The Jira Issues macro allows you to display a list of issues matching any JIRA filter within a page in Confluence.

Usage:

{jiraissues:url=jira_rss_url}

Description:

Display a list of JIRA issues on a Confluence page.

Input:

See parameters table below.

Output:

Nice looking list of issues on a Confluence page.

Bundled with Confluence?

(tick)

On this page:

Displaying a List of JIRA Issues on a Confluence Page

Stage 1 - Obtain Issue Filter URL

  1. Log in to your JIRA system.
  2. Visit the 'Find Issues' screen and create a new filter. Do not modify an existing filter.
  3. Set up your search parameters and use 'View' to check the issues returned.
  4. Once the filter is finished, visit the 'Filter View' tab, located above and to the left of the 'View' button.
  5. From the 'Filter View' tab, locate the 'Current View' links section (see example below) and find the 'XML' link.

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

Stage 2 - Embed 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: 
    {jiraissues:url=CONTENT}
  4. Replace 'CONTENT' with the JIRA search URL from your clipboard.
  5. Customise the macro output by adding optional parameters (see below) as required.
  6. Save the Confluence page.

Parameters

The following parameters can be embedded in the macro call:

Parameter

Required

Default

Description

url

yes

none

The URL of the XML view of your selected issues in Jira Issue Navigator.

anonymous

no

false

For Confluence 2.7.0 and later. 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.

columns

no

none

a semi-colon delimited list of jira column names. Valid columns are key, summary, type, created, updated, due, assignee, reporter, priority, status and resolution

count

no

false

true will output the number of issues in JIRA, linking the count to the JIRA instance

cache

no

on

'off' will refresh the jiraissues cache, forcing a reload on the page before the display

baseurl

no

 

the header link to the issue navigator will use this base url (used when Confluence connects to Jira with a different URL to normal users)

tempMax

no

20

limits the number of results you get back. This is the case even when count is set to true.

Example

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

{jiraissues:anonymous=true|url=http://jira.atlassian.com/secure/IssueNavigator.jspa?view=rss&pid=10470&fixfor=10650&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true|columns=type;key;summary}

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

Displaying Issues which have Restricted Viewing

For Confluence 2.7.0 and later, 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 this section if you want more detail.

This section explains how to handle JIRA issues that 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.

Specifying Username and Password in the JIRA URL (Not Recommended)

For Confluence 2.6.x and earlier, 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:

&os_username=MYNAME&os_password=MYPASSWORD

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

Using Confluence-to-JIRA Trusted Communication (Recommended)

For Confluence 2.7.0 and later, your administrator can set up trusted communication between Confluence and JIRA. The entire process is described in the Confluence Administrator's Guide.

Here is a relevant extract from the above page:

Troubleshooting

HTTPS

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.

JIRA 3.7 Link Format Change

And see also:

RELATED TOPICS

JIRA Portlet Macro
Working with Macros

In the Administrator's Guide:

Take me back to Confluence 2.7 User Guide