To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Builds an Excel workbook from incoming pipeline rows and writes it to the pipeline's output. Each call to exec() writes one row of cell values into the current sheet, mapping each incoming value to a column either by its position against the configured headers or by an explicit Column definition. The output workbook format (xls, xlsx or xlsm) is set by type, an optional header row is written first when headers is configured, and the finished workbook can optionally be password-protected when writing an xlsx file.
Implements: PipelineStep
Properties
| Property | Returns | Description |
|---|---|---|
| currentCell | Cell | The cell last created by getNextCell() for the current row. |
| currentRow | Row | The row currently being written to, looked up from the current sheet by row number if not already cached. |
| description | String | Human-readable summary of this step, shown to administrators managing the pipeline: that it builds an Excel workbook from incoming rows. |
| firstSheetTitle | String | The name given to the first sheet created in the output workbook. |
| formPath | String | Path to the Velocity template used by the pipeline management UI to edit this step's configuration. |
| headers | List<String> | Column header values written as the first row of the first sheet, and used to map row values to columns by name when writing. |
| next | PipelineStep | The single step that follows this one once the workbook has been written. |
| nextCell | Cell | Creates a new cell in the current row at the next column index and advances the column cursor. |
| nextRow | Row | Creates a new row in the current sheet at the next row index and advances the row cursor, ready for column values to be written into it. |
| nextStep | PipelineStep | The single step that follows this one, same as getNext(). |
| password | String | Password used to encrypt the output workbook; only applied when writing an xlsx workbook. |
| type | String | The output workbook format: "xlsx", "xlsm", or any other value (including unset) for the legacy "xls" format. |
| workbook | Workbook | The Apache POI workbook being built by this step. |
Methods
getFormPath() · getDescription() · getNext() · getNextStep() · getWorkbook() · getCurrentRow() · getNextRow() · getNextCell() · getCurrentCell() · getFirstSheetTitle() · getHeaders() · getType() · getPassword()
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 builds an Excel workbook from incoming rows.
getNext()
Returns: PipelineStep
The single step that follows this one once the workbook has been written.
getNextStep()
Returns: PipelineStep
The single step that follows this one, same as getNext().
getWorkbook()
Returns: Workbook
The Apache POI workbook being built by this step.
getCurrentRow()
Returns: Row
The row currently being written to, looked up from the current sheet by row number if not already cached.
getNextRow()
Returns: Row
Creates a new row in the current sheet at the next row index and advances the row cursor, ready for column values to be written into it.
getNextCell()
Returns: Cell
Creates a new cell in the current row at the next column index and advances the column cursor.
getCurrentCell()
Returns: Cell
The cell last created by getNextCell() for the current row.
getFirstSheetTitle()
Returns: String
The name given to the first sheet created in the output workbook.
getHeaders()
Returns: List<String>
Column header values written as the first row of the first sheet, and used to map row values to columns by name when writing.
getType()
Returns: String
The output workbook format: "xlsx", "xlsm", or any other value (including unset) for the legacy "xls" format.
getPassword()
Returns: String
Password used to encrypt the output workbook; only applied when writing an xlsx workbook.
© 2025 Kademi Ltd