Configure Xray Integration in Katalon TestOps (Legacy)

Attention

This document covers TestOps Legacy version only.

Xray is a complete Test Management tool for Jira. It is an Atlassian marketplace application and runs natively as part of Jira.

With Xray integration you will be able to:

• Link Xray test case with Katalon test case

• Link Xray test plan with Katalon test run

• Manually or automatically upload Katalon test result to Xray

• Link Jira fix version and test evidence to uploaded Katalon test result

This article shows you how to configure Xray integration in Katalon TestOps.

Prerequisites

• Your Jira project must have an active Xray configuration. See Xray Test Management for Jira on Atlassian Marketplace.

• You must have the Admin role in your Katalon project. See Administrative Roles and Permissions.

caution

Jira issue type names with this integration must be specific to avoid errors. We support the following names:

• Test or Xray Test
• Test Plan
• Test Execution
• Test Run

How to enable the Xray integration

1. Sign in to Katalon TestOps and go to your project.
   The project Dashboard page appears.
2. Select Settings > Integrations.
3. Select Jira/Xray from the menu or the search bar.
   The Jira/Xray page appears as below.
4. Enter your Jira URL, Username, and Password in their corresponding spaces:

   • Jira URL must be in the form of https://<site_name>.atlassian.net.

   • In the Username section, enter the email address you have registered for your Jira account.

   • In the Password section, enter an Atlassian Cloud's API token. To retrieve your Atlassian API token, see: API tokens.

5. Toggle on Enable Xray integration.
   
6. In the Client ID section, fill in your Xray API key. To learn how to get your key, see: Xray API key.
7. Click on Test Connection to check your settings. A notification informs you of your connection's success.
   
   Note:

   • In the event of an unsuccessful connection, refresh the page and re-enter all your information.

8. In the Link Project section, select your Jira project from the dropdown list. In the sample image below, the linked project is called Katalon (TD).
   
9. Configure the following Xray Issue Types to associate with your chosen corresponding TestOps entities. Learn more about Xray issues: Xray issue types.
   
10. Click Save.

You have successfully enabled the Jira/Xray integration within Katalon TestOps.