org.apache.nifinifi-scripting-nar2.3.0org.apache.nifinifi-standard-shared-nar2.3.02.0.0rel/nifi-2.3.0main1org.apache.nifi.processors.script.ExecuteScriptPROCESSORExperimental - 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.scriptexecutegroovyclojureScript EngineScript EngineLanguage Engine for executing scriptsClojureClojureClojureClojure 1.8.0 [Clojure UNKNOWN]GroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueFLOWFILE_ATTRIBUTEStruefailureFlowFiles that failed to be processedfalsesuccessFlowFiles that were successfully processedfalseScripts can store and retrieve state using the State Management APIs. Consult the State Manager section of the Developer's Guide for more details.LOCALCLUSTERexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.INPUT_ALLOWEDorg.apache.nifi.processors.script.InvokeScriptedProcessororg.apache.nifi.processors.script.InvokeScriptedProcessorPROCESSORExperimental - Invokes a script engine for a Processor defined in the given script. The script must define a valid class that implements the Processor interface, and it must set a variable 'processor' to an instance of the class. Processor methods such as onTrigger() will be delegated to the scripted Processor instance. Also any Relationships or PropertyDescriptors defined by the scripted processor will be added to the configuration dialog. The scripted processor can implement public void setLogger(ComponentLog logger) to get access to the parent logger, as well as public void onScheduled(ProcessContext context) and public void onStopped(ProcessContext context) methods to be invoked when the parent InvokeScriptedProcessor is scheduled or stopped, respectively. NOTE: The script will be loaded when the processor is populated with property values, see the Restrictions section for more security implications. Experimental: Impact of sustained usage not yet verified.scriptinvokegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueFLOWFILE_ATTRIBUTEStrueScripts can store and retrieve state using the State Management APIs. Consult the State Manager section of the Developer's Guide for more details.LOCALCLUSTERexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.processors.script.ExecuteScriptorg.apache.nifi.processors.script.ScriptedFilterRecordPROCESSORThis processor provides the ability to filter records out from FlowFiles using the user-provided script. Every record will be evaluated by the script which must return with a boolean value. Records with "true" result will be routed to the "matching" relationship in a batch. Other records will be filtered out.recordfilterscriptgroovyRecord ReaderRecord ReaderThe Record Reader to use parsing the incoming FlowFile into Recordsorg.apache.nifi.serialization.RecordReaderFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseRecord WriterRecord WriterThe Record Writer to use for serializing Records after they have been transformedorg.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseScript EngineScript LanguageThe Language to use for the scriptGroovyClojureClojureGroovyGroovytruefalsefalseNONEfalsefalseScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEfailureIn case of any issue during processing the incoming FlowFile, the incoming FlowFile will be routed to this relationship.falsesuccessMatching records of the original FlowFile will be routed to this relationship. If there are no matching records, no FlowFile will be routed here.falseoriginalAfter successful procession, the incoming FlowFile will be transferred to this relationship. This happens regardless the number of filtered or remaining records.falsemime.typeSets the mime.type attribute to the MIME Type specified by the Record Writerrecord.countThe number of records within the flow file.record.error.messageThis attribute provides on failure the error message encountered by the Reader or Writer.truetrueexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.INPUT_REQUIREDorg.apache.nifi.processors.script.ScriptedTransformRecordorg.apache.nifi.processors.script.ScriptedValidateRecordorg.apache.nifi.processors.script.ScriptedPartitionRecordorg.apache.nifi.processors.script.ScriptedPartitionRecordPROCESSORReceives Record-oriented data (i.e., data that can be read by the configured Record Reader) and evaluates the user provided script against each record in the incoming flow file. Each record is then grouped with other records sharing the same partition and a FlowFile is created for each groups of records. Two records shares the same partition if the evaluation of the script results the same return value for both. Those will be considered as part of the same partition.recordpartitionscriptgroovysegmentsplitgrouporganizeRecord ReaderRecord ReaderThe Record Reader to use parsing the incoming FlowFile into Recordsorg.apache.nifi.serialization.RecordReaderFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseRecord WriterRecord WriterThe Record Writer to use for serializing Records after they have been transformedorg.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseScript EngineScript LanguageThe Language to use for the scriptGroovyClojureClojureGroovyGroovytruefalsefalseNONEfalsefalseScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEsuccessFlowFiles that are successfully partitioned will be routed to this relationshipfalsefailureIf a FlowFile cannot be partitioned from the configured input format to the configured output format, the unchanged FlowFile will be routed to this relationshipfalseoriginalOnce all records in an incoming FlowFile have been partitioned, the original FlowFile is routed to this relationship.falsepartitionThe partition of the outgoing flow file. If the script indicates that the partition has a null value, the attribute will be set to the literal string "<null partition>" (without quotes). Otherwise, the attribute is set to the String representation of whatever value is returned by the script.mime.typeSets the mime.type attribute to the MIME Type specified by the Record Writerrecord.countThe number of records within the flow file.record.error.messageThis attribute provides on failure the error message encountered by the Reader or Writer.fragment.indexA one-up number that indicates the ordering of the partitioned FlowFiles that were created from a single parent FlowFilefragment.countThe number of partitioned FlowFiles generated from the parent FlowFiletrueexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.processors.script.ScriptedTransformRecordorg.apache.nifi.processors.script.ScriptedValidateRecordorg.apache.nifi.processors.script.ScriptedFilterRecordorg.apache.nifi.processors.script.ScriptedTransformRecordPROCESSORProvides the ability to evaluate a simple script against each record in an incoming FlowFile. The script may transform the record in some way, filter the record, or fork additional records. See Processor's Additional Details for more information.recordtransformscriptgroovyupdatemodifyfilterRecord ReaderRecord ReaderThe Record Reader to use parsing the incoming FlowFile into Recordsorg.apache.nifi.serialization.RecordReaderFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseRecord WriterRecord WriterThe Record Writer to use for serializing Records after they have been transformedorg.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseScript EngineScript LanguageThe Language to use for the scriptGroovyClojureClojureGroovyGroovytruefalsefalseNONEfalsefalseScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEfailureAny FlowFile that cannot be transformed will be routed to this RelationshipfalsesuccessEach FlowFile that were successfully transformed will be routed to this Relationshipfalsemime.typeSets the mime.type attribute to the MIME Type specified by the Record Writerrecord.countThe number of records in the FlowFilerecord.error.messageThis attribute provides on failure the error message encountered by the Reader or Writer.truetrueexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.INPUT_REQUIREDorg.apache.nifi.processors.script.ExecuteScriptorg.apache.nifi.processors.standard.UpdateRecordorg.apache.nifi.processors.standard.QueryRecordorg.apache.nifi.processors.jolt.JoltTransformRecordorg.apache.nifi.processors.standard.LookupRecordorg.apache.nifi.processors.script.ScriptedValidateRecordPROCESSORThis processor provides the ability to validate records in FlowFiles using the user-provided script. The script is expected to have a record as incoming argument and return with a boolean value. Based on this result, the processor categorizes the records as "valid" or "invalid" and routes them to the respective relationship in batch. Additionally the original FlowFile will be routed to the "original" relationship or in case of unsuccessful processing, to the "failed" relationship.recordvalidatescriptgroovyRecord ReaderRecord ReaderThe Record Reader to use parsing the incoming FlowFile into Recordsorg.apache.nifi.serialization.RecordReaderFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseRecord WriterRecord WriterThe Record Writer to use for serializing Records after they have been transformedorg.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0truefalsefalseNONEfalsefalseScript EngineScript LanguageThe Language to use for the scriptGroovyClojureClojureGroovyGroovytruefalsefalseNONEfalsefalseScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEinvalidFlowFile containing the invalid records from the incoming FlowFile will be routed to this relationship. If there are no invalid records, no FlowFile will be routed to this Relationship.falseoriginalAfter successful procession, the incoming FlowFile will be transferred to this relationship. This happens regardless the FlowFiles might routed to "valid" and "invalid" relationships.falsefailureIn case of any issue during processing the incoming flow file, the incoming FlowFile will be routed to this relationship.falsevalidFlowFile containing the valid records from the incoming FlowFile will be routed to this relationship. If there are no valid records, no FlowFile will be routed to this Relationship.falsemime.typeSets the mime.type attribute to the MIME Type specified by the Record Writerrecord.countThe number of records within the flow file.record.error.messageThis attribute provides on failure the error message encountered by the Reader or Writer.truetrueexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.INPUT_REQUIREDorg.apache.nifi.processors.script.ScriptedTransformRecordorg.apache.nifi.processors.script.ScriptedFilterRecordorg.apache.nifi.processors.script.ScriptedPartitionRecordorg.apache.nifi.lookup.script.ScriptedLookupServiceCONTROLLER_SERVICEAllows the user to provide a scripted LookupService instance in order to enrich records from an incoming flow file.lookuprecordscriptinvokegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueENVIRONMENTexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.lookup.LookupServiceorg.apache.nifinifi-standard-services-api-nar2.3.0org.apache.nifi.lookup.script.SimpleScriptedLookupServiceCONTROLLER_SERVICEAllows the user to provide a scripted LookupService instance in order to enrich records from an incoming flow file. The script is expected to return an optional string value rather than an arbitrary object (record, e.g.). Also the scripted lookup service should implement StringLookupService, otherwise the getValueType() method must be implemented even though it will be ignored, as SimpleScriptedLookupService returns String as the value type on the script's behalf.lookupscriptinvokegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueENVIRONMENTexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.lookup.StringLookupServiceorg.apache.nifinifi-standard-services-api-nar2.3.0org.apache.nifi.lookup.LookupServiceorg.apache.nifinifi-standard-services-api-nar2.3.0org.apache.nifi.record.script.ScriptedReaderCONTROLLER_SERVICEAllows the user to provide a scripted RecordReaderFactory instance in order to read/parse/generate records from an incoming flow file.recordrecordFactoryscriptinvokegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueENVIRONMENTexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.serialization.RecordReaderFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0org.apache.nifi.record.script.ScriptedRecordSetWriterCONTROLLER_SERVICEAllows the user to provide a scripted RecordSetWriterFactory instance in order to write records to an outgoing flow file.recordwriterscriptinvokegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueENVIRONMENTexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.3.0org.apache.nifi.record.sink.script.ScriptedRecordSinkCONTROLLER_SERVICEAllows the user to provide a scripted RecordSinkService instance in order to transmit records to the desired target. The script must set a variable 'recordSink' to an implementation of RecordSinkService.recordrecord sinkscriptinvokegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEScript Engine Binding propertyBinding property value passed to Script RunnerUpdates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's valueENVIRONMENTexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.org.apache.nifi.record.sink.RecordSinkServiceorg.apache.nifinifi-standard-services-api-nar2.3.0org.apache.nifi.reporting.script.ScriptedReportingTaskREPORTING_TASKProvides 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.reportingscriptexecutegroovyScript EngineScript EngineLanguage Engine for executing scriptsGroovyGroovyGroovyGroovy 4.0.26 [Groovy Scripting Engine 2.0]truefalsefalseNONEfalsefalseScript FileScript FilePath to script file to execute. Only one of Script File or Script Body may be usedfalsefalsetrueENVIRONMENTfalsefalseSINGLEFILEScript BodyScript BodyBody of script to execute. Only one of Script File or Script Body may be usedfalsefalsefalseNONEfalsefalseModule DirectoryModule DirectoryComma-separated list of paths to files and/or directories which contain modules required by the script.falsefalsetrueENVIRONMENTfalsefalseMULTIPLEDIRECTORYFILEA 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 valueENVIRONMENTtrueexecute codeProvides operator the ability to execute arbitrary code assuming all permissions that NiFi has.