Versions Compared

Key

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


Info

Related Issues are currently only available on Jira Cloud. If you would like to see this feature added to the Server version of the app please send us a message.


Table of Contents

Related issues allow you to see other issues which are related to your work. It allows you to easily define which issues are related and where this information should be displayed.

For example you can see what other issues were reported by the same user in Service desk projects. You can highlight project top priority blockers. It is all highly configurable with JQL queries and simple templating and you can fit the queries to your team needs.

Issue view

Whenever you open a Jira issue you'll see a new section on the left called Related issues.

...

Please keep in mind that at most 100 issues will be displayed per each tab. If there is an error in the query the tab won't be displayed.

Configuration

Related issues configuration page link is in the left hand menu.

...

Each entry has a name and a corresponding JQL query. It can also be configured to display in certain issues by using the another JQL query for filtering.

Default entries

After installation you'll notice that configuration is populated with sample entries that are useful in many projects. It can also be used as an inspiration for you own related issue entries.

Adding entries

To add a new entry scroll to  the bottom of the configuration page and click on the green Add button.

...

For example to only show the tab for stories set your filter to:

type=Story

Simple query templating

You can use values from the currently displayed issue to create more dynamic and context aware queries.

...

Supported keywords:

  • assignee
  • reporter

Advanced query templating

You can also use expressions that will be executed as a JSON Path expression to access all the data returned by issue REST endpoint: https://YOUR_JIRA_URL/rest/api/2/issue/ISSUE_KEY.

...

The simplest way to create you own advanced JSON path queries is to paste the issue JSON to JSON Path online Evaluator. If the value returned by the JSON Path is a single element array that element will substitute the template. If there are more values or the arrays are nested then all the elements will be put together and separated by a comma.

Sorting entries

Entries are displayed in the issue view in the order they are defined in the configuration.

...

Dragging is disabled when a new entry is added but not save. Save or remove the new entry to enable the dragging.

Deleting queries

You can quickly delete the configuration entry by clicking on the red Delete button. As soon as the entry is removed the tab for it won't be shown anymore in the issue view.

Turning off

You can disable the functionality in the configuration page by toggling the Enable checkbox. When it's disabled the Related Issues panel is not displayed in the issue view.

Restricting access to the configuration page

JQL Search Extensions Related issues settings global permission controls the access to the configuration page.

...