Configuration
Xray Test Case Designer is a feature included in the Xray Enterprise offer. To access this feature, you must have an active Xray license.
When a valid Xray Enterprise license is detected, a new Xray Enterprise configuration option will be made available to set up your Test Case Designer instance. More details below.
Looking for information on how to set up the Xray Test Case Designer? Check this section.
Please be aware that to enable Xray Test Case Designer you will need to make sure that Jira is at 8.22.x version or higher.
Usage
Access
Go to the Project in which you want to use Test Case Designer and, on the left-side menu of the screen, click Test Case Designer (Figure 1).
Figure 1 - Menu
A modal will open (Figure 2). In the modal, click Open Test Case Designer (Figure 2 - 1).
Figure 2 - Modal
A new tab will immediately be opened in your browser with the Test Case Designer UI (Figure 3).
Figure 3 - Test Case Designer
Operations
Searching for a Test Model
You can use the search bar (Figure 3 - 1) to find existing Test Models and/or projects.
Creating a New Test Model
Click the New Test Model (Figure 3 - 4) to create a new Test Model. Once you do so, a modal will open (Figure 4).
Figure 4 - New test model
Fill in the fields:
- Model name (Figure 4 - 1; mandatory field).
- Project (Figure 4 - 2). You can select None or, if you click the dropdown menu, you can create a new project to add directly from this modal.
- Import an external file (Figure 4 - 3; optional field). Click what kind of files? (Figure 4 - 5) to know more.
Once you're done, click Create (Figure 4 - 4). The new Test model will be generated immediately, and it will be listed in the My Test Models screen (Figure 3 - 5).
Managing My Test Models
You can view and manage the Test Models you created by clicking My Test Models (Figure 5 - 5).
Figure 5 - My test models
Here you can:
- See the Test Models you created (Figure 5 - 1). Once you click a Test Model, you can see its details (Figure 6).
- Edit a Test Model (Figure 5 - 3). The Edit Test Model dialog will open, similar to the Create New Test Model dialog (Figure 4).
- Copy a Test Model (Figure 5 - 2). The Copy Test Model dialog will open, similar to the Create New Test Model dialog (Figure 4). The copy of the model will be ready to be used in the project you specified.
- Delete a Test Model. A dialog will open, prompting you to confirm the removal of the Test Model.
The Model name of the copy will just add (copy) to the original Test Model name by default but it can be changed as long as it is unique in a given project or the private collection.
The Project name has to be filled in and it must be unique per user account (i.e., another user can have a different project with the same name).
In the Copy Model dialog:
The Revision History checkbox allows to preserve the traceability of edits across models. However, for old models, it may be better to clear the history for faster performance.
The Switch checkbox allows you to instantly start working on the copied version. Uncheck it if you create something for future needs and are not ready to edit it yet.
Projects in Test Case Designer are a way to organize your Test Models and enable collaboration. Creating a new project does not affect Jira, so it's fully independent of your Jira Projects. You will not create a Jira Project when creating a New Project in Test Case Designer.
Test Model Screen
Figure 6 - Test model
Parameters (Figure 6 - 2)
Parameters define the variables and their possible values within the Test Model.
Here, you can:
- Edit the existing parameters and values (Figure 6 - 7).
- Set the view (regular/bulk; Figure 6 - 1).
- Add new parameters (Figure 6 - 8).
Rules/Scenarios (Figure 6 - 3)
While Parameters enumerate the variables in your Test Model and their possible values, Rules allow you to apply restrictions, as not all variable combinations are relevant.
Scenarios are the generated combinations of input parameter values, where each row represents a combination of parameters (and their values) to be used in a Test.
Here you can search for Tests (Figure 7 - 1), add scenarios (standard/optimized; Figure 7 - 2), and select the interactions (1-way/2-way/mixed; Figure 7 - 2).
Then, you can freeze the scenarios and save them (Figure 7 - 3) into a CSV, JSON, YAML file, etc., which will be automatically downloaded on your machine.
Figure 7 - Scenarios
Scripts
Scripts (Figure 6 - 4) contain detailed Steps with actions and expectations for your Test scenarios. Scripts can be manual or automated.
Automated (Figure 8)
For automated Test Scripts, you can specify Gherkin (e.g., Cucumber) Scenarios or Scenario Outlines, or even Robot Framework Test cases. Similar to manual Test Scripts, Parameters can be mentioned in the specification and replaced by proper values later.
Here, you can:
- Edit, delete, and/or add a Test Script (Figure 8 - 1).
- Select 2-way interactions, or generate other Test Scenarios (Figure 8 - 2).
- See a sample Script (Figure 8 - 3).
Figure 8 - Automated
Manual (Figure 9)
For manual Test Scripts, detailed Steps and expected results can be specified, with parameters mentioned. These Parameters will be replaced by the respective values when generating the Tests later.
Here, you can write/edit the Steps (Figure 9 - 1) and select a 2-way interaction, or generate other Test scenarios (Figure 9 - 2).
Figure 9 - Manual
Analysis
Analysis (Figure 10 - 1) allows you to view the exact coverage achieved by your Scenarios.
From Analysis, you can access Coverage Matrix and Coverage Graph (Figure 10 - 2). More below.
Figure 10 - Analysis
Coverage Matrix (Figure 11)
Here, you can see the coverage matrix and save the coverage data as a JSON or XML file (Figure 11 - 1).
Figure 11 - Coverage matrix
Coverage Graph (Figure 12)
Here, you can view the percentage of interactions covered after each Scenario.
You can select a 2-way interaction, or generate other Test scenarios (Figure 12 - 1).
Figure 12 - Coverage graph
Review
Here (Figure 13 - 4) you can ensure your Test Model adequately covers the risks in the system by adding Notes (Figure 13 - 1), checking out Mind Maps (Figure 14), and Scorecards (Figure 15).
Notes (Figure 13)
Notes are specific to individual models.
Fill in the details of your note (Figure 13 - 1) and click the Create button (Figure 13 - 2) to create a note. You can see how many notes were created on the top of the screen (Figure 13 - 3). Anyone with access to the model (including reviewers, etc.) can use this feature.
If you need more context for a note, it may be useful to check the Revisions under the model name dialog.
Figure 13 - Notes
Mind Map (Figure 14)
Mind Map is a visual tool that helps organize and structure relationships between Test components, such as Requirements, Test cases, and Scenarios. Mind maps enable flexible, holistic test planning, ensuring comprehensive coverage in an efficient manner.
Figure 14 - Mind maps
Scorecards (Figure 15)
Scorecards are used to assess the effectiveness and completeness of Test coverage.
Figure 15 - Scorecards
Share (Figure 15 - 1)
If the model is not yet in a project, you will first need to move it to a project.
If the model you are sharing is already part of a project, you can skip this step.
Please note that all of the models from the project will be shared because sharing is done by the project, not by individual models.
Share (Figure 16) allows you to invite other team members to join your project by adding them via email.
Figure 16 - Share
You can add one or multiple email addresses, specify the rights to grant, and add the users. The email address field will present the list of users from your organization upon a partial match.
As explained in the table below, you can select different usage rights based on your preferences.
| Access Level | Typical Scenario for Using this Access Level | Comment in the Notes section | Edit Copied Versions | Edit models in the Shared Project Folder | Add and Remove Others from the Project |
|---|---|---|---|---|---|
| Can Edit Models and Project Members | Sharing with a project leader who will add or remove people from the project |
|
|
|
|
| Can Edit Models | Sharing with trusted colleagues who will collaboratively work with you on the same models |
|
|
| X |
| Can Copy and Comment on Models | Sharing with stakeholders who only need to review the progress and provide feedback without the hands-on experience |
|
| X | X |
When sharing with someone who is not yet familiar with how to use Xray Enterprise Designer, you might want to select “Can Copy and Comment on Models.” That way, the person you share with will be able to make comments on your models and ask clarifying questions about them, but they will not be able to make changes to your models.
Export (Figure 17)
You can export (Figure 17 - 1) your Test Model in several formats (Figure 17 - 2).
Figure 17 - Export
Synchronization (Figure 18)
You can sync (Figure 18 - 1) your Test data to Xray so that you can track the Test Execution. Many fields in the Sync dialog are customizable via Administration.
You can also check your sync history (Figure 18 - 2) to keep track of synchronizations.
Figure 18 - Sync
To better track the Issues created on Jira, the system will add labels to Issues with the Test Model ID (Figure 19) and with a generic label to tag the Issues synched from the Xray Test Case Designer (Figure 20).
Figure 19 - Sync
Figure 20 - Sync labels
Managing My Projects
Project
Projects in Test Case Designer are a way to organize your Test Models and enable collaboration. Creating a new project does not affect Jira, so it's fully independent of your Jira Projects. You will not create a Jira Project when creating a New Project in Test Case Designer.
You can view and manage the Project you created by clicking My Test Models (Figure 21 - 5).
Here, you can:
- Edit, remove and/or create a new project (Figure 21 - 1).
- Search for Test Models and/or projects (Figure 21 - 3).
- Share the current project with a team member (Figure 21 - 2). A new screen will open.
- See and enter the existing projects (Figure 21 - 4).
Figure 21 - My projects
Below My Projects (Figure 21) you can see Recent Projects (Figure 21 - 4). Here, you will find the projects you've opened more recently.
Sample Test Models (Figure 21 - 6)
Here you can find a list of sample projects (Figure 21 - 6).
Sample projects are useful for learning how to use the tool, providing best practices for Test design, and offering templates to quickly start new projects. They help you understand how to optimize Test coverage and structure Test scenarios efficiently.
You can copy and open a sample project the same way you open a regular project.