Document toolboxDocument toolbox

Import Requirements

Owned by
Cheney Ma
Apr 02, 2022

You are allowed to import requirements from a CSV file, requirement hierarchy and test case associations can also be imported.

Points to remember while importing Requirements:

  1. Summary or Issue Type is mandatory to start 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. 'Issue Id' and 'Parent Id' fields are mapped to maintain requirement hierarchy information:
    1) 'Issue Id' & 'Parent Id' column could be either 'blank' or with any 'texts'
    2) Once 'Issue Id' and 'Parent Id' are exactly same, the Parent<->Child relationship will be established after importing
    3) If 'Parent Id' equals to an existing requirement issue key (Jira Issue Key), the imported requirement issue will be linked as a child requirement for the specified issue
  4. Map Test Case ID (Jira Issue Key) in Test Case column if you want associate test cases to imported requirements
    Note: if Test Case ID specified in import file cannot be found in your Jira project, the Requirement will still be imported without Test Case associations
  5. Providing ISSUE KEY will update the corresponding issue, if found
  6. Specify Requirement Suite path in the Requirement Suite column if you want to import Requirements along with Requirement Suite information
    Note: If the Requirement Suite path specified in import file cannot be found from your project, the Requirement Suite will be created first and then put the corresponding Requirement issues inside it.
  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 requirements from .csv file, following these steps:

  1. Click the "Import" button
  2. Click "Choose Files" button, browse to your test case file (.csv format)
  3. Specify a "Delimiter" if necessary
  4. 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.
  5.  Click "Next" button
  6. 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 4.
  7. 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 fourth step of the CSV file import wizard.

[Screenshot - UG93_Requirement_Import_1]

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