Xray for Jira

The Xray Test Management for Jira integration provides an alternative to managing your tests using the Test Manager. To take advantage of this, you need to install the Jira connector and complete the integration by configuring a new connection in the Test Manager.

To connect your Test Manager instance to an XRay project follow these procedures:

Step 1: Install UiPath® Test Manager for Jira

Step 2: Configure Xray connection in Test Manager

Step 3: (Xray Cloud only) Configure custom field and screens

Supported object types and data transfer direction

Supported objects

• Items synchronized from Xray for Jira to Test Manager are read-only except for attachments, object labels and test case links.
• Defects are synchronized from test executions in Test Manager to Xray for Jira.

Data transfer

The direction of data transfer and corresponding objects are listed in the following table:

Xray for Jira	Direction	UiPath Test Manager
Requirements	→	Requirements
Test cases	→	Test cases
Defect	←	Defects

Prerequisites

• Jira Server account
• UiPath® Test Manager for Jira Server and Jira Data Center - required for Xray for Jira Server and Jira Data Center integration.
• UiPath® Test Manager for Jira Cloud - required for Xray for Jira Cloud integration.

Install UiPath® Test Manager for Jira

1. Log in to Jira as an administrator.
2. Navigate to Settings > Manage Apps.
3. Go to Find new apps.
4. Use the search bar to find UiPath® Test Manager for Jira.
5. Click Install to add the app to Jira.

Configure Xray Connection

1. Log in to Test Manager as an administrator.
2. Open your project.
3. Navigate to Project Settings > Integration.
4. Click New Connection and select XRay from the dropdown to edit the connection.
   
   

   

   
   
5. Configure as follows:
   • Name: Enter a name for your Xray project.
   • Description (optional): Add a description.
   • Server URL: Add the Jira Server URL, including the port number. This is the URL of the server that exposes the Jira REST API. It is usually identical to the URL you navigate to when using Jira through your browser. For example: https://company-name.atlassian.net.
   • Web URL (optional): Add the web URL in case the server URL is not hosted under the same address as the web URL used to access Jira resources.
   • Username: The username you use to authenticate to the Jira API.
   • Password (Xray Server only): The password you use to authenticate to the Jira API.
   • Project Key: Enter the project key from Jira which refers to the project you want to integrate.
   • API Token (Xray Cloud only): Generate an API token. For more information on Atlassian API tokens, see Manage API tokens for your Atlassian account.
   • Client Id (Xray Cloud only): Create an API Key containing a Client Id and Client Secret. You need to be a Jira administrator to perform this action. Enter the Client Id generated in Jira Software.
   • Client Secret (Xray Cloud only): Enter the Client Secret generated in Jira Software.
6. Click Save to add the connection. The Xray connection is added to the Integration list.
7. Copy the API Key.
8. Open Jira and navigate to Project Settings > UiPath® Test Manager.
9. Configure project settings and paste the API key in the API Key - XRay Integration field.
   
   

   

   
   

Configure Custom Field and Screens (Xray Cloud Only)

You need to configure a custom field of type Paragraph, named UiPath Automation to associate it with screens in Xray for Jira. This step is needed so you can view test case automation information in Xray for Jira.

For more information, see Custom Fields and Screen Configuration.

Editing an Xray Connection

1. Log in to the Test Manager as an administrator.
2. Open your project.
3. Click the Settings button to open Project Settings.
4. In the Integration list, click an Xray connection to expand the panel.
5. Click Edit to configure the connection.
6. Click Save to confirm.

Deleting an Xray Connection

Deleting the connection removes all associated requirements and test cases.

1. Log in to the Test Manager as an administrator.
2. Open your project.
3. Click the Settings button to open Project Settings.
4. In the Integration list, click an Xray connection to expand the panel.
5. Click Delete to remove the connection.
6. Click Ok to confirm.

Managing Tests Via Xray

The tests executed through the Orchestrator propagate the results to Xray. For more information on managing tests using Xray, see the Xray Documentation Home.

Important:

• Test cases edited in the Test Manager are not synchronized with Xray. Conversely, changes made to test cases in Xray are reflected in the Test Manager.

Related articles

Defect synchronization