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.
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 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

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
- 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
    - Installing the Launch plugin
      You must install the latest version of the HCL® Launch plugin for HCL OneTest™ API or the HCL Launch plugin for HCL OneTest Virtualization on the HCL Launch server to integrate HCL OneTest API or HCL OneTest Virtualization with HCL Launch, and then run tests on the HCL Launch server.
    - Running tests on the Launch server
      After you install the HCL® Launch plugin for HCL OneTest™ API or the HCL Launch plugin for HCL OneTest Virtualization on the HCL Launch server, you can create a process request that contains the test for your application, and then run the test on the HCL Launch server.
  - 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.
  - 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
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
Reference Guide
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.

HCL OneTest™ API 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® Launch plugin for HCL OneTest™ API

With the HCL® Launch plugin for HCL OneTest™ API, you can run a test or a test suite defined in an HCL OneTest™ API project.

HCL® Launch plugin for HCL OneTest™ Virtualization

Service Virtualization helps you to automate the testing of integration in complex application environments much earlier in the development life cycle. You can use the HCL® Launch plugin for HCL OneTest™ Virtualization for creating virtual services that model the services on which your application depends. You can virtualize services that are accessed through various technologies, including HTTP, MQ, JMS, JDBC, TCP/IP, CICS-TG, IMS Connect, SAP, and Software AG web methods.

Task flow for integrating with HCL® Launch

The following table shows the task flow for integrating HCL OneTest™ API with HCL® Launch by using the HCL® Launch plugin for HCL OneTest™ API or the HCL® Launch plugin for HCL OneTest™ Virtualization. You must perform these tasks in sequence.


	Tasks	More information
1.	Create tests for the application that you want to test in HCL OneTest™ API.	Building tests
2.	Install the latest version of the HCL® Launch agent on the HCL® Launch server, which runs the tests.	Installing the agents
3.	Download the latest version of the HCL® Launch plugin for HCL OneTest™ API or the HCL® Launch plugin for HCL OneTest™ Virtualization. Note: Do not extract the compressed file contents.	HCL OneTest™ API Launch plugin or HCL OneTest™ Virtualization Launch plugin
4.	Install the latest version of the HCL® Launch plugin for HCL OneTest™ API or the HCL® Launch plugin for HCL OneTest™ Virtualization on the HCL® Launch server.	Installing the HCL Launch plugin for HCL OneTest API or the HCL Launch plugin for HCL OneTest Virtualization
5.	Run tests by using the HCL® Launch plugin for HCL OneTest™ API or the HCL® Launch plugin for HCL OneTest™ Virtualization on the HCL® Launch server.	Running HCL OneTest API tests on the HCL Launch server