Skip to content

Write Dataset to Excel Activity

The Write Dataset to Excel activity enables users to persist changes from a dataset into a specified Excel file. This activity ensures that processed data is accurately recorded in the target spreadsheet, facilitating data integration and reporting.

Field Description Requirement
Excel Name The reference name of an already opened or created Excel file. Required
Dataset Name The reference name of an already created dataset. Required
Sheet name/index The name or numerical index of the sheet within the Excel file. If not specified, the first sheet is used by default. Optional
Destination The starting cell address (e.g., "A1") from which the dataset will be written. If left blank, the dataset is written directly into the Excel file, starting from the current range. Optional
Shift Specifies how the dataset is written to the Excel file, particularly when existing data is present. Required
Include Header Set to true if the dataset includes column headers that should be written to Excel. Optional

Action Types & Examples

NONE

  • Format: [string]
  • Example Result: "NONE"
  • Format: [string]
  • Example Result: "RIGHT"

DOWN

  • Format: [string]
  • Example Result: "DOWN"

Implementation Examples

Field Setup

  • Excel Name: ${newExcel}
  • Dataset Name: ${newDataset}
  • Sheet name/index: Sheet1
  • Destination: A1
  • Include Header: true

Execution Parameters

  • Shift: NONE

Technical Notes

Sheet name/index accepts either the sheet's name (e.g., Sheet1) or its numerical position within the workbook (e.g., 1 for the first sheet), matching the sheet selection behavior of the standard Excel component. When specifying a Destination cell, if the target range already contains data, the dataset will be written adjacent to the existing data. The Shift parameter dictates how existing data is handled during the write operation.