Subscribe

UiPath Apps

The UiPath Apps Guide

Function: Filter

📘

Tip:

To better understand how the Filter function works, check out the Using Apps with Data Service pages in the How To section.

Use this function to filter a table based on its fields.

This function performs a case insensitive check.

📘

Tip:

Depending on your project's needs, you can choose to exclude certain conditions when using the Filter function. To exclude a condition, you can write an expression that resolves the filter field (first parameter of the condition array) to a null. For example, you can use the following:
Filter(Customer, [If(IsBlank(Dropdown.Value), null, City), "=", Dropdown.Value])
In this case, the filter on City is only applied when the Dropdown contains a value other than blank.

SyntaxDescriptionExample
Filter(Entity, Condition)The function returns all records that result in true. These expressions can reference fields/columns by name.



Arguments

ArgumentTypeDescription
EntityRequiredThe entity to search (for example, a control's data property).
ConditionRequiredThe condition used to lookup for in the entity.
The format for the Condition argument should be as follows:
[Entity Field, Operator, Value]
The following operators can be used:
contains
not contains
startswith
endswith
=
!=
>
<
>=
<=
in
not in

📘

Tip:

You can use more than one condition using the Filter function. To do so, use the following syntax:
Filter(Entity, [Condition 1], [Condition 2], [Condition 3]).

Example

Filter(Customer, [City, "=", New York]): The loaded table only displays the information for customers from the city of New York

Updated 3 months ago

Function: Filter


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.