Skip to main content
Planview Customer Success Center

Jira Xray

Overview

Planview Hub offers integration solutions to flow test artifacts such as test results, test steps, and their associated tests, test runs, test instances, and folder structures.

Please review the sections below to learn more about supported test scenarios using Jira Xray.

           

Jira Xray & Microsoft Azure DevOps

In this integration scenario, a tester creates a test case in Jira Xray. Hub will flow the test case, along with its fields and sub-entities to Azure DevOps, so that the tester in Azure DevOps can begin running his tests. Hub will then flow the test results and defects back over to Xray to maintain full visibility across the lifecycle.

Screenshot 2023-10-30 at 4.46.15 PM.png

The goal of this integration scenario is to synchronize the Xray Test Case artifact with the Azure DevOps Test Case artifact, while including the Test Results and Defects from the Azure DevOps artifact. To do this, you'll need to configure the following integrations:

  • Jira Xray Test Plans <> Azure DevOps Test Plans
  • Jira Xray Test Sets <> Azure DevOps Test Suites
  • Jira Xray Tests <> Azure DevOps Test Cases
  • Jira Xray Test Executions -> Azure DevOps Test Runs
  • Jira Xray Test Runs <> Azure DevOps Test Results

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values (if applicable)
Summary Summary String N/A
Description Description Rich Text N/A
Status Status Single Select New, To Do, In Progress, Done
Formatted ID Formatted ID String N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
Location URL Location N/A
None Parents Relationships N/A
None Children Relationships N/A
Parent Artifact Parent Relationship N/A
None Test Coverage Relationships N/A

None

Azure DevOps ID

String

N/A

None

Azure DevOps URL

String

N/A

None

ADO Test Result Status

Single Select

Passed, Warning, Not Executed, Timeout, Failed, Inconclusive, Error, In Progress, Unspecified, Not Applicable, Aborted, None, Blocked, Paused

None Xray ID String N/A
None Xray URL String N/A

 

Xray

You will need to add the following custom fields to your Xray instance:

Name Type
Azure DevOps ID String
Azure DevOps URL String

 

Azure DevOps 

You will need to add the following custom fields to your Azure DevOps instance:

Name Type
Xray ID String
Xray URL String

 

Create your Collections

Xray

For this integration scenario, you'll need to configure the following Xray collections:

Work Item Collections

  • Xray Test Plans
  • Xray Test Sets
  • Xray Tests
  • Xray Test Executions
  • Xray Test Runs

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Test Plans Summary Summary
Description Description
Status Status
Priority Constant Value
Key Xray ID
URL Xray URL

Azure DevOps ID

Azure DevOps ID

Azure DevOps URL

Azure DevOps URL

Xray Test Sets Summary Summary
Description Description
Status Status
Priority Constant Value
Xray Tests Summary Summary
Description Description
Status Status
Key Xray ID
URL Xray URL
Priority Constant Value
Azure DevOps ID Azure DevOps ID
Azure DevOps URL Azure DevOps URL
Xray Test Executions Summary Summary
Priority Constant Value
Azure DevOps ID Azure DevOps ID
Azure DevOps URL Azure DevOps URL
Relationship Specification

Configure the following relationship mappings:

Collection Xray Field Model Field
Xray Test Plans tests Children
Xray Test Sets relates to (in) Parents
Xray Tests Parent Link Parent
Xray Test Executions Test Plan Parents
Xray Test Runs Test Run Test Execution key Parent
Test Run Test key Test Coverage
State Transitions

Configure the following state transition:

Collection Type Field Transition Name From State To State
Xray Test Plans Transition Graph Status Reopen Issue Closed Reopened
Close Issue  In Progress Closed
Resolve Issue In Progress Resolved
Close Issue New Closed
Start Progress New In Progress
Resolve Issue New Resolved
Start Progress Reopened In Progress
Reopen Issue Resolved Reopened
Xray Test Sets Transition Graph Status Start Progress Closed In Progress
Reopen Issue Closed Reopened
Resolve Issue Closed Resolved
Close Issue In Progress Closed
Resolve Issue In Progress Resolved
Close Issue  New Closed
Start Progress New In Progress
Reopen Issue New Reopened
Resolve Issue New Resolved
Close Issue Reopened Closed
Start Progress Reopened In Progress
Resolved Reopened Resolved
Close Issue Resolved Closed
Reopen Issue Resolved Reopened
Xray Tests Transition Graph Status Reopen Issue Closed Reopened
Close Issue In Progress Closed
Resolve Issue In Progress Resolved
Close Issue New Closed
Start Progress New In Progress
Resolve Issue New Resolved
Start Progress Reopened In Progress
Reopen Issue Resolved Reopened

Azure DevOps

For this integration scenario, you'll need to configure the following Azure DevOps collections:

Work Item Collections

  • Azure DevOps Test Plans
  • Azure DevOps Test Suites
  • Azure DevOps Test Cases
  • Azure DevOps Test Runs
  • Azure DevOps Test Results

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following Azure DevOps fields to the model:

Collection Azure DevOps Field Model Field
Azure DevOps Test Plans Title Summary
Description Description
State Status
Xray ID Xray ID
Xray URL Xray URL
Iteration Path Constant Value
Area Path Constant Value
Formatted ID

Azure DevOps ID

URL

Azure DevOps URL

Azure DevOps Test Suites Title Summary
Description Description
State Status
Iteration Path Constant Value
Area Path Constant Value
Azure DevOps Test Cases Title Summary
Description Description
State Status
Xray ID Xray ID
Xray URL Xray URL
Iteration Path Constant Value
Area Constant Value
Formatted ID Azure DevOps ID
URL Azure DevOps URL
Azure DevOps Test Runs Summary Summary
Formatted ID Azure DevOps ID
URL Azure DevOps URL
Azure DevOps Test Results Configuration Constant Value
Relationship Specification

Configure the following relationship mappings:

Collection Xray Field Model Field
Azure DevOps Test Plans Test Case Children
Azure DevOps Test Suites Parent Test Plan Parents
Azure DevOps Test Runs Parent Test Plan Parents
Azure DevOps Test Results Parent Test Run Parent
Parent Test Plan Constant Value
Parent Test Case Test Coverage

Configure your Integrations 

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jira Xray Test Plans <> Azure DevOps Test Plans
  • Jira Xray Test Sets <> Azure DevOps Test Suites
  • Jira Xray Tests <> Azure DevOps Test Cases
  • Jira Xray Test Executions -> Azure DevOps Test Runs
  • Jira Xray Test Runs <> Azure DevOps Test Results

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring
Xray Test Plans <> ADO Test Plans Work Item Synchronization Two-way Creation Xray <> ADO
Xray Test Sets <> ADO Test Suites Work Item Synchronization Two-way Creation Xray <> ADO
Xray Tests <> ADO Test Cases Work Item Synchronization Two-way Creation Xray <> ADO
Xray Test Executions -> ADO Test Runs Work Item Synchronization Two-way Creation Xray <> ADO
Xray Test Runs <> ADO Test Results Work Item Synchronization Two-way Creation Xray <> ADO

Functional Limitations

Category Limitation Applicable Repository Version
Third Party API Limitation

Test Steps

Test steps are not supported in Azure DevOps.

Any supported repository version:

Good to Know

Test Plans

When a Test Plan is created in ADO, a Test Suite is automatically created with the same name. As a result, both the Test Plan and Test Suite integrations will synchronize into Xray.

Any supported repository version:

Third Party API Limitation

Test Results

Test Results cannot be synchronized into ADO because Xray Test Runs do not have relationship options for Parent Test Plans and Parent Test Suites.

Any supported repository version:

 

 

           

           

Jira Xray & Micro Focus ALM/QC

In this integration scenario, Epics and Stories are created in Jira Xray. Hub will flow the Epics and Stories to Micro Focus ALM/QC, so that the tester in ALM can create and begin running tests. Hub will then flow the tests back over to Xray to maintain full visibility across the lifecycle.

Screenshot 2024-05-08 at 12.02.58 PM.png

The goal of this integration scenario is to synchronize the Xray Test artifact with the ALM Test artifact. To do this, you'll need to configure the following integrations:

  • Jira Xray Epics <> ALM Requirement Folders
  • Jira Xray Stories <> ALM Requirements
  • Jira Xray Test Repository Folders <> ALM Test Folders
  • Jira Xray Tests <> ALM Tests

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values (if applicable)
Summary Summary String N/A
Description Description Rich Text N/A
Status Status Single Select New, To Do, In Progress, Done
Formatted ID Formatted ID String N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
Location URL Location N/A
None Parents Relationships N/A
Parent Artifact Parent Relationship N/A

None

ALM ID

String

N/A

None

ALM URL

String

N/A

 

Xray

You will need to add the following custom fields to your Xray instance:

Name Type
ALM ID String
ALM URL String

 

Create your Collections

Xray

For this integration scenario, you'll need to configure the following Xray collections:

Work Item Collections

  • Xray Epics
  • Xray Stories
  • Xray Tests

Container Collections

  • Xray Test Repository Folders

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Epics Summary Summary
Epic Name Summary
Description Description
Created Created
Priority Constant Value
Xray Stories Summary Summary
Description Description
Created Created
Priority Constant Value
Xray Tests Summary Summary
Xray Test Repository Folders Summary Summary
Description Description
Status Status
Created Created
Priority Constant Value
ALM ID ALM ID
ALM URL ALM URL
Relationship Specification

Configure the following relationship mappings:

Collection Xray Field Model Field
Xray Stories Epic Link Parent
Xray Test Repository Folders Parent Folder Parent
Xray Tests Test Sets association with a Test Parents
State Transitions

Configure the following state transition:

Collection Type Field Transition Name From State To State
Xray Tests Transition Graph Status Start Progress New In Progress
Reopen Issue Closed Reopened
Close Issue In Progress Closed
Resolve Issue In Progress Resolved
Close Issue  New Closed
Resolve Issue New Resolved
Start Progress Reopened In Progress
Reopen Issue Resolved Reopened

Micro Focus ALM/QC

For this integration scenario, you'll need to configure the following ALM collections:

Work Item Collections

  • ALM Requirement Folders
  • ALM Requirements
  • ALM Tests

Container Collections

  • ALM Test Folders

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following ALM fields to the model:

Collection ALM Field Model Field
ALM Requirement Folders Name Summary
Description Description
Creation Date Created
ALM Requirements Name Summary
Description Description
Creation Date Created
ALM Tests Name Summary
ALM Test Folders Test Name Summary
Description Description
Status Status
Created Creation Date
Formatted ID ALM ID
URL ALM URL
Relationship Specification

Configure the following relationship mappings:

Collection ALM Field Model Field
ALM Requirements Parent Folder Parent
ALM Test Folders Parent Folder Parent
ALM Tests Requirement Coverage Parents

Configure your Integrations 

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jira Xray Epics <> ALM Requirement Folders
  • Jira Xray Stories <> ALM Requirements
  • Jira Xray Test Repository Folders <> ALM Test Folders
  • Jira Xray Tests <> ALM Tests

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring
Xray Epics <> ALM Requirement Folders Work Item Synchronization Two-way Creation Xray <> ALM
Xray Stories <> ALM Requirements Work Item Synchronization Two-way Creation Xray <> ALM
Xray Test Repository Folders <> ALM Test Folders Container + Work Item Synchronization Two-way Creation Xray <> ALM
Xray Tests <> ALM Tests Work Item Synchronization Two-way Creation Xray <> ALM

Functional Limitations

Category Limitation Applicable Repository Version
Good to Know

Status

The Status field is read-only in Xray.

Any supported repository version:

 

           

           

Jira Xray & Micro Focus ALM Octane

In this integration scenario, Epics and Stories are created in Jira Xray. Hub will flow the Epics and Stories to Micro Focus ALM Octane, so that the tester in ALM Octane can create and begin running tests. Hub will then flow the tests back over to Xray to maintain full visibility across the lifecycle.

Screenshot 2024-05-08 at 4.24.38 PM.png

The goal of this integration scenario is to synchronize the Xray Test artifact with the ALM Octane Test artifact. To do this, you'll need to configure the following integrations:

  • Jira Xray Test Sets <> ALM Octane Test Suites
  • Jira Xray Tests <> ALM Octane Tests
  • Jira Xray Test Executions <> ALM Octane Run Suites

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values (if applicable)
Summary Summary String N/A
Description Description Rich Text N/A
Formatted ID Formatted ID String N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
Location URL Location N/A
None Parents Relationships N/A
None Test Cases Relationships N/A

None

Octane ID

String

N/A

None

Octane URL

String

N/A

Test Steps

Smart Field Label Type Field Values
Action Action String N/A
Expected Result Expected Result String N/A
Id Id String N/A

 

Xray

You will need to add the following custom fields to your Xray instance:

Name Type
Octane ID String
Octane URL String

 

Create your Collections

Xray

For this integration scenario, you'll need to configure the following Xray collections:

Work Item Collections

  • Xray Test Sets
  • Xray Tests
  • Xray Test Executions

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Test Sets Summary Summary
Description Description
Created Created
Priority Constant Value
Xray Tests Summary Summary
Description Description
Octane ID Octane ID
Octane URL Octane URL
Priority Constant Value
Xray Test Executions Summary Summary
Description Description
Octane ID Octane ID
Octane URL Octane URL
Created Created
Priority Constant Value
Test Step Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Tests Test Step Action Action
Expected Result Expected Result
Id Id
Relationship Specification

Configure the following relationship mappings:

Collection Xray Field Model Field
Xray Tests Test Sets association with a Test Parents
Xray Test Executions tests Test Cases

 

Micro Focus ALM Octane

For this integration scenario, you'll need to configure the following Micro Focus ALM Octane collections:

Work Item Collections

  • ALM Octane Test Suites
  • ALM Octane Tests
  • ALM Octane Run Suites

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following ALM Octane fields to the model:

Collection ALM Octane Field Model Field
ALM Octane Test Suites Name Summary
Description Description
Creation time Created
ALM Octane Tests Name Summary
Description Description
Formatted ID Octane ID
URL Octane URL
Phase Constant Value
Application modules Constant Value
ALM Octane Run Suites Name Summary
Description Description
Creation time Created
Formatted ID Octane ID
URL Octane URL
Release Constant Value
Test Step Field Mapping

Map the following ALM Octane fields to the model:

Collection ALM Octane Field Model Field
ALM Octane Tests Description Action
Relationship Specification

Configure the following relationship mappings:

Collection ALM Octane Field Model Field
ALM Octane Tests Backlog Coverage Parents
ALM Octane Run Suites Test Test Cases

Configure your Integrations 

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jira Xray Test Sets <> ALM Octane Test Suites
  • Jira Xray Tests <> ALM Octane Tests
  • Jira Xray Test Executions <> ALM Octane Run Suites

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Test Step Flow Artifact Routing/Container Mirroring
Xray Test Sets <> ALM Octane Test Suites Work Item Synchronization Two-way Creation N/A Xray <> ALM Octane
Xray Tests <> ALM Octane Tests Work Item Synchronization Two-way Creation

One-way Flow

ALM Octane accepts test steps

Xray <> ALM Octane
Xray Test Executions <> ALM Octane Run Suites Work Item Synchronization Two-way Creation N/A Xray <> ALM Octane

 

           

           

Jira Xray & TestRail

In this integration scenario, a tester creates a test case in TestRail. Hub will flow the test case, along with its fields and sub-entities to Xray. Back in TestRail, the tester begins running his tests. Hub will then flow the test results back over to Xray to maintain full visibility across the lifecycle.

Screenshot 2024-05-08 at 1.58.18 PM.png

The goal of this integration scenario is to synchronize the Xray Test Case artifact with the TestRail Test Case artifact, while including the Test Results from the TestRail artifact. To do this, you'll need to configure the following integrations:

  • Jira Xray Test Sets <> TestRail Test Sections
  • Jira Xray Tests <> TestRail Test Cases
  • Jira Xray Test Executions <- TestRail Tests
  • Jira Xray Test Runs <- TestRail Test Results

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values (if applicable)
Summary Summary String N/A
Description Description Rich Text N/A
None Test Status Single Select Untested, Blocked, Failed, Passed, Retest
Formatted ID Formatted ID String N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
Location URL Location N/A
None Parents Relationships N/A
Parent Artifact Parent Relationship N/A

None

Xray ID

String

N/A

None

Xray URL

String

N/A
None TestRail ID String N/A
None TestRail URL String N/A

Test Steps

Smart Field Label Type Field Values
Action Action String N/A
Expected Result Expected Result String N/A
Id Id String N/A

 

Xray

You will need to add the following custom fields to your Xray instance:

Name Type
TestRail ID String
TestRail URL String

 

TestRail

You will need to add the following custom fields to your TestRail instance:

Name Type
Xray ID String
Xray URL String

 

Create your Collections

Xray

For this integration scenario, you'll need to configure the following Xray collections:

Work Item Collections

  • Xray Test Sets
  • Xray Tests
  • Xray Test Executions
  • Xray Test Runs

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Test Sets Summary Summary
Description Description
Priority Constant Value
Xray Tests Summary Summary
Description Description
Key Xray ID
URL Xray URL
Priority Constant Value
TestRail ID TestRail ID
TestRail URL TestRail URL
Xray Test Executions Summary Summary
Priority Constant Value
TestRail ID TestRail ID
TestRail URL TestRail URL
Xray Test Runs Formatted ID Xray ID
Status Test Status
Test Step Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Tests Test Step Action Action
Expected Result Expected Result
Id Id
Relationship Specification

Configure the following relationship mappings:

Collection Xray Field Model Field
Xray Tests Test Sets association with a Test Parents
Xray Test Runs Test Run Test Execution key Parent

TestRail

For this integration scenario, you'll need to configure the following TestRail collections:

Work Item Collections

  • TestRail Test Sections
  • TestRail Test Cases
  • TestRail Tests
  • TestRail Test Results

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Field Mapping

Map the following TestRail fields to the model:

Collection TestRail Field Model Field
TestRail Test Sections Name Summary
Description Description
TestRail Test Cases Title Summary
Preconditions Description
Xray ID Xray ID
Xray URL Xray URL
ID TestRail ID
Location TestRail URL
Priority Constant Value
Case Type Constant Value
Template Constant Value
TestRail Tests Title Summary
ID TestRail ID
Location TestRail URL
Status Constant Value Based on Projects
TestRail Test Results Xray ID Xray ID
Status Test Status
Test Step Field Mapping

Map the following TestRail fields to the model:

Collection TestRail Field Model Field
TestRail Test Cases Step Description Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection TestRail Field Model Field
TestRail Test Cases Section Parents
TestRail Test Results Test Parent

Configure your Integrations 

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jira Xray Test Sets <> TestRail Test Sections
  • Jira Xray Tests <> TestRail Test Cases
  • Jira Xray Test Executions <- TestRail Tests
  • Jira Xray Test Runs <- TestRail Test Results

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing Test Step Flow
Xray Test Sets <> TestRail Test Sections Work Item Synchronization Two-way Creation Xray <> TestRail N/A
Xray Tests <> TestRail Test Cases Work Item Synchronization Two-way Creation Xray <> TestRail

One-way Flow

TestRail accepts test steps

Xray Test Executions <- TestRail Tests Work Item Synchronization

One-way Creation

Xray accepts new artifacts

Xray <- TestRail N/A
Xray Test Runs <- TestRail Test Results Work Item Synchronization Two-way Creation Xray <> TestRail N/A

Functional Limitations

Category Limitation Applicable Repository Version
Configuration Requirement

Test Sections

Test Sections must be specified in order to flow into TestRail.

Any supported repository version:

Good to Know

Test Steps

Test Steps can only flow from Xray to TestRail.

Any supported repository version:

Good to Know

Test Results

Test Results in TestRail are read-only.

Any supported repository version: