Skip to content

rule schema

Frontend rule-engine definition (page-level conditional visibility/computed-value rules).

Pull the full JSON Schema: erp schema pull rule  ·  MCP: erp_get_schema {"name":"rule"}

Top-level properties

PropertyTypeRequiredNotes
idstringyes
namestringyesStable marketplace-facing name (Phase 21 §4c).
descriptionstring
eventstringyesDotted event-name pattern: '*' matches one segment, trailing '**' matches any remainder.
priorityintegeryesOne of the band values 1/5/10/100 unless priorityOverride is true. Bands confer timing and veto rights (ADR 0008 §4): security(1) and validation(5) run synchronously pre-commit and can veto; business(10) sync; notification(100) async post-commit.
priorityOverridebooleanExplicit opt-out of the band constraint. Deliberate, visible, audited.
enabledboolean
scopeobjectMatch dimensions beyond event name and tenant. Unset means any.
watchedFieldsarrayFire only when one of these data fields changed between data.old and data.new (ADR 0008 §2). Fires when old/new are absent (creation).
conditionstringPhase 1 expression over ${event.*} plus the ambient scopes. Boolean true fires; false/Null skips; non-Boolean/unresolvable is a distinct observable skip.
suppressSelfTriggerbooleanDon't re-fire from events this rule's own actions caused (ADR 0008 §5).
actionsarrayyesPhase 2 action chain(s), executed by the Action Engine with its frozen retry/timeout/error semantics.
metadataobjectMarketplace-publishable shape (Phase 21 §4c): version required at publish time.