SetState
Rule
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
- This Rule throws a
`PropertyNotFoundException`when the Rule parameter(s) is not provided.
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
Version History
See previous versions
2025-02-17
This change specifically applies to the
v25.2.17
This Rule NO longer triggers an exception when the`entitySubType` value is missing from the Event. This change specifically applies to the
`CREATE` Event for Variant and Standard Products within the Product Catalog Workflow.The Rule Version refers to the Product Release Version.2023-08-02
