Home
Installation
Everything you need to know to install HCL Link.
HCL Link design data
The documentation provided here describes data backup, data restoration, and data migration of HCL Link design data.
Design data backup and migration
Overview of backing up and restoring, or migrating data used by Link for design activities.
Filesystem data backup and restore

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.
- 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.
- HCL Link design data
  The documentation provided here describes data backup, data restoration, and data migration of HCL Link design data.
  - Design data storage
    This documentation describes data stores used by Link for design activities, and data storage configuration.
  - Design data backup and migration
    Overview of backing up and restoring, or migrating data used by Link for design activities.
    - MongoDB database operations
    - Filesystem data backup and restore
      - Filesystem data migration example
- Configuring SSL certificates for Link
  After installing Link, setup the custom SSL certificates for the Link web UI and the Link runtime application server.

Filesystem data backup and restore

Link uses several file system directories to store design data. They are shown below using JSON Pointer strings to refer to a mapping value in the Link config.yaml file:

server.persistence.files
server.persistence.modules
server.persistence.libs
rest.persistence.files

Backing up filesystem design data consists of creating a backup of these directories. The backup process varies depending upon the configuration of the filesystems used to store these directories and their contents.

Restoring filesystem design data consists of populating these directories with their backed-up contents. A change in the location of one or more of these directories during a restore operation might be desired. As for a change in the Link configuration for accessing a MongoDB server instance, such a change in location is allowed, and is handled by the general Link installation configuration update operation.