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.
Flow audits
Flow audits are a way to retrieve more verbose information about a flow instance.

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
  - 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.

Flow audits

Flow audits are a way to retrieve more verbose information about a flow instance.

There are two ways to retrieve an audit:

From install_dir/logs
As a response from the REST API

Method 1 – Enable the audit setting from the flow settings dialog (from an open flow, click the gear icon in the upper right). If On Error is also enabled, the audit will only be produced if an error occurs while running the flow. A log file is created in the directory with the naming convention: flow name + instance uuid.

Example: flow_e9bea8c6-2f8b-4c47-b776-dcd4f571190e.log

Using this method sets the default audit behavior for whenever the flow is run.

Method 2 – From the Swagger UI, specify "log" near the bottom (look for Add Item). This will again generate the file as above, but it will also return the audit in the response unless the flow is run asynchronously.

Using this method overrides the audit settings specified when designing the flow (method 1 above).