Customizable Help

Customizable Help

You may determine that you want to customize the Help functionality of CRM. Customizable Help allows you to customize the help content. The end-users see the help content when selecting the help icon in the top right corner. As an administrator, you have the option to direct the user to a completely new location (URL) when they click that button. What makes this feature really cool is not only can you customize the help globally, but you can also customize it for individual customizable entities. In this blog, we’ll show you how to do that.

Customizing Help Globally

To get started you will first need to select System Settings under Settings > Administration.

Next, to custom help globally in the system you will want to go down the to the Set custom Help URL section under the General tab in the System Settings and follow these steps.

  • Select “Yes” for Use custom Help for customizable entities
  • Enter the “URL” where your custom help is stored
  • Select “No” for append parameters for URL

Now when a user selects the Help icon your custom help URL will now be displayed globally in a new tab to help your users!

Customize Help for Individual Entities

If you want to display custom help for individual entities you can do that as well! To do this you will need to first decide if you want to set Append parameters to URL as “Yes” in the Set custom Help URL section of in the General tab under System Settings (Screen referenced above).

Next you will want to select the entity you wish to display your custom help under. To get there, go to Settings > Customizations > Customize the System and follow these steps.

  1. Click on the custom entity from the left side navigation panel.
  1. Now under the General tab in the Help section, select Use custom help and enter the URL that contains your custom help.

Note: Setting the Append parameter to URL as “yes” is not mandatory, but setting to “yes” will put a parameter (user language code/ entity name/ form ID) on the custom URL which will allow a developer to easily show the proper custom help for certain entities that require custom help. See below for example:

Now when you select help in the selected entity, your custom help URL will display and you can now have help that makes sense to your users and your customized CRM system.

Having the ability to customize your help is a feature of CRM that you can use to drive adoption and improve your users experience with CRM.