Welcome
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.
Configuration of HCL OneTest™ API
Working with Library Manager
HCL OneTest™ API uses a plug-in architecture to provide support for various middleware and messaging technologies, so the list of third-party products with which it interacts can become large. You can manage this list by using Library Manager. When support for a new architecture or messaging plug-in is required, you use Library Manager to add that support.
Library manager command-line options
Use the LibConfig executable on computers that do not have a graphical user interface.

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.
- 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 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
  - Installed directories
    When you install HCL OneTest™ API, the following directories are created and populated under the installation directory.
  - User file storage
    HCL OneTest™ API projects store user files, and can be created in any location to which a user has access. However, using a remote or network location can reduce HCL OneTest API performance significantly, so it is recommended that HCL OneTest API is installed on a local drive.
  - Changing the display language
    When you want to use the product in a different language other than the display language of your computer, then you can change the language of the product by using the command-line interface. You can find the information to change the language in Linux or Windows.
  - Configuring the project results database
    Historical test data is stored in the HCL OneTest™ API project results database. It is difficult to estimate the space that is required as the number and type of tests to be run varies. When you create the project results database, 50GB is probably a good starting point.
  - HTTP/TCP proxy setup
    The process of configuring applications to use the HTTP/TCP proxy varies according to the application.
  - Setting up the JDBC proxy
    After you install the JDBC proxy, you must deploy the proxy into the Java™ virtual machine (JVM) of the relevant applications, set up the proxy for use, and verify that it is deployed.
  - HCL OneTest™ API tool packages
    To enable HCL OneTest™ API to work with certain technologies, you must configure the required libraries by using the Library Manager and also install and configure HCL OneTest API tool packages that are provided with HCL Quality Server.
  - Working with Library Manager
    HCL OneTest™ API uses a plug-in architecture to provide support for various middleware and messaging technologies, so the list of third-party products with which it interacts can become large. You can manage this list by using Library Manager. When support for a new architecture or messaging plug-in is required, you use Library Manager to add that support.
    - Firewalls, VPNs, and multihomed machines
      Special considerations apply when you install HCL OneTest™ API on systems with firewalls, virtual private networks (VPNs), or connections to more than one network.
    - Configuring HTTP watch mode (Unix-like installations only)
      To complete installing HCL OneTest™ API on Unix-like systems, you must configure HTTP watch mode with Java™ Packet Capture (JPCAP).
    - Adding the libraries for database testing by using Library Manager
      To enable HCL OneTest™ API access to the database for testing, you must add various libraries to the configuration.
    - Custom providers
      In Library Manager, you can create new specific providers to supplement any of the existing third-party plug-ins or JDBC providers.
    - Configure default and custom provider library settings
      If you want to use providers such as JDBC, you must configure their library settings in Library Manager so that they work correctly with HCL OneTest™ API.
    - Resolving missing libraries errors
      If you see that required libraries for a specific provider are missing, you must fix the error.
    - Library manager command-line options
      Use the LibConfig executable on computers that do not have a graphical user interface.
      - Generating a configuration file for HCL OneTest™ API
        If you want to use Library Manager on computers that do not have a GUI, you can generate an XML configuration file by using a setting on the LibConfig command.
      - Editing a configuration file for HCL OneTest™ API
        After you generate an XML configuration file, you might need to change it if the target computer is different from the generated configuration. For example, the libraries and their locations in the configuration file do not match the libraries and their locations on the target computer.
      - Applying a configuration file for HCL OneTest™ API
        After the configuration file is generated and the library is copied to the target computer in the specified locations, you can apply the configuration.
    - Library manager GUI settings
      When you use a command line to configure HCL OneTest™ API, you can use an existing file as a template, and hence reuse those template settings.
  - 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.
  - HCL OneTest™ API and HCL OneTest™ Server
    You can publish test reports for tests run on HCL OneTest™ API to HCL OneTest Server. You can create secrets collections for your project and store them securely on HCL OneTest Server that you can retrieve the secrets from HCL OneTest Server during tests at runtime.
- 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.
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.
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
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
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.
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.

Library manager command-line options

Use the LibConfig executable on computers that do not have a graphical user interface.

You can configure HCL OneTest™ API from the command line by using the -genLibSettings and -processLibSettings options with the LibConfig executable. For Windows™ systems, the executable is called LibConfig.exe.

The -genLibSettings option generates an XML configuration file. Ideally, you generate the file on a computer that is configured the same or similar to the target computer.

Before the generated configuration file is processed on the target computer, you can use the -processLibSettings option to edit the configuration details.

Note: You can use an existing file as a template. To do so, find a computer that runs the graphical version of Library Manager and locate the librarysettings.xml file in the user profile. The default location is

C:\Documents
and Settings\

User ID\.integrationtester or C:\Users\User ID\.integrationtester on Windows™ systems, and ~/.integrationtester on Unix-like systems. For an example, see Library manager GUI settings.