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
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.
Configure default and custom provider library settings
If you want to use providers such as JDBC, you must configure their library settings in Library Manager so that they work correctly with HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
Editing libraries
Based on the provider that you are using, you might want to edit a library to change its location or specify a new library in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).

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.
  - 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.
    - Firewalls, VPNs, and multihomed machines
      Special considerations apply when you install HCL DevOps Test Integrations and APIs (Test Integrations and APIs) on systems with firewalls, virtual private networks (VPNs), or connections to more than one network.
    - Configuring HTTP watch mode (Unix-like installations only)
      To complete installing HCL DevOps Test Integrations and APIs (Test Integrations and APIs) on Unix-like systems, you must configure HTTP watch mode with Java™ Packet Capture (JPCAP).
    - Adding the libraries for database testing by using Library Manager
      To enable HCL DevOps Test Integrations and APIs (Test Integrations and APIs) access to the database for testing, you must add various libraries to the configuration.
    - Custom providers
      In Library Manager, you can create new specific providers to supplement any of the existing third-party plug-ins or JDBC providers.
    - Configure default and custom provider library settings
      If you want to use providers such as JDBC, you must configure their library settings in Library Manager so that they work correctly with HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
      - Changing installation directories
        If you install a provider into a non-default directory, Library Manager does not know where the JAR files are located. You must change the location of the JAR files for that provider in Library Manager.
      - Editing libraries
        Based on the provider that you are using, you might want to edit a library to change its location or specify a new library in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
      - Adding libraries
        You can add new libraries for custom providers but not for default providers in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
      - Copying libraries
        If you are using a custom provider, to save you time, you might want to copy existing libraries instead of creating new libraries.
      - Removing libraries
        If you are no longer using a custom provider, you might want to remove libraries of that custom provider.
    - Resolving missing libraries errors
      If you see that required libraries for a specific provider are missing, you must fix the error.
    - Library manager command-line options
      Use the LibConfig executable on computers that do not have a graphical user interface.
    - Library manager GUI settings
      When you use a command line to configure HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you can use an existing file as a template, and hence reuse those template settings.
  - 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.

Editing libraries

Based on the provider that you are using, you might want to edit a library to change its location or specify a new library in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).

About this task

If necessary, you can edit a single library that is required by a specific provider. For default providers, you can change the location of a single library. For custom providers, you can specify a new library altogether, or a new location for an existing library.

To edit a library, follow these steps:

Procedure

On the left side of the Library Manager application window, select the relevant provider-type.
Select the relevant provider (custom or default) from the list of available providers.
Under Settings, double-click the library that is to be edited.
Alternatively, select the file and click Edit. The Select dialog is displayed.
Using the Select dialog, browse for the relevant library.
Note: If the library file location is on a mapped network drive, you might get errors while running tests in a project. To prevent this, ensure that the files are available on a local drive that can be accessed by Test Integrations and APIs and its Agent.
When you find the relevant library, highlight it and click Select.
On the Library Manager application window, the new library and location are displayed for the selected file.