0 ×

Excel Writer

StreamableKNIME POI (Excel) Plug-in version 4.3.3.v202104260900 by KNIME AG, Zurich, Switzerland

This node supports the path flow variable. For further information about file handling in general see the File Handling Guide.

This node writes the input data table into a spreadsheet of an Excel file. The files can then be read with other applications such as Microsoft Excel.
Adding additional sheet input ports allows to write multiple spreadsheets to the same file. Furthermore, it is also possible to append sheets to an already existing excel file by selecting the append option.

The node supports two formats chosen by file extension:

  • .xls format: This is the file format which was used by default up until Excel 2003. The maximum number of columns held by a spreadsheet of this format is 256. If the input data table has more than 65536 rows, it is split into multiple spreadsheets.
  • .xlsx format: The Office Open XML format is the file format used by default from Excel 2007 onwards. The maximum number of columns held by a spreadsheet of this format is 16384. If the input data table has more than 1048576 rows, it is split into multiple spreadsheets.

This nodes does not support writing files in the 'xlsm' format, yet appending is supported.

Options

Write to
Select a file system in which you want to store the file. There are four default file system options to choose from:
  • Local File System: Allows you to select a location on your local system.
  • Mountpoint: Allows you to write to a mountpoint. When selected, a new drop-down menu appears to choose the mountpoint. Unconnected mountpoints are greyed out but can still be selected (note that browsing is disabled in this case). Go to the KNIME Explorer and connect to the mountpoint to enable browsing. A mountpoint is displayed in red if it was previously selected but is no longer available. You won't be able to save the dialog as long as you don't select a valid, i.e. known, mountpoint.
  • Relative to: Allows you to choose whether to resolve the path relative to the current mountpoint, current workflow, or the current workflow's data area. When selected, a new drop-down menu appears to choose which of the three options to use.
  • Custom/KNIME URL: Allows to specify a URL (e.g. file://, http:// or knime:// protocol). When selected, a spinner appears that allows you to specify the desired connection and write timeout in milliseconds. In case it takes longer to connect to the host / write the file, the node fails to execute. Browsing is disabled for this option.
It is possible to use other file systems with this node. For this you have to enable the file system connection input port of this node by clicking the ... in the bottom left corner of the node's icon and choose Add File System Connection port .
Afterwards, you can simply connect the desired connector node to this node. The file system connection will then be shown in the drop-down menu. It is greyed out if the file system is not connected, in which case you have to (re)execute the connector node first. Note: The default file systems listed above can't be selected if a file system is provided via the input port.
File/URL
Enter a URL when writing to Custom/KNIME URL, otherwise enter a path to a file. The required syntax of a path depends on the chosen file system, such as "C:\path\to\file" (Local File System on Windows) or "/path/to/file" (Local File System on Linux/MacOS and Mountpoint). For file systems connected via input port, the node description of the respective connector node describes the required path format. You can also choose a previously selected file from the drop-down list, or select a location from the "Browse..." dialog. Note that browsing is disabled in some cases:
  • Custom/KNIME URL: Browsing is always disabled.
  • Mountpoint: Browsing is disabled if the selected mountpoint isn't connected. Go to the KNIME Explorer and connect to the mountpoint to enable browsing.
  • File systems provided via input port: Browsing is disabled if the connector node hasn't been executed since the workflow has been opened. (Re)execute the connector node to enable browsing.
The location can be exposed as or automatically set via a path flow variable.
Create missing folders
Select if the folders of the selected output location should be created if they do not already exist. If this option is unchecked, the node will fail if a folder does not exist.
If exists
Specify the behavior of the node in case the output file already exists.
  • Overwrite: Will replace any existing file.
  • Append: Will append the input tables to the existent Excel file.
  • Fail: Will issue an error during the node's execution (to prevent unintentional overwrite).
Sheet name
Name of the spreadsheets that will be created.
If sheet exists
Fail will abort the execution if a sheet with the given file name already exists, otherwise the sheet will be replaced. This option is only relevant if the append option is selected.
Write row key
If checked, the row IDs are added to the output, in the first column of the spreadsheet.
Write column headers
If checked, the column names are written out in the first row of the spreadsheet.
Replaces missing values by
If selected missing values will be replaced by the specified value, otherwise a blank cell is being created.
Evaluate formulas
If checked, all formulas in the file will be evaluated after the sheet has been written. This is useful if other sheets in the file refer to the data just written and their content needs updating. This option is only relevant if the append option is selected.
Autosize columns
Fits each column's width to its content.
Portrait/Landscape
Sets the print format to portrait or landscape.
Paper size
Sets the paper size in the print setup.

Input Ports

Icon
The data table to write.

Workflows

Installation

To use this node in KNIME, install KNIME Excel Support from the following update site:

KNIME 4.3

A zipped version of the software site can be downloaded here.

You don't know what to do with this link? Read our NodePit Product and Node Installation Guide that explains you in detail how to install nodes to your KNIME Analytics Platform.

Wait a sec! You want to explore and install nodes even faster? We highly recommend our NodePit for KNIME extension for your KNIME Analytics Platform. Browse NodePit from within KNIME, install nodes with just one click and share your workflows with NodePit Space.

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.