Installing HCL OneTest™ API Agent in the GUI mode on Windows

You can find information about installing HCL OneTest™ API Agent in the GUI mode on Windows by using the stand-alone installer.

Before you begin

You must have completed the following tasks:

  • Read and ascertained that your computer meets the requirements specified in System Requirements.

  • Uninstalled any previous version of this product. See Uninstalling the product software on Windows.

  • Downloaded the product software package that is dependent on the stand-alone installer for the supported operating system on your computer from the HCL® License & Delivery portal.

Procedure

  1. Extract the compressed package file to a folder.

    For example, the name of the software package for HCL OneTest™ API Agent is HCL_OT_APIA_102_Install_IA_WIN.zip.

  2. Perform the following steps:
    1. Open the folder where you extracted the package.

      For example, the folder where you extracted the package can be as c:\Downloads\HCL_OT_APIA_102_Install_IA_WIN

    2. Select the file in the folder, right-click, and then select the Run as Administrator option.

      For example, the file in the folder for HCL OneTest™ API can be HCL-OneTest-API-Agent-Win-x64-v10.2.0.0.exe.

      The Introduction window of the stand-alone installer is displayed.

  3. Read through the details, and then click Next.

    The License Agreement window is displayed.

  4. Read the license agreement carefully, select the I accept checkbox, and then click Next.

    The Select Install Folder window is displayed.

  5. Select the location to install by performing any of the following actions:
    • Select the default location that is displayed.

      The default location is C:\Program Files\HCL\OneTest-API-Agent.

    • Click Choose, browse for a location on your computer, and then click OK to select the location.
      Note: You must select an existing folder or create a folder in any of the root directories on your computer.
  6. Click Next.
    The Install Service window is displayed.
    Note: The Install Service checkbox and Start On Boot checkbox are selected as the default options.
    The following actions are possible:
    • If the selections are retained, HCL OneTest™ API Agent is installed as a service and it is started whenever the computer is started.
    • If the selections are cleared, HCL OneTest™ API Agent is not installed as a service and you must manually start the agent.
  7. Retain or clear the selections, and then click Next.

    The Configuration window is displayed.

  8. 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.
  9. Click Next.
  10. Enter the URL of HCL Quality Server instance on which HCL OneTest™ API Agent must be registered.
  11. Click Next.

    The Pre-Installation Summary window is displayed.

  12. Read through the details, and then click Install.
    The Install Complete window is displayed after the installation of HCL OneTest™ API Agent is completed.
    Note: The Start Library Manager (Agent) checkbox is selected as the default option. The Library Manager for the agent is displayed when you click Done. If the Launch Library Manager checkbox is cleared, the stand-alone installer window is closed without opening Library Manager.
  13. Retain or clear the Launch Library Manager checkbox, and then click Done to close the stand-alone installer.

Results

You have installed the product on your computer.

What to do next

You can check the installation log to verify the installation. You can find the logs in the <Installation_folder>/logs folder.

You must set up the license before you can use the product. See License management.