Home
HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
Scripting within tests and stubs
You can write scripts in HCL OneTest™ API by using the HCL OneTest API legacy scripting language, ECMAScript (such as JavaScript™), or a third-party scripting language that you install.

HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
- HCL OneTest™ API overview
  This section provides an overview of HCL OneTest™ API, including information about projects and files, the HCL OneTest API 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 HCL OneTest™ API, 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 HCL OneTest™ API. 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, error, and performance reports for executed test suites and for test cases that were executed within a suite or as part of a test cycle.
- Messages
  HCL OneTest™ API 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
  HCL OneTest™ API can handle many types of content. For the product to be able to interpret this variety of content types, it must associate a content format description, or schema with the content.
- Database resources, connections, and bindings
  HCL OneTest™ API 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 OneTest™ API 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 write scripts in HCL OneTest™ API by using the HCL OneTest API legacy scripting language, ECMAScript (such as JavaScript™), or a 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
    You can write scripts in HCL OneTest™ API by using the HCL OneTest API legacy scripting language, ECMAScript.
  - Built-in functions
    All the built-in functions can be called from HCL OneTest™ API 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 HCL OneTest™ API 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
  HCL OneTest™ API is primarily GUI-based, but you can also run or view tests, suites, and stubs outside of the HCL OneTest API.
- 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 HCL OneTest™ API, 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 OneTest™ API, provides a simple way to generate messages that you can observe with topology discovery or capture in Recording Studio.

Scripts within tests and stubs

You can write scripts in HCL OneTest™ API by using the HCL OneTest™ API legacy scripting language, ECMAScript (such as JavaScript™), or a third-party scripting language that you install.

You can enter a script in a number of places, such as Function, Decision and Assert actions in tests, and Assert using Function actions in the message editor. These scripts return a value or perform an action (for example, a database update). When writing a script in a Function action, the returned value can be stored in a tag. Scripts in other locations must return a boolean value (true or false), which affects the running or validation of a test. The custom functions you add to a HCL OneTest™ API project are available while using the legacy scripts or ECMAScript.

Note:

When you use a scripting language other than legacy, the language's own functions and data types are also available.
When you use a scripting language that is not provided by HCL OneTest™ API, the built-in functions and project custom functions are not available.
Starting from V9.2.1 onwards, when you use the ECMAScript 5 language, syntax is checked, and invalid code is highlighted.

HCL OneTest™ API provides a number of opportunities for dynamic user interaction, including:

Function actions. See Function
Guard conditions in a message-based stub. See Input tab
Message cases in Message Switch actions. See Message cases.
Expressions for Assert, Decision, or Iterate While actions. See Flow actions.

The following topics and sections discuss various aspects of these scripting languages:

Within the editor, you can right-click and select Test to see the output of the filter expressions by using the current values of any included tags.

Test option

You can also click Test from the editor window, specify temporary values for any tags, and run the test to see the output.

Test button

Test button output