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.
Configuration of HCL OneTest™ API
Configuring the project results database
Historical test data is stored in the HCL OneTest™ API project results database. It is difficult to estimate the space that is required as the number and type of tests to be run varies. When you create the project results database, 50GB is probably a good starting point.
Creating the project results database by using Microsoft™ SQL Server
You can create project results databases by using Microsoft™ SQL Server.

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
  - Installed directories
    When you install HCL OneTest™ API, the following directories are created and populated under the installation directory.
  - User file storage
    HCL OneTest™ API projects store user files, and can be created in any location to which a user has access. However, using a remote or network location can reduce HCL OneTest API performance significantly, so it is recommended that HCL OneTest API is installed on a local drive.
  - Changing the display language
    When you want to use the product in a different language other than the display language of your computer, then you can change the language of the product by using the command-line interface. You can find the information to change the language in Linux or Windows.
  - Configuring the project results database
    Historical test data is stored in the HCL OneTest™ API project results database. It is difficult to estimate the space that is required as the number and type of tests to be run varies. When you create the project results database, 50GB is probably a good starting point.
    - Creating the project results database by using IBM® Db2®
      You can create project results databases that are based on IBM® Db2®.
    - Creating the project results database by using Oracle
      You can create a project results database that uses Oracle.
    - Creating the project results database by using Microsoft™ SQL Server
      You can create project results databases by using Microsoft™ SQL Server.
    - Creating the project results database by using MySQL
      You can create project results databases by using MySQL.
    - Upgrading the project results database schema
      The following provides information about upgrading the schema version of an HCL OneTest™ API project results database, and illustrates the process with an example.
  - 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.
  - HCL OneTest™ API tool packages
    To enable HCL OneTest™ API to work with certain technologies, you must configure the required libraries by using the Library Manager and also install and configure HCL OneTest API tool packages that are provided with HCL® Quality Server.
  - Working with Library Manager
    HCL OneTest™ API uses a plug-in architecture to provide support for various middleware and messaging technologies, so the list of third-party products with which it interacts can become large. You can manage this list by using Library Manager. When support for a new architecture or messaging plug-in is required, you use Library Manager to add that support.
  - 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.
  - HCL OneTest™ API and HCL OneTest™ Server
    You can publish test reports for tests run on HCL OneTest™ API to HCL OneTest Server. You can create secrets collections for your project and store them securely on HCL OneTest Server that you can retrieve the secrets from HCL OneTest Server during tests at runtime.
- 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.
- 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.

Creating the project results database by using Microsoft™ SQL Server

You can create project results databases by using Microsoft™ SQL Server.

Before you begin

For information about the supported versions of the database, see the Supported Software > Database section in the download document https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0078997.

About this task

The current version of the ghtester_mssql.sql script provides Unicode support. To update SQL project results databases that were created before HCL OneTest™ API version 8.5.0 to change varchars to nvarchars so that Unicode is supported, run the patch-1_9_24_d-1_9_24_e_mssql.sql script.

To update SQL project results databases to the latest database schema, run the patch-1_9_24_e-1_9_24_f_mssql.sql script.

Procedure

Create the database using the collation option of SQL_Latin1_General_CP437_CI_AS to enable use of the UTF-8 character set. For more information, refer to the Microsoft™ SQL Server documentation.
Run the ghtester_mssql.sql script against the new database.
Notes:
- If you plan to use the SQL Server 2005 standard driver (sqljdbc41.jar) as a project results database in HCL® Quality Server:
  - Download it from the Microsoft™ Developer Network website
  - Copy the sqljdbc41.jar file to the lib folder of the HCL® Quality Server installation directory, for example, C:\Program Files\HCL\HCLProducts\QualityServer\usr\servers\defaultServer\apps\RTCP.war\WEB-INF\lib
  - Restart the service
- If you plan to use the SQL Server open source driver (jtds-1.2.5.jar) as a project results database in HCL® Quality Server:
  - Copy the jtds-1.2.5.jar file to the lib folder of the installation directory, for example, C:\Program Files\HCL\HCLProducts\QualityServer\usr\servers\defaultServer\apps\RTCP.war\WEB-INF\lib
  - Restart the service