ScanAttribute
Description
Scans the specified attributes of FlowFiles, checking to see if any of their values are present within the specified dictionary of terms
Tags
attributes, find, lookup, scan, search, text
Properties
In the list below required Properties are shown with an asterisk (*). Other properties 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 |
|---|---|---|---|---|
| Dictionary File * | Dictionary File | A 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. Supports Expression Language, using Environment variables. | ||
| Attribute Pattern * | Attribute Pattern | .* | Regular Expression that specifies the names of attributes whose values will be matched against the terms in the dictionary | |
| Match Criteria * | Match Criteria | At Least 1 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 Pattern | Dictionary Filter Pattern | A 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 |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| matched | FlowFiles whose attributes are found in the dictionary will be routed to this relationship |
| unmatched | FlowFiles whose attributes are not found in the dictionary will be routed to this relationship |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.