Home
Administrator guide
Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
Installing
This section provides topics that are specific to installing HCL OneTest™ API.
Using a proxy server to connect to a license server
In some cases, you might want to use a proxy server to connect to a local license server or a cloud license server.

Administrator guide
Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
- Planning
  Before installing the software, review several platform and security considerations. Review the release notes and network ports information.
- Installing
  This section provides topics that are specific to installing HCL OneTest™ API.
  - Hardware and software requirements
    Before you begin the installation, verify that your hardware and software meet the minimum requirements.
  - Choosing your installation preference
    Choose the installation method that works best for your environment. Use IBM® Installation Manager graphical wizards or command line scripts to install the software.
  - Installation considerations
    Consider the requirements discussed in this section before installing HCL OneTest™ API.
  - Installation considerations for the server
    You can install HCL Quality Server as part of HCL OneTest™ Virtualization.
  - Installing the product software
    This section provides topics that are specific to installing HCL OneTest™ API.
  - Setting up licensing
    Before you start using HCL OneTest™ API, you must set up licensing.
  - Using a local license server
    In some cases, your computer might not be connected to the open Internet. In these cases, you can set up a local license server behind your company firewall. You must install the server on a physical computer and not on a Virtual Machine.
  - Using a proxy server to connect to a license server
    In some cases, you might want to use a proxy server to connect to a local license server or a cloud license server.
  - Uninstalling the software
    Use IBM® Installation Manager to uninstall your product. If no other software products are installed, you can also uninstall the IBM Installation Manager client.
  - Troubleshooting: Installation and configuration
    You can troubleshoot some of the problems that you might encounter when you are installing, configuring, or running HCL OneTest™ API.
- Configuring
  After installing the software, review information about how to configure databases and libraries.
- Integrating
  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.

Using a proxy server to connect to a license server

In some cases, you might want to use a proxy server to connect to a local license server or a cloud license server.

Procedure

Procedure on Windows

You must add these environment variables:
1. Press Windows + Break to open the System Properties window. Select the Advanced tab then click Environment variables.
2. Under System variables, click New to add the following environment variables.
  - HCL_ONETEST_LICENSING_PROXY_URL to the URL of the proxy server, for example, http://<ProxyServer Host name>
  - HCL_ONETEST_LICENSING_PROXY_PORT to the port on which the proxy server is listening.
  - HCL_ONETEST_LICENSING_PROXY_USER to the user name to use to connect to the proxy server.
  - HCL_ONETEST_LICENSING_PROXY_PASS to the password to use to connect to the proxy server.

Procedure on Linux (Ubuntu)

Add the following environment variables to /etc/environment

HCL_ONETEST_LICENSING_PROXY_URL=http://<ProxyServer Host name>
HCL_ONETEST_LICENSING_PROXY_PORT=<ProxyServer Port number>
HCL_ONETEST_LICENSING_PROXY_USER=<ProxyServer user name>
HCL_ONETEST_LICENSING_PROXY_PASS=<ProxyServer password>

Troubleshooting

Additionally logging can be enabled by appending com.hcl.products.test.common.licensing.key.level=INFO to it-logging.properties in the HCL OneTest™ API installation directory.

What to do next

Configuring HCL OneTest API

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box.