Skip to end of metadata
Go to start of metadata

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:

Inserting a requirement:


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,

    • Ensure you've set up a username on this page, and checked for authentication.

    • 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.


Custom field

Optionally, you can set up a custom field.

Using the custom field is not necessary at all. All 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 syntax

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

  • No labels