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.
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.
Including Maps and Files that are Dependencies of a Flow

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
  - 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.
    - Preparing to run a flow from the Designer
      Make these preparations in order to run your flow from the Designer.
    - Running the flow
      After you specify the server, variables and input data, using the Run properties dialog, you can run the flow.
    - Viewing logs
      The log for an individual node can be viewed by right-clicking on the node in the canvas and selecting View Log from the menu.
    - Viewing flow terminal data
      The input and output data of the flow can be viewed by clicking on the node containing the flow terminal and then clicking on the input or output terminal icon in the structure.
    - Displaying link data
      The data that was sent down a link in the flow can be viewed using either of these methods:
    - Including Maps and Files that are Dependencies of a Flow
- 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.

Including Maps and Files that are Dependencies of a Flow

When executing a flow from the design server, it is possible that the flow relies on internal dependencies. These dependencies need to be explicitly defined through specially formatted statements within the flow description.

In cases where a map node executes a map using the RUN function to call other maps, you must reference these additional maps in the flow description using the following format:

@packagemap=[map folder]/mapname

Furthermore, if a map node uses a map or run map that necessitates a specific file on its input card, you can incorporate the required file into the deployment process using the following notation:

@packagefile=<file path>

Both files and maps can be grouped into a package, and then you can reference this package using:

@package=<package name>

Note: It is important to observe that all "@package*=" statements, when added to the flow description, must each be on a new line. These measures ensure that all essential dependencies are correctly included and referenced when executing the flow from the design server.