Installing HCL OneTest UI

To get started, you must install HCL OneTest UI.

Before you begin

  • Your computer must have met the system requirements and completed the preinstallation tasks.
  • If you want to install the HCL OneTest UI on Linux machine, the following libraries must be available on your machine.
  • To install HCL OneTest UI on Red Hat Linux Enterprise (RHEL) 8.0 and later, you must have completed one of the following tasks:
    • Installed on your computer
    • Created a soft link to by running the following command:sudo ln -s /usr/lib64/ /usr/lib64/
  • To install HCL OneTest UI on a computer with Ubuntu operating system, you must have installed libxm4 and libxp6 packages.
    • Add deb precise-security main to /etc/apt/sources.list
    • From the terminal, pass these commands:

      $ sudo apt-get update and $ sudo apt-get install libxm4 libxp6
  • Note: Microsoft Visual Studio integration for HCL OneTest UI might not get installed if the mandatory prerequisites are not installed, or if Microsoft Visual Studio is not installed properly. For more information, see Unable to install HCL OneTest UI Extension for Microsoft Visual Studio 2015, 2017 & 2019.
  • You cannot upgrade to the latest version of the product. You must uninstall the existing version of the product before installing the latest version of the product.
  • HCL Software manages software licensing and downloads through the License and Delivery Portal. You must have ordered software and followed the instructions that you received to activate your entitlement and download the software from the Portal. These instructions help you complete the following steps:
    • Order the software. Gather the URL and login credentials for the HCL Software License & Download portal.
    • Log in to the Portal.
    • Create a User associated with your account.
    • Create a Device to host the license server and record the server ID that is returned when the device is created.
      Important: The server ID uniquely identifies your company’s entitlement and must be kept secure.
    • Map your entitlement to the license server Device.
    • Download the software.
  • Download and install IBM® Installation Manager.
  • To install the product on a Windows computer, install Oracle JDK 8.
  • If you were using the IBM testing product and want to reuse the test assets in the HCL testing product, follow these instructions:
    • From the IBM testing product, export all the test assets with dependencies.
    • Uninstall the IBM testing product.
    • Install the HCL testing product by following the instructions in this topic.
    • Import the test assets with dependencies to the HCL workspace.
Note: You must install HCL OneTest UI using either root user or Sudo access.


To install HCL OneTest UI on Windows® or Linux® operating systems:
  1. Start Installation Manager and from File > Preferences > Repositories, add a new repository link by pointing to the setup disk of the product.
  2. On the IBM® Installation Manager Start page, click Install.

    The Install Packages page lists all the packages found in the repositories that Installation Manager searched. If two versions of a package are discovered, only the most recent, or recommended version of the package is displayed. If Installation Manager is not installed on your computer, it is listed on the Install Packages page with HCL OneTest UI.

    1. To display all versions of the packages that Installation Manager finds, click Show all versions.
      Note: To search the predefined IBM update repository locations for the installed packages, ensure that Search service repositories during installation and updates check box is selected on the Repositories preference page. This preference is selected by default.
      If updates for the HCL OneTest UI package are found, then they are displayed on the Installation Packages list on the Install Packages page. The latest updates are displayed by default.
    2. To find other versions, fixes and extensions for the available packages in the update repository locations, click Check for Other Versions, Fixes and Extensions.
    3. To view all updates found for the available packages, click Show all versions.
    4. To display a package description under Details, click the package name. If additional information about the package is available, such as a readme file or release notes, a More info link is included at the end of the description text. To fully understand the package you are installing, review all information beforehand.
  3. Select HCL OneTest UI, the required version, and Installation Manager, if necessary and click Next.
    Updates that have dependencies are automatically selected and cleared together.
    Note: If you install multiple packages simultaneously, then all the packages will be installed into the same package group.
  4. On the Licenses page, read the license agreement for the selected package.

    If you select multiple packages to install, each package might contain a license agreement. On the left side of the License page, click each package version to display its license agreement. The package versions that you selected to install (for example, the base package and update) are listed under the package name.

    1. If you agree to the terms of all of the license agreements, click I accept the terms of the license agreements.
    2. Click Next to continue.
  5. On the Location page, type the path for the shared resources directory in the Shared Resources Directory field, or accept the default path. The shared resources directory contains resources that can be shared by one or more package groups. Click Next to continue.
    Important: If you are installing HCL OneTest UI on Windows®, and do not have Windows® Administrator privileges to work with HCL OneTest UI, you must not choose a directory inside the Program Files directory (C:\Program Files\).
    The default path is:
    • For Windows®: C:\Program Files\HCL\HCLIMShared
    • For Linux®:/opt/HCL/HCLIMShared
    Important: You can specify the shared resources directory only the first time when you install a package. You must use your largest disk partition to ensure adequate disk space is available for the shared resources of future packages. You cannot change the directory location unless you uninstall all packages.
  6. On the Location page, specify whether to create a package group and install the HCL OneTest UI package into a new package group or use an existing package group to shell-share with another offering. A package group represents a directory in which packages share resources with other packages in the same group. To create a new package group:
    1. Click Create a new package group.
    2. Type the path for the installation directory for the package group.
      The name for the package group is created automatically.
      The default path is as follows:
      • For Windows®: C:\Program Files\HCL\HCLOneTest
      • For Linux®: /opt/HCL/HCLOneTest
      Note: If you are installing HCL OneTest UI on a Linux® machine, ensure that you do not include any spaces in the directory path.
      Important: On Windows Vista, the Program Files directory is usually virtualized to allow users who are not running as the Administrator to have write access to this protected directory. However, the virtualization workaround is not compatible with HCL OneTest UI.
    3. Click Next to continue.
  7. On the next Location page, you can choose to extend an existing Eclipse IDE already installed on your system, adding the functionality in the packages that you are installing.
    Note: You must have Eclipse 3.6.2 with the latest updates from to select this option.
    • If you do not want to extend an existing Eclipse IDE, click Next to continue.
    • To extend an existing Eclipse IDE:
      1. Select Extend an existing Eclipse.
      2. In the Eclipse IDE field, type or navigate to the location of the folder containing the eclipse executable file (eclipse.exe or eclipse.bin). Installation Manager checks whether the Eclipse IDE version is valid for the package that you are installing. The Eclipse IDE JVM field displays the Java Virtual Machine (JVM) for the IDE that you specified.
      3. Click Next to continue.
  8. On the Features page under Languages, select the languages for the package group, and then click Next.

    The corresponding national language translations for the user interface and documentation for the HCL OneTest UI package is installed.

  9. Select the package features that you want to install.
    1. Select or clear features in the packages. Installation Manager automatically enforces any dependencies with other features and displays the updated download size and disk space requirements for the installation.
      • If you want to shell share HCL OneTest UI along with other products that utilize OpenJDK, you must select Java 8 OpenJDK with Eclipse OpenJ9 for only one of the shell shared products. You must not install multiple instances of OpenJDK in the same package group.
      • The Windows Desktop Application Testing (Next Generation) option, which is a default selection, provides you with the necessary prerequisite to test the Windows desktop applications. When the Windows Desktop Application Testing (Next Generation) checkbox is selected, the Developer mode is enabled automatically when you restart your computer, if it was not enabled earlier.
        After you install the product, the UI Test Agent starts to run automatically on your computer. Depending on the operating system of your computer, the UI Test Agent works as follows:
        • Windows: The UI Test Agent starts to run automatically every time you restart your computer. You can find the UI Test Agent in the system tray of your computer.
        • Linux and macOS: You must set the environment variable to start the UI Test Agent automatically when you start the product. For more details, see the related links.
    2. Optional: To see the dependency relationships between features, select Show Dependencies.
    3. Optional: Click a feature to view its brief description under Details.
    4. Click Next to continue.
  10. On the Summary page, review your choices before installing the HCL OneTest UI package. If you want to change the choices that you made on previous pages, click Back and make your changes. When you are satisfied with your installation choices, click Install to install the package.
    A progress indicator shows the percentage of the installation completed.
  11. When the installation process is complete, a message confirms the success of the process.
    1. Click View log file to open the installation log file for the current session in a new window.
    2. Click Finish.
    Note: Uninstalling Microsoft Visual Studio: If you want to uninstall your existing Microsoft Visual Studio, you must first remove the Microsoft Visual Studio .NET Integration of HCL OneTest UI using the Modify option in Installation Manager. You must then uninstall Microsoft Visual Studio.

What to do next

Start the product as a root user or Sudo access for the first time. When you start the product, apply the product license key.

To start using the Visual Studio Integration feature, open the Visual Studio application and click File > New > Functional Test Project. The connector window opens within the Visual Studio and you can access the HCL OneTest UI environment.

To create a project, you must enable Java in the product.