Creates Excel .xlsx workbook streams from row-shaped data, reads worksheet rows back into objects, and appends new worksheets to an existing workbook.
- 0.0.0.11 - 2026/04/13 - Initial release.
- 0.0.0.12 - 2026/05/12 - Current source exposes Create, Parse, and AddSheet methods with typed column handling, header control, and worksheet append support.
- 0.0.0.14 - 2026/05/13 - Added automatic default worksheet naming for AddSheet when WorksheetName is left blank, and clarified worksheet option behavior.
- Provide workbook content as an
.xlsx document stream when using Parse or AddSheet.
Create and AddSheet expect every item in Items to be an object where each property represents a worksheet column value.- When
Options.Columns is supplied, column names must be unique and each entry must include Name.
- Supported column type values are
Auto, String, Number, Date, DateTime, and Boolean.
The node exposes methods to create a workbook, parse one worksheet into objects, and add a worksheet to an existing workbook.
Creates a new Excel workbook from object rows. Use this when you want to generate a workbook from workflow data and optionally force Excel cell types per column.
| Parameter |
Type |
Description |
Items |
Array |
Object rows to write into the worksheet. Each object becomes one worksheet row. |
Options |
Object |
Optional settings for workbook creation. Supports WorksheetName, FirstRowContainsColumnHeaders, and Columns. WorksheetName defaults to Sheet1. FirstRowContainsColumnHeaders defaults to true. Columns is an ordered list of column definitions with Name and Type. |
| Return |
Type |
Description |
Document |
Stream |
Generated .xlsx workbook stream. |
Reads one worksheet from an Excel workbook and returns each row as an object. Use this when you need worksheet data back in a workflow-friendly object format.
| Parameter |
Type |
Description |
Document |
Stream |
The Excel workbook to parse. |
Options |
Object |
Optional settings for worksheet selection and header handling. Supports WorksheetName and FirstRowContainsColumnHeaders. When WorksheetName is omitted, the first worksheet is used. FirstRowContainsColumnHeaders defaults to true. |
| Return |
Type |
Description |
Rows |
Array |
Parsed row objects from the selected worksheet. |
Adds a new worksheet to an existing Excel workbook without replacing the workbook's existing sheets. Use this when you need to extend a workbook with another tab of workflow data.
| Parameter |
Type |
Description |
Document |
Stream |
The existing Excel workbook to update. |
Items |
Array |
Object rows to write into the new worksheet. Each object becomes one worksheet row. |
Options |
Object |
Optional settings for the new worksheet. Supports WorksheetName, FirstRowContainsColumnHeaders, and Columns. If WorksheetName is left blank, the node starts at Sheet1 and automatically increments to the next available default worksheet name when needed. FirstRowContainsColumnHeaders defaults to true. Columns is an ordered list of column definitions with Name and Type. |
| Return |
Type |
Description |
UpdatedDocument |
Stream |
Updated .xlsx workbook stream containing the appended worksheet. |
- When
Options.Columns is not supplied for Create or AddSheet, column order is taken from the first row in Items.
- When
FirstRowContainsColumnHeaders is false and Options.Columns is not supplied, the node still uses the first row to determine column order, but writes that first row as data instead of using it as worksheet headers.
- Set
Options.FirstRowContainsColumnHeaders to false when the worksheet should contain only data rows, or when parsing a worksheet whose first row should be treated as data.
String column typing preserves text values as strings in the workbook, while Number, Date, DateTime, and Boolean write the corresponding Excel cell types.- When
AddSheet leaves WorksheetName blank, the node preserves existing sheets and appends the new worksheet using the next available default worksheet name such as Sheet2 or Sheet3.
- If
Parse is used with FirstRowContainsColumnHeaders set to false, returned properties are named Column1, Column2, and so on.
Parse reads one worksheet per invocation rather than returning all worksheets from a workbook in one pass.- Date parsing depends on workbook cell styles being present and recognizable as date-like number formats.