Installing HCL OneTest™ API Agent by using Installation Manager

You can find information to install the HCL OneTest™ API Agent or HCL OneTest™ Virtualization.

Before you begin

HCL Software manages software licensing and downloads through the HCL® License & 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:
  1. Order the software. Gather the URL and login credentials for the HCL® License & Delivery portal.
  2. Log in to the Portal.
  3. Create a User associated with your account.
  4. 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 entitlement and must be kept secure.
  5. Map your entitlement to the license server Device.
  6. Download the software.

About this task

You cannot directly upgrade HCL OneTest™ API Agent from any of the earlier versions to the latest version. You must uninstall the existing version and then install the latest version.

After downloading the core installation packages, you must create repository locations that point to the diskTag.inf file in the package. If there are multiple packages, you must create repository locations for each package. If a package contains multiple disks, create repository locations pointing to each diskTag.inf file or supply the information when prompted during the installation.

Procedure

  1. Start an existing instance of Installation Manager and provide the location of the installation package as a repository:
    1. In Installation Manager, click File > Preferences.
    2. Click Add Repository and provide the path to the diskTag.inf file that is in the directory into which you extracted the package.
  2. Click Install.
  3. Click each of the product packages to highlight them.

    The description of the package is displayed in the Details pane at the bottom of the window. If more information about the package is available, such as a readme file or release notes, a More info link is included. To fully understand the package that you are installing, review all information.

    The following packages are available:
    • HCL OneTest™ API Agent
    • HCL® Quality Server

    To view all updates that are found for the available packages, click Show all versions.

    Note: For Installation Manager to search the predefined HCL® update repository locations for the installed packages, the Search the linked repositories during installation and updates preference on the Repositories preference page must be selected. This preference is selected by default. Internet access is also required. A progress indicator shows that the search is taking place. You can install updates at the same time that you install the base product package.
  4. Select the product package and any updates to the package to install. Updates that have dependencies are automatically selected and cleared together. Click Next.
  5. On the Licenses page, read the license agreement for the selected package. If you selected more than one package to install, there might be a license agreement for each package. 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 an update) are listed under the package name. If you agree to the terms of all of the license agreements, click I accept the terms of the license agreements. Click Next.
  6. On the Location page, the location of the package group into which each product is installed is displayed. Click each product to see its package group location. Optionally, you can enter another location for the package group in the Installation Directory field. Click Next.
  7. Select the translation packages to install, and then click Next.
  8. On the Features page, select the package features to install.
    1. To see the dependency relationships between features, select Show Dependencies
    2. Click a feature to view its brief description under Details.
    3. Select or clear features in the packages. Installation Manager automatically enforces any dependencies with other features and displays updated download sizes and disk space requirements for the installation.
    4. When you are finished selecting features, click Next.
  9. Select from the following options that depend on the server with which you want to register the agent:
    • To register the agent with HCL® Quality Server, go to Step 10.
    • To register the agent with HCL OneTest™ Server, go to Step 11.
  10. Perform the following steps when you want the agent to register with HCL® Quality Server:
    1. Enter the URL of the HCL® Quality Server instance.
    2. Enter the username and password for the HCL® Quality Server server.

      This step is applicable only if you configured HCL® Quality Server for security.

    3. Click Next.

    4. Go to Step 12.
  11. Perform the following steps when you want the agent to register with HCL OneTest™ Server:
    1. Enter the URL of the HCL OneTest™ Server instance.

      The HCL OneTest™ Server option is displayed as selected.

    2. Enter the team space alias or id in the Team Space field.
    3. Enter the Offline user token that you generated on HCL OneTest™ Server in the Security Token field.
    4. Click Next.
    5. Go to Step 12.
  12. Review the server configuration, and then click Next.
  13. Select your action based on the descriptions for the options displayed:
    Option Description
    Run as Local Service Runs HCL OneTest™ API Agent as a service.
    Run as existing user Runs HCL OneTest™ API Agent with a user authenticated with a user name and password.
    Note: You must provide a user name and a password.
  14. Click Next.
  15. Click Install to install the package.

    A progress indicator displays the progress of the installation.

  16. Select your action from the following options:
    • Retain the Library Manager (Agent) option, and then click Finish to open the Library Manager.
    • Click the None option, and then click Finish to close the installation window.

Results

You have installed HCL OneTest™ API Agent.

What to do next

You can perform the following tasks: