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.
Upgrading HCL OneTest™ API Agent
When a new version of software becomes available, you can perform an upgrade. Use Installation Manager to update the software installation.

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.
- Installation of HCL OneTest™ API Agent
  You can find information about installing HCL OneTest™ API Agent from the HCL OneTest Studio, HCL OneTest Virtualization, 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.
- Upgrading HCL OneTest™ API Agent
  When a new version of software becomes available, you can perform an upgrade. Use Installation Manager to update the software installation.
- 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.
- Configuring HCL OneTest™ API Agent
  After you install HCL OneTest™ API Agent, you must edit or modify the attributes in the Agent.config file for the features that you want to test by using the agent. You need to configure the libraries to enable testing the SUT based on certain technologies and also set up the required proxies for enabling testing.
- Running HCL OneTest™ API Agent on Microsoft™ Windows™
  On computers running Microsoft™ Windows™, the agent is typically installed and run as a Windows service.
- Running HCL OneTest™ API Agent on Unix-like systems
  On Unix-like systems, you can start HCL OneTest™ API Agent by running the Agent executable in the root of the HCL OneTest API Agent installation directory (for example, /opt/HCL/HCLProducts/Agent/).
- Troubleshooting: HCL OneTest™ API Agent
  You can use workarounds to common problems that you might encounter when you install and run the HCL OneTest™ API Agent.
- HTTP/TCP proxy setup
  The process of configuring applications to use the HTTP/TCP proxy varies according to the application.
- Setting up the JDBC proxy
  After you install the JDBC proxy, you must deploy the proxy into the Java™ virtual machine (JVM) of the relevant applications, set up the proxy for use, and verify that it is deployed.
- 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.

Upgrading HCL OneTest™ API Agent

When a new version of software becomes available, you can perform an upgrade. Use Installation Manager to update the software installation.

The procedure for upgrading the package is the same as installing, except that in Installation Manager, you choose Update instead of Install.

Before upgrading

Before you upgrade HCL OneTest™ API Agent, you must stop the service.

Note: You cannot directly upgrade HCL OneTest™ API Agent from any of the earlier versions to the latest version. You must uninstall the existing version and then install the latest version.

Preserving the configuration file

Upgrading the HCL OneTest™ API Agent software or uninstalling an older version to move to a newer version (when the upgrade is not applicable) overwrites the existing Agent.config file. If there are settings in the Agent.config file that must be preserved, for example, HCL® Quality Server domains and environments settings, copy the existing Agent.config file to a temporary location before upgrading. After the upgrade or uninstallation of the software has completed, overwrite the new Agent.config file with the old Agent.config file.