ScanAttribute

ScanAttribute 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
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
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Attribute Pattern
Regular Expression that specifies the names of attributes whose values will be matched against the terms in the dictionary

Display Name

Attribute Pattern

Description

Regular Expression that specifies the names of attributes whose values will be matched against the terms in the dictionary

API Name

Attribute Pattern

Default Value

.*

Expression Language Scope

Not Supported

Sensitive

false

Required

true
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.

Display Name

Dictionary File

Description

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.

API Name

Dictionary File

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
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

Display Name

Dictionary Filter Pattern

Description

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

API Name

Dictionary Filter Pattern

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Match Criteria
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
Display Name

Match Criteria

Description

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

API Name

Match Criteria

Default Value

At Least 1 Must Match

Allowable Values
- At Least 1 Must Match
- All Must Match
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
unmatched	FlowFiles whose attributes are not found in the dictionary will be routed to this relationship
matched	FlowFiles whose attributes are found in the dictionary will be routed to this relationship