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 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 the Freestyle project by using the Integration Tester Jenkins Plugin
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 a Jenkins 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.
  - 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.
    - 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 Jenkins Plugin on the Jenkins primary server.
    - 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 the Freestyle project by using the Integration Tester Jenkins Plugin
      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 a Jenkins build.
    - 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.
    - Creating a pipeline script from Jenkins
      You must create a pipeline script to run test assets from the Jenkins Pipeline project.
    - Configuring the Pipeline project to use created scripts
      You can configure a Pipeline project directly from the Jenkins UI by using pipeline scripts to run test assets from Jenkins.
    - Configuring the Pipeline project to use scripts from an SCM
      You can configure a Pipeline project to use pipeline scripts from a Source Code Management (SCM) source to run tests from Jenkins.
    - 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 you run tests that are in a Jenkins Freestyle project or a Jenkins Pipeline project, you can view the 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 the Freestyle project by using the Integration Tester Jenkins Plugin

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 a Jenkins build.

Before you begin

You must have completed the following tasks:

Installed the Integration Tester Jenkins Plugin. See Setting up the integration with Jenkins.
Created an Agent in Jenkins.
Created a Freestyle project in Jenkins.

Procedure

Open the Jenkins Freestyle project on the Jenkins Dashboard, and then click Configure.
Click the Build tab, and then click Add build step.
Select Run Integration Tester Tests.

The build step is displayed.

Enter values for the following fields:


Field	Value
Installation directory	Enter the path to the installation directory of HCL OneTest™ API.
Project	Enter the path to the folder containing the project and the name of the project
Environment	Enter the name of the environment that is configured in the project.
Tests	Enter the name of the test that you want to run.

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.

Note: In HCL OneTest™ API 10.2.2 or later, the environment variables INTEGRATION_TESTER_HOME and INTEGRATION_TESTER_AGENT_HOME are automatically created at the time of installing the product software.

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.

Click Advanced to view and update the other fields that are relevant for the test.
Click Save.

Results

You have configured the Freestyle project by adding the build step.

What to do next

You can run test assets from the Jenkins server. See Running tests from Jenkins.