Home
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
Cache Read and Write Nodes
Cache Read and Cache Write node functionality is described in this section.
Cache Write Node
The Cache Write Node writes key/value pairs to the global cache, or to the flow variables based on the scope property
Settings
This documentation describes the settings that are available in the Cache Write node.
Data Format
The format for the incoming and output data. Supported data formats are JSON and Delimited.

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.
      - Configuring Cache Read and Cache Write nodes
        Detailed description of how to configure the Cache Read Node and the Cache Write Node.
      - Cache Read
        The Cache Read node reads key/value pairs from the global cache, or from the flow variables. Optionally, it can delete keys and read from the cache.
      - Cache Write Node
        The Cache Write Node writes key/value pairs to the global cache, or to the flow variables based on the scope property
        Settings
        This documentation describes the settings that are available in the Cache Write node.
        Cache Scope
        Cache scope determines wither to write values to flow variables or to the cache.
        Data Format
        The format for the incoming and output data. Supported data formats are JSON and Delimited.
        Key Delimiter
        The Key Delimiter is enabled when the Data Format is Delimited.
        Record Delimiter
        The Record Delimiter is the delimiter for the end of each record. The value is read from the Key Delimiter to the Record Delimiter.
        Key Prefix
        Prefix the key values with this value. The property can include flow variables.
        Node Logging
        When executed, the node reports the keys that are set in the cache.
    - 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.
    - 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.
    - 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.
    - 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.
    - 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 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.

Data Format

The format for the incoming and output data. Supported data formats are JSON and Delimited.

If the Data Format is delimited, and the delimeters are set to defaults, the example data format is the following:

Key1,Value1\n
Key2,Value2

The record delimiter is an option on the last record.

If the Data Format is a JSON array, for example the following:

[
  {
    "key": "Key1",
    "value": "Value1"
  },
  {
    "key": "Key2",
    "value": "Value2"
  }
]

Key1 value is set to Value1, Key2 value is set to Value2.

If the Data Format is a JSON object, for example:

{ “Key1”:”Value1”, Key2:123 }

Key1 value is set to string “Value1” and Key2 integer value 123 is set to string “123”.

All cache values are stored as strings, but the value provided could be in any format supported by JSON.