Configuring the theme for overlay reports | HCL Digital Experience
To integrate the overlay analytics features into your theme, add a theme module to the theme profiles of your modular theme. If you do not add the theme, the overlay menu items are not displayed.
Before you begin
Locate the overlay analytics features that
are provided by the theme module wp_analytics_overlay_reports
.
This theme module contains a menu contribution, which defines the
menu entries that display or hide the overlay reports in the portal
user interface. In the default theme, these menu entries are integrated
into the Actions menu of the theme.
About this task
Procedure
- Open the menu definition file for the Actions menu. It is in WebDAV at fs-type1/themes/Portal8.5/menuDefinitions/pageAction.json
- In the menu definition file, find the menu entry of type
ModuleRef
, which references the theme modulewp_analytics_overlay_reports
.For example:{ "type":"ModuleRef", "id":"wp_analytics_overlay_reports" },
- To add the theme module for analytics overlay to a deferred
theme profile, add the module code to the deferred section of the
profile in WebDAV to fs-type1/themes/Portal8.5/profiles/profile_deferred.json.
In the following example, add the
deferredModuleIDs
code between theModuleIDs
and thewp_analytics_overlay_reports
line.{ "moduleIDs": [ ... modules that are loaded immediately... ... ], "deferredModuleIDs": [ ... modules that are deferred... ... "wp_analytics_overlay_reports", ... ], ... }
- Restart your Portal server or invalidate the resource aggregator cache. To invalidate your cache, click Auto invalidation recognizes your changes automatically for WebDAV based themes. No further action is required. For more information, see Utilities. .
What to do next
The theme module menu entries are displayed only if the
theme module wp_analytics_overlay_reports
is part
of the theme profile. The theme profile is associated with the portal
page that is being rendered.
If you have a custom modular theme, you can use the same approach to integrate the overlay features into a different menu.