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.
Accessing Link
Instructions for accessing the Link.

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
  - Starting and Stopping Link application
    After Installing, to start and stop Link , follow the steps:
  - Accessing Link
    Instructions for accessing the 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 the table are available on your machine.
  - Manually updating Apache Tomcat 9 for the Link application
    This procedure defines the steps to manually update the installed Apache Tomcat 9 software for the Link application. If the currently installed version of Apache Tomcat 9 has a security issue that is resolved in a later version, you can follow these steps to update it.
- Linux installation
  You have the choice of two installation types: Native and Docker.
- The Link configuration file config.yaml
- 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.
- Link Cosmos DB Integration
- Customizing the Trace
- HCL Link design data
  The documentation provided here describes data backup, data restoration, and data migration of HCL Link design data.
- Configuring SSL certificates for Link
  After installing Link, setup the custom SSL certificates for the Link web UI and the Link runtime application server.

Accessing Link

Instructions for accessing the Link.

You can access the Link web UI by opening the web browser and navigating to the local URL: https://<Hostname/IP>:<Link UI Port>/login. For the initial login, use username “admin” and the default administrator password, which is stored in the file path c:\HCL\hipfiles\adminpassword.txt on Windows and /opt/hipfiles/adminpassword.txt on Linux. However, you should refer to the property files in config.yaml for the exact file path.

After logging in, change the administrator account's initial password. The password file can be deleted after changing the administrator account password.

Note: If you upgrade the Link using the same MongoDB database, the initial administrator password file (adminpassword.txt) will not be created because the user already exists in the MongoDB database. In this case, use the previous login details.