Monday, August 30, 2021

Power Platform Customizable Help Pages

Model Driven App customizable help allows us to host our help contents in a website (can be SharePoint or any other preferred hosting option). 

To know more about customizable help please read here


Default help button takes users to Microsoft Documentation for Dynamics 365, which is helpful for a implementation which are inline with default capabilities and features. However most of the times we work with projects which are tailored to customer business process.

This help documentation is not so useful when there is a client specific customizations and users require to refer to user guide to know more about the implementation. Unfortunately the user guides are rarely updated & subsequent changes or updates are to be distributed to end-users whenever there is an update. 

What can be done to keep user guides updated with minimal effort, maintained within Dynamics and easily available to users with contextual help. That's where customizable help comes handy. Basic idea is to store the user guide within Dynamics which can be retrieved and shown in a web resource and URL of web resource can be used as customizable help URL.

I have tried to design a basic help storage entities within Model Driven app, which can be configured for contextual data like which entity, what context (weather help is requested from a form) and language.


Rich Text editor allows us to easily copy or create help contents with images etc hosted internally within Dynamics. 
If your project has existing User Guides in word or pdf it can be easily copied and pasted into the Rich Text field.

A Web Resource which retrieves help content based on the URL params in the customizable help feature. Sample web html here

Unmanaged solution for this help implementation is available here

Once imported, Customizable help can be configured in Power Platform Admin center, under Environment Settings -> Features.

Enter Global custom help URL as "/WebResources/helpcc_helppage.html" and enable Append parameters to URL.


Help Pages can be configured by navigating to Help documentation App


Create Help content



If everything is configured correctly as above, clicking help button will take you to help page as per context.


This allows business analyst or consultant to maintain the user guide with latest version. This solution allows us to expand the concept to required horizontal leveraging on power platform capabilities like "Approvals", Versioning etc., as required.