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.
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.
Troubleshooting: HCL® Quality Server
You can use workarounds to troubleshoot common problems that you might encounter when you use HCL® Quality Server.
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.

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
- 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.
  - Viewing the state of stubs that are published to HCL® Quality Server
    When you as an administrator of HCL® Quality Server want to view the state of stubs that are published to HCL Quality Server, you can use the script provided with the product installation package. You can use this information to manage projects in HCL Quality Server.
  - 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.
    - 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.
- 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.

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.

The usual cause is that the listening port is already taken, or that the user who is associated with the service has insufficient permissions to write to files on the local system.

The Java™ services are started by using the Apache Commons daemon. For reference, see: Procrun Documentation.

Ask for assistance from your local Windows™ administrator during this process.

This example looks at HCL OneTest™ API Agent, but also works for the HTTP Proxy and HCL® Quality Server.

Run the service on the command line

Open the Windows™ Service and make a note of the name of it.
In this case, the name is OneTestAPIAgent.
Additionally, make a note of the user.
Open a command window in the Virtualization installation folder. Run the service as a console application:
```
prunsrv //TS//OneTestAPIAgent
```
If this command works, compare the permissions of the user who is logged in with the one configured in the service. You might be able to run the command as the other user:
```
runas /user:LOCALMACHINENAME\user "prunsrv //TS//OneTestAPIAgent"
```

Service Logging

It is possible to add low-level logging to the service itself. Run the following command:
```
prunmgr //ES//OneTestAPIAgent
```
Set the Level to Debug and configure the Log path folder name.
Restart the service and check the log files. Three log files are produced:
- commons-daemon.2017-09-22.log
- onetestapiagent-stderr.2017-09-22.log
- onetestapiagent-stdout.2017-09-22.log