Home
Administrator Guide
This guide describes how to install HCL OneTest™ UI software. After you install the software, you can perform administration tasks such as license configuration and integration with other products. This guide is intended for administrators.
Integrations in UI Test perspective
In this section, you will learn about the supported integrations for the Web UI Test perspective.
Testing with Jenkins
You can use the HCL OneTest™ UI - UI Test Jenkins plugin to run tests on a Jenkins server.
Environment variables
You can add environment variables on the Jenkins server to run the Jenkins build by referring to environment variables.

Administrator Guide
This guide describes how to install HCL OneTest™ UI software. After you install the software, you can perform administration tasks such as license configuration and integration with other products. This guide is intended for administrators.
- Installation
  You can find information about the installation of HCL OneTest™ UI.
- License management
  Licensing for HCL OneTest™ UI is administered through HCL Software License & Download portal. This portal is a FlexNet-based web application that helps to manage software entitlements and licenses.
- Starting HCL OneTest™ UI from the command line
  You can start HCL OneTest™ UI from the desktop environment or a command-line interface.
- Software configuration management
  You can integrateHCL OneTest™ UI with the software configuration management systems to maintain an auditable and repeatable history of your organization's test assets.
- Integrations in UI Test perspective
  In this section, you will learn about the supported integrations for the Web UI Test perspective.
  - Integration plugin compatibility matrix
    You can find information about the versions of the integration plugins that are required to integrate Jenkins, Ant, HCL® Launch, and UrbanCode™ Deploy with HCL OneTest™ UI.
  - Testing with Ant
    You can use Ant to run compound tests and Web UI tests from the command-line interface.
  - Testing with Azure DevOps for UI tests
    When you use Azure DevOps for continuous integration and continuous deployment of your application, you can create tests for your application in HCL OneTest™ UI and run those tests in Azure DevOps pipelines. You can integrate Azure DevOps with HCL OneTest UI by using the HCL OneTest Studio extension that is available in the Visual Studio Marketplace portal.
  - Testing with EGit
    You can store your test assets in the remote Git repository and use EGit for version control operations. EGit is an Eclipse plugin for the Git version control system.
  - Configuration of test runs as a GitHub Actions Workflow
    You can configure test runs of test resources that are in a project repository of HCL OneTest™ UI in a GitHub Actions Workflow. You can choose to run test resources that are in the project in the GitHub Workflow when you want to run the test resources without opening the HCL OneTest UI.
  - Testing with IBM® Engineering Workflow Management
    You can manage test assets with Jazz™ source control management by integrating the test workbench with IBM® Engineering Workflow Management (formerly known as Rational® Team Concert™) Eclipse client.
  - Testing with Engineering Test Management
    You can integrate IBM® Engineering Test Management (formerly known as IBM Rational® Quality Manager) with HCL OneTest™ UI to initiate test runs from Engineering Test Management.
  - Testing with Jenkins
    You can use the HCL OneTest™ UI - UI Test Jenkins plugin to run tests on a Jenkins server.
    - Environment variables
      You can add environment variables on the Jenkins server to run the Jenkins build by referring to environment variables.
    - Build parameters for Jenkins
      You can define the build parameters when you configure either Freestyle or Pipeline projects. You must map the build parameters with the parameters of Run HCL OneTest UI - UI Test. When you use the build parameters, Jenkins prompts you to enter a value for the defined parameter when you run the Jenkins job. Each parameter has a name and value.
    - Task flows for running test assets from Jenkins
      You can perform certain tasks to run test assets from the Jenkins Freestyle project or the Pipeline project.
    - Installing the plugin on the Jenkins primary server
      You must install the HCL OneTest™ UI - UI Test Jenkins plugin to run UI test assets from the Jenkins server.
    - Configuring the Freestyle project
      You must configure a Freestyle project to add a build step, and then run test assets from Jenkins.
    - 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 by using the sample script
      You can configure a Pipeline project directly from the Jenkins UI by using the sample pipeline scripts to run test assets from Jenkins.
    - Configuring the Pipeline project by using the script from SCM
      You can configure the Pipeline project to use the pipeline script from the Source Code Management (SCM), and then run test assets from the Jenkins Pipeline project.
    - 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.
  - Testing with Maven
    Starting from 9.2.0, you can use the Maven plug-in that is provided with the testing product to run tests as part of your Maven build. Apache Maven is a software build tool based on the concept of a project object model (POM).
  - Testing with Micro Focus ALM
    You can integrate HCL OneTest™ UI with Micro Focus Application Lifecycle Management (ALM) to run test assets from Micro Focus ALM.
  - Testing with HCL OneTest™ API
    You can use HCL OneTest™ API extension to run API tests from HCL OneTest UI. You can either import the projects from HCL OneTest API or manage them from HCL OneTest UI by establishing the connection between the products. You can also create a compound test to run the tests by using the Agents.
  - Testing with HCL® Launch
    You can integrate HCL OneTest™ UI with HCL® Launch to run tests as a Process from HCL Launch.
  - Testing with UrbanCode Deploy
    With the HCL OneTest™ UI plugin for UrbanCode™ Deploy, you can automate the execution of tests and compound tests.
- Integrations in Functional Test perspective
  In this section, you will learn about the supported integrations for the Functional Test perspective.

Environment variables

You can add environment variables on the Jenkins server to run the Jenkins build by referring to environment variables.

You can add an environment variable on the Jenkins server by navigating to Manage Jenkins > Configure System > Global properties. You can enter the variable name by using any of the following methods for the corresponding text fields in the Run HCL OneTest UI - UI Test step:

Use the dollar sign ($) followed by the variable name.

For example, $workspace
Use the dollar sign ($) followed by the variable name between braces.

For example, ${workspace}

The HCL OneTest™ UI - UI Test Jenkins plugin uses the actual value while running the job.

For example, if you add the environment variable named workspace with the value C:\Users\HCL\workspace1, then you can use $workspace or ${workspace} as input to the Workspace field when running tests. During the run time, $workspace or ${workspace} is substituted with its corresponding value C:\Users\HCL\workspace1.