Skip to content

Commit 36f167b

Browse files
authored
docs(dashboards): update to describe current behaviour of system (#562)
1. index.md (Dashboards overview) - Removed the outdated "only available in MODX 2.2 or later" line (this is the 3.x branch) - Added a new Customizable Dashboards section explaining the Customizable checkbox, per-user cloning, and what happens when it's unchecked - Added a How Template Changes Propagate subsection explaining that widget additions/removals from the manager propagate to all users, while direct dashboard changes are per-user only 2. managing.md (Managing Your Dashboard) - Added a Template vs Personal Changes section clarifying that edits on this page update the template, that additions/removals propagate to all users, and that direct dashboard page changes only affect the current user - Included practical guidance on when to use each editing interface 3. usergroups.md (Assigning to a User Group) - Fixed the intro line (it previously said "how to edit a Dashboard" which was copy-pasted from the managing page) - Added a Customizable Dashboards and User Groups section explaining that personal copies are created on first login, and that subsequent template changes propagate 4. creating-a-widget.md (Creating a Dashboard Widget) - Added a blockquote note after the "Assigning the Widget" instructions explaining the difference between adding a widget via the manager (template-level, affects all users) vs directly on the dashboard (per-user only) - Included a performance note about placement records on large sites
1 parent 324c761 commit 36f167b

File tree

4 files changed

+41
-3
lines changed

4 files changed

+41
-3
lines changed

en/building-sites/client-proofing/dashboards/creating-a-widget.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ From here, click the "Place Widget" button above the Widgets grid on this page.
4141

4242
Save your Dashboard.
4343

44+
> **Note:** Adding a widget through the Dashboards manager page (as described above) places it on the dashboard **template**. If the dashboard is [customizable](building-sites/client-proofing/dashboards "Dashboards"), the widget will automatically appear for all existing users of that dashboard, as well as any new users.
45+
>
46+
> Adding a widget directly on the dashboard page (via the dashboard view itself) only adds it for the currently logged-in user. Other users will not see it unless it is also added to the template.
47+
>
48+
> On large sites with many users, adding a widget to the template will create a placement record for each user who already has a personal copy of that dashboard. Keep this in mind if performance is a concern.
49+
4450
### Viewing the Widget
4551

4652
Now, if you click the "Dashboard" top menu item on the page, you can see your new dashboard widget in place!

en/building-sites/client-proofing/dashboards/index.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ _old_id: "90"
44
_old_uri: "2.x/administering-your-site/dashboards"
55
---
66

7-
Dashboards are only available in MODX 2.2 or later.
8-
97
## What are Dashboards?
108

119
A Dashboard in MODX is the page that shows on initial loading of the MODX manager, or when clicking the "Dashboard" link in the top-left of the screen. Dashboards can contain an unlimited number of "widgets", which are boxes that show various content on the Dashboard. Widgets can be arranged in any order, and can be either a file, a MODX Snippet, or straight HTML.
@@ -14,6 +12,23 @@ Each User Group in MODX is assigned a Dashboard by default. This means that you
1412

1513
If a User is part of two different groups, it will use the Dashboard of its Primary Group, which can be set in the User editing screen.
1614

15+
## Customizable Dashboards
16+
17+
Dashboards have a **Customizable** setting. When this is checked (the default), MODX clones the dashboard's widget layout for each user the first time they load the dashboard. This gives each user their own personal copy of the dashboard, which they can then rearrange, add widgets to, or remove widgets from without affecting other users.
18+
19+
When **Customizable** is unchecked, all users share the same dashboard layout and cannot make personal changes to it.
20+
21+
### How Template Changes Propagate
22+
23+
The widget layout configured through the Dashboards manager page (Dashboard -> Dashboards -> Update Dashboard) serves as the **template** for a customizable dashboard. When you add or remove widgets from the template, those changes propagate to all existing users of that dashboard:
24+
25+
- **Widgets added** to the template will automatically appear for all users who already have a personal copy of the dashboard.
26+
- **Widgets removed** from the template will be removed from all users' personal dashboards.
27+
28+
Other personal customizations, such as widget order, are not affected by template changes.
29+
30+
Changes made directly on a user's dashboard page (for example, removing a widget with the close button or adding a widget via the dashboard itself) only affect that individual user and do not change the template.
31+
1732
## Using Dashboards
1833

1934
- [Managing Your Dashboard](building-sites/client-proofing/dashboards/managing "Managing Your Dashboard")

en/building-sites/client-proofing/dashboards/managing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,17 @@ You will see a name and description field, and below, a grid of Widgets assigned
1414

1515
![](dashboard-edit.png)
1616

17+
## Template vs Personal Changes
18+
19+
Changes made on this page update the dashboard **template**. For [customizable dashboards](building-sites/client-proofing/dashboards "Dashboards"), template changes are propagated to all users who have a personal copy of that dashboard:
20+
21+
- When you **add a widget** here, it will appear on the dashboard for all existing users of that dashboard.
22+
- When you **remove a widget** here, it will be removed from all users' personal dashboards.
23+
24+
This is different from changes made directly on the dashboard page itself (for example, using the close button on a widget or adding a widget from the dashboard view). Those changes only affect the currently logged-in user.
25+
26+
If you want to enforce a widget change across all users, make it from this management page. If you only want to adjust your own dashboard, make the change directly on the dashboard page instead.
27+
1728
## See Also
1829

1930
1. [Managing Your Dashboard](building-sites/client-proofing/dashboards/managing)

en/building-sites/client-proofing/dashboards/usergroups.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@ _old_id: "25"
44
_old_uri: "2.x/administering-your-site/dashboards/assigning-a-dashboard-to-a-user-group"
55
---
66

7-
This article describes how to edit a Dashboard, including on how to assign and arrange Widgets for that Dashboard.
7+
This article describes how to assign a Dashboard to a User Group.
88

99
First off, find the User Group that you would like to assign the Dashboard to, and edit it. You can do so by "Menu" -> "Access Controls", then right-clicking on the group in the User Groups tree, and clicking "Update User Group".
1010

1111
From there, you can simply click on the "Dashboard" dropdown, and select the Dashboard you want to assign to this User Group. All users in this group that have this group as their Primary Group will load that Dashboard instead of the Default now.
1212

1313
![](dashboard-assign.png)
1414

15+
## Customizable Dashboards and User Groups
16+
17+
If the assigned dashboard has the **Customizable** setting checked, MODX creates a personal copy of the dashboard's widget layout for each user the first time they log in. Users can then rearrange, add, or remove widgets on their own copy without affecting other group members.
18+
19+
When an administrator later updates the dashboard template (by adding or removing widgets through the Dashboards manager page), those changes are applied to all existing users' personal dashboards. See [Managing Your Dashboard](building-sites/client-proofing/dashboards/managing "Managing Your Dashboard") for more on how template changes propagate.
20+
1521
## See Also
1622

1723
1. [Managing Your Dashboard](building-sites/client-proofing/dashboards/managing)

0 commit comments

Comments
 (0)