Versions Compared

Old Version 3

changes.mady.by.user Melanie Castro

Saved on

compared with

New Version Current

changes.mady.by.user Sofia Canario

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleNew Jira UI - 2025

Jira is updating the UI until summer 2025, in case you already have the new UI please check this article :  [Xray Cloud] How can I Setup Xray with the New Jira UI (2025)?

UI Expand
titleTable of Contents

Table of Contents

Introduction

Before you start: 

When setting up Xray, you may need the input from the testingyour Testing/QA team about usage and preferences. 

We recommend you discuss the following points before you begin to configure Xray: 

  • Which entities must be considered as requirements Requirements and defectsDefects?
  • What is the correct project organization for the team? Should there be Tests and Requirements in the same project or in separate projects?

...

Info

...

QA Guide for Managers

Configuration

Requirements and Defects

Requirements

Configure Requirements & Defects

First, you need to set which

...

Issue Types are going to be considered Requirements and Defects. This is done at the project level

...

1. Access your Project Settings > Xray Settings > Test Coverage

Image Removed

Perform the desired mapping and click "Save."

...

.

...

Image Removed

Perform the desired mapping and click "Save."

Requirements can be covered by Tests, and are the expected results for the system. They don't have to be requirements in a strict sense, but we use this term to simplify the explanation.

Examples: Requirement, Story, Epic, Feature, Improvement

and others.

, etc.

Info
titleInfo
UI Steps
UI Step

On your Jira Cloud instance, go to your Project Settings, then enter Xray Settings and select Test Coverage (Figure 1 - 1).

UI Step

Perform the desired mapping by dragging the items you want from the Available Issue Types column (Figure 1 - 2) and dropping on the Covered Issue Types column (Figure 1 - 3).

Once you're done, click Save (Figure 1 - 4). 

Figure 1 - CoverageImage Added

Figure 1 - Coverage

Defects

Info

Defects are identified during

Tests

Test Executions

,

and represent a condition in the system that does not meet the

requirement

Requirement or end

-

user's expectations.

Examples: Defect, Bug, Fault, etc.

UI Steps
UI Step
and others

On your Jira Cloud instance, go to your Project Settings, then enter Xray Settings and select Defect Mapping (Figure 2 - 1)

.

Add
UI Step

Perform the desired mapping by dragging the items you want from the Available Issue Types column (Figure 2 - 2) to the Defect Issue Types column (Figure 2 - 3).

Once you're finished, click Save (Figure 2 - 4).

Figure 2 - Defect mappingImage Added

Figure 2 - Defect mapping

Adding Xray Issue Types to your

...

Schemes

You may want to include Xray Issue Types (such as Test, Test Plan, Test Set, Test

...

Execution) to your already created Issue Type Schemes and Issue Type Screen Schemes. 

UI Steps
UI Step

On your Jira Cloud instance, go to your Project Settings, then, under Apps (Figure 3 - 1) enter Xray Settings (Figure 3 - 2). Select Add Xray Issue Types (Figure 3 - 3) to automatically add the available Issue Types.

Figure 3 - SettingsImage Added

Figure 3 - Settings

1. Access your Project Settings > Xray Settings > Summary and select the Add Xray Issue Types.

Image Removed

Do you want to customize your Xray experience? Review these configuration details. 

Xray is a very flexible tool! Do you want to customize your experience even more? Get together with your
Tip

If you prefer, you can add Xray Issue Types manually. This will give you more flexibility in choosing the

issues types

Issue Types that you want to use.

 

To add issue types manually, you can click on Configure the Issue Type Scheme manually available on the Summary section within the projects settings or access the issue type scheme on Jira settings.

After editing the issue type scheme, you must drag and drop Xray Issue Types: Test, Test Plan, Test Set, Test Execution, Precondition and Sub Test Execution to "Issue Types for Current Scheme" and then click "Save".

Image Removed

         

Tip

For Team-managed Projects you need to create Issue Types manually and then map them with Xray Entities in Xray Settings > Issue Types Mapping. Learn more in "Administrator Onboarding Course."

UI Step

Customizing your Xray Experience - Configuration Details

Get together with your QA team and Xray users and find out how they want to organize their projects

...

: if they want to customize custom fields, workflows, or other settings. 

  •  

    Review Custom Fields for Xray Issue Types -

...

  • check if you need extra custom fields in your Test Issue Types. 

  •  Review Test Steps Fields -

...

  • see if you need to add extra info to

...

  • the Test Steps. By default, Xray has fields like Action, Data, and Expected Results. 
  •  

    Review Test Run Fields -

...

  • check if you need to add extra info to

...

...

  • see if you need any extra Test Types.
  •  Create Test Environments -

...

  • check if your teams needs to create Test Environments.
  •  Review Test Status -

...

  • see if you want to add any extra Test Status. 
  •  Review Test Step Status -

...

  • check if you want to add any extra Test Step Status.
  •  Review Workflows -

...

  • see if you need to have a custom workflow for each Xray Issue

...

  • Types, such as Test. 
  •  Review Permissions -

...

  • check if

...

  • Permissions are set according to your team's needs.
Info

Explore more

in 

in the Administrator Onboarding Course.


Expand
titleSupport/Troubleshooting

If you have questions or technical issues, please contact the Support team via the Customer Portal (Jira service management) or send us a message using the in-app chat.