Xray provides a built-in project template so all Xray Issue Types and Screens are associated to the newly created project. This way, each project can be customized without affecting other projects.
Creating the project
To create an Xray project, you must select the Xray Test Project in the Create Project Module. Then, you must read the short description and finally choose your project name and key.
As of v3.3, the project is created as being a "Business" based project.
You may want to change the project type to "Software" by going to Project settings > Details > Project Type, so that you can take advantage of some features such as Backlog management and visibility of active Sprint using the project side bar.
When you create an Xray Project, a project-specific structure with several entities is created.
Issue Type Scheme
This scheme uses all Issue Types from Default Issue Type Scheme and adds, if not already added, all Xray Issue Types.
Xray creates 9 project-specific Screens. Each Xray Issue Type has 2 screens (one for create/edit and one for viewing) and all other Issue types are mapped to the default screen.
Xray creates 5 project-specific Screens Schemes. Each Xray Issue Type has 1 screen scheme (configured with the 2 screens shown above) and all other Issue types are mapped to the default screen scheme.
Issue Type Screen Scheme
Xray creates a project-specific Issue type Screen Scheme (configured with the 5 screen schemes shown above).
When creating an Xray project to test a Requirement Project, there are some configurations that are optional but strongly recommended by the Xray team.
Replicate versions name to the newly created project
In order to calculate the overall requirement coverage by versions, you must guarantee that versions from the Requirement project and Test project are the same.
Bear in mind that the Automated replication will copy all versions name from the chosen projects
Go to Administration-> Projects -> newly created Xray project -> Actions -> Copy Project versions
- Choose the projects which you want to copy the versions
- All versions from the selected projects will be replicated to your newly created Xray project.
- Go to Administration-> Projects -> Choose your Requirement project -> Versions
You'll see this screen:
- Go to Administration-> Projects -> newly created Xray project -> Versions. Replicate the version names
Add Xray Issue Types to your project
It's quite a simple process.
Go to Administration -> Issue type schemes
Edit the requirement project adding Xray Issue Types.
Now, you're able to see Overall Requirement Coverage Report panel.
Add Requirement Status field to your Requirement screens
When you install Xray, it will add relevant fields to Defaul Issue Type Screens. If you only use these screens, then you do not have to perform the following action. If you use customized screens, then Xray have not added any custom fields to those screens. We recommend you to add Requirement Status to you Requirement issue type screens. Follow these steps illustrated in the images below.
You must repeat these steps for every Requirement issue type screen.
This is a requirement without Requirement Status field.
You can see that a custom field is not associated with this screen.
Just go to the specific screen listed on the previous screen and add the field.
Now, you can see the Requirement Status of this requirement.