Skip to main content

EncodeContent

Description

Encode or decode the contents of a FlowFile using Base64, Base32, or hex encoding schemes

Tags

base32, base64, decode, encode, hex

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Mode *ModeEncode
  • Encode
  • Decode
Specifies whether the content should be encoded or decoded.
Encoding *EncodingBase64
  • Base64
  • Base32
  • Hexadecimal
Specifies the type of encoding used.
Line Output Mode *Line Output ModeSingle Line
  • Single Line
  • Multiple Lines
Controls the line formatting for encoded content based on selected property values.

This property is only considered if:
  • the property Encoding has a value of base32 or base64
  • the property Mode has a value of Encode
Encoded Line Length *Encoded Line Length76Each line of encoded data will contain up to the configured number of characters, rounded down to the nearest multiple of 4.

Supports Expression Language, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property Encoding has a value of base32 or base64
  • the property Line Output Mode has a value of MULTIPLE_LINES
  • the property Mode has a value of Encode

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureAny FlowFile that cannot be encoded or decoded will be routed to failure
successAny FlowFile that is successfully encoded or decoded will be routed to success

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

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

This component does not specify system resource considerations.

See Also