Description:
Applies a list of Jolt specifications to the FlowFile payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the transform fails, the original FlowFile is routed to the 'failure' relationship.
Tags:
record, jolt, transform, shiftr, chainr, defaultr, removr, cardinality, sort
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.
| Name | Default Value | Allowable Values | Description |
|---|
| Record Reader | | Controller Service API:
RecordReaderFactory
Implementations: JsonPathReader
AvroReader
XMLReader
WindowsEventLogReader
ReaderLookup
Syslog5424Reader
GrokReader
ScriptedReader
CSVReader
SyslogReader
ParquetReader
JsonTreeReader
CEFReader | Specifies the Controller Service to use for parsing incoming data and determining the data's schema. |
| Record Writer | | Controller Service API:
RecordSetWriterFactory
Implementations: AvroRecordSetWriter
ScriptedRecordSetWriter
JsonRecordSetWriter
ParquetRecordSetWriter
RecordSetWriterLookup
FreeFormTextRecordSetWriter
XMLRecordSetWriter
CSVRecordSetWriter | Specifies the Controller Service to use for writing out the records |
| Jolt Transformation DSL | jolt-transform-chain | - Cardinality
 - Chain
- Default
- Modify - Default
- Modify - Define
- Modify - Overwrite
- Remove
- Shift
- Sort
- Custom
| Specifies the Jolt Transformation that should be used with the provided specification. |
| Custom Transformation Class Name | | | Fully Qualified Class Name for Custom Transformation
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the <Jolt Specification> Property has a value of "jolt-transform-custom". |
| Custom Module Directory | | | Comma-separated list of paths to files and/or directories which contain modules containing custom transformations (that are not included on NiFi's classpath).
This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: file, directory.
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the <Jolt Specification> Property has a value of "jolt-transform-custom". |
| Jolt Specification | | | Jolt Specification for transform of record data. This value is ignored if the Jolt Sort Transformation is selected.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Transform Cache Size | 1 | | Compiling a Jolt Transform can be fairly expensive. Ideally, this will be done only once. However, if the Expression Language is used in the transform, we may need a new Transform for each FlowFile. This value controls how many of those Transforms we cache in memory in order to avoid having to compile the Transform each time. |
Relationships:
| Name | Description |
|---|
| success | The FlowFile with transformed content will be routed to this relationship |
| failure | If a FlowFile fails processing for any reason (for example, the FlowFile records cannot be parsed), it will be routed to this relationship |
| original | The original FlowFile that was transformed. If the FlowFile fails processing, nothing will be sent to this relationship |
Reads Attributes:
None specified.Writes Attributes:
| Name | Description |
|---|
| record.count | The number of records in an outgoing FlowFile |
| mime.type | The MIME Type that the configured Record Writer indicates is appropriate |
State management:
This component does not store state.Restricted:
This component is not restricted.Input requirement:
This component requires an incoming relationship.System Resource Considerations:
None specified.