Home
Design Server
The documentation provided here describes how to use the Design Server.
Flows
This documentation describes how Flows can be run from REST API, listeners, or they can be scheduled.
Nodes
REST Client
The REST Client flow node provides a simple and powerful way to access REST services. It can be used to directly invoke REST APIs or can use prebuilt configurations that define the APIs of the service. The node supports:

Design Server
The documentation provided here describes how to use the Design Server.
- Projects
  This documentation describes Design Server projects.
- Schemas
- Maps
- Flows
  A flow node invokes a sub flow within a flow. Sub-flows need not be wired to other nodes; it is valid to have a flow that is comprised of multiple sub-flows that each have listeners.
- Using Design Server
  How to use the HCL Link Design Server.
- Flows
  This documentation describes how Flows can be run from REST API, listeners, or they can be scheduled.
  - Nodes
    - Maps
      A map node invokes a LNK map within a flow.
    - Flow
      A flow node invokes a sub flow within a flow. Sub-flows need not be wired to other nodes; it is valid to have a flow that is comprised of multiple sub-flows that each have listeners.
    - Source and Target
      Source and Target nodes provide Link with an outside-in approach to developing integrations. The inside-out approach means that you begin with a map, add inputs and outputs, and then configure these to access resources. Connections might be created in the process. The outside-in approach implements the integration from the opposite direction. You begin with the outside interfaces, then connects them to provide maps and other artifacts.
    - Cache Read and Write
      This documentation describes the function and use of the Cache Read and Cache Write nodes.
    - Clone
      The Clone node has one input and two output terminals. This node clones, or copies the input data from the single input terminal to both output terminals.
    - Decision
    - Fail
      Fails the flow execution.
    - Format Converter
      The Format Converter Node can be used to quickly convert data from one format to another.
    - JAVA
      Invokes a java class, performing user defined functionality based on the properties specified for the java class to act on the input.
    - Join
      The Join node gathers the individual results and appends to a single output file or terminal.
    - Log
      This node logs the raw data from the node input into the file and propagates the data from the input to the output terminal.
    - REST Client
      The REST Client flow node provides a simple and powerful way to access REST services. It can be used to directly invoke REST APIs or can use prebuilt configurations that define the APIs of the service. The node supports:
      - Functionality
        The REST Client node operates in 3 modes:
      - Terminals
        The REST Client node supports the terminals as given in below table.
      - Settings
        This section lists the settings available for the REST Client node.
      - Authentication
        Provides the options to authenticate the connection. This is an optional property.
      - Input Data Request Mode
        Input Data Request Mode is available, when you set Configuration Mode to Configuration Packages.
      - Request Assignments
        Provides a quick and easy way to build request data, when the request data is not provided to the node's input terminal.
      - Response Assignments
        Response Assignments are used to set flow variables based on values of elements of the response. This provides a simple way to parse responses to extract elements from the responses.
      - Logging
        Specifies the level of logging to use for the log (trace) file produced by the node.
    - Route
      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
      This node suspends the execution of the flow for the specified number of milliseconds
    - Split
      A Split node should be used when there is a need to split csv data processing. This might occur when csv data processing becomes excessively time consuming. Such time-consuming behavior might occur when you send big csv data to the flow input terminal or it might become memory intense when complex data validation is being performed. The Split node can be used with these, and with other data processing tasks that can be done in parallel.
  - Terminals
  - Flow terminals
  - Scheduled flows
  - 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.
- Schema designer
  Use the schema designer to define, modify, and view schemas. A schema describes the syntax, structure, and semantics of your data.

REST Client

The REST Client flow node provides a simple and powerful way to access REST services. It can be used to directly invoke REST APIs or can use prebuilt configurations that define the APIs of the service. The node supports:

Passing in request data on the input terminal or building the request directly in the node.
Returning success and error messages to the different output terminals.
The ability to loop through an array of requests to invoke an API repeatedly.

The node is an extension of the REST adapter. In many cases, it is much simpler to configure and use the node in a flow. Especially in cases, where an API call requires to send a request and handle the responses.