Import Test Cases From CSV

Applies to Zephyr Scale Server/Data Center 9.1, last modified on November 30, 2023

You can import Comma-Separated-Values (CSV) files directly into Zephyr Scale using a wizard.

If your data is in the Numbers spreadsheet program on a Mac OS, no worries! Just export to CSV before you proceed with the import process.

  • HTML is supported in multi-line fields while importing Test Cases from CSV.
  • A backslash (\) alone is not displayed, as it works as an escape character to escape double quotes. To make backslashes visible, put two backslashes (\\).

This topic is split into two main parts:

Note:

Having issues? Starting a CSV file from scratch?

Download the Sample1.csv template, which includes the suggested formatting. You must have Microsoft Excel installed to access the template.

Before you import: format your CSV file

To import and allow you to map your fields and data accurately, the CSV file you use to import your test-case information needs to abide by a few formatting specifications.

Define your test steps

There are two ways you can format your test steps. Choose one.

Option 1

You can import the script type (Steps) by creating a column for Step and another column for the Expected Result, as demonstrated in the following example:

The 'Step' and 'Expected results' columns

Click the image to enlarge it.

Option 2

You can import the script type (Plain Text) by creating a column for Test Script Plain Text, as demonstrated in the following example:

The 'Status' and 'Test Script Plain Text' columns

Click the image to enlarge it.

System fields available for import

This table lists all of the system fields that are importable via the CSV.

System Field Description
Name

Text field, single line.
The Name field is required.
Example: Validate mandatory fields.
Precondition

Text field, multi-line.
May contain line breaks.
Example: Leaves fields in blank to verify if a user can advance without filling mandatory fields.
Objective

Text field, multi-line.
Can contain line breaks.
Example: Ensure the user is unable to proceed without filling mandatory fields.
Test Script (Steps) - Step

Text field, multi-line.
Can contain line breaks. Should not be used if the Test Script (Plain Text) field has been mapped.
Example: Leave username field blank and attempt to proceed further.
Test Script (Steps) - Expected Result

Text field, multi-line.
Can contain line breaks. Should not be used if the Test Script (Plain Text) field has been mapped.
Example: User is unable to proceed further. The page warns about a mandatory field.
Test Script (Plain Text)

Text field, single line.
Should not be used if any Test Script (Steps) field has been mapped.
Example: The content of the error message should be "field user name is mandatory."
Folder

Folder structure separated by a slash (/).
Example: "folder 1/folder 2" or "/folder 1/folder 2" (same effect for both options).
Non-existing folders will be created.
Folders that match existing ones (including all path) will be merged.
Status

Name or short sentence describing the value.
A value-mapping step will be available for such fields.
Example: Draft, Approved, In Review, etc.
Priority

Name or short sentence describing the value.
A value-mapping step will be available for such fields.


Example: Low, Medium, High, etc.
Component

Name or short sentence describing the value.
A value-mapping step will be available for such fields.
The component field is the same component used by the Jira project.
Example: Manufacturing
Labels

Name or short sentence describing the value.
A value-mapping step will be available for such fields.
Example: Functional, Non-Functional, Smoke, Integration, etc.
Owner

The key of existing Jira users.
If the user doesn’t exist, it will not be imported and a warning will be generated.
Example: ccaetano, jbond, etc.
Estimated Time

The estimated time in seconds or using format hh:mm.
If the value can’t be parsed, it will not be imported and a warning will be generated.
Example: 00:40 or just 2400 (seconds)
Coverage

An issue key list separated by a comma.
If an issue doesn’t exist for a given key, it will not be imported and a warning will be generated.
Example: TIS-490, WOR-356, etc.

Importing your data to Zephyr Scale

  1. Open the project you want to import the test cases into, then click Tests > More > Import from File.

    The 'Import from File' command

    Click the image to enlarge it.

    The Import from File wizard appears.

  2. Click CSV.
    The wizard progresses to the Setup stage.

    The 'Import from File' command

    Click the image to enlarge it.

  3. Upload your CSV file by dragging and dropping it into the defined area or by clicking Choose the File and selecting it from your local storage.
    Your file uploads to the wizard.

  4. Complete the fields in the Settings section.

    • Destination Folder - The folder into which you want to import your test cases.

    • Date Format (two fields) - The format your test cases use, including the separator (slash, dash, or dot).

    • File Encoding - The file encoding used on your CSV file.

      • Choosing the incorrect encoding will affect your field mapping.

    • CSV Delimiter - The delimiter used on your CSV file.

      • Choosing the incorrect delimiter will affect your field mapping.

    • Start Import at Row - The row in which you want the import to begin.

      Note:

      The This row contains the field names checkbox is selected by default. Deselect this option if the row specified does not contain field names.

  5. Click Next.

    The import settings

    Click the image to enlarge it.

    The wizard progresses to the Field Mapping stage.

  6. Map your fields, then click Next.
    Unmapped fields will not be created.

    The 'Field Mapping' stage

    Click the image to enlarge it.

    The wizard progresses to the Data Mapping stage.

  7. Map your data type for components, priorities, statuses, labels, etc.
    A message appears if there is no data to map.
    Note the option to automatically create unmapped labels.

    The 'Data Mapping' stage

    Click the image to enlarge it.

  8. Click Import.
    Your test case information imports to Zephyr Scale. The wizard advances to the Results stage, where import messages and errors appear.

See Also

Importing Test Cases

Highlight search results