Warning: number_format() expects parameter 1 to be float, string given in /data/web/virtuals/7298/virtual/www/domains/kepty.cz/wp-includes/functions.php on line 425

Custom Filter Tokens

by May 3, 2022AL Language

Home 9 Development 9 AL Language 9 Custom Filter Tokens ( Page )

As a user of the Business Central you have some constants you can use to filter or insert values. These constants contain useful values for data manipulation such as

  • t / today for date field – return current date
  • q / quarter for date field filters – return range of the current quarter
  • w / week, m / month, y / year ….

However, in some cases, we need some other constants. For that reason, we can use codeunit 41 “Filter Tokens” (codeunit 58 “Filter Tokens Impl.”). It contains functionality that allows defining our own constants for custom fields. Source codes for this functionality are on Microsoft’s GitHub.

Let’s look at some details.

Available procedures & events in “Filter Tokens” codeunit

We have four different procedures for filter token validation based on the requested data type. All procedures accept filter token as a parameter and returns (within the same input-output parameter) date value or date filter value.

procedure MakeDateFilter(var DateFilterText: Text)
procedure MakeTimeFilter(var TimeFilterText: Text)
procedure MakeTextFilter(var TextFilter: Text)
procedure MakeDateTimeFilter(var DateTimeFilterText: Text)

These procedures have support for some constants by default.

For text variables, supported constants are ME, USER (return UserId()) and COMPANY (returns CompanyName()).

For date, time and DateTime variables we have similar constants to the constants available for standard table filters such as NOW, TODAY, WORKDATE, YESTERDAY, TOMORROW, WEEK, MONTH, YEAR.

However, the biggest advantage of this functionality is that we can use our own constants. To add support for a new constant we have to define constant transformation (to date or time variables) using the following OnResolve publishers.

procedure OnResolveDateFilterToken(DateToken: Text; var FromDate: Date; var ToDate: Date; var Handled: Boolean)
procedure OnResolveTextFilterToken(TextToken: Text; var TextFilter: Text; var Handled: Boolean)
procedure OnResolveTimeFilterToken(TimeToken: Text; var TimeFilter: Time; var Handled: Boolean)
procedure OnResolveDateTokenFromDateTimeFilter(DateToken: Text; var DateFilter: Date; var Handled: Boolean)
procedure OnResolveTimeTokenFromDateTimeFilter(TimeToken: Text; var TimeFilter: Time; var Handled: Boolean)

How to add own constants

Imagine we want to add support for new constants Monday to Sunday from Last, This and Next week. To do that, just implement OnResolveDateFilterToken from Codeunit Filter Tokens. See code below.

[EventSubscriber(ObjectType::Codeunit, Codeunit::"Filter Tokens", 'OnResolveDateFilterToken', '', false, false)]
local procedure OnResolveDateFilterTokenFilterTokens(DateToken: Text; var FromDate: Date; var ToDate: Date; var Handled: Boolean)
var
    StartingDate: Date;
begin
    StartingDate := WorkDate();
    if DateToken.Contains('last') then
        StartingDate := CalcDate('<-CW-1D>', WorkDate());
    if DateToken.Contains('this') then
        StartingDate := CalcDate('<-CW>', WorkDate());
    if DateToken.Contains('next') then
        StartingDate := CalcDate('<+CW+1D>', WorkDate());

    case true of
        DateToken.Contains('monday'):
            FromDate := CalcDate('<-CW>', StartingDate);
        DateToken.Contains('tuesday'):
            FromDate := CalcDate('<-CW+1D>', StartingDate);
        DateToken.Contains('wednesday'):
            FromDate := CalcDate('<-CW+2D>', StartingDate);
        DateToken.Contains('thursday'):
            FromDate := CalcDate('<-CW+3D>', StartingDate);
        DateToken.Contains('friday'):
            FromDate := CalcDate('<-CW+4D>', StartingDate);
        DateToken.Contains('saturday'):
            FromDate := CalcDate('<-CW+5D>', StartingDate);
        DateToken.Contains('sunday'):
            FromDate := CalcDate('<-CW+6D>', StartingDate);
        else begin
                Handled := false;
                exit;
            end;
    end;
    ToDate := FromDate;
    Handled := true;
end;

That’s all. We can try it for example in sales orders. Using “friday..next friday” we will get all orders with a posting date between this Friday and the next one (inclusive).

Recent Articles from the category

DynamicsCon 2021 session recording available!

DynamicsCon 2021 session recording available!

Finally, recordings from DynamicsCon 2021 Autumn edition are available! Check the official youtube channel. It was a great conference with over 250 people during my live session! I definitely hope I will be able to attend the next in-person DynamicsCon as a speaker...

read more
Directions EMEA

Directions EMEA

Directions4Partners EMEA 2021 is still in progress here in Milan. I want to share all details about each day, but unfortunately, there are so many amazing things to see, watch and try I have almost no time. So today just a few words about the day before the...

read more
Field Level Permissions (Restricted Fields)

Field Level Permissions (Restricted Fields)

I just add a new project to my GitHub repositories. It is a new extension for Business Central that extends security functionalities with field-level permission. Using this extension, users are able to define who can or can not change specific fields in any table in...

read more
Returning complex types in AL Language

Returning complex types in AL Language

In Microsoft Dynamics 365 Business Central 2021 w1 (released in May 2021), a profound change was introduced to ways how we can design our applications Until this version, the only way to return complex data types (like records, codeunits, Lists etc.) was using the var...

read more
Import various file types with Interfaces

Import various file types with Interfaces

A few weeks ago, I described a solution for importing an Excel file to the Business Central using Excel Buffer in AL Language (see here). In today's article, we will look at how to build a more complex solution that can be used for file imports without the needs to...

read more

Sign Up for News

Certifications

Highest certification
Microsoft Data Management and
also in D365 Business Central

Microsoft Certified: Dynamics 365 Business Central Functional Consultant Associate

See other certifications here