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 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
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.
    - Verify that the following ports are available on your machine
      Required ports and related Link configuration properties:
    - Data folders used by Link Application
      Required data folders and related Link configuration properties:
  - Installation procedures
  - 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.

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.

Before you install Link design time on a Windows computer, verify that MongoDB Server is available on the network (Instead of MongoDB, OneDB with MongoDB json listener can be used to store the Link database). The Link windows Installer will present you the MongoDB connection configuration dialog, and test the MongoDB connection with the specified parameters, the installation will not continue if MongoDB connection test fails.

Note: Refer to the Recommendations for configuring the OneDB wire listener documentation, if a OneDB wire listener will be used instead of a MongoDB server.