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 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.
Modifying security model settings after installation
This section explains how to modify HCL Quality Server security model settings after installation.
Configuring the security settings after installation by updating the security.config file
When you configure HCL Quality Server in GUI mode, the security settings are saved to the security.config file in the security folder in the HCL Quality Server workspace. To add or modify the security settings after installing the server in GUI mode use these instructions.

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.
- Upgrading HCL OneTest™ API Agent
  When a new version of software becomes available, you can perform an upgrade. Use IBM® Installation Manager to update the software installation.
- License management
  Licensing for your HCL software is administered through HCL Software License & Download 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/).
- 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 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.
    - Using your own truststore for server SSL connections
      The server by default provides a truststore but you might want to use your own truststore for server SSL connections.
    - Configuring the server HTTP Endpoint
      The server supports both HTTP and HTTPS connections but by default is HTTPS only. It is possible to enable, disable, and change the ports that are used by both HTTP and HTTPS server connections.
    - Registering HCL OneTest™ API Agent with HCL Quality Server
      HCL Quality Server runs stubs on agents. Agents can also be used to run scheduled tests. During the installation of the HCL OneTest™ API Agent, the agent is configured to register with the server instances so that they are available for stubs and/or running scheduled tests.
    - Adding Microsoft™ SQL Server and MySQL drivers
      Microsoft™ SQL Server and MySQL drivers are not supplied with HCL Quality Server. If you want to use SQL Server or MySQL with HCL Quality Server, you must copy the SQL Server or MySQL drivers to the HCL Quality Server installation directory.
    - Modifying security model settings after installation
      This section explains how to modify HCL Quality Server security model settings after installation.
      - Configuring the security settings after installation by updating the security.config file
        When you configure HCL Quality Server in GUI mode, the security settings are saved to the security.config file in the security folder in the HCL Quality Server workspace. To add or modify the security settings after installing the server in GUI mode use these instructions.
        Configuring the Active Directory settings
        You can configure HCL Quality Server to use the Active Directory security model by using IBM® Installation Manager during installation or by using the Modify option after the installation. You can also specify the settings by manually editing the security.config file.
        Configuring the Lightweight Directory Access Protocol (LDAP) settings
        Configuring the Lightweight Directory Access Protocol (LDAP) security for HCL Quality Server works the same way as for Active Directory, except that the LDAP configuration involves setting a few additional properties.
  - 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 the security settings after installation by updating the security.config file

When you configure HCL Quality Server in GUI mode, the security settings are saved to the security.config file in the security folder in the HCL Quality Server workspace. To add or modify the security settings after installing the server in GUI mode use these instructions.

Modifying security settings manually after installing in GUI mode

Before you begin

HCL Quality Server must be installed on the target computer.

About this task

When you install in GUI mode, you can configure Active Directory or LDAP authentication during the installation. To make changes to the security configuration after installation, you can either use the Modify option in the IBM® Installation Manager GUI or edit the security.config file.

Procedure

Stop the server, if it is running.
- On Windows systems, stop the HCL HCL Quality Server service.
- On Unix-like systems, run the stop script. For assistance, contact your system administrator.
Go to the security folder in the server workspace.
- On Windows systems, the folder is typically at C:\HCL\HQS-Workspace\security.
- On Unix-like systems, the folder is typically at /var/hqs/security.
Update the security.config file with Active Directory or Local Directory Access Protocol (LDAP) settings as necessary. For information about various properties associated with Active Directory and LDAP configuration, see Configuring the Active Directory settings and Configuring the Lightweight Directory Access Protocol (LDAP) settings.
Run EncryptPassword.exe available at either of the following locations to encode your administrator password:
- HCL OneTest™ API installation folder (C:\Program Files\HCL\HCLProducts\Agent\ in Windows and /opt/HCL/HCLProducts/Agent/ in Linux)
- HCL OneTest™ API Agent installation folder (C:\Program Files\HCL\HCLProducts\Agent\ in Windows and /opt/HCL/HCLProducts/Agent/ in Linux).
For example:
```
EncryptPassword.exe myPassword 
#com.ghc.1!b2b312954AC84469E34BA2E5
```
Escape the special characters using the \ character as shown in the following example:
```
\#com.ghc.1\!b2b312954AC84469E34BA2E5
```
Update the adminpassword property in the security.config file with the resulting value.
For the changes to take effect, start the server and test your login credentials by using a web browser.