Skip to main content
Version: Latest (4.63.0)

Excel Writer

The Excel Writer component allows you to write data into an Excel file (.xlsx).

To use it, specify the columns first by using the Columns input. Then add rows by using the Rows input. When you are done adding rows, use the Release input to write the Excel file. You can specify the column width by setting the width in each column.

If you have configured Split at row to a number higher than 0 the file will be written each time the number of rows are equal to the configured value. To write the last lines, you need to trigger the Release input.

The component supports writing to multiple sheets within the same Excel file. To select a sheet from each incoming message, include a sheetName field and set Sheet name to {{ sheetName }}. Otherwise, configure a fixed sheet name. Message fields do not automatically override the component settings.

See how it works:
Excel Writer Explainer

Configuration​

Inputs | Outputs​


Excel Writer
Columns
Rows
Release
Row Output
Column Output
Release Output
Error
00 0 (ildyx24)

Use this input to create headers in the sheet. The Headers setting selects the column array from the incoming message. Each column definition must contain string header and key values. Optionally, set width to specify the column width. To read path or sheetName from the message, configure Path as {{ path }} or Sheet name as {{ sheetName }}.

Example 1: Wrapped columns. Set Headers to {{$ columns }}. The headers will be Name1 and Name2. Use their keys when adding rows.

{
"columns": [
{
"header": "Name1",
"key": "name1"
},
{
"header": "Name2",
"key": "name2",
"width": 50
}
]
}

Example 2: Wrapped columns with a dynamic sheet name and path. Set Headers to {{$ columns }}, Sheet name to {{ sheetName }}, and Path to {{ path }}.

{
"path": "C://test.xlsx",
"sheetName": "First sheet",
"columns": [
{
"header": "Name1",
"key": "name1"
},
{
"header": "Name2",
"key": "name2",
"width": 50
}
]
}

Example 3: Direct column array. Set Headers to {{$root}} and configure a fixed path and sheet name.

[
{ "header": "Name1", "key": "name1" },
{ "header": "Name2", "key": "name2", "width": 50 }
]