Linking Issues

Issue linking allows you to create an association between two existing issues on either the same or different JIRA servers. For example:

  • An issue may relate to another.
  • An issue may duplicate another.
  • An issue may block another.

(Your JIRA administrator can customize the types of links that you can create.)

Issue linking also allows you to:

  • Create an association between a JIRA issue and a Confluence page.
  • Link a JIRA issue to any other web page.

On this page:

Issue links within an issue look like this:

Screenshot: the 'Issue Links' section within an issue

Note: Resolved issues (i.e. issues with a Resolution set) are displayed in strike-through font, e.g. DEMO-1.

To create links on JIRA issues, you need to have the Link Issues permission in the project(s) to which the issues belong.

Creating a link to another issue on the same JIRA site

To create a link to another issue on the same JIRA site:

  1. Open the issue you wish to link to another issue in the same JIRA site.
  2. Select More > Link to display the Link dialog box.
    (tick) Keyboard Shortcut: '.' + start typing link
  3. Ensure that the JIRA Issue item is selected at the left of the dialog box and then choose the type of link to be created from the This issue dropdown list.
    (info) If your JIRA system administrator has configured fully reciprocal application links between your JIRA site and another one, a Server dropdown list may appear above the This issue list. If this is the case, ensure your JIRA site appears or has been selected from the Server list.
  4. In the Issues field, specify the issue(s) to be linked to your currently viewed/selected issue. There are two ways to do this:
    • Type the full issue key (e.g. ABC-123) — or to link to multiple issues, press the 'Enter' key between each typed issue key.
      (info) If you have previously browsed an issue, you can quickly find the issue by typing the first few letters of the issue key (or part of the Summary), which will appear in an 'autocomplete' drop-down list for selection:
      OR:
    • Click the search for an issue link to use the Find JIRA issues popup, which allows you to perform either a simple text search or an advanced search for issues.
  5. Optional: Add a Comment to describe why you are linking these issues.
  6. Click the Link button at the bottom of the dialog.

Creating a link to an issue on another JIRA site

(warning) To create this type of link, your JIRA system administrator should have configured fully reciprocal application links between your JIRA site and the other JIRA site containing the issue(s) you want to link to.

To create a link to an issue on another JIRA site:

  1. Open the issue you wish to link to another issue.
  2. Select More > Link to display the Link dialog box.
    (tick)
    Keyboard Shortcut: '.' + start typing link
  3. Ensure that the JIRA Issue item is selected at the left of the dialog box.
    (info) Note:
    • This option will not be available if your JIRA system administrator has not configured an application link between your JIRA site and the remote JIRA site.
    • If, after selecting this option, you are prompted for authorisation, you may be required to log in to the remote JIRA site, which will allow your JIRA site to access the remote JIRA site on behalf of your account on the remote JIRA site.
      (info) This behavior means the application links configured between your JIRA site and the remote JIRA site use OAuth authentication.
  4. If your JIRA site is connected to multiple remote JIRA sites, choose the relevant JIRA site from the Server dropdown list.
  5. Choose the type of link to be created from the This issue dropdown list.
  6. Type the Issue key of the issue on the remote JIRA site that you want to link to. Alternatively, you can search for issues on the remote JIRA site by clicking the search for an issue link, which opens the Find JIRA issues popup.
    (info) You can link to any issue on the remote JIRA site to which you have access on that site.
  7. Select the Create reciprocal link check box to create the complementary link on the remote issue you are linking to, back to your issue. For example, if you create a blocks link type to a remote issue, the reciprocal link generated on the remote issue will be a is blocked by link type back to your local issue.
  8. Optional: Add a Comment to describe why you are linking these issues.
  9. Click the Link button at the bottom of the dialog.

Troubleshooting

(error) Problem: If you selected the Create reciprocal link check box but after clicking the Link button, discover that a reciprocal link from the remote JIRA issue back to your JIRA issue has not been created, then your JIRA system administrator has most likely created only a one-way link from your JIRA site to the remote JIRA site.

(tick) Solution: Ask your JIRA system administrator to configure fully reciprocal application links between your JIRA site and the remote JIRA site.

(error) Problem: If you attempted to create a reciprocal link but received the following message:

'A reciprocal link from issue 'XYZ-123' back to this issue was not created as the remote JIRA server returned the following error: No Link Issue Permission for issue 'XYZ-123'.' (where 'XYZ-123' is the issue key on the remote JIRA site),

then a reciprocal link on the remote JIRA site will not have been created, because the user account through which you authenticated on the remote JIRA site (at step 3 above) does not have the Link Issues project permission.

(tick) Solution:

  • Ask the JIRA project administrator(s) on the remote JIRA site to grant your user account the Link Issues project permission for the relevant project(s) to which you need to create issue links.
  • Alternatively, if the application link between your JIRA site and the remote JIRA site use OAuth authentication and you suspect you may have authenticated on the remote site with another user account that does not have the Link Issues project permission, repeat the procedure above but during the authorisation step (at step 3), authenticate on the remote site with a user account which has this permission.
    (info) If you are not prompted for authentication during authorisation, try clearing your browser's cookies first and repeat the procedure again.

Creating a link to a Confluence page

This feature is only supported in Confluence versions 4.0 or later.

(warning) To create this type of link, your JIRA system administrator needs to have configured an application link between your JIRA site and the Confluence site containing the pages you want to link to. 

To create a link to a Confluence page:

  1. Open the issue you wish to link to another issue.
  2. Select More > Link to display the Link dialog box.
    (tick) Keyboard Shortcut: '.' + start typing link
  3. Click the Confluence Page option at the left of the dialog box.
    (info) This option is not available if your JIRA system administrator has not configured an application link () between your JIRA site and the Confluence site.
  4. If more than one application link has been configured between your JIRA site and other Confluence sites, then choose the appropriate Confluence site from the Server dropdown list.
  5. Specify the Confluence page to be linked to your currently viewed issue. There are two ways to do this:
    • In the Page URL field, enter the URL of a page on the Confluence site you want to link to. For example:

      http://<confluence-server>/display/ds/Welcome+to+the+Confluence+Demonstration+Space
    • Click the search for a page link. The Link dialog box is replaced by the Find a Confluence page dialog box.
      (info) If you are prompted for authorisation, you may be required to log in to the Confluence site, which will allow your JIRA site to access the Confluence site on behalf of your account on the Confluence site.
      This behavior means the application links configured between your JIRA site and the remote Confluence site use OAuth authentication.
      1. In the first Search field, specify one or more search terms that appear in the page you want to link to. This field is mandatory.
      2. Optional: In the second Search field, select the Confluence space to further narrow down the search.
      3. Click the Search button and then the title of the page you want to link to.
  6. Optional: Add a Comment to describe why you are linking these issues.
  7. Click the Link button at the bottom of the dialog.

Troubleshooting

(error) Problem: If Confluence page links you create show Failed to load on the JIRA issue or if you attempted to search for a Confluence page but received the following message:

'Content on the Confluence site could not be accessed because the Confluence server's 'Remote API' feature is disabled. The Confluence system administrator must enable this 'Remote API' feature for JIRA to successfully access this content.'

then JIRA was unable to communicate with the Confluence server to either:

  • retrieve information about the link or
  • conduct a Confluence page search in the Find a Confluence page dialog box.

(tick) Solution:

Ask the Confluence system administrator to enable the Remote API (XML-RPC & SOAP) feature, since this Confluence feature is disabled by default. See Enabling the Remote API in the Confluence documentation for details.

Creating a link to any web page URL

To create a link to any web page URL:

  1. Open the issue you wish to link to another issue.
  2. Select More > Link to display the Link dialog box.
    (tick) Keyboard Shortcut: '.' + start typing link
  3. Click the Web Link option at the left of the dialog box.
  4. Specify the URL of the web page you want to link to.
  5. Specify the Link Text that will appear in the Issue Links section of the 'view issue' page and will be hyperlinked to your URL.
  6. Optional: Add a Comment to describe why you are linking these issues.
  7. Click the Link button at the bottom of the dialog.

To delete a link:

  1. Go to an issue that contains links, and locate the Issue Links section (see screenshot above).
  2. Hover your mouse over the link you wish to delete, and click the Delete (trashcan) icon that appears.

Searching for linked issues

You can search for issues that are linked to a particular issue. For details, please see the documentation on Advanced Searching.

(info) Be aware that this functionality does not extend to issues on a remote JIRA server.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport