---
title: "Getting Started"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44566361/Getting%20Started"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

## Overview

Xray turns quality into measurable business impact by unifying the entire Testing lifecycle, from [Requirements](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565368) to [Reports](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44566291) - directly inside Jira. Xray relies extensively on Jira Work items, so you’ll use Xray similarly to how you already use Jira.

Throughout this *Getting Started* page, you will learn what the best-practice, end-to-end process would look like in Xray. Treat this page as your high-level onboarding map to the “treasures” inside the tool and in other sections of our documentation. We recommend going through this *Getting Started* page and section before exploring each stage in-depth. 

We can break the Xray process down into two phases: Prepare and Perform (Figure 1). 

![Figure 1 - Overall Xray process](media://ebffef53-6b8a-4a14-bca0-5ae1a7ec86d8)

> ℹ️ You can also check out <u>[the Xray Academy](https://academy.getxray.app/)</u> and/or these pages:
> ℹ️ 
> ℹ️ - <u>[Quick Setup](https://xray.navattic.com/ql2o07vs)</u>
> ℹ️ - <u>[Xray Basics](https://xray.navattic.com/e3400frn)</u>
> ℹ️ - <u>[AI Test Case Generation](https://xray.navattic.com/pcm0pim)</u>
> ℹ️ - <u>[Test Case Designer Basics](https://xray.navattic.com/v71t053l)</u>
> ℹ️ - <u>[AI Test Model Generation](https://xray.navattic.com/mwl0sej)</u>

# Operations

## Preparing

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Familiarize yourself with different versions of Xray <u>[here](https://docs.getxray.app/space/XRAYCLOUD/393183414/App+Editions)</u> and follow the <u>[installation steps](https://docs.getxray.app/space/XRAYCLOUD/44566344/Installation)</u> for the one you choose. Before you proceed to the Setup, it is a good idea to review [Xray Terminology and UI guidance](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44566802) to better understand the tool basics and the instructions throughout the Xray documentation.
> 
> > Macro (rw-step)
> 
> There are a lot of settings you could tweak in Xray, but here we are going to focus on the <u>[Quick Setup](https://docs.getxray.app/space/XRAYCLOUD/44565860/Quick+Setup)</u>. In QA, a key feature is the association between Tests and Requirements or Defects, which helps you track your current Release status. Xray can validate any Work item type, including Bugs, as long as they are configured as coverable entities (i.e., as "requirements," according to the configuration in the <u>[Quick Setup instructions](https://docs.getxray.app/space/XRAYCLOUD/44565860)</u>).
> 
> > Macro (rw-step)
> 
> Explore the full variety of [Global](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565853) and [Space settings](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44567037) in <u>[Administration & Configuration](https://docs.getxray.app/space/XRAYCLOUD/44565797)</u>.
> 
> > ℹ️ **Migrations**
> > ℹ️ 
> > ℹ️ - If you are migrating from Xray DC to Xray Cloud, please check <u>[this documentation section](https://docs.getxray.app/space/XRAYCLOUD/392855911/Migration)</u>.
> > ℹ️ - If you are migrating from another Test management tool, Xray has several nuances that may not translate intuitively. So, in addition to the general best practices in the *Getting Started* section and other areas of documentation, you should consider <u>[the import capabilities](https://docs.getxray.app/space/XRAYCLOUD/44565062/Importing+Tests+using+Test+Case+Importer)</u>, <u>[APIs](https://docs.getxray.app/space/XRAYCLOUD/44574479/API)</u>, and <u>[migration tutorials](https://docs.getxray.app/space/XRAYCLOUD/44565782/TTT+-+Migration)</u>.

## Performing

Before creating a lot of Xray entities, we recommend establishing an efficient and repeatable process. What exactly that entails is up to you, because Xray is flexible. Taking advantage of Jira features (thanks to Xray nativeness) is often key.

A few considerations:

- Xray can be adapted to <u>[different Space scenarios](https://docs.getxray.app/space/XRAYCLOUD/44566397)</u>, whether you manage Requirements and Tests within the same Space or separately.
- Xray leverages Jira features for <u>[configuring the layout of the Work items](https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-layout/)</u>.
- Xray also uses Jira Workflow features, providing <u>[configurations specifically for that purpose](https://docs.getxray.app/space/XRAYCLOUD/44566331)</u>. You can check the <u>*[Using Jira workflows for Testing purposes](https://docs.getxray.app/space/XRAYCLOUD/44567832)*</u> page for more info.

> ℹ️ **More Resources**
> ℹ️ 
> ℹ️ - <u>[How to implement QA in your projects](https://docs.getxray.app/space/XRAYCLOUD/44565291)</u>
> ℹ️ - <u>[Xray Governance course](https://academy.getxray.app/plus/catalog/courses/167)</u>

With the *Preparing* stage completed and the optimal QA process determined, you are good to go with the asset creation. You will start by specifying the <u>[Requirements](https://docs.getxray.app/space/XRAYCLOUD/44577575/Covering+with+Tests)</u> for your Space (aligned with the Quick Setup selections). Normally, these Requirements will need to be reviewed by stakeholders. Once approved, you are able to start <u>[writing](https://docs.getxray.app/space/XRAYCLOUD/44565047)</u>, <u>[organizing](https://docs.getxray.app/space/XRAYCLOUD/44566566)</u>, and <u>[planning](https://docs.getxray.app/space/XRAYCLOUD/44565044)</u> your <u>[Tests](https://docs.getxray.app/space/XRAYCLOUD/44565156)</u> (Figure 2).

![Figure 2 - Xray process stages](media://dd86f93e-9321-4509-93f9-99cb95ed62b6)

### Writing Tests

Xray serves as the central point to manage all your Testing efforts regardless of types or frameworks. Xray supports manual, automated, and/or [exploratory Tests](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/74350879), whether they are aimed at software or hardware, functional or non-functional Requirements.

A full Test specification may be done using just a <u>[Test](https://docs.getxray.app/space/XRAYCLOUD/44565156)</u> Work item, where you specify the [Test Steps](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565316) and the expected results. Sometimes, you may prefer to abstract the initial conditions instead of writing them directly as the first Test steps, enabling you to use them in different tests. In this case, you may create one or more <u>[Precondition](https://docs.getxray.app/space/XRAYCLOUD/44565159)</u> Work items and associate them with a Test.

When you create Tests, you will also <u>[associate](https://docs.getxray.app/space/XRAYCLOUD/44577575/Covering+with+Tests)</u> each Test with the Requirement(s) it validates. This association is essential for calculating Requirement coverage and generating the necessary <u>[reports](https://docs.getxray.app/space/XRAYCLOUD/338526916)</u>.

> ✅ You can start simple, but keep in mind the efficiency features (such as <u>[Modular](https://docs.getxray.app/space/XRAYCLOUD/44578265/Modular+Tests)</u> or <u>[Parameterized](https://docs.getxray.app/space/XRAYCLOUD/44566351/Parameterized+Tests)</u> Tests) as your Test suite grows.

### Organizing Tests

Xray provides versatile options for <u>[organizing](https://docs.getxray.app/space/XRAYCLOUD/44566566)</u> Testing assets into flat lists using <u>[Test Set](https://docs.getxray.app/space/XRAYCLOUD/44565163)</u> Work items or folders using the <u>[Test Repository](https://docs.getxray.app/space/XRAYCLOUD/44565166)</u>. 

### Planning Tests

Your planning approach may be more or less formal, but you will probably end up using Xray <u>[Test Plans](https://docs.getxray.app/space/XRAYCLOUD/44565153/Test+Plan)</u>. By creating a Test Plan (or multiple) with the relevant Tests for your release, you will be able to immediately track the status of those Tests (and the associated Requirements) across multiple executions.

> ℹ️ <u>[Tips for organizing and planning Tests](https://docs.getxray.app/space/XRAYCLOUD/659259394/Tips+for+Organizing+&+Planning+Tests)</u>

### Executing Tests

From that Test Plan or directly from Jira, you will <u>[schedule, assign, and execute Tests](https://docs.getxray.app/space/XRAYCLOUD/44565037)</u> by creating one or more Test Executions. Some of those Tests might fail, so you will end up creating new or cloning existing Test Execution(s) until you have all your Requirements fully validated. A <u>[Sub-Test Execution](https://docs.getxray.app/space/XRAYCLOUD/44565114)</u> is similar to a Test Execution, but is created as a sub-task of a Requirement.

It is **very important to understand** that a Test Execution automatically creates an instance of a Test called <u>[Test Run](https://docs.getxray.app/space/XRAYCLOUD/44565109)</u>. Therefore, you generally don’t need to clone the Tests themselves and should avoid it as much as possible.

Putting the pieces together, you can arrive at the final state that could look like this (Figure 3; you can also review the <u>[Entity Relationship Diagram](https://docs.getxray.app/space/XRAYCLOUD/44566802/Terminology#Entity-Relationship-Diagram)</u>):

![Figure 3 - Xray entities](media://d55b3aae-44f2-42a2-b5b5-322c842ec899)

### Reports & Analysis

Xray provides <u>[multiple ways to gather QA-related metrics](https://docs.getxray.app/space/XRAYCLOUD/44566291)</u> from your Space so that when you decide to release, it will be a substantiated decision. Some of the popular options are:

- Consulting the specific panels of Requirements/Test Plans/Test Executions.
- Using the <u>[Reporting Center](https://docs.getxray.app/space/XRAYCLOUD/338526916)</u>.
- Building dashboards using <u>[gadgets](https://docs.getxray.app/space/XRAYCLOUD/44566250)</u>.
- Utilizing the <u>[Xporter app](https://docs.getxray.app/space/XRAYCLOUD/44565148)</u> or <u>[Document Generator templates](https://docs.getxray.app/space/XRAYCLOUD/44565169)</u> if you want fully customized reports as DOCX, XLSX, or PDF assets.

> ℹ️ [Xray FAQs](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44566412)


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).
</details>