Edit

Add context-sensitive Help links to AL objects

When you create pages, queries, or request pages for reports and XMLports, you can specify which Help file opens when the user selects a Learn more link in the Business Central interface.

The context-sensitive Help link combines a configuration setting in the app.json file with the name of the relevant Help file that you specify in the object metadata. Learn more about the configuration in Configure context-sensitive Help.

The following examples show how you can specify the ContextSensitiveHelpPage property on a page and on request pages for reports and XMLports:

page 50100 MyPageWithHelp
{
    ContextSensitiveHelpPage = 'sales-rewards';
}
report 50100 MyReportWithHelp
{
    requestpage
    {
        ContextSensitiveHelpPage = 'sales-rewards';
    }
}
xmlport 50100 XmlPortWithHelp
{
    requestpage
    {
        ContextSensitiveHelpPage = 'sales-rewards';
    }
}

All three examples set the ContextSensitiveHelpPage property to the same Help file because the objects support the feature described in the sales-rewards Help article. You can structure Help differently in your app.

Configure Context-Sensitive Help
Translating Base App Help
JSON Files
Page Object
Report Object
XMLport Object
Query object
ContextSensitiveHelpPage Property