Adding help links from pages, reports, and XMLports

  • Article

When creating new pages, you can specify which Help file to open if the user selects the Learn more links in the UI of Business Central.

The context-sensitive Help link is generated based on a configuration setting in the app.json file and the name of the relevant Help file that you specify as part of the metadata for the page object. For more information, see Configure Context-Sensitive Help.

Examples

The following examples show how you can specify the ContextSensitiveHelpPage property from new pages, reports, and XMLports:

page 50100 MyPageWithHelp
{
    ContextSensitiveHelpPage = 'sales-rewards';
}

report 50100 MyReportWithHelp
{
    requestpage
    {
        ContextSensitiveHelpPage = 'sales-rewards';
    }
}

xmlport 50100 XmlPortWithHelp
{
    requestpage
    {
        ContextSensitiveHelpPage = 'sales-rewards';
    }
}

In all three examples, the ContextSensitiveHelpPage property is set to point at the same Help file. This is because all three example objects support the same feature that is explained in the sales-rewards Help article. In your app, you can choose to structure the Help differently.

See Also

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