SetState
Changed on:
17 Feb 2025
Overview
Change the Status of the current Entity to the value provided.
| Plugin Name | Core Reference Module |
|---|---|
| Namespace | [[account.id]].core |
The Core Reference Module is a foundational Reference Module.
It provides a base set of general purpose Rules:
- that other Modules are built upon
- or that can be included in your own Workflows
Extensible by design, use this Module as a base to build a solution for the needs of your customers.
UI Description
Set state to {status}
Accepts
- All Orchestration Entities
Actions
- This Rule produces a MutateAction
Rule parameters
Name | Type | Description |
| | The new Status value to be set for the current Entity. |
Event attributes
This Rule does not expect any Event attributes.
Exceptions
- This Rule throws a when the Rule parameter(s) is not provided.
`PropertyNotFoundException`
Configuration example
1{
2 "name": "[[account.id]].core.SetState",
3 "props": {
4 "status": "BOOKED"
5 }
6}Language: json
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``STATE_CHANGE``NO_MATCH`Workflow Builder (Modeller) Screenshot
Version History
v25.2.17
This Rule NO longer triggers an exception when the
`entitySubType`This change specifically applies to the
`CREATE`The Rule Version refers to the Product Release Version.
v23.8.2
Refers to the Product Release Version
