JIRA Issues Macro

The Jira Issues Macro allows you to display JIRA issues matching any JIRA filter within a page in Confluence.

Usage:	{jiraissues:url=jira_rss_url\|columns=columns}
Description:	Display a list of JIRA issues in a page.
Input:	See parameters table below.
Output:	Nice looking list of issues in a Confluence page.
Bundled with Confluence?

Embedding JIRA Issue Filter Results into a Confluence Page

Stage 1 - Obtain Issue Filter URL

Visit your JIRA instance and log in if required.
Visit the 'Find Issues' screen and create a 'New' filter. Do not modify an existing filter.
Setup your search parameters and use 'View' to check the issues returned.
Once the filter is finished, visit the 'Filter View' tab, located above and to the left of the 'View' button.
From the 'Filter View' tab, locate the 'Current View' links section displayed below and find the 'XML' link.
Copy the 'XML' link to your clipboard.

Stage 2 - Embed Issue Filter URL

Visit your Confluence instance and log in if required.
Edit the page you wish to embed the issues into.
Switch to the Wiki Markup editor.
Copy the following text into the a new line at the appropriate location:
```
{jiraissues:url=CONTENT}
```
Replace CONTENT with the search URL from your clipboard.
If you need to log in to JIRA to view the search results, 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 their password. This user should not have an & symbol in their username or password.
Customise the macro by adding optional parameters (see below) as required.
Save the updated macro to 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.
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

This macro call requests a filter results from the Atlassian public JIRA instance:

{jiraissues: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}

The filter results are embedded in the page as:

type	key	summary
Unable to locate Jira server for this macro. It may be due to Application Link configuration.

Setup Notes

1. 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.

2. JIRA 3.7 Link Format Change

As a result of RSS feed improvements, the (outdated) JIRA Issues Macro differs between JIRA 3.6 and 3.7.

This is not an issue for users running the latest versions of Confluence and JIRA. However, users using Confluence versions older than 2.2.10 to access JIRA 3.7 must upgrade Confluence or patch the JIRA issues macro to handle the 3.7 format.

Confluence	JIRA	Action Required
2.2.10, 2.3	Any version	None
Older than 2.2.10	3.7	Stop Confluence, open your Confluence install directory and remove the file `\WEB-INF\lib\jira3.jar`. Download the JIRA 3.7 version and rename it to `jira3.jar`
Older than 2.2.10	Older than 3.7	None

Troubleshooting

See the JIRA Issues Macro FAQ.

Page tree

Embedding JIRA Issue Filter Results into a Confluence Page

Parameters

Example

Setup Notes

Troubleshooting

RELATED TOPICS