Back to QMetry All Products Help Page
Map Jira projects, Issue type and Fields with QMetry Project
- 1 Overview
- 2 Prerequisites
- 3 Mapping Jira Projects to QMetry
- 4 Mapping Jira Work Items to QMetry Modules
- 4.1 Requirement Module
- 4.2 Issue Module
- 5 Select Folder for Import
- 6 Tracking Sync Status
- 7 Manage Synced Folders
- 8 Change Mapping of work items with Requirement Module
- 9 Configure Jira Fields Visibility
- 9.1 Requirement Mapping
- 9.2 Issue Mapping
- 10 View Jira Integration Status
Overview
Integrate QMetry with Jira to use Jira Work Items in QMetry’s Requirements and Issues modules. QMetry maps them at the project level and requires specific permissions.
Get Project Administrator rights to integrate a Jira project with a QMetry project.
Prerequisites
Before you configure Jira integration with QMetry, ensure the following:
You have Project Administrator rights in QMetry.
Jira must be already integrated at the QMetry instance level.
You have valid permissions to access the Jira projects and work items for mapping.
Mapping Jira Projects to QMetry
Map one or more Jira projects to a single QMetry project. QMetry lets you map Jira Work Items to the following modules:
Requirements (e.g., Story, Epic, Task, Risk)
Issues (e.g., Bug, Defect)
QMetry offers flexible mapping options:
Map work items to only Requirement module.
Map work items to only Issue module.
Mapping Work Item to only Requirement module.
Mapping Single Jira Project
Select the Jira project.
Set the Work Items and QMetry Module associations.
Select the Jira project.
Set the Work Items and QMetry Module associations.
Work Item is a multi-select list.
For mapping requirements, select a folder.
Apply JQL filters to customise Jira work items syncing with QMetry Requirements and Issues.
Click Save and Activate.
Saving the Project Mapping
To save a project mapping configuration:
At least one Work Item must be mapped to either the Requirements module or the Issues module.
Unmapping Previously Configured Work Items
When removing Work Items mapped to the Issues module, QMetry updates relevant data according to the platform.
When one or more work item type mapping is removed from the Requirements module, the existing synced work items are converted into Internal Requirements.
When one or more work item type mapping is removed from the Issues module, the existing synced work items are deleted from QMetry along with all associations.
When you remove a work item type mapping from the Requirements module, the existing synced issues are converted into Internal Requirements.
Projects Without Work Item Type Mapping
When a QMetry project is integrated with an external tracker but no Work Items are mapped to the Issues module:
The system disables issue creation and linking options across QMetry (Requirements, Test Cases, Executions, and Exploratory Testing).
The Issues module does not display any issue list or filter options. It displays a message indicating that no Work Items are mapped.
Issue-based dashboards and sections in system reports appears blank.
More about JQL Filters
QMetry allows selective syncing of Jira issues into the Requirements and Issues modules using JQL filters. When JQL criteria change, QMetry ensures that no data loss occurs while still reflecting the updated filter scope.
You can enable the JQL filters only after mapping Work Item Types.
Filtering based on JQL is applicable on both manual and auto-syncing of Jira entities.
The system automatically includes a fixed portion of the JQL based on the selected Project and Work Item Type.
The system restricts adding extra project or work item values to the JQL.
Permissions
Users with integration system modify permissions can change the configuration/mapping.
Users with integration system view permissions can view the configuration/mapping.
When configuring additional filters, ensure that the overall JQL remains valid and properly structured.
Validate the JQL before saving to avoid syntax errors and prevent potential sync failures.
To apply JQL filters, perform these steps:
Go to Projects and select the Integration tab.
Map Jira Work Items with QMetry Modules.
Click the Filter icon to open the Advanced JQL window.
Define JQL query for filtering work items, beyond the default project and work item criteria.
Click Validate to check the query.
Validate the JQL before saving to ensure it is syntactically correct and does not cause sync failure.
QMetry only validates syntax errors. Incorrect parameters or values do not produce an error and may return blank results.
The JQL is defined separately for each Work Item Type integrated with either the Requirement Module or the Issue Module.
Click the copy icon to copy JQL for multiple Work Items.
Click Save and Activate.
The filter icon turns green, and hovering over it shows the applied JQL.
All Jira Work Items matching the JQL criteria are actively synced to QMetry.
When JQL is updated:
Jira Work Items that were previously synced as Requirements in QMetry but no longer meet the updated sync conditions are handled as follows:
Such requirements are flagged with “In JQL/Filter Scope” indicator as No.
Despite falling out of filter scope, they continue to stay in sync with Jira.
Once a Requirement is imported into QMetry, it remains linked to the Jira Work Item and reflects any updates made in Jira.
If a requirement falls back within the filter scope, the “In JQL/Filter Scope” status updates to Yes.
QMetry does not automatically delete requirements that fall out of JQL scope.
Users can filter requirements based on the 'In JQL/Filter Scope' parameters and manually delete them.
When the JQL criteria is modified, Jira Work Items previously synced as Issues in QMetry but no longer meet the updated sync conditions are handled as follows:
Such issues are flagged with “In JQL/Filter Scope” indicator as ‘No’.
Despite falling outside the Filter scope, they continue to stay in sync with Jira.
Once a Issue is imported into QMetry, it remains linked to the Jira Work Item and reflects any updates made in Jira.
Users can manually update the “In JQL/Filter Scope = No” status work items from within QMetry, allowing bi-directional syncing with Jira to continue functioning.
If a issue comes back within the JQL scope in the future, the “In JQL/Filter Scope” sets to Yes.
QMetry does not automatically delete issues that fall out of JQL scope.
Users can filter issues marked as 'In JQL/Filter Scope = No' and manually delete them.
Handling First Time Sync using Additional JQL Filter
When syncing work items as Requirements or Issues for the first time, QMetry only syncs Jira work items that meet the defined JQL filter (sync scope).
Handling Existing Synced Work Items After JQL or Issue Updates
If an already-synced Jira work item no longer meets the JQL filter due to updates in Jira or changes to the JQL in QMetry, QMetry adjusts its sync behaviour based on the updated scope.
Scenario | In JQL / Filter Scope? | What QMetry Does (Requirements vs. Issues) |
|---|---|---|
Mapping removed | No | Requirements: Previously synced removed types are converted to Internal Requirements. Issues: Previously synced removed types are deleted. |
JQL updated – Previously synced items no longer match filter | No | Requirements: Retains the Requirements and displays Jira details in read-only mode. Items continue syncing and QMetry fields remain editable but cannot add comments or attachments. Issues: Retains the issues and continues sync. QMetry and Jira fields remain editable can add comments or attachments. Note: User can filter, bulk delete, move and archive items for both requirements and issues. |
JQL updated – Item comes back into scope | Yes | Existing entity is reused if Jira Key matches. New items get new Requirement/Issue keys. |
Change component in Jira → component removed | No | Same as Previously synced items no longer match filter |
Change component in Jira replaced with Component 2 | No | Same as Previously synced items no longer match filter |
Add Component 2 while keeping Component 1 | Yes | Normal syncing for both modules; both components shown. |
Component changed from QMetry side (Issue module only) | No | Updates are applied and work items sync in Jira. |
Component change via Jira | No | Same as Previously synced items no longer match filter |
Work items that no longer meet the JQL criteria displays “In JQL/Filter Scope = No.”
The system retains items linked to Jira and continues syncing updates.
For the requirement module, Jira fields are read only.
For the issue module, Jira fields are editable.
QMetry preserves existing traceability links to test cases, issues, or other requirements.
When work item returns to the JQL scope, the system updates “In JQL/Filter Scope” with Yes.
The system does not auto-delete work items.
Filter and manually delete items that are no longer relevant.
Deleting only removes the item from QMetry; they remain unchanged in Jira.
If a previously out-of-scope item once again matches the JQL:
QMetry automatically switches its status back to In JQL/Filter Scope = yes
Sync continues normally
Mapping Multiple Jira Projects
To map multiple Jira projects with a QMetry project, perform the following steps:
Go to Project Management and select Projects.
Select the Project and go to Jira Integration tab.
Select the Jira URL to map with the QMetry project.
Select the Jira Project to configure with QMetry Project.
Map Jira Work Items to QMetry Modules.
Map Multiple Jira Instances
To map Jira instances with a QMetry project, perform the following steps:
Go to Project Management and select Projects.
Select the relevant project and open the Integration tab.
Under Select Integration Type, choose Jira.
From the Jira Instance List, select the Jira URL you want to configure.
In the Map QMetry and Jira section:
Select the Jira Project from the dropdown.
Map the Jira Work Items to a QMetry Module.
If mapping to the Requirement module, select the Folder where the issues should be imported.
Click Save & Activate.
To map another Jira instance:
Click Select Jira Instance, then choose a different Jira URL from the list.
Repeat steps 5 to 6 for the new instance.
Mapping Jira Work Items to QMetry Modules
Once you select the Jira instance and Project, you can map the Jira Work Items with specific QMetry Modules.
Requirement Module
If you manage requirements in Jira as Epics, Stories, or Sub-tasks, select these work items to link them to the Requirement module.
You can select and map multiple work items under the Jira Work Items.
Folder Selection is mandatory:
Select a folder in QMetry to import the Jira work items into.
The first sync imports all work items into the selected folder.
You can later move these work items to other folders in QMetry.
QMetry syncs all new stories and epics into the selected folder.
Issue Module
To sync Jira bugs or tasks, map the Jira work items to the QMetry Issue module.
This is also a multi-select configuration.
An work items can be mapped to either the Requirement module or Issue module, but not both.
Work items synced from Jira appear in QMetry’s Issue module with an external key referencing the Jira Work Item Key.
Once you have mapped the Jira work items with QMetry modules, click Save and Activate. For existing Jira integration, click Update.
Select Folder for Import
The Project Admin must select a folder during Jira configuration to import requirements into QMetry.
Admins can change the selected import folder at any time. When the folder is changed:
Only newly synced requirements are imported into the newly selected folder.
Previously imported requirements remain in their existing folders.
Tracking Sync Status
To monitor the sync status, perform the following steps:
In the left pane, select Integration.
Click on Integrations.
Choose Integration Scheduler Status.
View the sync status for Requirements, Issues, and Metadata.
Click the + icon to expand and see detailed sync information.
Tracking Jira Epics and Sub-tasks in QMetry
You can import Jira Epics and Sub-tasks as either Requirements or Issues, while maintaining their parent-child relationships and key metadata.
Importing Jira Sub-tasks
You can import Jira Sub-tasks into QMetry as Requirements or Issues.
After import, their details appear in the Sub-tasks Issues tab.
The sub-task issue detail's view includes a parent key for traceability to its parent Jira entity.
Read about Sub-task Traceability.
Importing Jira Epics
You can import Epics in QMetry as Requirements or Issues.
The system supports Epic Fields like Epic Link, Epic Status, Epic Color, and Epic Name and shows them in the Jira Details section.
You can view Issues that are part of these Epics in the "Issues in Epic" tab.
Viewing Issues Linked to Epics
Issues linked to the Epic appear in the Issues in Epic tab.
To display these issues in QMetry:
You must integrate these Jira work items with the QMetry project.
You must sync these issues with QMetry.
Each linked issue includes an Epic Link field that traces it back to the Epic.
Read about Epic Traceability.
Manage Synced Folders
You can change, copy, move, archive or delete the synced folder.
Copy or Move the Synced Folder
When you copy or move the synced folder, the system moves the folder to the new location and updates the folder mapping on the Project screen.
Archive Folder
Folders that contain externally synced entities (e.g., from Jira) cannot be archived.
You can move the imported requirements to other folders and then archive the folder.
The system restricts archiving the folder chosen during Jira integration.
During bulk archive, the system skips folders that contain external entities. It also skips their subfolders, even if those subfolders don’t have external entities.
Also Read: Auto-organize Imported Requirements
Change Mapping of work items with Requirement Module
Scenario 1. work items mapped with Requirement is replaced with another work items
Issues synced based on the earlier mapping will be converted into internal issues and they will no longer be Jira issues.
New issues will be synced as requirements as per the changed work items.
Scenario 2. In addition to the existing work items, another work items is mapped with the Requirement
Issues synced based on the earlier mapping will remain intact as Jira issues.
New issues will be synced as requirements as per the added work items.
Configure Jira Fields Visibility
QMetry displays default Jira Issue fields in its modules. Project admins can configure additional Jira system and custom fields separately for each Jira project and work items.
Admins can sync only the required Jira system fields into QMetry, rather than syncing all fields:
Project admins can deactivate syncing for specific Jira System Fields within QMetry Requirements and Issues for selected Jira work items.
Project admins can configure separate Jira Issue fields for viewing issue details in QMetry and creating issues from QMetry when configuring Jira work items as QMetry Issues.
The system supports the following Jira field types:
Number
Date
Date and Time
Single line
Multiline
Multi-Look-Up Option
Single Look-Up Option
User picker
Multi-user picker
Select Cascading List
Version picker
Multi-version picker
Note
If a Jira field does not appear on the Configuration screen in QMetry, click Sync to refresh the project data and enable field configuration.
To Sync Jira Project data with QMetry projects, perform the following steps:
Configure custom fields for Requirements and Issues.
Sync Jira data to QMetry. For example, newly created custom fields, etc.
Sync All: It will sync all issues irrespective of their updated date.
Sync: It will sync only those issue values that are recently updated in Jira based on their updated date.
Requirement Mapping
While mapping a Jira work items to QMetry Requirements, project admins can choose which Jira fields (system or custom) to show or hide on the Requirements screen.
They can also disable syncing for specific Jira system fields like Description, Component, Fix Version, Priority, Labels, and Attachments for selected work items.
Some Jira fields are always visible and cannot be hidden. These include Summary, work items, External Key, External Project, Created Date, Updated Date, Resolved Date, and Reporter.
Admins can select which Jira fields to map and display in QMetry Requirements. By default, Jira system fields and mandatory custom fields are pre-selected. Admins can choose to retain or deselect fields that do not need to be synced. Field mapping also determines how fields appear in hierarchical structures.
For cascading list fields:
If the field is mandatory in Jira, QMetry does not auto-map it. Admins must map it manually with view-only access.
If the field is optional, admins can decide whether to map it or leave it unmapped.
Click Save once you are done selecting or deselecting the Jira fields.
Issue Mapping
When mapping a Jira work items to the QMetry Issue module, project admins can control the visibility and usage of Jira fields by setting the View and Create permissions.
Field Permissions
View: Displays the selected Jira field on the Issue List and Issue Detail screens.
Create: Displays the selected Jira field on the Create Issue screen in QMetry.
Note
If the Description field is deselected, QMetry does not auto-populate the issue description with reproduction steps when you create an issue from the Execution screen.
If both View and Create permissions are disabled for a field, users cannot see the field on the asset details page. The module list view will display “Not mapped for syncing” in place of the field.
Cascading List Fields
If a cascading list field is marked as mandatory in Jira, QMetry auto-maps it to the Issue module with full access (view, create, and edit). Project admins can unmap it if necessary.
If the field is optional in Jira, project admins can decide whether or not to map it in QMetry.
After setting the required permissions for the Jira fields, click Save to apply the configuration.
Display of Issue fields in Jira and QMetry
In Jira, all fields remain visible regardless of the field configuration settings in QMetry. In QMetry, the project admin can customize the field visibility based on project requirements.
Jira system fields will be visible in the reports irrespective of the configuration of the Jira system field in QMetry. It means the Jira system fields will still be visible in the reports even if that system field is not selected in the work items configuration.
You can sync the mapped Jira custom fields in the QMetry Insight module for Visual Reports and Advanced Query Reports. Read more about Sync Fields to Reports.
Notes
The project admin must configure at least one of the Jira Projects with the Issue Module.
Once Jira is integrated with the QMetry project, the internal issue module is no longer available.
You can view the status under the Integration Scheduler Status tab under Integration > Integrations.
View Jira Integration Status
Users can view all the integrated Jira instances, their associated QMetry projects, and their current status either "Active" or "Inactive".
The Integration tab gives you a quick update on the integration status of Jira and QMetry projects.
To view Jira Integration Status, perform the following steps:
Expand Integration on the sidebar menu and select Jira Integrations.
Open the Integration tab.
Back to QMetry All Products Help Page