Skip to main content

LookupAttribute

Description​

Lookup attributes from a lookup service

Tags​

Attribute Expression Language, attributes, cache, enrich, join, lookup

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 NameAPI NameDefault ValueAllowable ValuesDescription
Lookup Service *lookup-serviceController Service:
StringLookupService

Implementations:
DistributedMapCacheLookupService
ElasticSearchStringLookupService
PropertiesFileLookupService
SimpleCsvFileLookupService
SimpleDatabaseLookupService
SimpleKeyValueLookupService
SimpleScriptedLookupService
XMLFileLookupService
The lookup service to use for attribute lookups
Include Empty Values *include-empty-valuestrue
  • true
  • false
Include null or blank values for keys that are null or blank

Dynamic Properties​

NameValueDescription
The name of the attribute to add to the FlowFileThe name of the key or property to retrieve from the lookup serviceAdds a FlowFile attribute specified by the dynamic property's key with the value found in the lookup service using the the dynamic property's value

Supports Expression Language: Yes, evaluated using FlowFile Attributes and Environment variables.

Relationships​

NameDescription
failureFlowFiles with failing lookups are routed to this relationship
matchedFlowFiles with matching lookups are routed to this relationship
unmatchedFlowFiles with missing lookups are 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.

See Also​