Guide for embedding HappySignals widgets in ServiceNow pre-Xanadu: create legacy dashboards, add widgets, verify roles, ACLs, and HappyConstants.
Background
ServiceNow’s Xanadu release removed the old Core UI framework that HappySignals widgets relied on. This means that in instances created after Xanadu, the traditional method of embedding widgets no longer works.
However, if your instance was created before Xanadu, you can still use the legacy dashboard functionality to add HappySignals widgets.
Steps to Embed Widgets in Pre-Xanadu Instances
- Navigate to
pa_dashboards.list
in your ServiceNow instance. - Create a new dashboard and wait a few moments for it to appear in the list.
- Open the newly created dashboard and look for the “View Dashboard” related link.
- If the dashboard opens with the message:
“Add widgets using the widget picker.”
You are in the correct (legacy) dashboard view. - Use the widget picker to search for and add the desired HappySignals widgets:
- Overall Scores
- Agent Scores
- Feedback
- After creating the dashboard, you can migrate it to the new dashboard framework using the Migration Center if needed.
Important Role and ACL Checks
Even in Pre-Xanadu instances, ensure the following for proper widget functionality:
-
Required Roles:
x_pgo_happysignals.happy_agent
(for agent view)x_pgo_happysignals.happy_global_manager
(for manager view)
-
ACL Verification:
- Check ACLs for the HappySignals Surveys table.
- Make sure no custom ACLs block visibility.
-
HappyConstants Script Include:
- Add any custom tables if used.
- Verify that the fields
resolved_user
andrelated_user
are correctly defined.
Best Practice
- If your instance was created after Xanadu, widgets cannot be embedded using this method. Consider using Platform Analytics dashboards or custom reports based on HappySignals data tables.
- Keep your documentation up to date and monitor HappySignals announcements for future widget solutions.