Custom Context Sensitive Help

Exago is installed with context sensitive help. When a user clicks the Help icon a tab opens to display the appropriate section of the Exago User Guide. The content of this tab can be replaced with custom content managed by the host application.

To implement Custom Context Sensitive Help:

1. Create a minimum of one webpage for the custom help content.
2. Set the Admin Console > General Settings > Feature/UI Settings > Custom Help Source setting to the URL of the webpage from step 1. Prefix the URL with url=.
   Example

   url=http://www.Customhelp.com/Exago;

Important

Supplying a value for the Custom Help Source will replace the Exago provided help system throughout the entire application.

Now, when a user clicks the Help icon a tab opens to display the content from the supplied Custom Help Source URL.

The user’s language and a context parameter will be appended as a query string to the URL.

• The language is determined by the value of the Admin Console > General Settings > Main Settings > Language File setting.
• The context parameter is determined by where in the application the user clicked the Help  icon, selected from Table A below.

Example

http://www.customhelp.com/Exago?helpKey=tabChartType&language=en-us

Tip

Create a default page to handle any cases where an undocumented or null context parameter is passed. This guarantees that a valid help page will always be displayed.