HCL® Quality Server upgrade information and requirements

Before you upgrade HCL® Quality Server, learn about the general and release-specific considerations and instructions for the upgrade.

No direct upgrade paths to the latest version are supported. To upgrade HCL OneTest™ API, HCL® Quality Server or HCL OneTest™ API Agent packages to the latest version, uninstall any previously installed version and install the latest version. For install instructions, see Installation of HCL OneTest API.

Note: When you upgrade, or uninstall an older version to move to a newer version (when the upgrade is not applicable), the customized trust stores that are located at HCL® Quality Server installation location\usr\servers\defaultServer\resources\security, if any, are removed. Hence, before uninstalling or upgrading a version, create a backup copy of the trust stores.

Enabling HTTPS and changing the ports

If you upgrade from 9.1.0 or later, all communications with HCL® Quality Server by default use HTTP on port 7819. To use HTTPS by default during the upgrade of the HCL® Quality Server software, you must use the Install option in Installation Manager and click Check for Other Versions, Fixes, and Extensions in the Install Packages dialog; otherwise, you continue to use HTTP on port 7819.

You can change the port number and enable HTTPS even after the installation. For details, see Configuring the server HTTP Endpoint.

Reusing the workspace

To determine the workspace location, open the container.server.properties file that is available in HCL® Quality Server installation directory\usr\servers\defaultServer\apps\RTCP.war\WEB-INF\classes directory. Look for the line that contains the workingDirectory key. For example:
  • On Windows, workingDirectory=C:\HCL\HQS-Workspace
  • Non-Windows, workingDirectory=/var/hqs
Note: If you delete the workspace during the uninstallation of HCL® Quality Server (by selecting the Delete Workspace option) in the Installation Manager, all the published test reports are deleted as well.
Before you upgrade or uninstall an older version to move to a newer version (when the upgrade is not applicable), perform the following tasks:
When you want to upgrade to HCL® Quality Server 10.2.3 or later from 10.2.2 or an earlier version, or install HCL® Quality Server 10.2.3 or later, and your existing workspace contains data about the configured stubs, scheduled tasks, or metrics databases, consider the following actions:
  • If you want to retain or reuse the existing HCL® Quality Server workspace, you are indicated by the installer that the data will be migrated. The time to install or upgrade depends on the amount of data that exists.
  • If you do not want to use the existing workspace that contains data and select a different location to install the workspace, the following are the results:
    • An empty workspace is created.
    • Data in the existing workspace is not migrated.
    • Data in the existing workspace cannot be used with HCL® Quality Server 10.2.3 or later versions.
To preserve the workspace (published stubs, user configuration, domains, and environments) of HCL® Quality Server 10.2.2 or an earlier version, when you uninstall the previous version, ensure that you do not select the option to remove the workspace. When you install the later version up to 10.2.2, ensure that the workspace directory is set to the same location as your existing workspace.
Note: Starting from 9.2.1 onwards, the HCL® Quality Server Environments page and the Agents page were replaced by dashboards. Those dashboards model stubs and scenarios differently and use new REST APIs, so existing test automation scripts that use the REST APIs before 9.2.1 operate differently.

After the upgrade or uninstallation, the contents of the workspace directory might change to work with the newer version of HCL® Quality Server.