JIRA Chart Macro

JIRA is Atlassian's issue tracking and project management system. By adding the JIRA Chart macro to a Confluence page, you can display information about JIRA issues and projects as pie charts.

Before you can use this macro, your Confluence and JIRA sites must be connected via Application Links. People viewing the page will see charts for publicly accessible issues from the JIRA site. If your JIRA site has restricted viewing (that is, people need permission to view issues) then they will need to authenticate before seeing the charts. This macro is compatible with JIRA 5.x and later.

Adding the JIRA Chart macro to a page

Quick guide to using the macro on a Confluence page:

In the Confluence editor, choose Insert > Other Macros.
Find and select the required macro.

Speeding up macro entry with autocomplete:

Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

Using the JIRA Chart Macro

To add a JIRA chart to your page:

Insert the JIRA Chart macro (see above).
Select your JIRA server.
If you have multiple JIRA instances linked to Confluence the drop down will default to the primary application link.
Search for issues - you can enter the query in JQL or paste a JIRA URL directly into the search field.
Choose Preview to see the chart.
Choose Insert.

To find out more about searching for issues see Displaying issues via a JIRA Query Language (JQL) search.

You can further control how the chart appears on your page. Choose Display options:

Chart by - select the JIRA field you want to segment the pie chart by.
Width - define the total width of the chart area. You can enter values in pixels or percent. Leave blank to auto fit.
Show border - add a border around the chart area
Show chart information - include a text summary under the chart with the total issues count and chart by value.

Screenshot: The JIRA Chart Macro in the macro browser

Disabling the JIRA Chart macro

The functionality is provided by an add-on (plugin) called 'JIRA Macros'. This macro is also used for the JIRA Issues macro. To make the macro unavailable on your site, you can disable the add-on. See Disabling and enabling apps.

Notes

HTTPS: The JIRA Chart macro can access a JIRA site running under SSL provided the Confluence server is configured to accept the JIRA SSL certificate. See Connecting to LDAP or JIRA or Other Services via SSL.

Authentication: If the query includes issues that require authentication (issues that are not visible to anonymous users in JIRA), users will be prompted to authenticate to view charts on the Confluence page.

In order to search for issues in the macro browser you may need to authenticate. With JIRA 5.x you will be able to search for unrestricted issues as an anonymous user, however with JIRA 6.x you must be authenticated to search for any issues.

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.

Macro name: jirachart

Macro body: None.

The following parameters are available in storage format.

Parameter name	Required	Default	Parameter description and accepted values
`chartType`	Yes	Pie	Type of chart to display. Currently Pie is the only available chart type. Other types may be added in future.
`statType`	Yes	Statuses	The JIRA field to segment the pie chart by: `statuses` - displays a breakdown of issues by Status. `allFixfor` - displays a breakdown of issues by chart by all Fix Versions (useful if issues have more than one fix version). `assignees` - displays a breakdown of issues by the Assignee name. `priorities` - displays a breakdown of issues by Priority. `components` - displays a breakdown of issues by Component. `issuetype` displays a breakdown of issues by Issue Type.
`showinfor`	No	False	Displays text information about the data below the chart. Includes the Total value and the Chart By value.
`jql`	Yes		JQL query for the chart to display.
`width`	600	(blank)	This is the total width of the chart area. Width can be entered in pixels, percent or left blank to fit to the available space.
`border`	No	False	Displays a border around the chart area.

Storage format example

Example chart by Issue Type - note that Confluence will insert the server and serverId parameters, based on settings in Application Links:

<ac:structured-macro ac:name="jirachart">
  <ac:parameter ac:name="chartType">pie</ac:parameter>
  <ac:parameter ac:name="statType">issuetype</ac:parameter>
  <ac:parameter ac:name="showinfor">true</ac:parameter>
  <ac:parameter ac:name="jql">project%20%3D%20CONF%20and%20fixVersion%20in%20('5.3')</ac:parameter>
  <ac:parameter ac:name="width">600</ac:parameter>
  <ac:parameter ac:name="server">JAC</ac:parameter>
  <ac:parameter ac:name="serverId">144880e9-a353-312f-9412-ed028e8166fa</ac:parameter>
  <ac:parameter ac:name="border">true</ac:parameter>
</ac:structured-macro>

Page tree