Linking from a JIRA issue to a Confluence page

FW Japanese Gardens 1I received a question this month, asking how to link from JIRA to a Confluence page. I’ve been thinking about doing exactly this, so that we can keep Specification documents in Confluence, and then link to them from a JIRA issue. Here’s what I found.

Looking through the Atlassian documentation, I discovered a plugin called the JIRA Linker, which lets you create a custom field and a Search button, so that you can search for a Confluence page and link to it.

[Confluence 3.5, JIRA 4.3]

1. Download and install the JIRA Linker plugin

  1. In JIRA, from the Dashboard, click Administration.
  2. Select JIRA Administration.
  3. Click Plugins.
  4. Click Install, and then search for “JIRA Linker”. (For some reason the Search didn’t work for me, but once I showed all available plugins, I could scroll through the list and find the JIRA Linker plugin.)
  5. Install the plugin, and then restart the JIRA service.

2. Configure the JIRA Linker plugin

  1. Follow the plugin configuration instructions to:
    – Add the Search image (search_16.png) file to JIRA’s images/icons directory.
    – Configure your custom Confluence server address.
  2. Restart the JIRA service.

3. Configure Confluence to enable Remote API Access

  1. In Confluence, from the Dashboard, click Browse, Confluence Admin.
  2. Click General Configuration.
  3. Click Edit.
  4. Select the Remote API check box.
  5. Click Save.

4. Add a custom field in JIRA

  1. In JIRA, from the Dashboard, click Administration.
  2. Select JIRA Administration.
  3. Click Custom Fields.
  4. Click Add Custom Field.
  5. Select the URL Link Field radio button, then click Next.
  6. Enter a name for the field.
  7. Select the appropriate issue types. (I selected Any issue type, for testing purposes.)
  8. Select an applicable context – Global, or a particular project. (I used the default.)
  9. Click Finish.
  10. Select which screens you want the field to appear on. (I selected all three options for testing.)

5.  Link to a Confluence page from a JIRA issue

  1. Open a JIRA issue for editing.
  2. Navigate to the new custom field you added.
  3. Click the Search icon to the right of the field.
  4. In the Search dialog box, enter a search term to find the Confluence page you want to link to.
  5. When the Search results are displayed (this might take a few seconds or more), select the page you want to link to.
  6. Click Update.

Presto! It works!


If you liked this post, consider subscribing to my RSS feed. Or have posts delivered via email. Thanks for visiting!

Photo via Flickr user BFS Man

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.