Filtering

Overview

Data filtering in Servoy is a powerful mechanism to control which records are visible to users, ensuring that only relevant data is displayed based on specific criteria. This capability is crucial for maintaining data security, enforcing business rules, and enhancing user experience by showing only pertinent data. Servoy provides two primary levels of data filtering: Foundset Filters and Table Filters. Each serves distinct purposes and is suited to different use cases, allowing for both temporary, user-driven filtering and persistent, session-wide data constraints.

Foundset Filters vs. Table Filters Foundset filters and table filters serve different purposes in Servoy's data management. Foundset filters are temporary and apply to individual foundsets, making them ideal for dynamic, user-driven filtering based on session-specific input. For example, a user can filter orders shipped to a specific city within their current session. In contrast, Table filters apply globally to entire tables or server connections and persist for the session duration, ensuring consistent data visibility rules across all users and sessions. They are best used for enforcing global business rules or permissions, such as restricting data access to only show products available for a specific company. Understanding these differences helps developers choose the appropriate method for filtering data based on their application's needs.

Foundset Filters

Foundset filters provide a way to temporarily restrict data visibility based on user input. These filters are useful when a user needs to apply specific criteria to view a subset of data without affecting other users or the entire application. These filters are ideal for creating dynamic user experiences where data visibility changes based on user interactions. Foundset filters can be layered to refine data visibility further.

Use Case: Temporary filters based on user input.

Foundset filters apply only to an individual foundset. They are valid until removed.

Example: Filter orders where shipcity is Berlin.

var success = foundset.addFoundSetFilterParam('shipcity', '=', 'Berlin', 'cityFilter');
foundset.loadAllRecords(); // to make the filter effective

Here are the API methods related to foundset filters:

Add Foundset Filters

There are several ways to add a Foundset filer:

addFoundSetFilterParam(query) In this example, we will add a filter to a foundset to show orders where the ship city is either "Amersfoort" or "Amsterdam". This filter will be permanent for the user session.

var query = datasources.db.example_data.orders.createSelect();
query.where.add(
    query.or
        .add(query.columns.shipcity.eq('Amersfoort'))
        .add(query.columns.shipcity.eq('Amsterdam'))
);
var success = foundset.addFoundSetFilterParam(query, 'cityFilter');
if (success) {
    foundset.loadAllRecords(); // to make the filter effective
} else {
    application.output('Failed to add foundset filter');
}

addFoundSetFilterParam(query, name) In this example, we will add a named filter to a foundset to show orders where the ship city is either "Amersfoort" or "Amsterdam". The filter is given a name cityFilter for easy removal later. This filter will be permanent for the user session and can be removed by name.

var query = datasources.db.example_data.orders.createSelect();
query.where.add(
    query.or
        .add(query.columns.shipcity.eq('Amersfoort'))
        .add(query.columns.shipcity.eq('Amsterdam'))
);
var success = foundset.addFoundSetFilterParam(query, 'cityFilter');
if (success) {
    foundset.loadAllRecords(); // to make the filter effective
} else {
    application.output('Failed to add foundset filter');
}

addFoundSetFilterParam(dataprovider, operator, value)

In this example, we will add a filter to a foundset to show orders where the customerid equals a specific value. This filter will be permanent for the user session and multiple filters can be added to the same dataprovider.

var success = foundset.addFoundSetFilterParam('customerid', '=', 'BLONP');
if (success) {
    foundset.loadAllRecords(); // to make the filter effective
} else {
    application.output('Failed to add foundset filter');
}

addFoundSetFilterParam(dataprovider, operator, value, name)

In this example, we will add a named filter to a foundset to show orders where the customerid equals a specific value. This filter will be permanent for the user session, and multiple filters can be added to the same dataprovider.

var success = foundset.addFoundSetFilterParam('customerid', '=', 'BLONP', 'custFilter');
if (success) {
    foundset.loadAllRecords(); // to make the filter effective
} else {
    application.output('Failed to add foundset filter');
}

Create Table Filter Parameter and Apply to Foundset

createTableFilterParam(dataprovider, operator, value)

In this example, we will create various table filters and apply them to a foundset. Multiple filters can be applied at the same time using foundset.setTableFilters().

Create a Simple Filter:

// Filter on messages table where messagesid > 10
var filter1 = foundset.createTableFilterParam('messagesid', '>', 10);

Create Filters with IN Conditions:

// Filter on product codes
var filter2 = foundset.createTableFilterParam('productcode', 'in', [120, 144, 200]);

// Use "sql:in" to interpret the value as a custom query
var filter3 = foundset.createTableFilterParam('countrycode', 'sql:in', 'select countrycode from countries where region = "Europe"');

Create Filters with Modifiers:

// Filter on companies where companyname is null or equals-ignore-case 'servoy'
var filter4 = foundset.createTableFilterParam('companyname', '#^||=', 'servoy');

// Filter where the value is null
var filter5 = foundset.createTableFilterParam('verified', '=', null);

Apply Multiple Filters to the Foundset:

// Apply multiple filters at the same time, previous filters with the same name are removed
var success = foundset.setTableFilters('myfilters', [filter1, filter2, filter3, filter4, filter5]);
if (success) {
    foundset.loadAllRecords(); // to make the filters effective
} else {
    application.output('Failed to apply table filters');
}

Set Multiple Foundset Filters at the Same Time

setFoundSetFilters(filterName, tableFilters)

In this example, we will create and apply multiple foundset filters at the same time. If the filters already exist with the same filter name, they will be removed and replaced with the new set of filters.

Create and Apply Multiple Filters:

// Create a number of filters
var filter1_10 = foundset.createTableFilterParam('customerid', '=', 10);

var query = datasources.db.example_data.orders.createSelect();
query.where.add(query.columns.shipcity.eq('Amersfoort'));
var filter2 = foundset.createTableFilterParam(query);

// Apply multiple filters at the same time, previous filters with the same name are removed
var success = foundset.setFoundSetFilters('myfilters', [filter1_10, filter2]);
if (success) {
    foundset.loadAllRecords(); // to make the filters effective
} else {
    application.output('Failed to set foundset filters');
}

Update One of the Filters:

var filter1_11 = foundset.createTableFilterParam('customerid', '=', 11);

var success = foundset.setFoundSetFilters('myfilters', [filter1_11, filter2]);
if (success) {
    foundset.loadAllRecords(); // to make the filters effective
} else {
    application.output('Failed to update foundset filters');
}

Remove Filters by Setting Them to an Empty List:

var success = foundset.setFoundSetFilters('myfilters', []); // To remove the filters, an empty list is passed
if (success) {
    foundset.loadAllRecords(); // to make the removal effective
} else {
    application.output('Failed to remove foundset filters');
}

Remove a Named Foundset Filter

removeFoundSetFilterParam(name)

In this example, we will remove a previously defined foundset filter using its given name and then reload the foundset to make the removal effective.

Remove the Named Filter:

var success = foundset.removeFoundSetFilterParam('custFilter'); // removes all filters with this name
if (success) {
    foundset.loadAllRecords(); // to make the removal effective
} else {
    application.output('Failed to remove foundset filter');
}

Table Filters

Table filters apply constraints across entire tables or server connections, ensuring that only specific records are accessible throughout the session. These filters are crucial for enforcing business rules, such as multi-tenant data segregation or ensuring compliance with data visibility policies. Table filters are powerful for implementing business rules and data security at a broader level. These filters ensure consistent data visibility rules across the entire application session.

Use Case: Apply filters to entire sessions to enforce rules or permissions (e.g., only show data for a specific company).

Table filters apply to all foundset instances and datasets based on the filtered table/datasource. They are valid for the session duration or until programmatically removed.

Example: Restrict data access to only show products available for a specific company.

var success = databaseManager.addTableFilterParam('my_server', 'products', 'companyid', '=', globals.currentCompanyID);

Filtering an entire server connection

This is ideal for multi-tenant architectures as an entire server connection can be filtered by a single expression, by passing null for the table name.

Example: All tables that have the companyid column should be filtered.

var success = databaseManager.addTableFilterParam('crm', null, 'companyidid', '=', globals.currentCompanyID)

Here are the API methods related to table filters:

Add Table Filters

There are several ways to add a Table filer:

addTableFilterParam(query)

In this example, we will add a table filter based on a query to all foundsets based on a table. This ensures that only records matching the query condition are visible.

var query = datasources.db.example_data.orders.createSelect();
query.where.add(
    query.or
        .add(query.columns.shipcity.eq('Amersfoort'))
        .add(query.columns.shipcity.eq('Amsterdam'))
);
var success = databaseManager.addTableFilterParam(query);
if (success) {
    application.output('Table filter added successfully');
} else {
    application.output('Failed to add table filter');
}

addTableFilterParam(query, filterName)

In this example, we will add a table filter based on a query to all foundsets based on a table. The filter will be named for easy identification and removal.

var query = datasources.db.example_data.orders.createSelect();
query.where.add(
    query.or
        .add(query.columns.shipcity.eq('Amersfoort'))
        .add(query.columns.shipcity.eq('Amsterdam'))
);
var success = databaseManager.addTableFilterParam(query, 'cityFilter');
if (success) {
    application.output('Table filter added successfully');
} else {
    application.output('Failed to add table filter');
}

addTableFilterParam(datasource, dataprovider, operator, value)

In this example, we will add a table filter based on a datasource, dataprovider, operator, and value. This ensures that only records matching the filter condition are visible.

// some filters with in-conditions
var success = databaseManager.addTableFilterParam('datasources.db.example_data.products.getDataSource()', 'productid', 'in', [120, 144, 200]);
if (success) {
    application.output('Table filter added successfully');
} else {
    application.output('Failed to add table filter');
}

addTableFilterParam(datasource, dataprovider, operator, value, filterName)

In this example, we will add a table filter based on a datasource, dataprovider, operator, value, and filter name. This ensures that only records matching the filter condition are visible.

// filter on messages table where messagesid>10, the filter has a name so it can be removed using databaseManager.removeTableFilterParam()
var success = databaseManager.addTableFilterParam('datasources.db.admin.messages.getDataSource()', 'messagesid', '>', 10, 'higNumberedMessagesRule')
if (success) {
    application.output('Table filter added successfully');
} else {
    application.output('Failed to add table filter');
}

addTableFilterParam(serverName, tableName, dataprovider, operator, value)

In this example, we will add a table filter based on a server name, table name, dataprovider, operator, and value. This ensures that only records matching the filter condition are visible.

// Filter on product codes
var success = databaseManager.addTableFilterParam('crm', 'products', 'productcode', 'in', [120, 144, 200]);
if (success) {
    application.output('Table filter added successfully');
} else {
    application.output('Failed to add table filter');
}

addTableFilterParam(serverName, tableName, dataprovider, operator, value, filterName)

In this example, we will add a table filter based on a server name, table name, dataprovider, operator, value, and filter name. This ensures that only records matching the filter condition are visible.

// Filter on companies where companyname is null or equals-ignore-case 'servoy'
var success = databaseManager.addTableFilterParam('crm', 'companies', 'companyname', '#^||=', 'servoy', 'companyNameFilter');
if (success) {
    application.output('Table filter added successfully');
} else {
    application.output('Failed to add table filter');
}

Create Table Filters

There are several ways to create a Table filer:

createTableFilterParam(query)

In this example, we will create a table filter based on a query. This filter can be applied to all foundsets based on a table.

Create a Filter with a Query:

var query = datasources.db.admin.messages.createSelect();
query.where.add(query.columns.messagesid.gt(10));
var filter = databaseManager.createTableFilterParam(query);

Apply Filter:

// Apply multiple filters at the same time, previous filters with the same name are removed
var success = databaseManager.setTableFilters('myfilters', [filter]);
if (success) {
    application.output('Table filters applied successfully');
} else {
    application.output('Failed to apply table filters');
}

createTableFilterParam(datasource, dataprovider, operator, value)

In this example, we will create a table filter that can be applied to all foundsets based on a table. Multiple filters can be applied at the same time using databaseManager.setTableFilters().

Create a Filter:

// Filter on messages table where messagesid > 10
var filter = databaseManager.createTableFilterParam('datasources.db.example_data.messages.getDataSource()', 'messagesid', '>', 10);

Apply Filter:

var success = databaseManager.setTableFilters('myfilters', [filter]);
if (success) {
    application.output('Table filters applied successfully');
} else {
    application.output('Failed to apply table filters');
}

createTableFilterParam(serverName, tableName, dataprovider, operator, value)

In this example, we will create and apply multiple table filters that can be applied to all foundsets based on a table. Multiple filters can be applied at the same time using databaseManager.setTableFilters().

// Apply multiple filters at the same time, previous filters with the same name are removed
var filter1 = databaseManager.createTableFilterParam('crm', 'companies', 'companyname', '#^||=', 'servoy');
var filter2 = databaseManager.createTableFilterParam('crm', 'orders', 'countrycode', 'sql:in', 'select countrycode from countries where region = "Europe"');
var success = databaseManager.setTableFilters('myfilters', [filter1, filter2]);
if (success) {
    application.output('Table filters applied successfully');
} else {
    application.output('Failed to apply table filters');
}

Set Multiple Table Filters at the Same Time

setTableFilters(filterName, tableFilters)

In this example, we will apply multiple table filters to all the foundsets that are affected by the filters using databaseManager.setTableFilters().

Create Multiple Filters:

// Create a number of filters
var query1_nl = datasources.db.crm.companies.createSelect();
query1_nl.where.add(query1_nl.columns.countrycode.eq('nl'));
var filter1_nl = databaseManager.createTableFilterParam(query1_nl);

var filter2 = databaseManager.createTableFilterParam('example', 'orders', 'clusterid', '=', 10).dataBroadcast(true);

Apply Multiple Filters at the Same Time:

// Apply multiple filters at the same time, previous filters with the same name are removed
var success = databaseManager.setTableFilters('myfilters', [filter1_nl, filter2]);
if (success) {
    application.output('Table filters applied successfully');
} else {
    application.output('Failed to apply table filters');
}

Update One of the Filters:

var query1_us = datasources.db.crm.companies.createSelect();
query1_us.where.add(query1_us.columns.countrycode.eq('us'));
var filter1_us = databaseManager.createTableFilterParam(query1_us);

var success = databaseManager.setTableFilters('myfilters', [filter1_us, filter2]);
if (success) {
    application.output('Table filters updated successfully');
} else {
    application.output('Failed to update table filters');
}

Remove Filters by Setting Them to an Empty List:

var success = databaseManager.setTableFilters('myfilters', []);
if (success) {
    application.output('Table filters removed successfully');
} else {
    application.output('Failed to remove table filters');
}

Remove a Named Table Filter

removeTableFilterParam(serverName, filterName)

In this example, we will remove a previously defined table filter using the removeTableFilterParam method.

var success = databaseManager.removeTableFilterParam('admin', 'highNumberedMessagesRule');
if (success) {
    application.output('Table filter removed successfully');
} else {
    application.output('Failed to remove table filter');
}

Filtering Methods

Filters remain in effect until removed and can be used in concert with other.

Both foundset and table filters can be implemented using two approaches:

Logical Expression

This approach is ideal for straightforward filters. It covers most use cases. A filter will contain a logical expression which is evaluated on behalf of records in the filtered foundset(s)/table(s). Only records, for which the expression evaluates to true, will be returned by any queries issued to the filtered foundset(s)/table(s). At runtime, the filter will be translated into an SQL WHERE clause and appended to the query of any foundset which is bound to the filtered table(s). An expression contains the following components:

Data Provider Name - This is the left-hand operand. It is the name of a single column by which to filter. In a table filter, when filtering an entire server connection, only tables which contain the named column will be filtered.
Operator - The following operators are supported
Data Provider Value - This is the right-hand operand and should evaluate to a literal value to be compared with the named column.

You can find examples of filters using Logical Expressions here.

QueryBuilder

This approach is ideal for advanced filters. It is useful for for scenarios where filters need to involve multiple columns, SQL logical operators, functions, aggregates, or nested conditions. The QueryBuilder (QB) approach is flexible and allows for complex filtering logic.

Query Builder used in Foundset Filters The table of the query has to be the same as the foundset table.

You can find examples of filters using QueryBuilder here.

Table of Operators

The following operators can be used for both foundset and table filters:

Operator

Description

=

Only records whose column equals the specified value

<

Only records whose column is less than the specified value

>

Only records whose column greater than the specified value

>=

Only records whose column greater than or equals the specified value

<=

Only records whose column less than or equals the specified value

!=

Only records whose column does not equal the specified value

^

Only records whose column value is null

LIKE

Only records whose column matches using the SQL LIKE construct (use wildcard % characters)

IN

Only records whose column value is in (using the SQL IN construct) a list of values

BETWEEN

Only records whose column value is (inclusive) between a list of 2 values

#

Modifier, used to make case-insensitive queries

Modifier used to concatenate two conditions; a logical OR

Operators and modifiers may be combined, producing more complex conditions. For example #^||!= would translate to: is null OR case-insensitive not equals.

When using the IN operator, one should provide an array of values or a String, which may be used as a sub select for the SQL IN clause.

Filters with in-conditions can be used with arrays or with custom queries.

Naming Filters

When adding a table filter parameter, a filter name may be used to allow for the later removal of a named filter. Multiple parameters or conditions may be set using the same filter name. In this case, all parameters may be removed at the same time. It is recommended to name all filters so they can be easily removed later.

Multiple filters can be "stacked" on a foundset or datasource, and results will be constrained by all applied filters.

Examples:

Foundset Filter Filter orders where shipcity = X, named cityFilter:

var success = foundset.addFoundSetFilterParam('shipcity', '=', 'Berlin', 'cityFilter');
foundset.loadAllRecords(); // to make param(s) effective

Table Filter Filter records in a products table based on the criteria that the status is not discontinued, named productfilter:

var success = databaseManager.addTableFilterParam('xx_server','products','product_status','!=',globals.STATUS_DISCONTINUED,'productfilter');
foundset.loadAllRecords(); // to make param(s) effective

The loadAllRecords method ensures that the foundset is reloaded with the new filter applied.

Removing Filters

Remove a named filter from a foundset / table.

Examples:

Foundset Filter

var success = foundset.removeFoundSetFilterParam('cityFilter');// removes all filters with this name
foundset.loadAllRecords(); // to make param(s) effective

Table Filter

var success = databaseManager.removeTableFilterParam('xx_server', 'productfilter'); // removes all table filters with this name
foundset.loadAllRecords(); // to make param(s) effective

The loadAllRecords method is used to refresh the foundset without the filter.

Examples of Filters using Logical Expressions

Foundset Filter Orders Between Two Dates Using Form Variables

In this example, we will add a filter to a foundset to display orders between two dates specified by form variables globals.startDate and globals.endDate.

Set the Form Variables:

// Setting the form variables for the date range
globals.startDate = '2023-01-01'; // Example start date
globals.endDate = '2023-12-31';   // Example end date

Add the Filter:

var success = foundset.addFoundSetFilterParam('orderdate', 'between', [globals.startDate, globals.endDate], 'dateFilter');
foundset.loadAllRecords(); // to make the filter effective

Remove the Filter (if needed):

var success = foundset.removeFoundSetFilterParam('dateFilter');
foundset.loadAllRecords(); // to make the removal effective

Foundset Filter Orders Based on a List of Customers Using IN Operator with array

In this example, we will filter a foundset to show orders based on a list of shipping countries. The list of shipping countries is stored in:

a form variable

Define the Form Variable:

globals.countries = ["France", "USA", "Netherlands"]; // Example list of shipping countries

Add the Filter:

var success = foundset.addFoundSetFilterParam('shipping_country', 'in', globals.countries, 'countryFilter');
foundset.loadAllRecords(); // to make the filter effective

a valuelist

Considering countries a valuelist containing country names: Define the countries list from the valuelist:

var filter_countries = application.getValueListItems('order_countries').getColumnAsArray(1);

Add the Filter:

var success = foundset.addFoundSetFilterParam('shipping_country', 'in', filter_countries, 'countryFilter');
foundset.loadAllRecords(); // to make the filter effective

Foundset Filter Orders Based on a List of Customers Using IN Operator with custom queries

In this example, we will filter a foundset to show orders based on a list of specific shipping countries

success = foundset.addFoundSetFilterParam("shipping_country", "sql:in", "select shipping_country from orders where shipping_country in ('France', 'USA', 'Netherlands')");
foundset.loadAllRecords(); // to make param(s) effective

Foundset Filter Customers Where CompanyName Starts with “big” (Case-Insensitive)

In this example, we will filter a foundset to show customers where the company name starts with "big", using a case-insensitive comparison.

Add the Filter:

var success = foundset.addFoundSetFilterParam('companyname', 'like', '#big%', 'companyFilter');
foundset.loadAllRecords(); // to make the filter effective

Remove the Filter (if needed):

var success = foundset.removeFoundSetFilterParam('companyFilter');
foundset.loadAllRecords(); // to make the removal effective

Table Filter: Where company = or IN companies

In this example, we will add a table filter to ensure that only records related to specific companies are shown. This filter will be applied on solution startup using the onOpen event.

Considering globals.companyIDs an array of Companies.

Apply the Table Filter on Startup:

function onSolutionOpen() {
    // Apply the filter to all tables that have the companyid column
    var success = databaseManager.addTableFilterParam('xx_server', null, 'companyid', 'IN', globals.companyIDs, 'companyFilter');
}

Remove the Table Filter (if needed):

function removeCompanyFilter() {
    var success = databaseManager.removeTableFilterParam('companyFilter');
}

In this example, the addTableFilterParam method is used to apply a table filter that restricts data to only those records where companyid is in the list specified by globals.companyIDs. This filter is added during the solution's startup by calling the onSolutionOpen function, which is assigned to the onOpen event of the solution. To remove the filter, the removeTableFilterParam method is used.

Using the Data Broadcast Flag:

Set the Data Broadcast Flag: In this example, we will set the dataBroadcast flag for a table filter to reduce data broadcast events for clients having a data broadcast filter set for the same column with a different value.

IMPORTANT dataBroadcast flag is only supported for simple filters using the in or = operators.

Create a Filter with the Data Broadcast Flag:

var filter = databaseManager.createTableFilterParam('example', 'orders', 'clusterid', '=', 10).dataBroadcast(true);
if (filter) {
    application.output('Table filter with dataBroadcast flag set successfully');
} else {
    application.output('Failed to create table filter with dataBroadcast flag');
}

In this example, the dataBroadcast method is used to set the dataBroadcast flag to true for a filter created using createTableFilterParam. This filter will help reduce data broadcast events for clients with a data broadcast filter set for the same column with a different value.

Examples of Filters using QueryBuilder

Foundset Filter Using QueryBuilder and Aggregates

In this example, we will use QueryBuilder to create a foundset filter that shows customers who have placed more than a specified number of orders. This example uses an aggregate function to count the number of orders per customer.

Create the QueryBuilder with Aggregate:

var query = datasources.db.example_data.orders.createSelect();
var subquery = query.joins.add('db:/example_data/customers', JSRelation.INNER_JOIN, 'c');
subquery.on.add(query.columns.customerid.eq(query.joins.c.columns.customerid));
query.result.add(query.columns.customerid);
query.result.add(query.columns.customerid.count, 'order_count');
query.groupBy.add(query.columns.customerid);
query.having.add(query.columns.customerid.count.gt(10)); // Example: more than 10 orders

// Filter customers based on the subquery
var filter = foundset.createTableFilterParam(query);

Add the Filter:

var success = foundset.setFoundSetFilters('customerOrderFilter', [filter]);
foundset.loadAllRecords(); // to make the filter effective

Remove the Filter (if needed):

var success = foundset.removeFoundSetFilterParam('customerOrderFilter');
foundset.loadAllRecords(); // to make the removal effective

In this example, the QueryBuilder is used to construct a query that aggregates order data to count the number of orders per customer. The having clause filters customers based on the aggregate condition (e.g., customers with more than 10 orders). The createTableFilterParam method creates a filter based on this query, and setFoundSetFilters applies the filter to the foundset. The loadAllRecords method ensures the foundset is reloaded with the new filter applied. To remove the filter, removeFoundSetFilterParam is used followed by loadAllRecords to refresh the foundset without the filter.

Foundset Filter Using QueryBuilder and Functions

In this example, we will use QueryBuilder to create a foundset filter that shows customers whose last order amount is greater than a specified value using the SUM function to calculate the total order amount.

Create the QueryBuilder with Functions:

var query = datasources.db.example_data.orders.createSelect();
var subquery = query.joins.add('db:/example_data/customers', JSRelation.INNER_JOIN, 'c');
subquery.on.add(query.columns.customerid.eq(query.joins.c.columns.customerid));
query.result.add(query.columns.customerid);
query.result.add(query.columns.orderamount.sum, 'total_order_amount');
query.groupBy.add(query.columns.customerid);
query.having.add(query.columns.orderamount.sum.gt(1000)); // Example: total order amount greater than 1000

// Filter customers based on the subquery
var filter = foundset.createTableFilterParam(query);

Add the Filter:

var success = foundset.setFoundSetFilters('orderAmountFilter', [filter]);
foundset.loadAllRecords(); // to make the filter effective

Remove the Filter (if needed):

var success = foundset.removeFoundSetFilterParam('orderAmountFilter');
foundset.loadAllRecords(); // to make the removal effective

In this example, the QueryBuilder is used to construct a query that aggregates order data to calculate the total order amount for each customer using the SUM function. The having clause filters customers based on the aggregate condition (e.g., customers with a total order amount greater than 1000). The createTableFilterParam method creates a filter based on this query, and setFoundSetFilters applies the filter to the foundset. The loadAllRecords method ensures the foundset is reloaded with the new filter applied. To remove the filter, removeFoundSetFilterParam is used followed by loadAllRecords to refresh the foundset without the filter.

Foundset Filter - Orders with QueryBuilder where Ship City is [A OR B] AND NOT C

In this example, we will use the QueryBuilder (QB) to filter a foundset to show orders where the ship city is either 'A' or 'B' and not 'C'.

Create the QueryBuilder Condition:

var query = datasources.db.example_data.orders.createSelect();
var orCondition = query.or
    .add(query.columns.shipcity.eq('A'))
    .add(query.columns.shipcity.eq('B'));
query.where.add(orCondition)
    .add(query.columns.shipcity.not.eq('C'));

Add the Filter:

var success = foundset.addFoundSetFilterParam(query, 'advancedCityFilter');
foundset.loadAllRecords(); // to make the filter effective

Remove the Filter (if needed):

var success = foundset.removeFoundSetFilterParam('advancedCityFilter');
foundset.loadAllRecords(); // to make the removal effective

In this example, the QueryBuilder is used to construct a condition where the shipcity is either 'A' or 'B', and not 'C'. The addFoundSetFilterParam method applies this filter to the foundset, and loadAllRecords ensures that the foundset is reloaded with the new filter applied. To remove the filter, removeFoundSetFilterParam is used followed by loadAllRecords to refresh the foundset without the filter.

Best Practices

Always Name Filters: This allows for easy management, especially when you need to remove or modify them.
Use Stacked Filters: Combine multiple filters to achieve the desired level of data restriction.
Test Filters Thoroughly: Ensure that filters apply the correct constraints and do not unintentionally hide necessary data.

Additional Links

The following articles are recommended for additional reading:

Reference for Foundset Filter
Reference for Table Filter
Searching Guide: QueryBuilder Guide
SvyPopupFilter: Combines Filters into a Reusable UI Pattern

PreviousSQL String NextEditing

Last updated 1 year ago

Was this helpful?