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.
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 and IBM® Engineering Test Management
When you integrate HCL OneTest™ API with Engineering Test Management, you can run HCL OneTest API tests and suites in the centralized test management environment of Engineering Test Management.
Troubleshooting: Engineering Test Management
You can use workarounds to common problems that you might encounter when you work with Engineering Test Management.

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
- 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 and Apache Maven
    Apache Maven is a software build tool that is based on the concept of a Project Object Model (POM). You can use the Maven plug-in that is provided for HCL OneTest™ API to run integration tests and test suites as part of your Maven build.
  - HCL OneTest™ API and Azure DevOps
    When you use Azure DevOps for continuous integration and continuous deployment of your application, you can create tests for your application in HCL OneTest™ API and run those tests in Azure DevOps pipelines. You can integrate Azure DevOps with HCL OneTest API by using the HCL OneTest Studio extension that is available in the Visual Studio Marketplace portal.
  - HCL OneTest™ API and change management tools
    HCL OneTest™ API can be integrated with the OSLC-compliant Change Management Integration Providers such as Rational® Team Concert™. It can also be integrated with Team Foundation Server Change Management Integration Providers (such as Microsoft™ Team Foundation Server), and Atlassian Jira. After integration, defects and projects can be tracked directly through Rational Team Concert.
  - HCL OneTest™ API and Git
    The Git integration feature provides a flexible test asset management method to track, back up, and collaborate on a project with multiple users. Collaborators in Git can import projects and test assets from shared repositories into HCL OneTest™ API and contribute their own assets and changes to the project so that everyone has access to the changes.
  - HCL OneTest and HCL Launch
    When you use HCL® Launch (HCL Launch) for automating application deployments of your application, you can run tests created for your application that are created in HCL OneTest™ API. You can run the tests from HCL Launch by using the HCL Launch plugin for HCL OneTest API or the HCL Launch plugin for HCL OneTest Virtualization
  - HCL OneTest™ API and HP Quality Center
    The HCL OneTest™ API add-in for HP Quality Center provides a way to integrate the powerful test creation and execution functionality of HCL OneTest API with the organizational structures provided by Quality Center.
  - HCL OneTest™ API and IBM® Engineering Test Management
    When you integrate HCL OneTest™ API with Engineering Test Management, you can run HCL OneTest API tests and suites in the centralized test management environment of Engineering Test Management.
    - Setting up the integration with IBM® Engineering Test Management
      You can integrate HCL OneTest™ API with Engineering Test Management to run HCL OneTest API tests and suites in the centralized test management environment of Engineering Test Management.
    - Working with HCL OneTest™ API resources in IBM® Engineering Test Management
      After the HCL OneTest™ API-Engineering Test Management integration is complete, you can export tests and test suites from HCL OneTest API into Engineering Test Management. Exported tests and test suites are created as test cases and test scripts in Engineering Test Management.
    - Troubleshooting: Engineering Test Management
      You can use workarounds to common problems that you might encounter when you work with Engineering Test Management.
  - HCL OneTest™ API and IBM® Rational® Quality Manager
    The integration of HCL OneTest™ API with IBM® Rational® Quality Manager enables the execution of HCL OneTest API tests and suites in Rational Quality Manager centralized test management environment.
  - Integration with Rational Software Architect Designer
    With IBM® Rational® Software Architect Designer, you can design an organization's services, which include technical description, technical documentation, and links to other technical documentation. As a tester, you can pull this information into HCL OneTest™ API by using a WSDL or WADL add operation and populate the Architecture School quickly and accurately. HCL OneTest API parses the added documents in a way that you can directly use them in your testing.
  - HCL OneTest™ API and Jenkins
    When you use Jenkins for the continuous integration (CI) of your application, you can run tests for testing your application. You can run tests created in HCL OneTest™ API for your application in Jenkins by using the Integration Tester Jenkins Plugin.
  - HCL OneTest and UrbanCode Deploy
    When you use UrbanCode™ Deploy (UCD) for automating application deployments of your application, you can run tests created for your application that are created in HCL OneTest™ API. You can run the tests from UCD by using the UCD plugin for HCL OneTest API or the UCD plugin for HCL OneTest Virtualization
  - HCL OneTest™ Virtualization with Engineering Test Management
    You can implement HCL OneTest™ Virtualization in Engineering Test Management integrated with HCL OneTest Virtualization by using HCL® Quality Server.
  - HCL OneTest™ Virtualization with Rational® Quality Manager
    You can implement HCL OneTest™ Virtualization in Rational® Quality Manager integrated with HCL OneTest Virtualization by using HCL® Quality Server.

Troubleshooting: Engineering Test Management

You can use workarounds to common problems that you might encounter when you work with Engineering Test Management.

Table 1. Troubleshooting Engineering Test Management
Solutions and workarounds to problems with Engineering Test Management
Problem	Resolution
HCL OneTest™ API Agent 9.0 after configuring as a Engineering Test Management adapter to use TLSv1.2 does not connect to enable remote test execution.	Install HCL OneTest™ API 9.1.0 or later. Otherwise, for 9.0 add the following Java™ parameter: `-Dhttps.protocols=TLSv1.2` For HCL OneTest™ API, add it to `RQMAgent.ini`. For HCL OneTest™ API Agent, add it to the Library Manager JVM arguments. Note: To see what protocol is used by the Agent when connecting to Engineering Test Management, add the following Java™ parameter to `RQMAgent.ini` and `Agent.ini`. `-Djavax.net.debug=all`
After you execute tests or suites from Engineering Test Management, and click Test Results on RTCP (Click Here) from the Test Case or Test Suite Results window, a dialog opens prompting you to enter a database name. This dialog shows because you did not configure a project results database to use and so the connection to the database fails.	You must configure the project results database and publish the results database connection details from the HCL OneTest™ API project that contains the tests and suites to HCL® Quality Server. For more information, see Working with HCL OneTest API resources in IBM Engineering Test Management.
When HCL OneTest™ API Agent is using an Asian locale, results from executing HCL OneTest™ API tests and suites in Engineering Test Management do not show in an Asian language.	Change the Asian locale to an English locale by using one of the following ways: Edit `Agent_installation_directory/RunTests.ini` and append the following lines: `-nl en` Edit `Agent_installation_directory/LibConfig` and add the following JVM argument: `-Duser.language=en_US` Export the HCL OneTest™ API tests and suites again and execute them from Engineering Test Management. The results show in English in Engineering Test Management.