Exago is installed with context sensitive help. When a user clicks the help button a tab appears displaying 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:
- Create a webpage for the custom help.
- Set the URL of the webpage in the Custom Help Source parameter in Feature/UI Settings. Ex url=http://www.Customhelp.com/Exago;
NOTE. When a user clicks the help button Exago will populate a tab with the content received from the URL. To notify the host application the user’s language the URL will be appended with the ‘Language File’ of Main Settings and a context parameter (listed below). Ex. http://www.customhelp.com/Exago?helpKey= newreport&language=en-us
|
Context Parameter |
Details |
|
tabexecute |
The user has report output active. |
|
Express Report Wizard |
|
|
tabExpressName |
The user has the Name tab of the Express Report Wizard active. |
|
tabExpressCatepgories |
The user has the Categories tab of the Express Report Wizard active. |
|
tabExpressSorts |
The user has the Sorts tab of the Express Report Wizard active. |
|
tabExpressFilters |
The user has the Filters tab of the Express Report Wizard active. |
|
tabExpressLayout |
The user has the Layout tab of the Express Report Wizard active. |
|
tabExpressOptions |
The user has the Options tab of the Express Report Wizard active. |
|
New Crosstab Wizard |
|
|
tabCrosstabName |
The user has the Names tab of the New Crosstab Report Wizard active. |
|
tabCrosstabCategories |
The user has the Categories tab of the New Crosstab Report Wizard active. |
|
tabCrosstabFilters |
The user has the Filters tab of the New Crosstab Report Wizard active. |
|
tabCrosstabLayout |
The user has the Layout tab of the New Crosstab Report Wizard active. |
|
New Report Wizard |
|
|
tabStandardName |
The user has the Names tab of the New Advanced Report Wizard active. |
|
tabStandardCategories |
The user has the Categories tab of the New Advanced Report Wizard active. |
|
tabStandardSorts |
The user has the Sorts tab of the New Advanced Report Wizard active. |
|
tabStandardFilters |
The user has the Filters tab of the New Advanced Report Wizard active. |
|
tabStandardLayout |
The user has the Layout tab of the New Advanced Report Wizard active. |
|
Report Designer |
|
|
tabDesign |
The user is editing an Advanced or Crosstab report and has the design grid active. |
|
dialogName |
The user has the Rename Menu active. |
|
dialogDescription |
The user has the Description Menu active. |
|
dialogCategories |
The user has the Categories Menu active. |
|
dialogSorts |
The user has the Sorts Menu active. |
|
dialogFilters |
The user has the Filters Menu active. |
|
dialogGeneralOptions |
The user has the Options Menu active. |
|
listItemReportHtmlOptionsGeneral |
The user has the General section of the HTML Options active. |
|
listItemReportHtmlOptionsFilters |
The user has the Filter section of the HTML Options active. |
|
listItemReportHtmlOptionsSorts |
The user has the Sorts section of the HTML Options active. |
|
dialogTemplate |
The user has the Template Menu active. |
|
dialogJoins |
The user has the Advanced Menu active. |
|
dialogJoinEdit |
The user has the Report Join Menu active. |
|
dialogFormulaEditor |
The user has the Formula Editor active. |
|
dialogLinkedReport |
The user has the Linked Report Menu active. |
|
tabCellFormatNumber |
The user has the Number tab of the Cell Format Menu active. |
|
tabCellFormatBoder |
The user has the Border tab of the Cell Format Menu active. |
|
tabCellFormatConditional |
The user has the Conditional tab of the Cell Format Menu active. |
|
dialogCrosstabDesign |
The user has the Crosstab Menu active. |
|
dialogGroup |
The user has the Group Section Menu active. |
|
dialogSectionShading |
The user has the Section Shading Menu active. |
|
tabChartType |
The user has the Type tab of the Chart menu active. |
|
tabChartLabels |
The user has the Labels tab of the Chart menu active. |
|
tabChartData |
The user has the Data tab of the Chart menu active. |
|
tabMapType |
The user has the Type tab of the Map menu active. |
|
tabMapLocations |
The user has the Locations tab of the Map menu active. |
|
tabMapData |
The user has the Data tab of the Map menu active. |
|
tabGaugeType |
The user has the Appearance tab of the Gauge menu active. |
|
tabGaugeData |
The user has the Data tab of the Gauge menu active. |
|
Dashboards |
|
|
tabDashboardDesigner |
The user has the Dashboard designer active. |
|
dialogDashboardUrlOptions |
The user has the Insert Url menu active. |
|
dialogDashboardName |
The user has the Dashboard Rename menu active. |
|
dialogDashboardDescription |
The user has the Dashboard Description menu active. |
|
dialogDashboardOptions |
The user has the Dashboard Options menu active. |
|
tabDashboardReportOptions |
The user has the Report tab of the Insert Report menu active. |
|
tabDashboardReportOptionsFilterPrompts |
The user has the Filters tab of the Insert Report menu active. |
|
tabDashboardReportOptionsParameterPrompts |
The user has the Parameters tab of the Insert Report menu active. |
|
tabDashboardReportOptionsOptions |
The user has the Options tab of the Insert Report menu active. |
|
tabDashboardFilterOptionsReports |
The user has the Reports tab of the Insert Filter menu active. |
|
tabDashboardFilterOptionsFilter |
The user has the Filter tab of the Insert Filter menu active. |
|
dialogDashboardVisualizationOptions |
The user has the Options menu of a Data Visualization active. |
|
Scheduler |
|
|
tabScheduleReportManager |
The user has the Schedule Report Manager active. |
|
tabScheduleRecurrence |
The user has the Recurrence tab of the New Schedule Wizard active. |
|
tabScheduleParameters |
The user has the Parameter tab of the New Schedule Wizard active. |
|
tabScheduleFilters |
The user has the Filter tab of the New Schedule Wizard active. |
|
tabScheduleRecipients |
The user has the Recipients tab of the New Schedule Wizard active. |
NOTE. 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 shown.