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.
record, validate, script, groovy, jython, python
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 |
|---|---|---|---|---|
| Record Reader | Record Reader | Controller Service API: RecordReaderFactory Implementations: JsonPathReader Syslog5424Reader CSVReader JsonTreeReader GrokReader ExcelReader ParquetReader ReaderLookup CEFReader WindowsEventLogReader ProtobufReader SyslogReader AvroReader XMLReader ScriptedReader YamlTreeReader | The Record Reader to use parsing the incoming FlowFile into Records | |
| Record Writer | Record Writer | Controller Service API: RecordSetWriterFactory Implementations: ScriptedRecordSetWriter ParquetRecordSetWriter RecordSetWriterLookup CSVRecordSetWriter FreeFormTextRecordSetWriter JsonRecordSetWriter AvroRecordSetWriter XMLRecordSetWriter | The Record Writer to use for serializing Records after they have been transformed | |
| Script Language | Script Engine | Groovy |
| The Language to use for the script |
| Script Body | Script Body | Body of script to execute. Only one of Script File or Script Body may be used | ||
| Script File | Script File | Path to script file to execute. Only one of Script File or Script Body may be used This property requires exactly one file to be provided.. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Module Directory | Module Directory | Comma-separated list of paths to files and/or directories which contain modules required by the script. This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: directory, file. Supports Expression Language: true (will be evaluated using variable registry only) |
| Name | Description |
|---|---|
| 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. |
| 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. |
| failure | In case of any issue during processing the incoming flow file, the incoming 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. |
| 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. |
| Required Permission | Explanation |
|---|---|
| execute code | Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has. |
ScriptedTransformRecord, ScriptedFilterRecord, ScriptedPartitionRecord