XMLRecordSetWriter

Array Tag Name

Name of the tag used by property "Wrap Elements of Arrays" to write arrays

Display Name: Array Tag Name
Description: Name of the tag used by property "Wrap Elements of Arrays" to write arrays
API Name: array_tag_name
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Wrap Elements of Arrays

Specifies how the writer wraps elements of fields of type array

Display Name

Wrap Elements of Arrays

Description

Specifies how the writer wraps elements of fields of type array

API Name

array_wrapping

Default Value

no-wrapping

Allowable Values

Use Property as Wrapper
Use Property for Elements
No Wrapping

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Character Set

The Character set to use when writing the data to the FlowFile

Display Name: Character Set
Description: The Character set to use when writing the data to the FlowFile
API Name: Character Set
Default Value: UTF-8
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Date Format

Specifies the format to use when reading/writing Date fields. If not specified, Date fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters, as in 01/01/2017).

Display Name: Date Format
Description: Specifies the format to use when reading/writing Date fields. If not specified, Date fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters, as in 01/01/2017).
API Name: Date Format
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Omit XML Declaration

Specifies whether or not to include XML declaration

Display Name

Omit XML Declaration

Description

Specifies whether or not to include XML declaration

API Name

omit_xml_declaration

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Pretty Print XML

Specifies whether or not the XML should be pretty printed

Display Name

Pretty Print XML

Description

Specifies whether or not the XML should be pretty printed

API Name

pretty_print_xml

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Name of Record Tag

Specifies the name of the XML record tag wrapping the record fields. If this is not set, the writer will use the record name in the schema.

Display Name: Name of Record Tag
Description: Specifies the name of the XML record tag wrapping the record fields. If this is not set, the writer will use the record name in the schema.
API Name: record_tag_name
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Name of Root Tag

Specifies the name of the XML root tag wrapping the record set. This property has to be defined if the writer is supposed to write multiple records in a single FlowFile.

Display Name: Name of Root Tag
Description: Specifies the name of the XML root tag wrapping the record set. This property has to be defined if the writer is supposed to write multiple records in a single FlowFile.
API Name: root_tag_name
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Schema Reference Writer

Service implementation responsible for writing FlowFile attributes or content header with Schema reference information

Display Name

Schema Reference Writer

Description

Service implementation responsible for writing FlowFile attributes or content header with Schema reference information

API Name

Schema Reference Writer

Service Interface

org.apache.nifi.schemaregistry.services.SchemaReferenceWriter

Service Implementations

org.apache.nifi.confluent.schemaregistry.ConfluentEncodedSchemaReferenceWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies

Schema Write Strategy is set to any of [schema-reference-writer]

Schema Write Strategy

Specifies how the schema for a Record should be added to the data.

Display Name

Schema Write Strategy

Description

Specifies how the schema for a Record should be added to the data.

API Name

Schema Write Strategy

Default Value

no-schema

Allowable Values

Do Not Write Schema
Set 'schema.name' Attribute
Set 'avro.schema' Attribute
Schema Reference Writer

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Schema Access Strategy

Specifies how to obtain the schema that is to be used for interpreting the data.

Display Name

Schema Access Strategy

Description

Specifies how to obtain the schema that is to be used for interpreting the data.

API Name

schema-access-strategy

Default Value

inherit-record-schema

Allowable Values

Inherit Record Schema
Use 'Schema Name' Property
Use 'Schema Text' Property

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Schema Branch

Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.

Display Name

Schema Branch

Description

Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.

API Name

schema-branch

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies

Schema Access Strategy is set to any of [schema-name]

Schema Cache

Specifies a Schema Cache to add the Record Schema to so that Record Readers can quickly lookup the schema.

Display Name: Schema Cache
Description: Specifies a Schema Cache to add the Record Schema to so that Record Readers can quickly lookup the schema.
API Name: schema-cache
Service Interface: org.apache.nifi.serialization.RecordSchemaCacheService
Service Implementations: org.apache.nifi.schema.inference.VolatileSchemaCache
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Schema Name

Specifies the name of the schema to lookup in the Schema Registry property

Display Name

Schema Name

Description

Specifies the name of the schema to lookup in the Schema Registry property

API Name

schema-name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies

Schema Access Strategy is set to any of [schema-name]

Schema Reference Reader

Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier

Display Name

Schema Reference Reader

Description

Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier

API Name

schema-reference-reader

Service Interface

org.apache.nifi.schemaregistry.services.SchemaReferenceReader

Service Implementations

org.apache.nifi.confluent.schemaregistry.ConfluentEncodedSchemaReferenceReader

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies

Schema Access Strategy is set to any of [schema-reference-reader]

Schema Registry

Specifies the Controller Service to use for the Schema Registry

Display Name

Schema Registry

Description

Specifies the Controller Service to use for the Schema Registry

API Name

schema-registry

Service Interface

org.apache.nifi.schemaregistry.services.SchemaRegistry

Service Implementations

org.apache.nifi.aws.schemaregistry.AmazonGlueSchemaRegistry

org.apache.nifi.apicurio.schemaregistry.ApicurioSchemaRegistry

org.apache.nifi.schemaregistry.services.AvroSchemaRegistry

org.apache.nifi.confluent.schemaregistry.ConfluentSchemaRegistry

org.apache.nifi.db.schemaregistry.DatabaseTableSchemaRegistry

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies

Schema Access Strategy is set to any of [schema-reference-reader, schema-name]

Schema Text

The text of an Avro-formatted Schema

Display Name

Schema Text

Description

The text of an Avro-formatted Schema

API Name

schema-text

Default Value

${avro.schema}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies

Schema Access Strategy is set to any of [schema-text-property]

Schema Version

Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.

Display Name

Schema Version

Description

Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.

API Name

schema-version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies

Schema Access Strategy is set to any of [schema-name]

Suppress Null Values

Specifies how the writer should handle a null field

Display Name

Suppress Null Values

Description

Specifies how the writer should handle a null field

API Name

suppress_nulls

Default Value

never-suppress

Allowable Values

Never Suppress
Always Suppress
Suppress Missing Values

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Time Format

Specifies the format to use when reading/writing Time fields. If not specified, Time fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, HH:mm:ss for a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 18:04:15).

Display Name: Time Format
Description: Specifies the format to use when reading/writing Time fields. If not specified, Time fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, HH:mm:ss for a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 18:04:15).
API Name: Time Format
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Timestamp Format

Specifies the format to use when reading/writing Timestamp fields. If not specified, Timestamp fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy HH:mm:ss for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters; and then followed by a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 01/01/2017 18:04:15).

Display Name: Timestamp Format
Description: Specifies the format to use when reading/writing Timestamp fields. If not specified, Timestamp fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java java.time.format.DateTimeFormatter format (for example, MM/dd/yyyy HH:mm:ss for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters; and then followed by a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 01/01/2017 18:04:15).
API Name: Timestamp Format
Expression Language Scope: Not Supported
Sensitive: false
Required: false

XMLRecordSetWriter 2.0.0