ExecuteGroovyScript
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
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 Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Script File | groovyx-script-file | Path to script file to execute. Only one of Script File or Script Body may be used Supports Expression Language, using Environment variables. | ||
| Script Body | groovyx-script-body | Body of script to execute. Only one of Script File or Script Body may be used | ||
| Failure strategy * | groovyx-failure-strategy | rollback |
| 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. |
| Additional classpath | groovyx-additional-classpath | Classpath list separated by semicolon or comma. You can use masks like *, *.jar in file name.Supports Expression Language, using Environment variables. |
Dynamic Properties
| Name | Value | Description |
|---|---|---|
| A script engine property to update | The value to set it to | 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.Supports Expression Language: Yes, evaluated using FlowFile Attributes and Environment variables. |
Relationships
| Name | Description |
|---|---|
| failure | FlowFiles that failed to be processed |
| success | FlowFiles that were successfully processed |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
State Management
This component does not store state.
Restricted
| Required Permission | Explanation |
|---|---|
| execute code | Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has. |
Input Requirement
This component allows an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.