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.

On your Jira Cloud instance, click the settings icon (Figure 1 - 1) and then select Apps (Figure 1 - 2). A menu on the left side of the screen will open. There, click Features (Figure 1 - 3). A new screen will open (Figure 2).

Figure 1 - Settings

Using the toggle, enable the Test Case Designer feature (Figure 2 - 1). Then, click Configure... (Figure 2 - 2). A new screen will open (Figure 3).

Figure 2 - Features

Enter the specific URL that Xray provided you (Figure 3 - 1). If you don't have this URL, please contact the Xray Support team. Once the URL is added, click Save (Figure 3 - 2).

Figure 3 - URL

The Test Case Designer menu option is now available on your Xray Projects (Figure 4 - 1).

Figure 4 - Test case designer

If, for some reason, Test Case Designer is removed from your instance and doesn't appear in Projects anymore (Figure 4 - 1), reinsert the Custom URL (Figure 3 - 1) and click Save (Figure 3 - 2).

Then, go to the Features screen (Figure 2), and, using the toggle (Figure 2 - 1), disable and enable the Test Case Designer option, and refresh your browser page. The Test Case Designer will button will reappear on Projects (Figure 4 - 1).

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 4 - 1). A modal will open (Figure 5). In the modal, click Open Test Case Designer (Figure 5 - 1).

Figure 5 - Modal

A new tab will immediately be opened in your browser with the Test Case Designer UI (Figure 6).

Figure 6 - Test case designer

Operations

Searching for a Test Model

You can use the search bar (Figure 6 - 1) to find existing Test Models and/or projects.

Creating a New Test Model

Click the New Test Model (Figure 6 - 4) to create a new Test Model. Once you do so, a modal will open (Figure 7).

Figure 7 - New test model

Fill in the fields:

Model name (Figure 7 - 1; mandatory field).
Project (Figure 7 - 2; mandatory field). 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 7 - 3; optional field). Click what kind of files? to know more.

Once you're done, click Create. The new Test model will be generated immediately, and it will be listed in the My Test Models screen (Figure 6 - 5).

Managing My Test Models

You can view and manage the Test Models you created by clicking My Test Models (Figure 6 - 5).

Figure 8 - My test models

Here you can:

See the Test Models you created (Figure 8 - 1). Once you click a Test Model, you can see its details (Figure 9).
Edit a Test Model (Figure 8 - 3). The Edit Test Model dialog will open, similar to the Create New Test Model dialog (Figure 7).
Copy a Test Model (Figure 8 - 2). The Copy Test Model dialog will open, similar to the Create New Test Model dialog (Figure 7). 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 9 - Test model

Parameters (Figure 9 - 2)

Parameters define the variables and their possible values within the Test Model.

Here, you can:

Edit the existing parameters and values (Figure 9 - 7).
Set the view (regular/bulk; Figure 9 - 1).
Add new parameters (Figure 9 - 8).

Rules/Scenarios (Figure 9 - 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 10 - 1), add scenarios (standard/optimized; Figure 10 - 2), and select the interactions (1-way/2-way/mixed; Figure 10 - 2).

Then, you can freeze the scenarios and save them (Figure 10 - 3) into a CSV, JSON, YAML file, etc., which will be automatically downloaded on your machine.

Figure 10 - Scenarios

Scripts

Scripts (Figure 9 - 4) contain detailed Steps with actions and expectations for your test scenarios. Scripts can be manual or automated.

Automated (Figure 11)

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 11 - 1).
Select 2-way interaction, or generate other Test scenarios (Figure 11 - 2).
See a sample script (Figure 11 - 3).

Figure 11 - Automated

Manual (Figure 12)

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 12 - 1) and select a 2-way interaction, or generate other Test scenarios (Figure 12 - 2).

Figure 12 - Manual

Analysis

Analysis (Figure 13 - 1) allows you to view the exact coverage achieved by your scenarios.

From Analysis, you can access Coverage Matrix and Coverage Graph (Figure 13 - 2). More below.

Figure 13 - Analysis

Coverage Matrix (Figure 14)

Here, you can see the coverage matrix and save the coverage data as a JSON or XML file (Figure 14 - 1).

Figure 14 - Coverage matrix

Coverage Graph (Figure 15)

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 15 - 1).

Figure 15 - Coverage graph

Review

Here (Figure 16 - 4) you can ensure your Test Model adequately covers the risks in the system by adding Notes (Figure 16 - 1), creating Mind Maps (Figure 17), and Scorecards (Figure 18).

Notes (Figure 16)

Notes are specific to individual models.

Fill in the details of your note (Figure 16 - 1) and click the Create button (Figure 16 - 2) to create a note. You can see how many notes were created on the top of the screen (Figure 16 - 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 16 - Notes

Mind Map (Figure 17)

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 17 - Mind maps

Scorecards (Figure 18)

Scorecards are used to assess the effectiveness and completeness of Test coverage.

Figure 18 - Scorecards

Share (Figure 18 - 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 project, not by individual model.

Share (Figure 19) allows you to invite other team members to join your project by adding them via email (Figure 19).

Figure 19 - 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	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 20)

You can export (Figure 19 - 1) your Test Model in several formats (Figure 19 - 2).

Figure 19 - Export

Synchronization (Figure 20)

You can sync (Figure 20 - 4) your Test data to Xray so that you can track the Test Execution.

For that, enter your Client ID and Client Secret (Figure 20 - 2). Then, click Save (Figure 20 - 3).

You can also check your sync history (Figure 20 - 1) to keep track of synchronizations.

Figure 20 - Sync

To better track the Issues created on Jira, the system will add labels to Issues with the Test Model ID (Figure 21) and with a generic label to tag the Issues synched from the Xray Test Case Designer (Figure 22).

Figure 21 - Sync

Figure 22 - Sync

Managing My Projects

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 23 - 5).

Here, you can:

Edit, remove and/or create a new project (Figure 23 - 1).
Search for Test Models and/or projects (Figure 23 - 3).
Share the current project with a team member (Figure 23 - 2). A new screen will open.
See and enter the existing projects (Figure 23 - 4).

Figure 23 - My projects

Below My Projects (Figure 23) you can see Recent Projects (Figure 23 - 4). Here, you will find the projects you've opened more recently.

Sample Test Models (Figure 23 - 6)

Here you can find a list of sample projects (Figure 23 - 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.

Test Case Designer Administration

If you have questions or technical issues, please contact the Support team via the Customer Portal (Jira service management) or send us a message using the in-app chat.