Working with JIRA in Confluence
This page provides some basics to get you stared working with JIRA issues in Confluence.
Displaying JIRA issues
You can display JIRA issues on a Confluence page using the JIRA Issues macro. You can display a single issue, a list of issues, or show the total number of issues.
One of the simplest ways to add a JIRA issue to a page is to paste a JIRA URL. For example:
<yourjirasite.com>/browse/CONF-1234will insert the JIRA Issues macro and display a single issue.
<yourjirasite.com>/issues/?filter=56789will insert the JIRA Issues macro and display a list of issues matching the saved filter.
<yourjirasite.com>/issues/?jql=project%20%3D%20CONFwill insert the JIRA Issues macro and display a list of issues matching the JIRA search.
Alternatively you can add the JIRA Issues macro to the page and use the macro browser to search for issues directly.
- In the editor choose Insert > JIRA Issue.
- Follow the prompts in the macro browser to choose a project and search for an issue - you can even use JIRA Query Language (JQL).
You can customise how the issue or list of issues appears on the page, including how much information to display, how many issues, and more.
Find out more about using the JIRA Issues Macro.
Creating JIRA Issues
You can create issues from a page, or from the editor. This is particularly useful if you use Confluence for requirements gathering.
To create an issue when viewing a page:
- Highlight some text on your page - a panel with appear near your selection.
- Choose Create JIRA Issue.
- Follow the prompts to enter information about your project and issue - your highlighted text will populate the issue summary.
- Choose Create - the issue will be created in JIRA, and added to your page.
If your text is in a table, you will have the option to create multiple issues using text from the same column.
If you do not see a popup when you highlight text, check that Text Select is enabled in your profile settings.
To create an issue in the editor:
- In the editor choose Insert > JIRA Issue > Create new issue.
- Follow the prompts to enter information about your project and issue.
- Choose Insert - the issue will be created in JIRA, and added to your page.
There are some limitations when creating JIRA Issues from Confluence. The JIRA Issues macro or Create JIRA Issue dialog will notify you if it is unable to create an issue in the selected project. You can find out more in the JIRA Issues Macro page.
Creating reports and charts
Reporting on information stored in JIRA couldn't be easier in Confluence. In addition to the JIRA Issues Macro, you can use the JIRA Report blueprint or JIRA Chart macro.
- Use the JIRA Report blueprint to create a Change Log or Status report.
- Use the JIRA Issues Macro to display a list of resolved issues, for example for use in release notes.
- Use the JIRA Chart Macro to display data as a pie chart.
Prompting users to add JIRA Issues to a page
If you use templates (including templates provided by blueprints), you can add a JIRA Issue placeholder that, when clicked, opens the JIRA Issues macro and prompts users to search for or create a JIRA issue.
You can see the JIRA Issues placeholder in the Product Requirements blueprint.
See Adding a Template for more information on using instructional text and placeholders.
View connections between Confluence and JIRA
The JIRA Links button gives you quick access to issues connected to the Confluence page you are viewing.
Links are displayed when:
- you have created or added single issues to the page using the JIRA Issues macro in Confluence.
- you have added a link from the issue to the Confluence page in JIRA.
If you use JIRA Agile, sprints and epics will also appear on the JIRA Links button.
The number on the JIRA Links button indicates the total number of issues connected to that page, regardless of whether you have permissions to view the issues. The dropdown will only show issues, epics and sprints that you have JIRA permissions to view.
- The JIRA Links button only appears in the default theme. It is not visible in the Documentation theme.
- The button also does not detect links from issues displayed in the JIRA Issues macro in table format.
Was this helpful?
Thanks for your feedback!