Atlassian Marketplace **Raledo Services Raise a Support Request**
Apps
More Info
© RALEDO 2022
Show Related Issues allows users to easily see a list of issues that are related to the current issue. The standard way to create relationships between Jira issues is through issue linking. But the relationship between issues is not necessarily through explicit links; it could be through some common attribute such as a common customer, same epic, or all issues part of the same release. This commonality can be expressed as JQL e.g. all the issues with the same reporter as the current issue that are in the Open state.
The purpose of the Show Related Issues app is to give users an easy way to view an issue and all its related issues on the same screen. The app can do this by displaying a panel within the standard Jira issue view, which contains a list of the results of the JQL query that has been defined for that panel. The JQL query finds all other issues that are related by some common set of attributes.
<aside> ⚡ Show Related Issues is built in Forge because we want to support Atlassian's new cloud app development platform that helps developers to build trusted and scalable apps with Atlassian-hosted compute and storage. Our team monitors the latest developments and releases from the Altassian Forge team and we will incorporate the relevant improvements and new capabilities as quickly as possible.
</aside>
| Feature | Lite | Pro |
|---|---|---|
| Show/Hide related issues panel in issue view | Yes | Yes |
| Create multiple related issue panels with different activation contexts (project / issue type combinations) | Yes | Yes |
| Use JQL to match related issues | Yes | Yes |
| Use current issue field values in JQL | Yes | Yes |
| Create Issues Button in Panel | Yes | Yes |
| Use $issue macro in JQL | Yes | Yes |
| Use $issueLinks macro in JQL | Yes | Yes |
| Configure fields to show in related issue panel | Key, Summary, Status, Priority, Assignee, Sprint | Any system or custom field |
| Calculate and display the sum and average of numeric fields | No | Yes |
| Configure Create Issue Button defaults | No | Coming Soon |
Show Related Issues includes all the features of Show Related Issues Lite, plus the following:
Our free version is limited to displaying 6 simple system fields; Issue Key, Status, Summary, Priority, Assignee, Sprint.
With the standard paid version you can display any Atlassian Jira custom field, including multi-value fields such as Sprint, Fix Version, multi-select lists. Please be aware that we do not support custom fields from third-party add-ons at this time.
We have expanded our JQL macros to support any custom field using the $issue syntax which is explain below.
Please be aware that we do not support custom fields from third-party add-ons at this time.
In the standard paid version you can display the Sum or Average value of any of the numeric values (Custom Field Type Number) displayed in the panel.
<aside> ⚡ Nov 2022: Our plan is that all new development and innovation will be released in the standard version. We will continue to support and fix bugs in the free version but we have no plans for new development.
</aside>
Log into your Jira instance as a Jira Administrator.
Click the Apps dropdown and choose Find new apps.
The Find new apps screen loads.
Search for Show Related Issue Pro and click on the app tile.
The App Details screen loads.
Click Get app to start installing your app.
You're all set!
Click Close in the Installed and ready to go dialog.
We will begin by creating a Related Issue Panel to display related stories. The related stories are those that have the same Epic Parent i.e. the same Epic Link. For example, if we have Epic 1, and it contains 10 stories, then within each Story issue view, we will be able to see a panel containing links to the other 9 stories that have the same Epic parent.
Navigate to the Apps administration screen.
Select Show Related Issues Pro under the Apps section. Click Allow Access if this is your first time configuring the app. On the next page, review the permissions and click on Accept.
The Related Issues Panel configuration page will display all the Related Issues Panels.
Click the “+ New Panel” button.
Provide a Name for your Related Issues Panel e.g. Related Stories.
Select the Projects where this panel should appear. Then select the relevant issue types where the panel will appear. In this case we will be selecting Story.
Select the fields you wish to display in the panel.
In the JQL field insert
issuetype = Story and "Epic Link" = ${issue.fields.parent.key} and issuekey != ${issue.key}.
Note: ${issue} is the current issue where the panel is being displayed.
Click Save and then Confirm.
Navigate to a Story that belongs to an Epic containing several other stories.
Click the Issue Panel button.
The Related Issues Panel should appear and display the other stories from the same Epic.
The ${issue} specifier allow us to reference the issue context for the current issue i.e. the issue that is being displayed by the user in the issue view screen. The ${issue} contains the JSON formatted issue data as returned by the Jira Cloud REST API.
An easy way to see this is to use the following URL in your browser
https://<yoursite>.atlassian.net/rest/api/3/issue/<your issue key>
where you must replace <yoursite> with the name of your Atlassian cloud site, and <your issue key> with a valid issue key in Jira. If successful, this will return the JSON structure for the issue. You can use this to determine the values that should be used to access the fields of your issue.
Here are some examples:
Priority: ${issue.priority.name}
Status: ${issue.status.name}
Custom Field (Text): ${issue.customfield_xxxxx} where customfield_xxxxx should be replace by your customfield identifier e.g. customfield_12345.
Custom Field (Select): ${issue.customfield_xxxxx.value}
We can also reference the collection of linked issues in the current issue by using the value $issueLinks in out JQL query in the configuration of the panel.
For example, if you wanted to display all issues linked to issues which are in turn linked to the current issue you could use
linkedIssue in ($issueLinks)
The first time you use the app, you need to grant access to the app. You will be presented with the following