Personal tools
Namespaces

Variants
Actions

MetricsCube Connector For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About MetricsCube Connector For WHMCS)
(→‎Update Instructions)
(10 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
=About [https://www.modulesgarden.com/products/whmcs/metricscube-connector MetricsCube Connector For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/metricscube-connector MetricsCube Connector For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''MetricsCube Connector For WHMCS''' is a free module that has been created to allow synchronization between WHMCS system and [https://www.metricscube.io/ MetricsCube] platform.<br/> With this unprecedented integration, the platform will get deep insight into the fundamental information, analyze it and draw over 70 various business reports.<br/> Every report will come with additional data management features, such as the application of specific filters and comparison of details from different sources and time periods.
+
|style="padding: 10px 0px 10px 0px;"|'''MetricsCube Connector For WHMCS''' is a free module that has been created to allow synchronization between the WHMCS system and [https://www.metricscube.io/ MetricsCube] platform.<br/> With this unprecedented integration, the platform will get deep insight into the fundamental information, analyze it and draw almost 90 various business reports.<br/> Enjoy the turnaround integration and enhance your WHMCS admin area with instant insight into your clients, services, and domain data fetched from MetricsCube.
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
Line 10: Line 10:
 
*'''Synchronization Benefits:'''
 
*'''Synchronization Benefits:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Access 72 Powerful Business Reports
+
|style="padding: 10px 0px 0px 30px;"|✔ Access 86 Powerful Business Reports
 
|}
 
|}
 
{|
 
{|
Line 33: Line 33:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Opt-In/Out For Detailed User Data Synchronization
+
|style="padding: 0px 0px 0px 30px;"|✔ View Last Synchronization Time And Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Opt-in/Out For User Tracking
+
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Synchronize Reports With Changes In WHMCS Database
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrate WHMCS Data Into MetricsCube Using Webhooks Synchronization Method
+
|style="padding: 0px 0px 0px 30px;"|✔ Download Connector Logs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Automatically Synchronize Reports With Changes In WHMCS Database
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Data Synchronization:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Download Connector Logs
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable Live Data Synchronization
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Last Synchronization Time And Status
+
|style="padding: 0px 0px 0px 45px;"|✔ Opt-In/Out For Detailed User Data Synchronization
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Opt-in/Out For User Tracking
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Configure Enhanced WHMCS Experience By Enabling:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ User Data Widget Popup
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ User Tags In Clients List
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Quick Statistics Widget
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ User Data Widget In Client Profile
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ User Data Widget In Service Details
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MetricsCube Link In Main Menu
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Manage Admin Role Permissions
 +
|}
 +
 
*'''Reports Available At MetricsCube:'''
 
*'''Reports Available At MetricsCube:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Billing:
+
|style="padding: 10px 0px 0px 30px;"|✔ MRR Breakdown:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR Growth
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR Total
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ General MRR Statistics
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR By Type
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR By Product Group
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR By Product
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ MRR By Country
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Financial Reports:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Accounts Receivable Aging
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Credits
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Billed Revenue
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Earned Revenue
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Deferred Revenue
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ All Transactions
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Unpaid Orders
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Billing:
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 45px;"|✔ Monthly Recurring Revenue (MRR)
 
|style="padding: 0px 0px 0px 45px;"|✔ Monthly Recurring Revenue (MRR)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Annual Recurring Revenue (ARR)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Paying Customer Lifetime Value (PLTV)
 
|}
 
|}
 
{|
 
{|
Line 77: Line 159:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 45px;"|✔ Accrual Net Revenue
 
|style="padding: 0px 0px 0px 45px;"|✔ Accrual Net Revenue
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Unpaid Invoices Value
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ New Monthly Recurring Revenue
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 45px;"|✔ Expansion Monthly Recurring Revenue
 
 
|}
 
|}
 
{|
 
{|
Line 295: Line 368:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 45px;"|✔ Late Fee Income
+
|style="padding: 0px 0px 0px 45px;"|✔ Late Fee Income
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Unpaid Invoices Value
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Combine Multiple Reports With Predefined Presets Or Own Assembly
 
|}
 
|}
  
Line 369: Line 448:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.3 Up To PHP 8.1
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.3
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V7.2 And Later
+
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.9 Back To WHMCS V7.2
 
|}
 
|}
  
Line 481: Line 560:
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|As soon as the connection is established successfully, you will get relevant information, such as the current connection status and the time of the last synchronization.<br/>  
 
|style="padding: 10px 0px 30px 15px;"|As soon as the connection is established successfully, you will get relevant information, such as the current connection status and the time of the last synchronization.<br/>  
−
The buttons allowing you to download the logs or link a different account can be also found on this page.<br/> Furthermore, you are offered a brief explanation of the subject of the currently chosen synchronization method.<br/> All these features will be explained in the following sections.
+
The buttons allowing you to download the logs or link a different account can also be found on this page.<br/> Furthermore, you are offered several extra features to enhance your WHMCS with data straight from the MetricsCube platform. <br/> All these features will be explained in the following sections.
 
|}
 
|}
  
Line 499: Line 578:
 
==Data Synchronization==
 
==Data Synchronization==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|By default, once the synchronization of your WHMCS is completed, the personal data of your clients are not processed to MetricsCube.<br/> Therefore, some features which are offered by MetricsCube can be unavailable.<br/>
+
|style="padding: 10px 0px 15px 15px;"|By default, once the synchronization of your WHMCS is completed, the personal data of your clients are not processed to MetricsCube.<br/> Therefore, some features offered by MetricsCube can be unavailable.<br/>
  
−
If you would like to benefit fully from possibilities provided by MetricsCube, you can grant access to the personal data.<br/> To do so, simply click on the '' 'Configure' '' button in the '' 'Data Synchronization' ''tab.
+
If you would like to benefit fully from the possibilities provided by MetricsCube, you can grant access to personal data.<br/> To do so, simply click on the '' 'Configure' '' button in the '' 'Data Synchronization' ''tab.
 
|}
 
|}
 
{|
 
{|
Line 508: Line 587:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Once a new popup window opens, you will notice a possibility to tick additional configuration options. There are:  
 
|style="padding: 0px 0px 15px 15px;"|Once a new popup window opens, you will notice a possibility to tick additional configuration options. There are:  
−
* '''General Data''' - stands for general data sharing required by MetricsCube to provide core services such a reporting, therefore this option is switched on by default.
+
* '''General Data''' - stands for general data sharing required by MetricsCube to provide core services such as reporting, therefore this option is switched on by default.
−
* '''Live Data Synchronisation''' - only if selected, data on recent activities in your system, such as users online, income or news feed, will be gathered and displayed in the Live Dashboard section.<br/>'' '''Note:''' Keep in mind that both slow connection with API and actions overload may noticeably slow down the application.''
+
* '''Live Data Synchronization''' - only if selected, data on recent activities in your system, such as users online, income or news feed, will be gathered and displayed in the Live Dashboard section.<br/>'' '''Note:''' Keep in mind that both slow connection with API and actions overload may noticeably slow down the application.''
−
* '''Detailed User Data''' - this option allows you to transfer to MetricsCube additional data about your clients such as name, surname, company name, email address, web hosting and domains assigned to them. <br/>[https://www.docs.modulesgarden.com/images/0/07/MCC22.png Here] you can check an exemplary report along with the personal data of clients.<br/>If this option is disabled, the client’s WHMCS will encrypt sensitive personal information and convey it in coded form.<br/>[https://www.docs.modulesgarden.com/images/b/b1/MCC23.png Here] you can find the previous example of the report without the consent to processing the data.<br/>If this option is enabled, the generated reports will be more detailed and straightforward.<br/> '' '''Note:''' Please keep in mind that all data sent to MetricsCube is safely encrypted using the strong algorithm SHA-256.''
+
* '''Detailed User Data''' - this option allows you to transfer to MetricsCube additional data about your clients such as first name, last name, company name, email address, web hosting and domains assigned to them. <br/>[https://www.docs.modulesgarden.com/images/0/07/MCC22.png Here] you can check an exemplary report along with the personal data of clients.<br/>If this option is disabled, the client’s WHMCS will encrypt sensitive personal information and convey it in coded form.<br/>[https://www.docs.modulesgarden.com/images/b/b1/MCC23.png Here] you can find the previous example of the report without the consent to process the data.<br/>If this option is enabled, the generated reports will be more detailed and straightforward.<br/> '' '''Note:''' Please keep in mind that all data sent to MetricsCube is safely encrypted using the strong algorithm SHA-256.''
−
* '''User Tracking''' - this option permits you to monitor the activity of your clients on the basis of logs generated through WHMCS. <br/> For instance, you will be able to check when and which websites were browsed by your customers or verify if your clients have already read the answer for a ticket.  <br/> '' '''Note:''' Please remember that this functionality is currently during the development '''and is not available yet.''' <br/>If you tick this option right now, you may be sure that once this functionality is completed, you will be granted access to it instantly.''
+
* '''User Tracking''' - this option permits you to monitor the activity of your clients on the basis of logs generated through WHMCS. <br/> For instance, you can check when and which websites were browsed by your customers or verify if your clients have already read the answer for a ticket.  <br/> '' '''Note:''' Please remember that this functionality is currently during the development '''and is not available yet.''' <br/>If you tick this option right now, you may be sure that once this functionality is completed, you will be granted access to it instantly.''
  
 
'''Important:''' Please, be aware that the data update in MetricsCube, once you opt in or opt out for additional data synchronization, may take '''up to 24h'''.
 
'''Important:''' Please, be aware that the data update in MetricsCube, once you opt in or opt out for additional data synchronization, may take '''up to 24h'''.
Line 527: Line 606:
 
-->
 
-->
  
 +
<!--
 
==Webhooks Synchronization Method==
 
==Webhooks Synchronization Method==
 
{|
 
{|
Line 537: Line 617:
 
|style="padding: 0px 0px 30px 25px;"|[[File:MCC12.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:MCC12.png]]
 
|}
 
|}
−
<!--
+
 
 
===Cron===
 
===Cron===
 
{|
 
{|
Line 543: Line 623:
  
 
In order to proceed, all you need to do is select '' 'Cron' '' from a drop-down menu that will be displayed after you click the arrow located next to the currently applied method.<br/>Now you can copy and paste the generated command to set up your crontab.<br/>
 
In order to proceed, all you need to do is select '' 'Cron' '' from a drop-down menu that will be displayed after you click the arrow located next to the currently applied method.<br/>Now you can copy and paste the generated command to set up your crontab.<br/>
−
Afterwards, the MetricsCube will no longer attempt to connect your WHMCS using the '' 'Webhooks' '' method, because it will automatically detect that the cron script has been executed.
+
Afterward, the MetricsCube will no longer attempt to connect your WHMCS using the '' 'Webhooks' '' method, because it will automatically detect that the cron script has been executed.
 
|}
 
|}
 
{|
 
{|
Line 575: Line 655:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|This very moment you will see a warning notification on the consequences of such action.<br/>  
 
|style="padding: 0px 0px 15px 15px;"|This very moment you will see a warning notification on the consequences of such action.<br/>  
−
Connecting with another account will reset your current configuration and your WHMCS will be no longer synchronized to your existing MetricsCube account.<br/>  
+
Connecting with another account will reset your current configuration and your WHMCS will be no longer synchronized with your existing MetricsCube account.<br/>  
−
You will have to go through the process form the beginning.
+
You will have to go through the process from the beginning.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:MCC17.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:MCC17.png]]
 +
|}
 +
==Enhanced WHMCS Experience==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Grant the MetricsCube Connector addon access to additional features, enabling it to retrieve data from your MetricsCube application and seamlessly present it within your WHMCS admin area.<br/> This will result in an elevated experience with your WHMCS platform.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Mark the features to take advantage of your MetricsCube data on specific pages directly in your WHMCS.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''User Data Widget Popup''' - appears upon hovering over the client's name within the entirety of the admin area.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''User Tags in Clients List''' - preview the tags assigned to the client; hover over the tags to reveal a popup displaying additional details.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''Quick Statistics Widget''' - MetricsCube Analytics widget featuring essential data is showcased on the WHMCS dashboard, and it can be managed just like any other active widget.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC32.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''User Data Widget in Client Profile''' - a dedicated widget for individual clients, providing the same data as the 'User Data Popup,' now integrated into the profile page.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC28.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''User Data Widget in Service Details''' - provides a concise overview of the service balance.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC29.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''User Data Widget in Domain Details''' - offers a brief summary of the domain balance.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC30.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|
 +
* '''MetricsCube Link in Main Menu''' - press and you will be redirected to the MetricsCube login page.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:MCC31.png]]
 +
|}
 +
 +
 +
===Admin Roles Permissions===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|MetricsCube enhances the usability of your WHMCS admin dashboard by offering essential insights and rapidly providing critical information about your business's performance, clients, and services.<br/> Proceed now to the detailed configuration to upgrade your WHMCS experience with instant data from your MetricsCube.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Define the settings for every administrator role individually to perfectly customize the displayed widgets and adjust the content to the admin role and needs.<br/>
 +
Click on the '' 'Permissions' '' to open the list of available sections to enable. Note that the same options are available for every administrator role. <br/> Press the '' 'On/Off '' to select/uncheck all options at once. Remember to save the changes when the enhanced WHMCS configuration is ready.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|
 +
* '''Client Profile Popup'''
 +
** Personal Information
 +
** Income
 +
** Services
 +
** Tickets History
 +
** User Activity
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC25_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|
 +
* '''Tags'''
 +
** Create New Tags
 +
** Manage Client Tags
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC26_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|
 +
* '''Comments'''
 +
** Add Comments
 +
** Remove Comments
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:MCC27.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:MCC27_1.png]]
 
|}
 
|}
  
Line 613: Line 807:
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 
|}
 
|}
  
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. If you encounter any issues with redirection to WHMCS via buttons like '''View in WHMCS''' in the MetricsCube pop-up, please ensure the '''Administration Panel URL'''' in '''MetricsCube → My Application''' settings is accurately configured.
 
|}
 
|}

Revision as of 08:50, 11 April 2024

Contents

About MetricsCube Connector For WHMCS

MetricsCube Connector For WHMCS is a free module that has been created to allow synchronization between the WHMCS system and MetricsCube platform.
With this unprecedented integration, the platform will get deep insight into the fundamental information, analyze it and draw almost 90 various business reports.
Enjoy the turnaround integration and enhance your WHMCS admin area with instant insight into your clients, services, and domain data fetched from MetricsCube.
  • Synchronization Benefits:
✔ Access 86 Powerful Business Reports
✔ View Live And Recent Activity Of WHMCS Customers And Events
✔ View 20 Customers And Services Segmentation Lists
✔ Browse Clear Charts And Real-Time Summaries
✔ Apply Various Filters For More Specific Results
✔ Compare Data From Different Sources And Time Intervals
  • Connector Features:
✔ Connect Single Or Multiple WHMCS Brands With MetricsCube Account
✔ View Last Synchronization Time And Status
✔ Automatically Synchronize Reports With Changes In WHMCS Database
✔ Download Connector Logs
✔ Configure Data Synchronization:
✔ Enable Live Data Synchronization
✔ Opt-In/Out For Detailed User Data Synchronization
✔ Opt-in/Out For User Tracking
✔ Configure Enhanced WHMCS Experience By Enabling:
✔ User Data Widget Popup
✔ User Tags In Clients List
✔ Quick Statistics Widget
✔ User Data Widget In Client Profile
✔ User Data Widget In Service Details
✔ MetricsCube Link In Main Menu
✔ Manage Admin Role Permissions
  • Reports Available At MetricsCube:
✔ MRR Breakdown:
✔ MRR Growth
✔ MRR Total
✔ General MRR Statistics
✔ MRR By Type
✔ MRR By Product Group
✔ MRR By Product
✔ MRR By Country
✔ Financial Reports:
✔ Accounts Receivable Aging
✔ Credits
✔ Billed Revenue
✔ Earned Revenue
✔ Deferred Revenue
✔ All Transactions
✔ Unpaid Orders
✔ Billing:
✔ Monthly Recurring Revenue (MRR)
✔ Annual Recurring Revenue (ARR)
✔ Paying Customer Lifetime Value (PLTV)
✔ Customer Lifetime Value (LTV)
✔ Average Revenue Per User (ARPU)
✔ Average Revenue Per Paying User (ARPPU)
✔ Revenue
✔ Net Revenue
✔ Accrual Revenue
✔ Accrual Net Revenue
✔ Subscriptions:
✔ Active Subscriptions
✔ Active Subscribers
✔ Active Paid Subscriptions
✔ Active Paid Subscribers
✔ New Subscriptions
✔ Expansion Subscriptions
✔ New Subscribers
✔ Retention:
✔ Active Addons
✔ Active Clients
✔ Active Domains
✔ Active Services
✔ New Addons
✔ New Clients
✔ New Domains
✔ New Services
✔ Churn:
✔ Revenue Churn
✔ Revenue Churn Rate
✔ Subscription Churn
✔ Subscription Churn Rate
✔ Customer Churn
✔ Customer Churn Rate
✔ Renewals:
✔ Revenue Renewal
✔ Revenue Renewal Rate
✔ Subscription Renewal
✔ Subscription Renewal Rate
✔ Customer Renewal
✔ Customer Renewal Rate
✔ Services:
✔ Services Revenue
✔ Average Revenue Per Service
✔ New Services
✔ Active Services
✔ Active Services Per Country
✔ Services Lifetime
✔ New Services Income Ratio
✔ Billing Cycles
✔ Services With Domain Ratio
✔ Services Lifetime Value
✔ Domains:
✔ Domains Revenue
✔ Average Revenue Per Domain
✔ Registered Domains
✔ Transferred Domains
✔ Active Domains
✔ Active Domains Per Country
✔ Domains Lifetime
✔ New Domains Income Ratio
✔ Domains With Service Ratio
✔ Domains Lifetime Value
✔ Clients:
✔ New Clients
✔ Active Clients
✔ Total Clients
✔ Active Clients Per Country
✔ Support:
✔ Tickets By Priority
✔ Tickets By Product
✔ Average Client Response Time Per Product
✔ Closed Tickets Per Admin
✔ Average Response Time Per Admin
✔ Average 1st Response Time Per Admin
✔ Other:
✔ New Orders
✔ Cancellation Requests
✔ Tax Value
✔ Late Fee Income
✔ Unpaid Invoices Value
✔ Combine Multiple Reports With Predefined Presets Or Own Assembly
  • Customer Segmentation Lists Available At MetricsCube:
✔ All Customers
✔ Active Paying Subscribers
✔ Active Subscribers
✔ Active Customers
✔ Inactive Customers
✔ New Customers
✔ Recently Churned Customers
✔ Customers By Income
✔ Customers By MRR
✔ Recently Ordered
✔ Customers By Opened Tickets
  • Services Segmentation Lists Available At MetricsCube:
✔ All Services
✔ Services By Renew Date
✔ Recently Churned Services
✔ New Services
✔ Services By Income
✔ Services By MRR
✔ Recently Ordered
✔ Services Without Domains
✔ Domains Without A Service
  • General Features:
✔ Secure Synchronization With No Personal Data Stored
✔ Fully GDPR Compliant
✔ Supports PHP 8.1 Back To PHP 7.3
✔ Supports WHMCS V8.9 Back To WHMCS V7.2
  • Exclusive Promo Code From ModulesGarden:
✔ Save 20% For 3 Months On The MetricsCube Platform With Coupon: WHMCS20%_MC

Installation and Synchronization

We have prepared a short but comprehensive tutorial that will show you how to successfully install MetricsCube Connector For WHMCS module and synchronize your WHMCS with MetricsCube.

Although the process is extremely easy and intuitive, go over the below guide to assure it is fast, smooth and trouble-free.

Install The Addon

1. First of all, you need the package, therefore log in to our client area and download the module.
MCC1.png
2. Open the FTP Client, log into the server with WHMCS installed. Then, open the main catalogue and upload the folder with files you have extracted previously.

The content of your package should look like on the below screen:

MCC1 1.png

Activate The Addon

3. Now, you have to activate the addon module in your WHMCS system.

Please log in to your WHMCS admin area. Once there, navigate to the 'System Settings' section and select 'Addon Modules'.
Find 'MetricsCube Connector' on the list of addons and click the 'Activate' button.

MCC2.png
4. After the module has been activated, you will need to enable access to your Admin Role.

To do that, click on 'Configure', select the admin roles that should have access to the module, and save changes.

MCC2 1.png
Your module has just been successfully installed and activated!

Sign Up And Synchronize With MetricsCube

Now, move to metricscube.io to learn more about MetricsCube, create a new account and activate your free 14-day trial of the platform or use a direct link to the sign up page.
MCC3.png
Enter your email address and a strong password. Remember to read and then agree to the Privacy Policy before signing up!

There are no other steps required to create an account, you may continue right after.

MCC4.png
On pressing the Sign Up button you will be automatically moved to the MetricsCube Wizard.

'Step 1' - select the platform you are going to synchronize with MetricsCube - in our case that will be 'WHMCS'.

MCC5.png
In 'Step 2' you will be asked to select the installation method.

Go for method 3, 'WHMCS Module - Already Installed ', as you have just installed the addon module.

MCC6.png
When moved to 'Step 3' you will see an activation code presented on your screen.

Copy it, use the copy icon next to it and keep it safe as you will need it in further steps of synchronization.

MCC7.png
Go back to your WHMCS addon now. Link the MetricsCube platform and your WHMCS by pasting the copied activation code into the Application ID field located in the module.

Press the 'Synchronize' button.

MCC8.png
The last step of installation has just begun! Wait until MetricsCube wizard has finished synchronizing data between your WHMCS system and the platform.
MCC8 1.png
The moment the synchronization is complete you will be informed about that in your addon with a short note. Have a break now and wait until the reports are finally ready.
MCC9.png
You've nailed it! There is nothing to stop you now from using all MetricsCube tools and boosting the productivity of your business processes!

MetricsCube Connector Addon Management

As soon as the connection is established successfully, you will get relevant information, such as the current connection status and the time of the last synchronization.

The buttons allowing you to download the logs or link a different account can also be found on this page.
Furthermore, you are offered several extra features to enhance your WHMCS with data straight from the MetricsCube platform.
All these features will be explained in the following sections.

Process

When synchronizing your WHMCS with MetricsCube platform for the first time, data download is divided into two parts:
  • The first and usually quite fast synchronization fetches data from the last year of the WHMCS usage to analyze them and generate reports.
  • As a background process there are data from the previous four years fetched and synchronized; this process is run once only.
In your addon you may control the current status of synchronization and details on when it was run for the last time.
MCC11.png

Data Synchronization

By default, once the synchronization of your WHMCS is completed, the personal data of your clients are not processed to MetricsCube.
Therefore, some features offered by MetricsCube can be unavailable.

If you would like to benefit fully from the possibilities provided by MetricsCube, you can grant access to personal data.
To do so, simply click on the 'Configure' button in the 'Data Synchronization' tab.

MCC20.png
Once a new popup window opens, you will notice a possibility to tick additional configuration options. There are:
  • General Data - stands for general data sharing required by MetricsCube to provide core services such as reporting, therefore this option is switched on by default.
  • Live Data Synchronization - only if selected, data on recent activities in your system, such as users online, income or news feed, will be gathered and displayed in the Live Dashboard section.
    Note: Keep in mind that both slow connection with API and actions overload may noticeably slow down the application.
  • Detailed User Data - this option allows you to transfer to MetricsCube additional data about your clients such as first name, last name, company name, email address, web hosting and domains assigned to them.
    Here you can check an exemplary report along with the personal data of clients.
    If this option is disabled, the client’s WHMCS will encrypt sensitive personal information and convey it in coded form.
    Here you can find the previous example of the report without the consent to process the data.
    If this option is enabled, the generated reports will be more detailed and straightforward.
    Note: Please keep in mind that all data sent to MetricsCube is safely encrypted using the strong algorithm SHA-256.
  • User Tracking - this option permits you to monitor the activity of your clients on the basis of logs generated through WHMCS.
    For instance, you can check when and which websites were browsed by your customers or verify if your clients have already read the answer for a ticket.
    Note: Please remember that this functionality is currently during the development and is not available yet.
    If you tick this option right now, you may be sure that once this functionality is completed, you will be granted access to it instantly.

Important: Please, be aware that the data update in MetricsCube, once you opt in or opt out for additional data synchronization, may take up to 24h.

MCC21.png


Logs

The MetricsCube Connector For WHMCS addon module allows to download Connector Logs. Press the button as shown on the screen to fetch logs.
MCC14.png
In case there are any issues and fetching logs is hampered, you will need to create or modify the log file in a required directory.

The correct path will be generated automatically and may be copied from the error notification that will appear on your screen. Please set the privileges as defined in the notifications.
When ready, patiently wait until the next synchronization.

MCC15.png

Connect New Account

It is possible to connect your WHMCS to MetricsCube with another account from one addon. Simply, press the second button on the addon dashboard.
MCC16.png
This very moment you will see a warning notification on the consequences of such action.

Connecting with another account will reset your current configuration and your WHMCS will be no longer synchronized with your existing MetricsCube account.
You will have to go through the process from the beginning.

MCC17.png

Enhanced WHMCS Experience

Grant the MetricsCube Connector addon access to additional features, enabling it to retrieve data from your MetricsCube application and seamlessly present it within your WHMCS admin area.
This will result in an elevated experience with your WHMCS platform.
MCC24 0.png
Mark the features to take advantage of your MetricsCube data on specific pages directly in your WHMCS.
MCC24 1.png
  • User Data Widget Popup - appears upon hovering over the client's name within the entirety of the admin area.
MCC24 2.png
  • User Tags in Clients List - preview the tags assigned to the client; hover over the tags to reveal a popup displaying additional details.
MCC24 3.png
  • Quick Statistics Widget - MetricsCube Analytics widget featuring essential data is showcased on the WHMCS dashboard, and it can be managed just like any other active widget.
MCC32.png
  • User Data Widget in Client Profile - a dedicated widget for individual clients, providing the same data as the 'User Data Popup,' now integrated into the profile page.
MCC28.png
  • User Data Widget in Service Details - provides a concise overview of the service balance.
MCC29.png
  • User Data Widget in Domain Details - offers a brief summary of the domain balance.
MCC30.png
  • MetricsCube Link in Main Menu - press and you will be redirected to the MetricsCube login page.
MCC31.png


Admin Roles Permissions

MetricsCube enhances the usability of your WHMCS admin dashboard by offering essential insights and rapidly providing critical information about your business's performance, clients, and services.
Proceed now to the detailed configuration to upgrade your WHMCS experience with instant data from your MetricsCube.
MCC24.png
Define the settings for every administrator role individually to perfectly customize the displayed widgets and adjust the content to the admin role and needs.

Click on the 'Permissions' to open the list of available sections to enable. Note that the same options are available for every administrator role.
Press the 'On/Off to select/uncheck all options at once. Remember to save the changes when the enhanced WHMCS configuration is ready.

MCC25.png
  • Client Profile Popup
    • Personal Information
    • Income
    • Services
    • Tickets History
    • User Activity
MCC25 1.png
  • Tags
    • Create New Tags
    • Manage Client Tags
MCC26.png
MCC26 1.png
  • Comments
    • Add Comments
    • Remove Comments
MCC27.png
MCC27 1.png

MetricsCube Platform

Here it is! Ready, complex and so much detailed analysis of your business.

Quickly sign in to your account and start the exploration.

MCC17 1.png
Most of all, accurate and flexible reports that will help you look deep into your company's performance.

Browse, change the periods and search for anything you might only need.

MCC18.png
MCC19.png

Tips

1. Take a look at our YouTube channel! You will find there short videos presenting three different methods of installing your MetricsCube Connector For WHMCS.

Stay tuned as other videos are coming soon!

2. Step into the MetricsCube Blog where you will find the latest Release Notes together with thought-provoking Business Guides.

Get the gist of the web hosting industry, let yourself be guided across the various reports types and finally reach for practical advice on how to boost your business development.

Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Common Problems

1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.
2. If you encounter any issues with redirection to WHMCS via buttons like View in WHMCS in the MetricsCube pop-up, please ensure the Administration Panel URL' in MetricsCube → My Application settings is accurately configured.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=MetricsCube_Connector_For_WHMCS&oldid=65889"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
MetricsCube Connector For WHMCS