Page tree

This is the documentation of Xray Server. If you are looking for Xray Cloud, visit this page. Documentation of older versions of Xray Server is available in this page.

Skip to end of metadata
Go to start of metadata

When you purchase or try Xray, often you already have one or more projects you're working on and you want to test. This following guides you through the steps that must be done in order to configure an existing project, whether you have a vanilla Project or a highly customized one.


When you create a project in Jira, this is most likely the screen you see in the Project Administration page. In order to enable the Xray components, you must configure the correct project schemes using this page.


You have two options to configure an existing project for Testing with Xray:

  1. Adding Default Xray Schemes to the Project

  2. Modifying your Current Project Schemes

Adding Default Xray Schemes to the Project

Xray provides default configuration schemes that you can directly associate with your project. You can customize these default Xray schemes but keep in mind that any change will affect all projects that are using these schemes. One advantage of creating a new Test Project using the Xray project template is that it will create dedicated schemes for the project being created.

Issue Type Scheme

One way to set Xray as part of your project is to simply replace the Project Specific Issue Type Scheme with Default Issue Type Scheme, where all Xray issue type have been added at installation time. To do this, 

  • Click on the Issue Type Scheme link that is on top of the page. The page below will appear.
  • Click on Actions -> Use a different scheme and choose Default Issue Type Scheme.

Issue Type Screen Scheme

Once the Issue Type Scheme is configured, you have to configure the Issue Type Screen Scheme.  To do this, 

  • Click on the project's Issue Type Screen Scheme link you see below the screen section
  • Click on Actions -> Edit Screens
  • Associate an Issue Type with a Screen Scheme
  • Choose Test for Issue type and Default Xray Test Screen Scheme
  • Repeat this action for Pre-Condition with Default Xray Pre-Condition Screen SchemeTest Plan with Default Xray Test Plan Screen Scheme, Test Execution with Default Xray Test Execution Screen Scheme, and Test Set with Default Xray Test Set Screen Scheme



Your project is now ready to use Xray.


Modify your Current Project Schemes

In case you have highly customized schemes for your projects and you do not want to use the default schemes provided by Xray, you must perform some customizations.

Edit Issue Type Scheme and add Xray Issue Types

You must edit your project's issue type scheme and add the Xray issue types:

  • Click on the Issue Type Scheme link you see on top of the page

  • Click on Edit issue types

  • Add TestTest SetPre-Condition, Test Execution, and Test Plan

Edit Issue Type Screen Scheme

Once the Issue Type Scheme is configured, you have to configure the Issue Type Screen Scheme.  To do this, 

  • Click on the project's Issue Type Screen Scheme link you see below the screen section
  • Click on Actions -> Edit Screens
  • Associate an Issue Type with a Screen Scheme
  • Choose Test for Issue type and Default Xray Test Screen Scheme
  • Repeat this action for Pre-Condition with Default Xray Pre-Condition Screen SchemeTest Plan with Default Xray Test Plan Screen Scheme, Test Execution with Default Xray Test Execution Screen Scheme, and Test Set with Default Xray Test Set Screen Scheme



You project is now ready to use Xray.

Troubleshooting


"I see Xray issue types, but I don't get screens with specific issue type information."



You have configured Issue Type Scheme, but not the Issue Type Screen Scheme.

Follow this tutorial instructions to configure the Issue Type Screen Scheme in your project.

  • No labels