Difference between revisions of "Admin Dashboard"

Revision as of 08:55, 10 August 2017

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.

    Looking for Site Widgets? The functionality previously referred to as site widgets has now been renamed to Data Feeds. Data feeds allow you to fetch product and domain information for inclusion on custom site pages.

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 entirely.

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.

The Show/Hide Widgets functionality is available in WHMCS 7.3 and later.

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.

Some older widgets do not leverage the access control permissions and access to these can be controlled individually via Administrator Roles.

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/

@@ Line 1: / Line 1: @@
-Widgets are a feature of WHMCS Version 5.0 & later that are the building blocks of the admin homepage.  They are open-source, movable blocks, which can be granted access to on a per admin role basis depending upon the permissions belonging to that role, allowing administrators to customise exactly what each staff group get to see, and staff to tailor their dashboard to their exact needs.
+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.
-''Looking for a way to get product/domain info & pricing on your site? The functionality for doing that previously referred to as widgets has now been renamed to [[Data Feeds]]''
+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].
-==Default Widgets==
+<div class="docs-alert-info">
+    <i class="fa fa-info-circle"></i> Looking for Site Widgets? The functionality previously referred to as site widgets has now been renamed to [[Data Feeds]]. Data feeds allow you to fetch product and domain information for inclusion on custom site pages.
+</div>
-WHMCS currently includes the following widgets as standard. But widgets can easily be created by hook and addon module developers and so it's more than likely you will have many more available to you in your installation than this:
+[[File:Admin_dashboard.png]]
+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 entirely.
+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.
+[[File:Admin_dashboard_showhide.png]]
+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==
+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.
+<div class="docs-alert-warning">Some older widgets do not leverage the access control permissions and access to these can be controlled individually via Administrator Roles.</div>
+==Widget Reference==
+The following table itemises all widgets that are included with WHMCS by default and the permissions required for each.
 <table class="table table-bordered">
@@ Line 70: / Line 108: @@
 </table>
-==Managing Widgets==
+==Creating Widgets==
-Each member of staff can have their own personalised admin homepage layout. The widgets are arranged in 3 columns, of unlimited depth.
-Widgets can also be minimised or maximised, so that even if a widget is enabled for a particular role group, if an admin doesn't want or need to see it, then they can simply minimise it and move it to the bottom of the screen out of the way.
-To do this simply click the "-" icon located to the far right of the title bar for a widget.  When minimised where the "-" icon was before, it will now display a "+" icon allowing for the widget to be opened again if needed.
-==Granting/Restricting Access to Widgets==
-Access to Widgets is defined on a per admin role group basis.  So for example all your Support staff might have access to the Network Status page, and can therefore see the Network Status widget on the dashboard . Whereas your Sales staff may not require this permission so would not see the widget either.
-To get started, begin by navigating to '''Setup > Administrator Roles''' and then click the edit icon next to the admin role group you want to change.
-===Legacy Widgets===
-Widgets designed for WHMCS 5.x to 7.0 can be used in version 7.1.
-Once on the permissions page, simply scroll down to the section labelled '''Widgets''' and from there you'll be able to enable/disable the Widgets accessible to that group by checking or unchecking the boxes.
-When a new widget is first installed into the system, the first thing you will always need to do before you can see & use it is navigate to your admin role group setup area as described above and enable it. Once enabled, you can then navigate back to your homepage and the new widget will appear as the top widget on your dashboard which you can move around and adjust as desired.
-==Creating/Editing Widgets==
-All the widgets included in WHMCS by default are open source and fully customisable. You can find & edit the files that control them in the '''/modules/widgets/''' folder.
-Or if you are a developer and want to create a widget to extend your existing Server/Provisioning/Registrars/Addon Module, or if you are a user who simply wants to create a custom widget for your own purposes, visit the [[Creating a Widget]] page to find out how.
+For information on creating your own widgets, please refer to our Developer Documentation at https://developers.whmcs.com/advanced/widgets/

Documentation