Excel transfer object

Excel transfer objects are available as sources and targets. You can write data to defined cells or read from them. You can also write multiple records from the database (SQL SELECT) to multiple rows in the Excel file. No plug-in configuration is necessary; you can configure the transfer object directly within the connection as described.

Transfer objects are available as sources and targets. You can write data to defined cells or read data from them. You can also write multiple records from the database (SQL SELECT) to multiple rows of the Excel file. No plug-in configuration is necessary; you can directly project the transfer object within the connection as described.

The following properties can be configured:

"File" tab

Property	Description
File	Dynamic: The file path can be passed dynamically as a parameter at runtime. This is helpful if different files are to be written or edited. Static: A static file path must be configured in the transfer object. This setting should be used if only one file is to be written or edited.
Action	Edit file: An existing file is modified. Create file: A new file is created.
If file does not exist (available if "Edit file" is selected)	Create new file: If the specified file does not exist, it is created. Cancel transfer: If the specified file does not exist, the transfer is canceled. Unlike "Trigger error," the error is not written to the log file. Trigger error: If the specified file does not exist, an error is triggered. This cancels the transfer.
Options (available when "Create file" is selected)	Create empty file: An empty file is created. Create from template: A template can be selected to be used for creating the file.
Template (available if "Create file" is selected)	Dynamic: The file path to the template can be passed dynamically as a parameter at runtime. This is helpful if different files are to be written or edited. Static: A static file path must be configured in the transfer object. This setting should be used if only one file is to be written or edited.

Property	Description
File	Dynamic: The file path can be passed dynamically as a parameter at runtime. This is helpful if different files need to be written or edited. Static: A static file path must be configured in the transfer object. This setting should be used if only one file is to be written or edited.
Action	Edit file: An existing file is modified. Create file: A new file is created.
If file does not exist (available if "Edit file" is selected)	Create new file: If the specified file does not exist, it is created. Cancel transfer: If the specified file does not exist, the transfer is canceled. Unlike "Trigger error," the error is not written to the log file. Trigger error: If the specified file does not exist, an error is triggered. This cancels the transfer.
Options (available when "Create file" is selected)	Create empty file: Create from template:
Template (available if "Create file" is selected)	Dynamic: The file path to the template can be passed dynamically as a parameter at runtime. This is helpful if different files are to be written or edited. Static: A static file path must be configured in the transfer object. This setting should be used if only one file is to be written or edited.

"Cells" tab

Property	Description
Worksheet	Dynamic: The name of the worksheet can be passed dynamically as a parameter at runtime. This is helpful if different worksheets are to be edited. Static: A static name must be configured in the transfer object. This setting should be used if only one worksheet is to be edited.
Static cells	Here, cells can be specified in the usual "column row" notation, for example A1, A2, B3, etc. The following write modes are available: Update: Overwrites the specified cell with the new value. Insert: Inserts a new cell at the specified position and moves all cells below it down. Append: The content is inserted in the first free column below the specified cell. This mode is useful if you want to write multiple data records, for example, the results of an SQL select, to the table.

"Archiving" tab

Property	Description
Archive	When this option is enabled, the Excel file is saved in the selected folder after changes are made. The file name is prefixed with the timestamp of the creation time. The name of an archived file has the following format: "2024-07-05_13-29-19_{file name}" Please note: If transfers are triggered every second, a new archive file will also be created every second.
Archive folder	Dynamic: The folder path can be passed dynamically as a parameter at runtime. This is helpful if archive files are to be written to different folders. Static: A static folder path must be configured in the transfer object. This setting should be used if archive files are to be written to only one folder.