ScriptedRecordSink - Apache NiFi

General

Developer

Processors

Controller Services

Reporting Tasks

Parameter Providers

Flow Analysis Rules
- DisallowComponentType

ScriptedRecordSink 2.1.0

Bundle: org.apache.nifi | nifi-scripting-nar
Description: Allows the user to provide a scripted RecordSinkService instance in order to transmit records to the desired target. The script must set a variable 'recordSink' to an implementation of RecordSinkService.
Tags: groovy, invoke, record, record sink, script
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Module Directory
Comma-separated list of paths to files and/or directories which contain modules required by the script.

Display Name

Module Directory

Description

Comma-separated list of paths to files and/or directories which contain modules required by the script.

API Name

Module Directory

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Script Body
Body of script to execute. Only one of Script File or Script Body may be used

Display Name

Script Body

Description

Body of script to execute. Only one of Script File or Script Body may be used

API Name

Script Body

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Script Engine
Language Engine for executing scripts
Display Name

Script Engine

Description

Language Engine for executing scripts

API Name

Script Engine

Default Value

Groovy

Allowable Values
- Groovy
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Script File
Path to script file to execute. Only one of Script File or Script Body may be used

Display Name

Script File

Description

Path to script file to execute. Only one of Script File or Script Body may be used

API Name

Script File

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

Script Engine Binding property
Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value

Name

Script Engine Binding property

Description

Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value

Value

Binding property value passed to Script Runner

Expression Language Scope

ENVIRONMENT

Restrictions

Required Permission	Explanation
execute code	Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.