Xray Integration
This document explains how to set up and use Xray (Jira) integration in Katalon True Platform.
You can enable Xray on a Jira-connected project, push test execution results to Xray, and see the linked Xray Test Execution on your test run details.
Xray integration in True Platform rides on your existing Jira connection and is rolled out per organization. Display of the linked Xray Test Execution on test run details is controlled by an organization setting — if you do not see it, contact your account admin or Katalon to enable it.
Find your starting point:
- Setting up Xray for the first time? -> Start from Step 1.
- Jira is connected and you want to enable Xray on a project? -> Skip to Step 2.
- Xray is enabled and you want to push results? -> Skip to Push test execution results to Xray.
Step 1: Connect Jira​
Xray integration is configured as part of your Jira integration. Set up the Jira connection first.
Follow Jira integration to connect Jira at the account level and link it to your project, then return here. Both Jira Cloud and Jira Data Center / Server are supported as Jira connection types.
Step 2: Enable Xray on the project-level​
- You must have the Project Admin role to configure it on a project.
Xray is enabled inside the project-level Jira integration configuration.
- Navigate to your Project Settings > Integrations.
- Add a new configuration for your linked Jira connection.
- Select the Jira project configured with Xray and available board.
- Scroll down to the Xray setup section, enable Xray and enter your Xray Client ID.
- Complete the mapping for the issue types, then save.
The Xray setup section appears only for eligible Jira integrations. It is not shown for other integration types, such as Jira DC or Azure DevOps.
If the Xray settings are disabled, another Jira integration owns the project's ALM bridge. Open that Jira integration and configure Xray there.
Push and view test execution results in Xray​
Once Xray is enabled, the Push to Xray action is available on your executions. Click the button send execution results to a Xray Test Execution in Jira.
You can also configure Xray behavior on scheduled runs, including the Xray import report type, from the schedule configuration.
After results are pushed, navigate to Additional Information > Details and click the linked issue under ALM Test Execution to open the test run result in Jira.