Step 2: Configuring Xray connection

Configure the Xray connection in Test Manager by entering your Jira server details and credentials to sync requirements and test cases.

An Xray connection links a Test Manager project to your Xray for Jira project.

Setting up an Xray connection

The connection is created from Project Settings > Integration, and its API Key is then pasted into the UiPath Test Manager settings of your Jira project.

Context

Xray Server uses a password, while Xray Cloud uses an API token and client credentials.

Prerequisites

• A Test Manager administrator account.
• For Xray Cloud, a Jira administrator account. You need it to create the API Key that contains the Client Id and Client Secret.

Steps

1. Log in to Test Manager as an administrator.

2. Open your project.

3. Navigate to Project Settings > Integration.

4. Select New Connection and select XRay from the dropdown to create the connection.

   

5. Configure as follows:

   • Name: Enter a name for your Xray connection.
   • 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. Enter the Client Id generated in Jira Software.
   • Client Secret (Xray Cloud only): Enter the Client Secret generated in Jira Software.

6. Select Save to add the connection.

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.

   

Result

The Xray for Jira project is connected to Test Manager. Requirements and test cases are synchronized from Xray to Test Manager, and test results and defects are synchronized from Test Manager back to Xray and Jira.

Editing an Xray connection

Editing a connection changes the settings of an existing Xray connection, such as the server URL, credentials, or project key.

Prerequisites

• A Test Manager administrator account.
• An existing Xray connection.

Steps

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

Result

The Xray connection is updated with the new configuration details.

Deleting an Xray connection

Deleting a connection removes it together with its associated requirements and test cases.

Prerequisites

An existing Xray connection.

Steps

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

Result

The Xray connection and its associated requirements and test cases are removed.