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.
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 data sources
You can configure test data sources that can drive a test template or a test by using several different instances of data. In this way, you can parameterize your tests, substituting specific data from a pre-configured source in different test iterations. You can also use test data to validate the results that are returned by different test actions.
Configuring a database data source
You can use a database source to supply live data to Test Integrations and APIs. A database source relies on a valid database connection in Architecture School.

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.
- 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.
  - Tests: Overview and tasks
    Tests are the fundamental building blocks of integration and SOA testing. A test sends an input message to an external service or system in a protocol-specific way and validates the reply against an expected result.
  - Test Suites: Overview and tasks
    A Test Suite represents a group of tests, test suites, and scenarios. Any combination of these items can be included, but a test suite must always contain at least one scenario and one test. Test suites are used mainly to construct reusable, packaged regression tests that can be run across multiple environments, or repeatedly within the same environment.
  - Stubs: Overview and tasks
    Stubs can be used to simulate services that you are unable to use or that are otherwise unavailable.
  - The Action Editor
    The Action Editor is used to modify the actions that are contained within a test or stub.
  - Creating a test template
    To save time when you are creating tests, you can create a template of test sequences that can be used to quickly create a number of pre-defined tests.
  - Test data sources
    You can configure test data sources that can drive a test template or a test by using several different instances of data. In this way, you can parameterize your tests, substituting specific data from a pre-configured source in different test iterations. You can also use test data to validate the results that are returned by different test actions.
    - Creating a test data source
      You create a test data source that you can then use to validate the results that are returned by different test actions.
    - Creating test data from tags in a test
      You can create test data from the tags defined in a test from the Test Editor. You can then use the test data to validate the results that are returned by different test actions.
    - Creating test data sources from recorded events
      You can create test data sources by using events that are captured in the Recording Studio.
    - Configuring a database data source
      You can use a database source to supply live data to Test Integrations and APIs. A database source relies on a valid database connection in Architecture School.
    - Configuring a directory data source
      You can use a directory data source to populate tag values from the contents of complete files or their properties and to read data from the resources in a specified file system directory or a project folder.
    - Configuring delimited files as a data source
      Delimited files contain "columns" of data that are separated by a specific character (for example, a comma or a tab).
    - Configuring fixed width files as a data source
      Fixed width files contain columns of data that are in fixed positions within the file (for example, "Emp/Last Name" uses the first 15 characters, "Emp/First Name" uses the next 15 characters).
    - Configuring a Microsoft™ Excel data source
      A Microsoft™ Excel data source can be used to populate tag values from a Microsoft Excel (.xls and .xslx) file.
    - Creating tags from data source fields
      Before you can use the data from any configured source, a tag must be defined for each value.
    - Using tags to define test data for dynamic data access
      Tags can be used in test data set definitions to provide dynamic data access. The tags can be used within file locations, file names, and database queries. You can reference environment or system tags by selecting the tags from the menu while test tags have to be entered manually.
    - Editing test data source
      You can edit a test data source when you want to change or add test data to test a different scenario.
- 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.

Configuring a database data source

You can use a database source to supply live data to Test Integrations and APIs. A database source relies on a valid database connection in Architecture School.

About this task

Do the following steps to configure a database data source:

Procedure

Click Browse to select the wanted database server from the project resource dialog.
Select the Table/View option and select a database table/view from drop down list, or select Query and enter a SQL select statement to pull only specific data.

Note: The query field supports the use of tags for all or part of the SQL statement. Tags might typically be used to vary your SQL query according to the selected environment (that is, by using an environment tag).
If Auto map new columns to tags at runtime is selected (the default value), then the values in any new columns that are added to the test data set are used as test data. This assumes that a tag exists that exactly matches each new column name and that the column count property is not set.
If the number of test iterations exceed the number of matching records, enable the Loop Data option to force Test Integrations and APIs to process the same records over and over.
Click Refresh to generate a preview of the data that is returned.
Save the data source when finished, then see Creating tags from data source fields for details about copying column names to create tags from them.