Creating a Version Path document to upload a new HCAA install file to AUT servers

To prepare to deploy a new version of HCL Client Application Access (HCAA) on AUT servers, create a Version Path document to define and upload the install executable file for the new version into the AUT Catalog. You also define in the document which version or versions of HCAA can be upgraded to the new version.

Before you begin

  • Download the web kit that contains the install file executable for the new version from the HCL download site and save it to a local file location.
  • Have handy the AUT install manifest .xml, updaterepository_hcaa.xml, for:
    • The version that you are upgrading to.
    • The version that you are upgrading from.
    The install updaterepository_hcaa.xml files are are available for download in the following article in the HCL Support site: article KB0074862. Note that the HCAA internal version numbers correspond to Notes version numbers.

About this task

  • Standalone HCAA 3.0.1 or later clients on Windows can be upgraded. Note that AUT cannot be used to upgrade from HCAA 2.0.x or HCAA 3.0.0. Also, upgrades from a dual client scenario (where HCAA and Notes are both installed) is not supported.
  • AUT servers must run at least Domino® 11.0.1.
  • AUT servers require a Domino® 11.0.1 or later version of the Domino® directory template (pubnames.ntf) and the Aut Catalog template (autcat.ntf).


  1. Open the AUT Catalog on any AUT server.
  2. Select Version Paths.
  3. Click Import Manifest and select the install manifest file for the HCAA version you are upgrading to.
  4. Complete the following fields in the Version Path document:
    Note: The values of fields marked with an asterisk (*) in the following table are filled in for you from the information in the install manifest file of the versin you are upgrading to. If for some reason you didn't import the install manifest, you complete these yourself.
    Product* HCL Client Application Access
    Platform* HCAA-Win32
    Language* Language version.
    Upgrade from version
    Specify the version string of the HCAA version or versions to allow upgrades from. Enter this information manually.
    • To determine the version number of a release that you want to allow upgrades from, refer to the updaterepository_hcaa.xml file for that release.

    • The minimum version you can upgrade from using AUT is version HCAA 3.0.1. This version is referred to in updaterepository_hcaa.xml as a Notes 11.0.1 version.
    • Use a comma to separate version strings.
    To version* The new version of HCAA. The version number is a Notes version number.
    Note A description of the package to help you identify it.
    Display name This name is created when you save the document. It is derived by concatenating the values of the previous fields.
    Upload Use to select the install executable file for the new version that you saved previously to a local location.
    Actions Commands that are run on the HCAA client to install the new version. Default commands are derived from the install executable file and are filled in for you.
    Comments Additional comments to note.
  5. Click Save & Close.
  6. To deploy the new install executable to the AUT servers, select Deploy Files from the action bar in either the Version Paths or Files view. All pending additions and updates to the currently deployed files are applied.


  1. The install executable is uploaded as an attachment to the Version Path document. In the Files view, the Uploaded column shows the date and time the upload occurred.
  2. The AUT Catalog change replicates to any other AUT servers.
  3. The install executable is downloaded from the AUT Catalog to the following location on each AUT server:
  4. In the Files view of the AUT Catalog, the Deployed column shows the date and time when the install executable is deployed on all AUT servers.