Skip to content

Flow Services

A Flow Service is the primary unit of logic in Joynare Nexus. It represents a sequence of processing steps defined in a YAML file.

Structure

Every Flow Service lives in a directory named after itself, containing a flow.yaml file.

text
flows/
  namespace/
    MyService/
      flow.yaml

The YAML Definition

A typical flow.yaml includes:

  • name: The service name.
  • namespace: The logical grouping.
  • pipeline: Metadata defining inputs and outputs.
  • steps: An ordered array of processing steps.

Step Types

Joynare Nexus supports several step types to build complex logic:

TypePurpose
invokeCalls another service (Built-in, Flow, or Adapter).
mapDirectly manipulates pipeline variables (Set, Copy, Drop).
branchConditional logic (Switch or Expression modes).
sequenceGroups steps with error handling strategies (Try/Catch).
loopIterates over an array in the pipeline.
repeatRe-executes steps based on count or success/failure.
exitTerminates a flow, loop, or sequence early.

Example

yaml
name: "ProcessOrder"
namespace: "orders"
pipeline:
  input:
    orderId: "string"
steps:
  - name: "FetchData"
    type: "invoke"
    service: "orders:GetOrderById"
    input:
      id: "${orderId}"

---

## See Also
- [The Pipeline Concept](./pipeline)
- [Step Types Overview](./control-flow)
- [How to run Flows](../showcase/index)

Released under the ISC License.