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.
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).
Viewing DevOps Test Virtualization Control Panel logs
If you are an HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) administrator, you can view the audit, activity, and diagnostic logs of Test Virtualization Control Panel.
Locating the logs
HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) produces two types of logs: messages.log and console.log. These logs provide information about the execution of the server. If the server fails to start, this is the only information that you have to debug the failure. The logs also include information about migration of the workspace, ports that it cannot listen on, files that it cannot find, or about HTTP requests sent to the server that it cannot understand. These logs are available on your hard disk, but not viewable on the Test Virtualization Control Panel web UI. The messages.log file contains the same log entries as console.log, but provides additional information (for example, what package logged the entry).

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
- 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).
  - Configuring DevOps Test Virtualization Control Panel
    You might need to configure the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) after the application is installed.
  - Getting started with DevOps Test Virtualization Control Panel
    Start using the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel).
  - Task flow: Working with the DevOps Test Virtualization Control Panel Environments dashboard
    You can use the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Environments dashboard to perform various tasks such as starting, stopping stubs and scenarios, and modifying stub configurations after you have published stubs to Test Virtualization Control Panel. You can also lock the environment that contain the published stubs.
  - Task flow: Working with the DevOps Test Virtualization Control Panel Infrastructure dashboard
    You can use the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Infrastructure dashboard to perform administrative tasks such as viewing agents and proxies registered with Test Virtualization Control Panel.
  - Task flow: Working with the DevOps Test Virtualization Control Panel Network dashboard
    You can use the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Network dashboard to perform administrative tasks such as viewing recording or routing rules configured for agents and proxies.
  - Working with DevOps Test Virtualization Control Panel dashboards
    You can filter, search, sort, and choose the number of items to be displayed in HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) dashboards.
  - Managing users
    HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) has multiple choices associated with its security model. Depending on the security option selected during installation of the Test Virtualization Control Panel, different options are available based on the user accounts.
  - Managing domains
    How to create and manage domains in HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel).
  - Viewing the state of stubs that are published to DevOps Test Virtualization Control Panel
    When you as an administrator of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) want to view the state of stubs that are published to Test Virtualization Control Panel, you can use the script provided with the product installation package. You can use this information to manage projects in Test Virtualization Control Panel.
  - Deleting environments
    This topic explains how to delete environments.
  - Agent and Proxy administration
    Use HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to view and control any of the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) agents or proxies.
  - Viewing DevOps Test Virtualization Control Panel logs
    If you are an HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) administrator, you can view the audit, activity, and diagnostic logs of Test Virtualization Control Panel.
    - Locating the logs
      HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) produces two types of logs: messages.log and console.log. These logs provide information about the execution of the server. If the server fails to start, this is the only information that you have to debug the failure. The logs also include information about migration of the workspace, ports that it cannot listen on, files that it cannot find, or about HTTP requests sent to the server that it cannot understand. These logs are available on your hard disk, but not viewable on the Test Virtualization Control Panel web UI. The messages.log file contains the same log entries as console.log, but provides additional information (for example, what package logged the entry).
      - Directories used when running as a Windows service
        The HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) writes to several directories.
    - Viewing the DevOps Test Virtualization Control Panel audit log
      If you are an administrator of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), you can view the contents of the audit log. The audit log provides information about your overall activity in Test Virtualization Control Panel (for example, failed login attempts, starting and stopping stubs, creating and deleting environments, and creating and deleting domains). These data may be useful for security reasons and for finding out who initiated a particular change (for example, who stopped a stub or who deleted a domain). You can view the audit log on the Test Virtualization Control Panel web UI.
    - Viewing the DevOps Test Virtualization Control Panel activity log
      If you are an administrator of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), you can view, download, and share the contents of the activity log. The activity log provides information about your activity across the various components of Test Virtualization. The data is particularly about the communication between, or control of these components; for example, recording and routing rules sent to proxies. You can view the activity log on the Test Virtualization Control Panel web UI.
    - Enabling and disabling remote diagnostic logging for the JDBC proxy
      To facilitate troubleshooting, HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) administrators can view, download, and share detailed log events information for the JDBC proxy. The capability to display this information in Test Virtualization Control Panel requires enabling remote diagnostic logging for the proxy.
    - Enabling and disabling remote diagnostic logging for the HTTP/TCP proxy
      To facilitate troubleshooting, HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) administrators can view, download, and share detailed log events information for the HTTP/TCP proxy. The capability to display this information in Test Virtualization Control Panel requires enabling remote diagnostic logging for the proxy.
    - Viewing the diagnostic log
      If you are an HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) administrator, you can view, download, and share the contents of the diagnostic log of Test Virtualization Control Panel. The diagnostic log provides information about the execution of the Test Virtualization components. When enabled for a given proxy, this log records the same information as is contained in the log files that proxy writes to the disk, for example, information about how the HTTP proxy matches requests against the rules it has and whether it sends requests to a stub or to the live system. It might also include information about the execution of Test Virtualization Control Panel itself. You can view the diagnostic log on the server web UI.
    - Setting the log level of DevOps Test Virtualization Control Panel
      The logging element in the server configuration file of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) defines the log level.
    - Configuring logging for metrics storage (KairosDB)
      You can use the server configuration file of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to configure the level and location of logging for metrics that are stored by using KairosDB.
  - Viewing reports in DevOps Test Hub
    All the project stakeholders can view test reports for multiple testing products from the Results page on HCL DevOps Test Hub (Test Hub). You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
  - Configuring stubs to connect to DevOps Test Virtualization Control Panel and the HTTP proxy
    A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.
  - Troubleshooting: DevOps Test Virtualization Control Panel
    You can use workarounds to troubleshoot common problems that you might encounter when you use HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel).
- 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.

Locating the logs

HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) produces two types of logs: messages.log and console.log. These logs provide information about the execution of the server. If the server fails to start, this is the only information that you have to debug the failure. The logs also include information about migration of the workspace, ports that it cannot listen on, files that it cannot find, or about HTTP requests sent to the server that it cannot understand. These logs are available on your hard disk, but not viewable on the Test Virtualization Control Panel web UI. The messages.log file contains the same log entries as console.log, but provides additional information (for example, what package logged the entry).

Procedure

Go to the Test Virtualization Control Panel installation folder and locate the log files.
- On Windows computers, the logs are in C:\Program Files\HCL\DevOpsTestControlPanel\logs.
- On Unix and Linux computers, the logs are in /opt/HCL/DevOpsTestControlPanel/logs.
Optional: Customize the location of the logs by setting the LOG_DIR variable in the following files:
- On Windows computers, locate the setenv.bat file. Typically, the file is in C:\Program Files\HCL\DevOpsTestControlPanel\bin\setenv.bat.
- On Unix and Linux computers, locate the setenv.sh file. Typically, the file is in /opt/HCL/DevOpsTestControlPanel/bin/setenv.sh.
Important: After every upgrade of Test Virtualization Control Panel, reapply the change.