Managing the Xray configuration

You can manage the configuration of the Xray integration that you set in HCL DevOps Test Hub (Test Hub) 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 the 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 Test Hub. 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 Test Hub.

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.
Go to the Jira Xray Test Management and within the Configuration details of Jira Xray section the details about the Xray integration is configured are displayed.
Perform any of the following actions when you want to update or delete the Xray configuration:
- To update the Xray API keys that were set previously in the Xray configuration, go to Step 6.
- To delete the Xray configuration, go to Step 7.
Perform the following steps to update the Xray API keys:
1. Click the Update Credentials icon of the Xray integration that you want to manage.
  The Update Xray Integration dialog is displayed.
2. Enter the Xray API key that was generated for the Client ID in the Client ID field.
3. Enter the Xray API key that was generated for the Client Secret in the Client Secret field.
4. Click Update to save the updated Xray API keys in the Configuration details of Jira Xray.
The Xray configuration is updated and a confirmation message is displayed.
Perform the following steps to delete the existing Xray configuration:
1. Click the Delete icon .
  The Delete Xray configuration dialog is displayed.
2. Click Confirm.
  
  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 Test Hub even after you delete the Xray configuration.

Results

You achieved the following results:

Updated the Xray configuration.
Deleted the Xray configuration.