5.1.2.8. Atlassian JIRA integration

If you use JIRA for issue tracking, you may be interested in the JIRA integration, which allows dashboard users and IDE plugin users to easily link continuous integration findings (issues) to JIRA tickets.

Note that a precondition for using this feature is that issue annotations must be enabled. This project-specific setting is enabled by default but can be deactivated on the project configuration page (see Section Projects). Links to the JIRA tickets are stored in the analysis database extension file (suffix .dbx), where tags and comments are also stored. Once configured, the feature is accessible on the Issue Page when viewing an issue in the dashboard, or in the Issue Properties pane when viewing an issue within an IDE plugin.

The integration is a one-way relationship; only the Dashboard uses JIRA APIs, meaning JIRA has no specific knowledge of the Axivion Dashboard.

Authentication is performed via OAuth 1.0a, which requires creating an incoming application link for the dashboard in JIRA (see Figure JIRA Application Links Configuration Table).

When creating a new Application Link in JIRA, ensure that the “Create incoming Link” checkbox is selected in the “Link Applications” dialog (see Figure Be sure to check “Create incoming Link”) and leave all non-required fields empty. Next, enter a “Consumer Key”, a “Consumer Name”, and a “Public Key”. In OAuth terms, the “Consumer” is the client application, which in this case is the Dashboard.

JIRA dialog to register the Dashboard

JIRA dialog to register the Dashboard

To fill out the remaining fields (see Figure JIRA dialog to register the Dashboard), open a new browser tab and navigate to the “Atlassian JIRA Integration” section on the General Settings page in the Dashboard (see Section General Settings), activate it, and click the Register button. An RSA key pair will be generated as you enter the necessary details. Ensure that the “Consumer Key” is identical on both ends and that the URLs are the main entry URLs for the respective applications.

Dashboard dialog to register JIRA

Dashboard dialog to register JIRA

After entering the details on both sides – and most importantly, copying the Public Key from the Dashboard dialog into the JIRA dialog – confirm the JIRA dialog and verify that the application link appears in the list of JIRA application links (as shown in Figure JIRA Application Links Configuration Table). Then, finalize the registration on the Dashboard side. Note that connections to JIRA are made from the Java process running the dashboard (rather than from inside the user’s browser), which is important to know if you use restrictive firewalls or if your JIRA instance uses a certificate that is not trusted by Java by default.

Once the initial registration is complete, you have two choices for how the dashboard should authenticate a JIRA user to link or unlink tickets. By default, each dashboard user will be prompted (upon first use of the feature) to request their own JIRA access token, which is then stored in the dashboard configuration database. Alternatively, you may prefer a single JIRA user token shared by all dashboard users. In that case, create the token by following the instructions in the Atlassian JIRA Integration section on the General Settings page. Note that the “Shared Access Token” only works for linking and unlinking; when creating JIRA issues, users must still authenticate directly with JIRA using their own credentials.