Importing Test Cases

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-user-guide/test-repository/importing-test-cases.html

Important notes on importing test cases

When importing test cases, please note the following:

Only test cases in Excel formats XLSX are supported.
Only the first tab is imported.
Special formatting is not supported (merged cells, formulas, etc.).
If importing in bulk, all source test case files should be located on the same machine where the Zephyr server is installed or on mapped or network drives. If the source test case files are located on the same machine where the Zephyr server is installed, then the import process should be run only from a desktop launched on the server machine. If located on mapped or network drives, make sure you have specified the path correctly.
Individual files can be imported from a user's local machine.
Three discriminators are supported to demarcate test cases: ID change, name change, and a blank line between test cases.
We recommend that you break large files into smaller ones with no more than 5000 rows for fast importing.

About

Besides creating test cases from scratch, you can also import Excel files containing test case data to Zephyr and thus create test cases in it. An Excel file can contain one or multiple test cases separated by discriminators. Each column letter of an Excel file corresponds to a mapped Zephyr field. Imported test cases are placed in the Imported folder in the tree of test cases on the Test Repository page:

Import test cases

To import test cases, perform the following steps:

1. Map Excel columns to Zephyr fields

1. Click Test Repository in the menu on the left, and then click Import above the list of test cases:

2. If you have no Excel maps yet, you need to create one. In the subsequent Import Test Cases dialog, click Create New Excel Map:

3. In the Create New Excel Map dialog, populate all the required fields (the ones marked with an asterisk):

A list of fields available in the dialog:

Field name	Description

Field name	Description
Map Name	The name of your Excel map.
Description	Additional information about your Excel map.
Starting Row Number	The number of the row to start importing from. For example, there might be some header rows that need to be ignored.
Select Discriminator	Discriminators allow Zephyr to distinguish between multiple test cases in an Excel file. Possible values: By empty row By ID change By testcase name change

The dialog also contains a list of Zephyr fields (Name* is the test case name) with empty fields next to them where you can specify a column letter of the Excel file. To map a field to an Excel column, just enter the column letter in the empty field (see the image above). The section can also list custom fields available in the project.

After populating the fields, click Create New Excel Map. Zephyr will show the created map in the Import Test Cases Dialog:

The dialog has two tabs:

Available Map - lists all the available Excel maps.
History - shows the history of job runs. Clicking a job reveals its details.

Each map in the list has three actions:

Click the Play icon to create a job that will import the data.
Click the Pencil icon to edit the map.
Click the Trash icon to delete the map.

To create a new Excel map, click the plus icon in the top right corner of the dialog.

2. Create and run a job

After creating an Excel map, you need to create a job that will import the data. To do that:

1. Click the Play icon on the right, and in the subsequent dialog, specify the job name, upload the file/attachment to be imported and click Start Import:

If you want to import a folder containing sub-folders, select the Import with Hierarchy check box and specify the letter of the Excel column containing the folder names. For example, if you have the NewTC folder that has two sub-folders (TC1 and TC2), in Excel, the strings will look like this: In Zephyr, the imported hierarchy will be under the folder having the name of the import job:

If you want to import a folder containing sub-folders, select the Import with Hierarchy check box and specify the letter of the Excel column containing the folder names. For example, if you have the NewTC folder that has two sub-folders (TC1 and TC2), in Excel, the strings will look like this: In Zephyr, the imported hierarchy will be under the folder having the name of the import job:

After the job run is over, Zephyr will show the details of the run:

View imported test cases

Now, to view the imported test cases, go back to the Test Repository page, click Imported in the tree of test cases and select the folder with the name of your job. The imported test cases will be in the table on the right:

You can rename the imported folder, move it to another place, or just drag and drop the imported test cases to any folder in the tree.

Best Practices

Due to the varied nature of the source Excel files and potential inherent format inconsistencies, run smaller import jobs (fewer test cases) to ensure greater importing success. When confident of the results, import larger groups of test cases.
There might be issues when importing test cases if the source files were manually created by multiple users. We suggest standardizing the source files as much as possible to guarantee smooth importing.

Zephyr Enterprise 8.1.0