Welcome
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.
MongoDB migration for Design Server
About the migration script
Migration script command syntax and options

Introduction
Congratulations on your selection of HCL Link as your data integration solution!
What's new
Learn about the new and changed functions and features in HCL Link version 1.3.2.0.
Release notes
Read the latest release specific information for HCL Link version 1.3.2.0.
System requirements
A complete desciption of the hardware and software requirements for both Windows and Linux systems.
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 three installation types: Native, Docker, and Podman.
- 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.
  - 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
    - MongoDB migration for Design Server
      - Supported migration scenarios
      - About the migration script
        Migration script command syntax and options
      - Migration procedure
        The following two scenarios are supported by this migration process:
    - Filesystem data backup and restore
- Configuring SSL certificates for Link
  After installing Link, setup the custom SSL certificates for the Link web UI and the Link runtime application server.
Administration
Here you will find the tasks that are required for administration of your HCL Link product.
Projects
A project is a container for HCL Link artifacts.
Services
Service definitions define REST services and the endpoints of a service. This guide provides step-by-step instructions for creating, importing, and managing services using the system interface, following Microsoft standards.
Connectors
This documentation describes the connectors and how they are used.
Packages
Servers
This documentation contains a description of the server groups and servers.
Variables
The variables described here include Configuration variables, flow variables, and cache variables.
Dashboards
A description of HCL Link dashboards, including the Server dashboard and the Kibana dashboard.
Runtimes
Descriptions of Link runtime services.
Resource Adapters
About the HCL Link Resource Adapters, and how to use them.
Cloud Native Link
Cloud Native Link refers to the HCL Link product installation on a Kubernetes cluster.
Reference
This documentation provides HCL Link reference information.
Notices

Migration script command syntax and options

Use the following syntax to run the migration script:

./upgrade_mongo.sh [OPTIONS]

You can customize the migration process by specifying the following options:

--target-version=VERSION: Specifies the target MongoDB version you are upgrading to. The default value is 8.2.3.
--old-version=VERSION: Specifies your current MongoDB version. The default value is 4.0.5.
--data-dir=PATH: Specifies the path to your MongoDB data directory. The default value is /opt/data.
--keep-container=true|false: Specifies whether to keep the MongoDB container after the upgrade is complete. The default value is false.
--help: Displays the help message and available command options

Note:

If you execute ./upgrade_mongo.sh without any arguments, the script will prompt you to confirm the use of default settings.
When providing partial arguments, the script identifies any missing parameters, displays their default values, and requests verification before continuing.