| Table of Contents |
|---|
You can display related issues in the issue view to give more context or highlight priority work to the users to make sure everyone is on the same page.
...
| Info |
|---|
It's a discountinued functionality that is not available in new JQL Search Extensions installations. Related Issues were only available on Jira Cloud. |
Summary
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:
- See what other issues were reported by the same user in Service desk projects
...
- Highlight top priority blockers for a project.
It is all highly configurable with JQL queries and simple templating and you can fit the queries to your team needs.
| Table of Contents | ||
|---|---|---|
|
Issue view
Whenever you open a Jira issue you'll see a new section on the left called Related issues.
It's organized in tabs and you can click on them to unfold the list of matching issues. Configuration of the tabs is described in the next section.
| Info |
|---|
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.
The configuration page consists of entries. It also has a checkbox that allows to enable or disable the related issues functionality.
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.
A new empty entry form is displayed:
| Field | Description | Example |
|---|---|---|
| Name of the relation |
...
A human readable label that will be displayed on the tab in the issue view. This field is required. |
...
| High priority stories |
| Related issue match |
...
A JQL query that controls the results |
...
displayed in the tab in the issue view. It supports templating described in the next subsection. |
...
Show high priority stories:
| |||||||
| Only show for isssues that match the filter |
...
A JQL query that allows you to show the tab only in the issues that match this query. You can leave it blank to show the tab for all the issues. |
...
Show only |
...
the tab for stories |
...
|
Simple query templating
You can use values from the currently displayed issue to create more dynamic and context aware queries.
Templated keywords or JSON path expressions need to be within double quotes and a curly bracket. For example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
"{assignee}" |
The following query matches stories that are assigned to the same person as the current issue:
| Code Block | ||||
|---|---|---|---|---|
| ||||
type=Story and assigne="{assignee}" |
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.
Most of the data in the issue JSON is in the fields field where you can access project id and labels:
| Code Block | ||||
|---|---|---|---|---|
| ||||
project="{fields.project.id}" and labels in ("{fields.labels}") |
You can match the ids of all the fix versions:
| Code Block | ||||
|---|---|---|---|---|
| ||||
fixVersion in ("{fields.fixVersions[*].id}") |
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 JQL Search Extensions Related issues settings global permission controls the access to the configuration page.
...