> ## Documentation Index
> Fetch the complete documentation index at: https://docs.saphion.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Automations

> Rules that start when something happens in your work and do the steps you chose: make one, test it, turn it on, read every run and ask someone to approve.

An **Automation** is a rule that starts when something happens in your work, such as an Action being marked done or a date arriving, and then does the steps you chose. Use one for work you would otherwise do by hand each time: tell someone, change a field, make a follow-up Action or ask for a sign-off. Every run is recorded, so you can always see what it did.

> [!NOTE]
>
> Admins manage Automations for the whole Organisation. On a Project, its Editors and Managers manage that Project's Automations.

## Where to find Automations

| Where | What you get |
| - | - |
| **Automations** in the sidebar | Every Automation you may open, with the **Rules** and **Run history** tabs. |
| A Project's **Project settings > Automations** | The rules managed in that Project, the rules that watch it and the rules that may act in it. See [Projects](https://docs.saphion.co.uk/work/projects.md). |
| **Automate** in a board's **More actions** menu | The rules for that board, in a window over it. Choose **Open all Automations** in the window to go to the full page. See [Boards, tables and views](https://docs.saphion.co.uk/work/boards-and-views.md). |
| **Automate this account** in a connected account's menu | Starts an Automation that listens to that account. See [Connectors](https://docs.saphion.co.uk/beacon/connectors.md). |
| A **Button** field | A button on an item that runs one Automation. See [Run an Automation from a button](#run-an-automation-from-a-button). |

## Make an Automation

**1. Start it**

Open **Automations** and choose **New Automation**, then **Blank** to build your own or **Start from a starter** to begin from a ready-made rule. Where you start decides what is filled in: from a Project it is managed by that Project, and from a connected account it listens to that account.

**2. Say what starts it**

On the **Workflow** tab, the first card is headed **When this happens**. Choose **What starts it**, then the work to watch and any detail it asks for. The card reads back as a sentence. See [What starts an Automation](#what-starts-an-automation).

**3. Add the steps**

Choose **Then do this** and pick a step. Each step after it is headed **And then**. Fill in what the step asks for. See [The steps](#the-steps).

**4. Name it**

The **Settings** tab holds **Name** and **Description**. Until you type a name, Saphion names the Automation from its steps and renames it when they change. Type a name to keep your own. **Managed by** shows whether the Organisation or a Project manages it.

**5. Save it**

Choose **Save**. The button is greyed, with the reason on hover, while something it needs is still missing. A new Automation is saved switched off. Test it, then turn it on.

If you leave a draft unsaved, Saphion asks before you go, and keeps your edits if you refresh. If Beacon or someone else changes the Automation while you have it open, a notice offers **Keep my edits** or **Use Beacon's version**.

### Start from a starter

A starter is a ready-made rule. You choose what it should use and give it a name, and you get your own Automation to change before you turn it on. Changing the starter later never changes an Automation you already made from it.

| Starter | What it does | What you choose |
| - | - | - |
| **Update when a field matches** | Changes one field only when a condition on another is met. Other items stay as they are. | Where it works, the field to check, the value it must have, the field to change and its new value. |
| **Wait, then update** | Waits a set time, then changes a field. | Where it works, how long to wait in seconds, the field to change and its new value. |
| **When an Action is marked done, ask its Project lead to approve** | Asks whoever holds the Role you choose on the Action's Project to approve it. If they return it, the Action goes back to **Working on it** and they say why. | The Actions it watches and the Role that approves. |

Starters are grouped by what they do, and **Search starters…** narrows the list.

## What starts an Automation

Choose one in **What starts it**. The list is grouped as follows.

| Group | What starts it |
| - | - |
| **Records** | **An item is created**; **An item changes** (you can ignore changes to only some fields); **A field changes**, optionally to a value you name; **An item starts matching conditions**, which fires when a change makes it match, and not again until it stops matching and then matches once more. |
| **People** | **A person is assigned**; **Someone presses a button on an item**. |
| **Dates and schedules** | **A date arrives**, with days before or after; **A scheduled time arrives**, every day, week, month or other rhythm you set, with **Working days only** and a choice for a non-working day; **An expected item is missing by its time**. |
| **Reviews** | **A review decision is made**: a reviewed change proposed, accepted or rejected. |
| **Schedule** | **The work it waits on is done**; **It falls behind its dates**; **It is back on track with its dates**. |
| **Connected apps** | **Something happens in a connected app**: you choose the connected app, what happens there and, where it offers one, what to watch, such as a mail folder or a drive folder. |
| **Products** | **Something happens in a product**, from the events that product offers. |

A rule saved with a start that Saphion no longer offers is paused and says so. It cannot be saved or switched on again until you choose another.

## The steps

Choose a step from the chooser, grouped as below. Each step has the one name you see in the editor, in Run history and in any message that names it.

| Group | Steps |
| - | - |
| **Items** | **Set a field value**; **Create an item**; **Find items matching a condition**; **Find or create an item**; **Close an item**; **Archive an item**; **Find the items linked to this item**; **Add a template's items under it**; **Find the items filed under the event's Project**, for a rule that starts from an event. |
| **People and messages** | **Send a notification**; **Ask for approval**; **Post an update**; **Assign people**; **Notify the person with a Role**; **Give it to the person with a Role**; **Send each person one list**. |
| **Beacon** | **Ask Beacon**, which does what you tell it in words within the tools you allow; **Check text**, which judges an item's text field, or the text an earlier step read from a connected app such as an email, against questions you set, and goes down the path for the answer. |
| **Weather and places** | **Find a place**; **Get weather information**. |
| **Checks, waits and repeats** | **Continue only if a condition matches**; **Wait before continuing**; **Repeat for each item**; **Do these at the same time**; **Work out a value**; **Finish**. |
| **Connected apps** | **Do something in a connected app**, such as sending a message or saving a file through an account you may use. |

A few of these shape the workflow rather than act on an item:

* **Continue only if a condition matches** splits the path. Items that match carry on, and you choose what happens to the rest, or end there with **Stop here**.
* **Wait before continuing** waits for **A length of time**, **A date and time**, **Something to happen** or **A condition to become true**. You can say how long to wait before giving up.
* **Repeat for each item** takes the items an earlier step found, at most 500, and runs the steps beneath it on each. You choose how many may fail before it stops.
* **Do these at the same time** runs its branches side by side.
* **Finish** ends a path as **Done**, **Stop here**, **Stop: can't go on**, **Finish as failed** or **Finish as cancelled**.
* A step can have an **If it fails** path of its own.

A later step can use what an earlier step found or made, for example **Each action found in step 1**.

> [!NOTE]
>
> An Automation only does what the person who turned it on could do. Its steps are checked again at every run, so a step never reaches further than that person's access.

## Turn an Automation on or off

Each rule in **Rules** has an **Active** switch, and the editor has the same switch beside **Save**, reading **On** or **Paused**. Pausing stops new runs at once.

* **A rule that sends something automatically.** If a step sends, drafts or exports through a connected account, turning the rule on first opens **Turn on** and lists each send: the account it goes from, the operation, who receives it and what it says. For an **Ask Beacon** step it shows Beacon's instruction and where it works. Choose **Turn on** to allow exactly what is listed. Parts that come from an item, such as its title, are filled in each time.
* **Changing what it sends** pauses the rule until you turn it on again, so a new recipient or message is never sent under an old yes.
* **When the person who turned it on loses access**, or no longer manages Automations where it is filed, the rule pauses and says why. Nobody is put in their place: someone who manages the rule turns it on again.
* **A paused rule** keeps its history and can be turned on again. Select several rules to **Pause**, **Turn on** or **Delete** them together.

To copy a rule, choose **Duplicate** from its row menu or from the editor's **⋯** menu. **Delete** moves it to the Bin. The **⋯** menu also opens its **History**.

## Test an Automation

Open the **Test** tab. Choose an item to test on, or leave it as **First matching item**, and choose **Test**. Saphion shows what the Automation would do to that item, step by step, headed **Test only: nothing was changed**. Nothing is sent or changed. A rule that starts from a schedule shows what it would do at its next scheduled time. A rule that starts from an event has no item to test on, and says so.

### Run it for real, once

While an Automation is switched off, the **Test** tab also offers **Run it for real**. Choose **Show what it would do**, read the steps and anything it would send, then choose **Run it for real**. It runs once on the item you tested, changes and sends what it said, and stays switched off. If the rule or the item changed since you were shown the plan, Saphion shows the new plan first. Save your changes before you run it.

### Run now

For a saved rule that is on, **Run now** in the editor's **⋯** menu runs it once, for real, on the first matching item or the one you tested. You need to be able to change the rule.

## Read the runs

**Run history** lists every run, newest first, as one line: the Automation, what it did, the version it ran, who it ran as and when. The tab carries a red count of the runs that need attention. Narrow the list with **Filter**, by **Status**, **Project**, **Source** or **Run day**:

| Status | What it lists |
| - | - |
| **All runs** | Every run. |
| **Needs attention** | A run that failed, was refused or is stuck at a wait. It stays listed until a later run on the same item settles it. |
| **In progress** | A run waiting to start, running or waiting. |
| **Completed** | A run that finished what it had to do. |
| **Missed** | A scheduled time that passed while nothing could start it. |
| **Stopped** | A run that was cancelled, or stopped when its rule was paused. |

When a Project's list cannot place some runs under it, it says how many are missing.

Choose **View run** to open one run. The page is headed by the Automation's name, with how it ended and when. Below it:

* **Each step**, with what it did to which item, and **Done**, **Skipped**, **Refused**, **Failed**, **Uncertain** or **Started, not confirmed**.
* **Each condition it decided**: met, or not met and it stopped there or took the other path.
* **Each wait it went through**, with what released it and when, or that it did not wait. A run still waiting shows the wait, whether it is **Waiting**, **Past due** or **Stuck**, and when it carries on or gives up.
* **For an Ask Beacon step**, which model and how much effort it used.

Choose **Back to run history** to return.

You can see how a run ended even where you may not see its steps, and it says so.

### Cancel, run again or settle

Where you may change the rule:

* **Cancel run** stops a run that has not finished.
* **Run again** carries a run that left work undone through on the version it ran. What it already did is not done twice. If the rule has changed since, Saphion says so and offers a new run on the current version instead.
* A step that may or may not have reached a connected app is never repeated blindly. The run asks **It happened** or **It did not happen**, and carries on from your answer.

> [!NOTE]
>
> Saphion keeps a finished run for 400 days after it ended.

## Ask someone to approve

Add the step **Ask for approval** to an Automation. The Automation stops at that step and waits. It carries on only when the person answers.

The step asks one of:

* **A named person.**
* **The people in a field**, such as an Action's Assignee.
* **Whoever holds a Role on the item's Project**, such as its Project lead. See [Roles on a Project](https://docs.saphion.co.uk/admin/teams-and-permissions.md#roles-on-a-project).

The people asked are fixed when the step asks. Changing a field or a Role afterwards does not change who was asked for that run.

### How the person answers

The request appears under **Waiting on you**. The person chooses one of:

* **Approve.** The Automation carries on down the branch for approval.
* **Return**, with a reason. The Automation carries on down the branch for a return, and the reason is kept with the run. A later step can use the reason, for example to post it as an update.

Only someone who was asked can answer. Anyone else is refused, with the reason.

### What stays as it was

A change to a field that needs agreement, and Form answers awaiting review, are decided by the people the field or Form names. They are not Automations and are unchanged.

### When a step waits for you to allow it

Some steps wait for a person's allowance before they run. **Waiting for your approval** at the head of **Automations** lists each one, with who it goes to, what it says and when the request expires. Choose **Approve** or **Deny**, or **View run** to open the run. Only the person the Automation runs for can approve it. Others who see it can deny it.

## Run an Automation from a button

A **Button** field puts a button on every item of a board. Pressing it runs one Automation on that item.

**1. Make the Automation**

Make an Automation whose trigger is **Someone presses a button on an item**, watching the board's items.

**2. Add the Button field**

Add a field of type **Button** to the board. See [Fields](https://docs.saphion.co.uk/work/fields.md). In its settings, give it a **Button label** and choose the Automation in **Runs this automation**. **Create an automation that starts from a button** opens Automations if you have none yet.

**3. Choose whether it asks first**

**Ask before running** is on by default. **What pressing it does** reads back what will happen. If the Automation is paused, it says the button will not run until the Automation is turned on.

Anyone who can open the item and use the button field can press it. They need no permission to manage Automations, and a button gives them nothing more: the steps run with the Automation's own authority. Pressing twice while the first run is still pending starts nothing more.

## Who can manage Automations

| You are | You can manage |
| - | - |
| An Admin | Automations for the whole Organisation, and for any Project. |
| An Editor or Manager of a Project | That Project's Automations. Its steps change only that Project. |
| Anyone else | You can open the Automations you may see, and a Button you may press. |

Where you may not, the control is greyed or refused with the reason, for example "Only an Admin can manage Automations for the whole Organisation. Ask an Admin." A rule you may open but not change opens read-only, and turning it on or off, **Duplicate** and **Delete** say who to ask.

## Plan limits

An Organisation has a monthly allowance of **Automation actions**. Each step that changes something counts once. Looking things up, checks and retrying do not count. An **Ask Beacon** step counts once, and the AI it uses is funded separately.

When the allowance is used up, further runs are refused before they act, with the reason **The organisation's monthly Automation action allowance is exhausted or not configured**, and show as **Refused** in Run history. The allowance resets each month.

| Plan | Included each month |
| - | - |
| **Team** | 10,000 actions, plus 500 for each seat |
| **Business** | 50,000 actions, plus 1,000 for each seat |

Where Saphion sets a different figure for an Organisation, **Usage** shows that figure. **Settings > Organisation > Usage** shows **Monthly Automation actions**: what has been completed, what is reserved and what is awaiting confirmation. See [Plan, billing and usage](https://docs.saphion.co.uk/admin/billing.md).

## Ask Beacon

Beacon can make, change, test and run Automations, as you could. A new Automation is saved switched off. Where it sends automatically, Beacon asks you first with a card saying what it will send, and Beacon never turns that on without you. It can also run a switched-on rule, press a button as you would, cancel or run a run again, and read the run history to tell you what happened.

* "When an Action is marked done, ask the Project lead to approve it."
* "Why did last night's run of the weekly reminder fail?"
* "Show me what this rule would do to the Harbour Road Project's overdue Actions, without running it."

Work Beacon does on a schedule, from instructions that stand alone, is a **Scheduled task** instead. See [Scheduled tasks](https://docs.saphion.co.uk/beacon/scheduled-tasks.md) and [Chat with Beacon](https://docs.saphion.co.uk/beacon/chat.md).

## FAQ

> [accordion] I saved my Automation. Why has nothing happened?
>
> A new Automation is saved switched off. Test it, then turn on its **Active** switch. Check **Run history** for runs that were refused or are waiting.

> [accordion] Why did a run say Nothing to do?
>
> The item did not meet the rule's conditions, or every step found its work already done. It is a normal result and not a fault.

> [accordion] Why did a run say Missed?
>
> A scheduled time passed while nothing could start it. It is listed under **Missed** in Run history.

> [accordion] Why was my rule paused?
>
> Its row says why. Common reasons are that its automatic sends changed, or that the person who turned it on no longer has the access it runs with. Turn it on again, or ask someone who manages it.

> [accordion] Can I try a rule without sending anything?
>
> Yes. **Test** shows what it would do and changes nothing. **Run it for real** is a separate act, after you read the plan.

> [accordion] I deleted a rule by mistake.
>
> It rests in the Bin. See [Bin and restore](https://docs.saphion.co.uk/admin/bin-and-restore.md).

> [accordion] Can the person I ask to approve see my Automation?
>
> They see the request, the item it is about and what it asks. They do not need to open the Automation, and the request does not carry its name.

## Related

* [Teams and Permissions](https://docs.saphion.co.uk/admin/teams-and-permissions.md): Roles on a Project, and who holds them.
* [Actions](https://docs.saphion.co.uk/work/actions.md): Status, including **Not required**, and the **Waiting on** badge.
* [Connectors](https://docs.saphion.co.uk/beacon/connectors.md): The accounts an Automation can listen to and act through.
* [Fields](https://docs.saphion.co.uk/work/fields.md): Add a Button field that runs an Automation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.