Welcome
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 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.
Task flow for testing with the email transport
You can find information about the tasks that you can perform in HCL OneTest™ API for testing with the email transport.

Release Notes
This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.
API Tester Guide (New user)
Typically, a user with the API tester role is responsible for certain tasks including creating and running tests and virtual services to determine the quality of the API layer of the system. This guide lists all such topics to help the new API tester get started with the product.
Administrator Guide
Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
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.
      - Task flow for testing with the email transport
        You can find information about the tasks that you can perform in HCL OneTest™ API for testing with the email transport.
      - Prerequisites for testing with the email transport
        You can find information about the prerequisite conditions that you must satisfy before you can test the email transport in HCL OneTest™ API.
      - Creating logical email resources
        In HCL OneTest™ API, tests and stubs reference the logical resources in a project. Therefore, you must create at least one logical email resource.
      - Creating physical resources for logical email resources
        In HCL OneTest™ API, creating a physical resource for a logical connection involves configuring the physical resource. You must configure the details of the SMTP server (for sending messages) and the IMAP server (for receiving messages).
      - Configuring the MEP settings for the email transport
        You can configure the email transport for the message exchange pattern (MEP) in HCL OneTest™ API and create tests for the application based on the MEP settings.
      - Supported messaging patterns for email resources
        You can find information about the supported messaging patterns that you can use in your tests for email resources, which you set up in an HCL OneTest™ API project.
      - Stubbing settings for the email transport
        You can specify the stubbing settings depending on the message exchange pattern (MEP) defined for the email transport.
    - 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.
    - 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.
Test Manager Guide
Typically, a user with the Test Manager role is responsible for certain tasks that includes tracking the quality of the application. This guide lists all such topics.
Troubleshooting: HCL OneTest™ API
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
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.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.

Task flow for testing with the email transport

You can find information about the tasks that you can perform in HCL OneTest™ API for testing with the email transport.

The following table provides a list of the tasks that you can perform for testing with Kafka along with the link to the corresponding topic for the details of the task.
	Task	More information
1.	You must complete the prerequisite tasks.	Prerequisites for testing with the email transport
2.	You must create a logical email resource in the Architectural School perspective for the email transport.	Creating logical email resources
3.	You must configure the physical resources for the logical resource.	Creating physical resources for logical email resources
4.	You must set up a Service Component that uses an email server as the physical resource before you can create tests or stubs.	Creating a service component
5.	You must set up an Operation that uses an email server as the physical resource before you can create tests or stubs.	Creating an operation
7.	If you are testing an email service, you can set up the message exchange pattern (MEP) for messaging in the email service.	Configuring the MEP settings for the email transport
6.	Create tests for each of the supported messaging actions for testing with the email resources in HCL OneTest™ API.	Supported messaging patterns for email resources
8.	You can specify the stubbing settings based on the MEP for the email resources.	Stubbing settings for the email transport