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)

TypeAvailable Context(s)Screens
Begin Date
The start date of the Test Execution or Test Plan

(tick) 

Date Time Picker
Issue type(s):
  • Default Test Execution Screen
Conditions
The Pre-Condition conditions		(tick) Pre-Conditions Editor
Issue type(s):
  • Default Pre-Condition Screen (Pre-Condition Details)
Cucumber Scenario
The Cucumber Scenario clauses in Gherkin		(tick) Cucumber Test Steps Editor
Issue type(s):
  • Default Test Screen (Test Details)
Cucumber Test Type
The Cucumber Scenario Type		(tick) Automated Test Type Select List (single choice)
Issue type(s):
  • Default Test Screen (Test Details)
End Date
The completion date for the test execution		(tick) Date Time Picker
Issue type(s):
  • Default Test Execution Screen
Exploratory Session
The link to an exploratory session		(error)Exploratory Session

Issue type(s):

  • Default Test Execution Screen
Generic Test Definition
The definition for automated generic Test		(tick) Generic Test Editor
Issue type(s):
  • Default Test Screen (Test Details)

Manual Test Steps

The manual steps fields in JSON format

(tick) Manual Test Steps
Issue type(s):
  • Default Test Screen (Test Details)
Pre-Condition Type
Choose the Pre-Condition Type. It must match the Test Type with which this Pre-Condition is associated		(tick) Pre-Condition Type Select List (single choice)
Issue type(s):
  • Default Pre-Condition Screen (Pre-Condition Details)
Pre-Condition association with a Test
The Pre-Condition issue to associate with this Test		(tick) Pre-Condition Association with a Test
Issue type(s):

Requirement Status
The status of the Requirement		(error)Requirement Status Custom FieldIssue types mapped as requirements
  • Default Screen
Revision
The system revision for the test execution		(tick) Text Field (single line)
Issue type(s):
  • Default Test Execution Screen
Steps Count
Number of Steps in a Manual Test		(error)Manual Test Steps Count

Issue type(s):


Test Execution Status
The overall execution status for the tests in the test execution		(tick)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		(tick)Test Plan Association with a Test

Issue type(s):

  • Default Test Screen (Test Plans)
Test Set Status
The execution status for the tests in the test set		(error) 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		(tick)Test Sets Picker

Issue type(s):

  • Default Test Screen (Test Sets)
Test Type
Choose the Test Type		(tick)Test Type Select List (single choice)
Issue type(s):
  • Default Test Screen (Test Details)
TestRunStatus
Latest Test Run final status		(error)Test Run Status Custom Field
Issue type(s):

Tests association with a Pre-Condition
Associated Tests with this Pre-Condition		(tick)Test Association with a Pre-Condition

Issue type(s):


Tests association with a Test Execution
Associated Tests with this Test Execution		(tick)Test Execution association with Tests
Issue type(s):

Tests associated with a Test Plan
Associated Tests with this Test Plan		(tick)Test Association with a Test Plan

Issue type(s):


Tests association with a Test Set 
Associated Tests with this Test Set		(tick)Tests Picker
Issue type(s):

Test Plan Status
The aggregated execution status for the tests in the test plan		(error)Test Plan Status Custom Field
Issue type(s):

Tests Count

Number of Tests within a Test Set or a Test Plan issue

(error)Issue Links Count
Issue type(s):

Test Environments

Test Environment(s) associated with the Test Execution

(tick)Test Environments Custom Field

Issue type(s):

  • Default Test Execution Screen

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

(error)Test Execution Defects
Issue type(s):

Test Repository Path

The Test Repository Path for this issue

(error)Test Repository Path

Issue type(s):

    • Default Test Screen (General)

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.






  • No labels