Installation considerations for HCL OneTest API

Consider the requirements discussed in this section before installing HCL OneTest API.

Note: For HCL OneTest Virtualization, you must install HCL OneTest API Agent from HCL OneTest Virtualization offering.

Hardware and software requirements

For a complete list of system requirements, see System Requirements.

Networking considerations

Note if HCL OneTest API will be running in an IPv4 or IPv6 networking environment. The Networking option in the Library Manager controls the IPv4/6 preference. For information about setting the networking preference, see Working with the Library Manager.

Security considerations

Ensure that you review the security considerations for installing the software. For more information, see Security considerations for HCL OneTest API.

Installing systems, transports, and technologies supported by HCL OneTest API

In HCL OneTest API, you can test numerous messaging and governance implementations, workflow, and database providers. The system or technology that is being tested must be installed and available to HCL OneTest API. Library Manager is an application that is installed with HCL OneTest API to provide support for various middleware and messaging technologies.

Library Manager settings

Library Manager settings and most user preferences are preserved during the uninstallation or reinstallation process. During the installation of HCL OneTest API, run Library Manager at the end of the process and confirm that the settings are correct. Perspective and dialog layout preferences are reset.

Note: Library Manager writes some of its configuration details to a directory within the users home directory called .integrationtester, and to the HCL OneTest API installation directory. To ensure that Library Manager can write to the HCL OneTest API installation directory, the user ID that is used to install HCL OneTest API must be used when running Library Manager.

For information about Library Manager, see Working with the Library Manager.

Upgrading the database schema

If you uninstall and reinstall the software, you must ensure that the database schema version is compatible with the version of the software that you install. Until the database schema is upgraded, it is not possible to store results to the database.

This schema upgrade is required to provide Unicode compatibility for the Microsoft SQL Server database. When you upgrade, for Microsoft SQL Server, every varchar column that could contain Unicode characters is changed to an nvarchar column (while preserving the contents). For IBM® Db2®, Oracle and MySQL databases, the 1.9.24f upgrade does not change the structure of the database. Instead, it just marks the database as the 1.9.24f version to keep version numbers consistent across the four databases.

To upgrade the database schema, use the provided upgrade script for each of the four supported results databases. This script can be run only on a database that is already at version 1.9.24d. If your results database is an older version, you must run previous upgrade scripts to get it to 1.9.24e before you attempt the 1.9.24f upgrade. For more information, see Upgrading the project results database schema

See the following table for the database scheme version for each version of the software

Important: Back up the results database before you run the upgrade scripts.
HCL OneTest API version Database schema version
Releases of 9.x.x version 1.9.24f
Releases of 8.7.1 version 1.9.24f
Releases of 8.5, 8.6, 8.7 versions 1.9.24e
Releases of 8.0 version 1.9.24d or 1.9.24e
Green Hat Tester 5.4 1.9.24d or 1.9.24e
Note: Previous versions of HCL OneTest API (including Green Hat Tester 5.4) operate correctly against schema 1.9.24e. This means that the results database can be upgraded first and then individual copies of HCL OneTest API can be upgraded over time.