LookupAttribute

Description:

Lookup attributes from a lookup service

Tags:

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

Properties:

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.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Lookup Servicelookup-serviceController Service API:
StringLookupService
Implementations: ElasticSearchStringLookupService
XMLFileLookupService
DistributedMapCacheLookupService
SimpleScriptedLookupService
SimpleCsvFileLookupService
SimpleKeyValueLookupService
PropertiesFileLookupService
CouchbaseKeyValueLookupService
SimpleDatabaseLookupService
The lookup service to use for attribute lookups
Include Empty Valuesinclude-empty-valuestrue
  • true
  • false
Include null or blank values for keys that are null or blank

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

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: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
failureFlowFiles with failing lookups are routed to this relationship
unmatchedFlowFiles with missing lookups are routed to this relationship
matchedFlowFiles with matching lookups are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

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:

None specified.