Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printablefalse

Xray Test Management Overview

Xray app allows users to manage all tests as Jira issues, monitor

tests

test coverage, and

analyse

analyze test statuses. When building Jira reporting in BI software such as Microsoft Power BI, it is important to have this data to bring consistency

in

to business analytics.

note
Table of Contents
minLevel1
maxLevel7

The main part of Xray integration is already done, but our developers are still working on adding new Xray data, which will be released very soon.

Power BI Connector for Jira

Cloud

allows

to export

exporting Xray app data easily from Jira to Microsoft Power BI.

Info

Xray Test Management Fields can be found in a separate tab

:

TestRunStepDefects

TEST_RUN_STEP_ID

ISSUE_ID

TestRunStepEvidences

TEST_RUN_STEP_ID

NAME

SIZE

CREATED

TestRunCustomFields

TEST_RUN_ID

FIELD_NAME

FIELD_TYPE

FIELD_VALUE

TestRunIterations

ITERATION_ID

TEST_RUN_ID

STATUS

DEFAULT_STEP_STATUS

NUMBER_STEPS

LAST_MODIFIED_DATE

TestRunIteratuionParameterList

ITERATION_ID

PARAMETER_NAME

PARAMETER_VALUE

TestRunIterationSteps

ITERATION_ID

ITERATION_STEP_ID

STATUS

ACTUAL_RESULT

COMMENT

TestRunIterationStepDefects

ITERATION_STEP_ID

ISSUE_ID

TestRunIterationStepEvidences

ITERATION_STEP_ID

NAME

SIZE

CREATED

.

Image Removed

Overview

Test Specification includes the following concepts: Tests, Preconditions, TestSets, TestPlans, TestExecutions. These are, in general, Jira issues with the corresponding IssueType. Thus, they can contain all Jira fields, including custom fields.

Test Execution includes TestRuns. TestRun contains a snapshot of the test data at its execution time (as the test specification may change in the future).

The Xray plugin adds 3 custom fields: StartDate, EndDate, Revision.

They are mostly used during TestExecution and mean when to start executing tests and documentation version. Also, in the tests context, such standard Jira fields as Summary, Description, Assignee, FixVersions, Components, issue links, etc. These fields may be of interest for reports and dashboards, and are recommended to be included into the datasource. They can be found here:

Jira Work Management ->Issues -> IssueComponents, IssueFixVersions, IssueLinks, CustomFields

Xray - Test Specification Fields

Tests

TEST_ISSUE_ID

TYPE_ID

GENERIC

CUCUMBER(GHERKIN)

CUCUMBER_TYPE(GHERKIN_TYPE)

LAST_MODIFIED_DATE

Preconditions

PRECONDITION_ISSUE_ID

TYPE_ID

MANUAL

GENERIC

CUCUMBER(GHERKIN)

LAST_MODIFIED_DATE

TestPreconditions

TEST_ISSUE_ID

PRECONDITION_ISSUE_ID

TestSteps

TEST_ISSUE_ID

STEP_ID

ACTION

DATA

RESULT

CALL_TEST_ISSUE_ID

CustomStepFields

TEST_ISSUE_ID

STEP_ID

FIELD_NAME

FIELD_VALUE

StepAttachments

STEP_ID

ATTACHMENT_NAME

TestSets

TEST_ISSUE_ID

ISSUE_ID

TestPlans

TEST_ISSUE_ID

ISSUE_ID

TestExecutionPlans

TEST_EXECUTION_ISSUE_ID

ISSUE_ID

TestExecutionEnvironments

TEST_EXECUTION_ISSUE_ID

ENVIRONMENT_NAME

Datasets

DATASET_ID

TEST_ISSUE_ID

TEST_EXECUTION_ISSUE_ID

ITERATIONS_COUNT

LAST_MODIFIED_DATE

DatasetParameters

DATASET_ID

PARAMETER_ID

PARAMETER_NAME

TYPE

IS_COMBINATIONS

DatasetParameterValues

DATASET_ID

PARAMETER_ID

PARAMETER_NAME

PARAMETER_VALUE

Xray - Test Execution Fields

TestRuns

TEST_RUN_ID

TEST_EXECUTION_ISSUE_ID

TEST_ISSUE_ID

STARTED_DATE

FINISHED_DATE

EXECUTED_BY

COMMENT

STATUS

INVALID_STEP_ERROR

TYPE_ID

GENERIC

CUCUMBER(GHERKIN)

CUCUMBER_TYPE(GHERKIN_TYPE)

LAST_MODIFIED_DATE

TestRunDefects

TEST_RUN_ID

ISSUE_ID

 TestRunPreconditions

TEST_RUN_ID

PRECONDITION_ISSUE_ID

DEFINITION

TestRunEvidences

TEST_RUN_ID

NAME

SIZE

CREATED

TestRunExamples

EXAMPLE_ID

STATUS

DURATION

TestRunSteps

TEST_RUN_ID

TEST_RUN_STEP_ID

ORDER

ACTION

DATA

RESULT

CALL_TEST_ISSUE_ID

STATUS

COMMENT

ACTUAL_RESULT

Xray.gifImage Added

How to Add Xray Client ID

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.

Image Added

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

Image Added

  1. Select Create API Key.

The Create API Key pop-up window will appear.

Image Added

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

Image Added

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

Image Added

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

Image Added

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

Image Added

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

Image Added

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

Image Added

Tip

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

Image Added