Install & Configure QMetry's Jira Integration App
Pre-requisites: Supported QMetry Jira Integration
Below is the support matrix for the QMetry Jira Integration app.
QMetry | Jira | Supported? |
|---|---|---|
Cloud | Cloud | Yes |
Server | Server | Yes |
Cloud | Server | Yes |
Server | Cloud | No |
Note: For Jira Data Center versions 9.17.5, the compatible QMetry Jira Integration App v2.3.0_jira9. For Jira Data Center v10.x, the QMetry Jira Integration App v2.3.0.
Step 1: Install App: "QMetry Jira Integration"
Install "QMetry Jira Integration" app in your Jira Instance. It is free to download.
Jira Edition | Jira App Availability | Upgrading Jira App |
|---|---|---|
| Already Installed | Automatic Upgrade. Configuration Required |
Not Installed | Installation and Configuration Required | |
Server | Already Installed | Upgrade and Configuration Required |
Not installed | Installation and Configuration Required |
1. Login in Jira with Admin Credentials. Administrator login is required to be able to install the App from Atlassian Marketplace.
After login into the Jira, go to the Jira settings option and click on Apps.
In the Apps section, there is an option to find & Install the app from Market place. Search for "QMetry Integration for Jira" app.
Select the app and click on the Get app button to install it.
4. Click on the Get it now button.
Select a site and click Request App.
Step 2. Configuring Jira app with QMetry Admin
After installing the "QMetry Integration for Jira" app follow below steps to configure Jira with QMetry. The integration requires QMetry admin credentials.
There are two options available to configure Jira with QMetry:
A. Connect using Credentials: The integration should be done with QMetry admin credentials.
B. Connect using Open API Key: If you have an integration package enabled then only you will get the Open API key. You can use the Open API key for any user to connect QMetry with Jira.
A. Connect Using Credentials
Note
Integrate with QMetry users using QMetry authentication. A QMetry user authenticated with SSO login can not be used for Integration. Recommended - Use the system admin (for cloud instances - the user who has registered for the QMetry instance) or administrator (for server customer - user "Admin" is the administrator) user for authentication.
If the user has Two-step Verification enabled in QMetry, then they need to provide the Two-step Verification code to connect using this method. Users with Two-step Verification disabled can connect directly by providing credentials and Organization Code.
To connect using credentials, perform the following steps:
Go to Jira settings.
Select QMetry Configuration and enter the QMetry URL.
Enter QMetry Admin Credentials and Organization Code
Click Connect the configuration.
2. If Two-step Verification is enabled for the user, also provide the Two-step Verification code after clicking on the Connect button.
3. Enter the Two-step Verification code and click Submit to save the details.
On submitting the valid Two-step Verification code, the Jira integration is established with QMetry.
B. Connect Using Open API Key
Users can also integrate Jira with QMetry by using the Open API Key of QMetry (Integration > Open API).
Open API Key is only available for users who have opted for the Integration app.
After entering the valid Open API Key and clicking Connect, the Jira integration is established with QMetry.
If you are using Cloud version of Jira, the integration app "QMetry Jira Integration" will be displayed as follows in Jira under the Apps > Manage apps section.
If you are on Server or Data Center version of Jira, the integration app "QMetry Jira Integration" will be displayed as follows in Jira, under the Apps > Manage apps section.
Step 3: Verify All Modules are Enabled (only for server or data center Jira editions).
Note: Skip this step if you're using Cloud Jira.
If you are on Server or Data Center version of Jira, then verify that all the modules are enabled on the Manage app screen.
In Jira, go to Apps > Manage apps section.
Expand the modules section and make sure that all the modules are enabled.
Step 4: Verify the QMetry - Jira Integration is Active
After the successful configuration with the above steps, QMetry "Integration" section will start showing "JIRA" configured as below.
Login to QMetry >> Integration >> Integrations >> Verify Integration URL and Status as "Active"
The Associated QMetry Projects column will show QMetry projects configured with this integration.
Sync fields to Reports
Note: The feature is only available to the customers who have opted for the Advanced Reports App.
Admin can opt for syncing the mapped custom fields of external tracker to the reports. You can include Jira's custom fields of Issues and Requirements modules in QMetry Insight tables for both Visual and Advance Query Reports to create a custom report with UDFs.
If the option is turned “On”, then the mapped custom fields for Issues and Requirements modules will be synced in the QMetry Insight module.
If the options is turned “Off”, then the synced fields in the QMetry Insight module will be removed.
Use Case: Project admin wants to create a custom report in QMetry Insights using Jira's custom fields, which are mapped n Project Integration Screen (Projects > Project/Release/Cycle > Integration).
→ Permission required: Users with Integration “Modify” rights can enable/disable the sync.
Notes:
Once you have enabled/disabled the option for an external tracker integration, you can change the state of that option for that integration only after 8 hours.
Once you have enabled/disabled the option for one external tracker integration, you can enable/disable the option for other integrations only after 4 hours.
You can not disable the Sync Fields to Reports option in the midst once the syncing is initiated and in-progress.
Only those external UDFs which are mapped under Project > Integrations tab will be synced in the QMetry Insight module.
Maximum 1000 UDFs (including internal and external UDFs) are allowed to sync for the QMetry Insight module.
The syncing of fields to reports are done at instance level. Hence, all the users of the projects with which the external tracker is integrated, can see the synced UDFs in the QMetry Insight module.
If the integration with the external tracker is removed, the UDFs will also be stopped showing in the QMetry Insight module.
Steps:
1. Go to Integrations and open the Integrations tab.
2. Turn the Sync fields to Reports option “On” for the integration to sync mapped external custom fields to QMetry Insights. By default, the option remains “Off”.
Step 5: Integrate Jira Project with A QMetry Project
Refer to Map Jira projects, Issue type and Fields with QMetry Project
Step 6: Enable QMetry Test case and BDD panels for Jira Projects
Configuration to enable QMetry Test case and BDD panels for Jira Projects. This change is required for all Jira projects that are to be integrated with QMetry.
1. Log into Jira and open your Project. Click on Project Settings on the sidebar.
2. Locate and go to QMetry Features on the sidebar.
3. Click on QMetry Features to open the QMetry Configuration screen.
Enable QMetry Panels for Project: Enable it to make the QMetry Test Case panel visible on issue screen. If the feature is disabled, the QMetry panel will not be displayed on Issue screen. This panel shows the Test cases - Issue linkages.
Issue Type - Enable Issue types for which Test case and BDD panel should be displayed in Jira.
BDD and Test Case panels are enabled only for the current project (and not all other projects having the same project type).
A similar configuration has to be done for all projects which are integrated with QMetry.
4. To sync the data of already linked Jira project, go to Projects > Project / Release / Cycle from QMetry. Open the Project > Integration tab. Click the Sync button against your Jira Project to sync the requirements and issues from Jira.
A. Sync All : Enabling this check-box and clicking the sync will sync complete data between QMetry and Jira (syncing all the Jira assets to QMetry).
B. Sync : Clicking on the sync button without enabling the Sync All check-box would just sync the updated assets from Jira. "Sync" option should be used when there are structural changes made in Jira like adding new fields, updating of the existing fields in Jira layouts, or when the QMetry-Jira integration was stuck or broken due to some reason.