Skip to main content

SimpleScriptedLookupService

Description

Allows the user to provide a scripted LookupService instance in order to enrich records from an incoming flow file. The script is expected to return an optional string value rather than an arbitrary object (record, e.g.). Also the scripted lookup service should implement StringLookupService, otherwise the getValueType() method must be implemented even though it will be ignored, as SimpleScriptedLookupService returns String as the value type on the script's behalf.

Tags

groovy, invoke, lookup, script

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
Script Engine *Script EngineGroovy
  • Groovy
Language Engine for executing scripts
Script FileScript FilePath to script file to execute. Only one of Script File or Script Body may be used

Supports Expression Language, using Environment variables.
Script BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be used
Module DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.

Supports Expression Language, using Environment variables.

State Management

This component does not store state.

Restricted

Required PermissionExplanation
execute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.

System Resource Considerations

This component does not specify system resource considerations.

See Also