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.
Configuration of HCL OneTest™ API
HTTP/TCP proxy setup
The process of configuring applications to use the HTTP/TCP proxy varies according to the application.

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.
- Configuration of HCL OneTest™ API
  - Installed directories
    When you install HCL OneTest™ API, the following directories are created and populated under the installation directory.
  - User file storage
    HCL OneTest™ API projects store user files, and can be created in any location to which a user has access. However, using a remote or network location can reduce HCL OneTest API performance significantly, so it is recommended that HCL OneTest API is installed on a local drive.
  - Changing the display language
    When you want to use the product in a different language other than the display language of your computer, then you can change the language of the product by using the command-line interface. You can find the information to change the language in Linux or Windows.
  - Configuring the project results database
    Historical test data is stored in the HCL OneTest™ API project results database. It is difficult to estimate the space that is required as the number and type of tests to be run varies. When you create the project results database, 50GB is probably a good starting point.
  - HTTP/TCP proxy setup
    The process of configuring applications to use the HTTP/TCP proxy varies according to the application.
    - Modifying the configuration settings of the HTTP/TCP proxy
      To change the server address, log level, and other settings, you can modify the registration.xml file of the HTTP/TCP proxy.
    - Configuring a HTTP(S) reverse proxy or TCP port forwarding
      The reverse proxy capability allows applications that are unable to configure HTTP(S) forward proxying to address the proxy directly and have it forward these requests to a configured destination, which is also applicable for forwarding TCP-based communications.
    - Advanced HTTP and TCP proxy configuration
      The HTTP protocol runs on top of the TCP protocol, but provides extra information about the message destination. For that reason, the two proxies are configured differently.
    - Configuring Apache Tomcat to use HTTP/TCP proxy
      You must modify the Java™ virtual machine (JVM) so that Apache Tomcat can use an HTTP/TCP proxy. You can configure Apache Tomcat by configuring JVM options in the Tomcat startup script.
    - Configuring WebSphere® Application Server to use HTTP/TCP proxy
      You must modify the Java™ virtual machine (JVM) so that WebSphere® Application Server can use an HTTP/TCP proxy. You can do this change by setting some JVM options through the administrative console.
    - HTTP/TCP proxy logs
      To help you troubleshoot HTTP/TCP proxy problems, a number of logging methods are available for the HTTP/TCP proxy.
    - Starting and stopping the HTTP/TCP proxy
      To route and record HTTP(S) and TCP traffic with HCL® Quality Server and HCL OneTest™ API, you must start the HTTP/TCP proxy. If the proxy is installed as a Windows service, you can configure it for an automatic start on start of the system or for a manual start on demand.
    - Programmatic custom certificate creation in proxy
      When an HTTPS connection is established with an HTTP/TCP proxy, the certificate that is presented to the client by the proxy is retrieved from an existing keypair that represent the intended endpoint or is generated as the default certificate by the proxy and is signed by the private key in the keystore that is configured in the registration.xml. Ordinarily, this mechanism is sufficient. If full control over the generation of certificates is required, an alternative advanced approach is available. The approach requires that custom code is written to generate and sign the required certificates.
  - 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.
  - HCL OneTest™ API tool packages
    To enable HCL OneTest™ API to work with certain technologies, you must configure the required libraries by using the Library Manager and also install and configure HCL OneTest API tool packages that are provided with HCL® Quality Server.
  - Working with Library Manager
    HCL OneTest™ API uses a plug-in architecture to provide support for various middleware and messaging technologies, so the list of third-party products with which it interacts can become large. You can manage this list by using Library Manager. When support for a new architecture or messaging plug-in is required, you use Library Manager to add that support.
  - Debugging failed Windows™ services
    If one of the programs fails to start as a Windows™ service, it can be difficult to determine the cause. Typically the service fails to start but gives no indication of why. The Windows Event log has nothing useful and the process might not have created its log file.
  - HCL OneTest™ API and HCL OneTest™ Server
    You can publish test reports for tests run on HCL OneTest™ API to HCL OneTest Server. You can create secrets collections for your project and store them securely on HCL OneTest Server that you can retrieve the secrets from HCL OneTest Server during tests at runtime.
- 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.

HTTP/TCP proxy setup

The process of configuring applications to use the HTTP/TCP proxy varies according to the application.

Note: The registration.xml file, which is provided with HCL® Quality Server in the httptcp folder, includes some default settings for the HTTP/TCP proxy. You can update the configuration to work with the required applications.

You can configure the settings in a client to route HTTP and HTTPS traffic directly to the system under test, or through a proxy. Two proxy options are possible:

Standard proxy: Client requests are sent to the proxy and forwarded to the system under test. See Modifying the configuration settings of the HTTP/TCP proxy.
Reverse proxy: Client requests are forwarded according to a forward rule in the registration.xml file. See Configuring a HTTP(S) reverse proxy or TCP port forwarding.
Note: For an explanation of when to use a reverse proxy versus a standard proxy, see Virtualizing HTTP.

When an HTTPS connection is established with the HTTP/TCP proxy, the certificate that is presented to the client by the proxy is obtained by using any of the following methods:

Locating an existing private key and certificate that represents the intended endpoint, which is optionally loaded from the keystore file and selected based on the target hostname if available. If no matching keypair is found then a new certificate will be fabricated.
By using the default certificate that is generated by the proxy and signed by the private key in the keystore that is configured in registration.xml (The certificatge can either be the default greenhat one that is shipped or the one that is provided by you). Ordinarily, this mechanism is sufficient, however if full control over the generation of certificates is required then an alternative advanced approach is available that uses custom code. See Programmatic custom certificate creation in proxy.

If you are configuring an application that is already using a proxy server, you can connect the HTTP proxy to the existing proxy. See Chained proxy configuration settings.

The HTTP/TCP proxy can be used for HTTP testing, Virtualizing HTTP, testing TCP-based protocols (such as FIX, IMS™, IPIC and MQTT), and virtualizing TCP.

The following tasks are related to HTTP/TCP proxy configuration:

The following links provide instructions for configuring each listed application type to use the HTTP/TCP proxy: