Home
Administrator Guide
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
License management
Licensing for your HCL software is administered through HCL® License & Delivery portal. This portal is FlexNet-based web application to manage software entitlements and licenses.
Setting up licenses for HCL OneTest™ API
Before you can start using HCL OneTest™ API, you must set up and apply the licenses.

Administrator Guide
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
- Installation of HCL OneTest™ API
  You can find information about installing HCL OneTest™ API from the HCL OneTest Studio or HCL OneTest API package.
- Installation of HCL® Quality Server
  You can find information about installing HCL® Quality Server from the HCL OneTest™ Studio, HCL OneTest Virtualization, or HCL OneTest API package.
- Uninstalling the product software
  When you no longer require the software, you can use either Installation Manager or the stand-alone installer to uninstall the products that you have installed.
- License management
  Licensing for your HCL software is administered through HCL® License & Delivery portal. This portal is FlexNet-based web application to manage software entitlements and licenses.
  - Licenses for HCL OneTest™ API and HCL OneTest™ Virtualization
    You can find information about the licenses that you can purchase to use HCL OneTest™ API and HCL OneTest Virtualization.
  - Setting up licenses for HCL OneTest™ API
    Before you can start using HCL OneTest™ API, you must set up and apply the licenses.
    - Setting up licenses on Linux (Ubuntu)
      Before you use HCL OneTest™ API, you must set up and apply the licenses by using a license server.
    - Setting up licenses on Windows
      Before you use HCL OneTest™ API, you must set up and apply the licenses by using a license server.
  - Troubleshooting licensing issues
    After you set up and apply licenses for HCL OneTest™ API, you can troubleshoot issues with licensing by setting up logs.
- Configuration of HCL OneTest™ API
- Administering HCL® Quality ServerHCL® Quality Server
  is a server-based web application providing a central repository for virtualized services. The HCL® Quality Server allows you to use virtual services published with HCL OneTest™ API to create, share, and deploy virtualized test environments in HCL OneTest Virtualization.
- Integrations
  HCL OneTest™ API supports integration with various other tools for quality management, change management, software configuration management, and deployment automation tools such as UrbanCode™ Deploy or HCL® Launch.

Setting up licenses for HCL OneTest™ API

Before you can start using HCL OneTest™ API, you must set up and apply the licenses.

You must apply the licenses that you purchased by using any of the following methods that is based on the network set up and the operating system:

When you use HCL OneTest™ API or the non-GUI applications such as RunTests or IntegrationTesterCmd, an HCL OneTest™ API floating seat license is consumed. This is a portable license that is consumed on-demand, enabling several users and applications to time-share a license. With this license, you can open a project, view, edit, and run resources on the computer on which you have installed HCL OneTest™ API. When you close the application, this seat is released within 15 minutes.

Note: If the license is not used for 15 minutes, the license is returned to the License server for others to consume it. If the product loses connectivity to the HCL® License & Delivery portal, you can use the product for two hours only if the server ID that you entered last time is correct.

You must add the License Server as an environment variable on the computer on which you want to run the HCL OneTest™ API assets. You might want to run the assets on any of the following computers:

On which you have installed HCL OneTest™ API.
On which you have installed Docker.
On which you have installed HCL OneTest™ API Agent, if the computer is different from the one on which you installed HCL OneTest™ API.

Configure the environment variables as described in the following table:


Environment variable	Description	Value
HCL_ONETEST_LICENSING_URL	The value specifies the URL of the licensing server.	The value depends on the method you used to configure the license server. For example, if you used the Cloud License Server, the value can be as follows: `https://hclsoftware.compliance.flexnetoperations.com`
HCL_ONETEST_LICENSING_ID	The value specifies the ID of the licensing server.	The ID is a 12-character alphanumeric identifier provided by HCL for the product licenses you purchased.