apps
2023.10
true
LEGACY
Legacy Apps User Guide for Automation Suite
Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Jan 18, 2024

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.

Syntax

Description

Example

Filter(Entity, Condition)

The function returns all records that result in true. These expressions can reference fields/columns by name.

docs image

Arguments

Argument

Type

Description

Entity

Required

The entity to search (for example, a control's data property).

Condition

Required

The 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

Example

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

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.