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.
Testing methodology
By following four basic guidelines, you can incorporate HCL OneTest™ API into your testing methodology. These guidelines drive efficient and expedient integration testing, and they can be applied to your testing process and infrastructure requirements.
Service-oriented architecture (SOA) testing
A SOA consists of business processes that are implemented by linking individual services. The linking can be done programmatically or with tools based on Business Process Execution Language (BPEL). SOA testing can be challenging because there is no GUI; the focus is on testing interfaces and services.
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® Quality Server overview
HCL OneTest™ Virtualization stubs designed in HCL OneTest API are published to HCL® Quality Server, which holds them in a repository.
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.
Installation planning
Before you install the software, you must review platform and security considerations along with information about the network ports.
Installation
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® License & Delivery portal. This portal is FlexNet-based web application to manage software entitlements and licenses.
Configuration of HCL OneTest™ API
Integrations
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 or HCL® Launch.
Administering HCL® Quality ServerHCL® Quality Server
is a server-based web application providing a central repository for virtualized services. The HCL® Quality Server allows you to use virtual services published with HCL OneTest™ API to create, share, and deploy virtualized test environments in HCL OneTest Virtualization.
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.
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.
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: Java™ applications that use JDBC
You can use workarounds to problems that you might encounter when you test Java™ applications in 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 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 overview
This section provides an overview of HCL OneTest™ API, including information about projects and files, the HCL OneTest API user interface, environments, and project settings and preferences.
Architecture School
Use the Architecture School perspective to build a system under test by using the logical, physical, and synchronization views. You can also use this perspective to manage the schemas available in your project.
Recording Studio
With HCL OneTest™ API, you can record events (messages or database interactions) sent to and from the system under test. Use Recording Studio to control what parts of the system should be recorded. These parts could be specific parts of the system infrastructure or specific services using that infrastructure. You can then use the recorded events as a source of tests and other interactions with the system. In Recording Studio, you can record the traffic over a number of different transports.
Test Factory
The Test Factory perspective is one of the main areas in HCL OneTest™ API. You can create all the tests and the required artifacts/data to support them.
Test Lab
You use the Test Lab to execute test assets, repair tests, and open test assets for editing directly from this perspective. You can execute all of the tests, test suites, and stubs that are created in Test Factory.
Results Gallery
You use the Results Gallery perspective to view an execution summary and detailed coverage, and error reports for executed test suites and for test cases that were executed within a suite or as part of a test cycle.
Messages
HCL OneTest™ API can publish and subscribe to messages as part of a test. A message normally consists of two parts: a header and a body. The header usually adheres to a predefined logical construction, while the structure of the body can be more arbitrary.
Schemas
HCL OneTest™ API can handle many types of content. For the product to be able to interpret the variety of content types, it must associate a content format description, or schema with the content.
Database resources, connections, and bindings
HCL OneTest™ API can interact with any database that supports connectivity through the JDBC specification. These interactions can be used to extract or update data where necessary, and test data sets can be taken directly from database table content.
Identity stores and SSL
An identity store can group a collection of one or more certificates that can be used in HCL OneTest™ API to validate and authenticate connections that use SSL. After you create an identity store, you can use it to enable SSL communications in various messaging transports.
Scripting within tests and stubs
You can use scripts in HCL OneTest™ API that include the HCL OneTest API legacy scripting language, ECMAScript (such as JavaScript™), Chai, or any third-party scripting language that you install.
External tools
HCL OneTest™ API is primarily GUI-based, but you can also run or view tests, suites, and stubs outside of the HCL OneTest API.
Test actions
Actions are the building blocks of a test. A test consists of a series of steps and each step is an action. Actions can be defined for tests and stubs.
Formatting and parsing date-time patterns
For some fields in HCL OneTest™ API, you can define patterns for date-time formatting. Pattern letters are repeated, as their number determines the exact presentation of the date-time information that they represent.
The Add Numbers service
The Add Numbers service, included with HCL OneTest™ API, provides a simple way to generate messages that you can observe with topology discovery or capture in Recording Studio.
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.
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.