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.
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.

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 test assets in HCL OneTest™ Server and publish test assets to the Git repository that you have configured. You can also edit existing test assets that are in the repository added to 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
  In this topic, you can find information about using the system model feature. You can also find the tasks that you can perform to create a system model. You must configure a repository to save the system model that you created for the application under test.
- 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 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.
- 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.
- 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 connected 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.
- 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 the 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.
Reference Guide
This guide describes conceptual information about data design environment components when you want to use the data fabrication feature in HCL OneTest™ Server.
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.

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.

All REST services are accessible from the base URL of HCL OneTest™ Server and are defined by using Swagger. A navigable user interface lists the available set of APIs at <server_URL>/#/Initial/Admin/docs. This Swagger file describes the individual APIs along with details of the parameters and response bodies.

You must be assigned the role of an administrator to be able to view or run the REST APIs.

After you log into HCL OneTest™ Server with your credentials that has administrator privileges, you must go to the following URL: <server_URL>/#/Initial/Admin/docs

The Swagger docs that are available can be viewed from the drop down list.

You can select the Swagger doc for the REST APIs that you want to view or use. For example, you can select the /jobservicev2/api-docs to view the APIs for the execution micro-service.

You can perform the following steps to view or run the API:

Expand the section to view the APIs that are available.
Expand each of the APIs to view the details such as the description, examples, parameters, and responses.
Run the API by clicking the Try it out option and then enter the required values for the parameters.
Click Execute to start the API.

You can view the response after the API runs.