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 - 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.
Modifying message-based stubs
You can use either the Test Editor or the Stub Editor to create, modify, and enhance any legacy or new stubs created by HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
Sift-and-pass-through capability
You can filter the messages that a stub receives, separating traffic from client and server applications that need to use the live system as opposed to a virtual system.
Configuring stub pass-through behavior
You can configure a stub to use pass-through actions in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) in three ways.

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.
- 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.
  - DevOps Test Virtualization overview
    HCL DevOps Test Virtualization (Test Virtualization) is software that is used for creating, maintaining, publishing, and running message-based stubs and database stubs.
  - Virtualizing HTTP
    You can simulate an HTTP connection with a virtual service, also known as a stub.
  - Virtualizing HTTPS
    You can simulate an HTTPS connection with a virtual service, also known as a stub.
  - Virtualizing TCP
    You can simulate a TCP connection with a virtual service, also known as a stub.
  - Virtualizing a REST API without recording or synchronization
    You can virtualize REST APIs by using the Recording Studio, or by synchronizing WADL, Swagger, or RAML documents. When none of these options is available, you can still manually virtualize REST APIs that use path parameters.
  - Creating message-based stubs
    In HCL DevOps Test Integrations and APIs (Test Integrations and APIs), there are several methods that you can use to create a message-based stub.
  - Modifying message-based stubs
    You can use either the Test Editor or the Stub Editor to create, modify, and enhance any legacy or new stubs created by HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
    - The Events tab
      With the Events tab, you can define how the stub will handle internally and/or externally received events.
    - The Behavior tab
      With the Behavior tab, you can add reusable behavioral entities, that is, pre-programmed intelligence, to your stub.
    - The Properties tab
      With the Properties tab, you can set up states for your stub and input parameters that can determine how the stub behaves when it runs.
    - The Performance tab
      With the Performance tab, you can change the performance characteristics of the stub either by adding delays when a stub runs or by disabling performance optimization.
    - The Session tab
      With the Session tab, you can configure the sharing of the tag data store between workers (instances of the stub), so that messages can be processed based on information that was captured from previously processed messages.
    - The Logging tab
      With the Logging tab, you can define how much information is recorded when the stub is run.
    - The Documentation tab
    - Adding a timer behavior to a stub
      You can use a timer behavior to set a timer event in a stub. After a set time period, the timer event is triggered, the stub receives the event, which it can then respond to. For example, you might have a stub to manage user sessions and you want to add a timer behavior that automatically logs out a user after 30 seconds of inactivity.
    - Example: Adding a repeating timer behavior to a stub
      In this example, you add a repeating timer event to a stub that starts after zero seconds and then repeats every 10 seconds.
    - Sift-and-pass-through capability
      You can filter the messages that a stub receives, separating traffic from client and server applications that need to use the live system as opposed to a virtual system.
      - Configuring transports
        The sift-and-pass-through capability is provided by HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to filter the messages that a stub receives, separating traffic from client and server applications that need to use the live system as opposed to a virtual system.
      - Adding business logic
        You can add logic to a stub to determine whether and how it should respond to a received request.
      - Configuring stub pass-through behavior
        You can configure a stub to use pass-through actions in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) in three ways.
    - Performance profiles
      You can use a performance profile to store response time characteristics for a stub over a period of time.
  - Creating and modifying database stubs
    You can create and modify database stubs in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
  - 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.
  - Publishing and running stubs
    You can publish stubs that are created in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel), Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
  - Viewing results in DevOps Test Virtualization Control Panel
    You can use HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) to display the results of tests that you run in both HCL DevOps Test Integrations and APIs (Test Integrations and APIs) and Test Virtualization Control Panel.
  - Viewing usage statistics of virtual services in DevOps Test Virtualization Control Panel
    Test Virtualization Control Panel collects and stores usage metric data. The metric data might include the number and types of actions that are used, the features that are used in the workbench, details about Operating System or languages set while running, and so forth. You cannot view the metric data on the Test Virtualization Control Panel user interface, but it is available from the underlying implementation. Storage is either managed by H2 or optionally Apache Cassandra.
  - 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.
  - Troubleshooting: DevOps Test Virtualization
    You can use workarounds to common problems that you might encounter when you use HCL DevOps Test Virtualization (Test Virtualization).
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 stub pass-through behavior

You can configure a stub to use pass-through actions in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) in three ways.

Note: You must configure the transport associated with a stub to use the pass-through action. For details, see The Properties tab and Configuring transports to use the sift-and-pass-through capability.

The following table outlines the methods using which you can configure a stub:


Method	Application	Description
Use the Pass-through window on the Properties tab of the Stub Editor	Test Integrations and APIs	The transport type (HTTP, IBM® WebSphere® MQ, or WebMethods Integration Server) associated with a stub determines the range of possible pass-through actions for each operation within a stub. The Pass-through window on the Properties tab on the Stub Editor is used to configure a specific pass-through action for each operation in the stub (irrespective of the number of events that are defined for each operation) that will be executed if the stub cannot process any requests from any of the relevant transport types (HTTP, WebSphere® MQ, or WebMethods Integration Server). Irrespective of the number of events (configured on the Events tab of the Stub Editor) that are defined for each operation within a stubs properties, there can be only one pass-through action for each operation. (For instructions, refer to the table in The Properties tab.)
Customize a stubs execution to use the sift-and-pass-through capability temporarily	Test Integrations and APIs	Instructions: Right-click the stub on the Test Factory perspective. Click Run on the shortcut menu. The Customized Execution dialog is displayed. Modify the pass-through actions (for information about this method, refer to table in The Properties tab). Click Run.
Modify a stubs properties to use the sift-and-pass-through capability before starting the stub	HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel)	For instructions, see Starting stubs by using the DevOps Test Virtualization Control Panel method.
Add a Pass-through action to the stub	Test Integrations and APIs	For instructions, see Stub actions.