Report Jira information in Confluence
10 min
By the end of this lesson, you’ll be able to:
- Use the Jira charts macro to visualize Jira data on a Confluence page
- Utilize the Jira Timeline macro to visualize and display a Jira space’s timeline in Confluence
- Use the Jira Reports blueprint as a base for various reporting needs
- Use the Product requirement blueprint to define, scope, and track requirements for your product or feature
- Utilize the Page Properties Report macro to keep a summary of specific pages and necessary details
Use Confluence macros to show Jira data
Use the Jira Chart macro
The Jira Chart macro provides Confluence users with a visual for Jira information. You can display charts in a pie chart or two-dimensional (table) format.
👇Click the tabs below to explore how to create charts in Confluence.
The pie chart format gives users a quick visual with options to display work items from work item keys, search URLs, Jira links, JQL searches, plain text or a pre-created filter.
To create a pie chart from Jira information:
- While editing a page, either select Insert elements (represented by +) in the tool bar or type “/Jira”, then select the Jira charts macro.
- On the left side, select Pie chart, then search for the work items in your chosen format that you want to display information from.
- Expand the Display options section to the bottom of the dialog box and select the information you want to show from the work items, like Status.
- Adjust any other display options as you like, then select Insert.
You can preview the chart as you configure and edit your configurations after placing it on the page.
👇Here’s how a piechart is displayed in Confluence.
Users who can edit Confluence pages can create these charts. Page viewers can only view work items they have permission to access in Jira.
Use the Jira timeline macro
The Jira timeline macro allows users to visualize and display a Jira space's timeline. It provides a visual representation of space milestones, tasks, and deadlines, helping teams to track progress and manage spaces effectively.
Confluence will update timelines added to its pages in real-time to avoid any lag in information. Timelines are embedded on a page, meaning you can interact with the timeline the same way you interact with it in Jira.
To insert a timeline into your Confluence page:
- While editing the page, type “/Jira” or select Insert elements (represented by +) from the top of the page.
- Select Jira timeline.
- Add the URL to your Jira instance and choose the space and board you want to take your timeline from.
- Select Save.
- Once the timeline has been added, you can select Edit link to update the text above the timeline or the timeline itself.
To add a timeline into Confluence by URL:
- Copy the chosen timeline’s URL.
- While editing the Confluence page, paste the URL where you would like to see the timeline on the page.
- Once the timeline has been added, you can select Edit link to update the text above the timeline or the timeline itself.
👇Here’s how you would see a Timeline in Confluence.
Use blueprints and templates to display Jira data
A template in Confluence is a page with predefined content that helps users create consistent and organized content.
A blueprint is a template with more functionality than standard page templates. A blueprint includes developer code to add unique functionality to the pages created.
Use the Jira Report blueprint
The Jira Report blueprint displays the Jira Chart macro and other macros on a single customizable page. This provides a visual display of your Jira work’s status in Confluence.
You can only add a template to a blank page, so make sure to select the template as soon as you create the page and before you add information. Confluence allows you to create a Change Log or Status report once you select the template.
👇 Here's the different Jira report blueprint options.
👇 Click the tabs below to explore the Jira report blueprint options.
The Change Log report type lets you track your team's progress and communicate deliverables. You can also generate a static or dynamic list of Jira work items from a saved search, Jira URL, or JQL query.
Use the Product Requirements blueprint
The Product Requirements blueprint helps you define, scope, and track requirements for your product or feature.
👇Here’s how the Product Requirements blueprint is formatted.
You can create as many product requirements pages as you need. After you’ve saved the first Product Requirements blueprint page, Confluence adds it to the Product Requirements index that you can access from the Confluence space sidebar. The product Requirements page shows the status of all your requirements at a glance. As long as you have the necessary permissions, you can also access linked Jira work items from your requirements and view them directly in Jira.
👇Here’s how you would see the Product requirement index page in Confluence’s sidebar.
👇 Click the boxes below to explore the components of a product requirements page.
Use the Page Properties Report macro
The Page Properties Report macro lists each page within a space that has a specific label, like the one for pages using the product requirements blueprint. This macro lists information from each page’s page properties section.
When configuring the Page Properties Report macro, you need to choose at least one label and at least one space. You can hide columns and reorder the listed pages.
The Page Properties Report macro is especially helpful on Blueprint index pages to display all pages created with that Blueprint.
👇 Here’s how the Page Properties macro is formatted.
For more information on the Page Properties Report macro, visit Atlassian documentation.