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
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.
Configuring a Split node
Settings
This section lists the settings available for the Split Node.

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.
    - 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.
      - Configuring a Split node
        Consuming data through an input terminal
        A Split node receives data through an input terminal if it is connected to an upstream node. For example, from the map node, if its input terminal is enabled as a flow terminal.
        Consuming data from a file
        A Split node reads data from the file specified by the File Path setting. This option is supported only if it is not connected to an upstream node, or if its input terminal is not enabled as the flow terminal. If the map is defined as the data source, the map reads the file defined with the specified file.
        Defining number of Split instances
        A Split node splits data into batches and passes each batch to its downstream node.
        Settings
        This section lists the settings available for the Split Node.
      - Split example
        See the Split Node example for a demonstration of how to design, deploy, and run flows that contain the spilt node. The Split node example contains a readme file that contains detailed instructions about how to run the example.
    - 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.

Settings

This section lists the settings available for the Split Node.

Maximum Instances

Specifies the maximum number of parallel instances.

Read From File

Specifies the options to read the input from a file or from the input terminal.

File Path

Specifies the path of input file.

Source

Specifies the data source. Supported options are ‘map’ and ‘data’.

If ‘map’ is a source, the supported settings are:

Map Name: Defines a map that will run inside the split node in the burst mode.
Input Card Name: Defines which input card to use in the selected map to split data. (click on ‘Fetch’ to get the list of input cards). Default is the 1st input card.
Ouput Card Name: Defines which output card in the selected map will produce data for the split node output terminal. (click on ‘Fetch’ to get the list of output cards). Default is the last output card.

If ‘data’ is a source, the supported settings depend on the data format. Supported data formats are delimited (CSV) and JSON.

Batch Size

Specifies the number of records to include in each batch.

If the data format is ‘delimited’ (CSV), the supported settings are:

Record Delimiter

Specifies the character that delimits records. \\r for carriage return, \\n for newline and \\t for tab.

Has Header

Specifies that the header record is available in data.

Include Header

Decides whether the header record should be included in each batch sent to the output.

Output Header Split

Controls the Split node header processing, if the Has Header property is set. If the Output Header Split is enabled, the Split node processes the header in the first batch. It sets Flow Internal variable ~SPLIT~ to value HEADER when processing the header. The Split node waits for the header to process before it executes rows processing in parallel. ~SPLIT~ variable is set to the batch index when rows are processed in parallel.

If the data format is ‘JSON’, the supported settings are:

Array Path: The path of the array in the json document.
Output JSON Object: If this option is turned on, when the batch size is set to 1 output a JSON object, otherwise output an JSON array.
Output Context Before: Controls whether the output data includes the JSON context before the selected array.