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.
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 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.
Configuring a Jenkins environment for running tests
After you install the Integration Tester Test Execution plugin on the Jenkins server, you can configure the Jenkins environment to run the Integration Tester tests as a Jenkins build. You can also run the tests as an Ant task by using the test configuration file generated by 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 IBM® 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.
  - 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 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.
    - Generating a Jenkins project configuration file for running tests or suites
      After you create tests or test suites for your application in HCL OneTest™ API, you can generate a project configuration file for the tests.
    - Setting up the integration with Jenkins
      You can run HCL OneTest™ API tests and view the results. You must set up the integration with Jenkins by deploying the Integration Tester plugins for Jenkins into the Jenkins environment.
    - Configuring a Jenkins environment for viewing test results
      The Integration Tester Test Execution plugin helps to run the test suites. You can also view the test suite results. The Jenkins environment must have the Integration Tester Results plugin for Jenkins installed.
    - Configuring a Jenkins environment for running tests
      After you install the Integration Tester Test Execution plugin on the Jenkins server, you can configure the Jenkins environment to run the Integration Tester tests as a Jenkins build. You can also run the tests as an Ant task by using the test configuration file generated by HCL OneTest™ API.
    - Configuring the Freestyle project by using the Ant script
      After you install the Integration Tester Jenkins plugin on the Jenkins server, you can configure the Jenkins Freestyle project environment to run the Integration Tester tests as an Ant task by using the test configuration file generated by HCL OneTest™ API.
    - Running tests from Jenkins
      You can run test assets either from the Jenkins Freestyle or the Pipeline project on the Jenkins server to test an application under test.
    - Viewing test results in Jenkins
      After configuring a Jenkins job to either run a test suite by using the Integration Tester Test Execution plugin or to run an Apache Ant build script generated by HCL OneTest™ API for a test suite, you can view test results within the Jenkins interface.
  - 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.

Configuring a Jenkins environment for running tests

After you install the Integration Tester Test Execution plugin on the Jenkins server, you can configure the Jenkins environment to run the Integration Tester tests as a Jenkins build. You can also run the tests as an Ant task by using the test configuration file generated by HCL OneTest™ API.

Before you begin

You must have completed the following tasks:

Installed the Integration Tester Test Execution plug-in by following the procedure described in Setting up the integration with Jenkins to run tests using this plugin.
Generated an Ant script by using HCL OneTest™ API to run tests using Apache Ant plugin. See Generating Ant scripts to run tests.

Running tests by using the Integration Tester Test Execution plugin

Procedure

Create a new project or modify an existing project on the Jenkins dashboard.
Click Configure on the Project page.
Click Add build step under Build.
Select Run Integration Tester Tests. The following dialog is displayed:
Fill in values for the task as required.

Enter values for Installation directory, Project, Environment, and Tests. If you leave the Installation directory blank, the following environment variables are queried during runtime to find the directory:

INTEGRATION_TESTER_AGENT_HOME and INTEGRATION_TESTER_HOME.

The job fails if the value is blank. These variables must be visible to the user or the service account that is running the Jenkins primary or secondary server. If you update either of the environment variables, you must restart the Jenkins primary or secondary server for the values to take effect.

Optionally, click Advanced to view and update the other fields. For a detailed description of any field, click the question mark icon that is next to it.
Click Save.

Running tests by using the Ant plugin

Procedure

On the Jenkins dashboard, create a new project or modify an existing project.
On the Project page, click Configure.
Under Build, click Add build step.
Select Invoke Ant.
Click Advanced.
In the Build File field, enter the location of the Apache Ant script that was generated by HCL OneTest™ API.
Click Save.