Welcome
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.
Architecture School
Use the Architecture School perspective to build a system under test by using the logical, physical, and synchronization views. You can also use this perspective to manage the schemas available in your project.
The Physical View
The Physical View displays available physical resources and their location within the enterprise. Resources in this view are organized by subnet and host. If a resource is not associated with a subnet or host, it is displayed under Unconnected Resources.
Adding a host to the Physical view
You can use a host to group other physical resources. Starting from 9.2.1 onwards, binding a File transport to a Host resource is deprecated. Instead a File transport is bound to a File Access resource so you can connect to and consume files from or publish new files to a remote host machine. To add a host to the Physical view of the Architecture School perspective, use the General menu.

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.
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.
- DevOps Test Integrations and APIs overview
  This section provides an overview of HCL DevOps Test Integrations and APIs (Test Integrations and APIs), including information about projects and files, the Test Integrations and APIs user interface, environments, and project settings and preferences.
- Architecture School
  Use the Architecture School perspective to build a system under test by using the logical, physical, and synchronization views. You can also use this perspective to manage the schemas available in your project.
  - The Logical View
    The Logical View provides an abstract model of the system under test. You can visualize the Service and Infrastructure Components, their dependencies, inputs and outputs, and the interface patterns in this view. Use the toolbar to add resources. Use the right side of the toolbar above the drawing palette to build and modify the system under test.
  - The Physical View
    The Physical View displays available physical resources and their location within the enterprise. Resources in this view are organized by subnet and host. If a resource is not associated with a subnet or host, it is displayed under Unconnected Resources.
    - Adding a cluster to the Physical view
      A cluster is one or more of the same types of physical resource that are configured as a unit outside of Test Integrations and APIs. To add a Cluster to the Physical view of the Architecture School perspective, you can use the General menu.
    - Adding a database to the Physical view
      You can use a database to supply Test Integrations and APIs with live test data during the execution of different test resources (for example, tests and test suites). To add a database to the Physical view of the Architecture School perspective, use the General menu.
    - Adding a host to the Physical view
      You can use a host to group other physical resources. Starting from 9.2.1 onwards, binding a File transport to a Host resource is deprecated. Instead a File transport is bound to a File Access resource so you can connect to and consume files from or publish new files to a remote host machine. To add a host to the Physical view of the Architecture School perspective, use the General menu.
    - Creating a physical File Access resource
      You can use a logical File resource with a physical File Access resource to publish or consume remote file contents by using File Transport Protocol (FTP) or SSH File Transport Protocol (SFTP) in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
    - Adding an identity to the Physical view
      You can use an Identity when it is necessary to authenticate to a third party (for example, when you are importing or synchronizing with a WSDL by using a secure URL, when you are monitoring a remote log file over SSH). To add an Identity to the Physical view of the Architecture School perspective, use the General menu.
    - Adding an identity store to the Physical view
      You can use an Identity store to enable SSL communications in various messaging transports in Test Integrations and APIs. To add an Identity store to the Physical view of the Architecture School perspective, use the General menu.
    - Adding an LTPA provider to the Physical view
      To test a web service that requires Lightweight Third-Party Authentication message-level authentication, you must enter details about the LTPA provider and the level of authentication required. To add a LTPA provider to the Physical view of the Architecture School perspective, use the General menu.
    - Adding a subnet to the Physical view
      You can use a subnet to group hosts and other physical resources in Test Integrations and APIs. To add a subnet to the Physical view of the Architecture School perspective, use the General menu.
  - Synchronization view
    Synchronization enables you to add external resources to your project, view resources that were added, and synchronize those resources with your local system. The biggest benefit of synchronization is that it can create many test artifacts in a short time without errors. If you are testing one of the supported resources, synchronization does all the work of building the system under test automatically.
  - Schema Library overview
    In the Schema Library, you can view and manage the schemas and message formats that are available in your project. You can add, rebuild, and delete schemas, and apply schema-specific data masks.
  - The Data Model view
    A data model stores a small quantity of data from the system under test and keeps it in memory at run time. It provides many of the features of a database while requiring a much smaller overhead.
  - Rule Cache view
    When validation errors are repaired and cached, the repair method is saved as a validation rule. These rules are applied to the same field from which they are created when the same schema is in use. You manage the rules in the Rule Cache view in Architecture School. You also use the Rule Cache view to view, modify, or delete non-schema-specific data masks.
  - Environment Tasks view
    Use the Environment Tasks view to configure test environments. You can define environment configuration tasks by adding and configuring a limited set of actions. You can then associate these environment tasks with stubs. Doing so ensures that test environments are set up correctly before stubs or scenarios are run, and that environments are closed down properly.
  - Topology Discovery overview
    Topology discovery is the process of observing and modeling the components of a system under test.
- Recording Studio
  With Test Integrations and APIs, you can record events (messages or database interactions) sent to and from the system under test. Use Recording Studio to control what parts of the system should be recorded. These parts could be specific parts of the system infrastructure or specific services using that infrastructure. You can then use the recorded events as a source of tests and other interactions with the system. In Recording Studio, you can record the traffic over a number of different transports.
- Test Factory
  The Test Factory perspective is one of the main areas in Test Integrations and APIs. You can create all the tests and the required artifacts/data to support them.
- Test Lab
  You use the Test Lab to execute test assets, repair tests, and open test assets for editing directly from this perspective. You can execute all of the tests, test suites, and stubs that are created in Test Factory.
- Results Gallery
  You use the Results Gallery perspective to view an execution summary and detailed coverage, and error reports for executed test suites and for test cases that were executed within a suite or as part of a test cycle.
- Messages
  Test Integrations and APIs can publish and subscribe to messages as part of a test. A message normally consists of two parts: a header and a body. The header usually adheres to a predefined logical construction, while the structure of the body can be more arbitrary.
- Schemas
  Test Integrations and APIs can handle many types of content. For the product to be able to interpret the variety of content types, it must associate a content format description, or schema with the content.
- Database resources, connections, and bindings
  Test Integrations and APIs can interact with any database that supports connectivity through the JDBC specification. These interactions can be used to extract or update data where necessary, and test data sets can be taken directly from database table content.
- Identity stores and SSL
  An identity store can group a collection of one or more certificates that can be used in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to validate and authenticate connections that use SSL. After you create an identity store, you can use it to enable SSL communications in various messaging transports.
- Scripting within tests and stubs
  You can use scripts in Test Integrations and APIs that include the Test Integrations and APIs legacy scripting language, ECMAScript (such as JavaScript™), Chai, or any third-party scripting language that you install.
- External tools
  Test Integrations and APIs is primarily GUI-based, but you can also run or view tests, suites, and stubs outside of the Test Integrations and APIs.
- Test actions
  Actions are the building blocks of a test. A test consists of a series of steps and each step is an action. Actions can be defined for tests and stubs.
- Formatting and parsing date-time patterns
  For some fields in Test Integrations and APIs, you can define patterns for date-time formatting. Pattern letters are repeated, as their number determines the exact presentation of the date-time information that they represent.
- The Add Numbers service
  The Add Numbers service, included with HCL DevOps Test Integrations and APIs (Test Integrations and APIs), provides a simple way to generate messages that you can observe with topology discovery or capture in Recording Studio.
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.

Adding a host to the Physical view

You can use a host to group other physical resources. Starting from 9.2.1 onwards, binding a File transport to a Host resource is deprecated. Instead a File transport is bound to a File Access resource so you can connect to and consume files from or publish new files to a remote host machine. To add a host to the Physical view of the Architecture School perspective, use the General menu.

Click General > Host to add a host machine to the physical network.

Enter the name of the new host and Test Integrations and APIs automatically tries to resolve the machines IP address. If resolution fails, you must add the IP address manually.

Note: If the new host is part of a new subnet, the subnet is added automatically to the Physical view.

Under the Connectivity tab you can configure port and credential information required to connect through SSH (SFTP) to the host. This connection is used by File transports, restricted to SSH (SFTP), and log file monitoring.

The connection credentials are defined by an Identity that has been configured in the current project. To add an Identity to a connection, double-click the Identity field for the connection and select an Identity from the list. The port number for the SSH connection defaults to 22. To change the port number, double-click the Port field and enter the port number to which you want to connect.

You can verify that the connection works by clicking Test Connection.