ScriptedReportingTask

Description:

Provides reporting and status information to a script. ReportingContext, ComponentLog, and VirtualMachineMetrics objects are made available as variables (context, log, and vmMetrics, respectively) to the script for further processing. The context makes various information available such as events, provenance, bulletins, controller services, process groups, Java Virtual Machine metrics, etc.

Tags:

reporting, script, execute, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj

Properties:

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.

NameDefault ValueAllowable ValuesDescription
Script EngineClojure
  • Clojure
  • ECMAScript
  • Groovy
  • lua
  • python
  • ruby
The engine to execute scripts
Script FilePath to script file to execute. Only one of Script File or Script Body may be used
Supports Expression Language: true (will be evaluated using variable registry only)
Script BodyBody of script to execute. Only one of Script File or Script Body may be used
Module DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.
Supports Expression Language: true (will be evaluated using variable registry only)

Dynamic Properties:

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

NameValueDescription
A script engine property to updateThe value to set it toUpdates 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)

State management:

This component does not store state.

Restricted:

Required PermissionExplanation
execute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.

System Resource Considerations:

None specified.