Page History
After installing Xray, there are basically two a few steps you need to make or ensure before starting to use itat the project level.
| Table of Contents |
|---|
Configure Requirements and Defects
In Jira's administration, in the Add-ons tab, go to Issue Type Mapping and configure what issue types should be considered as "requirements" and "defects".
| Info | ||
|---|---|---|
| ||
Refer to the specific Project Settings: Test Coverage page or take a look at the extensive Global Settings if you want to fine-tune Xray or adapt it to your specific needs. |
Enable Xray in your projects
You can enable Xray for your existing projects or create a new project with both standard and Xray issue types.
For existing projects, in the project Administration page, go to Actions at the top right-hand side. You can either:
a) set your project as a Requirements project by choosing "Enable Xray Requirement Coverage", so the requirements are covered by tests; or
...
| 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.
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 | ||
|---|---|---|
|
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.
This can be done automatically by clicking the Add Xray Issue Types available in the Summary section within the project settings:
Or manually either within the Jira administration or clicking Configure the issue Type Scheme manually available in the Summary section within the project settings:
- Edit the Issue Type Scheme (be aware of the projects using it):
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.
...
| Info | ||
|---|---|---|
| ||
Since the Issue Type Scheme being used by your project may also be used by other projects, in order to add Xray's Issue Types from the project settings page you must belong to a group allowed to do so in Xray settings. The allowed groups to add Xray Issue Types can be defined in this setting. |
| Info | ||
|---|---|---|
| ||
If, instead, you want to quickly create a new project and use it to manage everything (e.g., requirements, defects, tests), go to the Jira Administration page for Projects. In the creation dialog, choose "Xray Test Project".
...
| |
When a company-managed project is configured, the Testing Board may not be visible right away: |
Team-Managed Project (old Next-Gen Project)
Within team-managed projects, you first need to create the necessary issue types manually.
- 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. E.g. Creating the Test issue type:
You can download the icons for the Xray issue types below:
Section Column width 20% 
Column width 20% 
Column width 20% 
Column width 20% 
Column width 20% 
- 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:
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
- 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.
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.
| Info | ||
|---|---|---|
| ||
See Creating a Test Project using an Xray TemplateRefer 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. |