A Test Model is your test bench, where you define all the parameters, and rules so that the system can then generate all the scenarios and test scripts automatically. In this section, we will go through the basic steps to create/copy your test models.


Create a Test Model

First, click the “New Test Model" button in the top left of your home page.

Next, follow the prompts.

  1. Add a model name.
  2. Depending upon where you would like your new model to be saved, as appropriate:
    1. Select an existing project from the drop-down menu,
    2. Create a new project, or alternatively…
    3. Use the default “None (private).”
  3. Optionally (if you already have a set of test inputs created in Excel or a mind map), select “Choose File” to import the file. Learn more at 
  4. Click the “Create” button.


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 entirely independent of your Jira Projects. When creating a "New Project" in Test Case Designer, you will not create a new Jira Project.

Want to understand how to create a test model? Explore our Test Models samples.

Import a Test Model from a File

Xray Test Case Designer allows you to import all types of details you might have in your model. The import feature is straightforward but relatively inflexible.

You can import from .xlsx ( MS Excel) or OPML (Mind Mapping & Outlining).

Import from Excel

Provide an Excel spreadsheet with a sheet named Inputs. Each column in the sheet is a parameter, and each row has parameter values:

AnimalsLettersParameter 3
MonkeyAValue 1
FerretBValue 2


The spreadsheet must be in the Excel Workbook file format and end in a .xlsx extension. Save a spreadsheet in Excel Workbook format by selecting File→Save As and picking the .xlsx file type.

To ensure you have the correct file format for importing, export an existing model or start with this Excel example file. If you follow the format from an export or this sample, you can also import constraints, value expansions, notes, and auto-scripts from their respective sheets.

Import from a Mind Map or Outline

Many mind mapping and outlining tools support exporting to OPML, a simple hierarchical format that can only be used to define test model inputs. To import from OPML, ensure your file name has a .opml extension.

First outline level, if named with >3 characters and if they are all capital lettersParameter GroupOptional way to group like parameters
First outline level, or next level under a groupParameter name
Next LevelParameter values
Next LevelValues expansionsOptional

To ensure you have the correct format for importing, compare your file with this OPML example.

Click “New Test Model”

Name the new model.

Select the project (optional)

Select the file to be imported by selecting the "Choose File" option.

Click “Create.”

Make a Copy of an Existing Test Model

Click on “My Test Models.”

Search for the plan you want to create a copy of.

Hover to the right of that plan name to pull up the 3 tooltips.

Click on the “copy” icon below to create a copy of the plan.

Select the Model Name and Project. Input the name for the new test model and select the project to put the copied model into. You can create a new project by selecting “Create a new project…,” and typing the name on the popup screen.


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 entirely independent of your Jira Projects. When creating a "New Project" in Test Case Designer, you will not create a new Jira Project.

A couple of things to note:

  • “Model name” of the copy will add “(copy)” to the original by default but 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 should be a unique per-user account (i.e., another user can have a different project with the same name).

  • The “Revision History” checkbox allows you to preserve the traceability of edits across plans. However, it may be better to clear the history for faster performance for old plans.

  • The “Switch” checkbox allows users to start working on the copied version instantly. Uncheck it if you create something for future needs and are not ready to edit it yet.

The copy of the model is ready to be used in the project you specified.

Edit Test Model Details

Hover the model you which to edit to see the available options.

Select the "Edit test model properties" option.

Edit Model dialog is displayed, and you can update model properties. Select "Update" to reflect changes.

View Version and revert the Test Model version (Revisions)

The Revisions option allows you to revert to a previous version of that test model easily.

We provide a list of each revision and the date, so all you have to do is click a button to revert to that version. We also allow you to copy that model (in case you want to view it but also want to keep all the updates you have made since then) and create a new model based on that version.

When you are editing a test plan, you will see a Revisions link under the sub-menu of the plan name dropdown (see the image below)

Revisions are available in editable test models; the revisions link is not available in uneditable test models (such as the “original” sample ones).

For each revision, three options are available:

  • Revert
  • Make a copy
  • Download

A version of a model can be searched for by Label, User, and Update Details (e.g., typing “Java” in the search field would return “Revision 2”). The Revisions feature allows a solid version control of your test model.

Revert a Test Model version.

To revert, click the Revisions link, and a list of all versions of the model is displayed:

Review the Test Model 

Add notes to the  Test Model

Notes are specific to individual plans. They are located under Review in the left navigation pane and/or to the right from the plan name at the top.

Fill in the details of your note and click the “Create” button. Remember that anyone with access to the plan (including reviewers, etc.) can use this feature. This is usually a good thing.

If you need more context for a note, it may be helpful to check the Revisions under the plan name dialog.

How many notes have been created for a plan? That information is shown here in the red counter at the top.

Delete a Test Model

Hover the model you want to delete to see the available options.

Select the "Delete" to delete the test model option.

Confirm to delete the model.

Share a Test Model

First, open the model from the project that you would like to share. Next, click on “Share” underneath Review in the left navigation pane.

If the plan is not yet in a project, you will first need to move it to a project.

You can skip this step if the plan you share is already in a project.

Please note that all of the plans in the project will be shared because sharing is done by the project, not by individual plan.

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 the table below explains, you can select different usage rights based on your preferences.

When sharing with someone who is not yet familiar with how to use Test Case Designer, you might want to select “Can Copy and Comment on Plans.” That way, the person you share with will be able to comment on your plans and ask clarifying questions about them, but they will not be able to make changes to your plan.

Synchronize a Test Model

After you have designed your test model, you can synchronize it to Xray to track test execution.

Access Synchronization from the Test Model menu on the left.

Select test strength:

Select "Export Script"

Compose the Test name options you want the test name to be. 

You can select any of the options available on the drop-down and define what the naming convention will be. Options available:

  • Test Number - Incremental numeric value 
  • Model Name - the name of the model being synced
  • Feature Name - the name of the feature defined on the script (Available when the automated script is selected)
  • Scenario Name - the name of the scenario selected (Available when the automated script is selected)

Select the target Jira project. 

Select Test type:

Click "Synchronize" button:

On the first synchronization, you will only have the "Create New Xray Issues" option available. After the first successful synchronization, a new option will be made available and selected by default to update the issues created during the previous synchronization.
The "Create New Xray Issues" is still available if you want to bypass the issues update and create new issues on Xray (We strongly advise not to keep creating new issues as it will make tracking more difficult, and since generation is an automatic process, you might be adding a lot of unnecessary tests to your instance affecting performance)


To keep track of synchronizations, access the "Sync History" on the screen to track all synchronizations as well as their status:

To better track the issues created on Jira, the system will add labels to issues with the test model ID and a generic label to tag the issues synched from Xray Test Case Designer.

  • No labels