Settings API - Business event processing schema table
Business event processing (builtin:bizevents-processing-pipelines.rule
)
Incoming business events can be transformed through processing rules using this syntax. Note that rules are processed sequentially, making the order important; a different rule order could give different results.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:bizevents-processing-pipelines.rule |
| environment |
Parameters
Property | Label | Type | Description | Required |
---|---|---|---|---|
enabled | Enabled | boolean | - | required |
ruleName | Rule name | text | - | required |
matcher | Matcher (DQL) | text | required | |
transformationFields | Transformation fields | list | - | required |
script | Processor definition | text | required | |
RuleTesting | - | RuleTesting | required |
Request body objects
The TransformationField
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
type | Type | enum | - | required |
name | Name | text | - | required |
optional | Optional | boolean | - | required |
array | Is Array | boolean | - | required |
readonly | Read-only | boolean | - | required |
The RuleTesting
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
sampleEvent | Event sample | text | Sample event to use for the test run. Only JSON format is supported. | required |