Installing HCL Quality Server

Install HCL Quality Server by using IBM® Installation Manager.

Before you begin

Review the Installation considerations for HCL Quality Server and the Before you begin section of Installing HCL OneTest API.

About this task

To install HCL Quality Server in silent mode, see Installing the software silently. To install HCL Quality Server by using the launchpad, read the instructions below.

No direct upgrade paths to the latest version are supported. To upgrade one or more packages to the latest version, uninstall any previously installed version and install the latest version.


  1. Start the installation.
  2. Select HCL Quality Server and any updates to the package to install. Updates that have dependencies are automatically selected and cleared together.

    To view all updates that are found for the available packages, select Show all versions and click Check for Other Versions, Fixes, and Extensions. You require your HCL Software License & Download portal login credentials to view and install any newer packages or updates to the selected version of the software.

    Click Next.

  3. On the Licenses page, read the license agreement for HCL Quality Server.

    If you agree to the terms of all of the license agreements, click I accept the terms in the license agreement. Click Next.

  4. On the Location page, the location of the package group into which HCL Quality Server is to be installed is displayed. Optionally, you can enter another location for the package group in the Installation Directory field. Click Next.

    The shared resources directory is the location to which installation artifacts that can be used by one or more package groups are written. To change the shared resources directory, uninstall all the installed packages and then reinstall them in to the new directory location.

  5. Select the translation packages to install, and then click Next.
  6. For Windows. On the Features page, select HCL Quality Server and the HTTP/TCP Proxy features to install. To install HCL Quality Server or HTTP/TCP proxy as a service and start it whenever the computer boots, select the options Install as Service and Start on boot.
    Note: To set up multiple proxies or to install the proxy behind a certain firewall so that the software under test can connect to it, install the HTTP/TCP component on a computer that is different from the location where you install HCL Quality Server. You must also run the installer on that computer and select only the HTTP/TCP proxy component.
  7. If you are installing HCL Quality Server, enter the following information in the HCL Quality Server Configuration Panel and click Next.
    1. In the Standard Configuration page, enter the HCL Quality Server HTTPS Port where HCL Quality Server listens for all communications. The default port is 5443 and is provided for you.
      Note: You can change the port number after installation and also enable plain HTTP. For details, see Configuring the server HTTP Endpoint.
    2. Enter the path to the HCL Quality Server workspace, which is used for storing published stubs, audit and activity logs, and user information.
    3. Enter the name of a default domain. To enable the publishing of stubs, HCL Quality Server requires at least one domain. You can create an initial domain while installing the package. Alternatively, if you have not yet decided the number and the names of the domains that you will need, you can use HCL Quality Server (after it is installed) or HCL OneTest API (if it is installed) to add one or more domains.
    4. In the Server Details section, enter the hostname where you are installing HCL Quality Server. This information is used to create a connection URL for other products to connect to HCL Quality Server. The default values are provided for you.
      Note: Specify a fully-qualified host name, for example,
    5. In the Networking section, specify either the Internet Protocol version 4 or 6 (IPv4 or IPv6) as the networking environment preference for HCL Quality Server. HCL Quality Server uses this preference when it installs the HTTP proxy.
      For more information, see Installation considerations for HCL Quality Server.

      Click Next.

    6. In the Advanced Configuration page, enter the port number to use for communications between HCL Quality Server and HCL OneTest API. This port is used for the Topology Discovery feature in HCL OneTest API. The default port is 7883 and is provided for you.
    7. In the HQS Security Configuration page, select an authentication type and enter the security details. To disable security, select None. Click Next.
      Note: You can modify the security settings after the installation. For more information, see Modifying security model settings after installation.
  8. If you are installing only the HTTP/TCP component, the Register with HCL Quality Server page is displayed. To register HCL OneTest API proxy with HCL Quality Server:
    1. Specify the HCL Quality Server URL.
    2. Specify the HCL Quality Server user name and password.
      Note: This step is applicable only when the Domain-level security is enabled. You can enable domain-level security only after starting HCL Quality Server.
    3. Click Next.
  9. On the Summary page, review your choices before you install the product package and click Install.
    A progress indicator shows the percentage of the installation that is completed. When the installation process is complete, a confirmation message is displayed.
  10. Click View log file to open the installation log file for the current session in a new window. You must close the Installation Log window to continue.

    Alternatively, in IBM® Installation Manager, go to File > View Log to verify if the installation was successful.

  11. Click Finish to start HCL Quality Server. The Install Package wizard closes and you are returned to the launchpad program.

What to do next