ScanContent - Apache NiFi

General

Developer

Processors

Controller Services

Reporting Tasks

Parameter Providers

Flow Analysis Rules
- DisallowComponentType

ScanContent 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Scans the content of FlowFiles for terms that are found in a user-supplied dictionary. If a term is matched, the UTF-8 encoded version of the term will be added to the FlowFile using the 'matching.term' attribute
Tags: aho-corasick, byte sequence, content, dictionary, find, scan, search
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Dictionary Encoding
Indicates how the dictionary is encoded. If 'text', dictionary terms are new-line delimited and UTF-8 encoded; if 'binary', dictionary terms are denoted by a 4-byte integer indicating the term length followed by the term itself
Display Name

Dictionary Encoding

Description

Indicates how the dictionary is encoded. If 'text', dictionary terms are new-line delimited and UTF-8 encoded; if 'binary', dictionary terms are denoted by a 4-byte integer indicating the term length followed by the term itself

API Name

Dictionary Encoding

Default Value

text

Allowable Values
- text
- binary
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Dictionary File
The filename of the terms dictionary

Display Name

Dictionary File

Description

The filename of the terms dictionary

API Name

Dictionary File

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
unmatched	FlowFiles that do not match any term in the dictionary are routed to this relationship
matched	FlowFiles that match at least one term in the dictionary are routed to this relationship

Writes Attributes

Name	Description
matching.term	The term that caused the Processor to route the FlowFile to the 'matched' relationship; if FlowFile is routed to the 'unmatched' relationship, this attribute is not added