How to set up the integration
To enable the Confluence-Jira integration:
- Install the Requirement Yogi module in Jira (available on the Marketplace),
- Set up Application Links between Jira and Confluence,
- Set up Entity Links between a Jira project and a Confluence space (or several),
- IMPORTANT Go to the administration and set the credentials in both products (since 2.2 for Confluence and 2.5 for Jira).
|Set your credentials in Confluence||Set your credentials in Jira|
What are credentials used for?
The user is used to send the queue messages between Jira and Confluence. When you modify requirements, we update their text in Jira; When you modify issue titles, we update the link title in Confluence.
What permissions are needed?
- The user doesn't have to be an administrator,
- It needs to be the same user on both sides. Usernames can be different if you use OAuth, but when you authorize the other side, the associated account must be the same as saved in the properties.
- It needs to have VIEW permissions on the spaces with requirements in Confluence,
- It needs to have EDIT permissions on the issues with links, in Jira.
If I don't like providing credentials, how should I do?
- It is not like we ask for a password. We just ask for a username. If we had been evil, we could have used any administrative user from the database to synchronize the queue, and you wouldn't have seen it. We ask for a username is because we are not malevolent.
- It doesn't pose any extended security risk, since the only data we modify are Requirement Yogi tables.
- It solves a lot of issues. Before using a queue, we used to send the information to Jira synchronously. Unfortunately, there were situations where we couldn't ask for OAuth approval (when saving a page) and this resulted in the message not being sent to Jira, and issues being different than the data in Confluence. Since implementing the queue, we've had zero support cases about synchronization. The queue is solving the authentication very effectively, with the drawback that we need a user to ensure the authentication is satisfying.
This was introduced in version 2.2, so head to our release notes if you have more questions.
After adding your credentials, make sure you have "Entity links" between the Jira project and the Confluence space.
Overview of the integration
A Requirements panel on Jira issues:
A custom field, if you choose to configure it instead of the panel:
The dialog to add links on an issue:
The glorious Jira bulk issue creation:
And of course, Jira issues appear in the popup as dependencies, and in the traceability matrix.
The Custom Field
Using the custom field is optional. All requirements can be displayed in the "requirements" panel, but some customers prefer using the custom field, which makes it possible to:
- Make requirements visible in the REST API,
- Make requirements visible in the XML API,
- Make the field visible and mandatory on the Create Issue screen.
If interested, see more details on Release notes 2.2.5 for Jira
The JQL function to search for issues with Requirement Yogi links is described on this page: JQL Syntax.