Page History
| UI Expand | ||
|---|---|---|
| ||
|
Introduction
You can use the Xray's Test Case Importer to import new or existent tests, preconditions and test sets issues from a CSV or JSON source file.
The Test Case Importer follows a wizard-like interface, guiding you through the process which envolvesinvolves:
- preparing data (CSV/JSON) beforehand
- submit the data
- choose the destination project along with some global settings
- for CSV, define the mapping of CSV columns <=> fields in Jira
...
| Info | ||
|---|---|---|
| ||
The Test Case Importer is only able to create or update tests, preconditions, and test set issues. If you wish to create or update other types of issues, you should use Jira's CSV importer instead. Note that Jira's CSV importer is not able to handle any Xray-related semantics though. |
| Table of Contents | ||
|---|---|---|
|
| Note | ||||||
|---|---|---|---|---|---|---|
| ||||||
Please see a tutorial with working Examples using Test Case Importer, showcasing different scenarios, which you can download and try by yourself. |
...
Xray provides the ability to import multiple Tests, Preconditions, or Test Sets at once either as a standard user or as a Jira administrator; the user can create or update all those issues types with a maximum number limit of 1000 issues per import.
...
| Info | ||
|---|---|---|
| ||
Only users that who have the Make Bulk Changes permission will have this option available. The configuration can be found in the Jira Administration / System. Additionally, the user will only be able to import data into projects where he has the Create Issues permission. This configuration can be found in the Jira Projects / Project Settings / Permissions. |
...
The Test Case Importer is also accessible from within the Testing Board of a an Xray-enabled project.
| Info | ||
|---|---|---|
| ||
|
...
| Info | ||
|---|---|---|
| ||
The <<!clear!>> special marker removes the values of the field (with the exception of test step fields) where it is it specified (only applicable as a valid input of a csv CSV file). |
Open Test Case Importer
...
- An existing configuration file saved from the last import made with this file or a similar one.
- The file encoding is used in the CSV source file; this is especially important when the file contains non-ASCII characters. The supported encodings can be seen seen here.
- The CSV delimiter is the column delimiter used.
...
Additional setup information, for choosing the destination project along with some settings related with to the source data.
- The default project to which the tests will be imported into. Tests without project information associated will be imported into the project defined by this field.
- The list value delimiter is the delimiter used for fields that are lists of values.
- Date format is used to parse the fields that are representing represent dates, refer to to this page for help on how to define a valid format.
- Flag indicating if Test Repository folders should be created automatically if they do not exist.
...
There are three mandatory fields that must be mapped: Test ID, Summary, and Test Type.
Besides these ones, if you have defined additional fields as mandatory for Test issues, then you will also need to specify their mapping.
...
If no project field is mapped or when the value in this field is empty, the project selected in the Setup step will be the one where which these issues will be imported into.
...
To update existing issues, your CSV file needs to contain a column that maps to the Issue Key. If an issue exists for a given key, it will be updated.
...
If no issue type is defined for an issue being imported, it will default to test. When updating issues, the field can be left empty on the csv CSV file.
Test Type field
The type of the Test being imported. Must be filled for a Test in your CSV file, when creating one, and can be left empty when updating an existing Test.
...
Each value should be the issue key of an existing precondition or the id ID of a precondition also being imported ("Test ID" field).
...
Each value should be the issue key of an existing test set or the id ID of a test set also being imported ("Test ID" field).
...
Links can be created between imported tests and other existent issues using the "Link ..." Jira fields. Only applicable when creating an a test.
The field is a list field and the value of the respective field should hold a list of the issue keys of the issues to link to the test.
...
| Info | ||
|---|---|---|
| ||
Due to technical restrictions, there is a limit to the total amount of links the import file can have. The limit is 2000 issue links apart from the first one in every test. |
...
Example of one test being create created and one existent test being updated in the JSON import format:
...
After the import process has began begun its status will be periodically updated in on the Test Case Importer page. No new import process can be started until the current one finishes.
...
In the detailed import results, the elementNumber field represents to which issue the information corresponds to (elementNumber 0 being the first issue).
When importing tests into Test Repository folders, if for any reason the process is unable to create a folder or move a test to the respective folder, the respective tests will be still be migrated and a warning detailing the situation will be written to the import result.
...
And then you can use it when you import the next file (if the configurations are supposed to be the same or similar):
Learn More
...
| Expand | ||
|---|---|---|
| ||
If you have questions or technical issues, please contact the Support team via the Customer Portal (Jira service management) or send us a message using the in-app chat. |