Welcome
Administrator Guide
This guide describes how to install HCL OneTest™ UI software. After you install the software, you can perform administration tasks such as license configuration and integration with other products. This guide is intended for administrators.
Integrations in UI Test perspective
In this section, you will learn about the supported integrations for the Web UI Test perspective.
Testing with HCL OneTest™ API
Starting from V9.5.0, you can use HCL OneTest™ API extension to execute API tests. In HCL OneTest UI, you can either import the projects from HCL OneTest API or manage them from HCL OneTest UI by establishing the connection between the products. In HCL OneTest UI, you can create a compound test to run the IntegrationAPI tests by using the Agents.
Running HCL OneTest™ API tests
You can use HCL OneTest™ UI Extension for HCL OneTest API to run HCL OneTest API tests.

Release Notes
This document contains information about what's new, installation instructions, known problems in and contact information of HCL Customer Support.
System Requirements
This document includes information about hardware and software requirements for HCL OneTest™ UI.
Getting Started Guide
This guide provides an overview of HCL OneTest™ UI. You can find the task flows to get you started with HCL OneTest UI. This guide is intended for new users.
Tutorials
This section contains the tutorials which explains the main features of HCL OneTest™ UI.
Samples
This section describes about the sample project which can be used with HCL OneTest™ UI to test the functionality of an application.
Administrator Guide
This guide describes how to install HCL OneTest™ UI software. After you install the software, you can perform administration tasks such as license configuration and integration with other products. This guide is intended for administrators.
- Installing
  In this section, you will learn about two ways to install the product. In the first approach, you use an executable file to directly install the product in an easy manner. In the second approach, you download and install IBM® Installation Manager and then use that tool to install the product.
- Starting HCL OneTest™ UI from the command line
  You can start HCL OneTest™ UI from the desktop environment or a command-line interface.
- Integrations in UI Test perspective
  In this section, you will learn about the supported integrations for the Web UI Test perspective.
  - Integration plugin compatibility matrix
    You can find information about the versions of the integration plugin that are compatible with HCL OneTest™ UI.
  - Testing with Ant
    You can use Ant to run compound tests and Web UI tests from the command-line interface.
  - Integration with Azure DevOps for UI tests
    When you use Azure DevOps for continuous integration and continuous deployment of your application, you can create tests for your application in HCL OneTest™ UI and run those tests in Azure DevOps pipelines. You can integrate Azure DevOps with HCL OneTest UI by using the HCL OneTest Studio extension that is available in the Visual Studio Marketplace portal.
  - EGit integration
    EGit is an Eclipse plugin for the Git version control system. You can store your test assets in the Git repository and use EGit for the daily version control operations.
  - Testing with Rational® Team Concert™
    You can manage test assets with Jazz™ source control management by integrating the test workbench with IBM® Rational® Team Concert™ (formerly known as Rational Team Concert) eclipse client.
  - Integration with Engineering Test Management
    You can integrate IBM® Engineering Test Management (formerly known as IBM Rational® Quality Manager) with HCL OneTest™ UI to initiate test runs from Engineering Test Management.
  - Integration with Jenkins
    You can use the HCL OneTest™ UI Jenkins plugin to run tests on a Jenkins server.
  - Testing with Maven
    Starting with v9.2, you can use the Maven plug-in to run Functional Test scripts. Apache Maven is a software build tool based on the concept of a project object model (POM). You can use the Maven plug-in that is provided to run tests as part of your Maven build.
  - Integration with Micro Focus ALM
    You can integrate HCL OneTest™ UI with Micro Focus Application Lifecycle Management (ALM) to run test assets from Micro Focus ALM.
  - Testing with HCL OneTest™ API
    Starting from V9.5.0, you can use HCL OneTest™ API extension to execute API tests. In HCL OneTest UI, you can either import the projects from HCL OneTest API or manage them from HCL OneTest UI by establishing the connection between the products. In HCL OneTest UI, you can create a compound test to run the IntegrationAPI tests by using the Agents.
    - Running HCL OneTest™ API tests
      You can use HCL OneTest™ UI Extension for HCL OneTest API to run HCL OneTest API tests.
  - Testing with UrbanCode Deploy
    With the HCL OneTest™ UI plugin for UrbanCode™ Deploy, you can automate the execution of tests and compound tests.
- Integrations in Functional Test perspective
  In this section, you will learn about the supported integrations for the Functional Test perspective.
Test Author Guide
This guide describes how to create test scripts and enhances them by applying different test elements such as dataset, variables, and verification points.
Test Execution Specialist Guide
This guide describes how to automate the playback of the tests by using different methods such as Docker, IBM Cloud Private, Jenkins and so on. The test results can be pushed to HCL Quality Server.
Test Manager Guide
This guide describes how to keep track of the performance of the application by evaluating the test results. Following topics cover how you can work with the test results.
Troubleshooting
This guide describes how to analyze and resolve some of the common problems that you might encounter while you work with HCL OneTest™ UI.
Reference Guide
This guide describes the additional topics to gain more knowledge about HCL OneTest™ UI.
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™ UI as a PDF file.
Security Considerations
You can take certain actions 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.

Running HCL OneTest™ API tests

You can use HCL OneTest™ UI Extension for HCL OneTest™ API to run HCL OneTest™ API tests.

You can install both the products on the same machine, establish the connection, and run HCL OneTest™ API tests. See Testing with HCL OneTest™ API.

You also have the option to just import the projects to HCL OneTest™ Performance HCL OneTest™ API, add the tests to a compound test to run them. You can either use HCL OneTest™ Performance Agent or HCL OneTest™ API Agent to generate the load. You need a compound test that contains the HCL OneTest™ API tests.

Setting environment variable

To run the tests with HCL OneTest™ API Agent, set the environment variable INTEGRATION_TESTER_AGENT_HOME and point it to the HCL OneTest™ API Agent installation directory.

On Windows, set:

INTEGRATION_TESTER_AGENT_HOME = C:\Program Files\HCL\HCLProducts\Agent

On Linux, set:

INTEGRATION_TESTER_AGENT_HOME=/opt/HCL/HOT-API-Agent
export INTEGRATION_TESTER_AGENT_HOME
echo $INTEGRATION_TESTER_AGENT_HOME

If the variable is not set, you will get a test log with error message when the compound test is run. Error message when the environment variable is not set

Error message when the environment variable is not set

Running the compound test

Click Run Compound Test.
After the run completes, the HCL OneTest™ API report displays statistics on the executed sequences and Timed Sections if some are defined in the tests.

Overall page of the report