JSLTTransformJSON

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:

json, jslt, transform

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 NameAPI NameDefault ValueAllowable ValuesDescription
JSLT Transformationjslt-transform-transformationJSLT 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

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)
Transformation Strategyjslt-transform-transformation-strategyEntire FlowFile
  • Entire FlowFile Apply transformation to entire FlowFile content JSON
  • Each JSON Object Apply transformation each JSON Object in an array
Whether to apply the JSLT transformation to the entire FlowFile contents or each JSON object in the root-level array
Pretty Printjslt-transform-pretty_printfalse
  • true
  • false
Apply pretty-print formatting to the output of the JSLT transform
Transform Cache Sizejslt-transform-cache-size1Compiling 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.

Relationships:

NameDescription
successThe FlowFile with transformed content will be routed to this relationship
failureIf 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:

NameDescription
mime.typeAlways 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:

ResourceDescription
MEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.