AttributesToCSV

AttributesToCSV 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Generates a CSV representation of the input FlowFile Attributes. The resulting CSV can be written to either a newly generated attribute named 'CSVAttributes' or written to the FlowFile as content. If the attribute value contains a comma, newline or double quote, then the attribute value will be escaped with double quotes. Any double quote characters in the attribute value are escaped with another double quote.
Tags: attributes, csv, flowfile
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Attribute List
Comma separated list of attributes to be included in the resulting CSV. If this value is left empty then all existing Attributes will be included. This list of attributes is case sensitive and supports attribute names that contain commas. If an attribute specified in the list is not found it will be emitted to the resulting CSV with an empty string or null depending on the 'Null Value' property. If a core attribute is specified in this list and the 'Include Core Attributes' property is false, the core attribute will be included. The attribute list ALWAYS wins.

Display Name

Attribute List

Description

Comma separated list of attributes to be included in the resulting CSV. If this value is left empty then all existing Attributes will be included. This list of attributes is case sensitive and supports attribute names that contain commas. If an attribute specified in the list is not found it will be emitted to the resulting CSV with an empty string or null depending on the 'Null Value' property. If a core attribute is specified in this list and the 'Include Core Attributes' property is false, the core attribute will be included. The attribute list ALWAYS wins.

API Name

attribute-list

Expression Language Scope

Environment variables and FlowFile Attributes

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. The final output will contain a combination of matches found in the ATTRIBUTE_LIST and ATTRIBUTE_REGEX.

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. The final output will contain a combination of matches found in the ATTRIBUTE_LIST and ATTRIBUTE_REGEX.

API Name

attributes-regex

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Destination
Control if CSV value is written as a new flowfile attribute 'CSVData' or written in the flowfile content.
Display Name

Destination

Description

Control if CSV value is written as a new flowfile attribute 'CSVData' or written in the 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 CSV value generated. Core attributes will be added to the end of the CSVData and CSVSchema strings. The Attribute List property overrides this setting.
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 CSV value generated. Core attributes will be added to the end of the CSVData and CSVSchema strings. The Attribute List property overrides this setting.

API Name

include-core-attributes

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Include Schema
If true the schema (attribute names) will also be converted to a CSV string which will either be applied to a new attribute named 'CSVSchema' or applied at the first row in the content depending on the DESTINATION property setting.
Display Name

Include Schema

Description

If true the schema (attribute names) will also be converted to a CSV string which will either be applied to a new attribute named 'CSVSchema' or applied at the first row in the content depending on the DESTINATION property setting.

API Name

include-schema

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Null Value
If true a non existing or empty attribute will be 'null' in the resulting CSV. If false an empty string will be placed in the CSV
Display Name

Null Value

Description

If true a non existing or empty attribute will be 'null' in the resulting CSV. If false an empty string will be placed in the CSV

API Name

null-value

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

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

Writes Attributes

Name	Description
CSVSchema	CSV representation of the Schema
CSVData	CSV representation of Attributes