Page History
...
- Xray and Jira configuration
- Xray server/DC or Xray Cloud ? (which implicitly will define if Jira server/DC or Jira Cloud are being used)
- Server/DC specific settings
- Use Jira username/password or Personal Access Token?
- Jira username
- Jira password
- Personal Access Token
- Cloud specific settings
- Jira username
- Jira API Token
- On each test on the tool, associate it to an existing Xray Test issue
- specify Test issue key
- Discover the custom fields ids of the entities being used
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.
CFs can be seen as way to expose some internal information, to assign information, connected with some 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):
- 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 Jira apps/plugins create Jira CFs to present or manage some of their data.
- Xray's test step custom fields: Xray proprietary way of defining named attributes for steps on "manual" scripted tests; definable at project level.
- Xray's Test Run custom fields: Xray proprietary way of defining named attributes for Test Runs; definable at project level.
| 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 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) | - |
References
- Xray Cloud
- Xray custom fields
- Test Run CFs
Recommendations, tips, and concerns
...
- Data-driven testing and datasets
- use case for exporting data to BI tools and similar
Useful resources
- Xray Postman Collections (Postman collections showcasing usage of APIs both for Xray server/DC and Xray Cloud, including REST and GraphQL examples)
- RestMan (a Chrome extension very useful to try out REST API call)
- Postman (API client with good support for REST APIs)
- Insomnia (API client that provides good support for GraphQL)
References
- Xray server/DC
- Jira server/DC REST API
- Xray server/DC REST API
- Xray usage tips for improving performance (see integration and REST API sections)
- Xray Cloud
...