Skip to main content
Version: ACE 5

What are flows?

What is a flow?​

A flow is a set of steps that are applied to an input document. The result is a modified document.

Flows are used to provide the functional implementation of API endpoints and scheduled jobs as well as custom steps.

What is a step?​

Steps are the basic building blocks of flows. They contain re-usable logic. Similar to flows, steps receive an input document and modify it. It is also possible to define custom steps known as virtual steps.

Some of the available steps and their use:

  • JSONATA Map - Transforms the document based on a JSONATA query
  • SOAP HTTP - Sends a SOAP HTTP request and places the response into the document
  • Logger - Produces a log entry
  • ...

What is a document​

The working data of flows and steps in JSON format.

Sample document
{
  "doc": {
    "myQueryParameter": "text", // Flow called by an API contains request data
    "myPathParameter": "text",
    "anotherNode": "some mapping" // Steps can also modify document nodes
  },
  "errors": [] // Errors that occurred in any of the steps
}