Versions Compared

Old Version 9

changes.mady.by.user Adrien Ragot

Saved on

compared with

New Version 10

changes.mady.by.user Adrien Ragot

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents

Overview

Requirement Yogi has a JIRA module for JIRA-Confluence integration.

  • Search and link to requirements from JIRA,

  • Confluence displays the link in the Requirement Yogi inline dialog,

  • The text is updated in JIRA whenever users click "synchronize" for an issue.

Example:

Image Removed

Inserting a requirement:

Image Removed

How to set up the integration?

We have greatly improved the technical architecture of this integration in September 2019, as part of the Data Center program. We still have to improve the set up experience, so it takes several steps for the moment, and will be improved too:

...

Install Requirement Yogi for Jira on Jira. We only support Jira Server and Data Center, we don't support Cloud.

...

Ensure you have an Application Link between Jira and Confluence. This isn't dependent on Requirement Yogi, it is a native feature in products.

...

Ensure you have a Project Link between the Jira project(s) and the Confluence space(s) where you plan to work. Again, this is a native feature in Atlassian products.

...

Try linking requirements:

  • Go to an issue, click the "..." menu, click "Add links". You will see the dialog pictured in the header of this page.

  • In this dialog, try searching for a requirement. Any necessary information will be brought to you at this point, for example if you need to authenticate to Confluence, if you didn't set up the entity links, etc.

Set a username for the Confluence/Jira communication:

...

Go to the Confluence administration,

...

Go to the Requirement Yogi page in the Confluence administration (in the "Marketplace" section),

...

Go to the Integrations tab in this page,

...

How to set up the integration

To enable the Confluence-Jira integration:

  • Set up Application Links between Jira and Confluence,
  • Set up Entity Links between a Jira project and a Confluence space (or several),
  • Status
    colourYellow
    titleImportant
     Go to the administration and set the credentials in both products (since 2.2 for Confluence and 2.5 for Jira).

Image Added


Info
titleWhat 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.

Do you recognize this screen? If not, then you haven't fully completed the installation steps above.

Image Removed

Custom field

...

After adding your credentials, make sure you have "Entity links" between the Jira project and the Confluence space.


Overview of the integration

Requirement Yogi has a JIRA module for JIRA-Confluence integration.

  • Search and link to requirements from JIRA,

  • Confluence displays the link in the Requirement Yogi inline dialog,

  • The text is updated in JIRA whenever users click "synchronize" for an issue.

Example:

Image Added

Inserting a requirement:

Image Added


The Custom Field

Requirements appear in a panel at the bottom of the Jira issue. However, you can also disable the panel and use a Custom Field instead!

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

JQL

...

function

The JQL function to search for issues with Requirement Yogi links is described on this page: JQL Syntax.

...