Platform › Automation
Workflows
A trigger, a condition and a list of steps. Run one by hand to see exactly what it would do before letting an event drive it.
Where to find it
- Module: Platform
- Group: Automation
- Section: Automation
- Screen: Workflows
Address in the console: /platform/workflows
List · 9 columns · 13 fields on its form · 3 of them required · 2 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Workflow | Code | code |
| Name | Text | name |
| Category | Status | category |
| Trigger | Status | trigger_type |
| On event | Code | trigger_event |
| Steps | Number | steps |
| Runs | Number | run_count |
| Success | Text | success_rate |
| Status | Status | status |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Workflow code required | Text | e.g. WF-PO-APPROVE | |
| Name required | Text | ||
| What it does | Long text | ||
| Category | Choice | automation, approval, integration, notification, data_quality, escalation | |
| Trigger required | Choice | Configuration list | |
| Event | Text | e.g. platform.payment.captured — the event that starts it. | |
| Module | Choice | accounting, crm, hrms, scm, mfg, ehr, slcm, ats, platform | |
| Schedule (cron) | Text | Only for a scheduled trigger. | |
| Condition | Text | Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000} | |
| Status | Choice | draft, active, paused, archived | |
| Owner | Choice | Looked up from existing records | |
| Maximum retries | Number | ||
| Timeout (seconds) | Number |
What you can do here
Dispatch an event
Dispatch an event
Asks for: Event type* Payload
Run now primary
Run this workflow
Asks for: Input
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.