Updates the contents of a FlowFile that contains Record-oriented data (i.e., data that can be read via a RecordReader and written by a RecordWriter). This Processor requires that at least one user-defined Property be added. The name of the Property should indicate a RecordPath that determines the field that should be updated. The value of the Property is either a replacement value (optionally making use of the Expression Language) or is itself a RecordPath that extracts a value from the Record. Whether the Property value is determined to be a RecordPath or a literal value depends on the configuration of the <Replacement Value Strategy> Property.
update, record, generic, schema, json, csv, avro, log, logs, freeform, text
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.
Display Name | API Name | Default Value | Allowable Values | Description |
---|---|---|---|---|
Record Reader | record-reader | Controller Service API: RecordReaderFactory Implementations: CEFReader SyslogReader ReaderLookup ProtobufReader Syslog5424Reader CSVReader GrokReader WindowsEventLogReader ScriptedReader AvroReader ParquetReader JsonPathReader ExcelReader JsonTreeReader YamlTreeReader XMLReader | Specifies the Controller Service to use for reading incoming data | |
Record Writer | record-writer | Controller Service API: RecordSetWriterFactory Implementations: JsonRecordSetWriter RecordSetWriterLookup AvroRecordSetWriter XMLRecordSetWriter FreeFormTextRecordSetWriter CSVRecordSetWriter ParquetRecordSetWriter ScriptedRecordSetWriter | Specifies the Controller Service to use for writing out the records | |
Replacement Value Strategy | replacement-value-strategy | Literal Value |
| Specifies how to interpret the configured replacement values |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
Name | Value | Description |
---|---|---|
A RecordPath. | The value to use to replace fields in the record that match the RecordPath | Allows users to specify values to use to replace fields in the record that match the RecordPath. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Name | Description |
---|---|
success | FlowFiles that are successfully transformed will be routed to this relationship |
failure | If a FlowFile cannot be transformed from the configured input format to the configured output format, the unchanged FlowFile will be routed to this relationship |
Name | Description |
---|---|
record.index | This attribute provides the current row index and is only available inside the literal value expression. |
record.error.message | This attribute provides on failure the error message encountered by the Reader or Writer. |