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
Many test actions can be completed in non-GUI mode by using the command line, Ant, or REST interfaces.
Ant tasks
Support for the environment, scenario and stub Ant tasks is supplied with HCL Quality Server.
Exit codes for Command-line client and Ant client
The HCL OneTest™ API Command-Line Client and the HCL Quality Server Ant Client applications share the same exit codes.

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
    Many test actions can be completed in non-GUI mode by using the command line, Ant, or REST interfaces.
    - Command-line interfaces
      HCL OneTest™ API command-line client is available in HCL OneTest API 8.0.1 or later.
    - Ant tasks
      Support for the environment, scenario and stub Ant tasks is supplied with HCL Quality Server.
      - Accessing Ant tasks
        The Apache Ant tasks package contains Ant tasks for controlling the environment, scenario and stubs in HCL Quality Server. The package is provided with HCL Quality Server.
      - Generating ANT scripts to run tests or suites
        You can generate ANT scripts from HCL OneTest™ API by using the Integration Tester Test Execution plug-in. You can use the generated script to run test resources automatically from within ANT by using the IntegrationTester ANT task.
      - Exit codes for Command-line client and Ant client
        The HCL OneTest™ API Command-Line Client and the HCL Quality Server Ant Client applications share the same exit codes.
    - 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.

Exit codes for Command-line client and Ant client

The HCL OneTest™ API Command-Line Client and the HCL Quality Server Ant Client applications share the same exit codes.

For information about the HCL OneTest™ API Command-Line Client, refer to Command-line interfaces.


Code range	Description	Examples	Description
		0	Success
1-9	Command line option errors	1	An option required for execution of a command was not provided.
		2	Failed to open the specified project.
		3	An option provided to the command was invalid.
10-19	Server connection errors	10	HCL Quality Server connection error.
20-29	Auxiliary resource discovery errors	20	Either the domain or the environment were not found.
		21	A suitable agent could not be found.
30-39	Authentication and authorization errors	30	The environment was locked.
		31	Unauthorized to perform the requested action.
40-49	Target discovery errors	40	The target resource (for example, stub to be started) was not found.
		41	Multiple targets were found for the specified details, but only one can be operated on.
50-59	Action failure errors	50	The action requested by the user did not occur.
		51	The action requested by the user started but then failed with an error.
		52	A status (for example, "RUNNING", "STOPPING") is retrieved from the server but was not recognized.
		53	The specified scenario is already running.
90-99	Unexpected errors	90	The server reported an unexpected client error (for example, bad request).
		91	The server reported an unexpected server error (for example, internal server error).
		92	The server reported an error that the client does not understand.