Release Notes for HCL OneTest API and HCL OneTest Virtualization

This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.



HCL OneTest API is an integration testing and virtualization tool that includes capabilities to automate and run tests earlier and more often to find problems sooner in the development cycle. See HCL OneTest API overview.

What’s new

The following sections list the new features, enhancements, or other changes made in this release.
  • HCL OneTest Server

    For information about HCL OneTest Server, see Release notes.

  • HCL Quality Server
    • Tools page

      The list of agents changed for a release was updated. Review the Tools page of HCL Quality Server to see each tool and the version that it was last changed.

    • The latest version of the agents is displayed

      The IBM WebSphere MQ agent for z/OS and IBM CICS DPL agent now display the latest version when they are started. The latest MQ agent and CICS DPL agent have the same functions as the previous version of agents. Therefore, you need not upgrade them to the latest agent versions.

    • Enhanced performance of HCL Quality Server

      Previously, when you published stubs to HCL Quality Server that contained the git directories in a compressed folder, the performance of HCL Quality Server was affected.

      Now, the git directories are not included in the compressed folder when you publish stubs and thus the performance of HCL Quality Server is enhanced.

  • Installation
    • Separate installation of JDK or JRE is not required

      The HCL OneTest API stand-alone installer now uses the embedded JRE for execution and no longer requires a separate JRE or JDK to be present in order to run.

  • Technologies
    • Recording the Istio traffic on HCL OneTest Server

      You can use a sample application that is in the same cluster as HCL OneTest Server to record the HTTP traffic through the Istio service mesh to and from the sample application. Recording the Istio traffic in HCL OneTest API is a Tech Preview feature.

      To achieve the recording of the Istio traffic, you must install HCL OneTest Server by using the demo configuration, and then install the Bookinfo application in a namespace called bookinfo on the same Kubernetes cluster as HCL OneTest Server. You must configure a physical web server in HCL OneTest API that enables you to record the requests from and to the service that are generated when the Bookinfo application is run. You can then create stubs from these recorded events in HCL OneTest API and then run the stubs as virtual services on HCL OneTest Server instead of the actual service.

    • Support for GraphQL schemas, queries, or mutations

      HCL OneTest API now supports GraphQL schemas to be used in GraphQL queries or mutations in messages. You can either use the predefined GraphQL schemas or add custom-defined GraphQL schemas to messages.

      You can build GraphQL queries or GraphQL mutations in messages based on the GraphQL schema that you add from the Schema Library view. You can also paste the GraphQL queries or mutations into the message editor and the schema is recognized by HCL OneTest API as a GraphQL schema.

      You can send GraphQL messages either as Query Parameters without a message body or messages that have either a JSON body or a GraphQL body.

      You can also perform negative testing when you have an externally defined schema. See GraphQL schema overview.

    • Support for JSONPath expressions

      JSONPath is a query language for JSON. Similar to XPath for XML, a JSONPath expression specifies a path to an element which can be stored for subsequent usage or validated. You can now use JSONPath expressions within a Store action, Validate action, or the legacy/ECMAScript built-in function to query the JSON data. You can also use the option to generate JSONPath actions when treating a JSON node as plain text.

    • Support for synchronizing HCL OneTest API with a stand-alone integration server

      Previously, you were able to synchronize the resources on integration servers that were connected to IBM® App Connect Enterprise integration nodes from HCL OneTest API.

      Now, you can connect HCL OneTest API directly to a stand-alone integration server and synchronize the resources by using the synchronization feature.

    • Support for IBM® Engineering Test Management

      IBM® Rational® Quality Manager V7 is now referred as IBM® Engineering Test Management. HCL OneTest API is enhanced to supportIBM® Engineering Test Management V7.

    • Enhanced the method for obtaining an OpenID Connect refresh token

      Previously, you manually configured an OpenID Connect refresh token for an HTTP transport, which the transport used to obtain an access token at test runtime.

      Now, you can use an authorization server to obtain the refresh token, the generated token is received by a configurable local URI and added to the transport.

    • Enhanced features in SOAP messages

      You can now sign, encrypt, and decrypt the individual fields in a SOAP message body by using the Web Service-Security feature in HCL OneTest API. See Encrypting SOAP messages and Adding signatures.

    • Changes to the Maximum Optional Fields option limit for messages

      Previously, the Maximum Optional Fields limit that you set for messages in the project preferences was also applied to the number of optional nodes displayed for a schema in the Schema Library view. This behavior is changed.

      The maximum number of optional nodes that are displayed in the Schema Library view is now limited to 500 and cannot be changed. The limit that is set as the project preferences is applied to other areas such as in the Schema Selector menu.

    • Root resource path configuration support for an HTTP transport is optionally reinstated
      Although the root resource path configuration for an HTTP transport was deprecated in HCL OneTest API V8.7.1 and removed in V9.5, the support for this configuration is reinstated from V10.1.3. Support in a limited capacity is now enabled for legacy projects with existing transports that use this feature. To enable, use the following in the JVM Arguments section of Library Manager:

      The same limitations that led to the deprecation and ultimate removal of the feature still apply. The configuration can be seen in the transport panel but cannot be edited in transports where this configuration was used.

    • Proxy support for the file transport

      You can now configure a proxy server for the file transport in HCL OneTest API for both FTP and SFTP protocols. You can configure the proxy type that supports either an HTTP or SOCKS protocol.

    • Enhanced display of field editor names

      You can now use a new line character in field editor names so that the text is displayed in different lines.

    • Db2 z/OS stubs display warnings

      Db2 z/OS stubs now display warnings when they encounter unsupported cursor types.

    • The Db2 z/OS pass-through enabled stubs now pass though Db2 SET commands that update the host program variables.
  • Starting of multiple engines on HCL OneTest API Agent

    You can now configure the starting-up of multiple engines that are set up on HCL OneTest API Agent. If you do not change the configuration in the Agent.config file, the default configuration is applied. A total of 10 concurrent engines can be started within 60 seconds of the start of the first engine.

System requirements

For information about the hardware and software compatibility for HCL OneTest API, see System Requirements.

For information about the hardware and software compatibility for HCL OneTest Virtualization, see System Requirements.

Installing HCL OneTest API and HCL Quality Server

For information about installation, see the following topics:

Installing HCL OneTest Virtualization

For information about installation, see Installing HCL OneTest Virtualization.

Known problems

Table 1. Download documents and technotes
Product Download document Knowledge base
HCL OneTest API Release document HCL support

The knowledge base is continually updated as problems are discovered and resolved. By searching the knowledge base, you can quickly find workarounds or solutions to problems.

Known limitations

The only known limitation is that the Logical View does not display a diagram. Instead, a tree view, similar to that used in the Test Factory and Test Lab is used to support the logical components of the SUT.

Contacting HCL support

HCL Customer Support provides you with technical assistance.

Before you contact HCL support, you must gather the background information that you will need to describe your problem. When you describe a problem to an HCL support specialist, be as specific as possible and include all relevant background information so that the specialist can help you solve the problem efficiently. To save time, know the answers to these questions:
  • What software versions were you running when the problem occurred?
  • Do you have logs, traces, or messages that are related to the problem?
  • Can you reproduce the problem? If so, what steps do you take to reproduce it?
  • Is there a workaround for the problem? If so, be prepared to describe the workaround.