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.
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.
Test artifact documentation
All Test Integrations and APIs test artifacts (for example, tests, suites, messages, test templates) contain a Documentation tab in their respective editors.

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.
  - Test Integrations and APIs projects
    When you launch Test Integrations and APIs, a welcome dialog is displayed that you can use to create a new project or open an existing one. All work is organized into individual projects, similar to a development IDE. This organization allows for simpler organization of complex test scenarios.
  - Test Integrations and APIs workbench
    The main window of Test Integrations and APIs is a workbench that contains several dockable windows. These windows are organized in a logical way, providing an intuitive, easy-to-use central workspace. You can view the workbench from one of several perspectives: Architecture School, Recording Studio, Test Factory, Test Lab, and Results Gallery.
  - Test artifact documentation
    All Test Integrations and APIs test artifacts (for example, tests, suites, messages, test templates) contain a Documentation tab in their respective editors.
  - Tags for dynamic data access
    Tags are like data variables in Test Integrations and APIs, consisting of a name and a default value. Tags can be used throughout the application to allow for dynamic data access. Tags can be used in most fields within Test Integrations and APIs (for example, message headers, body elements, function definitions).
  - Environment properties, bindings, and tasks
    Environments are typically used to create configurations for different parts of a product workflow (for example, Development, QA, UAT).
  - Test cycles overview and management
    A test cycle is a container for tests and test suites that spans multiple users and projects. The result of each test that is executed inside a Test Cycle is persisted to the database, regardless of whether the test is inside a suite or not. To work with test cycles, you use the Test Cycle Manager window.
  - Changing preferences
    You can customize much of Test Integrations and APIs behavior by changing the default settings for the application preferences.
  - Refreshing a project
    When you are working in a project in Test Integrations and APIs and you click Project > Refresh to refresh the project, the Save Resources dialog is displayed that prompts you to save or discard unsaved changes in the editors that are open.
  - Creating an email publisher
    You can set up an email as a result publisher.
- 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.
- 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.

Test artifact documentation

All Test Integrations and APIs test artifacts (for example, tests, suites, messages, test templates) contain a Documentation tab in their respective editors.

Within this tab, users can enter a description of the artifact (in the Description field), an optional link to an external document related to the artifact (in the External Documentation field), and an optional External ID for the artifact. The default location for external documentation can be defined under Project settings, and external documents can be launched in an associated program or by using a user-defined command, as described in Applications preferences preferences.

Note: If an external documents extension is not associated with an application or command, you are prompted to provide one when you are trying to launch the document.

More details about the selected artifact (that is, date and time that the artifact is created and updated, internal ID, ID of the user who created and last updated the artifact, and the artifacts source within the project) are also provided within the Documentation tab.