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.
Agent and Proxy administration
Use HCL® Quality Server to view and control any of the HCL OneTest™ API agents or proxies.
Viewing rules
Depending on the version of HCL® Quality Server that you are using, you have different options for viewing agents that are currently running.

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.
  - 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 running proxies
      You can view all HCL OneTest™ API proxies that are registered with the current HCL® Quality Server instance and that are running. You can view the agents and the routing or recording rules if the security settings were enabled for you to view them.
    - Viewing running agents
      Depending on the version of HCL® Quality Server that you are using, you have different options to view agents that are currently running. You can view the agents and the routing or recording rules if the security settings are enabled for you to view them.
    - Viewing rules
      Depending on the version of HCL® Quality Server that you are using, you have different options for viewing agents that are currently running.
    - Modifying log levels
      The log level of proxy refers to the default level of events that the proxy must log to HCL® Quality Server instance.
  - 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.
- 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.

Viewing recording or routing rules

Depending on the version of HCL® Quality Server that you are using, you have different options for viewing agents that are currently running.

About this task

The Network Dashboard of HCL® Quality Server lists agents and proxies registered with it. You can view the agents and the routing or recording rules if the security settings were enabled for you to view them.

You can view the routing or recording rules configured for an agent or proxy by completing the following tasks:

Procedure

In the landing page of HCL® Quality Server, click the Network icon or navigation link.

The Network Dashboard is displayed with the following information about the agents or proxies:

Activity	Lists the agent or proxy
Domain	Lists the name of the domain
Environment	Lists the name of the environment in the domain
Target	Lists a summary view of the endpoint that is being recorded or virtualized
Recipient	Lists the destination that captured messages are being sent to

Expand the agent or proxy card by clicking on the expand card icon ( image of the icon

image of the icon

). Click each tab to display the following information:

Tab

Description

Details

This section provides the following information:

Condition	Lists the condition that when matched will cause traffic to be recorded or routed to a virtual service.
Created By	Lists the user who created the rule.
Created At	Lists the date and time of creation of the rule.
Created From	Lists the system name from which the rule originated.
Recording To	Lists the locations to which recorded events are sent.
Routing To	Lists the stub or agent to which traffic is routed to.

Activities

Lists the log of the activities performed by the agent or proxy. Displays details of the activity, date and time, and user (where available) who initiated the activity.