Is Xray integration still available?

Integrations
1

Hi everyone, I wanted to know if the Xray integration with Katalon is still available in current versions.

I saw this document (Configure Xray Integration in Katalon TestOps (Legacy) | Katalon Docs) and was interested in the feature to automatically send results to X-ray. Thank you.

2 Likes
2

Great find! Let me ping our internal team to seek solutions for you, my best take is it should have!

3

I need to automate the sending of results generated by Katalon to the Xray API.
Currently, we are running a .bat file manually and it’s tedious; I would be delighted if there were a solution to this.

4

Which setup are you using? This might help us guide you correctly:

  1. Simple TestOps users
  2. Manual test execution
  3. CI/CD pipeline users
5

Thanks for your reply!

At the moment I’m using manual test execution:

  • I have Katalon Studio Enterprise installed on my local machine.

  • I run the test suites manually from Katalon.

  • After each execution, I manually run a .bat script that calls the Xray Cloud REST API to upload the JUnit/XML reports.

What I want to achieve is to automate this upload step, so that the results are sent to Xray automatically after each execution, without having to run the .bat file by hand.

If there’s any recommended way to integrate this flow (Katalon → Xray) in current versions, I’d really appreciate some guidance.

2 Likes
6

Current Xray Integration Capabilities

According to the official Katalon documentation, the Xray integration now supports:

:white_check_mark: Automatically/manually push TestOps test run to Jira as Xray test execution
:white_check_mark: Manage Xray test execution with release versions and evidences from TestOps
:white_check_mark: Synchronize TestOps test results to Xray test run
:white_check_mark: Link TestOps test cases with Xray tests on Jira
:white_check_mark: Link TestOps test schedules with Xray test plans on Jira

You have two approaches to automate sending results to Xray:

Option 1: Automatic Push via TestOps (Recommended)

When you link a Katalon test run to an Xray test plan in TestOps, you can configure automatic result pushing with three mechanisms:

  1. Manual push only - You manually decide which test runs to upload
  2. Push on all runs - Katalon automatically uploads ALL test run results to Xray
  3. Push on passing runs only - Katalon automatically uploads only passing test results to Xray

Steps:

  1. Configure Xray integration in Katalon TestOps (Settings > Integrations > Jira/Xray)
  2. Link your Katalon test run to an Xray test plan
  3. Select your preferred push mechanism (e.g., “Push on all runs”)
  4. Results will be automatically uploaded to Xray after each test execution

Reference: Link a Katalon test run with an Xray test plan

Option 2: Use Katalon Report Uploader CLI

If you prefer to keep your current .bat file approach but automate it, you can use the Katalon Report Uploader with the

--push-to-xray=true parameter:

image
image1270Ă—270 21.1 KB

This allows you to integrate the upload step directly into your CI/CD pipeline or test execution scripts.

Reference: Use Katalon Report Uploader

Next steps:

  1. Upgrade to current Katalon TestOps if you’re still on the legacy version
  2. Configure Xray integration in your TestOps project settings
  3. Link your test runs to Xray test plans and select automatic push
  4. Your test results will now be automatically sent to Xray after each execution, and no more manual .bat file runs needed!

Please try it out, hope this might help, if not, we can bring in our community to assist you with this.

Bella

1 Like
7

Based on the official Katalon documentation, here’s the current status of Xray integration:

Important Notice: Legacy Feature

:warning: The Xray integration is currently available ONLY in Katalon TestOps Legacy, not in the current version of Katalon TestOps.

According to the official documentation:

“This document covers TestOps Legacy version only.”

What This Means

Aspect Status
Current Katalon TestOps :cross_mark: Xray integration NOT available
Katalon TestOps Legacy :white_check_mark: Xray integration available
Auto-upload to Xray :white_check_mark: Available in Legacy version
Manual push to Xray :white_check_mark: Available in Legacy version

What You Can Do with Xray Integration (in Legacy)

If you’re using Katalon TestOps Legacy, you can:

  1. Link Xray test cases with Katalon test cases
  2. Link Xray test plans with Katalon test runs
  3. Automatically upload Katalon test results to Xray
  4. Manually push test results to Xray
  5. Link Jira fix versions and test evidence to uploaded results

How to Set Up Xray Integration (Legacy Only)

Prerequisites:

  • Your Jira project must have an active Xray configuration
  • You must have Admin role in your Katalon project

Steps:

  1. Go to Settings > Integrations in Katalon TestOps
  2. Select Jira/Xray
  3. Enter your Jira URL, username, and Atlassian API token
  4. Toggle on Enable Xray integration
  5. Enter your Xray API key in the Client ID field
  6. Test the connection
  7. Link your Jira project
  8. Map Xray issue types to TestOps entities
  9. Click Save

Reference: Configure Xray Integration in Katalon TestOps (Legacy)

Recommendation

If you’re using the new Katalon TestOps and need Xray integration, you have two options:

  1. Continue using Katalon TestOps Legacy - where Xray integration is fully supported
  2. Contact Katalon Support - to inquire if Xray integration is planned for the current TestOps version

The documentation doesn’t indicate whether Xray integration will be added to the current TestOps version, so it’s best to confirm directly with the Katalon team.