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.
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.

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.

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.

Before you begin

Important: Ensure that you back up the <Link installation folder>/restapi/ folder.

About this task

To manually update Apache Tomcat 9 for Link application on windows platform, complete the following steps:

Procedure

Download the latest 64-bit Windows binaries of Apache Tomcat 9 in ZIP format from the official Apache Tomcat website.
Copy the downloaded ZIP archive into the <Link installation folder>/restapi/tomcat folder.
Complete the following steps:
1. Type WINDOWS+R.
2. Right-click the Command Prompt window and select Run as Administrator.
3. In the Command Prompt window, change the current directory to <Link installation folder>\DesignServer.
Run the following command to clean any existing Apache Tomcat installation:
```
clean.bat
```
Use a Text Editor to modify the dtxtomcat.ini configuration file located at the <Link installation folder>\restapi\tomcat\ location. Update the string TomcatVersion=9.0.XX to match the version of the downloaded Apache Tomcat 9 from Step 1. Save the changes.
From the same command prompt window folder, as mentioned in Step 3, run the following command to install Apache Tomcat:
```
install.bat
```