Difference between revisions of "Admin Dashboard"
m (Matt moved page Widgets to Admin Dashboard) |
(→Customising the 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 | + | Each member of staff can personalise their admin dashboard view by minimising or hiding widgets, as well as re-arranging by drag & drop (available in WHMCS 7.7 and later). |
| + | |||
| + | To move a dashboard widget, hover over the widget title and a cross-hair will appear. Click and hold to drag and re-position the widget. A target area will be displayed where the widget is positioned to drop. Release the mouse to save. | ||
| + | |||
| + | Widget position preferences are stored to your admin profile and therefore will persist between admin login sessions and across all devices where you login to WHMCS. | ||
| + | |||
| + | <div class="docs-alert-warning">Note that due to differing widget sizes and the grid system layout, when moving a widget or re-loading the page, other widgets may be moved automatically or re-ordered to ensure optimum display. If you experience any overlapping of widgets, simply refresh the page.</div> | ||
Located 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: | Located 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: | ||
Revision as of 13:12, 19 December 2018
Widgets are the building blocks of the WHMCS Admin Dashboard. WHMCS includes a variety of dashboard widgets by default that are designed 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.
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 re-arranging by drag & drop (available in WHMCS 7.7 and later).
To move a dashboard widget, hover over the widget title and a cross-hair will appear. Click and hold to drag and re-position the widget. A target area will be displayed where the widget is positioned to drop. Release the mouse to save.
Widget position preferences are stored to your admin profile and therefore will persist between admin login sessions and across all devices where you login to WHMCS.
Located 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. A minimised widget can easily be expanded again.
- Close - Closes the widget. This removes the widget from the dashboard for the current admin user. The widget will remain closed until it is re-added to the dashboard.
Showing/Hiding Widgets
Widgets displayed on the admin dashboard can be managed via the Show/Hide Widgets panel.
To open the panel, click the gear icon located at the top right of the dashboard.
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.
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 the user is granted within the system.
For example the Support Tickets widget will only show to a user with access to view and respond to support tickets.
Widget Reference
The following table itemises all widgets that are included with WHMCS by default and the permissions required for each.
| 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 5 client logins, including dates/times & IP addresses | List Clients |
| Health | An overview of System Health, links through tot he main System Health Status page | Health and Updates |
| Network Status | Listing your servers and allowing you to check the status (if status url monitoring has been implemented) | None |
| System Overview | An overview of orders and income in graphical format. The timescale can be changed to show daily, monthly or yearly | View Income Totals |
| System Overview Badges | Displayed at the top of the page, the colourful badges 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 Gravatar image will be used. | None |
| Support | An overview of support awaiting reply tickets, tickets assigned to your account and tickets with recent activity | List Support Tickets |
| To-Do List | An overview of support awaiting reply tickets, tickets assigned to your account and tickets with recent activity | To-Do List |
Creating Widgets
For information on creating your own widgets, please refer to our Developer Documentation at https://developers.whmcs.com/advanced/widgets/