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 within a page in Confluence.

In other words, if you have your own JIRA site, your Confluence page can show a list of issues from your JIRA project. You can also show a list of issues from any JIRA site to which you and your readers have access.

Screenshot: Example of JIRA Issues shown on a Confluence page



On this page:

用途

The basic syntax is:

{jiraissues:url=<URL of your JIRA XML view>}

Displaying a List of JIRA Issues on a Confluence Page

Step 1 — Obtain the URL of the Issue Filter

  1. Log in to your JIRA system.
  2. Go to 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, go to 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.

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: 
    {jiraissues:url=CONTENT}
  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.

パラメーター

The JIRA Issues macro allows the following parameters:

パラメーター

必須

既定

説明

URL

はい

なし

The URL of the XML view of your selected issues in Jira Issue Navigator. (Note that if this URL contains the tempMax parameter, it will limit the number of results you get back. This is the case even when count is set to true. )

匿名

いいえ

false

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.

列

いいえ

既定では、次の列が表示されます。

  • type
  • 鍵 (キー)
  • 要約
  • 担当者
  • reporter
  • 優先度
  • ステータス
  • resolution
  • created
  • updated
  • due

A list of JIRA column names, separated by semi-colons (;). Example columns are: key, summary, type, created, updated, due, assignee, reporter, priority, status and resolution.

count

いいえ

false

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

キャッシュ

いいえ

オン

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

ベース URL

いいえ

'url' パラメーターの値

If you specify a 'baseurl', 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.

例

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/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?&query=jiraissues&summary=true&description=true&body=true&pid=10470&tempMax=10|columns=type;key;summary}

The example code contains three parameters:

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

Displaying Issues which have Restricted Viewing

You don't need to add any extra parameters — see below for more detail. Provided that your administrator has set up trusted communication, 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.

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.

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 ampersand (&) 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:

トラブルシューティング

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:

関連トピック

JIRA Portlet Macro
Working with Macros

In the Administrator's Guide:

Take me back to Confluence User Guide