Enabling HCL Link runtime licensing

To use Link runtime components, complete the following steps before you install Design Server:

  1. Locate the folder where the Link is installed.
  2. Rename the .passport.oem file to .passport.

Link installation

Before you install Design Server, to install HCL Link, complete the following steps:

  1. Copy the .exe file that you downloaded at time of purchase into a directory called HCL on your computer.
  2. Double click on the .exe file.
  3. Install Shield opens to guide you through the installation process.

Installation steps - LNK REST API is not installed on your computer

Note: Installing the LNK Design Server also installs the LNK REST API at the same time. The Design Server reuses the REST API application server configuration settings defined in the restapi\tomcat\dtxtomcat.ini file. In order for any change to this file to take effect, you must reinstall the Design Server.

After the LNK Runtime server is installed, install the Design Time server by following these steps:

  1. Locate the LNK Runtime Server on your computer: c:\HCL\Link_<version umber>.
  2. Open Windows command window with administrator privileges, change the current folder to c:\HCL\Link_<version number>\DesignServer.
  3. Extract the Design Server installation compressed by executing the script unzipDesignServer.bat.
  4. Type install.bat and then press Enter.
  5. Follow the messages on the screen, that display installation status. In the case of an installation error, look in the install.log file. The log file displays error messages and possible actions that you can perform to correct errors.

Installation steps, LNK REST API is installed on your computer

  1. Locate the HLK Runtime Server on your computer: c:\HCL\Link_<version umber>.
  2. Open Windows command window with administrator privileges, change the current folder to c:\HCL\Link_<version number>\restapi\tomcat.
  3. Uninstall HLK REST API:
    • If you have installed LNK REST API as Windows terminal application, using dtxtomcat.bat script run:
      dtxtomcat.bat uninstall
    • If you have installed LNK REST API as Windows service application, using dtxtomcatservice.bat script run: 
      dtxtomcat.bat uninstall
  4. Follow Installation steps from the previous section.

Starting and Stopping the LNK Design Server

After Installing, to start and stop the Design Server, follow the steps:

  1. In the Command windows change the current folder to c:\HCL\Link_<version umber>\DesignServer.
  2. To start the server run the start.bat command. The server start time might take several minutes depending on the performance of your computer.
  3. To stop the Design Server, run the stop.bat command. The server should stop in several seconds.

Accessing the Link Design Server

After the Link Design Server is installed, users can access the server by pointing the Web browser to the following local URL: https://localhost/login. Use the default user/password credentials to login (admin/admin) - after you login for the first time, change the default password of the admin account for security reasons.

Customizing the installation

Link Design Server customization can be performed by editing settings in the file:

c:\HCL\Link_<version umber>\DesignServer\ hip-server-env.bat

Review the file content for detailed description of all customization options. If you change any of the configuration settings post installation, in order to activate the change, you must reinstall the Design Server by running clean.bat and then install.bat.

Customizing the Redis and Link Design Server Database

The Link Design server installation includes a Redis server. In the case that you want to use a preinstalled Redis server, you must customize your Design Server installation.

Redis customization instructions are written in the batch execution script located in the DesignServer installation folder. Modify REDIS host and port settings to match your environment:

c:\HCL\Link_<version umber>\DesignServer\ hip-server-env.bat

Change REDIS or MONGO settings if you want to customize your Redis or MongoDB database.

Customizing the Design Server URL and selecting HTTPS/HTTPS protocol

The HLI Design Server default URL is the following:

https://localhost/login

This URL uses HTTPS protocol on port 443. If you want to use a non-default port, and HTTP protocol, you must update the HIP_HTTP, HIP_HTTPS_PORT and HIP_HTTP_PORT settings.

For detailed instructions review the hip-server-env.bat file.

Uninstalling the Design server

To uninstall the Design Server, complete the following steps:

  1. In the Command windows change the current folder to: c:\HCL\Link_<version umber>\DesignServer.
  2. Run the clean.bat command, to stop and uninstall the DesignServer.
  3. Manually delete the c:\HCL\Link_<version umber>\DesignServer folder.