Welcome
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.
Tester Guide - Integrations and API Testing
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. This guide is intended for Integrations and API testers.
Working in non-GUI mode
You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
Ant tasks
You can use the supported Ant tasks that is supplied with HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to create, update, or manage the environment, scenarios, and stubs.
Exit codes for Command-line client and Ant client
The HCL DevOps Test Integrations and APIs (Test Integrations and APIs) Command-Line Client and the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Ant Client applications share the same exit codes.

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.
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.
- Tester Guide - Integrations and API Testing
  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. This guide is intended for Integrations and API testers.
  - Integrations and API Testing
    You can use find information about the tasks that you can perform for testing various domains, technologies, or applications.
  - Extending DevOps Test Integrations and APIs functionality by using custom functions
    You can add more calculations and operations to tests by using the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) custom function class. Test Integrations and APIs custom function is a Java™ class that extends the com.ghc.ghTester.expressions function.
  - Working in non-GUI mode
    You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
    - Command-line interfaces
      HCL DevOps Test Integrations and APIs (Test Integrations and APIs) command-line client is available in Test Integrations and APIs 8.0.1 or later.
    - Ant tasks
      You can use the supported Ant tasks that is supplied with HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to create, update, or manage the environment, scenarios, and stubs.
      - Accessing and using Ant tasks
        You can use the Apache Ant tasks package provided with HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) that contains the Ant tasks with which you can control the environment, scenario, and stubs in Test Virtualization Control Panel.
      - Generating Ant scripts to run tests or suites
        You can generate Ant scripts from HCL DevOps Test Integrations and APIs (Test Integrations and APIs) by using the Integration Tester Test Execution plug-in. You can use the generated script to run test resources automatically from within Ant by using the IntegrationTester Ant task.
      - Exit codes for Command-line client and Ant client
        The HCL DevOps Test Integrations and APIs (Test Integrations and APIs) Command-Line Client and the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Ant Client applications share the same exit codes.
    - REST services
      Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Running tests
      Use HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to run tests with command-line and Ant APIs.
    - Managing test results
      Use HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to manage test results with command-line APIs.
    - Managing domains
      You can create, list, update, and delete domains with the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) REST API.
    - Managing environments
      Locking a HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
    - Managing scenarios
      Use HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to manage scenarios with command-line, Ant, and REST APIs.
    - Managing stubs
      You can manage stubs by using the command-line, Ant, and REST APIs.
- Tester Guide - Service Virtualization
  This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for API Testers.
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.

Exit codes for Command-line client and Ant client

The HCL DevOps Test Integrations and APIs (Test Integrations and APIs) Command-Line Client and the HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) Ant Client applications share the same exit codes.

For information about the Test Integrations and APIs Command-Line Client, refer to Command-line interfaces.


Code range	Description	Examples	Description
		0	Success
1-9	Command line option errors	1	An option required for execution of a command was not provided.
		2	Failed to open the specified project.
		3	An option provided to the command was invalid.
10-19	Server connection errors	10	HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) connection error.
20-29	Auxiliary resource discovery errors	20	Either the domain or the environment were not found.
		21	A suitable agent could not be found.
30-39	Authentication and authorization errors	30	The environment was locked.
		31	Unauthorized to perform the requested action.
40-49	Target discovery errors	40	The target resource (for example, stub to be started) was not found.
		41	Multiple targets were found for the specified details, but only one can be operated on.
50-59	Action failure errors	50	The action requested by the user did not occur.
		51	The action requested by the user started but then failed with an error.
		52	A status (for example, "RUNNING", "STOPPING") is retrieved from the server but was not recognized.
		53	The specified scenario is already running.
90-99	Unexpected errors	90	The server reported an unexpected client error (for example, bad request).
		91	The server reported an unexpected server error (for example, internal server error).
		92	The server reported an error that the client does not understand.