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.

Xray.gif

How to Add Xray Client ID

note

Xray Client ID is required to export Xray data.

Xray Client ID is required to export Xray data.

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

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

  1. Select Create API Key.

note

The Create API Key pop-up window will appear.

The Create API Key pop-up window will appear.

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

note

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

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

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

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

  1. On the left-side menu, select Tokens, and then select the Xray tab.

  1. 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 and filters:

Global and Local Filters.gif

If you apply the filter, 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.

Modified from.gif

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

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

  • Tests

  • Test Steps

  • Preconditions

  • Test Preconditions (blue star)

  • Test Set Tests (blue star)

  • Test Plan Tests (blue star)

  • Test Plan Executions (blue star)

  • Test Plan Folders

  • Test Execution Tests

  • Test Execution Environment

  • Test Step Attachment

Filter Options.gif

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

For example, the Test Preconditions (blue star) 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 filter allows selecting the specific type of tests for export: Manual, Generic, or Cucumber. You can select only one type at once.

Test Type.gif

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

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

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

Local Filters.gif

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

Tests.gif

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.

Tests Executions.gif

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).

Test Run Assignee.gif