Skip to main content

SplitContent

Description

Splits incoming FlowFiles by a specified byte sequence

Tags

binary, content, split

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
Byte Sequence Format *Byte Sequence FormatHexadecimal
  • Hexadecimal
  • Text
Specifies how the <Byte Sequence> property should be interpreted
Byte Sequence *Byte SequenceA representation of bytes to look for and upon which to split the source file into separate files
Keep Byte Sequence *Keep Byte Sequencefalse
  • true
  • false
Determines whether or not the Byte Sequence should be included with each Split
Byte Sequence Location *Byte Sequence LocationTrailing
  • Trailing
  • Leading
If <Keep Byte Sequence> is set to true, specifies whether the byte sequence should be added to the end of the first split or the beginning of the second; if <Keep Byte Sequence> is false, this property is ignored.

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
originalThe original file
splitsAll Splits will be routed to the splits relationship

Reads Attributes

This processor does not read attributes.

Writes Attributes

NameDescription
fragment.countThe number of split FlowFiles generated from the parent FlowFile
fragment.identifierAll split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute
fragment.indexA one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile
segment.original.filenameThe filename of the parent FlowFile

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

ScopeDescription
MEMORYThe FlowFile with its attributes is stored in memory, not the content of the FlowFile. If many splits are generated due to the size of the content, or how the content is configured to be split, a two-phase approach may be necessary to avoid excessive use of memory.

See Also

MergeContent