Dashboard Templates¶
A dashboard template is a saved set of widgets that several users can apply. Attached to a role, it becomes that role's starting dashboard: a new member finds their department's widgets instead of an empty page — and can return to them at any time.
It is the counterpart of Grid Templates for tables, one dimension simpler: a user has one dashboard, so a role has exactly one starting template.
Permissions¶
| Operation | Allows |
|---|---|
| (none) | Applying visible templates and resetting to the role's starting template |
dashboard_template_saveas |
Saving the user's own dashboard as a personal template |
dashboard_template_admin |
Managing templates, attaching them to roles, picking each role's starting template |
A user sees what is system-wide, what belongs to them, and what is assigned to one of their roles. Other people's personal templates stay hidden.
Create a template — the recommended way¶
Build the dashboard, then save it from there:
- Set up the dashboard: add widgets, position and size them
- Open Templates in the header
- Under Save current dashboard as template, give it a name and description
- With
dashboard_template_admin, additionally tick Share with roles, pick the roles and optionally set Start template for these roles - Save resp. Save and share
Creating and assigning are one step, and you see the real dashboard while building it instead of a list of widget names.
The template is a copy
Rearranging your dashboard afterwards does not change the template. That is exactly why "Reset" returns to the saved state and not to the one from a minute ago.
Tiles backed by an advanced filter
The filter result count and filter statistic tiles point at a saved
advanced filter.
That filter belongs to whoever created it — for everyone else the tile
would stay empty. For the template to arrive complete, the filter has to be
shared: with the same roles as the template, or with everyone. That is
done in the grid's filter panel and requires the Share Advanced Filters
permission (advanced_filter_share).
Only the formula is shared: every recipient counts across the records they are allowed to see themselves. Two users can therefore get different numbers from the same tile — that is intended.
Manage templates¶
Administration > Data Model > Dashboard Templates
(/v2/admin/data-model?tab=3) lists the whole stock: rename, describe, make
system-wide, order, delete. The tab sits next to the
Grid Templates — both answer what a user finds when
they open something. The old address /v2/admin/dashboard-templates redirects
there.
- System-wide means visible to every user, even without a role assignment. A system-wide template is also the starting dashboard for users whose role has none of its own.
- Nothing is created here — a template's widgets come from a real dashboard.
- Deleting a template takes its role assignments with it. Dashboards already built from it stay untouched: they are copies, not references.
Assign roles¶
Under Administration > Roles > role > Dashboard templates:
- A role can hold several templates; its members may apply any of them.
- The starting template is exactly one per role. A new member receives it on their first visit, and "Templates > Reset" returns to it. A new default clears the mark on the previous template of that role.
- A template assigned to a role loses its personal owner: from then on it belongs to the operation.
Several roles per user
A user holding several roles with different starting templates starts with one of them — stable, but not for a reason anyone chose. Where that matters, set the same starting template for the roles involved.
Starting dashboard for new users¶
A user with no dashboard at all receives their role's starting template on their first visit to the start page, or the system-wide one. With neither, the empty state stays as it is — nothing is created without a template behind it.
Existing dashboards are never touched. Whoever rebuilt theirs keeps it; the way back is Templates > Reset.
Reset¶
In the Templates dialog, the role's starting template sits at the top with a Reset button. It replaces the widgets of the active dashboard with the template's; the name the user gave their dashboard stays.
Every other visible template can be applied the same way — either into the active dashboard (Apply) or next to it as an additional dashboard (Apply as new dashboard).