Skip to main content

SplitExcel

Description

Splits a multi sheet Microsoft Excel spreadsheet into multiple Microsoft Excel spreadsheets where each sheet from the original file is converted to an individual spreadsheet in its own flow file. This processor is currently only capable of processing .xlsx (XSSF 2007 OOXML file format) Excel documents and not older .xls (HSSF '97(-2007) file format) documents. NOTE: All original cell styles are dropped when splitting into multiple Microsoft Excel spreadsheets.

Tags

split, text

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
Protection Type *Protection TypeUnprotected
  • Unprotected
  • Password Protected
Specifies whether an Excel spreadsheet is protected by a password or not.
Password *PasswordThe password for a password protected Excel spreadsheet

This property is only considered if:
  • the property Protection Type has a value of PASSWORD

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureIf a FlowFile cannot be transformed from the configured input format to the configured output format, the unchanged FlowFile will be routed to this relationship.
originalThe original FlowFile that was split into segments. If the FlowFile fails processing, nothing will be sent to this relationship
splitThe individual Excel 'segments' of the original Excel FlowFile will be routed to this relationship.

Reads Attributes

This processor does not read attributes.

Writes Attributes

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

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