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

You must have installed Installation Manager from the jazz website. For more information about installing the product from the command-line interface in the silent mode, see IBM Installation Manager Knowledge Centre.

You must ensure that you have connected to the Internet.

About this task

Notes:

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

  • Currently, the collection of response time breakdown data from the 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.

Procedure

  1. Open Installation Manager.
  2. Click File > Preferences > Repositories to add a repository link to the product's setup disk, and then click OK.
  3. Click Install.
  4. Click a product package.
    The description of the product package is displayed in the Details pane at the end of the window.
  5. Optional: Click Check for Other Versions, Fixes, and Extensions to search for any updates to the product packages.
    If updates for a product package are found, they are displayed in the Installation Packages list under their corresponding product. Installation Manager displays only the recommended updates by default.
  6. Optional: Select the Show all versions checkbox to view all the updates that are available for the packages.
    You can click the package name to view the package description under the Details pane. 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. You can click the link to view additional information in a browser.
  7. Select the product package and its updates, install it on your computer, and then click Next.
    Note: Updates with dependencies are automatically selected and cleared together. If you install multiple packages simultaneously, all the packages are installed into the same package group.
  8. Read and understand the terms of all of the license agreements for the selected package, and then perform the following steps:
    1. Click I accept the terms in the license agreement.
    2. Click Next to continue.
  9. Select a location for the shared resources directory, and then click Next.

    The shared resources directory contains resources that can be shared with one or more package groups. You can either browse the location in the Shared Resources Directory field or enter the path of the location for the shared resources directory.

    The default path of the Shared Resources Directory are as follows:

    • For win_icon: C:\Program Files\HCL\HCLIMShared

    • For lin_icon: /opt/HCL/HCLIMShared

    • For mac_icon: /Applications/HCL/HCLIMShared

    Remember: 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. The largest disk ensures that you have adequate space for the shared resources of future packages. You cannot change the location of the directory unless you uninstall all packages.
  10. Select one of the following options to use an existing or new package group:
    • Use the existing package group: You can use this package group if you update the product.
    • Create a new package group: You can use this package group either to install or update the product.
    A package group represents a directory in which packages share resources with other packages in the same group.
    Note: The Use the existing package group option is disabled when you install a package for the first time.
  11. Perform the following steps to create a new package group:
    1. Select Create a new package group.
    2. Enter the path in the Installation Directory field for the package group.
      The name for the package group is created automatically.
      The default paths are as follows:
      • For win_icon: C:\Program Files\HCL\HCLOneTest
      • For lin_icon: /opt/HCL/HCLOneTest
      • For mac_icon: /Applications/HCL/HCLOneTest
    3. Select 32-bit or 64-bit as Architecture Selection.
    4. Click Next.
  12. Click Next.
    HCL OneTest™ Performance Agent does not support extending an existing Eclipse IDE.
  13. Select the languages for the package group.

    The corresponding translations for the user interface and documentation for the product package are installed.

  14. Select all the features that you want to install, and then click Next.

    You can perform the following actions to install or view information about the features:

    • Select the Windows desktop Application testing (Next Generation) and Appium Drivers for Automated Testing checkboxes to install the UI Test Agent which provides the necessary prerequisites to test native and hybrid mobile applications, and Windows desktop applications. The UI Test Agent is installed along with HCL OneTest™ Performance Agent on your computer.
      Note: After the installation, the UI Test Agent starts to run automatically on your computer whenever you restart your computer. On Linux and macOS, you must set the environment variable to start the UI Test Agent automatically. For more details, see the related links.

    • Select Show Dependencies to view the dependency relationships between features.

    • Click a feature to view its brief description under Details.

    Notes:
    • The Load Generation Agent is used to generate a load on the system under test and gather data for the Response Time Breakdown feature.
    • Installation Manager automatically enforces any dependencies with other features and displays updated download sizes and disk space requirements for the installation.
  15. Perform the following steps to configure the agent:
    1. Select HCL OneTest UI Panel if you shell-share HCL OneTest™ Performance with HCL OneTest™ UI and run a UI test on the remote agent computers.
      Notes:

      • On Windows system, clear The agent will be used primarily to support remote execution of UI tests from HOT-UI checkbox if you are not running a UI test, so that Majordomo runs as a service.

      • On Linux and Mac operating systems, the The agent will be used primarily to support remote execution of UI tests from HOT-UI option is not available. The agent runs as a service and can run a UI test. This is the default behavior.

      • When Majordomo runs as a service, it starts the service automatically after the computer is restarted. However, if you want to run the UI test on remote agent computers, then you must select The agent will be used primarily to support remote execution of UI tests from HOT-UI checkbox so that after the installation of the agent is complete, Majordomo runs as a batch file instead of a service.

      • When Majordomo runs as a batch file, it stops after the computer is restarted. You must restart Majordomo by double-clicking the AgentInstallDir/Majordomo/Majordomo.bat file.

    2. Select HCL Load Generation Agent Configuration and perform the following steps:
      1. Specify the values for the following parameters for HCL OneTest™ Performance:
        Field name Description Example
        Workbench hostname The hostname of HCL OneTest™ Performance. localhost
        Workbench port The port number of HCL OneTest™ Performance. 7080

      2. Specify the values of the following parameters for HCL OneTest™ Server:

        Field name Description Example
        Server Hostname The hostname of HCL OneTest™ Server.
        Note:

        • The hostname of HCL OneTest™ Server must be resolvable through a Domain Name Server (DNS).

        • An IP address cannot be the hostname of HCL OneTest™ Server.

        • The hostname of HCL OneTest™ Server through host files must not be specified.

          For example, /etc/hosts or C:/Windows/system32/drives/etc/host

        		 localhost
        Server Port The port number of HCL OneTest™ Server. 443
        Server Token An offline user token that is created from HCL OneTest™ Server. eyJhbGciOiJIUzI1NiIsInR
        Server URL Alias The name of the Server URL Alias that you provided during the creation of the team space in HCL OneTest™ Server. testteam
    3. Click Next.
  16. Review your choices, and then click Install.
    You can click Back to change the choices that you made on previous pages and make your changes.
    A progress indicator shows the percentage of the installation that is complete.
  17. Optional: Click View Log File to open the installation log file for the current session in a new window.
    Note: You must close the Installation Log window to continue.
  18. Click Finish to exit the installation wizard.

Results

You have installed HCL OneTest™ Performance Agent.

What to do next

You can check the status of agents from the workbench. See Checking the status of agents.