Page History
...
It's possible to generate a dump of the Xray managed data; note that this dump doesn't contain the information managed by Jira/Atlassian as that follows a different mechanism.
Custom fields
...
Generically speaking, custom fields (CFs) are like custom attributes. They exist as a means to add additional, well-defined information, to certain entities.
...
But whenever "custom fields" come to mind, we may be referring to different kinds of CFs (as Xray also provides some kind of custom fields), and this may cause some misunderstanding. These are the types of fields we may be referring to:
- Jira's traditional "custom fields": In Jira terminology, custom fields (CFs) are a way to collect information that isn't available on the default fields. In other words, Jira CFs are a way to add additional metadata to issues.; we can think on them as issue level "attributes", having a id, name, type, and value. Jira CFs are defined at administration level (server/DC, cloud), and may be included on some screens, for certain issue types. These fields can easily be included on Jira standard gadgets, listings, etc. A field has a visual representation and a text representation. Some fields may be searchable and included on JQL queries. Some fields store data, while others are calcula. Some calculated. It's usual for Jira apps/plugins to create specific Jira CFs to present or manage some of their data as seen ahead.
- Xray managed Jira CFs: Xray data managed as a Jira CF (server/DC, cloud); some of these CFs are read-only, while other are read/write. These are also Jira CFs in strict sense. Xray server/DC has many of these; Xray cloud has very few, due to the way apps integrate with Jira cloud.
- Xray's test Test step custom fields: Xray proprietary way of defining named attributes for steps on "manual" scripted tests; definable at project level. These are not listable/includable on Jira issues/gadgets nor exportable using standard Jira mechanisms; they are also not visible to Jira's REST API.
- Xray's Test Run custom fields: Xray proprietary way of defining named attributes for Test Runs; definable at project level. These are not listable/includable on Jira issues/gadgets nor exportable using standard Jira mechanisms; they are also not visible to Jira's REST API.
| Xray server/DC | Xray Cloud | ||||
|---|---|---|---|---|---|
| read | update | read | update | ||
Jira CFs (issue level) | Jira's REST API | Jira's REST API | Jira's REST API | Jira's REST API | |
Xray data managed as Jira CFs (issue level) | Jira's REST API | Jira's REST API | Jira's REST API | Jira's REST API | |
| Xray test step CFs | Xray's Test Run CFs |
|
|
|
|
| Xray's Test Run CFs |
|
|
|
| |
| Xray managed CF | Xray | Xray managed CF | Xray server/DC | Xray Cloud |
|---|---|---|---|---|
| Begin Date | x (rw) | x (rw) | ||
Conditions | x (rw) | - | ||
| Cucumber Scenario | x (rw) | - | ||
| Cucumber Test Type | x (rw) | - | ||
| Dataset values | x | - | ||
| End Date | x (rw) | x (rw) | ||
| Generic Test Definition | x (rw) | - | ||
| Manual Test Steps | x (rw?) | - | ||
| Pre-Condition Type | x (rw) | - | ||
| Pre-Condition association with a Test | x (rw?) | - | ||
| Requirement Status | x (r) | - | ||
| Revision | x (rw) | x | ||
| Steps Count | x (r) | - | ||
| Test Type | x (rw?) | - | ||
| TestRunStatus | x (r) | - | ||
| Test Plans associated with a Test | x (rw?) | - | ||
| Test Repository Path | x (rw) | - | ||
| Test Sets associated with a Test | x (rw?) | - | ||
| Test Count | x (r) | - | ||
| Tests association with a Pre-Condition | x (rw?) | - | ||
| Tests associated with a Test Plan | x (rw?) | - | ||
| Tests association with a Test Set | x (rw?) | - | ||
| Tests association with a Test Execution | x (r) | - | ||
| Test Environments | x (rw) | - | ||
| Test Execution Defects | x (r) | - | ||
| Test Execution Status | x (r) | - | ||
| Test Set Status | x (r) | - | ||
| Test Plan Status | x (r) | - |
Tips
- try to use the proper APIs as much as possible and avoid using CFs to obtain or modify data
References
- Xray Cloud
- Xray server/DC
Recommendations, tips, and concerns
...