JoltTransformJSON

JoltTransformJSON 2.0.0

Bundle: org.apache.nifi | nifi-jolt-nar
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.
Tags: cardinality, chainr, defaultr, jolt, json, removr, shiftr, sort, transform
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

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).
Display Name

Custom Module Directory

Description

Comma-separated list of paths to files and/or directories which contain modules containing custom transformations (that are not included on NiFi's classpath).

API Name

Custom Module Directory

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dependencies
- Jolt Transform is set to any of [jolt-transform-custom]
Custom Transformation Class Name
Fully Qualified Class Name for Custom Transformation
Display Name

Custom Transformation Class Name

Description

Fully Qualified Class Name for Custom Transformation

API Name

Custom Transformation Class Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Jolt Transform is set to any of [jolt-transform-custom]
Jolt Specification
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.

Display Name

Jolt Specification

Description

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.

API Name

Jolt Specification

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Jolt Transform
Specifies the Jolt Transformation that should be used with the provided specification.
Display Name

Jolt Transform

Description

Specifies the Jolt Transformation that should be used with the provided specification.

API Name

Jolt Transform

Default Value

jolt-transform-chain

Allowable Values
- Shift
- Chain
- Default
- Remove
- Cardinality
- Sort
- Custom
- Modify - Default
- Modify - Overwrite
- Modify - Define
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Max String Length
The maximum allowed length of a string value when parsing the JSON document

Display Name

Max String Length

Description

The maximum allowed length of a string value when parsing the JSON document

API Name

Max String Length

Default Value

20 MB

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Pretty Print
Apply pretty print formatting to the output of the Jolt transform
Display Name

Pretty Print

Description

Apply pretty print formatting to the output of the Jolt transform

API Name

Pretty Print

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Transform Cache Size
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.

Display Name

Transform Cache Size

Description

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.

API Name

Transform Cache Size

Default Value

1

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
failure	If a FlowFile fails processing for any reason (for example, the FlowFile is not valid JSON), it will be routed to this relationship
success	The FlowFile with transformed content will be routed to this relationship

Writes Attributes

Name	Description
mime.type	Always set to application/json