Welcome
Administrator Guide
This guide describes how to install HCL DevOps Test Integrations and APIs (Test Integrations and APIs). 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 DevOps Test Integrations and APIs
Configuring the project results database
Historical test data is stored in the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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.
Upgrading the project results database schema
The following provides information about upgrading the schema version of an HCL DevOps Test Integrations and APIs (Test Integrations and APIs) project results database, and illustrates the process with an example.

Release Notes
This document includes information about the new features introduced, features deprecated or removed, defects fixed, and known issues identified in this version of HCL DevOps Test Integrations and APIs (Test Integrations and APIs). You can also find the installation and upgrade instructions along with the contact information of HCL Customer Support.
System requirements
This document includes information about hardware and software requirements for HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 2024.03 (11.0.1).
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
Administrator Guide
This guide describes how to install HCL DevOps Test Integrations and APIs (Test Integrations and APIs). 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 DevOps Test Integrations and APIs
  You can find information about installing HCL DevOps Test Integrations and APIs (Test Integrations and APIs) from the HCL DevOps Test Workbench or HCL DevOps Test Integrations and APIs package.
- Installation of DevOps Test Virtualization Control Panel
  You can find information about installing HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) from the HCL DevOps Test Workbench (Test Workbench), HCL DevOps Test Virtualization (Test Virtualization), or HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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 DevOps Test Integrations and APIs
  - Installed directories
    When you install HCL DevOps Test Integrations and APIs (Test Integrations and APIs), the following directories are created and populated under the installation directory.
  - User file storage
    HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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 Test Integrations and APIs performance significantly, so it is recommended that Test Integrations and APIs 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 DevOps Test Integrations and APIs (Test Integrations and APIs) 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 DevOps Test Integrations and APIs (Test Integrations and APIs) 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.
  - DevOps Test Integrations and APIs tool packages
    To enable HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to work with certain technologies, you must configure the required libraries by using the Library Manager and also install and configure Test Integrations and APIs tool packages that are provided with HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel).
  - Working with Library Manager
    HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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.
  - DevOps Test Integrations and APIs and DevOps Test Hub
    You can publish test reports for tests run on HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to HCL DevOps Test Hub (Test Hub). You can create secrets collections for your project and store them securely on Test Hub that you can retrieve the secrets from Test Hub during tests at runtime.
- Administration of DevOps Test Virtualization Control Panel
  HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) is a server-based web application providing a central repository for virtualized services. The Test Virtualization Control Panel allows you to use virtual services published with HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to create, share, and deploy virtualized test environments in HCL DevOps Test Virtualization (Test Virtualization).
- Integrations
  HCL DevOps Test Integrations and APIs (Test Integrations and APIs) supports integration with various other tools for quality management, software configuration management, and deployment automation tools.
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
Test Manager Guide
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
Troubleshooting
While working with HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you might encounter some problems that you can easily troubleshoot.
Reference Guide
This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.

Upgrading the project results database schema

The following provides information about upgrading the schema version of an HCL DevOps Test Integrations and APIs (Test Integrations and APIs) project results database, and illustrates the process with an example.

Note: Ensure that you have full backups of your project results database before you make changes.

Note: Scripts are not provided to downgrade databases, so a tested backup is essential.

Example

Scripts are provided and are required to upgrade the project results database schema, and they can be found in the Test Integrations and APIs Installation Directory\scripts.

The following example assumes that you are using Oracle for the project results database and that the current schema version is 22.

Run the following scripts in this order:

patch-1_9_22-1_9_23_oracle.sql
patch-1_9_23-1_9_24_oracle.sql
patch-1_9_24-1_9_24_a_oracle.sql
patch-1_9_24_a-1_9_24_c_oracle.sql
patch-1_9_24_c-1_9_24_d_oracle.sql
patch-1_9_24_d-1_9_24_e_oracle.sql
patch-1_9_24_e-1_9_24_f_oracle.sql

Compatibility with Test Integrations and APIs client versions

From GH Tester 5.2.11 onwards, unless otherwise stated in release notes, the previous release of Test Integrations and APIs will run on the next releases database schema.

You can upgrade your database schema without having to upgrade all clients simultaneously. After the database schema upgrade is complete, clients can be upgraded to the new release as required.

Note: For versions of GH Tester earlier than 5.2.11, Test Integrations and APIs client software and the database schema must be kept in step.

For example, if your GH Tester 5.2.11 uses database schema 1.9.24c, and you must upgrade to Test Integrations and APIs 8.0.0, the first step is to update the database schema to 1.9.24d. The schema update is required by 8.0.0.

Existing GH Tester 5.2.11 clients continue to operate normally against the updated database version. After the schema update is complete, individual client computers can be upgraded to 8.0.0.