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
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.
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.
Command-line interfaces
HCL OneTest™ API command-line client is available in HCL OneTest API 8.0.1 or later.

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™ API.
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
Administrator Guide
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.
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
  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.
  - API 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. This guide is intended for API testers.
  - 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.
    - Command-line interfaces
      HCL OneTest™ API command-line client is available in HCL OneTest API 8.0.1 or later.
      - Displaying RunTests command help
        To display RunTests command help, run RunTests help command.
      - Displaying IntegrationTesterCmd command list and the help
        To display the list of IntegrationTesterCmd commands and the help for a specific command, run IntegrationTesterCmd help and IntegrationTesterCmd help <command-name> commands.
    - Ant tasks
      Support for the environment, scenario and stub Ant tasks is supplied with HCL® Quality Server.
    - REST services
      Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL® Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Running tests
      Use HCL OneTest™ API to run tests with command-line and Ant APIs.
    - Managing test results
      Use HCL® Quality Server to manage test results with command-line APIs.
    - Managing domains
      You can create, list, update, and delete domains with the HCL® Quality Server REST API.
    - Managing environments
      Locking a HCL® Quality Server environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
    - Managing scenarios
      Use HCL® Quality Server to manage scenarios with command-line, Ant, and REST APIs.
    - Managing stubs
      You can manage stubs by using the command-line, Ant, and REST APIs.
- 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.
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.

Command-line interfaces

HCL OneTest™ API command-line client is available in HCL OneTest™ API 8.0.1 or later.

Run the HCL OneTest™ API commands from the Windows™ Command Prompt or the Linux™ Terminal. Use the commands to run HCL OneTest™ API project resources locally (using RunTests), manage test results (using IntegrationTesterCmd), and use HCL® Quality Server to start and stop stubs, run scenarios, and lock and unlock environments (using IntegrationTesterCmd). Most HCL OneTest™ API commands require HCL OneTest™ API version 8.0.1 or later and HCL® Quality Server version 8.0.1 or later, unless noted otherwise on the page for the individual command.

RunTests Command syntax

The general syntax for all commands is as follows:

RunTests Options

For more information and examples about the RunTests command, see Run tests by using the command line.

HCL OneTest™ API Command syntax

The general syntax for all commands is as follows:

IntegrationTesterCmd Options command Arguments

For more information and examples about the IntegrationTesterCmd command, see Working in non-GUI mode.

Exit codes

The commands and the Ant tasks share the same exit codes. For information about these codes, see Exit codes for Command-line client and Ant client.