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.
Platform considerations for HCL OneTest™ API
You can ensure that you know about any platform limitations that you might encounter with this application.

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.

Platform considerations for HCL OneTest™ API

You can ensure that you know about any platform limitations that you might encounter with this application.

Internet Protocol IPv4 and IPv6

HCL OneTest™ API, HCL OneTest™ API Agent, and HCL® Quality Server can operate in both IPv4 and IPv6 environments.

Product components can be set to run in either of the following operating modes:

For HCL® Quality Server set the Networking option during installation. For more details, see Networking considerations.
For HCL OneTest™ API or its Agent, set the Networking option in the library manager. For more details, see Working with Library Manager.

IP literal address

Consider these points when using IP literal address:

Use of IPv6 literal addresses in HTTP URLs is defined by Internet Standard RFC 2732
Database URL formats are specific to the JDBC Driver provider. See provider specific documentation on how to define the Database URL when using IP literal addresses, though here are some typical values of Database URL for the IBM® Db2® universal JDBC driver:
- Standard server name - jdbc:db2://www.example.com:50000/DB
- IPv4 literal address - jdbc:db2://8.4.5.6:50000/DB
- IPv6 literal address - jdbc:db2://[fe80::20c:29ff:feea:1361]:50000/DB