JSLTTransformJSON

JSLTTransformJSON 2.0.0

Bundle: org.apache.nifi | nifi-jslt-nar
Description: Applies a JSLT transformation to the FlowFile JSON payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the JSLT transform fails, the original FlowFile is routed to the 'failure' relationship.
Tags: jslt, json, transform
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Transform Cache Size
Compiling a JSLT 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 JSLT 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

jslt-transform-cache-size

Default Value

1

Expression Language Scope

Not Supported

Sensitive

false

Required

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

Pretty Print

Description

Apply pretty-print formatting to the output of the JSLT transform

API Name

jslt-transform-pretty_print

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Transform Result Filter
A filter for output JSON results using a JSLT expression. This property supports changing the default filter, which removes JSON objects with null values, empty objects and empty arrays from the output JSON. This JSLT must return true for each JSON object to be included and false for each object to be removed. Using a filter value of "true" to disables filtering.

Display Name

Transform Result Filter

Description

A filter for output JSON results using a JSLT expression. This property supports changing the default filter, which removes JSON objects with null values, empty objects and empty arrays from the output JSON. This JSLT must return true for each JSON object to be included and false for each object to be removed. Using a filter value of "true" to disables filtering.

API Name

jslt-transform-result-filter

Default Value

. != null and . != {} and . != []

Expression Language Scope

Not Supported

Sensitive

false

Required

true
JSLT Transformation
JSLT Transformation for transform of JSON data. Any NiFi Expression Language present will be evaluated first to get the final transform to be applied. The JSLT Tutorial provides an overview of supported expressions: https://github.com/schibsted/jslt/blob/master/tutorial.md

Display Name

JSLT Transformation

Description

JSLT Transformation for transform of JSON data. Any NiFi Expression Language present will be evaluated first to get the final transform to be applied. The JSLT Tutorial provides an overview of supported expressions: https://github.com/schibsted/jslt/blob/master/tutorial.md

API Name

jslt-transform-transformation

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Transformation Strategy
Whether to apply the JSLT transformation to the entire FlowFile contents or each JSON object in the root-level array
Display Name

Transformation Strategy

Description

Whether to apply the JSLT transformation to the entire FlowFile contents or each JSON object in the root-level array

API Name

jslt-transform-transformation-strategy

Default Value

EACH_OBJECT

Allowable Values
- Entire FlowFile
- Each JSON Object
Expression Language Scope

Not Supported

Sensitive

false

Required

true

System Resource Considerations

Resource	Description
MEMORY	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.

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

Writes Attributes

Name	Description
mime.type	Always set to application/json