Experimental - Executes a script given the flow file and a process session. 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. Experimental: Impact of sustained usage not yet verified.


script, execute, 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 Expression Language Guide.

Name Default Value Allowable Values Description
Script Engine ECMAScript *ECMAScript The engine to execute scripts
Script File Path to script file to execute. Only one of Script File or Script Body may be used
</b>Supports Expression Language: true</b>
Script Body Body of script to execute. Only one of Script File or Script Body may be used
Module Directory Comma-separated list of paths to files and/or directories which contain modules required by the script.

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

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
Supports Expression Language: true


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

Reads Attributes:

None specified.

Writes Attributes:

None specified.