Installing HCL OneTest Performance Agent

You must install HCL OneTest Performance Agent on different computers to apply load on the server that hosts the application under test.

Before you begin

About this task

For more information about installing the product from the command prompt in the silent mode, see IBM Installation Manager Knowledge Centre.

  • To use the response time breakdown feature in HCL OneTest Performance Agent 8.7 or later, uninstall the existing version of the agent and install it afresh.

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

  • 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.


  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 end 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 under 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:
    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.
    The following default paths are provided:
    • For Windows. C:\Program Files\HCL\HCLIMShared
    • For Linux. /opt/HCL/HCLIMShared
    • For Macintosh. /Applications/HCL/HCLIMShared
    Important: You can specify the shared resources directory only for the first time when you install a package. You must 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. If you are updating the product, 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.
      The following default paths are provided:
      • For Windows. C:\Program Files\HCL\HCLOneTest
      • For Linux. /opt/HCL/HCLOneTest
      • For Macintosh. /Applications/HCL/HCLOneTest
    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.
    • The Load Generation Agent is used to generate a load on the system under test and gather data for the Response Time Breakdown feature.
    • IBM® Installation Manager automatically enforces any dependencies with other features and displays updated download sizes and disk space requirements for the installation.
    1. Optional: To see the dependency relationships between features, select Show Dependencies.
    2. Optional: Click a feature to view its brief description under Details.
    3. After you are finished selecting features, click Next to continue.
  12. On the next Features page, configure the agent:
    1. 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 runs 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 runs as a batch file instead of 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 available, and by default, the agent runs as a service and can run a Web UI test.

      Click Next.
    2. For Load Generation Agent, type the host name of the workbench . If needed, change the port number. You can also change the port number after you install HCL OneTest Performance Agent. For more information, see Configuring ports for agents.
    3. To connect the agent with HCL OneTest Server, specify the fully qualified domain name in Server Hostname, the port number, and the offline user token. For information about offline user token, see Managing access to HCL OneTest Server.
      Note: Use the default port number 443 to connect to the server.
    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.

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.