AttributesToJSON

AttributesToJSON 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Generates a JSON representation of the input FlowFile Attributes. The resulting JSON can be written to either a new Attribute 'JSONAttributes' or written to the FlowFile as content. Attributes which contain nested JSON objects can either be handled as JSON or as escaped JSON depending on the strategy chosen.
Tags: attributes, flowfile, json
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Attributes List
Comma separated list of attributes to be included in the resulting JSON. If this value is left empty then all existing Attributes will be included. This list of attributes is case sensitive. If an attribute specified in the list is not found it will be be emitted to the resulting JSON with an empty string or NULL value.

Display Name

Attributes List

Description

Comma separated list of attributes to be included in the resulting JSON. If this value is left empty then all existing Attributes will be included. This list of attributes is case sensitive. If an attribute specified in the list is not found it will be be emitted to the resulting JSON with an empty string or NULL value.

API Name

Attributes List

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Attributes Regular Expression
Regular expression that will be evaluated against the flow file attributes to select the matching attributes. This property can be used in combination with the attributes list property.

Display Name

Attributes Regular Expression

Description

Regular expression that will be evaluated against the flow file attributes to select the matching attributes. This property can be used in combination with the attributes list property.

API Name

attributes-to-json-regex

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Destination
Control if JSON value is written as a new flowfile attribute 'JSONAttributes' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.
Display Name

Destination

Description

Control if JSON value is written as a new flowfile attribute 'JSONAttributes' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.

API Name

Destination

Default Value

flowfile-attribute

Allowable Values
- flowfile-attribute
- flowfile-content
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Include Core Attributes
Determines if the FlowFile org.apache.nifi.flowfile.attributes.CoreAttributes which are contained in every FlowFile should be included in the final JSON value generated.
Display Name

Include Core Attributes

Description

Determines if the FlowFile org.apache.nifi.flowfile.attributes.CoreAttributes which are contained in every FlowFile should be included in the final JSON value generated.

API Name

Include Core Attributes

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
JSON Handling Strategy
Strategy to use for handling attributes which contain nested JSON.
Display Name

JSON Handling Strategy

Description

Strategy to use for handling attributes which contain nested JSON.

API Name

JSON Handling Strategy

Default Value

ESCAPED

Allowable Values
- Escaped
- Nested
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Null Value
If true a non existing selected attribute will be NULL in the resulting JSON. If false an empty string will be placed in the JSON
Display Name

Null Value

Description

If true a non existing selected attribute will be NULL in the resulting JSON. If false an empty string will be placed in the JSON

API Name

Null Value

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Pretty Print
Apply pretty print formatting to the output.
Display Name

Pretty Print

Description

Apply pretty print formatting to the output.

API Name

Pretty Print

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Destination is set to any of [flowfile-content]

Relationships

Name	Description
failure	Failed to convert attributes to JSON
success	Successfully converted attributes to JSON

Writes Attributes

Name	Description
JSONAttributes	JSON representation of Attributes