Personal tools
Namespaces

Variants
Actions

MetricsCube Connector For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About MetricsCube Connector For WHMCS

MetricsCube Connector For WHMCS is a free module that has been created to allow synchronization between WHMCS system and MetricsCube.
With this unprecedented integration, the platform will get deep insight into the fundamental information, analyze it and draw over 70 various business reports.
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.
  • Synchronization Benefits:
✔ Access 72 Powerful Business Reports
✔ 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
✔ Opt-In/Out For Detailed User Data Synchronization
✔ Opt-in/Out For User Tracking
✔ Integrate WHMCS Data Into MetricsCube Using:
✔ Webhooks Synchronization Method
✔ Cron Synchronization Method
✔ Automatically Synchronize Reports With Changes In WHMCS Database
✔ Download Connector Logs
✔ View Last Synchronization Time And Status
  • Reports Available At MetricsCube:
✔ Billing:
✔ Monthly Recurring Revenue (MRR)
✔ Customer Lifetime Value (LTV)
✔ Average Revenue Per User (ARPU)
✔ Average Revenue Per Paying User (ARPPU)
✔ Revenue
✔ Net Revenue
✔ Accrual Revenue
✔ Accrual Net Revenue
✔ Unpaid Invoices Value
✔ New Monthly Recurring Revenue
✔ Expansion Monthly Recurring 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
  • 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 5.6 Up To PHP 7.3
✔ Supports WHMCS V7.2 And Later
  • 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 'Setup' tab 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 create a new account and activate your 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 WHCMS 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 began! 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 be also found on this page.
Furthermore, you are offered a brief explanation of the subject of the currently chosen synchronization method.
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 ran 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 which are offered by MetricsCube can be unavailable.

If you would like to benefit fully from possibilities provided by MetricsCube, you can grant access to the 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 a reporting, therefore this option is switched on by default.
  • Detailed User Data - this option allows to transfer to MetricsCube additional data about your clients such as name, surname, 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 the processing 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 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.
    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

Synchronization Methods

After the first successful synchronization between the two platforms, your data will be downloaded to analyze and update the reports automatically and regularly once per 24 hours.

Are there any problems with data synchronization? There is always an option to change the synchronization method whenever needed.

Webhooks

'Webhooks' is a synchronization method that MetricsCube Connector For WHMCS works with by default.

The process starts with the MetricsCube server that makes a connection to your WHMCS.
Once the synchronization is initiated, the MetricsCube Connector For WHMCS module transfers the data via our API.

MCC12.png

Cron

As another option, you can take advantage of the 'Cron' synchronization method once you have established the connection to your WHMCS.

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.
Now you can copy and paste the generated command to set up your crontab.
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.

MCC13.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 to your existing MetricsCube account.
You will have to go through the process form the beginning.

MCC17.png

MetricsCube Platform

Here they are! Ready, detailed and flexible reports that will help you look deep into your company's performance.

Quickly sign in to your account and start the exploration.

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.

Common Problems

1. When you encounter problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
FAQ
Community
MetricsCube Connector For WHMCS