ExecuteGroovyScript

ExecuteGroovyScript 2.0.0

Bundle: org.apache.nifi | nifi-groovyx-nar
Description: Experimental Extended Groovy script processor. The script is responsible for handling the incoming flow file (transfer to SUCCESS or remove, e.g.) as well as any flow files created by the script. If the handling is incomplete or incorrect, the session will be rolled back.
Tags: groovy, groovyx, script
Input Requirement: ALLOWED
Supports Sensitive Dynamic Properties: false

Properties

Additional classpath
Classpath list separated by semicolon or comma. You can use masks like `*`, `*.jar` in file name.

Display Name

Additional classpath

Description

Classpath list separated by semicolon or comma. You can use masks like `*`, `*.jar` in file name.

API Name

groovyx-additional-classpath

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Failure strategy
What to do with unhandled exceptions. If you want to manage exception by code then keep the default value `rollback`. If `transfer to failure` selected and unhandled exception occurred then all flowFiles received from incoming queues in this session will be transferred to `failure` relationship with additional attributes set: ERROR_MESSAGE and ERROR_STACKTRACE. If `rollback` selected and unhandled exception occurred then all flowFiles received from incoming queues will be penalized and returned. If the processor has no incoming connections then this parameter has no effect.
Display Name

Failure strategy

Description

What to do with unhandled exceptions. If you want to manage exception by code then keep the default value `rollback`. If `transfer to failure` selected and unhandled exception occurred then all flowFiles received from incoming queues in this session will be transferred to `failure` relationship with additional attributes set: ERROR_MESSAGE and ERROR_STACKTRACE. If `rollback` selected and unhandled exception occurred then all flowFiles received from incoming queues will be penalized and returned. If the processor has no incoming connections then this parameter has no effect.

API Name

groovyx-failure-strategy

Default Value

rollback

Allowable Values
- rollback
- transfer to failure
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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

groovyx-script-body

Expression Language Scope

Not Supported

Sensitive

false

Required

false
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

groovyx-script-file

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

A script engine property to update
Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value. Use `CTL.` to access any controller services, `SQL.` to access any DBCPServices, `RecordReader.` to access RecordReaderFactory instances, or `RecordWriter.` to access any RecordSetWriterFactory instances.

Name

A script engine property to update

Description

Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value. Use `CTL.` to access any controller services, `SQL.` to access any DBCPServices, `RecordReader.` to access RecordReaderFactory instances, or `RecordWriter.` to access any RecordSetWriterFactory instances.

Value

The value to set it to

Expression Language Scope

FLOWFILE_ATTRIBUTES

Restrictions

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

Relationships

Name	Description
success	FlowFiles that were successfully processed
failure	FlowFiles that failed to be processed