View Source

JIRA is the issue tracking and project management system supplied by Atlassian. The JIRA Portlet macro allows you to display a JIRA dashboard portlet on a Confluence page.

To do this, you will need to include the URL of the portlet in the macro.

JIRA Portlet Macro

{jiraportlet:url=urlOfJIRAPortlet}

Screenshot: Example of a JIRA Portlet shown on a Confluence page

Confluence 2.9 > _Flagship Image for JIRA Portlet Macro > JIRAPortletMacroFlagshipImage.png

On this page:

Displaying a JIRA Portlet on your Confluence Page

Here's how you locate the URL of a JIRA portlet and put it into your JIRA Portlet macro:

Log in to your JIRA system.
Add the portlet you wish to include in Confluence to your JIRA dashboard. (Once you have copied the portlet's URL into Confluence, you can remove it from your JIRA dashboard.)
Click 'On' beside 'Configure' on your JIRA dashboard. (If you don't see this link, you need to click the 'Manage Portal' link, click the 'Configure' button and then return to the dashboard.)
Right-click the title located at the top-left corner of the portlet and copy its link location. See Screenshot 1.
Log in to your Confluence system.
Paste the link location into the {jiraportlet} macro on your Confluence page.

Screenshot 1: Copy link location

Confluence 2.9 > Space Attachments Directory > copy-link-to-clipboard.png

Parameters

Parameter	Required	Default	Description
url	yes	none	URL of the JIRA portlet, as described above.
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.
baseurl	no	none	If Confluence retrieves the JIRA portlet from some other URL than JIRA's public URL, you should supply JIRA's public URL in the baseurl parameter.

Example

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

{jiraportlet:anonymous=true|url=http://jira.atlassian.com/secure/RunPortlet.jspa?portletKey=com.atlassian.jira.plugin.system.portlets:projectstats&description=Stats:%20Confluence%20(Versions)&projectid=10470&statistictype=fixfor&template=/portlets/dashboard/projectstats.jsp}

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

Known Limitations when used with JIRA Calendar

If you are using the JIRA Portlet macro in combination with the JIRA Calendar, paging will work only if your Confluence and JIRA sites are running on the same host. Otherwise, you see error messages like Access to restricted URI.

Reason: the Calendar portlet communicates with JIRA via AJAX requests. Because of security concerns, browsers by default do not allow requests to any host different from the one the page was originally downloaded from.

There is a workaround. If you wish, you can turn off this security check in your browser. The exact way depends on your browser version, so Google for hints.
Please consider all implications of turning off this security check before you perform this action.

There is an existing request to develop support for proxying of the AJAX requests from Confluence to JIRA. If you need this feature, please vote for this issue: JCAL-64.