Splits incoming FlowFiles by a specified byte sequence


content, split, binary


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Byte Sequence FormatByte Sequence FormatHexadecimal
  • Hexadecimal The Byte Sequence will be interpreted as a hexadecimal representation of bytes
  • Text The Byte Sequence will be interpreted as UTF-8 Encoded text
Specifies how the <Byte Sequence> property should be interpreted
Byte SequenceByte SequenceA representation of bytes to look for and upon which to split the source file into separate files
Keep Byte SequenceKeep Byte Sequencefalse
  • true
  • false
Determines whether or not the Byte Sequence should be included with each Split
Byte Sequence LocationByte Sequence LocationTrailing
  • Trailing Keep the Byte Sequence at the end of the first split if <Keep Byte Sequence> is true
  • Leading Keep the Byte Sequence at the beginning of the second split if <Keep Byte Sequence> is true
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.


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

Reads Attributes:

None specified.

Writes Attributes:

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
fragment.countThe number of split FlowFiles generated from the parent FlowFile
segment.original.filename The filename of the parent FlowFile

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

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: