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

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.
    - Task flow: Working with Apache Maven
      The tasks outlined in the work flow help you to get started with working with Apache Maven to run tests using HCL OneTest™ API as part of your Maven integration project.
    - Generating Maven scripts to run stubs, tests, or suites
      You can generate Maven scripts from HCL OneTest™ API by using the Integration Tester Test Execution plug-in. You can use the generated script to run stubs, tests, or suites in a Maven build.
    - Running POM files from earlier versions of HCL OneTest™ API
      POM files generated from earlier versions of HCL OneTest™ API cannot run with HCL OneTest API 9.2.1 or later. To use POM files generated from earlier versions of HCL OneTest API you must edit the existing POM file. POM files generated from HCL OneTest API 9.2.1.1 or later can run a Maven command to update the version property value. Alternatively, you can create a new POM file with the current release.
  - 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.
  - 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.

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.

Introduction

To automate testing with HCL OneTest™ API for your Maven build project, you must configure a POM file that points to the integration test or project and launch the test from the command line using Maven commands. You must be familiar with working with Maven and the build life cycle. For more information about Maven, see Maven.

You can get a complete picture of the tasks you must complete by using HCL OneTest™ API integration tests in your Maven project by referring to Task flow: Working with Apache Maven.

Before you proceed with the following task install the requisite software. See Installing software.

You can run integration tests by using HCL OneTest™ API or HCL OneTest™ API Agent and you must configure the path to the installed location of these components as environment variables. See Setting up environment variables.

For enabling Maven to access the Maven plug-in from HCL® Quality Server during the Maven build, you must install HCL® Quality Server in a server, verify whether it is accessible, and import the certificate into the JDK trust store. See Adding HCL Quality Server certificate to JDK trust store.

Maven plug-in

With the HCL OneTest™ API Maven plug-in, you can run tests and test suites, as well as starting and stopping stubs as part of your Maven build. Each of these tasks is represented by a specific goal in Maven as follows:

start-stubs
run-tests
stop-stubs

You can run integration tests as part of your Maven project builds by running the Maven commands. See Running Maven commands.

The build results after successful runs are found as reports in the Maven target folder. See Viewing Maven build results.

Samples

To facilitate working with your Maven integration project in HCL OneTest™ API, a set of sample POM files, a sample HCL OneTest™ API starter project, and a sample unit test for that project are provided for you to download from the sample project site at https://github.com/ibm-rtvs/maven. You can also refer to the README.md file from the sample project site for instructions about using the samples in your Maven project build.