TestRail integrates with Jira Data Center so that you can autofill and push bug reports to Jira during testing, link issues to test results, look up issue details from TestRail, and track requirement coverage and traceability.
Additionally, with TestRail’s Integration for Jira Data Center app, you can directly see linked test results and test case links inside Jira, review metric dashboards, and create new test cases from Jira.
This guide will walk you through the steps of integrating TestRail with your Jira Data Center instance.
Get a TestRail instance
Already using TestRail? You are all set and you can skip this step! If you are not yet using TestRail, simply register your free trial. You can either get TestRail Server for a self-hosted installation or use TestRail Cloud for a SaaS solution hosted by us.
- If your Jira Data Center instance is running on your private network behind a firewall, then we recommend you use a TestRail Server instance because your TestRail instance must be able to access your Jira instance via https.
- If your Jira Data Center instance is reachable over the Internet, you can also use our TestRail Cloud edition (we can also provide the list of our cloud IPs for the integration if required by your IT team).
Configure Jira integration in TestRail
Configuring the Jira integration in TestRail is easy. Simply select Administration > Integration to start configuring your settings. We recommend using the simple Jira configuration wizard at the top of the page. Simply click the Configure Integration button to get started:
This will automatically help you set up the required Jira URLs, the defect integration to push/lookup Jira issues, as well as the reference/requirement integration.
For Jira Data Center integration, you should select the Jira Version Jira Server 5.x, 6.x, 7.x and later, and authenticate the integration using your Jira username and password combination.
The wizard also automatically configures the integration with User Variables so that each user can enter their own Jira integration settings. If users do not add individual User Variables, then the instance user settings will be used instead, and defects pushed to Jira will have the administrator's name on them, rather than the user's.
To configure the Jira user, each user can simply enter the details under their My Settings page by clicking on their name in the top right corner of the TestRail interface. Each user can simply enter their Jira login details for the integration.
Manual Jira configuration
Do you prefer to configure the Jira integration manually or need to customize, extend, or change the integration? No problem, you can also easily configure the Jira integration from TestRail’s side manually with a few simple steps.
You can also configure different integrations for different projects. To do so, simply configure the integration for each project under Administration > Projects > edit a project > Defects / References tabs. Learn more about configuring the integration manually or how to customize and adjust the integration here:
- Manual Jira configuration
- Jira custom fields and issue links
- Defect variables to map users
- Building a custom defect plugin
Get the "TestRail Integration for Jira" app
The optional (but highly recommended!) Jira app add-on allows you to directly review related test results, test case links, TestRail dashboard statistics and new case buttons directly from inside Jira.
The way the app is installed in Jira may be slightly different depending on whether the app is available on marketplace, and if your site is behind a firewall.
For more details, please refer to the Installing marketplace apps.
Install an app from Atlassian Marketplace
Alternatively, you or your Jira administrator can enable the add-on directly from Jira under Settings > Apps > Find new apps, then search for TestRail.
From there, click the TestRail app > Get App > Get it now.
Install an app from a file
If a firewall is preventing access to the Marketplace, you can install the app from a file by uploading it to Jira. To do that, download a specific version of the app from Marketplace. Go to the Versions tab on the app's page and click See all versions. Make sure you select the appropriate file for Data Center in the Version History, and click Download on the right side of the file.
To install the app by uploading a file:
- From the top navigation bar in your application, choose Settings > Add-ons> Manage apps.
- Choose Upload app.
- Select the app file (it will be a .jar or .obr file) or enter the URL where the file can be found.
- Select Upload.
Next, after you installed the app either from Marketplace or by uploading a file, simply configure the add-on with your TestRail address and key.
From Jira’s administration area, select Manage apps, expand the TestRail for Jira Test Management app, and click Configure. Then simply configure your TestRail address and integration key and any additional optional settings.
You can also limit the add-on to select Jira user groups or projects to hide the integration from users who don’t currently use TestRail.
You can only link one TestRail project to one Jira project at a time. You can, however, link multiple Jira projects to different TestRail projects within the same TestRail instance.
If you have several Jira projects, and a TestRail instance associated with all of them, you can connect a new TestRail instance by either deselecting an existing Jira project, or creating a new one.
Migrating from Jira Server to Jira Data Center
If users wish to migrate from Jira Server to Jira Data Center, they need to take into account how each of those instances have been setup to be able to access Jira issues from the Server instance:
- Make sure your Jira Data Center instance has been setup so it uses the same URL as your old Server instance.
- Make sure your Jira issues have been migrated from your old Server instance so that they have the exact same ID in your Data Center instance.