Read Range (Excel)

Reads cells from an Excel sheet into a DataTable.

Behaviour

Risk: None · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash

Package Excel activities Velophex.Excel.Activities 0.7.1-rc.7 · Supported (Core profile) · type id velophex.excel.readRange

Properties#

Input#

Sheet#

Sheet · String · Required · Default: Sheet1

The name of the sheet, for example Sheet1.

Range#

Range · String · Optional · Default: Not specified in package metadata

The cell range in A1 notation (e.g. 'A1:C10'). Leave empty to read the entire used range.

Workbook#

Workbook · ExcelWorkbookReference · Optional · Default: Not specified in package metadata

The Excel file to use. Empty uses the innermost enclosing Use Excel File; set it to the Reference As name of a Use Excel File to use that one.

Options#

Has Headers#

HasHeaders · Boolean · Optional · Default: True

True if the first row contains column headers.

Output#

Data Table#

DataTable · DataTable · Output

The resulting DataTable with the read range data.

Rules#

  • Must be inside Use Excel File.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Excel. Keywords: excel, workbook, xlsx, spreadsheet, range, read, datatable, table.

Properties

Input

Options

Output

Rules

Retry and risk

Related activities