Open Excel File

Opens an .xlsx or .xlsm file for the activities of a Use Excel File scope.

Behaviour

Risk: Low · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

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

Properties#

Input#

Excel file#

FilePath · String · Required · Default: Not specified in package metadata

Path of the .xlsx or .xlsm file to use.

Options#

Save changes#

SaveChanges · Boolean · Required · Default: True

Save the file when the scope completes successfully. Nothing is saved if the body fails.

Read only#

ReadOnly · Boolean · Optional · Default: False

Open without locking the file; changes are never saved.

Create if not exists#

CreateIfNotExists · Boolean · Optional · Default: False

Create an empty workbook with one sheet (Sheet1) when the file does not exist.

Output#

Workbook#

Workbook · ExcelWorkbookReference · Output

The opened workbook, for the activities inside the scope.

Session id#

SessionId · String · Output

The id of the opened workbook's session, for activities after the scope.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. 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.

Related activities#

• Append Range (Excel)
• Auto Fill
• Auto Fit Range
• Clear Range
• Copy Paste Range
• Copy Sheet
• Create Sheet
• Create Table

Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Excel. Keywords: excel, workbook, xlsx, spreadsheet, file, open, use, scope, xlsm.

Properties

Input

Options

Output

Retry and risk

Related activities