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 Server
HCL 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.
Getting started
Start using the HCL Quality Server.
Server-based stubs
You can find information about the ways in which the stubs are managed in HCL Quality Server V9.2.1 or later.

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 IBM® 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.
- Configuring HCL OneTest™ API
- Administering HCL Quality Server
  HCL 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.
    - Starting and stopping HCL Quality Server
      You can start HCL Quality Server to enable users to log in by using a web browser. If the server is installed as a service, you can configure it for automatic startup on boot or for manual startup on demand.
    - Logging in and out
      After the HCL Quality Server process is started , you can log in to HCL Quality Server.
    - Navigating the user interface
      After you log in to HCL Quality Server, the landing page is displayed. You can navigate around the user interface and use various pages to view schedules, agents, test results, environments, recorded events, and to handle administrative tasks such as managing users, domains, and security.
    - Server-based stubs
      You can find information about the ways in which the stubs are managed in HCL Quality Server V9.2.1 or later.
  - 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.
- 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.

Server-based stubs

You can find information about the ways in which the stubs are managed in HCL Quality Server V9.2.1 or later.

Earlier to 9.2.1, a stub that was authored and published to the server was shown in the hierarchical view of components and operations and was a one-to-one presentation of the stub definition that came from HCL OneTest™ API. Also, all configuration settings were to be specified as part of the request to start a stub.

In HCL Quality Server V9.2.1 or later, the way in which stubs are worked with has changed. Stubs are now a representation of both their definition and the configuration settings. You must use both when the stub is started and managed by HCL Quality Server. You can now pre-configure the settings that you want to use before you control the execution of the stub.

When you publish a stub definition from HCL OneTest™ API, a server-based stub with a default configuration is created in HCL Quality Server. Pre-existing stub definitions that are present in the server earlier to V9.2.1 are also migrated as new server-based stubs with default configurations. Interactions with pre-existing stub definitions are adapted to the new model in V9.2.1 and are displayed as externally-created instances of running stubs in the Environments Dashboard, where they will remain in this state until they are stopped in HCL Quality Server. For example, you can by using the HCL OneTest™ API command-line client, start a pre-existing stub definition along with its configuration settings, resulting in the creation and starting of an instance of the stub in HCL Quality Server (displayed as an externally-created running stub instance in the Environments Dashboard).

You can view the following types of stubs in the Environments Dashboard:

Stub definitions that are published and become server-based stubs. The running stub is displayed with this icon: .
Stubs that are created because of being started externally to HCL Quality Server and are displayed with this icon: .