Welcome
Administrator Guide
This guide describes how to install HCL DevOps Test UI (Test 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 DTUI-UITest-Jenkins-HCL plugin to run tests on a Jenkins server.
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.

Release Notes
This document includes information about the new features introduced, features deprecated or removed, defects fixed, and known issues identified in this version of HCL DevOps Test UI (Test UI). You can also find the installation and upgrade instructions along with the contact information of HCL Customer Support.
System Requirements
This document includes information about hardware and software requirements for HCL DevOps Test UI (Test UI) 2024.06 (11.0.2).
Getting Started Guide
This guide provides an overview of HCL DevOps Test UI (Test UI). You can find the task flows to get you started with Test UI. This guide is intended for new users.
Tutorials
You can learn to start using Test UI by reviewing the information in the Tutorials for the UI Test perspective and Functional Test perspective.
Samples
You can find the sample project that you can use with HCL DevOps Test UI (Test UI) to test the functionality of an application.
Administrator Guide
This guide describes how to install HCL DevOps Test UI (Test 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 DevOps Test UI (Test UI).
- License management
  Licensing for HCL DevOps Test UI (Test UI) is administered through HCLSoftware License & Download Portal (FlexNet Operations Cloud). This portal is a FlexNet-based web application that helps to manage software entitlements and licenses.
- Starting DevOps Test UI from the command line
  You can start HCL DevOps Test UI (Test UI) from the desktop environment or a command-line interface.
- Software configuration management
  You can integrateHCL DevOps Test UI (Test 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, and HCL DevOps Deploy (Deploy) with HCL DevOps Test UI (Test 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 DevOps Test UI (Test UI) and run those tests in Azure DevOps pipelines. You can integrate Azure DevOps with Test UI by using the HCL DevOps Test Workbench (Test Workbench) 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 DevOps Test UI (Test 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 Test 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 DevOps Test UI (Test UI) to initiate test runs from Engineering Test Management.
  - Testing with Jenkins
    You can use the DTUI-UITest-Jenkins-HCL 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 DevOps Test 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 DTUI-UITest-Jenkins-HCL 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 DevOps Test UI (Test UI) with Micro Focus Application Lifecycle Management (ALM) to run test assets from Micro Focus ALM.
  - Testing with DevOps Test Integrations and APIs
    You can use HCL DevOps Test Integrations and APIs (Test Integrations and APIs) extension to run API tests from HCL DevOps Test UI (Test UI). You can either import the projects from Test Integrations and APIs or manage them from Test 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® DevOps Deploy
    You can integrate HCL DevOps Test UI (Test UI) with HCL DevOps Deploy (Deploy) to run tests as a Process from Deploy.
  - Testing with IBM® DevOps Deploy
    With the HCL DevOps Test UI (Test UI) plugin for IBM® DevOps Deploy (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.
Test Author Guide
This guide describes how to create test scripts and enhances them by applying different test elements such as dataset, variables, and verification points.
Test Execution Specialist Guide
This guide describes how to automate the playback of the tests by using different methods such as Docker, IBM Cloud Private, Jenkins and so on. The test results can be pushed to HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel).
Test Manager Guide
This guide describes how to keep track of the performance of the application by evaluating the test results. Following topics cover how you can work with the test results.
Troubleshooting
This guide describes how to analyze and resolve some of the common problems that you might encounter while you work with HCL DevOps Test UI (Test UI).
Reference Guide
This guide describes the additional topics to gain more knowledge about HCL DevOps Test UI (Test UI).
All Guides (PDF)
You can find the link to view or download the content of the release notes, system requirements, and persona guides of HCL DevOps Test UI (Test UI) as a PDF file.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for the product documentation.

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.

Before you begin

You must have completed the following tasks:

Verified that you have test assets residing within Test UI.
Configured the Freestyle project, if you want to run test assets from the Freestyle project. See Configuring the Freestyle project.
Configured the Pipeline project either by using the Pipeline script or Pipeline script from SCM, if you want to run test assets from the Pipeline project. See Configuring the Pipeline project by using the sample script or Configuring the Pipeline project by using the script from SCM.
Downloaded the latest Test Results Analyzer plugin from the Jenkinsci repository. For more information about the Test Results Analyzer plugin, refer to the Jenkins documentation.
Installed the Test Results Analyzer plugin on the Jenkins server. For more information about installing the plugin, refer to the Jenkins documentation.
Closed Test UI.

About this task

After the test run is complete, you can view the test results in a tabular format when you use the Jenkins Test Results Analyzer plugin. With a TRA-based report, you can filter the results based on the status of the build. The status of the builds can be PASSED, FAILED, and SKIPPED. You can also identify the failed build from the TRA-based report and take the required action to resolve the build errors. The TRA report also represents the build information in Line, Bar, and Pie graphs so that you can easily read the data.

Note: You can view the TRA-based reports only when you run Web UI tests.

Procedure

Log in to the Jenkins server.
The Jenkins dashboard is displayed.
Open your Jenkins Freestyle or Pipeline project from the list.
Perform one of the following steps to run the test assets from Jenkins:
- Click Build Now.
- Click Build with Parameters to provide the values for the defined parameters, and then click Build.

Results

You have run the test from the Jenkins server.

What to do next

You can view the build logs by clicking the build number from the Build History pane, and then selecting the Console Output option.

You can also view the history of test results in a tabular format by clicking the Test Results Analyzer option. The TRA reports are available only for Web UI test assets.