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.
Tester Guide - API Testing
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. This guide is intended for API testers.
API Testing
You can use find information about the tasks that you can perform for testing various domains, technologies, or applications.
Testing applications on z/OS®
You can test applications on IBM® z/OS® systems by using the capabilities that are supported for mainframes by HCL OneTest™ API.
Testing with WebSphere® MQ on z/OS® systems
You can test WebSphere® MQ on z/OS® by using the HCL OneTest™ API MQ agent module. You can record at the transport level or operation level when running the agent with a single queue manager. If you have a queue sharing group and if you choose to run an instance of the agent 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.
Configuring IBM® WebSphere® MQ on z/OS®
You must configure IBM® WebSphere® MQ on IBM z/OS® to set up the required queues and namelists. Based on your system security requirement, you might need to grant permissions to enable HCL OneTest™ API to intercept the queue messages. From HCL OneTest API 9.1.1 onwards, you can do the required setup using the example configuration JCL templates (RITDEFN, RITCFGS, and RITCFGG) which are provided with the RIT.PROC.XMIT.BIN package.
Additional configuration steps if the HCL OneTest™ API user cannot be given queue create permission
As of version 9.2.0, HCL OneTest™ API uses queues that are named COM.GREENHAT.INTERCEPT_LCK, COM.GREENHAT.INTERCEPT.<QMGR>_LCK, RIT.DIVERT.RULES_LCK, and RIT.DIVERT.RULES.<QMGR>_LCK. Which of these queues is required depends on your environment. HCL OneTest API attempts to create these queues automatically when they are first accessed. If you do not allow HCL OneTest API to create queues, then you must predefine these queues.

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.
- Tester Guide - API Testing
  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. This guide is intended for API testers.
  - API Testing
    You can use find information about the tasks that you can perform for testing various domains, technologies, or applications.
    - 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 10.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 resource, which represents an abstraction of the File resource 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 IBM® 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 and tests for testing with Istio in HCL OneTest™ API.
    - Testing with Kubernetes
      HCL OneTest™ API supports testing with Kubernetes after you set up a Kubernetes cluster. You can test the containerized applications that run as services in Kubernetes in HCL OneTest API. You can also create and publish stubs from HCL OneTest API to Kubernetes and then run the stubs in Kubernetes.
    - 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 the migrated Postman collections
      You can migrate Postman collections and environments that you created in Postman to HCL OneTest™ API. Operations, transports, tests and stubs are automatically created during migration and you can run the tests and stubs in HCL OneTest API.
    - Testing with MongoDB
      If you are using HCL OneTest™ API 9.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 9.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 10.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 capabilities that are supported for mainframes by HCL OneTest™ API.
      - Testing with CICS®
        HCL OneTest™ API supports the recording and virtualization of CICS® programs that are run on z/OS® and 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.
      - Testing with WebSphere® MQ on z/OS® systems
        You can test WebSphere® MQ on z/OS® by using the HCL OneTest™ API MQ agent module. You can record at the transport level or operation level when running the agent with a single queue manager. If you have a queue sharing group and if you choose to run an instance of the agent 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.
        Transferring the JCL and executable files for Websphere MQ to z/OS®
        To transfer JCL and executable files to IBM® z/OS®, download and extract the HCL OneTest™ API API agent for Websphere MQ (z/OS) package.
        Unpacking the files
        Use the TSO receive command to unpack the files in IBM® z/OS®.
        APF authorizing the load library
        The system programmer must APF-authorize the userid.RIT.AUTH library.
        Adding the HRVMMQF module to the Link Pack Area
        You can dynamically add the HRVMMQF module to the Link Pack Area (LPA).
        Configuring IBM® WebSphere® MQ on z/OS®
        You must configure IBM® WebSphere® MQ on IBM z/OS® to set up the required queues and namelists. Based on your system security requirement, you might need to grant permissions to enable HCL OneTest™ API to intercept the queue messages. From HCL OneTest API 9.1.1 onwards, you can do the required setup using the example configuration JCL templates (RITDEFN, RITCFGS, and RITCFGG) which are provided with the RIT.PROC.XMIT.BIN package.
        Considerations before using the WebSphere® MQ agent for z/OS
        Starting from 9.5.0, you can control which user ids are allowed to record messages for a queue manager.
        Security settings for MQ agent resources on z/OS
        If security is enabled for your queue manager or queue sharing group, you must set up security for the HCL OneTest™ API MQ agent resources and give user IDs access to the HCL OneTest API intercept queue.
        Additional configuration steps if the HCL OneTest™ API user cannot be given queue create permission
        As of version 9.2.0, HCL OneTest™ API uses queues that are named COM.GREENHAT.INTERCEPT_LCK, COM.GREENHAT.INTERCEPT.<QMGR>_LCK, RIT.DIVERT.RULES_LCK, and RIT.DIVERT.RULES.<QMGR>_LCK. Which of these queues is required depends on your environment. HCL OneTest API attempts to create these queues automatically when they are first accessed. If you do not allow HCL OneTest API to create queues, then you must predefine these queues.
        Message interception and application setup
        Every intercepted message results in an MQPUT1 to the HCL OneTest™ API queue, which doubles the CPU cost of an MQPUT or MQPUT1. To reduce the overhead, intercept only the messages that you are interested in rather than intercepting all messages.
        Editing the JCL file for local customization
        You can edit the JCL file for local customization in RIT.PROC.
        Running the HCL OneTest™ API jobs
        You can run the HCL OneTest™ API job or stop the running ones.
        Verifying the configuration and installation of the API agent
        After you configure the IBM® WebSphere® MQ on IBM z/OS® and install the API agents, you can verify if the configurations and the agents are installed correctly by running the installation verification jobs that are provided with the RIT.PROC.XMIT.BIN package. If you have set up HCL OneTest™ API to run with a single queue manager, use jobs RITIVP1, RITIVP2, and RITIVP3. If you have set up HCL OneTest API to run with a queue sharing group, use jobs RITIVP1G, RITIVP2G, and RITIVP3G.
        Special considerations for queue sharing groups
        Starting in HCL OneTest™ API 9.1.1, you can record and virtualize shared queues in a queue sharing group.
        Creating transports for WebSphere® MQ
        To record interactions with IBM® WebSphere® MQ, you must set up transports to provide information about the infrastructure of these systems. HCL OneTest™ API uses a decoupled, plug-in architecture to provide maximum flexibility for the messaging transport software in use by a system under test.
        Using WebSphere® MQ transports on distributed platforms to test traffic to and from WebSphere® MQ on z/OS
        You can record requests from a non-z/OS queue manager to a queue on a z/OS queue manager and virtualize replies from z/OS to a queue on a non-z/OS queue manager without installing the HRVMMQF agent.
        Uninstalling HCL OneTest™ API and the HRVMMQF agent module
        Uninstalling the HCL OneTest™ API HRVMMQF agent module involves a few actions.
      - Testing with IBM® IMS™ Connect
        For testing with IBM® Information Management System (IBM IMS Connect), you can set up HCL OneTest™ API. With this set up you can record the IBM 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.
    - Managing credentials
      If you have external resources that must be accessed by project or test resources in HCL OneTest™ API and you do not want to expose the credentials used to access the external resources, then you can implement a user-defined access in a credential management system.
    - 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.
    - Configuration of test runs in a GitHub Actions Workflow
      You can configure test runs of test resources that you create in HCL OneTest™ API in a GitHub Actions Workflow. You can choose to run test resources in the GitHub Workflow when you do not want to run the test resources without opening HCL OneTest API.
    - Security vulnerabilities testing by using HCL® AppScan
      You can use HCL® AppScan to scan all HTTP traffic that is generated as part of integration testing in HCL OneTest™ API for security vulnerabilities.
  - Extending HCL OneTest™ API functionality by 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 the com.ghc.ghTester.expressions function.
  - Working in non-GUI mode
    You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
- Tester Guide - Service Virtualization
  This guide describes the tasks that you can perform 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 guide is intended for API Testers.

Additional configuration steps if the HCL OneTest™ API user cannot be given queue create permission

As of version 9.2.0, HCL OneTest™ API uses queues that are named COM.GREENHAT.INTERCEPT_LCK, COM.GREENHAT.INTERCEPT.<QMGR>_LCK, RIT.DIVERT.RULES_LCK, and RIT.DIVERT.RULES.<QMGR>_LCK. Which of these queues is required depends on your environment. HCL OneTest™ API attempts to create these queues automatically when they are first accessed. If you do not allow HCL OneTest™ API to create queues, then you must predefine these queues.

On z/OS, the jobs within the RIT.PROC dataset contain sample statements for creating the required security profiles to allow HCL OneTest™ API to create the queues. The RITDEFN job contains commands for creating the queues manually, if you prefer to predefine them.

In the distributed WebSphere® MQ environment, if you do not allow HCL OneTest™ API to dynamically create queues, your system administrator must create the required locking queues in advance.

The queues that are used for locking depend on the WebSphere® MQ environment.

Distributed WebSphere® MQ

Mirror queue recording: com.greenhat.intercept_LCK
Sift-and-pass-through stubbing: rit.divert.rules_LCK
Topology discovery: COM.GREENHAT.OBSERVATION_LCK

z/OS (Queue manager not in a queue sharing group)

Mirror queue recording: COM.GREENHAT.INTERCEPT_LCK
Sift-and-pass-through stubbing: RIT.DIVERT.RULES_LCK

z/OS (Queue manager in a queue sharing group)

All of the following queues must be created as shared queues:

Mirror queue recording: COM.GREENHAT.INTERCEPT_LCK, COM.GREENHAT.INTERCEPT.<QMGR>_LCK for each queue manager in the group
Sift-and-pass-through stubbing: RIT.DIVERT.RULES.<QMGR>_LCK for each queue manager in the group
Note: Topology discovery for WebSphere® MQ is not currently supported for WebSphere® MQ on z/OS.