SplitContent

SplitContent 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Splits incoming FlowFiles by a specified byte sequence
Tags: binary, content, split
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Byte Sequence
A representation of bytes to look for and upon which to split the source file into separate files

Display Name

Byte Sequence

Description

A representation of bytes to look for and upon which to split the source file into separate files

API Name

Byte Sequence

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Byte Sequence Format
Specifies how the <Byte Sequence> property should be interpreted
Display Name

Byte Sequence Format

Description

Specifies how the <Byte Sequence> property should be interpreted

API Name

Byte Sequence Format

Default Value

Hexadecimal

Allowable Values
- Hexadecimal
- Text
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Byte Sequence Location
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.
Display Name

Byte Sequence Location

Description

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.

API Name

Byte Sequence Location

Default Value

Trailing

Allowable Values
- Trailing
- Leading
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Keep Byte Sequence
Determines whether or not the Byte Sequence should be included with each Split
Display Name

Keep Byte Sequence

Description

Determines whether or not the Byte Sequence should be included with each Split

API Name

Keep Byte Sequence

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

System Resource Considerations

Resource	Description
MEMORY	The 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.

Relationships

Name	Description
original	The original file
splits	All Splits will be routed to the splits relationship

Writes Attributes

Name	Description
fragment.identifier	All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute
fragment.index	A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile
fragment.count	The number of split FlowFiles generated from the parent FlowFile
segment.original.filename	The filename of the parent FlowFile