Skip to main content
Version: 5.4

Excel Transfer Object

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

The following properties can be configured:

"File" tab

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 being modified.

Create file:
A new file will be created.

If file does not exist (available when "Edit file" is selected)

Create new file:
If the specified file does not exist, it will be created.

Abort transfer:
If the specified file does not exist, the transfer will be canceled. Unlike "Clear error", the error is not written to the log file here.

Throw 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 being created.

Create from template:
The template from which the file is to be created can be chosen.

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

Spread sheet

Dynamic:
The name of the spreadsheet can be passed dynamically as a parameter at runtime. This is helpful if different spreadsheets are to be edited.

Static:

A static name must be configured in the transfer object. This setting should be used if only one spreadsheet is to be edited.

Static cells

Cells can be specified here in the usual "ColumnRow" notation, for example A1, A2, B3 etc.


The following write modes are available:


Update: Overwrites the specified cell with the new value.


Insert: A new cell is being inserted at the specified position and all cells below it will be moved down.


Append: The content is being inserted into the first free column below the specified cell. This is useful if several data records, for example the results of an SQL select, are to be written to the table.

"Archiving" tab

Archiving

If this option is activated, the Excel file is saved in the selected folder after the changes have been made. The file name is preceded by the timestamp of the creation time. The name of an archived file then looks like this, for example: "2024-07-05_13-29-19_{filename}"

Attention: If transfers are triggered every second, a new archive file is being created every second too.

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 only to be written to one folder.