# How to Connect Teamscale to Jira Server

Teamscale integrates with Jira Server using Jira's built-in REST API.

Minimum Jira Version

Teamscale relies on Jira's REST API version 2, which is available with Jira Server 5.0 or later.

# Jira Integration Sample

Jira Issue Integration Example

In order to enable Teamscale to update issues in Jira Server with Teamscale analysis results, you need to follow the steps below:

  1. Ensure that the public base URL is configured correctly in Teamscale. For this, open the settings page ( Admin / Settings ) and check the entry Teamscale instance base URL in tab Server Settings . This should point to the URL of the Teamscale server.

  2. Select the Jira Issue Tracker connector during project creation.

  3. Select or create an account for the Jira server. The account fields should be filled out as follows:

    URI: Jira Server root URL (e.g., https://jira.my-company.com ).

    Username: The username of a user who has following permissions on the Jira Server:

    • Browse projects project permission for the Jira project(s) that contain the matched issues.

    • Edit issues project permission for the Jira project(s) that contain the matched issues.

    • If issue-level security is configured, issue-level permission to view the matched issues.

    Password: The user's password.

  4. Configure the Add to Jira issues Jira connector option. You can select the analysis results to be added to Jira issues as well as the destination field(s) for Teamscale-generated messages (issue description, custom field, etc.). Details of Add to Jira issues connector option are available here. An example of a Jira issue field enhanced with Teamscale-generated data can be seen in the screenshot above.

  5. Complete Jira connector configuration and project creation as usual. Make sure the Issue ID pattern connector option is configured, since the integration builds upon this option to decide which Jira issues to update with Teamscale analysis results.

# Jira Gadget

To allow integration of Teamscale dashboards as Jira gadgets, follow those steps.

  1. Ensure that the public base URL is configured correctly in Teamscale. For this, open the settings page ( Admin / Settings ) and check the entry Teamscale instance base URL in tab Server Settings . This should point to the URL of the Teamscale server.

  2. In Jira go to a dashboard and click on Add gadget. In the next dialog select Manage gadgets. Note that this requires administrator access in Jira.

  3. Enter the following URL in the input field and press Add gadget: http://BASE-URL-OF-TEAMSCALE/api/gadgets/jira/dashboard.xml

The gadget should now be available and can be added to your Jira dashboard.