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 Functional Test perspective
In this section, you will learn about the supported integrations for the Functional Test perspective.
Testing with Jenkins
You can use the HCL OneTest™ UI - Functional Test to run tests on a Jenkins server.
Configuring the Freestyle project
You must configure a Freestyle project to add a build step, and then run test assets from Jenkins.

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.
- Integrations in Functional Test perspective
  In this section, you will learn about the supported integrations for the Functional 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 functional tests from the command line. Starting with version 2.0 of the ant plugin, you can run multiple tests simultaneously.
  - Testing with Azure DevOps for functional 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 Cucumber
    Starting with HCL OneTest™ UI 9.2, you can take advantage of Cucumber integration to create, annotate, and run functional test scripts that can be easily understood by all members of the team.
  - Testing with Micro Focus Application Life Cycle Management
    To obtain test result details, you can integrate and run Functional Test scripts in Micro Focus Application Lifecycle Management by using a ready-made template available in the HCL OneTest™ UI installation directory.
  - 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 Test Management
    HCL OneTest™ UI can be integrated with IBM® Engineering Test Management. You can execute the functional test scripts from HCL OneTest UI.
  - Testing with IBM® Engineering Test Management in the Visual Studio IDE
    HCL OneTest™ UI in the Visual Studio environment supports integration with IBM® Engineering Test Management.
  - Testing with Jenkins
    You can use the HCL OneTest™ UI - Functional Test 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 an HCL OneTest UI - Functional 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 - Functional Test Jenkins plugin to run 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 with v9.2, you can use the Maven plug-in to run Functional Test scripts. Apache Maven is a software build tool based on the concept of a project object model (POM). You can use the Maven plug-in that is provided to run tests as part of your Maven build.
  - Testing with IBM® Engineering Workflow Management
    HCL OneTest™ UI can be integrated with IBM® Engineering Workflow Management (formerly known as Rational Team Concert). You can manage functional test assets by using the Jazz™ source control management that the Jazz Eclipse Client provides. You must have a compatible version of IBM Engineering Workflow Management server set up to use the Jazz source control management.
  - Testing with Tivoli Composite Application Manager
    HCL OneTest™ UI can be integrated with IBM Tivoli® Composite Application Manager. You can schedule the interval at which the application manager agent runs to track the response time and generate logs using HCL OneTest UI scripts.
  - 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
    You can run functional test scripts remotely with the HCL OneTest™ UI - Functional Test plugin for UrbanCode™ Deploy.

Configuring the Freestyle project

You must configure a Freestyle project to add a build step, and then run test assets from Jenkins.

Before you begin

You must have completed the following tasks:

Installed the HCL OneTest™ UI - Functional Test on the Jenkins primary server. See Installing the plugin on the Jenkins primary server.
Created an Agent in Jenkins. For more information about creating Agents, refer to the Jenkins documentation.
Copied the name of the labels that you provided in the Labels field when you created the Agent.
Created a Jenkins Freestyle project.

About this task

When you create a Freestyle project in the Jenkins server, you must select the Restrict where this project can be run checkbox and enter the name of the labels that you provided during the creation of Agent in the Label Expression field.

Procedure

Open the Jenkins Freestyle project, and then click Configure.
Click the Build tab, and then click Add build step.
Select the Run an HCL OneTest UI - Functional Test option from the drop-down list.

Provide the details about the test run for the fields in the following table:


Field	Description
Name	Required. The name of the HCL OneTest™ UI test.
Project Directory	Required. The fully qualified path to the HCL OneTest™ UI project directory. You must use '\\' or '/' as the file separator.
Script Name	Required. The name of the script to be run.
Log Format	Optional. The format of the script run logs. The avaiable options are as follows: Default none json xml html TPTP Text
Iteration Count	Optional. The number of dataset iterations to be run.
User Arguments	Optional. Additional playback arguments, if any. For multiple arguments, you must enclose each argument within double quotation marks and separate the arguments by providing a space between them. For example, "password" "7891230" "20".
Project Dependencies	Optional. The complete path to the project that your test depends for the run. If there are multiple projects, you must separate each project path with a semicolon.

Optional: Click Add build step again, and provide details for the next test to run multiple tests under the same job.
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.