Xray provides a set of custom fields that can be used for several issue types, as detailed in Custom Fields and Screen Configuration.

Aside from these, you can add your own custom fields to these Xray issue types: Tests, Pre-Conditions, Test Sets, Test Executions, Test Plans.

You can't add custom fields to Test Runs because they're not Jira issues.


Xray-provided custom fields

As mentioned in Custom Fields and Screen Configuration, whenever you install Xray, it will also add custom fields that are available only for some issue types. Below are explanations of some of the most important ones:

Begin Date

The start date for the Test Execution or Test Plan.

End Date

The end date for the Test Execution or Test Plan.

Revision

The system revision (or code revision) being tested in the context of a given Test Execution. It is an open field that can contain the Git commit hash or the SVN revision, for example. Some users use it to put the build number/identifier.

Adding your own custom fields

You may add CFs to Tests; however, they’re not copied to the Test Run. Custom fields in Tests can be seen as complementary, non-relevant information.

Adding custom fields is not limited to the Test issue type; they can also be added to other Xray issue types, including the Test Execution and the Test Plan. For example, you could add a custom field to identify the browser version to the screen of a Test Execution. Note that, in this example, if you want to analyze your Test Execution per browser, it would be preferable to use the Test Environment custom field instead; otherwise, you can add some custom fields to the Test Execution for the purpose of adding more context to it.


Recommendations

  • 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. Therefore, they’re volatile and informative only; they’re not part of the specification.
  • No labels