Difference between revisions of "Widgets"

From WHMCS Documentation

 
Line 3: Line 3:
 
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">
+
<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>
    <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>
 
  
[[File:Admin_dashboard.png]]
+
==Dashboard==
 +
 
 +
[[File:Admin_dashboard.png|800px]]
  
 
Pictured above is an example of the admin dashboard.
 
Pictured above is an example of the admin dashboard.
  
==Customising the Dashboard==
+
===Customising the Dashboard===
  
 
Each member of staff can personalise their admin dashboard view by minimising or hiding widgets entirely.
 
Each member of staff can personalise their admin dashboard view by minimising or hiding widgets entirely.
Line 33: Line 33:
 
<div class="docs-alert-warning">The Show/Hide Widgets functionality is available in WHMCS 7.3 and later.</div>
 
<div class="docs-alert-warning">The Show/Hide Widgets functionality is available in WHMCS 7.3 and later.</div>
  
==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 the user is granted within the system.
 
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.

Latest revision as of 02:56, 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.

Dashboard

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.

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.

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/