Add reports to Tell Me

Completed

In AL code, you would make a page or report searchable from Tell Me by setting the UsageCategory property. The UsageCategory setting will make the page or report searchable, and the value that is chosen for the setting will further subcategorize the item.

Screenshot of the Tell Me page with the UsageCategory property setting.

The Tell Me feature finds pages and reports by searching the captions that are specified on page and report objects.

When creating a report, you need to add the UsageCategory property. If the UsageCategory is set to None, or if you don't specify a UsageCategory, the report won't show up when you search in Dynamics 365 Business Central.

The following list explains the values for the UsageCategory property. The subcategory will help the user navigate through the search results, and it is a best practice to be consistent when categorizing the pages and the reports that you add. A consistent approach will help guide the user and improve productivity.

  • None - The report is not included in search.

  • Lists - The report is sorted as Lists under the Pages and Tasks category.

  • Tasks - The report is sorted as Tasks under the Pages and Tasks category.

  • ReportsAndAnalysis - The report is sorted as Reports and Analysis under the Reports and Analysis category.

  • Documents - The report is sorted as Documents under the Reports and Analysis category.

  • History - The report is sorted as Archive under the Reports and Analysis category.

  • Administration - The report is sorted as Administration under the Pages and Tasks category.

You can specify other words or phrases that can help users find a page or report by using the AdditionalSearchTerms and AdditionalSearchTermsML properties. If the page or report is searchable by Tell Me (that is, the UsageCategory property is set to a value other than None), the search terms that are specified by these properties are used in addition to the caption of the page or report. These properties are useful when the caption doesn't always reflect what users will look for. A good example in Business Central is pages and reports that are associated with items. Users who are unfamiliar with Business Central might look for product or merchandise instead of item.

The following example shows how you can use the UsageCategory and AdditionalSearchTerms properties.

report 50102 Example_DataItems_Join
{
    UsageCategory = ReportsAndAnalysis;
    ApplicationArea = All;
    AdditionalSearchTerms = 'Customer and Ledgers Report';
}

In addition to making a report searchable, you can control the access of an object by providing Read, Insert, Modify, Delete, and Execute (RIMDX) permissions by adding the AccessByPermission property. Likewise, you can control the application area access on the specified object by adding the ApplicationArea property.

The AccessByPermission and ApplicationArea properties are the optional settings, which can be applied with the UsageCategory property. These settings are used to set restrictions on an object when you enable the search functionality.