Provides an instance of a rules engine to the caller. Supports rules stored as JSON or YAML file types.
rules, rules-engine, engine, actions, facts
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Rules File Type | rules-file-type | JSON |
| File or Body type for rules definition. Supported types are YAML and JSON |
| Rules File Path | rules-file-path | Path to location of rules file. Only one of Rules File or Rules Body may be used This property requires exactly one file to be provided.. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Rules Body | rules-body | Body of rules file to execute. Only one of Rules File or Rules Body may be used Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Rules File Format | rules-file-format | NIFI |
| Format for rules. Supported formats are NiFi Rules, Easy Rules files with MVEL Expression Language and Easy Rules files with Spring Expression Language. |
| Ignore Condition Errors | rules-ignore-condition-errors | false |
| When set to true, rules engine will ignore errors for any rule that encounters issues when compiling rule conditions (including syntax errors and/or missing facts). Rule will simply return as false and engine will continue with execution. |
| Filter Rules With Missing Facts | rules-filter-missing-facts | false |
| When set to true, the rules engine will first filter out any rule where fact are not available before executing a check or firing that rule. When running a check rules this will return only rules that were evaluated after filtering. NOTE: This is only applicable for the NIFI Rules Format (which allows specification of fact variables) and will be ignored for other formats. |
