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.
Integrating
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.
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.
Configuring HCL OneTest™ API Agent as an IBM® Engineering Test Management adapter
HCL OneTest™ API Agent can be configured as an Engineering Test Management adapter to enable remote test runs.
Configuring the Engineering Test Management Agent as a Windows service
If you have installed only HCL OneTest™ API, you might want to set up Engineering Test Management Agent as a Windows service.

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.
- Configuring HCL OneTest™ API
- Administering HCL® Quality Server
  HCL® 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.
- Integrating
  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.
  - 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.
  - Integration with 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.
      - Configuring IBM® Engineering Test Management integration
        You can configure one or more Engineering Test Management servers in HCL OneTest™ API to be able to run integration tests and suites in the centralized test management environment of Engineering Test Management.
      - Configuring HCL OneTest™ API Agent as an IBM® Engineering Test Management adapter
        HCL OneTest™ API Agent can be configured as an Engineering Test Management adapter to enable remote test runs.
        Configuring the Engineering Test Management Agent as a Windows service
        If you have installed only HCL OneTest™ API, you might want to set up Engineering Test Management Agent as a Windows service.
    - 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 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™ 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.
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 HCL OneTest™ API
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
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.

Configuring the Engineering Test Management Agent as a Windows service

If you have installed only HCL OneTest™ API, you might want to set up Engineering Test Management Agent as a Windows service.

Before you begin

You must have configured the Agent.config file in HCL OneTest™ API as an adapter for IBM® Engineering Test Management.

Procedure

Run a command prompt as an administrator from the HCL OneTest™ API installation folder. Install the Engineering Test Management Agent as a Windows service:


prunsrv //IS//OneTestAPIRQMAgent --DisplayName="HCL OneTest API RQM Agent "  --Description="HCL OneTest API RQM Agent"  --Startup=auto --StartImage="C:\Program Files\HCL\HCLProducts\API\RQMAgent.exe" --StartPath="C:\Program Files\HCL\HCLProducts\API" --StartParams="-c C:\Program Files\HCL\HCLProducts\API\config\Agent.config"

The Java™ services are started by using the Apache Commons daemon.

Verify that the new Windows service is installed by opening the Services applet in the Control Panel by clicking Start > (All) Programs > Administrative Tools > Services.

The Windows service name is HCL OneTest API RQM Agent.
Start the service from the Service window.
Note: You can also change other properties such as the type of startup.

You can delete the service if you no longer want to run the Engineering Test Management Agent as a Windows service by performing the following action:
Run a command prompt as an administrator from the HCL OneTest™ API installation folder:
```
prunsrv //DS//OneTestAPIRQMAgent
```