Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of Contents
maxLevel4

...


UI Expand
titleTable of Contents

Table of Contents

Introduction

A Test Model is serves as your test Test bench, where you define all the the parameters, 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.

Actions

Create a Test Model

and rules. The system then uses these definitions to automatically generate all the Scenarios.

Test models streamline the Test creation process, improve Test coverage, enable reusability, foster collaboration, and integrate with automation efforts, making the overall Testing process more efficient and effective.

Next, follow the prompts

Info

See the full details of the Test Case Designer operations here.

UI Steps
sizesmall
UI Step

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

Image Removed

UI Step
Column
width40%

Image Removed

Column
width60%
  1. Add a model name.
  2. Depending upon where you would you 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.
Note
titleProject

Projects in Test Case Designer are a way to organize your Test Models and

enabling

enable collaboration. Creating a new project does not affect Jira, so it's fully independent of

the

your Jira Projects. You will not create a Jira Project when creating a

"

New Project

"

in Test Case Designer.

Tip

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

Operations

Info

Creating a Test Model

Importing

...

a Test Model from a File when Creating a New Test Model

Xray Test Case Designer allows Designer allows you to import all types of details you might have in your model. The various details from your model when creating a new one. While the import feature is straightforward but fairly , it is somewhat inflexible.

You can import from .xlsx ( MS files in XLSX (Excel) format or from OPML (Mind Mapping & and Outlining).

...

Importing from Excel

...

To import from Excel, provide a spreadsheet with a sheet named

...

Inputs. Each column in the sheet

...

should represent a parameter, and each row

...

should contain corresponding parameter values:

AnimalsLettersParameter 3
MonkeyAValue 1
FerretBValue 2C


Info

The spreadsheet must be in the

...

Excel Workbook

...

 format, with an XLSX extension. To save a spreadsheet in

...

this format, select File → Save As, and choose the XLSX file type.

...

info

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

...

Importing from a Mind Map or Outline

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

LevelUsageNotes
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 nameN/A
Next levelParameter valuesN/A
Next levelValues expansionsOptional
Info

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

small
UI Steps
size
UI Step

Click “New Test Model”

Image Removed

UI Step

Name the new model.

Image Removed

UI Step

Select the project (optional)

UI Step

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

Image Removed

UI Step

Click “Create.”

Make a Copy of an Existing Test Model

...

sizesmall
UI Step

Click on “My Test Models.”

Image Removed

...

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.

Image Removed

...

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

UI Step

Select 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.

Image Removed

Note
titleProject

Projects in Test Case Designer are a way to organize your Test Models and enabling collaboration. Creating a new project does not affect Jira, so it's fully independent of the your Jira Projects.You will not create a Jira Project when creating a "New Project" in Test Case Designer.

A couple of things to note:

  • “Model name” of the copy will just 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.

  • Project name has to be filled and should be unique per user account (i.e., another user can have a different project with the same name).

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

  • “Switch” checkbox allows to instantly start working on the copied version. Uncheck it if you create something for the 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

...

sizesmall

...

Hover the model you which to edit to see the available options
Image Removed

New Test Model (Figure 1 - 1).

Figure 1 - Test ModelImage Added

Figure 1 - Test Model

UI Step

A modal will open (Figure 2). Fill in the fields:

  • Modal name (Figure 2 - 1).
  • Select a Project (Figure 2 - 2).
  • Update an external file (Figure 2 - 3).

Once you're finished, click Create (Figure 2 - 4).

Figure 2 - ModalImage Added

Figure 2 - Modal


Viewing Versions and Reverting Test Model Version

UI Step

Select the "Edit test model properties" option

Image Removed

UI Step

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

Image Removed

...

(Revisions)

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

We provide a list of each revision and the date so all you have to do is click a button the Revisions button (Figure 4 - 2) to revert to that version. We also give you the option 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 planTest model, you will see a Revisions link button (Figure 4 - 2) under the sub-menu of the plan model name dropdown (see the image below)Image Removed .

Info

Revisions are available in editable test models, the revisions link Test Models. The Revisions button is not available in un-editable test models uneditable Test Models (such as the “original” original sample ones).

For each revision three options are available:

...

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:

Image Removed

Review the Test Model 

Add notes to the  Test Model

...

Fill in the details of your note and click the “Create” button. Keep in mind that anyone with access 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 useful 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

UI Steps
sizesmall
UI Step

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

Image Removed

UI Step

Select "Delete this test model" option.

Image Removed

UI Step

Confirm to delete model.

Image Removed

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.

Image Removed

Info

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

If the plan you are sharing is already in a project, you can skip this step.

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

Add one or multiple email addresses, specify the rights to grant, and add the users.

Image Removed

The email address field will present the list of users from your organization upon partial match.

As explained in the table below, you can select different usage rights based on your preferences.

Image Removed

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 Plans.” That way, the person you share with will be able to make comments to your plans and ask clarifying questions about it, but they will not be able to make changes to your plan.

Synchronize a Test Model

...

sizesmall
UI Step

Access Synchronization from the Test Model menu on the left.
 Image Removed

UI Step

Select test strength:
Image Removed

UI Step

Select "Export Script"

Image Removed

UI Step

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

Image Removed
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 automated script is selected)
  • Scenario Name - the name of the scenario selected (Available when automated script is selected)
UI Step

Select the target Jira project 

Image Removed

UI Step

Select Test type:

Image Removed

...

Info

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)

  Image Removed

UI Steps
UI Step

Go to My Test Models (Figure 3 - 1) and enter a Test Model (Figure 3 - 2).

Figure 3 - Test modelImage Added

Figure 3 - Test model

UI Step

The Test Modal screen will open (Figure 4). Click the option with the name of the Test Modal (Figure 4 - 1) and then select Revisions (Figure 4 - 2).

Figure 4 - OptionsImage Added

Figure 4 - Options

UI Step

The Revisions screen will open (Figure 5).

Here, you can:

  • See the list of the revisions made (Figure 5 - 1).
  • Revert, make a copy and/or download the Test Model (Figure 5 - 2).
  • Hovering over the revision provides a more precise timestamp. Clicking on the revision expands the section with more details.

Figure 5 - RevisionsImage Added

Figure 5 - Revisions

Info

A version of a Model can be searched (Figure 5 - 3) by Label, User, and Update Details (e.g., typing Ana in the search field would return Revision 2). The Revisions feature allows a solid version control of your Test Model.

Info

See the full details of the Test Case Designer operations here.


Expand
titleSupport/Troubleshooting

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.

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

Image Removed

Tip

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

Image Removed

Image Removed