Difference between revisions of "Admin Dashboard"

From WHMCS Documentation
(→‎Widget Reference)
 
(17 intermediate revisions by 4 users not shown)
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, and moved into any display order/combination as desired, allowing administrators to customise exactly what each staff group get to see, and staff to tailor their dashboard to their exact needs.
+
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).
  
−
''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]]''
+
You will see the '''Admin Dashboard''' after you log in to the WHMCS [[Admin Area]].
  
−
==Default Widgets==
+
[[File:82Dashboard.png|600px|thumb|The Admin Area Dashboard]]
  
−
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:
+
== Dashboard Widgets ==
  
−
*'''Activity Log''' - Recent activity overview to keep you up to date with what's happening
+
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.
−
*'''Getting Started with WHMCS''' - Quick getting started tips for new users
 
−
*'''Income Forecast''' - A quick income forecast of estimated income should all active products renew in a 12 month period
 
−
*'''Income Overview''' - A graphical summary of daily income compared for the past 2 weeks
 
−
*'''My Notes''' - Access to your personal admin notes at a glance
 
−
*'''Network Status''' - Listing your servers and allowing you to check the status (if status url monitoring has been implemented)
 
−
*'''Open Invoices''' - A quick view of unpaid invoices, showing your latest 5
 
−
*'''Orders Overview''' - A graphical summary of active orders per month for the current year
 
−
*'''Recent Admin Activity''' - A brief overview of the last 5 logins by staff, date/time & IP address
 
−
*'''Recent Client Activity''' - A brief overview of the last 5 client logins, including dates/times & IP addresses
 
−
*'''System Overview''' - A quick statistical overview including orders, services, and tickets
 
−
*'''To-Do List''' - Instant access to your WHMCS To-Do list to review and manage
 
−
*'''WHMCS News Feed''' - All the latest news & updates from WHMCS straight to your WHMCS dashboard
 
  
−
==Managing 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>
  
−
Each member of staff can have their own personalised admin homepage layout. The widgets are arranged in 2 columns, of unlimited depth.
+
== Managing Widgets ==
  
−
To move a widget, simply click and drag the title bar where the widget name is displayed to the desired location and then release it. Before you let go of the mouse, a dotted outline will appear where the widget will be moved to allowing you to confirm it's as you want.
+
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.
  
−
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.
+
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.
  
−
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 thw widget to be opened again if needed.
+
<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>
  
−
==Granting/Restricting Access to Widgets==
+
=== Widget Controls ===
  
−
Access to Widgets is defined on a per admin role group basis.  So for example all your Sales staff might have access to the System & Orders Overview widgets, while your Support staff might not require those things.
+
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:
  
−
To get started, begin by navigating to '''Setup > Admin Roles''' and then click the edit icon next to the admin role group you want to change.
+
* '''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.
  
−
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.
+
[[File:82WidgetList.png|300px|thumb]]
  
−
===Accessing Newly Installed Widgets===
+
=== Showing/Hiding Widgets ===
  
−
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.
+
You can manage widgets on the admin dashboard via the '''Show/Hide Widgets''' panel.
  
−
==Creating/Editing Widgets==
+
To open the panel, click the gear icon at the top-right of the dashboard.
  
−
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.
+
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.
  
−
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.
+
== 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.
 +
 
 +
<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 ==
 +
 
 +
The following table itemises all widgets that WHMCS includes by default and their required permissions:
 +
 
 +
<table class="table table-bordered">
 +
<tr>
 +
<td>'''Name'''</td>
 +
<td>'''Description'''</td>
 +
<td>'''Required Permission'''</td>
 +
</tr>
 +
<tr>
 +
<td>Activity</td>
 +
<td>Recent system activity to keep you up to date with what's happening.</td>
 +
<td>View Activity Log</td>
 +
</tr>
 +
<tr>
 +
<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>Configure Automation Settings</td>
 +
</tr>
 +
<tr>
 +
<td>Billing</td>
 +
<td>An overview of income over four periods: daily, monthly, yearly and all time.</td>
 +
<td>View Income Totals</td>
 +
</tr>
 +
<tr>
 +
<td>Client Activity</td>
 +
<td>A brief overview of the last five client logins, including dates, times, and IP addresses.</td>
 +
<td>List Clients</td>
 +
</tr>
 +
<tr>
 +
<td>Health</td>
 +
<td>An overview of System Health and links through the main [[System_Health_Status|System Health Status]] page.</td>
 +
<td>Health and Updates</td>
 +
</tr>
 +
<td>MarketConnect</td>
 +
<td>Provides details of the selling status of MarketConnect products with your current points balance and options to deposit funds and view promotions.</td>
 +
<td>View MarketConnect Balance</td>
 +
</tr>
 +
<tr>
 +
<tr>
 +
<td>Network Status</td>
 +
<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>
 +
</tr>
 +
<tr>
 +
<td>System Overview</td>
 +
<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>
 +
</tr>
 +
<tr>
 +
<td>System Overview Badges</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>
 +
</tr>
 +
<tr>
 +
<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 system will display the Gravatar image.</td>
 +
<td>None</td>
 +
</tr>
 +
<tr>
 +
<td>Stripe Balance</td>
 +
<td>Displays the pending and available balances for the Stripe payment gateway.</td>
 +
<td>View Gateway Balances</td>
 +
</tr>
 +
<tr>
 +
<td>Support</td>
 +
<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>
 +
</tr>
 +
<tr>
 +
<td>To-Do List</td>
 +
<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>
 +
</tr>
 +
</table>
 +
 
 +
== Creating Widgets ==
 +
 
 +
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 ==
 +
 
 +
=== 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.
 +
 
 +
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].

Latest revision as of 09:15, 20 September 2023

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

You will see the Admin Dashboard after you log in to the WHMCS Admin Area.

The Admin Area Dashboard

Dashboard Widgets

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.

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.

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.

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.

Widget Controls

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.
82WidgetList.png

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:

</tr>

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
MarketConnect Provides details of the selling status of MarketConnect products with your current points balance and options to deposit funds and view promotions. View MarketConnect Balance
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
Stripe Balance Displays the pending and available balances for the Stripe payment gateway. View Gateway Balances
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

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

For more information, see Troubleshooting a Blank Admin Dashboard After Update.

Retrieved from "http://3.17.75.209/index.php?title=Admin_Dashboard&oldid=34242"