Home
Installation
Everything you need to know to install HCL Link.
Windows installer
This documentation describes how to install the HCL Link using the Windows Installer.
Installation procedures
Modify an existing installation
If you do not select Link Server and Runtime on Link InstallShield Installation time, you can still install it later.

Installation
Everything you need to know to install HCL Link.
- Windows installer
  This documentation describes how to install the HCL Link using the Windows Installer.
  - Link Server Components
    The Link windows installation has the following components:
  - Installation prerequisites
    If you have a previous version of Link installed, you must uninstall it completely. Link windows installation does not support multiple Link installations on a single computer.
  - Installation procedures
    - Installing Link Server with Install Shield
      To install Link, complete the following steps:
    - Manually Installing Link Server and Runtime
      The Link Install Shield typically installs all the features. If you do not select Link Server and Runtime at Link Install Shield Installation time, you can install them later.
    - Post installation action
      It is optional to change Link service accounts.
    - Modify an existing installation
      If you do not select Link Server and Runtime on Link InstallShield Installation time, you can still install it later.
  - Starting and Stopping Link
    After Installing, to start and stop Link , follow the steps:
  - Accessing Link
    Instructions for accessing Link.
  - Customizing the installation
    HCL Link customization instructions.
  - Customizing the Redis and Link Databases
    HCL Link installation includes Redis server. If you want to use a preinstalled Redis server you must customize your Link installation.
  - Customizing Link URL and Selecting HTTPS protocol
  - Uninstalling Link
    Instructions for uninstalling Link.
  - Troubleshooting the installation
    In the case of Link Install/Start/Stop errors, review the log files from this folder:
  - Troubleshooting Link installation process
    If Link installation fails, verify that ports listed in a table are available on your machine.
- Linux installation
  You have the choice of two installation types: Native and Docker.
- Using the OneDB wire listener as a MongoDB server
  The OneDB wire listener may be used in place of a MongoDB server when it is suitably configured.
- HCL Link design data
  The documentation provided here describes data backup, data restoration, and data migration of HCL Link design data.

Modify an existing installation

If you do not select Link Server and Runtime on Link InstallShield Installation time, you can still install it later.

If you change Link configuration, you must reinstall both Link Server runtime and Design time.

If you modify any of the ports or variables in the hip-server-env.bat or dtxtomcat.ini files, follow these steps:

Open a Windows terminal window and select Run as administrator.
Run the command: <install_dir>\clean.bat
Run the command: <install_dir>\install.bat

In addition, if you change any variable in the tx-rest.properties file, you must restart the Link Apache service from the Windows services console.