VLookup

Finds a value in the first column of a range and returns the value in the same row of another column, as Excel's VLOOKUP.

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.vlookup

Properties#

Input#

Sheet#

Sheet · String · Required · Default: Sheet1

The name of the sheet.

Range#

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

The table to search; its first column holds the keys.

Value#

Value · Object · Required · Default: Not specified in package metadata

The value to find in the first column.

Column Index#

ColumnIndex · Int32 · Required · Default: 2

The 1-based column of the range to return.

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#

Exact Match#

ExactMatch · Boolean · Optional · Default: True

Off finds the largest key not greater than Value; the first column must then be sorted ascending.

Output#

Result#

Result · Object · Output

The value found, or null when there is no match.

Found#

Found · Boolean · Output

Whether a row matched.

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, vlookup, lookup, find, search.

Properties

Input

Options

Output

Rules

Retry and risk

Related activities