Admin Dashboard - Revision history

PeterM: /* Widget Reference */

2023-09-20T09:15:27Z

‎Widget Reference

SarahK at 20:11, 30 January 2023

2023-01-30T20:11:49Z

SarahK: /* Showing/Hiding Widgets */

2023-01-30T20:04:52Z

‎Showing/Hiding Widgets

SarahK at 17:08, 18 April 2022

2022-04-18T17:08:51Z

SarahK at 20:51, 1 March 2022

2022-03-01T20:51:50Z

SarahK: /* Widget Reference */

2021-05-13T17:38:54Z

‎Widget Reference

SarahK: /* Dashboard */

2021-05-13T17:38:26Z

‎Dashboard

PeterM: Added troubleshooting section

2020-11-03T12:52:17Z

Added troubleshooting section

SarahK at 15:30, 30 April 2020

2020-04-30T15:30:44Z

Show changes

John: /* Showing/Hiding Widgets */

2019-05-17T09:45:53Z

‎Showing/Hiding Widgets

@@ Line 84: / Line 84: @@
 <td>Health and Updates</td>
 </tr>
 <tr>
 <td>Network Status</td>

@@ Line 1: / Line 1: @@
-Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default, which we design to give you an overview of activity and events occuring within your WHMCS installation.
+Each member of staff can personalise their admin dashboard view by minimising or hiding widgets, as well as rearranging via drag-and-drop (available in WHMCS 7.7 and later).
-Addon and third party module developers can also include dashboard widgets as part of a [https://developers.whmcs.com/addon-modules/admin-dashboard-widgets/ custom module].
+You will see the '''Admin Dashboard''' after you log in to the WHMCS [[Admin Area]].
-<div class="docs-alert-info"><i class="fa fa-info-circle"></i> Looking for Site Widgets? The functionality that we previously referred to as site widgets is now [[Data Feeds]]. Data feeds allow you to fetch product and domain information for inclusion on custom site pages.</div>
+[[File:82Dashboard.png|600px|thumb|The Admin Area Dashboard]]
-==Dashboard==
+== Dashboard Widgets ==
-[[File:82Dashboard.png|800px]]
+Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default, which we design to give you an overview of activity and events occuring within your WHMCS installation.
-Pictured above is an example of the admin dashboard.
+<div class="docs-alert-info"><i class="fa fa-info-circle"></i> Looking for Site Widgets? The functionality that we previously referred to as site widgets is now [[Data Feeds]]. Data feeds allow you to fetch product and domain information for inclusion on custom site pages.</div>
-===Customising the Dashboard===
+== Managing Widgets ==
 To move a dashboard widget, hover over the widget title. A cross-hair will appear. Click and hold to drag and reposition the widget. The system will display a target area where the widget will drop. Release the mouse to save the new position.
@@ Line 21: / Line 17: @@
 The system stores widget position preferences to your admin profile. Because of this, they will persist between admin login sessions and across all devices that you use to log in to WHMCS.
-<div class="docs-alert-warning">Due to differing widget sizes and the grid system layout, when moving a widget or reloading the page, other widgets may move automatically or reorder themselves to ensure optimum display. If you experience any overlapping of widgets, simply refresh the page.</div>
+<div class="docs-alert-warning">
 At the top right of each widget are the widget controls.  These controls allow an admin user to customise their dashboard.  The available actions include:
@@ Line 31: / Line 31: @@
 [[File:82WidgetList.png|300px|thumb]]
-===Showing/Hiding Widgets===
+=== Showing/Hiding Widgets ===
 You can manage widgets on the admin dashboard via the '''Show/Hide Widgets''' panel.
@@ Line 39: / Line 39: @@
 Widgets with a check next to them are enabled and the system will render them on the dashboard. To remove a widget, uncheck the box next to its name. To add a previously removed widget, check the box next to its name. The dashboard will immediately update when you enable or disable a widget.
-===Permissions===
+== Permissions ==
 Widgets use the administrator role access control permissions system and therefore the widgets a user can see and has access to will match the user's permissions in the system.
@@ Line 49: / Line 49: @@
 </div>
-==Widget Reference==
+== Widget Reference ==
 The following table itemises all widgets that WHMCS includes by default and their required permissions:
@@ Line 121: / Line 121: @@
 </table>
-==Creating Widgets==
+== Creating Widgets ==
-For information on creating your own widgets, see our [https://developers.whmcs.com/advanced/widgets/ Developer Documentation].
+Addon and third party module developers can also include dashboard widgets as part of a custom module. For information on creating your own widgets, see our [https://developers.whmcs.com/addon-modules/admin-dashboard-widgets/ Developer Documentation].
-==Troubleshooting==
+== Troubleshooting ==
-===Oops Error===
+=== Oops Error ===
 An Oops Error Message is shown when viewing the Dashboard.
@@ Line 133: / Line 133: @@
 The error will reference the widget that is causing the failure. Once you know the affected widget you can remove the files from '''/modules/widgets/''' or obtain an updated version of from the developer.
-===Blank Dashboard After Update===
+=== Blank Dashboard After Update ===
 If none of the admin dashboard widgets are loading following an update of WHMCS, then the problem most likely lies in the table collation values.
 For more information, see [https://help.whmcs.com/m/updating/l/1040457-troubleshooting-a-blank-admin-dashboard-after-update Troubleshooting a Blank Admin Dashboard After Update].

@@ Line 28: / Line 28: @@
 * '''Minimise''' — Minimises the widget. You can expand the minimised widget again later.
 * '''Close''' — Closes the widget. This removes the widget from the dashboard for the current admin user. You must add it to the dashboard again to reopen it.
 ===Showing/Hiding Widgets===
-You can manage widgets on the admin dashboard via the Show/Hide Widgets panel.
+You can manage widgets on the admin dashboard via the '''Show/Hide Widgets''' panel.
 To open the panel, click the gear icon at the top-right of the dashboard.
 Widgets with a check next to them are enabled and the system will render them on the dashboard. To remove a widget, uncheck the box next to its name. To add a previously removed widget, check the box next to its name. The dashboard will immediately update when you enable or disable a widget.

@@ Line 1: / Line 1: @@
 Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default, which we design to give you an overview of activity and events occuring within your WHMCS installation.
-You will see the '''Admin Dashboard''' after you log in to the WHMCS Admin Area.
+You will see the '''Admin Dashboard''' after you log in to the WHMCS [[Admin Area]].
 Addon and third party module developers can also include dashboard widgets as part of a [https://developers.whmcs.com/addon-modules/admin-dashboard-widgets/ custom module].
@@ Line 45: / Line 45: @@
 For example, the Support Tickets widget will only show to a user with access to view and respond to support tickets.
-<div class="docs-alert-warning">Some older widgets do not leverage the access control permissions. You can control access to these individually via Administrator Roles.</div>
+<div class="docs-alert-warning">
 ==Widget Reference==
@@ Line 124: / Line 126: @@
 ==Troubleshooting==
 ===Oops Error===
 An Oops Error Message is shown when viewing the Dashboard.
 This can be caused by an incompatible widget. Please follow our guide on blank/oops pages to obtain the full error - https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message.
 The error will reference the widget that is causing the failure. Once you know the affected widget you can remove the files from '''/modules/widgets/''' or obtain an updated version of from the developer.
 ===Blank Dashboard After Update===
 If none of the admin dashboard widgets are loading following an update of WHMCS, then the problem most likely lies in the table collation values.
-https://help.whmcs.com/m/updating/l/1040457-troubleshooting-a-blank-admin-dashboard-after-update
+For more information, see [https://help.whmcs.com/m/updating/l/1040457-troubleshooting-a-blank-admin-dashboard-after-update Troubleshooting a Blank Admin Dashboard After Update].

← Older revision		Revision as of 20:51, 1 March 2022
Line 1:		Line 1:
	Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default, which we design to give you an overview of activity and events occuring within your WHMCS installation.		Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default, which we design to give you an overview of activity and events occuring within your WHMCS installation.
		+
		+	You will see the '''Admin Dashboard''' after you log in to the WHMCS Admin Area.

	Addon and third party module developers can also include dashboard widgets as part of a [https://developers.whmcs.com/addon-modules/admin-dashboard-widgets/ custom module].		Addon and third party module developers can also include dashboard widgets as part of a [https://developers.whmcs.com/addon-modules/admin-dashboard-widgets/ custom module].

@@ Line 99: / Line 99: @@
 <td>Shows currently-logged-in staff. If the staff member's email address corresponds with a [https://gravatar.com/ Gravatar] account, the system will display the Gravatar image.</td>
 <td>None</td>
 </tr>
 <tr>

← Older revision		Revision as of 12:52, 3 November 2020
Line 115:		Line 115:

	For information on creating your own widgets, see our [https://developers.whmcs.com/advanced/widgets/ Developer Documentation].		For information on creating your own widgets, see our [https://developers.whmcs.com/advanced/widgets/ Developer Documentation].
		+
		+	==Troubleshooting==
		+	===Oops Error===
		+	An Oops Error Message is shown when viewing the Dashboard.
		+	This can be caused by an incompatible widget. Please follow our guide on blank/oops pages to obtain the full error - https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message.
		+	The error will reference the widget that is causing the failure. Once you know the affected widget you can remove the files from '''/modules/widgets/''' or obtain an updated version of from the developer.
		+	===Blank Dashboard After Update===
		+	If none of the admin dashboard widgets are loading following an update of WHMCS, then the problem most likely lies in the table collation values.
		+
		+	https://help.whmcs.com/m/updating/l/1040457-troubleshooting-a-blank-admin-dashboard-after-update

← Older revision		Revision as of 09:45, 17 May 2019
Line 36:		Line 36:

	Widgets with a check next to them are enabled and will be rendered on the dashboard. To remove a widget, uncheck the box next to it's name. To add a previously removed widget, check the box next to it's name. The dashboard will immediately update upon enable or disable of a widget.		Widgets with a check next to them are enabled and will be rendered on the dashboard. To remove a widget, uncheck the box next to it's name. To add a previously removed widget, check the box next to it's name. The dashboard will immediately update upon enable or disable of a widget.
−
−	~~<div class="docs-alert-warning">The Show/Hide Widgets functionality is available in WHMCS 7.3 and later.</div>~~

	===Permissions===		===Permissions===