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. Please note that due to a bug in Jython that remains unresolved, it is not possible to use Jython to write a script for this service in Python.
lookup, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj
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, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Script Engine | Script Engine | ECMAScript DEPRECATED |
| Language Engine for executing scripts |
| Script File | Script File | Path to script file to execute. Only one of Script File or Script Body may be used This property requires exactly one file to be provided.. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Script Body | Script Body | Body of script to execute. Only one of Script File or Script Body may be used | ||
| Module Directory | Module Directory | Comma-separated list of paths to files and/or directories which contain modules required by the script. This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: directory, file. Supports Expression Language: true (will be evaluated using variable registry only) |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| Script Engine Binding property | Binding property value passed to Script Runner | Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value Supports Expression Language: true (will be evaluated using variable registry only) |
| Required Permission | Explanation |
|---|---|
| execute code | Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has. |
![ECMAScript ECMA - 262 Edition 5.1 [Oracle Nashorn 11.0.3]](../../../../../html/images/iconInfo.png "ECMAScript ECMA - 262 Edition 5.1 [Oracle Nashorn 11.0.3]")