Description:
Applies a list of Jolt specifications to the flowfile JSON payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the JSON transform fails, the original FlowFile is routed to the 'failure' relationship.
Additional Details...
Tags:
json, 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.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| 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 | jolt-custom-class | | | 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 Transformation DSL] Property has a value of "Custom". |
| Custom Module Directory | jolt-custom-modules | | | 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 Transformation DSL] Property has a value of "Custom". |
| Jolt Specification | jolt-spec | | | Jolt Specification for transformation of JSON data. The value for this property may be the text of a Jolt specification or the path to a file containing a Jolt specification. 'Jolt Specification' must be set, or the value is ignored if the Jolt Sort Transformation is selected.
This property requires exactly one resource to be provided. That resource may be any of the following types: file, text.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Transform Cache Size | 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. |
| Pretty Print | pretty_print | false | | Apply pretty print formatting to the output of the Jolt transform |
| Max String Length | Max String Length | 20 MB | | The maximum allowed length of a string value when parsing the JSON document |
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 is not valid JSON), it will be routed to this relationship |
Reads Attributes:
None specified.Writes Attributes:
| Name | Description |
|---|
| mime.type | Always set to application/json |
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.