Welcome
Test Execution Specialist Guide
This guide describes tasks that you must complete before you can configure and run tests in HCL OneTest™ Server. 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.
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 OneTest™ Server. 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 API agents
You can manage the HCL OneTest™ API agents that you want to use as locations to run tests from HCL OneTest Server. When you install the agents by using your offline user token, the agents are registered with the team space in HCL OneTest Server. You can view the registered agents before you add them to your projects. You can then select the agents as locations to run virtual services.

Release Notes
This document includes information about What’s new, installation and upgrade instructions, known issues, and contact information of HCL Customer Support.
System Requirements
This document includes information about hardware and software requirements for HCL OneTest™ Server.
Getting Started Guide
This guide provides an overview of HCL OneTest™ Server. You can find the task flows to get you started with HCL OneTest Server. This guide is intended for new users.
Administrator Guide
This guide describes how to install the HCL OneTest™ Server software.
Test Author Guide
This guide describes how to create and edit test assets in HCL OneTest™ Server, 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 OneTest™ Server. 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 OneTest™ Server 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 OneTest™ Server, 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 OneTest™ Server. 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 performance agents
    You can manage the performance agents that you want to use as locations to run tests from HCL OneTest™ Server. When you install the agents by using your offline user token, the agents are registered with the team space in HCL OneTest Server. You can view the registered agents before you add them to your projects. You can then select them as locations to run tests.
  - Management of API agents
    You can manage the HCL OneTest™ API agents that you want to use as locations to run tests from HCL OneTest Server. When you install the agents by using your offline user token, the agents are registered with the team space in HCL OneTest Server. You can view the registered agents before you add them to your projects. You can then select the agents as locations to run virtual services.
    - Considerations for running virtual services on remote API agents
      Before you configure a run of a virtual service resource on a remote API agent from HCL OneTest™ Server, you must read the considerations that you must take into account.
    - Viewing API agents that are registered with HCL OneTest™ Server
      After you install the remote HCL OneTest™ API agents and configure them with your offline user token, HCL OneTest API agents register with HCL OneTest Server, and then you can view the registered API agents on the Agents and Intercepts page.
    - Adding an API agent to a project
      You must add the registered API agents to your projects before you select them as the location to run the virtual service resources that are in your project on HCL OneTest™ Performance.
    - Removing an API agent from a project
      You can remove an API agent from your project in HCL OneTest™ Server when you no longer need the agent to run virtual services.
    - Unregistering a remote API agent from HCL OneTest™ Server
      You can unregister a remote API agent that is registered with HCL OneTest™ Server in a team space when you no longer require it.
- 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 OneTest™ Server. 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 OneTest™ Server. 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 OneTest™ Server.
- Test run configurations
  You can configure and run tests in HCL OneTest™ Server 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 OneTest™ Server 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 HCL OneTest Server project.
- Configuration of a scan of an application code
  You can use HCL OneTest™ Server 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 OneTest™ Server. You can start or stop the virtual services that are available to HCL OneTest Server. You can view the routing rules and usage statistics of virtualized services, agents, or intercepts that are connected to HCL OneTest Server.
- Test results
  After the tests, Suites, or schedules are run and completed, you can view the results and open the reports in HCL OneTest™ Server to analyze the verdict, the performance, and statistics. You can also re-execute tests and schedules from the Result page with the same commit id.
- Machine learning capabilities in HCL OneTest™ Server
  HCL OneTest™ Server uses Machine learning (ML) algorithms to analyze test results 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 OneTest™ Server 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 system
  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 system on HCL OneTest™ Server. 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 OneTest™ Server to run tests, view the test results, and create defects.
- Managing access to HCL OneTest™ Server
  Desktop clients and third-party integrations use offline user tokens to connect to HCL OneTest™ Server.
- Working with HCL OneTest™ Server REST services
  When you want to use the HCL OneTest™ Server REST APIs in your test automation scripts, you can view the REST APIs that are exposed by HCL OneTest Server. You can also run the APIs from within your project in HCL OneTest Server.
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 OneTest™ Server.
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 OneTest™ Server 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.
Notices
This document provides information about copyright, trademarks, terms and conditions for the product documentation.

Management of API agents

You can manage the HCL OneTest™ API agents that you want to use as locations to run tests from HCL OneTest™ Server. When you install the agents by using your offline user token, the agents are registered with the team space in HCL OneTest™ Server. You can view the registered agents before you add them to your projects. You can then select the agents as locations to run virtual services.

Note: The API agent is referred interchangeably as either the HCL OneTest™ API agent or API agent in the documentation.

Before you run any of the supported virtual services on a remote HCL OneTest™ API agent from a project on HCL OneTest™ Server, you must have completed the following tasks:

Installed the HCL OneTest™ API agent of the same version as the version of HCL OneTest™ Server. Refer to the HCL OneTest™ Virtualization documentation at Installing HCL OneTest API agent.
Configured the HCL OneTest™ API agent so that the HCL OneTest™ API agent can register with HCL OneTest™ Server.
Note: When you configure the HCL OneTest™ API agent by using the offline user token, HCL OneTest™ Server considers you as the owner of the API agent.
Viewed the API agents that are registered with HCL OneTest™ Server. See Viewing API agents that are registered with HCL OneTest Server.
Added the remote API agents that are registered with HCL OneTest™ Server to your project on HCL OneTest™ Server. See Adding an API agent to a project.

If you do not want to retain the API agents in a project or if you want to add the API agents to a different project, you can remove the API agents from a project. When you remove an API agent from a project, you cannot select that API agent to run virtual services in the project. See Removing an API agent from a project.

If you want to remove a registered API agent from a team space in HCL OneTest™ Server when the API agent is not available for use, you can unregister a remote API agent from a team space. See Unregistering a remote API agent from HCL OneTest Server.