About issue linking

Issue linking allows you to create an association between two 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 customise 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.

Within an issue, issue links look like this:

Screenshot: the 'Issue Links' section within an issue

Note that resolved issues will be shown in strike-through font, e.g. DEMO-1.

On this page:

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

Creating a link to another issue

To create a link to another issue:

  1. View the issue from which you want to create a link. Alternatively, move to the this issue on the issue navigator.
  2. On the 'view issue' page, select Link from the More Actions menu or click the Link (plus) icon at the right of the Issue Links section. Otherwise, using the issue navigator, click the Actions (cog) icon to the right of this issue. The Link dialog box will be displayed.
    (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.
  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:
  5. Type an optional Comment - for example, to describe more information about why you are creating these links.
  6. Click the Link button.

Creating a link to an issue on another JIRA site

(warning) To create this type of link, your JIRA system administrator ideally needs to 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. View the issue from which you want to create a link. Alternatively, move to the this issue on the issue navigator.
  2. On the 'view issue' page, select Link from the More Actions menu or click the Link (plus) icon at the right of the Issue Links section. Otherwise, using the issue navigator, click the Actions (cog) icon to the right of this issue. The Link dialog box will be displayed.
    (tick) Keyboard Shortcut: '.' + start typing link
  3. Click the Remote JIRA Issue option at the left of the dialog box and then choose the type of link to be created.
    (info) Note:
  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.
    (info) Note:
  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) Type a Comment, for example, to describe more information about why you are creating this link.
  9. Click the Link button.

Troubleshooting

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.

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

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.

Solution:

Creating a link to a Confluence page

(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. Only Confluence versions 4.0 or later support this JIRA feature.

To create a link to a Confluence page:

  1. View the issue from which you want to create a link. Alternatively, move to the this issue on the issue navigator.
  2. On the 'view issue' page, select Link from the More Actions menu or click the Link (plus) icon at the right of the Issue Links section. Otherwise, using the issue navigator, click the Actions (cog) icon to the right of this issue. The Link dialog box will be displayed.
    (tick) Keyboard Shortcut: '.' + start typing link
  3. Click the Confluence Page option at the left of the dialog box.
    (info) This option will not be 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:
  6. (Optional) Type a Comment, for example, to describe more information about why you are creating this link.
  7. Click the Link button.

Troubleshooting

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:

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. View the issue from which you want to create a link. Alternatively, move to the this issue on the issue navigator.
  2. On the 'view issue' page, select Link from the More Actions menu or click the Link (plus) icon at the right of the Issue Links section. Otherwise, using the issue navigator, click the Actions (cog) icon to the right of this issue. The Link dialog box will be displayed.
    (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) Type a Comment, for example, to describe more information about why you are creating this link.
  7. Click the Link button.

Deleting a link

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.