Specifies whether the provider filters on every Web Services endpoint column server-side, instead of limiting server-side filtering to key and reference columns.

Data Type

bool

Default Value

false

Remarks

This property affects only Web Services endpoints, whose URLs contain /ODataV4/. Common Service endpoints and Custom API endpoints already filter server-side on any queryable column, so this property does not change how they behave. The endpoint category follows from the OrganizationURL you connect to and, for a friendly https://businesscentral.dynamics.com/ URL, from EndpointType. For a description of each endpoint category and the URL formats that select it, see Business Central Endpoints.

A Web Services endpoint exposes a published page, and a published page supports filtering only on the fields it was designed to filter on. Filtering on any other field fails with a "Field 'X' is not filterable" error from Microsoft Dynamics 365 Business Central. Microsoft Dynamics 365 Business Central does not report which fields a published page supports filtering on, so the add-in cannot tell the two kinds of field apart on its own.

When set to False (the default), the add-in sends only primary key and reference (foreign key) conditions to a Web Services endpoint. It retrieves the matching rows and evaluates the rest of the WHERE clause locally. Queries always succeed, but a highly selective query against a large table can still retrieve most of that table before discarding the rows that do not match.

When set to True, the add-in sends every supported condition on a Web Services column to Microsoft Dynamics 365 Business Central. On large transactional tables, this can greatly reduce the amount of data the add-in retrieves and the time a query takes to complete.

Note: Set this property to True only when you know that the published pages you query support filtering on the fields you filter on. With the property enabled, a query that filters on an unsupported field fails with an error from Microsoft Dynamics 365 Business Central instead of succeeding through local evaluation. Fields backed by an enum (option set) are a common source of these failures, because Microsoft Dynamics 365 Business Central rejects any value outside the set of options it accepts for the field.

The add-in applies this property while it builds the column list for a table. If you change the value on a connection that has already retrieved metadata, clear the cached metadata before you run further queries.