Skip to main content
Version: 4.51.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.

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.

Display Settings
Path

Full path to where to write the Excel file without the extension. The extension will automatically be added. However, the path can be overwritten by sending { path: "/path/to/file.xlsx" } to the Release input. The local file system or a cloud storage can be used. In order to access the local filesystem, the XILL4_WORKDIRS environment variable must be set to the path of the directory to be accessed.

Example:

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

Name of the sheet.

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

Configuration

Inputs | Outputs


Excel Writer
Rows
Columns
Release
Row Output
Column Output
Error
0 0 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.

Example: 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"
}
]
}