Exago Logo
Search
Generic filters
Exact matches only

Custom Context Sensitive Help

Exago is installed with context sensitive help. When a user clicks the Help Help.png 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 Help.png 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 Help.png icon, selected from Table A below.

Example

http://www.customhelp.com/Exago?helpKey=tabChartType&language=en-us
Table A — Custom Context Help Context Parameters
Context Parameter aka “helpKey”Details
tabexecuteThe user is in the Report Viewer.

ExpressView

tabExpressViewThe user has the ExpressView Designer active.
tabExpressViewFilter v2019.2.37+v2020.1.20+v2021.1.8+The user is interacting with the Filters tab of the ExpressView Designer’s Properties Pane
tabExpressViewSort v2019.2.37+v2020.1.20+v2021.1.8+The user is interacting with the Sorts tab of the ExpressView Designer’s Properties Pane
tabExpressViewViz v2019.2.37+v2020.1.20+v2021.1.8+The user is interacting with the Visualizations tab of the ExpressView Designer’s Properties Pane
dialogExpressViewFormulaEditor v2019.2.37+v2020.1.20+v2021.1.8+The user has the Formula Builder in the ExpressView Designer open.

Express Report Wizard

tabExpressNameThe user has the Name tab of the Express Report Wizard active.
tabExpressCategoriesThe user has the Categories tab of the Express Report Wizard active.
tabExpressSortsThe user has the Sorts tab of the Express Report Wizard active.
tabExpressFiltersThe user has the Filters tab of the Express Report Wizard active.
tabExpressLayoutThe user has the Layout tab of the Express Report Wizard active.
tabExpressOptionsThe user has the Options tab of the Express Report Wizard active.

Chained Report Wizard

tabChainedNameThe user has the Names tab of the New Chained Report Wizard active.
tabChainedReportsThe user has the Reports tab of the New Chained Report Wizard active.
tabChainedOptionsThe user has the Options tab of the New Chained Report Wizard active.

CrossTab Wizard

tabCrosstabNameThe user has the Names tab of the New CrossTab Report Wizard active.
tabCrosstabCategoriesThe user has the Categories tab of the New CrossTab Report Wizard active.
tabCrosstabFiltersThe user has the Filters tab of the New CrossTab Report Wizard active.
tabCrosstabLayoutThe user has the Layout tab of the New CrossTab Report Wizard active.
dialogCrosstabOptionsThe user has the CrossTab Data Designer dialog open.

New Report Wizard pre-v2021.1

tabAdvancedName pre-v2021.1The user has the Names tab of the New Advanced Report Wizard active.
tabAdvancedCategories pre-v2021.1The user has the Categories tab of the New Advanced Report Wizard active.
tabAdvancedSorts pre-v2021.1The user has the Sorts tab of the New Advanced Report Wizard active.
tabStandardFilters pre-v2021.1The user has the Filters tab of the New Advanced Report Wizard active.
tabAdvancedLayout pre-v2021.1The user has the Layout tab of the New Advanced Report Wizard active.

Report Designer

tabDesignThe user is editing an Advanced or CrossTab report in the Advanced Report Designer.
dialogNameThe user has the Rename Menu active.
This key is never called in v2021.1+
dialogDescriptionThe user has the Description Menu active.
This key is never called in v2021.1+
dialogCategoriesThe user has the Categories/Manage Data Objects dialog open.
dialogSortsThe user has the Sorts dialog open.
dialogFiltersThe user has the Filters dialog open.
dialogGeneralOptionsThe user has the General Options dialog open.
dialogHtmlOptionsThe user has the Report Viewer Options dialog open.
listItemReportHtmlOptionsGeneralThe user has the General section of the Report Viewer Options dialog open.
listItemReportHtmlOptionsFiltersThe user has the Filter section of the Report Viewer Options dialog open.
listItemReportHtmlOptionsSortsThe user has the Sorts section of the Report Viewer Options dialog open.
dialogTemplatesThe user has the Template dialog open.
dialogJoinsThe user has the Joins dialog open.
dialogJoinEditThe user has the Joins dialog open.
dialogFormulaEditorThe user has the Formula Editor open.
dialogLinkedReportThe user has the Linked Report dialog open.
tabCellFormatNumberThe user has the Number tab of the Cell Format dialog active.
tabCellFormatBorderThe user has the Border tab of the Cell Format dialog active.
tabCellFormatConditionalThe user has the Conditional tab of the Cell Format dialog active.
dialogCrosstabDesignThe user has the CrossTab Data Designer dialog open.
dialogGroupThe user has the Group Section dialog open.
dialogSectionShadingThe user has the Section Shading dialog open.
dialogShowSQLThe user has the Show Generated SQL open.
dialofReportLevelParametersThe user has the Report Level Parameters open.
tabChartTypeThe user has the Type tab of the Chart Wizard open.
dialogChartBenchmarkLineThe user has the Benchmark Lines dialog open.
dialogChartDataFormatThe user has the Data Layout… dialog of the Chart Wizard open.
tabChartLabelsThe user has the Labels tab of the Chart menu open.
tabChartDataThe user has the Data tab of the Chart Wizard open.
tabChartAppeanceThe user has the Appearance tab of the Chart menu active.
tabChartSizeAndPreviewThe user has the Size and Preview tab of the Chart Wizard open.
tabMapTypeThe user has the Type tab of the GeoChart Wizard open.
tabMapLocationsThe user has the Locations tab of the GeoChart Wizard open.
tabMapDataThe user has the Data tab of the GeoChart Wizard open.
tabGaugeTypeThe user has the Appearance tab of the Gauge Wizard open.
tabGaugeDataThe user has the Data tab of the Gauge Wizard open.
tabGoogleMapAppearanceThe user has the Appearance tab of the Google Maps Wizard open.
tabGoogleMapLocationsThe user has the Locations tab of the Google Maps Wizard open.
tabGoogleMapDataThe user has the Data tab of the Google Maps Wizard open.
tabGoogleMapSizeAndPreviewThe user has the Size and Preview tab of the Google Maps Wizard open.
listItemReportCacheOptionsGeneralThe user has the Execution Caching dialog open.

Dashboards

tabDashboardThe user has the Dashboard Viewer active
tabDashboardDesignerThe user has the Dashboard Designer active.
dialogDashboardUrlOptionsThe user is adding or editing a URL tile on the canvas.
dialogDasboardImageOptions v2019.2.37+v2020.1.20+v2021.1.8+The user is adding or editing an Image tile on the canvas.
dialogDashboardTextOptions v2019.2.37+v2020.1.20+v2021.1.8+The user is adding or editing a Text tile on the canvas.
dialogDashboardNameThe user has the Dashboard Rename menu active.
dialogDashboardDescriptionThe user has the Dashboard Description menu active.
dialogDashboardOptionsThe user has the Dashboard Options menu active.
tabDashboardReportOptionsThe user is adding or editing an Existing Report tile.
tabDashboardReportOptionsFilterPromptsThe user is interacting with the Filters menu.
tabDashboardReportOptionsParameterPromptsThe user is interacting with the Parameters menu.
tabDashboardReportOptionsOptionsThe user has the Options tab of the Insert Report menu active.
tabDashboardFilterOptionsReportsThe user has the Reports tab of the Insert Filter menu active.
tabDashboardFilterOptionsFilterThe user has the Filter tab of the Insert Filter menu active.
dialogDashboardVisualizationOptionsThe user is adding or editing a visualization tile.

Scheduler

tabScheduleReportManagerThe user has the Schedule Report Manager active.
tabScheduleRecurrenceThe user has the Recurrence tab of the New Schedule Wizard active.
tabScheduleParametersThe user has the Parameter tab of the New Schedule Wizard active.
tabScheduleFiltersThe user has the Filter tab of the New Schedule Wizard active.
tabScheduleRecipientsThe user has the Recipients tab of the New Schedule Wizard active.
tabScheduleBatchThe user has the Batch tab of of the New Schedule Wizard active.

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.

Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents