Scans the specified attributes of FlowFiles, checking to see if any of their values are present within the specified dictionary of terms


scan, attributes, search, lookup, find, text


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
Dictionary FileDictionary FileA new-line-delimited text file that includes the terms that should trigger a match. Empty lines are ignored. The contents of the text file are loaded into memory when the processor is scheduled and reloaded when the contents are modified.

This property requires exactly one file to be provided..

Supports Expression Language: true (will be evaluated using variable registry only)
Attribute PatternAttribute Pattern.*Regular Expression that specifies the names of attributes whose values will be matched against the terms in the dictionary
Match CriteriaMatch CriteriaAt Least 1 Must Match
  • At Least 1 Must Match
  • All Must Match
If set to All Must Match, then FlowFiles will be routed to 'matched' only if all specified attributes' values are found in the dictionary. If set to At Least 1 Must Match, FlowFiles will be routed to 'matched' if any attribute specified is found in the dictionary
Dictionary Filter PatternDictionary Filter PatternA Regular Expression that will be applied to each line in the dictionary file. If the regular expression does not match the line, the line will not be included in the list of terms to search for. If a Matching Group is specified, only the portion of the term that matches that Matching Group will be used instead of the entire term. If not specified, all terms in the dictionary will be used and each term will consist of the text of the entire line in the file


unmatchedFlowFiles whose attributes are not found in the dictionary will be routed to this relationship
matchedFlowFiles whose attributes are found in the dictionary will be routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.