SetState
Changed on:
12 June 2025
Overview
Change the Status of the current to the value provided.
| Plugin Name | Core Reference Module |
|---|---|
| Namespace | [[account.id]].core |
The is a foundational .
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 . |
Event attributes
This does not expect any 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 will produce a MutateAction.
The mutation will apply to the current in the Context. Mutation Actions are executed immediately after the that produced it to ensure the following Rules and Rulesets have up to date state.
Additionally, a `STATE_CHANGE` will be generated by the platform for backward compatibility purposes. We don't generally recommend using this . 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
v25.6.12
This now uses the type-agnostic `updateProduct` mutation for Product updates instead of the type-specific mutations updateVariantProduct, updateStandardProduct. As a result, it NO longer throws an exception when the Product Type:
- is not specified
- or differs from the reference Types:
`STANDARD``VARIANT`
The Version refers to the Product Release Version.
v25.2.17
This NO longer triggers an exception when the `entitySubType` value is missing from the .
This change specifically applies to the `CREATE` for Variant and Standard Products within the .
The Version refers to the Product Release Version.
v23.8.2
Refers to the Product Release Version
