Installing HCL OneTest Performance Agent

Install HCL OneTest™ Performance Agent on different computers to apply load on the server that hosts the application under test.

Before you begin

Before you start the installation, review the installation considerations.

About this task

You cannot upgrade from version 9.2.1 to Uninstall the existing version of the product before installing

To install the product from a command prompt in silent mode, see the Installing Silently section of the IBM Installation Manager Information Center.

Currently, collection of response time breakdown data from macOS system is not supported.


  1. In the Installation Manager, click File > Preferences > Repositories, and add a repository link to the product's setup disk and click OK.
  2. Click Install.
  3. Click a product package. Its description is displayed in the Details pane at the bottom of the screen.
  4. To search for updates to the product packages, click Check for Other Versions, Fixes, and Extensions. Make sure you are connected to the internet. If updates for a product package are found, they are displayed in the Installation Packages list on the Install Packages page below their corresponding product. Only recommended updates are displayed by default.
    • To view all of the updates that are found for the available packages, click Show all versions.
    • 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. Click the link to display the additional information in a browser. To fully understand the package that you are installing, review all of the information.
  5. Select the product package and updates to the package to install. Updates that have dependencies are automatically selected and cleared together. Click Next to continue.
    Note: If you install multiple packages at the same time, all the packages are installed into the same package group.
  6. On the Licenses page, read the license agreement for the selected package. If you selected more than one package to install, each package might have a separate license agreement. On the left 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 an update) are listed under the package name.
    1. Read and understand the terms of all of the license agreements before clicking I accept the terms of the license agreements.
    2. Click Next to continue.
  7. On the Location page, in the Shared Resources Directory field, type the path for the shared resources directory or accept the default path. The shared resources directory contains resources that one or more package groups can share. Click Next to continue.
    These default paths are provided:
    • For Windows. C:\Program Files\HCL\HCLIMShared
    • For Linux. /opt/HCL/HCLIMShared
    Important: You can specify the shared resources directory only the first time that you install a package. Use your largest disk for this directory to help ensure adequate space for the shared resources of future packages. You cannot change the directory location unless you uninstall all packages.
  8. On the Location page, create a package group to install the product package into or for an update, use the existing package group. A package group represents a directory in which packages share resources with other packages in the same group. To create a package group, complete these steps:
    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.
      These default paths are provided:
      • For Windows. C:\Program Files\HCL\HCLProducts
      • For Linux. /opt/HCL/HCLProducts
    3. Click Next to continue.
  9. HCL OneTest Performance Agent does not support extending an existing Eclipse IDE, so you can ignore this page.
  10. On the Features page under Translations, select the languages for the package group. The corresponding translations for the user interface and documentation for the product package will be installed.
  11. On the next Features page, select the features to install.
    1. By default, the Load Generation Agent check box is selected. The Load Generation Agent is used to generate a load on the system under test and gather data for the Response Time Breakdown feature.
      Note: IBM Installation Manager automatically enforces any dependencies with other features and displays updated download sizes and disk space requirements for the installation.
    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. After you are finished selecting features, click Next to continue.
  12. On the next Features page, configure the agent:
    1. On the Select Java Runtime page, for Enter Java Executable, specify the path to IBM JDK or Oracle JDK or use Select Java Executable from list to select the Java path.
      Note: After installing the product, you cannot update the Java path. To change the Java path, you must uninstall and then install the product. If you choose to specify Java directory path as C:\ProgramData\Oracle\Java\javapath, you can install IBM JDK or Oracle JDK on any directory.
    2. For Windows.: The Web UI test panel is applicable only if you are shell-sharing HCL OneTest Performance and HCL OneTest UI and executing a Web UI test on the remote agent computers. If you are not running a Web UI test, do not select the The agent will be used primarily to support remote execution of Web UI tests check box so that Majordomo starts as a service. When Majordomo runs as a service, it starts automatically after the computer reboots. However, if you must run the Web UI test on remote agent computers, select the check box, so that, after the installation of the agent, Majordomo starts as a batch file instead as a service. When Majordomo runs as a batch file, it stops after the machine reboots. You must restart Majordomo by double clicking AgentInstallDir/Majordomo/Majordomo.bat.

      On Linux, this check box is not avaialble, and, by default, the agent is started as a service and can run a Web UI test.

      Click Next.
    3. For Load Generation Agent, type the workbench host name. If needed, change the port number. You can also change the port number after you install HCL OneTest Performance Agent. For more information, see the Configuring ports for agents topic.
    4. Click Next.
  13. On the Summary page, review your choices before installing the product package. 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 that is complete.
  14. When the installation process is complete, a message confirms the completion of the process.
    1. Click the View log file button to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.
    2. Click Finish to install the selected package.
  15. Required: Complete the following steps after the product is installed:
    1. Open the terminal and pass this command to create a soft link to the jdk directory.
      cd /opt/HCL/HCLProducts
      sudo ln -s /opt/ibm-java/jdk64 jdk
    2. Browse to the product installation directory, open the eclipse.ini file, and specify the following path.

What to do next

After the installation, the agent starts polling the workbench based on the IP address or the host name provided by you. You can check the status of agents from the workbench. See Checking the status of agents.