Check existent custom fields for Xray Issue Types
When you install Xray, you will see new custom fields that are added to some issue types.
Field Name | Manually set by the user? (users needs to fill out the custom field) | Type | Available Context(s) | Screens |
---|---|---|---|---|
Begin Date The start date of the Test Execution or Test Plan |
| Date Time Picker | Issue type(s): |
|
Conditions The Pre-Condition conditions | Pre-Conditions Editor | Issue type(s): |
| |
Cucumber Scenario The Cucumber Scenario clauses in Gherkin | Cucumber Test Steps Editor | Issue type(s): |
| |
Cucumber Test Type The Cucumber Scenario Type | Automated Test Type Select List (single choice) | Issue type(s): |
| |
End Date The completion date for the test execution | Date Time Picker | Issue type(s): |
| |
Exploratory Session The link to an exploratory session | Exploratory Session | Issue type(s): |
| |
Generic Test Definition The definition for automated generic Test | Generic Test Editor | Issue type(s): |
| |
Manual Test Steps The manual steps fields in JSON format | Manual Test Steps | Issue type(s): |
| |
Pre-Condition Type Choose the Pre-Condition Type. It must match the Test Type with which this Pre-Condition is associated | Pre-Condition Type Select List (single choice) | Issue type(s): |
| |
Pre-Condition association with a Test The Pre-Condition issue to associate with this Test | Pre-Condition Association with a Test | Issue type(s): | ||
Requirement Status The status of the Requirement | Requirement Status Custom Field | Issue types mapped as requirements |
| |
Revision The system revision for the test execution | Text Field (single line) | Issue type(s): |
| |
Steps Count Number of Steps in a Manual Test | Manual Test Steps Count | Issue type(s): | ||
Test Execution Status The overall execution status for the tests in the test execution | Execution Status Custom Field | Issue type(s): | ||
Test Plans associated with a Test Start typing to get a list of possible matches or press down to select from a list of existing Test Plans to associate with this Test | Test Plan Association with a Test | Issue type(s): |
| |
Test Set Status The execution status for the tests in the test set | Execution Status Custom Field | Issue type(s): | ||
Test Sets associated with a Test Start typing to get a list of possible matches or press down to select from a list of existing Test Sets to associate with this Test | Test Sets Picker | Issue type(s): |
| |
Test Type Choose the Test Type | Test Type Select List (single choice) | Issue type(s): |
| |
TestRunStatus Latest Test Run final status | Test Run Status Custom Field | Issue type(s): | ||
Tests association with a Pre-Condition Associated Tests with this Pre-Condition | Test Association with a Pre-Condition | Issue type(s): | ||
Tests association with a Test Execution Associated Tests with this Test Execution | Test Execution association with Tests | Issue type(s): | ||
Tests associated with a Test Plan Associated Tests with this Test Plan | Test Association with a Test Plan | Issue type(s): | ||
Tests association with a Test Set Associated Tests with this Test Set | Tests Picker | Issue type(s): | ||
Test Plan Status The aggregated execution status for the tests in the test plan | Test Plan Status Custom Field | Issue type(s): | ||
Tests Count Number of Tests within a Test Set or a Test Plan issue | Issue Links Count | Issue type(s): | ||
Test Environments Test Environment(s) associated with the Test Execution | Test Environments Custom Field | Issue type(s): |
| |
Test Execution Defects Shows the number of defect issues associated with a Test Execution issue. These can be directly linked with the issue using Jira issue links or defects that were created during testing within Test Runs | Test Execution Defects | Issue type(s): | ||
Test Repository Path The Test Repository Path for this issue | Test Repository Path | Issue type(s): |
|
You can hide custom fields or make them required at the Field Configuration Scheme. You can also remove custom fields from the default screens.
Make sure these operations do not affect Xray functionality.
Check if you need to create new custom fields
Your team may want to add extra custom fields to your Xray Issue Types. As Xray uses JIRA Issue features, this is as simple as adding a new custom field to a screen.
You can add new custom fields to:
- Test
- Test Plan
- Test Set
- Test Execution
- Pre-Condition
- Sub Test Execution
Add New Custom Field to Xray Issue Type
Go to Jira Administration > Issues > Custom Fields and click add.
Select the Field Type you want to use (like Text, Select List, Date Picker) and fill the configuration options.
Finally, select the screens where this new field should be available.
Don’t reinvent the wheel. Use standard fields, such as labels and components, and avoid unnecessary creation of custom fields.
Remember that custom fields added to Tests are not copied to Test Runs, so they’re volatile/informative only; they’re not part of the specification.