The Business Central Tell Me Pages and Reports client includes the Tell me feature that lets users find objects and online help articles by entering search terms. When you have inserted a page or a report in your extension, you will want it to be discoverable to users in Tell me.
In AL, you make a page or report searchable from Tell me by setting the UsageCategory property in code. The UsageCategory setting will make the page or report searchable, and the value chosen for the setting will further sub categorize the item.
Business Central Tell Me Pages and Reports finds pages and reports by searching the captions that are specified on page and report objects by the CaptionML property.
Business Central Tell Me Pages and Reports Overview
1. Working with the UsageCategory Property
When you create a Page or a Report, you add the UsageCategory Property. If the UsageCategory is set to None, or if you do not specify UsageCategory, the page or report will not show up when you search in Dynamics 365 Business Central.
UsageCategory Property Values
The values for the UsageCategory property are listed below. The sub category 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 steady approach will help guiding the user and improve productivity.
|None||Page or report is not included in search.|
|Lists||The page or report is listed as Lists under the Pages and Tasks category.|
|Tasks||The page or report is listed as Tasks under the Pages and Tasks category.|
|ReportsAndAnalysis||Page or report is listed as Reports and Analysis under the Reports and Analysiscategory.|
|Documents||The page or report is listed as Documents under the Reports and Analysis category.|
|History||Page or report is listed as Archive under the Reports and Analysis category.|
|Administration||The page or report is listed as Administration under the Pages and Tasks category.|
2. Adding Additional Search Terms
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, the search terms specified by these properties are used in addition to the caption of the page or report.
These Business Central Tell Me Pages and Reports properties are useful when the caption does not always reflect what users will look for. A good example of this in MS D365 BC is pages and reports associated with Item. Users unfamiliar with Business Central might look for ‘product’ or ‘merchandise’ instead of ‘item’.
For Business Central on-premises, the Business Central Web Server configuration file (navsettings.json) includes a setting called
UseAdditionalSearchTerms that enables or disables the use of additional search terms by the Tell me.
The following example creates a
SimpleItemList page and sets a
UsageCategory property to the page, so that the
SimpleItemList page is accessible through search utilizing the Tell me feature. Also, the example sets the
AdditionalSearchTerms property to add two search terms for the page.
page 50210 SimpleItemList
PageType = List;
SourceTable = Item;
UsageCategory = Lists;
AccessByPermission = page SimpleItemList = X;
ApplicationArea = All;
AdditionalSearchTerms = ‘product, merchandise’;
3. Optional Settings
Also to making a page or 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, control the application area access on the specified object by adding the ApplicationArea Property.
The AccessByPermission property and ApplicationArea property 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.
Sets a value for a table field or UI element that determines the permission mask for an object that a user should see and use the related page fields or UI element in the client.
The UI element will be removed at runtime if the user does not have access to a certain object as specified in the AccessByPermission property.
All types of UI elements will be removed if they relate to an object to which the user does not have the required permissions:
- Fields on pages, including FactBoxes
- Actions on pages, including toolbars and navigation panes
- Page parts, such as Lines FastTabs
AccessByPermission = tabledata MySetup = I;
The UsageCategory property is a required setting used together with the AccessByPermission property. This enables a page or a report to be available in Search for the navigation support.
The property value for TableData can be set with a combination of Read, Insert, Modify and Delete permissions. This means, you can set the property value to
RIMD permissions; the value
X is not valid for TableData.
For other objects including Table, Page, Query, Report, Codeunit, or Xmlport, it can only be Execute permission. This means, you can set the property value to
X for the specified object type.
Working in the Dynamics NAV Development Environment
If you are using the Dynamics NAV Development Environment, you can also set UsageCategory, AdditionalSearchTerms, AccessByPermission, and ApplicationArea properties on pages and reports to control their search.
After you change these properties by using the MS Dynamics NAV Development Environment, before the changes take effect in the client, you must execute Build Object Search Index from the Tools menu. For more information on Microsoft Dynamics 365 Business Central Tell Me Pages and Reports, please contact us.