> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/dokumentation/automation/flow-designer.md).

# The flow designer

The flow designer: add and connect components, variables and modifiers, conditions, loops, scheduling, webhooks, testing and error handling.

**Path:** "Automation" → "Workflows" → open a flow or **"Create Flow"**

In the **flow designer** you assemble a flow from components. It opens in full screen; the equipme sidebar collapses. Use the back button in the equipme toolbar to return to the [flow list](https://hub.equipme.io/dokumentation/automation/workflows.md).

## The canvas

| Area        | Content                                                                                                                                                                                                                               |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Left**    | The building blocks, grouped into "Utilities" (general helpers such as filters, timers, HTTP), "Applications" (connectors for systems such as equipme or Microsoft) and possibly "Custom". Use "Filter connectors" to search by name. |
| **Center**  | The canvas with the components and their connections.                                                                                                                                                                                 |
| **Right**   | The **inspector**: the settings of the selected component.                                                                                                                                                                            |
| **Top**     | Flow name, validation status ("All components are valid." or the number of invalid components), "Start flow"/"Stop flow" and the flow menu.                                                                                           |
| **Toolbar** | "Undo", "Redo", "Zoom to fit", "Zoom in", "Zoom out", align diagram, keyboard shortcuts and "Logs".                                                                                                                                   |

Handy while working:

* **Select several components:** hold Shift and click, or drag a selection frame.
* **Copy and paste:** Ctrl/Cmd + C and Ctrl/Cmd + V.
* **Zoom:** Ctrl/Cmd + mouse wheel or the zoom buttons.
* **Align:** arranges all components neatly from left to right; connections and settings stay unchanged.
* **Notes:** text blocks on the canvas explain complex parts. They do not affect execution.

## Adding components

1. **Start with the trigger.** In an empty flow, the designer suggests frequently used triggers: **Timer**, **OnStart**, **Scheduler** and **Webhook**. Alternatively, drag a connector trigger onto the canvas, e.g. "New Employee" from the [equipme connector](https://hub.equipme.io/dokumentation/automation/connectors/equipme.md).
2. **Add actions:** drag a component from the left panel onto the canvas.
3. **Choose the type:** many components bundle several triggers or actions. In the inspector, pick the specific one under **"Action"**.
4. **Connect an account:** if the component needs a connection, select an existing account or create a new one via **"Connect account"** or **"Connect a new account"** (see [Accounts](https://hub.equipme.io/dokumentation/automation/accounts.md)).
5. **Rename:** use **"Rename"** in the inspector to give the component a meaningful name, e.g. "Create account in Entra ID".

You remove a component via its context menu ("Remove").

## Connecting components

Each component has **inputs** (left) and **outputs** (right). Draw a line from the output of one component to the input of the next. The line defines the path the data takes.

* Some components have several outputs, e.g. "true"/"false" for a condition or "item"/"done" for a loop. Connect every output you need.
* One output can lead to several components – the data then continues in parallel.
* Components that are not connected are not executed.

## The inspector

When you select a component, the inspector shows its fields: text fields, drop-down lists, switches, file picker or account selection. Missing required fields are reported at the top as invalid components, e.g. "Should have required property …" or "Not authenticated." (account missing).

## Inputs and variables

With **variables** you take over data from earlier steps, e.g. the first name and email of the new employee from the trigger into a welcome email.

1. Click a field in the inspector.
2. Open the **"Variables"** icon next to the field.
3. Under **"Connectors"** you find the outputs of all components connected **before** this component; under **"General"**, general values.
4. Click a variable to insert it into the field. You can combine text and several variables, e.g. "Welcome, {first name}!".

If variables are missing, check that the components are connected and click **"Refresh variables"**. Some outputs are only known to the designer after the previous step has run once.

## Modifiers: transforming values

Clicking an inserted variable opens **"Modify variable"**. With **"Add modifier"** you transform the value before it is used. Several modifiers can be chained.

| Category | Examples                                                                          |
| -------- | --------------------------------------------------------------------------------- |
| Text     | Upper/lower case, replace, split, truncate, trim spaces                           |
| Number   | Calculate (e.g. divide by 100), round, compare                                    |
| Date     | Format a date, add a time span (e.g. +14 days), compare                           |
| List     | First/last item, count, sum, filter, pick a field from each entry, join into text |
| Object   | Read a single field via a path, convert to JSON text                              |
| Control  | Condition (if … then value A, else value B), equals, not                          |

Use **"Test your modifier"** to try the result with a sample value before the flow runs. Apply the setting with **"Update"**.

## Conditions and filters

* **Filters** only let a message through if a rule is met, e.g. "Contains", "Equal", "NotEqual", "Greater than", "LessThan", "Range" or "IsNotEmpty". Whatever does not meet the rule ends at this point – without an error.
* **Condition** checks one or more expressions (with AND/OR) and branches into "true" or "false".
* **Switch** distributes to several outputs – the first matching case wins, everything else goes to "else".
* **Join** merges several paths into one again.

Example: only orders above €1,000 additionally go to the cost center managers – a "Greater than" filter on the order value.

## Loops over lists

If a step returns a **list** (e.g. all employees), you process the entries one by one with **Each**:

* Each passes every entry on via the **"item"** output and reports **"done"** at the end.
* **Recommended: process one after the other.** Turn on **"Sequential"** in Each and end the loop body with **Continue Each**. An entry is then only processed when the previous one is finished; the order is kept, and "done" delivers the collected results.
* Without "Sequential", all entries start at the same time. This is faster, but the order is not guaranteed, and "done" only means "all sent", not "all finished".
* For systems with request limits, set a **"Delay"** (pause between entries) in Each.

Simple list transformations (sum, count, one field from each entry) often work without a loop using a list modifier. equipme list actions also offer the "Output Type" "One item at a time" (see [equipme connector](https://hub.equipme.io/dokumentation/automation/connectors/equipme.md#list-actions-and-output-type)).

## Scheduling

| Trigger or component | When                                                                                                                       |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| **Scheduler**        | At fixed times, e.g. weekdays at 6 a.m. or on the 1st of every month. Check the **time zone** – it is often preset to GMT. |
| **Timer**            | Every N minutes (at least 5). Also fires right when the flow starts.                                                       |
| **OnStart**          | Once, when you start the flow – useful for one-off tasks and tests.                                                        |
| **Wait**             | Holds a message for a time span or until a date, e.g. "3 days before the start date".                                      |

## Webhook trigger

With the **Webhook** trigger, another system starts the flow via an HTTP call.

1. Drag the Webhook trigger onto the canvas. The inspector shows the **webhook URL**.
2. Enter the URL in the other system and start the flow.
3. If the caller should receive a custom response, turn off **"Immediate response"** and add a **Response** component later in the flow.

{% hint style="warning" %}
Treat the webhook URL like a password: anyone who knows it can trigger the flow.
{% endhint %}

## Testing

Test every flow before you start it permanently:

* **With test data:** e.g. create a test employee or use your own mailbox as the recipient.
* **Test run:** if the header offers **"Test flow"**, the flow runs once without being started; the status appears directly on the components. Otherwise, start the flow briefly with "Start flow" and fire the trigger with test data.
* **Check the result:** via **"Logs"** you see, for each step, which data came in and went out (more under [Insights](https://hub.equipme.io/dokumentation/automation/insights.md)). "Start tracking" shows new entries live.

{% hint style="danger" %}
A test is not a dry run: all actions are **really executed**. Emails are sent, accounts created, records changed. So only test with test data and test recipients.
{% endhint %}

## Error handling and retries

* **Automatic retry:** temporary errors – such as an unreachable server, a timeout or too many requests – are retried automatically by the automation module at increasing intervals. This can take from minutes to hours.
* **Permanent errors** – e.g. wrong credentials, missing permission, invalid input – are not retried. They appear with an error message in [Insights](https://hub.equipme.io/dokumentation/automation/insights.md).
* **Per component** you can define what happens on an error (component settings → error handling, where offered): discard the message and carry on, stop the whole flow, or continue via a dedicated **error output** – e.g. send an email to IT (see [Insights → Getting notified of errors](https://hub.equipme.io/dokumentation/automation/insights.md#getting-notified-of-errors)).

## Publishing and applying changes

The designer saves your changes continuously. A flow only works once you start it with **"Start flow"**. How to change a flow that is already running (draft and "Publish changes", or stop and restart) is described under [Managing workflows → Changing running flows](https://hub.equipme.io/dokumentation/automation/workflows.md#changing-running-flows).

## The flow menu

Via the menu in the designer's header:

| Menu item                   | Effect                                                                                                                                                            |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Rename"                    | Rename the flow                                                                                                                                                   |
| "Share"                     | Share the flow for viewing ("Read"); you grant further permissions in the [flow list](https://hub.equipme.io/dokumentation/automation/workflows.md#sharing-flows) |
| "Change Description"        | Edit the flow's description                                                                                                                                       |
| "Export SVG" / "Export PNG" | Save the diagram as an image (right-click → "Save as"), e.g. for process documentation                                                                            |
| "Print"                     | Print the diagram                                                                                                                                                 |

## Frequently asked questions

**Why don't I see any variables in a field?**

Variables only come from components connected before the current one. Check the connecting lines and click "Refresh variables".

**Do I need to save?**

No, changes are saved automatically. They take effect when the flow is started or the changes have been applied.

**My Scheduler fires at the wrong time.**

Check the time zone in the Scheduler. If none is set, GMT often applies.

**Can I add my own code?**

For special cases there are HTTP calls to any interface and a modifier for custom functions. For most processes, the ready-made building blocks are enough.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/dokumentation/automation/flow-designer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
