Difference between revisions of "Admin Dashboard"
From WHMCS Documentation
(→Showing/Hiding Widgets) |
m |
||
| Line 1: | Line 1: | ||
| − | Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default | + | 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. |
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]. | ||
| − | <div class="docs-alert-info"><i class="fa fa-info-circle"></i> Looking for Site Widgets? The functionality previously referred to as site widgets | + | <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> |
==Dashboard== | ==Dashboard== | ||
| Line 13: | Line 13: | ||
===Customising the Dashboard=== | ===Customising the Dashboard=== | ||
| − | Each member of staff can personalise their admin dashboard view by minimising or hiding widgets, as well as | + | 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). |
| − | To move a dashboard widget, hover over the widget title | + | 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. |
| − | + | 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"> | + | <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> |
| − | + | 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: | |
| − | * '''Refresh''' | + | * '''Refresh''' — Refreshes the content of the widget. For performance reasons, many of the widgets cache their data for a period of time. |
| − | * '''Minimise''' | + | * '''Minimise''' — Minimises the widget. You can expand the minimised widget again later. |
| − | * '''Close''' | + | * '''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=== | ===Showing/Hiding Widgets=== | ||
| − | + | You can manage widgets on the admin dashboard via the Show/Hide Widgets panel. | |
| − | To open the panel, click the gear icon | + | To open the panel, click the gear icon at the top-right of the dashboard. |
[[File:Admin_dashboard_showhide.png]] | [[File:Admin_dashboard_showhide.png]] | ||
| − | Widgets with a check next to them are enabled and will | + | 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 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. |
| − | For example the Support Tickets widget will only show to a user with access to view and respond to support tickets. | + | 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 | + | <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> |
==Widget Reference== | ==Widget Reference== | ||
| − | The following table itemises all widgets that | + | The following table itemises all widgets that WHMCS includes by default and their required permissions: |
<table class="table table-bordered"> | <table class="table table-bordered"> | ||
| Line 57: | Line 57: | ||
<tr> | <tr> | ||
<td>Activity</td> | <td>Activity</td> | ||
| − | <td>Recent system activity to keep you up to date with what's happening</td> | + | <td>Recent system activity to keep you up to date with what's happening.</td> |
<td>View Activity Log</td> | <td>View Activity Log</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Automation</td> | <td>Automation</td> | ||
| − | <td>An overview of system automation. Click a miniature graph to see a the full version on the [[Automation_Status|Automation Status]] page</td> | + | <td>An overview of system automation. Click a miniature graph to see a the full version on the [[Automation_Status|Automation Status]] page.</td> |
<td>Configure Automation Settings</td> | <td>Configure Automation Settings</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Billing</td> | <td>Billing</td> | ||
| − | <td>An overview of income over four periods | + | <td>An overview of income over four periods: daily, monthly, yearly and all time.</td> |
<td>View Income Totals</td> | <td>View Income Totals</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Client Activity</td> | <td>Client Activity</td> | ||
| − | <td>A brief overview of the last | + | <td>A brief overview of the last five client logins, including dates, times, and IP addresses.</td> |
<td>List Clients</td> | <td>List Clients</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Health</td> | <td>Health</td> | ||
| − | <td>An overview of System Health | + | <td>An overview of System Health and links through the main [[System_Health_Status|System Health Status]] page.</td> |
<td>Health and Updates</td> | <td>Health and Updates</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Network Status</td> | <td>Network Status</td> | ||
| − | <td>Listing your servers and allowing you to check the status (if [[Servers#Status_Monitoring|status | + | <td>Listing your servers and allowing you to check the status (if the system has implemented [[Servers#Status_Monitoring|status URL monitoring]]).</td> |
<td>None</td> | <td>None</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>System Overview</td> | <td>System Overview</td> | ||
| − | <td>An overview of orders and income in graphical format. | + | <td>An overview of orders and income in graphical format. You can change the timescale to show daily, monthly, or yearly orders and income.</td> |
<td>View Income Totals</td> | <td>View Income Totals</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>System Overview Badges</td> | <td>System Overview Badges</td> | ||
| − | <td> | + | <td>The colourful badges at the top of the page provide a quick statistical overview including orders, cancellation, and tickets.</td> |
<td>None</td> | <td>None</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Staff Online</td> | <td>Staff Online</td> | ||
| − | <td>Shows currently logged in staff. If the staff member's email address corresponds with a [https://gravatar.com/ Gravatar] account, the Gravatar image | + | <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> | <td>None</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Support</td> | <td>Support</td> | ||
| − | <td>An overview of support awaiting | + | <td>An overview of support tickets that are awaiting replies, tickets that you assigned to your account, and tickets with recent activity.</td> |
<td>List Support Tickets</td> | <td>List Support Tickets</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>To-Do List</td> | <td>To-Do List</td> | ||
| − | <td>An overview of support awaiting | + | <td>An overview of support tickets that are awaiting replies, tickets that you assigned to your account, and tickets with recent activity.</td> |
<td>To-Do List</td> | <td>To-Do List</td> | ||
</tr> | </tr> | ||
| Line 114: | Line 114: | ||
==Creating Widgets== | ==Creating Widgets== | ||
| − | For information on creating your own widgets, | + | For information on creating your own widgets, see our [https://developers.whmcs.com/advanced/widgets/ Developer Documentation]. |
Revision as of 15:30, 30 April 2020
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.
Addon and third party module developers can also include dashboard widgets as part of a custom module.
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.
Contents
Dashboard
Pictured above is an example of the admin dashboard.
Customising the Dashboard
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).
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.
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.
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.
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:
- Refresh — Refreshes the content of the widget. For performance reasons, many of the widgets cache their data for a period of time.
- 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.
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.
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.
For example, the Support Tickets widget will only show to a user with access to view and respond to support tickets.
Some older widgets do not leverage the access control permissions. You can control access to these individually via Administrator Roles.
Widget Reference
The following table itemises all widgets that WHMCS includes by default and their required permissions:
| Name | Description | Required Permission |
| Activity | Recent system activity to keep you up to date with what's happening. | View Activity Log |
| Automation | An overview of system automation. Click a miniature graph to see a the full version on the Automation Status page. | Configure Automation Settings |
| Billing | An overview of income over four periods: daily, monthly, yearly and all time. | View Income Totals |
| Client Activity | A brief overview of the last five client logins, including dates, times, and IP addresses. | List Clients |
| Health | An overview of System Health and links through the main System Health Status page. | Health and Updates |
| Network Status | Listing your servers and allowing you to check the status (if the system has implemented status URL monitoring). | None |
| System Overview | An overview of orders and income in graphical format. You can change the timescale to show daily, monthly, or yearly orders and income. | View Income Totals |
| System Overview Badges | The colourful badges at the top of the page provide a quick statistical overview including orders, cancellation, and tickets. | None |
| Staff Online | Shows currently-logged-in staff. If the staff member's email address corresponds with a Gravatar account, the system will display the Gravatar image. | None |
| Support | An overview of support tickets that are awaiting replies, tickets that you assigned to your account, and tickets with recent activity. | List Support Tickets |
| To-Do List | An overview of support tickets that are awaiting replies, tickets that you assigned to your account, and tickets with recent activity. | To-Do List |
Creating Widgets
For information on creating your own widgets, see our Developer Documentation.