The embedded Self-Service Dashboard
Last updated
Was this helpful?
Last updated
Was this helpful?
The Self-Service Dashboard enables App Builders to embed a customizable dashboard within their SaaS platform, giving End Users the ability to modify their dashboards according to their needs.
The Self-Service Dashboard offers End Users the flexibility to:
Add or remove charts from a pre-existing library.
Rearrange and resize charts to fit their preferences.
Save and publish changes with one click, without affecting the default version of the dashboard.
1 - Create the Generic Dashboard
The App Builder creates a generic dashboard in the Toucan platform, which will serve as the base template for all end users. This dashboard will be embedded within the SaaS platform.
2 - Embed the Dashboard
The App Builder integrates the generic dashboard into their SaaS platform using either an iframe or a web component. This allows the dashboard to be seamlessly accessed within the application.
3 - Manage Dashboard Access
By default, an embedded dashboard is view-only. This corresponds to the ‘can view’ option.
If the App Builder wants a specific dashboard to be editable in embed by End Users, they simply need to select the ‘can edit’ option in the dashboard access management modal, available on the Toucan platform.
4 - Create Tokens for End Users
For each End User who will access the self-service dashboard, the Backend Developer of the SaaS creates a token. This token authenticates users and links them to their personalized dashboard experience.
5 - Personalize the Dashboard
Once the End Users access the dashboard within the SaaS platform, they can begin editing it. When the user starts editing, a personal copy of the dashboard is created for them. This copy remains independent of the original, enabling users to make custom changes without affecting the default version.
For App Builders:
Configure edit or view mode for each embedded dashboard.
For End Users (in embed):
End Users can personalize their own version of the dashboard through the following actions:
Add charts: Select from a library of available charts to enhance your dashboard.
Remove charts: Remove any charts that aren't relevant to your needs.
Rearrange the layout: Move and resize charts to better organize the dashboard according to your preferences.
Save and publish changes: Once satisfied, save and publish your personalized version. These changes are saved privately and do not affect the original dashboard.
Does it delete the default dashboard?
No. When an App Builder embeds a generic dashboard with self-service enabled, editing by an end user creates a custom copy. This custom copy replaces the embedded generic dashboard for that user, but the original dashboard remains intact for other users or for future use.
Can the end user roll back to the default dashboard?
Not in this version. Once the end user has customized their dashboard, they cannot revert to the default version. We plan to introduce this feature in a future release.
Can administrators see the duplicated or deleted dashboards?
No. Administrators cannot view the personal copies created by end users. Each user’s custom dashboard is private to them.
As an end user, can I link/unlink filters to a chart?
Currently, end users cannot modify charts or filters directly. The feature is focused on dashboard layout and chart management, but modifications to filters will be considered for future versions.
As an end user, if I add a story with a new filter, does that filter get added to my dashboard automatically?
Yes, if the story is filtered using a button click filter, the filter will be automatically added to the dashboard along with the story.
⚠️ However, if the story is filtered using YouPrep steps, the filter will not be automatically added to the dashboard when the story is added. This limitation is planned to be addressed in a future product update.
For more information on authentication, a dedicated .
