> 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/pro/automation/flow-designer.md).

# The flow designer

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

**Path:** "Automation" → "Workflows" → open a flow

In the **flow designer**, you assemble a flow via drag & drop. It opens in full screen as soon as you create or open a flow; the Pro sidebar collapses. Use the **back arrow in the Pro header** to return to the [flow list](https://hub.equipme.io/pro/automation/workflows.md).

## Layout

| Area                 | Content                                                                                                                                                                                                                     |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Header**           | Name of the flow, notice about invalid components, **"Start flow"** or **"Stop flow"** and the flow menu                                                                                                                    |
| **Left: components** | All available building blocks, grouped into **"Utilities"** (helpers such as filter, timer, HTTP) and **"Applications"** (connectors such as Equipme Pro, weclapp, Autotask, Microsoft). Use "Filter connectors" to search. |
| **Center: canvas**   | This is where the components and their connections are placed.                                                                                                                                                              |
| **Right: inspector** | Settings of the selected component                                                                                                                                                                                          |
| **Toolbar**          | Undo/redo, zoom ("Zoom to fit", "Zoom in", "Zoom out"), align diagram, keyboard shortcuts and "Logs"                                                                                                                        |

**Working on the canvas:** Select multiple components while holding the Shift key. Use Ctrl/Cmd + C and Ctrl/Cmd + V to copy components within the designer. "Zoom to fit" brings a large flow completely into view; the align button arranges all components neatly from left to right.

## Adding and connecting components

1. **Trigger first:** Every flow starts with a trigger. To get started, the designer offers frequently used triggers: **Timer**, **OnStart**, **Scheduler** and **Webhook**. Triggers from connectors (e.g. *New Sales Order* from "Equipme Pro") are dragged from the left panel onto the canvas.
2. **Add actions:** Drag more components onto the canvas. For connectors, choose the specific action in the inspector under **"Action"**.
3. **Connect:** Every component has **ports** – inputs on the left, outputs on the right. Drag a line from the output of one component to the input of the next. Only then does data flow on.
4. **Choose an account:** If the component needs a connection, select an existing [account](https://hub.equipme.io/pro/automation/accounts.md) in the inspector or create a new one with **"Connect account"** or **"Connect a new account"**.
5. **Fill in fields:** Required fields are marked. As long as something is missing, the header shows e.g. "1 component is invalid."; clicking it takes you to the affected component.

**Renaming components:** In the inspector via "Rename". Names like "Create ERP order" make the flow understandable for others.

## Inputs and variables

In almost any field you can use a **variable** instead of a fixed value – data from a previous step.

1. Click the **"Variables"** icon in the field.
2. Under "Connectors", choose the component and the value, e.g. the order number from *New Sales Order*. "General" contains general values.
3. The variable appears in the field and is filled with the current value on every run.

Only values of components that come **before** the current component and are connected to it are available. If an expected variable is missing, check the connections and click "Refresh variables".

## Modifiers: transforming values

Click an inserted variable to transform it in the **"Modify variable"** dialog. With **"Add modifier"** you choose a function from categories such as text, number, date, list, object or control, e.g.:

* convert text to uppercase, shorten, replace or combine it,
* format a date or shift it by days,
* divide, round or sum numbers,
* get the first item, the count or individual fields from a list.

Modifiers can be chained. With **"Test your modifier"** you try out the result with sample data before the flow runs.

## Conditions and filters

* **Filters** (Utilities): Only let a message through if a rule is met – e.g. "Contains", "Equal", "NotEqual", "Greater than", "LessThan", "Range" or "IsNotEmpty". Connect the matching output to the next step.
* **Condition** (Controls): Checks an expression with and/or combinations and passes the result on via the outputs "true" or "false" – this is how you branch the flow.
* **Switch** (Controls): Several cases, each with its own output, plus "else" for everything else.

Messages that don't meet a condition end there without an error.

## Processing lists in loops

Many actions return lists, e.g. all open fulfillment positions. To process each entry individually:

1. Add **Each** (Controls) and specify the list as a variable in the "Field" field.
2. Each passes every entry on individually via the "item" output; at the end it reports once via "done".
3. If the order matters or the next step needs all results, turn on **"Sequential"** and close the loop with **Continue Each**.
4. For interfaces with limits, set a delay ("Delay") between entries.

For simple transformations of whole lists, the list modifiers are often enough – no loop needed. Many list actions of the equipme connector also offer "Output Type" → "One item at a time".

## Scheduling

| Component     | Purpose                                                                               |
| ------------- | ------------------------------------------------------------------------------------- |
| **OnStart**   | Fires once when you start the flow.                                                   |
| **Timer**     | Fires at fixed intervals (at least 5 minutes apart).                                  |
| **Scheduler** | Fires on a schedule, e.g. every weekday at 6 a.m. Check the configured **time zone**. |
| **Wait**      | Holds a message for a period of time or until a point in time.                        |

## Webhook trigger

A **Webhook** trigger provides its own address ("Webhook URL"), which you copy in the inspector. When another system – e.g. your warehouse management system – calls this address, the flow starts with the transmitted data.

* With "Immediate response", the caller immediately receives a confirmation.
* If the caller should receive its own answer, turn off "Immediate response" and add a **Response** component later in the flow.

Treat the webhook address as confidential: anyone who knows it can start the flow.

## Testing

{% hint style="danger" %}
During testing, all actions are **really executed**: orders are created in the ERP, statuses changed in Pro, emails sent. Test with a **test customer**, test data and – where possible – test or sandbox accounts.
{% endhint %}

How to test a flow:

1. Restrict the trigger to test data, e.g. via "Customers" to your test customer.
2. If the designer offers **"Test flow"**, use it to run the flow once without starting it. Otherwise start it with **"Start flow"** and trigger it with a test transaction.
3. Open **"Logs"** in the toolbar and check the inputs and outputs of each step (see [Insights](https://hub.equipme.io/pro/automation/insights.md)).
4. If everything is fine, remove the test restriction and start the flow for live operation.

## Error handling and retries

* **Temporary errors** such as timeouts, connection drops or overloaded interfaces are retried automatically over time. This can take minutes to hours.
* **Permanent errors** such as missing permissions, invalid values or entries not found are not retried. The message remains in the log as an error; other messages continue.
* For important steps, you can define under "Error handling" in the component's menu what happens after an error – e.g. a dedicated error output that you connect to a notification (see [Insights](https://hub.equipme.io/pro/automation/insights.md#getting-notified-of-errors)).

## Starting

A flow only runs once you click **"Start flow"**. Use **"Stop flow"** to stop it. Changing running flows is described in [Managing workflows](https://hub.equipme.io/pro/automation/workflows.md#changing-a-running-flow).

## Flow menu

| Entry                               | Effect                                                                                                             |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| **"Rename"**                        | Rename the flow                                                                                                    |
| **"Share"**                         | Share the flow for viewing (see [Sharing flows](https://hub.equipme.io/pro/automation/workflows.md#sharing-flows)) |
| **"Change Description"**            | Add a description, e.g. purpose and contact person                                                                 |
| **"Export SVG"** / **"Export PNG"** | Save the diagram as an image (right-click → "Save As"), e.g. for documentation                                     |
| **"Print"**                         | Print the diagram                                                                                                  |

## Frequently asked questions

**I can't find a variable in the picker.**

The supplying component must come before the current one and be connected to it. Click "Refresh variables". For triggers, it helps to run the flow once with test data.

**The flow can't be started.**

Check the message in the header, e.g. "2 components are invalid.", and fill in the missing required fields.

**Where do I see the intermediate results of a step?**

Under "Logs" in the toolbar or in [Insights](https://hub.equipme.io/pro/automation/insights.md). Each entry shows the data a step received or passed on.

**Why has the "Personal"/"Team" bar disappeared in the designer?**

It is hidden while the flow designer is open. The flow stays in the area where you created it.


---

# 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/pro/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.
