Document toolboxDocument toolbox

Import Test Cases to a Test Suite

Owned by Cheney Ma
Sept 20, 2021

You can import Test Cases (.csv) directly to a Test Suite, the Test Cases and Test Suites will be imported to the Test Suite where you start from.

Points to remember while importing Test Cases:

  1. Summary is mandatory to start the import.
  2. Appropriate date format is required when processing with date fields.
    • Use the syntax that complies with the Java SimpleDateFormat
    • Example: set date format to yyyy-MM-dd h:mm a if you are going to import date time value as 2030-01-01 12:00 AM
  3. Step ID is mandatory when a step is provided.
  4. Providing ISSUE KEY will update the corresponding issue, if found.
  5. Specify Requirement ID in Requirement column if you want to import Test Cases with Requirement associations.
    Note: if Requirement ID specified in import file cannot be found in your project, the Test Case will still be imported without Requirement associations.
  6. Specify Test Suite path in Test Suite column if you want to import Test Cases with Test Suite associations.
    Note: If Test Suite path specified in import file cannot be found from your project, it will be created from import file.
  7. At the end of the CSV file import wizard, you will be given the option of creating a CSV configuration file, which contains the settings you configured while running through the CSV file import wizard. This is useful if you need to test your CSV file import on a test JIRA server first before performing the import on a production system.

To import test Test Cases from .csv file to a Test Suite, follow these steps:

  1. Click the "Edit" icon from a Test Suite
  2. Click the "Import" icon from any Test Suite
  3. Click "Choose Files" button, browse to your test case file (.csv format).
  4. Specify a "Delimiter" if necessary. 
  5. Select "Use an existing configuration file" if you have, it will ask you to select the configuration file and mappings in the file will be loaded automatically in next page.
  6. Click "Next" button.
  7. Select the CSV fields to import, then set how you would like these converted to fields in JIRA.
    • Note: the field mapping can be done automatically if you have a configuration file created in your previous import and follow step 5.

  8. Click "Import" button.

    Note:

    If you need to import another CSV file with the same (or similar) settings to what you used through this procedure, click the save the configuration link to download a CSV configuration file, which you can use at the fifth step of the CSV file import wizard.

[Screenshot - UG0042_Test_Suite_Panel_Import_Test_Case]

After Test Case import is done, the Test Case will be imported to the Test Suite where the import is started from.

[Screenshot - UG0043_Test_Suite_Panel_Import_Test_Case]

Tips for importing CSV data into JIRA fields

Below are some helpful tips when importing data from your CSV file into specific JIRA system fields and user created custom fields:

Jira FieldImport Notes
 -

synapseRT import only supports Jira system field (e.g. Summary, Priority ...) and custom fields from Jira standard field types (e.g. Checkboxes, Date Picker ...)

Jira advanced field types (e.g. Development Summary, Global Rank ...) and any field types from third party apps are not supported.

SummaryThis is the only required field.
Issue KeyYou can set the issue key for an imported issue. If an issue with a given key already exists in JIRA, it will be updated instead.
Component(s)You can import issues with multiple components by entering each component in a separate column.
Affects Version(s)You can import issues with multiple 'Affects Versions' by entering each version in a separate column.
Fix Version(s)You can import issues with multiple 'Fix Versions' by entering each version in a separate column.
Due Date
  • Use the syntax that complies with the Java SimpleDateFormat
  • Example: set date format to yyyy-MM-dd h:mm a if you are going to import date time value as 2030-01-01 12:00 AM
LabelsYou can import issues with multiple labels by entering each component in a separate column.
Epic LinkProvide Epic issue key if you want to link issues to an existing Epic in Jira.

Custom field types:

  • Date Picker
  • Date Time Picker
  • Use the syntax that complies with the Java SimpleDateFormat
  • Example: set date format to yyyy-MM-dd h:mm a if you are going to import date time value as 2030-01-01 12:00 AM

Custom field types:

  • Checkboxes
  • Labels
  • Select List (multiple choices)
  • You can import issues with multiple values by entering each value in a separate column.
  • Values for 'Checkboxes' and 'Select List (multiple choices)' fields require to be pre-defined in your Jira server.
  • Values for 'Labels' field are not required to be pre-defined in your Jira server, values will be created by import process.

Example:

Summary, Checkbox, Checkbox, Checkbox, Label, Label
"First issue", value1, , , Label1,
"Second issue", value2, , , Label1, Label2
"Third issue", value1, value2, value3, Label1,

Custom field types:

  • Number Field
  • Text Field (multi-line)
  • Text Field (single line)
  • URL Field
  • Values for those fields are not required to be pre-defined in your Jira server.
  • Values will be created by import process.

Custom field type:

  • Select List (cascading)
  • The '->' separator allows you to import the hierarchy.
  • Values for this field require to be pre-defined in your Jira server.

Example:

Summary, Cascading Custom Field
Example Summary, Parent Value -> Child Value

Custom field type:

  • User Picker (single user)
  • It requires to specify Jira 'username' in csv file in order to make a successful import.
  • The user(username) specified in csv five must be defined in Jira server already.

Downloadable examples