Welcome
Projects
A project is a container for HCL Link artifacts.
Flows
This documentation describes how Flows can be run from REST API, listeners, or they can be scheduled.
Nodes
JSON Transform Node
The JSON Transform node is used to transform JSON documents from one form to another.
JSON Template Property
The JSON template property must be a valid JSON. It can be either a JSON object or a JSON array.
Path to a Primitive
To fetch a field that is a primitive (string, number, boolean) specify the JSON path as a string primitive:

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.
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.
- Flows
  This documentation describes how Flows can be run from REST API, listeners, or they can be scheduled.
  - Nodes
    - Map Node
      A Map Node invokes an HCL Link map within a flow.
    - Flow Node
      A Flow node invokes a sub-flow within a flow.
    - Source and Target Nodes
      Source and Target Nodes provide HCL Link with an outside-in approach to developing integrations.
    - Request Node
      The Request Node has a single input request terminal and a single output response terminal.
    - Cache Read and Write Nodes
      Cache Read and Cache Write node functionality is described in this section.
    - Clone Node
      The Clone Node has one input and two output terminals.
    - Decision Node
      The Decision Node routes input data to the true, or false terminals depending upon the condition.
    - Encoding Converter Node
    - Fail Node
      The Fail Node causes the flow execution to fail.
    - Format Converter Node
      The Format Converter Node can be used to quickly convert data from one format to another.
    - JSON Read Node
      This documentation describes the function and use of the JSON Read Node.
    - JSON Transform Node
      The JSON Transform node is used to transform JSON documents from one form to another.
      - Examples
        These examples show the functionality of JSON Transform Node.
      - JSON Template Property
        The JSON template property must be a valid JSON. It can be either a JSON object or a JSON array.
        Path to a Primitive
        To fetch a field that is a primitive (string, number, boolean) specify the JSON path as a string primitive:
        Path to an Object
        There are two ways to specify an object in the template.
        Path to an Array
        If the path is specified as a string member of an array, then the path will return an array.
    - Java Node
      The Java Node invokes a Java class, thus performing user defined functionality based on the properties specified for the Java class to act on the input.
    - Join Node
      The Join Node gathers the individual results and appends to a single output file or terminal.
    - Log Node
      The Log Node logs the raw data from the node input into the file and propagates the data from the input to the output terminal.
    - Lock and Unlock Nodes
      Lock and Unlock nodes are used to manage resource locking within flow executions. The Lock node controls access to resources and restricts the execution of the current branch in the flow execution. The Unlock node releases the lock previously acquired within the current branch.
    - Map Rule Node
    - Passthrough Node
      The Passthrough Node propagates data from the input to the output terminal.
    - REST Client Node
      The REST Client Node provides a simple and powerful way to access REST services.
    - Route Node
      The Route Node provides a way to route data conditionally to one or more outputs of the node. The node bases decisions by evaluating a condition for a flow variable and determining whether to send the data to output 1 or 2 or both, based on the result of the condition.
    - Sleep Node
      The Sleep Node suspends the execution of the flow for the specified number of milliseconds
    - SOAP Client Node
      The SOAP Client Node provides a simple and powerful way to access SOAP services.
    - Split Node
      A Split Node should be used when there is a need to split CSV or JSON data processing or when a map can run in a burst mode to process data in batches. This might occur when data processing becomes excessively time consuming.
    - Distributor Node
      The Distributor Node is used to horizontally scale single, large transactions. It splits data records into batches, which are then processed in parallel by downstream nodes. This workload is distributed across multiple machines or pods, data for each output flow terminal is aggregated in distribution-order by the distributor node. The adapter for the output flow terminal acts on the aggregated data.
    - Status Node
      A Status Node can only be used as the first node in a ‘’status flow”, as that what makes a flow a status flow. Similar to an initialization flow, a status flow may be referenced from any other main flow. A status flow has a Status node as its first node which has Success, Error and Always output terminals that provide the flow status JSON to a downstream node.
  - Terminals
  - Flow terminals
    Flow terminals represent the inputs and outputs to a flow. Every node has input and/or ouptut terminals.
  - Scheduled flows
    This documentation describes the options for defining the flow schedule.
  - Listener
    A Flow that has a Map node as its first node, and uses a File adapter for an input, can enable that node's input to be a Watch.
  - Flow audits
    Flow audits are a way to retrieve more verbose information about a flow instance.
  - Flow and Node Timing
    The flow audit provides information about the execution time of a flow and its individual nodes.
  - Flow Load Balancing
  - Flow variables
    Flow Variables are process data variables that go along with the flow execution, accessible to all nodes in the flow while it is being executed under flow executor/engine context.
  - Create a flow
    Steps required to create a flow.
  - Running flows in the Designer
    When you develop a flow in the Flow Designer you can run the flow directly from the Designer either in Link, or on a different runtime environment.
- Maps
  Maps define input and output specifications and mapping rules for data transformation.
- Schemas
  Use the schema designer to define, modify, and view schemas. A schema describes the syntax, structure, and semantics of your data.
- Connections and Actions
  This documentation describes connections and actions.
- Files
  Files are used in various places within HCL Link. HCL Link allows files to be uploaded to the HCL Linkserver.
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

Path to a Primitive

To fetch a field that is a primitive (string, number, boolean) specify the JSON path as a string primitive:

"field": "@@$.id",

The value of field will be set to whatever is returned from the specified path.