EasyRulesEngineService

Description:

Defines and execute the rules stored in NiFi or EasyRules file formats for a given set of facts. Supports rules stored as JSON or YAML file types.

Additional Details...

Tags:

rules, rules-engine, engine, actions, facts

Properties:

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 NameAPI NameDefault ValueAllowable ValuesDescription
Rules File Typerules-file-typeJSON
  • JSON JSON file configuration type.
  • YAML YAML file configuration type.
File or Body type for rules definition. Supported types are YAML and JSON
Rules File Pathrules-file-pathPath 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 Bodyrules-bodyBody 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 Formatrules-file-formatNIFI
  • NIFI NiFi rules formatted file.
  • Easy Rules MVEL Easy Rules File format using MVFLEX Expression Language
  • Easy Rules SpEL Easy Rules File format using Spring Expression Language
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 Errorsrules-ignore-condition-errorsfalse
  • true
  • 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 Factsrules-filter-missing-factsfalse
  • true
  • 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.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.