Page tree

Versions Compared


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

You can use the Xray's Test Case Importer (a JIRA Jira Importer Plugin extension) to import Manual Tests from a CSV source file. 

Table of Contents

Before importing

The CSV source file must follow some simple rules.


  1. Test Case Identifier – this is the field used to identify which lines belongs to which test case. In the example bellowbelow, it is the TCID column.
  2. Summary – this field is mandatory since JIRA Jira doesn’t allow you to create an issue without a summary. In the example bellowbelow, it is the Test Summary column.
  3. Step – this field is going to be mapped as the Step field of a Manual Test Step. In the example bellowbelow, it is the Step column.

Here is an example of test cases structure:


And here This is how the CSV file looks like once the test cases above are exported to CSV:



titleCSV column separator

If you choose the “,” (comma) as the CSV columns column separator, then you must quote use quotation marks around any field that contains commas.

titleFields with line breaks

If you need to use new lines within a field, like  for example, in the issue description for example, then you need to quote the field.

Importing Test Cases

For demonstration purposepurposes, the CSV example file from the previous section is used.

To complete the importation process, follow the examples bellowsteps below.

  1. Log in with an administrator account.
  2. go to Projects>Import External Projects
  3. Choose Go to System > Import and Export > External System Import.
  4. Select the Xray Test Case Importer like shown in the image bellow. Image Modified


Setup Page

Provide the basic settings for the importation process must be provided.

  • The CSV Delimiter field is where you provide the column delimiter used in your CSV source file.
  • The File Encoding field is where you provide the encoding used in your CSV source file. Make sure that you provide the right encoding. 
  • Optionally, you can use the settings from a previous importation.


Project Page

Select the Xray project where you want your Manual Test cases to be imported. 

Image Removed

Next you need to map Image Added

Field Mapping Page

Map the fields from your CSV to JIRA Jira and Xray fields

It is mandatory to map at least three fields:

  1. Test Case Identifier (located under Manual Test Step fields). In this example, this field is mapped with to the TCID column from the CSV file.
  2. Summary (Located under JIRA Jira fields) In this example, this field is mapped with to the Test Summary column from the CSV file.
  3. Step (located under Manual Test Step fields) In this example this field is mapped with to the Step column from the CSV file.

The fields that aren't are not mapped will not be imported within to the test case.

titleCustom field mapping

Only custom fields that have the issue type Test selected as one of the applicable issue types , will be available for mapping.

Available custom fields for import:

  • Checkboxes
  • Labels
  • Number fields
  • Radio buttons
  • Select lists
  • Text field
  • URL field
  • User picker

Note: Only single-value custom fields are supported.


Value Mapping Page

Map the CSV column values. In the example above, the Map Field Value checkbox is selected for Priority, so next those values are going to be mapped.


Now just click Begin Import and Xray Test Case Importer will import the manual test cases to the selected project.

Image Added

The importation process is complete. A configuration file can be saved to import other manual test cases in the future.

Special fields


It is


possible to attach files to Test and to Test Steps.

Image Removed

Image Added


The attachment may be referred by name (in this case the file:// protocol is assumed), by "file://" or "http(s)://". Multiple files may be specified within one CSV column; for this, the attachments must be delimited by space.

Note: For file protocol, only files in the "<JIRA_DATA_HOME>/import/attachments" folder will be imported.

Test Repository folder

If you want to add the Tests to some folder within the Test Repository, you can specify a column having the Test Repository Path.

Folders and their respective sub-folders must be delimited by "/", as shown in the following example:

Image Added

During the mapping step, you need to map the CSV column containing the path to the "Test Repository Path" Xray's custom field.

Image Added

titlePlease note

The "Test Repository Path" is case insensitive and each folder is trimmed (spaces are removed from the start/end of it).

This means that "components/compA", "components /compA", and " components/COMPA" are all the same and will be mapped to the same folder within the Test Repository.

If the folder is not found, then the Test is created, but it is not associated with any folder; it will appear in the "Orphans" meta-folder.

You can import a link to other issues for newly-created Tests by choosing the "Link ..." mapping.

titleLinks to requirements

Whenever When importing Tests, it's also possible to  you can specify the links to the requirements that each Test validates. For that purpose, columns must be mapped as Link "Tests".

If the Test covers multiple requirements, then multiple CSV columns must be used, each one being mapped in the same way.


Now just click next and Xray Test Case Importer will import the manual test cases to the selected project.

Image Removed

The importation process is complete. A configuration file can be saved to import other manual test cases using the same configuration.

For any questions regarding this feature, please contact our support team.


Date Time fields

Dates and Date Time field formats must comply with the Java SimpleDateFormat. On the project mapping page, the format used on the CSV file should be given in order for the import process to complete without errors or warnings. 

titleExample of valid SimpleDateTime formats
  • dd/MM/yyyy hh:mm
  • dd/MMM/yy h:mm a


Comments can be added to Test issues using the "DateTime;User;CommentBody"syntax, where DateTime and User are optional.

More that one comment can be added for each issue, by adding more than one column on the CSV file.

DateTime uses the Date Time format specified on the project mapping page, and User must be a valid username. 

titleExample valid comment entries
  • 01/01/2012 10:10;Admin; This comment works
  • 01/01/2012 10:10; This comment also works
  • "This comment is only the text body"

Useful tips for importing Tests

Importing data in any system may be is a non-linear process and ; you may need to run it multiple times until you got get the expected result , because simple things such as forgetting to because it is easy to forget to map a field may happen.

Some general useful tips:


or use a delimiter, etc.

  • Add a unique label to all your tests, so you can clearly identify the tests imported at a given time; that . This will make your analysis simpler and eventualy if you do some bulk operation in them performing bulk operations (e.g., change fields, remove themfields) it will also be easier;.
  • use Use a custom field for storing the external ID of the tests in their original system. Thus, whenever tests are imported, you can easily compare them with the original ones tests in the original system;