Managing the Xray configuration

You can manage the configuration of the Xray integration that you set in HCL OneTest™ Server when you want to modify the API keys configured or when you want to delete the existing Xray configuration.

Before you begin

You must have completed the following tasks:

Ensured that you are assigned a role as a Project Owner or Tester in the project. See Managing access to server projects.
Ensured that you obtained the access and authentication details to Jira from the Jira administrator.
Configured the Xray API keys for the Xray integration on HCL OneTest™ Server. See Configuring the Xray integration.
Regenerated the Xray API keys in Jira by following the steps to generate the Xray API keys in Generating API keys for the Xray app in Jira.

Procedure

Log in to HCL OneTest™ Server.

The team space that contains your project is displayed.
Click Active projects > My projects > project_name to open the project that contains the test assets.

The Overview page of the project is displayed.
Click Manage > Integration in the navigation pane.
The Integration page is displayed.
Click the TEST MANAGEMENT tab, if it is not already open.

The details about the Xray integration that is configured are displayed.
Click the Open action menu icon of the Xray integration that you want to manage.

The Update credentials and Delete configuration options are displayed in the list.
Perform any of the following actions when you want to modify or delete the Xray configuration:
- To modify the Xray API keys that were set previously in the Xray configuration, go to Step 7.
- To delete the Xray configuration, go to Step 8.
Perform the following steps to modify the Xray API keys:
1. Select Update credentials as the option from the list.
  The Update Xray Integration dialog is displayed.
2. Enter the Xray API key that was generated for the Client Id and copied into the text file, in the Client Id field.
3. Enter the Xray API key that was generated for the Client Secret and copied into the text file, in the Client Secret field.
4. Click Update to save the updated Xray API keys in the Xray configuration.
The Xray configuration is updated and a confirmation message is displayed.
Perform the following steps to delete the existing Xray configuration:
1. Select Delete as the option from the list.
  The Delete Jira server configuration dialog is displayed.
2. Click Delete.
  
  The Xray configuration is deleted and a confirmation message is displayed.
Note: The links to the issues that you created to export the test results are not deleted from the results panel in HCL OneTest™ Server even after you delete the Xray configuration.

Results

You achieved the following results:

Updated the Xray configuration.
Deleted the Xray configuration.