Xray Test Management for Jira

1 Xray Test Management Overview
2 How to Add Xray Client ID
3 Xray Tables Filtering

Xray Test Management Overview

Xray app allows users to manage all tests as Jira issues, monitor test coverage, and analyze test statuses. When building Jira reporting in BI software such as SQL databases, it is important to have this data to bring consistency to business analytics.

SQL Connector for Jira allows exporting Xray app data easily from Jira to SQL databases.

Xray Test Management fields can be found in a separate tab.

How to Add Xray Client ID

Xray Client ID is required to export Xray data.

Being signed in to your Jira Cloud instance, select Apps, and then select Manage your apps.

Scroll down, and then select API Keys (under the XRAY section).

Select Create API Key.

The Create API Key pop-up window will appear.

Enter your name or the name of the desired user, and then select Generate.

The API Key was successfully generated pop-up window will appear.

Copy Client Id and Client Secret, and then select Close.

Go back to Apps, and then select SQL Connector for Jira.

On the left-side menu, select API Integrations, and then select the Xray tab.

In the Client Id* and Client Secret* fields, paste your client ID and client secret respectively, and then select Validate & Save.

Starting now, all users with granted permission to work with the data sources can select Xray tables and fields for export.

Xray Tables Filtering

SQL Connector for Jira Cloud offers GLOBAL and LOCAL filters:

MODIFIED FROM
TEST TYPE
TESTS
TEST EXECUTIONS
TEST RUN ASSIGNEES

If you apply the MODIFIED FROMfilter, it will be applied to all Xray tables. If the filter is not needed for a specific table, you can deselect it individually for each table.

There are also JQL and Basic filters available to apply. Unlike the MODIFIED FROM filter, JQL and Basic filters are applied to the Jira issue itself. The MODIFIED FROMfilter is applied to Xray fields.

The JQL and Basic filters are only applied to the following tables:

Tests
Test Steps
Preconditions
Test Preconditions
Test Set Tests
Test Plan Tests
Test Plan Executions
Test Plan Folders
Test Execution Tests
Test Execution Environment
Test Step Attachment

As per linking tables, JQL or Basic filter is applied to the main table only. All linking tables are marked with the link icon .

For example, the Test Preconditions table links the Test issue types (Xray tests) and the Precondition issue types. In this case, only the Test issue types will be filtered by JQL or Basic filter. This means you’ll get all the Test issue types that match the specified filter along with their preconditions.

The TEST TYPE filter allows selecting the specific type of tests for export: Manual, Generic, or Cucumber. You can select only one type at once.

The TEST filter allows selecting the specific test(s) for export.

The TEST EXECUTIONS filter allows selecting the specific test execution(s) for export.

The TEST RUN ASSIGNEE filter allows selecting certain test run(s) for export performed by a specific user (assignee).

If you need to export test runs for specific tests, simply select them using the Tests filter.

If the specific tests you need to export are already grouped within a single test execution, just select that test execution using the Test Executions filter. You can select a few test executions.

When selecting a specific test execution in the Test Executions filter, and then selecting tests in the Tests filter that don't belong to the specified test execution, the exported table will be blank as a result.

If you need to export test runs assigned to a specific user, select their name in the Test Run Assignees filter. You can select a few assignees.

When selecting a specific assignee’s name in the Test Run Assignees filter, and then selecting tests in the Tests filter, the exported table will be blank as a result (the same logic is applied for selecting test executions).