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. No plug-in configuration is necessary; you can configure the transfer object directly within the flow as described.

Transfer objects are available as sources and destinations. 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 in the Excel file. No plug-in configuration is necessary; you can configure the transfer object directly within the flow 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 when 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 when 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 when “Edit file” is selected)	Create new file: If the specified file does not exist, it will be created. Cancel transfer: If the specified file does not exist, the transfer is canceled. Unlike with "Trigger error," the error is not written to the log file here. 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 an empty file: An empty file is created. Create from Template: You can select a template to use for creating the file.
Template (available when “Create file” is selected)	Dynamic: The file path to the template can be passed dynamically as a parameter at runtime. This is helpful when 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 when 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 when different files need to be written to or edited. Static: A static file path must be configured in the transfer object. This setting should be used when 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 when “Edit file” is selected)	Create new file: If the specified file does not exist, it will be created. Cancel transfer: If the specified file does not exist, the transfer will be canceled. Unlike with "Read Error," the error is not written to the log file here. Trigger error: If the specified file does not exist, an error is triggered. This causes the transfer to be canceled.
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 when 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 when 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 when you need to edit different worksheets. Static: A static name must be configured in the transfer object. This setting should be used when only one worksheet is to be processed.
Static Cells	Here, cells can be specified using the standard “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: A new cell is inserted at the specified position, and all cells below it are shifted downward. Append: The content is inserted into the first available column below the specified cell. This mode is useful when writing multiple data records—such as the results of an SQL SELECT query—to the table.

"Archiving" tab

Property	Description
Archive	If this option is enabled, the Excel file is saved to the selected folder after the 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_{filename}” Note: If transfers are triggered every second, a new archive file is created every second.
Archive Folder	Dynamic: The folder path can be passed dynamically as a parameter at runtime. This is helpful when 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 when archive files are to be written to only one folder.