How do I add Xray items to Jira and see them in Ketryx? – Ketryx

Frequently Asked Questions

How do I add Xray items to Jira and see them in Ketryx?

To add Xray item types to Ketryx in Jira, you'll need to follow a process similar to adding custom item types. Ketryx integrates with Xray Test Management for Jira by mapping Xray Tests, Test Executions, and Test Plans to Ketryx items.

Here's how to set it up:

First, (if you have not already) you will need to create an API key in Xray. Go to Jira under Apps > Manage your apps > XRAY > API Keys to create this key.
In Ketryx, enter the Client ID and Client Secret from your Xray API key in the organization settings under Organization > Connections. Note that you'll need the Manage connections permission in Ketryx to do this.
Note: If your Jira is configured with Xray issue types at the time of connection, Ketryx will create a specific issue type scheme with a Ketryx Test Execution instead of the standard Test Execution issue type scheme to avoid confusion. The reverse is also true: if Ketryx is connected first (or there is a work item already called "Test Execution"), Xray's version will be named "Xray Test Execution"
Add the Xray Test Plan, Xray Test, and Xray Test Executions to a copy of your Ketryx scheme in Jira. If you have already made a copy in your Jira instance, these Xray issue types can be added directly. Making a copy is always best practice because otherwise the scheme can be overwritten in a future update of the Ketryx app.

For mapping Xray items to Ketryx, the integration works as follows:

Xray Test Plans are associated with versions using Jira's Fix versions field
Xray Test Plans contain Xray Test Executions and/or Xray Test Cases
Test Executions are composed of test runs that execute specific Xray Tests or Xray Test Plans
Xray Tests can be linked to tested items through Jira's native tests link

For more detailed information on the Xray integration, you can refer to the Ketryx Test Management documentation.

If you need to customize how these item types appear in Ketryx, you may need to use the advanced settings for issue mapping, similar to how you would configure other custom item types.