ScriptedValidateRecord 2.3.0¶
BUNDLE¶
org.apache.nifi | nifi-scripting-nar
DESCRIPTION¶
This processor provides the ability to validate records in FlowFiles using the user-provided script. The script is expected to have a record as incoming argument and return with a boolean value. Based on this result, the processor categorizes the records as “valid” or “invalid” and routes them to the respective relationship in batch. Additionally the original FlowFile will be routed to the “original” relationship or in case of unsuccessful processing, to the “failed” relationship.
INPUT REQUIREMENT¶
REQUIRED
Supports Sensitive Dynamic Properties¶
false
PROPERTIES¶
Property |
Description |
|---|---|
Module Directory |
Comma-separated list of paths to files and/or directories which contain modules required by the script. |
Record Reader |
The Record Reader to use parsing the incoming FlowFile into Records |
Record Writer |
The Record Writer to use for serializing Records after they have been transformed |
Script Body |
Body of script to execute. Only one of Script File or Script Body may be used |
Script Engine |
The Language to use for the script |
Script File |
Path to script file to execute. Only one of Script File or Script Body may be used |
RESTRICTIONS¶
REQUIRED PERMISSION |
EXPLANATION |
|---|---|
execute code |
Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has. |
RELATIONSHIPS¶
NAME |
DESCRIPTION |
|---|---|
invalid |
FlowFile containing the invalid records from the incoming FlowFile will be routed to this relationship. If there are no invalid records, no FlowFile will be routed to this Relationship. |
original |
After successful procession, the incoming FlowFile will be transferred to this relationship. This happens regardless the FlowFiles might routed to “valid” and “invalid” relationships. |
failure |
In case of any issue during processing the incoming flow file, the incoming FlowFile will be routed to this relationship. |
valid |
FlowFile containing the valid records from the incoming FlowFile will be routed to this relationship. If there are no valid records, no FlowFile will be routed to this Relationship. |
WRITES ATTRIBUTES¶
NAME |
DESCRIPTION |
|---|---|
mime.type |
Sets the mime.type attribute to the MIME Type specified by the Record Writer |
record.count |
The number of records within the flow file. |
record.error.message |
This attribute provides on failure the error message encountered by the Reader or Writer. |