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® 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.
Working with resources in Rational Quality Manager
Once the HCL OneTest™ API-IBM® Rational® Quality Manager integration is complete, you can export tests and test suites from HCL OneTest API into Rational Quality Manager. Exported tests and test suites are created as test cases and test scripts in Rational Quality Manager.
Tests and test suites in IBM® Rational® Quality Manager
After you export tests or test suites into Rational® Quality Manager and the HCL OneTest™ API adapter is configured, you can remotely run HCL OneTest API resources.
Verifying the HCL OneTest™ API Agent
Before you can execute HCL OneTest™ API resources from IBM® Rational® Quality Manager, the HCL OneTest API Agent must be configured, running and available as an adapter in Rational Quality Manager.

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.
  - 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.
    - Setting up the integration with Rational Quality Manager
      You can integrate HCL OneTest™ API and IBM® Rational® Quality Manager to run HCL OneTest API tests and suites in Rational Quality Manager centralized test management environment.
    - Working with resources in Rational Quality Manager
      Once the HCL OneTest™ API-IBM® Rational® Quality Manager integration is complete, you can export tests and test suites from HCL OneTest API into Rational Quality Manager. Exported tests and test suites are created as test cases and test scripts in Rational Quality Manager.
      - Exporting resources from HCL OneTest™ API
        After integrating HCL OneTest™ API with IBM® Rational® Quality Manager, you can export tests and test suites from HCL OneTest API into Rational Quality Manager. Exported tests and test suites are presented as test cases and test scripts in Rational Quality Manager.
      - Tests and test suites in IBM® Rational® Quality Manager
        After you export tests or test suites into Rational® Quality Manager and the HCL OneTest™ API adapter is configured, you can remotely run HCL OneTest API resources.
        Verifying the HCL OneTest™ API Agent
        Before you can execute HCL OneTest™ API resources from IBM® Rational® Quality Manager, the HCL OneTest API Agent must be configured, running and available as an adapter in Rational Quality Manager.
        Executing test cases in IBM® Rational® Quality Manager
        Once you export at least one test or test suite into IBM® Rational® Quality Manager and the HCL OneTest™ API adapter is available, you can execute HCL OneTest API resources remotely.
        Managing HCL OneTest™ API test execution parameters in Rational® Quality Manager
        When you are running HCL OneTest™ API tests from an IBM® Rational® Quality Manager server, you can send input parameters to, and receive output parameters from the agent computers that are running the tests. You can also chain together multiple HCL OneTest API tests in Rational Quality Manager so that the output of one test can be input into another test.
    - Troubleshooting: Rational Quality Manager
      You can use workarounds to common problems that you might encounter when you work with Rational® Quality Manager.
  - 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.

Verifying the HCL OneTest™ API Agent

Before you can execute HCL OneTest™ API resources from IBM® Rational® Quality Manager, the HCL OneTest™ API Agent must be configured, running and available as an adapter in Rational® Quality Manager.

About this task

To verify the available adapters, do the following steps:

Procedure

Open the Rational® Quality Manager console and select Adapter Console from the Execution menu. All registered adapters are listed.

If the HCL OneTest™ API Agent is not listed, then it is not successfully registered with the server. In this case:
Ensure that Agent.conf is modified properly and then launch the Agent to register it (see Configuring HCL OneTest API Agent as Rational Quality Manager adapter).

If the Agent is listed but unavailable, then it is successfully registered but is probably not running. In this case:
Launch the agent, then wait for it to connect to Rational® Quality Manager. Then, refresh the list of available adapters.

Once the Agent is listed as "Available" in the adapter Console, you are ready to run HCL OneTest™ API resources from Rational® Quality Manager.