How to let users choose field(s) properly

by Feb 6, 2022AL Language

Home 9 Development 9 AL Language 9 How to let users choose field(s) properly

When some complex functionality is developed, it is sometimes necessary to let users choose a specific field. This can be required for field permissions, mapping imported values or any similar process.

Earlier, the usual way was to create a link on the Field table (for example “Field”.”No.” WHERE (TableNo=FIELD(Table ID))). As you can see, you have to first specify (let the user choose) the table. That means that the user has to use two lookup pages. Furthermore, if you want to let users choose more than one field, the script had to be programmed much more complicated way.

However, with all the new changes to best practices that Microsoft has done during the last two years, there is a new way how to let users choose fields properly. All needed is included in codeunit 9806 “Field Selection” (codeunit 9807 “Field Selection Impl.”).

We only need to call method Open(var Field: Record “Field”): Boolean and the system will do everything automatically. The method returns true when a field is selected, false otherwise. The selected field is returned as a selected record of the Field record parameter.

local procedure LetUserChoose()
var
    Field: Record Field;
    FieldSelection: Codeunit "Field Selection";

    SelectedFieldMsg: Label 'Field %1 in table %2 of type %3 has been selected.', Comment = '%1 - Caption of the field, %2 - Caption of the table, %3 - data type of the field';
    NoFieldSelectedMsg: Label 'No field has been selected.';
begin
    if FieldSelection.Open(Field) then
        Message(SelectedFieldMsg, Field."Field Caption", Field.TableCaption, Field.Type);
    Message(NoFieldSelectedMsg);
end;

If we look at the implementation in more detail (codeunit 9807 “Field Selection Impl.”) we can see that some of the fields are automatically excluded from selection – already removed fields (Removed-Obsoleted) and fields that are disabled.

local procedure HideInvalidFields(var "Field": Record "Field")
begin
    Field.FilterGroup(2);
    Field.SetFilter(ObsoleteState, '<>%1', Field.ObsoleteState::Removed);
    Field.SetRange(Enabled, true);
    Field.FilterGroup(0);
end;

Another interesting thing about this functionality is how the selected field (or fields!). All of this depends on the Field record parameter provided in FieldSelection.Open(var Field: Record “Field”): Boolean method. It works differently with Temporary and Non-Temporary records.

If you provide a Non-Temporary Field record, the selected field(s) is returned filtered using the SetSelectionFilter system method. On the other hand, if you provide a Temporary Field record, returned variable contains unfiltered results that contain only selected field(s).

Of course, you can filter fields that will be shown to the user – by applying filters on the Non-Temporary Field record or by inserting only specific fields into the Temporary Field record.

procedure GetSelectedFields(var SelectedField: Record "Field")
var
    "Field": Record "Field";
begin
    if SelectedField.IsTemporary() then begin
        SelectedField.Reset();
        SelectedField.DeleteAll();
        CurrPage.SetSelectionFilter(Field);
        if Field.FindSet() then
            repeat
                SelectedField.Copy(Field);
                SelectedField.Insert();
            until Field.Next() = 0;
    end else begin
        CurrPage.SetSelectionFilter(SelectedField);
        SelectedField.FindSet();
    end;
end;

Side note: the name of the field’s table is shown only when the fields are from more than one table. Otherwise, the table name column is not shown.

Recent Articles from the category

NavigationAction for ErrorInfo data type

NavigationAction for ErrorInfo data type

One more article about ErrorInfo data type. Have you already read my previous posts about ErrorInfo and Collectible Errors? ErrorInfo data type & Collectible Errors | MSDyn365 Business Central - Ing. Tomáš Kapitán (kepty.cz) Collectible Errors?! | MSDyn365...

read more
Error actions for ErrorInfo data type

Error actions for ErrorInfo data type

It is already almost one and a half years since the ErrorInfo data type was introduced (we saw this data type for the first time in BC2021w2). If you do not know what it is and how to use this data type, check my previous posts: ErrorInfo data type & Collectible...

read more
Data types under the microscope: List

Data types under the microscope: List

The List data type in AL language represents an ordered collection of objects that can be accessed by their index. Unlike an Array data type, a List does not have a fixed size and does not need to have its dimension specified when it is declared. The List data type...

read more
Connect to Azure Function in BC 2022 wave 2 (v21)

Connect to Azure Function in BC 2022 wave 2 (v21)

The new version of the Microsoft Dynamics 365 Business Central brought a new system module "Azure Functions" that makes integration with Azure Functions much easier and straightforward. The typical scenario, why to use Azure Functions together with Business Central,...

read more
Collectible Errors?! Is it already in use?

Collectible Errors?! Is it already in use?

Collectible Errors?! Is it already in use? This is the second part of my new article series about Collectible Errors. Let's check out the first part here: Collectible Errors?! | Microsoft Dynamics 365 - Ing. Tomáš Kapitán (kepty.cz) or you might be interested in my...

read more
Collectible Errors?!

Collectible Errors?!

Collectible Errors?! It has been already almost a year since ErrorInfo datatype & CollectibleErrors were introduced (I already have an article about basic structure: ErrorInfo data type & Collectible Errors). This article was released for the first time in...

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