Custom Get Started Pane for help or video file

Let’s suppose we want to embed a video or html help file for Account entity on Get Started Pane of Account entity.

The default content for the get started pane is located with the Help content. The content is exposed in the application through attributes in the <SubArea> (SiteMap) element for specific entities. This content cannot be included in a solution and, therefore, cannot be transported with a solution.

To create custom get started pane content, the Microsoft Dynamics CRM SDK includes a set of files that replicate the appearance and behavior of the get started pane pages. These files are located at SDK\Resources\GetStartedPaneTemplate.

Below are steps to create custom get started pane.

Steps:

We want to place a custom video and help file on Get Started Pane of Account entity.

Step #1 Import solution “helpvisorcomponents_1_0_0_0” which is available at \sdk\resources\getstartedpanetemplate of CRM 2011 sdk.

Step #2 Create a virtual directory (Let’s say” Video”) on server in ISV folder of CRMWeb
and keep the video file there. Update the below url in helpvisortemplate1.htm file.
URL: http://<CrmServer>:5555/ISV/Video/newCRMjquery_ch9.wmv

Step #3 Edit the “helpvisortemplate.htm” file which is at \sdk\resources\getstartedpanetemplate\helpvisor\1033 of CRM 2011 Sdk and rename the file name as helpvisortemplate1.htm .

Step #4 Create html help file say Help.htm.

Step #5 Create below Web Resources in same solution with similar structure as below

sample_/1033/HelpVisorTemplate1.htm
sample_/1033/Content/Help.htm

Step #6 Add the Site Map to existing solution and export it for editing.

Step #7 Open customization.xml file from exported solution in edit mode.

Replace below code (Usually at 4 places)

<SubArea Id=”nav_accts” DescriptionResourceId=”Account_SubArea_Description” Entity=”account” GetStartedPanePath=”Accounts_Web_User_Visor.html” GetStartedPanePathAdmin=”Accounts_Web_Admin_Visor.html” GetStartedPanePathOutlook=”Accounts_Outlook_User_Visor.html” GetStartedPanePathAdminOutlook=”Accounts_Outlook_Admin_Visor.html” />
With below code
<!–
<SubArea Id=”nav_accts” DescriptionResourceId=”Account_SubArea_Description” Entity=”account” GetStartedPanePath=”Accounts_Web_User_Visor.html” GetStartedPanePathAdmin=”Accounts_Web_Admin_Visor.html” GetStartedPanePathOutlook=”Accounts_Outlook_User_Visor.html” GetStartedPanePathAdminOutlook=”Accounts_Outlook_Admin_Visor.html” />
–>

<SubArea Id=”nav_accts” DescriptionResourceId=”Account_SubArea_Description” Entity=”account” GetStartedPanePath=”$webresource:sample_/redir.htm?data=HelpVisorTemplate1.htm” GetStartedPanePathAdmin=”$webresource:sample_/redir.htm?data=HelpVisorTemplate1.htm” GetStartedPanePathOutlook=”$webresource:sample_/redir.htm?data=HelpVisorTemplate1.htm” GetStartedPanePathAdminOutlook=”$webresource:sample_/redir.htm?data=HelpVisorTemplate1.htm” />

Step #8 Save the customization.xml file
Step #9 Zip all the file with updated customization.xml
Step #10 Import the updated solution and publish all customization.
Step #11 the final output should look like as below.
Step #12 on click of video link; it will play a custom video (not out of box) file in media player and “Help”
link will open html help file.

Author: Arvind Singh

Solution Architect with 17+ years of exp. In Dynamics CRM, Power Platform, Azure which includes Solution, Design, Development, Deployment, Maintenance and support experience. View all posts by Arvind Singh