SetState
RuleRules are designed to be building blocks for workflow logic.
Changed on:
6 Aug 2025
Overview
Change the Status of the current Entity to the value provided.| Plugin Name | Core Reference Module |
|---|---|
| Namespace | [[account.id]].core |
- that other Modules are built upon
- or that can be included in your own Workflows
UI Description
Set state to {status}
Accepts
- All Orchestration Entities
Actions
- This Rule produces a MutateAction
Rule parameters
| Name | Type | Description |
`status` | `String` | The new Status value to be set for the current Entity. |
Event attributes
This Rule does not expect any Event attributes.
Exceptions
Configuration example
1{
2 "name": "[[account.id]].core.SetState",
3 "props": {
4 "status": "BOOKED"
5 }
6}Detailed Technical Description
This Rule will produce a MutateAction.The mutation will apply to the current Entity in the Event Context. Mutation Actions are executed immediately after the Rule that produced it to ensure the following Rules and Rulesets have up to date Entity state.Additionally, a 
`STATE_CHANGE` Event will be generated by the platform for backward compatibility purposes. We don't generally recommend using this Event. The Reference Modules do not include `STATE_CHANGE` Rulesets, and it is ok to let these result in a `NO_MATCH`.Workflow Builder (Modeller) Screenshot
