Welcome
Test Execution Specialist Guide
This guide describes tasks that you must complete before you can configure and run tests in HCL DevOps Test Hub (Test Hub). You can find information about configuring runs for the different test types that are supported. You can also find information about other tasks that you can perform on the Resource Monitoring Service, Virtualization, and Integrations with third-party applications. This guide is intended for testers or test execution specialists.
Integrations with other applications
You can integrate certain applications with HCL DevOps Test Hub (Test Hub) to run tests, view the test results, and create defects.
Integration with Xray test management for Jira
When you use Jira as a change management system on HCL DevOps Test Hub (Test Hub) and you use Xray as the test management application in Jira, you can integrate Xray with Test Hub. With this integration, you can export the test results of the tests that run on Test Hub to your Jira project. You can then view and use the test results in your project in Jira.
Generating API keys for the Xray app in Jira
You must generate API keys for the Xray app in Jira and use them to configure the Xray integration in HCL DevOps Test Hub (Test Hub). The Xray API keys are used by Jira to authenticate the requests from Test Hub.

Release Notes
This document includes information about the new features introduced, features deprecated or removed, defects fixed, and known issues identified in this version of HCL DevOps Test Hub (Test Hub). You can also find the installation and upgrade instructions along with the contact information of HCL Customer Support.
System Requirements
This document includes information about hardware and software requirements for HCL DevOps Test Hub (Test Hub).
Getting Started Guide
This guide provides an overview of HCL DevOps Test Hub (Test Hub). You can find the task flows to get you started with Test Hub. This guide is intended for new users.
Administrator Guide
This guide describes how to install the HCL DevOps Test Hub (Test Hub) software.
Test Author Guide
This guide describes how to create and edit test assets in HCL DevOps Test Hub (Test Hub), and then publish test assets to the remote Git repository that you have configured in your project. This guide is intended for testers and test managers.
Test Execution Specialist Guide
This guide describes tasks that you must complete before you can configure and run tests in HCL DevOps Test Hub (Test Hub). You can find information about configuring runs for the different test types that are supported. You can also find information about other tasks that you can perform on the Resource Monitoring Service, Virtualization, and Integrations with third-party applications. This guide is intended for testers or test execution specialists.
- System modeling
  You can use the system model feature on HCL DevOps Test Hub (Test Hub) to create a model that simulates an application or system under test. You can define components to represent the actual components in the system under test, define their relationships and then view the components in a system under test as a diagrammatic representation.
- Prerequisites to running tests
  Before you can run a test asset in a project on HCL DevOps Test Hub (Test Hub), you must read the information about the different tests assets. You can add a remote static agent, Docker host, or Kubernetes cluster to the project and then select it as an alternate location to run the test assets.
- Management of agents
  You can find information about managing performance agents or API agents that you install on remote computers and then configure the remote agents to register with HCL DevOps Test Hub (Test Hub). After the agents are registered, you can add them to your projects and then select them as locations to run tests or virtual services.
- Management of Docker hosts
  You can find information about the tasks that you can perform on remote Docker hosts. After you set up a remote Docker host, you can register the Docker host with HCL DevOps Test Hub (Test Hub). You must then add the registered remote Docker host to your project before you can run tests on the remote Docker host location.
- Management of remote Kubernetes clusters
  You can find information about the tasks that you can perform on remote Kubernetes clusters. After you set up a remote Kubernetes cluster, you can register the external cluster with a team space on HCL DevOps Test Hub (Test Hub). You must then add the remote cluster to a project before you run test assets or resources on the remote Kubernetes cluster.
- Management of mobile device cloud credentials
  You can find information about managing the credentials that are required to connect to mobile device clouds from HCL DevOps Test Hub (Test Hub).
- Test run configurations
  You can configure and run tests in HCL DevOps Test Hub (Test Hub) after you add the test resources to your project in your team space.
- Configuration of test runs in a GitHub Actions Workflow
  You can configure test runs of test resources that are in a project repository of HCL DevOps Test Hub (Test Hub) in a GitHub Actions Workflow. You can choose to run test resources that are in your server project in the GitHub Workflow when you do not want to run the test resources without opening the Test Hub project.
- Configuration of a scan of an application code
  You can use HCL DevOps Test Hub (Test Hub) to scan your application code for security vulnerabilities similar to using the HCL® AppScan CodeSweep plugin to scan code in Visual Studio.
- Management of running tests
  Find information about the tasks that you can perform on a test that you configured for a run either while it runs or after it completes the run.
- Management of virtualized services
  You can find information about the tasks that you can perform on and manage the virtualized services that run on HCL DevOps Test Hub (Test Hub). You can start or stop the virtual services that are available to Test Hub. You can view the routing rules and usage statistics of virtualized services, agents, or intercepts that are connected to Test Hub.
- Test results
  After the tests, Suites, or schedules are run and completed, you can view the results and open the reports in HCL DevOps Test Hub (Test Hub) to analyze the verdict, the performance, and statistics. You can also re-execute tests and schedules from the Results page with the same commit id.
- Machine learning capabilities in DevOps Test Hub
  HCL DevOps Test Hub (Test Hub) uses Machine learning (ML) algorithms to analyze tests that match certain requirements and criteria, and then presents the findings as insights and recommendations after the tests are run. You can use the insights and recommendations to interpret the test results and identify the problem areas in the system under test.
- Resource monitoring
  When you apply load to a system under test, the amount of resources consumed by your system is increasing. If the capacity of the resources does not match the load, you can see performance issues in the results. Resource monitoring in HCL DevOps Test Hub (Test Hub) helps you monitoring the resources of a system and establish the performance metrics and usage data of the system. Thus, you can observe the health of these resources while a schedule is running.
- Configuration of a change management
  When you use any application to create and track defects (bugs), issues, or other work items, you can configure the application as a change management on HCL DevOps Test Hub (Test Hub). You can then create defects (bugs), issues, or other work items without the need to open your application.
- Integrations with other applications
  You can integrate certain applications with HCL DevOps Test Hub (Test Hub) to run tests, view the test results, and create defects.
  - Integration plugin compatibility matrix
    You can find information about the versions of the integration plugin that are compatible with HCL DevOps Test Hub (Test Hub).
  - Integration with Azure DevOps
    When you use Azure DevOps for continuous integration and continuous development of your application, you can run tests created for your application and available in a project on HCL DevOps Test Hub (Test Hub), in Azure DevOps pipelines by using the HCL DevOps Test Hub extension.
  - Integration with HCL DevOps Deploy
    You can integrate HCL DevOps Test Hub (Test Hub) with HCL DevOps Deploy (Deploy) to run test assets as a Process from Deploy.
  - Integration with IBM® DevOps Deploy
    You can integrate HCL DevOps Test Hub (Test Hub) with IBM® DevOps Deploy (Deploy) to run test assets as a Process from Deploy.
  - Integration with IBM® Engineering Test Management
    As a Project Owner, you can integrate Engineering Test Management as a quality management solution with HCL DevOps Test Hub (Test Hub). You can run test assets that are available in a project from Engineering Test Management.
  - Integration with Jenkins
    You can use the HCL DevOps Test Hub (Test Hub) plugin to integrate Test Hub with Jenkins. After you complete the integration, you can run tests assets that are available in a project of Test Hub from a Jenkins server.
  - Integration with Xray test management for Jira
    When you use Jira as a change management system on HCL DevOps Test Hub (Test Hub) and you use Xray as the test management application in Jira, you can integrate Xray with Test Hub. With this integration, you can export the test results of the tests that run on Test Hub to your Jira project. You can then view and use the test results in your project in Jira.
    - Generating API keys for the Xray app in Jira
      You must generate API keys for the Xray app in Jira and use them to configure the Xray integration in HCL DevOps Test Hub (Test Hub). The Xray API keys are used by Jira to authenticate the requests from Test Hub.
    - Configuring the Xray integration
      You can set up the Xray integration when you want to export test results from HCL DevOps Test Hub (Test Hub) to an issue in your Xray project in Jira. You must configure the Xray integration in your project in Test Hub before you select the Xray project in Jira as the location to export the test results after the test runs in Test Hub.
    - Selecting a Jira Xray issue to export test results
      After you configure the Xray integration on HCL DevOps Test Hub (Test Hub), you can select a Jira Xray issue in Jira or create a new issue in Jira to export the test results. The test results are exported to the selected issue after the tests run on Test Hub. You can then view and track the test results in your Jira project.
    - 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.
- Managing access to DevOps Test Hub
  Desktop clients and third-party integrations use offline user tokens to connect to HCL DevOps Test Hub (Test Hub).
- Working with DevOps Test Hub REST services
  When you want to use the REST APIs of HCL DevOps Test Hub (Test Hub) in your test automation scripts, you can view the REST APIs that are exposed by Test Hub. You can also run the APIs from within your project in Test Hub.
Test Manager Guide
This guide describes how to manage and track your overall test effort. This guide is intended for test managers.
Troubleshooting
This guide describes how to analyze and resolve some of the common problems that you might encounter while you work with HCL DevOps Test Hub (Test Hub).
All Guides (PDF)
You can find the link to view or download the content of the release notes, system requirements, and persona guides of HCL DevOps Test Hub (Test Hub) as a PDF file.
Security Considerations
This document describes the actions that you can take to ensure that your installation is secure, customize your security settings, and set up user access controls in HCL DevOps Test Hub (Test Hub).
Notices
This document provides information about copyright, trademarks, terms and conditions for the product documentation.

Generating API keys for the Xray app in Jira

You must generate API keys for the Xray app in Jira and use them to configure the Xray integration in HCL DevOps Test Hub (Test Hub). The Xray API keys are used by Jira to authenticate the requests from Test Hub.

Before you begin

You must have completed the following tasks:

Read about the prerequisite tasks in Prerequisites.
Verified that you can access Jira.
Ensured that you are assigned a role as a Project Owner or Tester in the project. See Managing access to the server projects.
Created a project in your team space in Test Hub. See Adding a project.

Procedure

Log in to Jira.
Click Settings > Apps.

The apps that are installed in Jira are listed in the navigation pane.
Find the Xray App in the navigation pane, and then click the API Keys option.

The API Keys page is displayed.
Click Create API Key.

The Create API Key dialog is displayed.
Enter your username in the User field, and then select the username that is displayed.
Click Generate.

The API keys are generated and displayed under the Client ID and Client Secret fields.
Click the Copy icon in the Client ID field to copy the key, and then paste the copied key into a text file.
Click the Copy icon in the Client Secret field to copy the key, and then paste the copied key into a text file.

Results

You have generated the Xray API keys in Jira.

What to do next

You must use the Xray API keys to configure the Xray integration in Test Hub. See Configuring the Xray integration.