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
execute, groovy, reporting, 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 Engine * | Script Engine | Groovy |
| Language Engine for executing scripts |
| Script File | 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 | Script Body | Body of script to execute. Only one of Script File or Script Body may be used | ||
| Module Directory | Module Directory | Comma-separated list of paths to files and/or directories which contain modules required by the script. Supports Expression Language, using Environment variables. |
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. |
System Resource Considerations
This component does not specify system resource considerations.