Skip to main content

SegmentContent

Description

Segments a FlowFile into multiple smaller segments on byte boundaries. Each segment is given the following attributes: fragment.identifier, fragment.index, fragment.count, segment.original.filename; these attributes can then be used by the MergeContent processor in order to reconstitute the original FlowFile

Tags

segment, 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
Segment Size *Segment SizeThe maximum data size in bytes for each segment

Supports Expression Language, using FlowFile attributes and Environment variables.

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
originalThe original FlowFile will be sent to this relationship
segmentsAll segments will be sent to this relationship. If the file was small enough that it was not segmented, a copy of the original is sent to this relationship as well as original

Reads Attributes

This processor does not read attributes.

Writes Attributes

NameDescription
fragment.countThe number of segments generated from the parent FlowFile
fragment.identifierAll segments 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 segments that were created from a single parent FlowFile
segment.original.filenameThe filename of the parent FlowFile
segment.original.filenameThe filename will be updated to include the parent's filename, the segment index, and the segment count

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

MergeContent