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.
Terminals
Error and Success terminals
An error terminal is used on a node for cases where the error can be caught with another node, preventing the flow from failing. An error terminal will only run a node if the node that has the error terminal is the initial cause of the error.

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
  - Terminals
    - Error and Success terminals
      An error terminal is used on a node for cases where the error can be caught with another node, preventing the flow from failing. An error terminal will only run a node if the node that has the error terminal is the initial cause of the error.
      - Error and Success terminals example
        The Error and Success terminals example demonstrates usage of Error and Success terminal used in a flow.
    - Log terminals
      Log terminals report the node log in json format. Information about node terminals and the data size is provided for all nodes.
  - 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.

Error and Success terminals

An error terminal is used on a node for cases where the error can be caught with another node, preventing the flow from failing. An error terminal will only run a node if the node that has the error terminal is the initial cause of the error.

A success terminal will run a node if the terminal that has the success terminal is successful. Multiple success terminals in a flow will run multiple nodes as long as each node is successful.

A node is not considered successful until all nodes that are linked to it return to that node successfully.

A node is considered successful if a linked node fails, but that linked node has an error terminal linked to catch the error.

See the Error and Success Terminals example for a demonstration of how to use Error and Success terminals in a flow. The Error and Success example contains a readme file that contains detailed instructions about how to run the example.