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
HTTP/TCP proxy setup
The process of configuring applications to use the HTTP/TCP proxy varies according to the application.
Configuring WebSphere® Application Server to use HTTP/TCP proxy
You must modify the Java™ virtual machine (JVM) so that WebSphere® Application Server can use an HTTP/TCP proxy. You can do this change by setting some JVM options through the administrative console.

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.06 (11.0.2).
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 HCLSoftware License & Download 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.
    - Modifying the configuration settings of the HTTP/TCP proxy
      To change the server address, log level, and other settings, you can modify the registration.xml file of the HTTP/TCP proxy.
    - Configuring a HTTP(S) reverse proxy or TCP port forwarding
      The reverse proxy capability allows applications that are unable to configure HTTP(S) forward proxying to address the proxy directly and have it forward these requests to a configured destination, which is also applicable for forwarding TCP-based communications.
    - Advanced HTTP and TCP proxy configuration
      The HTTP protocol runs on top of the TCP protocol, but provides extra information about the message destination. For that reason, the two proxies are configured differently.
    - Configuring Apache Tomcat to use HTTP/TCP proxy
      You must modify the Java™ virtual machine (JVM) so that Apache Tomcat can use an HTTP/TCP proxy. You can configure Apache Tomcat by configuring JVM options in the Tomcat startup script.
    - Configuring WebSphere® Application Server to use HTTP/TCP proxy
      You must modify the Java™ virtual machine (JVM) so that WebSphere® Application Server can use an HTTP/TCP proxy. You can do this change by setting some JVM options through the administrative console.
    - HTTP/TCP proxy logs
      To help you troubleshoot HTTP/TCP proxy problems, a number of logging methods are available for the HTTP/TCP proxy.
    - Starting and stopping the HTTP/TCP proxy
      To route and record HTTP(S) and TCP traffic with Test Virtualization Control Panel and Test Integrations and APIs, you must start the HTTP/TCP proxy. If the proxy is installed as a Windows service, you can configure it for an automatic start on start of the system or for a manual start on demand.
    - Programmatic custom certificate creation in proxy
      When an HTTPS connection is established with an HTTP/TCP proxy, the certificate that is presented to the client by the proxy is retrieved from an existing keypair that represent the intended endpoint or is generated as the default certificate by the proxy and is signed by the private key in the keystore that is configured in the registration.xml. Ordinarily, this mechanism is sufficient. If full control over the generation of certificates is required, an alternative advanced approach is available. The approach requires that custom code is written to generate and sign the required certificates.
  - 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.

Configuring WebSphere® Application Server to use HTTP/TCP proxy

You must modify the Java™ virtual machine (JVM) so that WebSphere® Application Server can use an HTTP/TCP proxy. You can do this change by setting some JVM options through the administrative console.

About this task

To configure WebSphere® Application Server to use the HTTP/TCP proxy:

Procedure

In the administrative console, open the Java™ virtual machine page to enter values for the JVM settings. The steps to set JVM arguments with the administrative console are different depending on the version of WebSphere® Application Server that you are using.

In the Generic JVM arguments field, type the following arguments:

-Dhttp.proxyHost=<Hostname or IP address of HTTP/TCP proxy> 
-Dhttp.proxyPort=<Port number specified during installation of Test Virtualization Control Panel and/or editing registration.xml file, for example, 3128>

Save the changes that are made to the master configuration.
Restart the application server for the changes to take effect.
Note: If you are setting up a HTTP/TCP proxy to support HTTPS, the properties are -Dhttps.proxyHost and -Dhttps.proxyPort.