Filter Data Table

Filters rows in a DataTable based on a column condition, returning a new DataTable.

Behaviour

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

Package System activities VeloPhex.System.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.system.filterDataTable

Properties#

Input#

Data Table#

DataTable · DataTable · Required · Default: Not specified in package metadata

The DataTable to be filtered.

Column Name#

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

The name of the column to evaluate. Takes precedence over ColumnIndex.

Column Index#

ColumnIndex · Int32? · Optional · Default: Not specified in package metadata

The zero-based index of the column to evaluate.

Operator#

Operator · String · Optional · Default: Equal

The comparison operator (Equal, NotEqual, Contains, StartsWith, EndsWith, GreaterThan, LessThan, IsEmpty, IsNotEmpty).

Allowed values: Equal, NotEqual, Contains, StartsWith, EndsWith, GreaterThan, LessThan, IsEmpty, IsNotEmpty.

Value#

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

The reference value to compare against.

Filter Action#

FilterAction · String · Optional · Default: Keep

Specifies whether matching rows are kept or removed (Keep / Remove).

Allowed values: Keep, Remove.

Conditions#

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

Several conditions in DataView RowFilter syntax, in place of Column/Operator/Value, e.g. Amount > 100 AND (Status = 'Open' OR Name LIKE 'A%').

Columns#

Columns · IEnumerable<String> · Optional · Default: Not specified in package metadata

Column names the output keeps (or loses, with Columns Mode Remove). Empty: every column.

Columns Mode#

ColumnsMode · String · Optional · Default: Keep

Keep only the listed Columns, or remove them.

Allowed values: Keep, Remove.

Output#

Output Data Table#

OutputDataTable · DataTable · Output

The filtered DataTable instance.

First Row#

FirstRow · DataRow · Output

The first row of the output, or null when no row is left.

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.

Related activities#

• Add Data Column
• Add Data Row
• Build Data Table
• Clear Data Table
• Generate Data Table From Text
• Get Row Item
• Join Data Tables
• Lookup Data Table

Generated from VeloPhex.System.Activities 0.7.1-rc.12. Category: Data Table. Keywords: datatable, filter, where, condition, keep, remove.

Properties

Input

Output

Retry and risk

Related activities