Home
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.
API Tester Reference
Typically, a user with the API Tester role can work in the user interface, use commands or scripts. This reference lists all such topics to help the API Tester use the product.
API Tester Guide
Typically, a user with the API Tester role is responsible for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide lists all such topics.
Testing applications on z/OS®
You can test applications on IBM® z/OS® systems by using the mainframe support capabilities of HCL OneTest™ API.
Testing with CICS®
HCL OneTest™ API supports the recording and virtualization of CICS® programs running on z/OS® that are called by CICS Distributed Program Link (DPL). The CICS transport supports interacting with such calls in CICS Transaction Server (EXEC CICS LINK calls and ECIRequest calls using IPIC) and CICS Transaction Gateway (ECIRequest calls). CICS programs can be called in a test via a CICS Transaction Gateway.
Using CICS® Transaction Gateway for recording and virtualization
You can use CICS® Transaction Gateway for recording and stubbing (virtualization) ECI request calls of a CICS program. You can configure a CICS Transaction Gateway client Java™ application for recording and stubbing. Recording can also take place in the CICS Transaction Gateway daemon. With the CICS Transaction Gateway methods, you can virtualize CICS even when there is no CICS system; that is, if the messages are routed to a stub, CICS Transaction Gateway need not connect to a running CICS server.
Requirements for CICS® Transaction Gateway
Before you install and set up the CICS® Transaction Gateway, ensure that you have the downloaded the CICS Transaction Gateway exits from HCL Quality Server and installed the correct version of Java™ and a CICS JVMS server.

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.
- API Tester Reference
  Typically, a user with the API Tester role can work in the user interface, use commands or scripts. This reference lists all such topics to help the API Tester use the product.
  - API Tester Guide
    Typically, a user with the API Tester role is responsible for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide lists all such topics.
    - Testing Java™ applications
      You can use HCL OneTest™ API to test Java™ applications.
    - Testing Java™ Message Service (JMS) systems
      Use the generic JMS plug-in to connect HCL OneTest™ API to a wide range of EAI platforms, which includes any vendor that provides an implementation of this Java™ standard. JMS provides a way of separating the application from the transport layer of providing data. The same Java classes can be used to communicate with different JMS providers by using the JNDI information for a specific provider. The classes first use a connection factory to connect to the queue or topic, and then use populate and send or publish the messages. On the receiving side, the clients then receive or subscribe to the messages
    - Testing Java™ objects
      You can import Plain Old Java™ Objects (POJOs) from JAR files into HCL OneTest™ API in order to parse and construct messages containing the serialized forms of those objects. You can construct and parse the Java objects and perform validation, but you cannot test the objects directly.
    - Testing with Apache Camel components
      You can use HCL OneTest™ API to create tests and stubs by setting up an Apache Camel component in an HCL OneTest API project. You can configure the technology endpoints supported by the Camel component as the physical resources in the HCL OneTest API project and test for the services provided by the technology.
    - Testing with Apache Kafka
      Starting from HCL OneTest™ API V10.0.2 and later, you can create Kafka transports to test Kafka services.
    - Testing with Docker
      You can use Docker containers with HCL OneTest™ API to run stubs co-located with your test systems.
    - Testing with the email transport
      When you use applications in your test environment that use email services, you can use HCL OneTest™ API to create tests and stubs for testing the email services. You can set up an email transport in an HCL OneTest API project and configure the email servers as the physical resources in the HCL OneTest API project, and then test the email services.
    - Testing with Envoy Proxy (Experimental)
      You can use HCL OneTest™ API to record the HTTP traffic on the Envoy Proxy by using the Experimental HTTP Tap Filter feature of the Envoy Proxy.
    - Testing with the File transport
      As with any other transport, the File transport includes both logical and physical configurations. Tests and stubs are associated with the logical file, which represents an abstraction of the file and is the same for all environments. The physical File Access configuration includes connection details, and you can configure a different physical File Access for each environment.
    - Testing with the FIX transport
      You can use the Financial Information eXchange (FIX) transport and FIX dictionaries in HCL OneTest™ API to help you test trade-related messages and the systems that use them.
    - Testing with the HTTP transport
      To provide support for HTTP-based communications, you must configure and run HCL OneTest™ API by using the HTTP transport and SOAP message formatters.
    - Testing with IBM® API Developer Portals
      You can configure HCL OneTest™ API to synchronize IBM API Connect™ Developer Portal resources or IBM® API Management Developer Portal resources.
    - Testing with IBM® App Connect Enterprise
      When you want to test the services on applications deployed by the integration node of IBM® App Connect Enterprise, you can use the synchronization feature in HCL OneTest™ API to import details of deployed applications into an HCL OneTest API project. You can select the tests and stubs to be created in your project during the synchronization process in HCL OneTest API.
    - Testing with IBM® Integration Bus
      When you want to test the services on applications deployed by the integration node of IBM® Integration Bus, you can use the synchronization feature in HCL OneTest™ API to import details of deployed applications into an HCL OneTest API project. You can select the tests and stubs to be created in your project during the synchronization process in HCL OneTest API.
    - Testing with WebSphere® Application Server
      You can configure HCL OneTest™ API to synchronize IBM® WebSphere® Application Server resources.
    - Testing with IBM® WebSphere® MQ messages
      You can test WebSphere® MQ messages using the WebSphere MQ transport method or JMS interface. HCL OneTest™ API also supports testing WebSphere MQ on z/OS systems.
    - Testing with WebSphere® Portal
      You can configure HCL OneTest™ API to synchronize IBM® WebSphere® Portal resources.
    - Testing with IBM® z/OS® Connect Enterprise Edition
      IBM® z/OS® Connect Enterprise Edition provides a framework for enabling z/OS®-based programs and data to fully participate in the new API economy for mobile and cloud applications. Use IBM® z/OS® Connect Enterprise Edition to access z/OS subsystems, such as CICS®, IMS™ and Batch, by using RESTful APIs with JSON formatted messages. You can access multiple z/OS subsystems concurrently through a common interface.
    - Testing with Istio
      When you have applications hosted in a Kubernetes cluster that have Istio as a service-mesh, you can virtualize the services in the cluster by creating stubs in HCL OneTest™ API.
    - Testing with Kubernetes
      For testing with Kubernetes set up a Kubernetes cluster, and then you can create and publish stubs from HCL OneTest™ API so that stubs can be run within Kubernetes. The stubs published can be co-located with existing services running within the Kubernetes cluster.
    - Testing with Microsoft™ .NET objects
      You can import serializable .NET objects from .NET assembly files (.exe or .dll) into HCL OneTest™ API and apply them to messages in the same way as you would apply a schema. A service-based test or stub can then send and receive a message containing a serialized form of a .NET object from the assembly file. You can construct and parse the .NET objects and perform validation, but you cannot test the objects directly.
    - Testing with MongoDB
      If you are using HCL OneTest™ API V9.5.0 or later, you can create MongoDB transports and run tests against them.
    - Testing with the MQ telemetry transport
      If you are using HCL OneTest™ API 8.6.0 or later, you can create MQ telemetry transports.
    - Testing with Oracle Fusion
      Configure and run HCL OneTest™ API with the Oracle Fusion plug-in, which provides support for synchronization with and testing of the web services and composites that are available on a configured SOA server (that is, an Oracle WebLogic server with Oracle SOA Suite 11g deployed on it).
    - Testing with RabbitMQ
      If you are using HCL OneTest™ API V9.2.1.1 or later, you can create RabbitMQ transports.
    - Testing with SAP applications
      You can use HCL OneTest™ API to test SAP application server resources.
    - Testing with Software AG CentraSite
      You can incorporate governance in your SOA by using the integration of HCL OneTest™ API with Software AG CentraSite.
    - Testing with Software AG Universal Messaging
      You can use HCL OneTest™ API API to test Software AG Universal Messaging Broker server resources. From HCL OneTest API V10.0.2 or later, you can create Software AG Universal Messaging Broker transports, configure and run HCL OneTest API with the Software AG Universal Messaging server.
    - Testing with Software AG webMethods
      You can configure and run HCL OneTest™ API with the Software AG webMethods Integration Server to connect to Software AG webMethods Broker and Integration Server resources.
    - Testing with SSL
      To provide secure connections between clients and servers during testing, you can use the Secure Sockets Layer (SSL) technology supported by HCL OneTest™ API.
    - TCP and UDP
      In HCL OneTest™ API, you can create transports that facilitate communication between clients and servers by using both TCP- and UDP-based sockets.
    - Testing with TIBCO applications
      To use HCL OneTest™ API to test TIBCO messaging, you must configure and run HCL OneTest API with the TIBCO messaging plug-in. Doing so supports TIBCO Rendezvous messaging ("plain" TIBCO Rendezvous messaging and TIBCO ActiveEnterprise (AE) formats), TIBCO EMS messaging, and sending and receiving AE messages by using TIBCO EMS.
    - Testing applications on z/OS®
      You can test applications on IBM® z/OS® systems by using the mainframe support capabilities of HCL OneTest™ API.
      - Testing with CICS®
        HCL OneTest™ API supports the recording and virtualization of CICS® programs running on z/OS® that are called by CICS Distributed Program Link (DPL). The CICS transport supports interacting with such calls in CICS Transaction Server (EXEC CICS LINK calls and ECIRequest calls using IPIC) and CICS Transaction Gateway (ECIRequest calls). CICS programs can be called in a test via a CICS Transaction Gateway.
        Before creating CICS® transports
        To use a CICS® Transaction Gateway transport, you must configure HCL OneTest™ API to use CICS Transaction Gateway JAR files.
        Using CICS® Transaction Gateway for recording and virtualization
        You can use CICS® Transaction Gateway for recording and stubbing (virtualization) ECI request calls of a CICS program. You can configure a CICS Transaction Gateway client Java™ application for recording and stubbing. Recording can also take place in the CICS Transaction Gateway daemon. With the CICS Transaction Gateway methods, you can virtualize CICS even when there is no CICS system; that is, if the messages are routed to a stub, CICS Transaction Gateway need not connect to a running CICS server.
        Requirements for CICS® Transaction Gateway
        Before you install and set up the CICS® Transaction Gateway, ensure that you have the downloaded the CICS Transaction Gateway exits from HCL Quality Server and installed the correct version of Java™ and a CICS JVMS server.
        Adding the CICS® Transaction Gateway Agent to a client application
        To record or virtualize requests in a CICS® Transaction Gateway Java™ client, you must add the CICS Transaction Gateway Agent that is provided with HCL Quality Server to the client application.
        Enabling recording in a CICS® Transaction Gateway client application
        You can enable recording for CICS® Transaction Gateway in a Java™ client that uses the CICS Transaction Gateway client API.
        Enabling virtualization in a CICS® Transaction Gateway client application
        You can enable virtualization for CICS® Transaction Gateway in a Java™ client that uses the CICS Transaction Gateway client API.
        Enabling recording and stubbing in the CICS Transaction Gateway daemon
        As an alternative to a CICS® Transaction Gateway client application, you can use the CICS Transaction Gateway daemon for recording and stubbing.
        Enabling and disabling remote diagnostic logging for the CICS® Transaction Gateway proxy
        To facilitate troubleshooting, HCL Quality Server administrators can view, download, and share detailed log events information for the CICS® Transaction Gateway proxy. The capability to display this information in HCL Quality Server requires enabling remote diagnostic logging for the proxy.
        Viewing the configuration and log files
        To troubleshoot issues while working with the CICS® Transaction Gateway, you can use the configuration (ctg.ini) and log files.
        Recording and virtualizing DPL calls in CICS® Transaction Server
        You can record and virtualize CICS® Distributed Program Link (DPL) calls with CICS® Transaction Server versions 4.1, 4.2, 5.1, and 5.2. To do so, install and configure HCL OneTest™ API CICS TS Agent in the CICS regions that are making the DPL requests.
        Recording and virtualizing CICS® applications that use IPIC
        To record and virtualize IP interconnectivity (IPIC) to a CICS® region, you must first configure the HCL OneTest HTTP/TCP Proxy, and then enable your CICS client application.
        Using CICS® web services for HTTP traffic
        You can use CICS® web services to record, redirect, or create stubs for HTTP traffic. CICS programs can make available or use HTTP-based web services.
        Defining CICS® resources in HCL OneTest™ API
        You must define logical and physical CICS® resources to record and virtualize CICS programs running on zOS.
        Configuring CICS® Transaction Gateway messages in tests
        After you define CICS® physical and logical resources and bind them to an environment, you must create a test for an operation that is bound to a logical CICS server. Then you can configure CICS Transaction Gateway messages.
      - Testing with WebSphere® MQ on z/OS® systems
        You can test WebSphere® MQ on z/OS® by using the HCL OneTest™ API MQ exit module. You can record at the transport level or operation level when running the exit with a single queue manager. If you have a queue sharing group and if you choose to run an instance of the exit for each queue manager within the queue sharing group, you can record shared queues using mirror queue recording. You can also virtualize requests to shared queues using fixed queue stubbing.
      - Testing with IMS™ Connect
        For testing with IBM® Information Management System (IMS) Connect, you can set up HCL OneTest™ API. The set up will help you to record the IMS™ Connect traffic.
      - Troubleshooting: Testing on IBM® z/OS®
        You can use workarounds to common problems that you might encounter when you use IBM® z/OS® with HCL OneTest™ API.
    - Configuration of virtual IP addresses as virtual clients
      You can find information about how to configure virtual IP addresses in the operating system, and then use the virtual IP addresses to configure them as virtual clients in tests or as virtual servers in stubs.
  - Extending HCL OneTest™ API functionality using custom functions
    You can add more calculations and operations to tests by using the HCL OneTest™ API custom function class. HCL OneTest API custom function is a Java™ class that extends com.ghc.ghTester.expressions function.
  - Working in non-GUI mode
    Many test actions can be completed in non-GUI mode by using the command line, Ant, or REST interfaces.
- API Tester Guide
  Typically, a user with the API Tester role is also responsible for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This tester is also interested in reports, results and statistics for their testing. This guide lists all such topics.

Requirements for CICS® Transaction Gateway

Before you install and set up the CICS® Transaction Gateway, ensure that you have the downloaded the CICS® Transaction Gateway exits from HCL Quality Server and installed the correct version of Java™ and a CICS® JVMS server.

For CICS Transaction Gateway versions earlier than V9.1.0.1, you can virtualize CTG calls through the client side exit, if you have installed CA5F SupportPac. To virtualize calls through the Transaction Gateway, you must use CTG version V9.1.0.1 or later.