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:
- Create a minimum of one webpage for the custom help content.
- 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=
.
Exampleurl=http://www.Customhelp.com/Exago;
ImportantSupplying 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
Context Parameter aka "helpKey" | Details |
---|---|
tabexecute | The user is in the Report Viewer. |
ExpressView |
|
tabExpressView | The user has the ExpressView Designer or ExpressView visualization builder active. |
Express Report Wizard |
|
tabExpressName | The user has the Name tab of the Express Report Wizard active. |
tabExpressCategories | 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. |
Chained Report Wizard |
|
tabChainedName | The user has the Names tab of the New Chained Report Wizard active. |
tabChainedReports | The user has the Reports tab of the New Chained Report Wizard active. |
tabChainedOptions | The user has the Options tab of the New Chained Report Wizard active. |
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. |
dialogCrosstabOptions | The user has the CrossTab Data Designer dialog open. |
New Report Wizard |
|
tabAdvancedName | The user has the Names tab of the New Advanced Report Wizard active. |
tabAdvancedCategories | The user has the Categories tab of the New Advanced Report Wizard active. |
tabAdvancedSorts | 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. |
tabAdvancedLayout | 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. |
dialogHtmlOptions | The user has the Report View 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. |
dialogTemplates | 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. |
tabCellFormatBorder | 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. |
dialogShowSQL | The user has the Show Generated SQL Menu active. |
dialofReportLevelParameters | The user has the Report Level Paramers Menu active. |
tabChartType | The user has the Type tab of the Chart menu active. |
dialogChartBenchmarkLine | The user has the Benchmark Line dialog active. |
dialogChartDataFormat | The user has the Chart Data Format tab 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. |
tabChartAppeance | The user has the Appearance tab of the Chart menu active. |
tabChartSizeAndPreview | The user has the Chart Size and Preview 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. |
tabGoogleMapAppearance | The user has the Appearance tab of the Google Maps menu active. |
tabGoogleMapLocations | The user has the Locations tab of the Google Maps menu active. |
tabGoogleMapData | The user has the Data tab of the Google Maps menu active. |
tabGoogleMapSizeAndPreview | The user has the Size and Preview tab of the Google Maps menu active. |
listItemReportCacheOptionsGeneral | The user has the Execution Caching menu active. |
Dashboards |
|
tabDashboard | The user has the Dashboard Viewer active |
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. |
tabScheduleBatch | The user has the Batch tab of of the New Schedule Wizard active. |
TipCreate 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.