Home
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.
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.
Adding other scripting languages
In addition to ECMAScript, you can customize Test Integrations and APIs to use other scripting languages. The language must provide a .jar archive that implements the Java™ Scripting API and that you can embed in the product.

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.
- 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.
  - Legacy scripting language
    Scripts written in the legacy scripting language represent a single or composite expression from the built-in and custom functions. By using a Function action within a test, you can enter an expression that refers to a specific function by name (built-in or custom). These expressions can be used in the Function or Decision action types, and within individual message fields to provide dynamic content. More complex expressions can refer to several functions by using a nested bracket syntax, which is familiar to programmers, for example: eq(5,abs(5.2)), which is the same as eq(5,5.2) and evaluates to "false."
  - ECMAScript (Javascript) scripting language
  - Chai scripting language
    You can use Chai as the default option for scripting in the Assert, Decision, and Function actions in tests, and in the Assert using Function actions in the message editor in Test Integrations and APIs. You can find information about the usage of the Chai scripting in these actions.
  - Built-in functions
    All the built-in functions can be called from Test Integrations and APIs scripting languages (ECMAScript and Legacy). The built-in functions are available in the legacy scripting language and most of them are available in the ECMAScript scripting language as well. The only exception is the null() function, because the scripts use the null keyword.
  - Adding other scripting languages
    In addition to ECMAScript, you can customize Test Integrations and APIs to use other scripting languages. The language must provide a .jar archive that implements the Java™ Scripting API and that you can embed in the product.
- 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.

Adding other scripting languages

In addition to ECMAScript, you can customize Test Integrations and APIs to use other scripting languages. The language must provide a .jar archive that implements the Java™ Scripting API and that you can embed in the product.

For more information about the Java™ Scripting API, see the Java™ Scripting Programmer's Guide.

Note: When you use a scripting language that is not provided by Test Integrations and APIs, the built-in functions and project custom functions are not available.

Example: Adding Groovy script to Test Integrations and APIs

For example, to add Groovy script to Test Integrations and APIs, complete the following steps:

From the Groovy website, download the latest stable release.
Extract the archive file to a local directory.
Copy the groovy-x.x.x\embeddable\groovy-all-x.x.x.jar file into the Test Integrations and APIs installation directory:
```
installation_directory/jre/lib/ext/
```
Note: If the Groovy download does not include an embeddable directory copy the following .jar files from the indy directory into the Test Integrations and APIs directory:
```
groovy-x.x.x\indy\groovy-x.x.x-indy.jar
```
```
groovy-x.x.x\indy\groovy-jsr223-x.x.x-indy.jar
```
Restart Test Integrations and APIs.
Groovy is displayed as an option in the drop-down menu for the Function.

Note: An agent that runs stubs that include Groovy scripts must have the Groovy .jar file on its classpath. If the file is not present in the classpath, the agent throws a null pointer exception.