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. Columns and rows can optionally specify a sheetName in the message send to the component. If omitted, the sheet name from the configuration is used.

Path

Full path to where to write the Excel file without the extension. The path can be overwritten by sending < path: "/path/to/file.xlsx" > to the `Columns` input. The local file system or a cloud storage can be used.

Example:

• File system: C://Users/Bob/Documents/myReport.xlsx. The file name is myReport.
• Cloud storage: <cloud-storage>://Users/Bob/Documents/myReport.xlsx. The file name is myReport.

Sheet name

Name of the sheet. This sheet name is used when no sheetName is provided in the Columns or Rows input.

Example: Report

Split at row number

Splits the sheet into multiple sheets based on the row number specified. If set to 0 the sheet is not split.

Example: 100000

Auto Filter on Each Column

If enabled, an auto filter will be applied to each column in the sheet. This allows for easy filtering of data within the Excel file.

Configuration

Inputs | Outputs

Excel Writer

Columns

Rows

Release

Row Output

Column Output

Error

00 0 (ildyx24)

Use this input to create headers in the sheet. A valid input must be an object containing the columns key (array). This array is populated with objects containing the header and key keys and accepts only the following types: null, string, number, boolean and Date. Optionally, you can also set the width key to set the width of the column in pixels. This input can also be used to override the configured settings path or sheet name. Sending the path key with the full path to the file including the extension will override the configured path. Including a sheetName key to define which sheet the columns belong to will override the configured sheet name. This can also be used to create multiple sheets with different headers in the same file when sending multiple messages with different sheet names.

Example 1: The headers will be Name1 and Name2. You need to use the keys for the headers when adding rows.

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

Example 2: The headers will be Name1 and Name2 and the sheet name will be First sheet, a path is included as well.

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