Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titlePlease note

If your Jira Cloud UI layout looks like the following screenshot, then it means you're using the "old" Jira UI. You need to switch to the new layout, which you can do in your profile located at the top right-hand corner.

Image Removed

After installing Xray, there are basically a few steps you need to make at the project level.

true
Table of Contents
outline


Note

To enable Xray at the project level, the user needs to have "Browse Projects" permission enabled at the Project Permission Scheme. If you do not have it, please ask help to your Jira Administrator before proceeding.

You can do it for a brand-new project or for an existing one.

If you're not sure where to start, you can create a Demonstration Project with sample data to explore.

These operations can all be done from within Xray Settings available at the project settings page.

Image RemovedImage Added 

Image Added    Image Removed       Image Removed

...

Configure Xray Issue Types

...

in your project

In order to configure Xray issue types with a project, you must know if you are in a team-managed project or in a company-managed project. The configuration steps for Xray issue types will be different for each kind of project.

Table of Contents
minLevel2

Company-Managed Project (old Classic Project)

Tests, along with other entities, are abstracted as Jira Issue Types. Thus, you need to add them to the Issue Type Scheme used by your project.

Info
titlePlease note

Please note that Xray doesn't work with the Agility based project templates (i.e. Kanban and Scrum), available in the new Jira experience; you should create or use projects based on the "Scrum (classic)" or "Kanban (classic)" project templates instead.

...

 

This can be done automatically by clicking the Add Xray Issue Types available in the Summary section within the project settings:

Image Added


Or manually either within the Jira administration or clicking Configure the issue Type Scheme manually available in the Summary section within the project settings:

...

Image Added

  1. Edit the Issue Type Scheme (be aware of the projects using it) and add :

Image Added

2. Add Test, Precondition, Test Set, Test Execution, Sub-Test Execution issue types by dragging them from

...

the Available Issue

...

Types column on the right side to

...

the Issue Types for Current

...

Scheme on the left side. Click Save.

Image AddedImage Added



Info
titleInfo

When a company-managed project is configured, the Testing Board may not be visible right away:

Image Added

If this is the case, after configuring it, simply access a page containing Xray information, such as an Xray issue of the given project or Xray Settings of that same project and then refresh the page.

Team-Managed Project (old Next-Gen Project)

Within team-managed projects, you first need to create the necessary issue types manually.

  1. In the team-managed project settings, navigate to Issue Types and press Add Issue Type. Specify a name, description and icon for the new issue type. For simplicity, you can choose the same issue type names as the default global Xray issue types. Repeat these steps for all other necessary Xray entities such as: Test, Precondition, Test Set, Test Plan and Test Execution.
    Image Removed      Image Removed E.g. Creating the Test issue type:

    Image Added

  2. You can download the icons for the Xray issue types below: 

    Section
    Column
    width20%

    Image Added

    Column
    width20%

    Image Added

    Column
    width20%

    Image Added

    Column
    width20%

    Image Added

    Column
    width20%

    Image Added



  3. Map Issue Types to Xray entities: The next step is to map the issue types created in the first step with Xray entities. You can do that by accessing the Xray "Issue Types Mapping" settings page and selecting the corresponding issue types:

    Image Added

Now you should be able to start creating Xray entities within your team-managed project. These issue types will behave exactly like the global Xray issue types that are installed by Xray.


Configure Requirements and Defects

  1.  In the Test Coverage section, define the Covered Issue Types (i.e., the testable entities such as the typical requirements, user stories, epics). Drag the ones you want from the Available Issue Types column (e.g., Epic, Story) to the Covered Issue Types column. Click Save.

Image RemovedImage Added


2. In the Defect Mapping section, define the Covered Issue Types (i.e., the testable entities). Drag the ones you want from the Available Issue Types column (e.g., Story, Epic) to the Defect Issue Types. Click Save.

Image RemovedImage Added



Info
titleLearn more

Refer to the specific Project Settings page or take a look at the extensive Global Settings if you want to fine-tune Xray or adapt it to your specific needs.

...