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:

Confluence: Requirement Yogi information

If you move a requirement to another space in Confluence, the link from JIRA is not updated. Don't worry, users will be redirected to the new space as long as no requirement is created with the same name in both spaces.

It is therefore useful to synchronize requirements between Confluence and JIRA. A synchronization can either be triggered from a JIRA issue (see screenshot above) or from Confluence. We've included this feature in the Tools menu, on the top-right of the page:

 

Installation in JIRA

To install this module, please:

  • Check both JIRA and Confluence have the same version of Requirement Yogi,
  • Create an Application Link using OAuth between JIRA and Confluence (see Atlassian's documentation),
  • Create an Entity Link between the JIRA project and the Confluence space (see Atlassian's documentation).

When search for a requirement from JIRA, Requirement Yogi will only search Confluence instances which are linked with the current JIRA project.

Synchronization FAQ

In the following answers, RIL is a Remote Issue Link. It's the lines that are visible in JIRA under the "Description" panel.

 

Is there any harm when the sync fails or when a RIL is invalid?

No:

  • The master data for links is what is visible in JIRA. Requirement Yogi has no control over what JIRA displays.
  • Invalid data in JIRA cannot delete data in Confluence.
  • The worst that can happen is that Confluence is not aware of a link.
    • This could be recovered by going to the JIRA issue and synchronizing it. Synchronization always affects all RILs on a JIRA issue.
    • If the synchronization fails, then deleting-and-recreating the link will always update the situation. This is what the synchronization does automatically.
  • RILs will be deleted in the following situations:
    • When the requirement in Confluence was deleted (removed from its original page) and the JIRA issue is synchronized. That means the link persists on the JIRA issue until a user clicks "Synchronize" in JIRA.
    • When it is immediately recreated to update its globalID. This is required because the globalID is immutable and unique across a JIRA instance.

Is there any harm when the JIRA connector of Requirement Yogi is uninstalled or when the HTTP link to Confluence is suspended?

Yes, there is little harm:

  • RILs can't be displayed properly,
  • Neither synchronous nor asynchronous synchronizations can happen between JIRA and Confluence, causing:
    • Issues link to stale requirements (which were either moved or deleted in Confluence),
    • Confluence requirements display stale links to JIRA (e.g. keep displaying a link although it was deleted in JIRA, or no link although a new one was created in JIRA).

The whole purpose of the "synchronize" buttons is to recover those situations. After reinstalling and synchronizing:

  • Titles will be updated both ways (Confluence requirement description in JIRA / JIRA issue title in Confluence),
  • Links to requirements which were deleted in Confluence will be deleted from JIRA,
  • Links which were created or deleted in JIRA will be updated in Confluence.

 

  • No labels