To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Parses an incoming Excel workbook and passes its rows, sheets, or the whole workbook to the next step. Configured with either a single next step, which receives the whole parsed workbook, or a list of NextSheetStep entries which route processing per sheet identified by name or index. When a NextSheetStep is set to process rows, that sheet's data rows are read one at a time, converted to a row of cell values, and passed to that sheet's next step; rows whose configured skip-if-blank columns are all empty are skipped, and reading stops early if the pipeline is cancelled, a configured maximum row count is reached, or ten consecutive blank rows are seen. An unreadable or password-protected workbook aborts the pipeline with a failure.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable summary of this step, shown to administrators managing the pipeline: that it parses an incoming Excel workbook into rows, sheets, or the whole workbook for the next step. |
| formPath | String | Path to the Velocity template used by the pipeline management UI to edit this step's configuration. |
| next | PipelineStep | The single next step which is passed the whole parsed workbook when nextSheetSteps is not used. |
| nextSheetSteps | List<NextSheetStep> | The per-sheet routing rules configuring which next step receives each sheet, addressed by name or index. |
| nextStep | PipelineStep | The single configured next step (see getNext()), or null if this step instead routes per sheet via nextSheetSteps. |
| processRows | boolean | Whether each row of the resolved sheet is parsed and passed individually to that sheet's next step, rather than passing the whole sheet or workbook object in a single call. |
| useXml | boolean | Configured flag intended to select between the XSSF (xlsx) and HSSF (xls) POI readers; the workbook format is now auto-detected by WorkbookFactory in exec(), so this flag is not currently read. |
| workbook | Workbook | The workbook parsed from the most recent exec() call. |
Methods
getFormPath()
Returns: String
Path to the Velocity template used by the pipeline management UI to edit this step's configuration.
getDescription()
Returns: String
Human-readable summary of this step, shown to administrators managing the pipeline: that it parses an incoming Excel workbook into rows, sheets, or the whole workbook for the next step.
getNextSheetSteps()
Returns: List<NextSheetStep>
The per-sheet routing rules configuring which next step receives each sheet, addressed by name or index.
getWorkbook()
Returns: Workbook
The workbook parsed from the most recent exec() call.
isUseXml()
Returns: boolean
Configured flag intended to select between the XSSF (xlsx) and HSSF (xls) POI readers; the workbook format is now auto-detected by WorkbookFactory in exec(), so this flag is not currently read.
getNext()
Returns: PipelineStep
The single next step which is passed the whole parsed workbook when nextSheetSteps is not used.
getNextStep()
Returns: PipelineStep
The single configured next step (see getNext()), or null if this step instead routes per sheet via nextSheetSteps.
isProcessRows()
Returns: boolean
Whether each row of the resolved sheet is parsed and passed individually to that sheet's next step, rather than passing the whole sheet or workbook object in a single call.
© 2025 Kademi Ltd