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.
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.
Configuring stubs to connect to HCL® Quality Server and the HTTP proxy
A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL® Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.

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.
  - Configuring HCL® Quality Server
    You might need to configure the HCL® Quality Server after the application is installed.
  - Getting started
    Start using the HCL® Quality Server.
  - Task flow: Working with the HCL® Quality Server Environments dashboard
    You can use the HCL® Quality Server Environments dashboard to perform various tasks such as starting, stopping stubs and scenarios, and modifying stub configurations after you have published stubs to HCL Quality Server. You can also lock the environment that contain the published stubs.
  - Task flow: Working with the HCL® Quality Server Infrastructure dashboard
    You can use the HCL® Quality Server Infrastructure dashboard to perform administrative tasks such as viewing agents and proxies registered with HCL Quality Server.
  - Task flow: Working with the HCL® Quality Server Network dashboard
    You can use the HCL® Quality Server Network dashboard to perform administrative tasks such as viewing recording or routing rules configured for agents and proxies.
  - Managing users
    HCL® Quality Server has multiple choices associated with its security model. Depending on the security option selected during installation of the HCL Quality Server, different options are available based on the user accounts.
  - Managing domains
    How to create and manage domains in HCL® Quality Server.
  - Working with HCL® Quality Server dashboards
    You can filter, search, sort, and choose the number of items to be displayed in HCL® Quality Server dashboards.
  - Deleting environments
    This topic explains how to delete environments.
  - Agent and Proxy administration
    Use HCL® Quality Server to view and control any of the HCL OneTest™ API agents or proxies.
  - Viewing HCL® Quality Server logs
    If you are an HCL® Quality Server administrator, you can view the audit, activity, and diagnostic logs of HCL Quality Server.
  - Viewing reports in HCL OneTest™ Server
    All the project stakeholders can view test reports for multiple testing products from the Results page on HCL OneTest™ Server. You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
  - Configuring stubs to connect to HCL® Quality Server and the HTTP proxy
    A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL® Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.
  - Troubleshooting: HCL® Quality Server
    You can use workarounds to troubleshoot common problems that you might encounter when you use HCL® Quality Server.

Configuring stubs to connect to HCL® Quality Server and the HTTP proxy

A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL® Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.

There are many ways in which you can establish communication between the services - for example, by using SSH reverse tunneling or a virtual private network. An example of how to configure the stub to connect to the services by using the SSH reverse tunneling method is as follows:

Assumptions

The stub makes available an HTTP transport using port 80.
The stub's HTTP transport is configured to use localhost:3128 as a proxy for pass-through.
The stub is configured to connect to HCL® Quality Server on localhost:5443.

Procedure

In the enterprise, use SSH to connect to the public cloud instance. This creates tunnels for the stub to connect to HCL® Quality Server and the HTTP proxy.
```
ssh -R 5443:${HQS_ENDPOINT} -R 3128:${HTTP_PROXY_ENDPOINT} ${DOCKER_HOST_IP}
```
Start the stub image by using the following command:
```
docker run --net=host -p 80:80 -e RULE_HOST=${DOCKER_HOST_IP} -e RTVS_METRIC_MODE=OFF ${DOCKER_IMAGE}
```
where, --net=host makes the ssh tunnels accessible to the docker container, and RTVS_METRIC_MODE=OFF switches off metrics reporting.
For example:
```
docker run --net=host -p 80:80 -e RULE_HOST=mydockerhost.local -e RTVS_METRIC_MODE=OFF dockerimage
```
For information about the docker run command, see Running stubs in a Docker container.