Last updated Dec 20, 2022

Rate this page:

Link components to Jira issues

If you use Jira Software, you can track work on components by linking them to Jira issues.

A Jira admin needs to turn on the Compass custom field for a Jira Software project. Then anybody in that project can link components to Jira issues.

Once components are linked to Jira issues, you can view, sort, and filter those issues from the components' Jira issues page.

Before you begin

Turn on the Compass custom field for a Jira Software project

A Jira admin needs to turn on the Compass custom field for a Jira Software project. The project has to be company-managed, and on the same Jira site.

  1. In Jira, select Settings Settings icon > Issues.

  2. Under Fields, select Custom fields.

  3. Find the Compass custom field, and select More actions More actions icon > Associate to screens.

  4. Add the custom field to the screens you want by ticking the corresponding box.

  5. Select Update.

Add the Jira Software project to a component

  1. In Compass, go to a component’s Jira issues page.

  2. Select the URL field, and choose the same project you turned the Compass custom field on for.

  3. Select Add.

  1. Turn on the Compass custom field for a Jira Software project.

  2. Add the same Jira Software project to a component.

  3. Find the Jira issue you want to link a component to.

  4. On the Jira issue, select the Compass custom field.

  5. Choose a component.

  6. Select Link. The Jira issue will appear on the component’s Jira issues page.

Change the component linked to a Jira issue

  1. Find the Jira issue you want to change.

  2. On the Jira issue, select the Compass custom field.

  3. Choose a different component.

  4. Select Link. The Jira issue will appear on the component’s Jira issues page.

  1. Find the Jira issue you want to unlink a component from.

  2. On the Jira issue, select the Compass custom field.

  3. Select Remove Cross icon.

  4. Select OK. The Jira issue will disappear from the Compass component's Jira issues page.

View a component's Jira issues

  1. In Compass, find the component that you want to see Jira issues for.

  2. In the side navigation, select Jira issues.

  3. In the table, filter Jira issues by type or status, or sort them from the table columns. By default, Jira issues are sorted by most recently updated.

In December 2022, we improved how you link components to Jira issues

If you used the Jira issues Components field to link Compass components, you now need to use the Compass custom field.

Learn how to bulk change your Jira issues by reading the steps below.

  1. Turn on the Compass custom field for a Jira Software project.

  2. Add the Jira Software project to a component's Overview page.

  3. Go to your Jira Software project’s Issues page.

  4. Select the JQL search mode.

  5. In the query field, type component = compass-component-name. This shows Jira issues that have their Components field set to the name of the Compass component you specify in the query.

  6. Select More actions More actions icon > Bulk change issues.

  7. In the new tab that opens, select all the issues, then select Next.

  8. Select Edit issues, then select Next.

  9. Select Change Compass, then copy and paste the Compass component ID into the field.

    To copy the Compass component ID:

    1. In Compass, go to the component’s Overview page.
    2. Select More actions More actions icon > Copy component ID.
  10. Select Next.

  11. Select Confirm.

  12. Let your changes take effect, then select Done. You’ll see your component in the Jira issues' Compass custom field, and the Jira issues will appear in Compass.

Known issues

We're working to fix the following issues:

  • When bulk editing Jira issues that have components linked to them, the Compass custom field doesn’t show the component name

  • When viewing advanced search results in Jira Software, the Compass custom field shows the component ID instead of the component name

  • In Jira Software email notifications, the Compass custom field shows the component ID instead of the component name

Rate this page: