Home
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.
Installation of HCL OneTest™ API
You can find information about installing HCL OneTest™ API from the HCL OneTest Studio or HCL OneTest API package.
Installation considerations for HCL OneTest™ API
Consider the requirements discussed in this section before installing HCL OneTest™ API.
HCL OneTest™ API installation topology
Understand how the HCL OneTest™ API components are installed in a typical installation topology. This topology shows the installation of HCL OneTest API and HCL® Quality Server. It also shows how you can extend your HCL OneTest Virtualization capabilities by installing the Virtualization Server agents.

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.
- Installation of HCL OneTest™ API
  You can find information about installing HCL OneTest™ API from the HCL OneTest Studio or HCL OneTest API package.
  - Installation considerations for HCL OneTest™ API
    Consider the requirements discussed in this section before installing HCL OneTest™ API.
    - Platform considerations for HCL OneTest™ API
      You can ensure that you know about any platform limitations that you might encounter with this application.
    - HCL OneTest™ API installation topology
      Understand how the HCL OneTest™ API components are installed in a typical installation topology. This topology shows the installation of HCL OneTest API and HCL® Quality Server. It also shows how you can extend your HCL OneTest Virtualization capabilities by installing the Virtualization Server agents.
    - HCL OneTest™ API on Linux™ systems
      Understand the considerations that apply to install HCL OneTest™ API on Linux™ systems.
    - HCL OneTest™ API for non-administrative users
      To run HCL OneTest™ API as a non-administrative user, you must install the software as a non-administrative user. On Linux™ systems, if you already installed HCL OneTest API as a root user, you can change the ownership of the product installation directories, and then use the software as a non-root user.
    - Network ports
      To plan your network topology and firewall rules, you must know which TCP/IP ports are used by the software components.
    - Choosing your installation preference if using Installation Manager
      You can find information about the different methods you can choose to install the product software.
  - Installing the product software by using IBM® Installation Manager
    You can find information about installing the product software by using Installation Manager.
  - Installing the product software by using the stand-alone installer
    You can find information about installing the product software on Linux or Windows by using the stand-alone installer.
  - Uninstalling the product software
    When you no longer require the software, you can use either Installation Manager or the stand-alone installer to uninstall the products that you have installed.
- Installation of HCL® Quality Server
  You can find information about installing HCL® Quality Server from the HCL OneTest™ Studio, HCL OneTest Virtualization, or HCL OneTest API package.
- Uninstalling the product software
  When you no longer require the software, you can use either Installation Manager or the stand-alone installer to uninstall the products that you have installed.
- 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
- 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.
- 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.

HCL OneTest™ API installation topology

Understand how the HCL OneTest™ API components are installed in a typical installation topology. This topology shows the installation of HCL OneTest™ API and HCL® Quality Server. It also shows how you can extend your HCL OneTest™ Virtualization capabilities by installing the Virtualization Server agents.

Topology diagram for a HCL OneTest API installation

Table 1.
Component	When do I need it?	Where do I install it?
HCL OneTest™ API (client)	To create, modify, and run service tests, and virtualization tests. Additional information: With HCL OneTest™ API, you get a scripting-free environment for developing tests for SOA messaging and business process integration projects. You can build tests by recording existing system behaviors or from requirements. To build tests, enter the data to send and the data that is expected in return. You can also create virtual services to remove test dependencies and enable earlier testing. Virtual services can be deployed by HCL OneTest™ API to provide on-demand virtualized test environments that can support all phases of the test development lifecycle.	Any number of desktop computers or on a server. Install HCL OneTest™ API on a server to run tests non-interactively, such as regression packs or scheduled tests, or as part of a Continuous Integration (CI) environment such as Jenkins.
HCL® Quality Server	To publish and store HCL OneTest™ Virtualization stubs and to schedule the execution of test suites. HCL® Quality Server provides a central registration point for the proxies so that multiple instances of HCL OneTest™ API can find and communicate with the proxies. Additional information: HCL® Quality Server contains technology-specific components used by HCL OneTest™ API for recording SOA message conversations, HTTP(S) and JDBC traffic, and for monitoring middleware systems under test with minimal reconfiguration of client applications. For more information, see HCL OneTest API tool packages.	Web server.
HCL OneTest™ API agents. The following installation mode is available for different test environments: HCL OneTest™ API Agent to virtualize services, execute stubs for continuous testing, and enable integration with IBM® Rational® Quality Manager	For HCL OneTest™ Virtualization and to enable integration with Rational® Quality Manager.	Any remote computers that are to be used for HCL OneTest™ Virtualization.