Jump to main content
This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.
Product description
What's new
You can find information about the features introduced in this release of HCL OneTest™ API and HCL OneTest Virtualization.
Installing and upgrading
You can find information about the installation and upgrade instructions for HCL OneTest™ API, HCL Quality Server, and HCL OneTest Virtualization.
Known issues
You can find information about the known issues identified in this release of HCL OneTest™ Server.
Contacting HCL support
This document includes information about hardware and software requirements for HCL OneTest™ API.
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
HCL OneTest™ API overview
You can use HCL OneTest™ API to create, modify, and run service tests.
Interactive Guides
The home page contains several interactive guides that walks you, step by step, through some of the common tasks.
Task flow: Basic test scenario
A diagram is provided to show you a basic task flow that can help you get started with some of the features of the tool to test the system. After you configure the complete setup for testing, you can do the tasks in sequence to test the application.
Task flow: Advanced test data scenario
A diagram is provided to show you an advanced task flow that can help you get started with resources, environments, schemas, and test suites to test the system. After you configure the complete setup for testing, you can do the tasks in sequence to test the application.
Getting started with testing
You can start using HCL OneTest™ API by completing the preliminary tasks such as creating and running a test, creating and running a stub, recording an HTTP proxy, and running a stub in a Docker container.
HCL OneTest™ API accessibility features
Users who have a physical disability, such as limited vision, can review the available accessibility features to use HCL OneTest™ API.
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
Planning
Before installing the software, review several platform and security considerations. Review the release notes and network ports information.
Installing
You can find information about the installation considerations, selection of an installation method, and installing the product software.
License management
Licensing for your HCL software is administered through HCL Software License & Download portal. This portal is FlexNet-based web application to manage software entitlements and licenses.
Configuring HCL OneTest™ API
Integrating
HCL OneTest™ API supports integration with various other tools for quality management, change management, software configuration management, and deployment automation tools such as UrbanCode™ Deploy.
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.
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 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
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 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 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 capabilities that are supported for mainframes by 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.
This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
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.
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.
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
Viewing results in HCL Quality Server
You can use HCL Quality Server to display the results of tests that you run in both HCL OneTest™ API and HCL Quality Server.
Viewing usage statistics of virtual services in HCL Quality Server
HCL Quality Server collects and stores usage metric data. The metric data might include the number and types of actions that are used, the features that are used in the workbench, details about Operating System or languages set while running, and so forth. You cannot view the metric data on the HCL Quality Server user interface, but it is available from the underlying implementation. Storage is either managed by H2 or optionally Apache Cassandra. For more information about the H2 database and its management, see sections A. Server Configuration and D. Deleting Data.
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
Troubleshooting: Installation and configuration
You can troubleshoot some of the problems that you might encounter when you are installing, configuring, or running HCL OneTest™ API.
Global problem notifications
Problems can occur at a time when HCL OneTest™ API cannot display an error message. Instead, a warning icon is displayed. Double-clicking the icon reveals a list of errors.
Working with HCL OneTest™ API logs
To configure the HCL OneTest™ API logs, including those for the RunTest command when run from the command line, update the HCL OneTest API logging properties file.
Working with HCL OneTest™ API Agent logs
To configure the HCL OneTest™ API Agent logs, including those for the RunTests command when run from the command line, update the HCL OneTest API Agent logging properties file.
Working with RQMAgent logs
To configure the RQMAgent logs, update the RQMAgent logging properties file.
Locating the logging properties files
When you install HCL OneTest™ API, HCL OneTest API Agent, or HCL Quality Server including the HTTP/TCP proxy, several logging properties files are added to each installation's home directory.
Logging references
You can use the following list of logging-related information to help you find information about the logs that are supported by HCL OneTest™ API. All of the programs use the Java logging framework. For details, see the Java logging framework documentation.
Debugging failed Windows™ services
If one of the programs fails to start as a Windows™ service, it can be difficult to determine the cause. Typically the service fails to start but gives no indication of why. The Windows Event log has nothing useful and the process might not have created its log file.
Troubleshooting: Installation and configuration
You can troubleshoot some of the problems that you might encounter when you are installing, configuring, or running HCL OneTest™ API.
Troubleshooting: transports, tests, and resources
Workarounds and solutions for transport diagnostics, creating and running tests, and saving and renaming objects are contained in this topic.
Troubleshooting: HCL OneTest™ API Agent
You can use workarounds to common problems that you might encounter when you install and run the HCL OneTest™ API Agent.
Troubleshooting: HCL Quality Server
You can use workarounds to troubleshoot common problems that you might encounter when you use HCL Quality Server.
Troubleshooting: HCL OneTest™ Virtualization
You can use workarounds to common problems that you might encounter when you use HCL OneTest™ Virtualization.
Troubleshooting: Software AG webMethods
You can use workarounds to problems that you might encounter when you use the Software AG webMethods.
Troubleshooting: Websphere MQ
You can use workarounds to problems that you might encounter when you use IBM® WebSphere® MQ with HCL OneTest™ API.
Troubleshooting: WebSphere® Application Server
You can use workarounds to problems that you might encounter when you use IBM® WebSphere® Application Server products with HCL OneTest™ API.
Troubleshooting: WebSphere® Portal
You can use workarounds to problems that you might encounter when you use IBM® WebSphere® Portal products with HCL OneTest™ API.
Troubleshooting: TIBCO
You can use workarounds to common problems that you might encounter when you are testing TIBCO products in HCL OneTest™ API.
Troubleshooting: Java™ method transport
You can use workarounds to common problems that you might encounter when you use the Java™ method transport of HCL OneTest™ API.
Troubleshooting: HTTP and Web Services
You can use workarounds to common problems that you might encounter when you use HTTP and Web Services.
Troubleshooting: TCP UDP sockets
You can use workarounds to common problems that you might encounter when you use TCP and UDP transports.
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.
This section provides topics that are specific to testing with HCL OneTest™ Virtualization.
Release Notes
This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.
System Requirements
This document includes information about hardware and software requirements for HCL OneTest™ Virtualization.
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.
API 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.
Test Manager Guide
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
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.
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Security considerations for HCL OneTest™ API
Ensure that your installation is secure, customize your security settings, and set up user access controls. Also, know about any security limitations that you might encounter with this application.
Security considerations for HCL Quality Server
You must ensure that your installation is secure, customize your security settings, and set up user access controls. Also, you must know about any security limitations that you might encounter with this server application.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.