Add objects to search

Completed

The Business Central application contains several objects. Along with the navigation options within the navigation menus, navigation bar, or actions area, you can also search for objects. By using the Search (also referred to as Tell Me), you can search by name.

Screenshot of the Tell Me What You Want to Do feature.

When you create your own objects, they don't show up in the search list by default. To have your objects displayed in the search list, you have to set an extra property: UsageCategory.

page 50101 "Car List"
{
    Caption = 'Car List';
    PageType = List;
    ApplicationArea = All;
    UsageCategory = Lists;
    ...
}

The UsageCategory property sets the category for a searched page or report. You can select one of following categories:

  • Administration

  • Documents

  • History

  • Lists

  • None

  • Reports and Analysis

  • Tasks

Typically, you wouldn't want a user to directly search for a card page, but would prefer that they are guided through a list page first. Therefore, you can set the UsageCategory to None for card pages. Additionally, you can use the Administration category for Setup pages and the History category for posted documents and transactions.

A UsageCategory property is not provided for CardParts, ListParts, HeadlineParts, and so on.

The UsageCategory property is used together with the ApplicationArea property. If you provide a UsageCategory, you need to provide the ApplicationArea property as well. If the UsageCategory is set to None, you need to remove the ApplicationArea.

With the ApplicationArea property, you can define for which type of license the search entry appears in the list.

For example, perhaps you want to have users search for a page but with different terms than the name of the page. For that scenario, you can use the AdditionalSearchTerms property. These search terms are in addition to the caption of the page or report. Users can search for "item," but can also search for "product" or "merchandise."

page 50101 "Car List"
{
    Caption = 'Car List';
    PageType = List;
    ApplicationArea = All;
    UsageCategory = Lists;
    AdditionalSearchTerms = 'transport, vehicle, automobile'
    ...
}