Personal tools
Namespaces

Variants
Actions

WithoutDNS For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 3: Line 3:
  
 
=About [https://www.modulesgarden.com/products/whmcs/withoutdns WithoutDNS For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/withoutdns WithoutDNS For WHMCS]=
 +
<!-- fixed -->
 +
 +
*'''Synchronization Benefits:'''
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''WithoutDNS''' is a
+
|style="padding: 10px 0px 0px 30px;"|✔ Access 91 Powerful Business Reports
 
|}
 
|}
−
<!-- fixed -->
+
 
−
*'''Addon Module:'''
+
*'''General Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Secure Synchronization With No Personal Data Stored
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Fully GDPR Compliant
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 7.3
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V7.2
 
|}
 
|}
  
−
=Installation=
+
*'''Exclusive Promo Code From ModulesGarden:'''
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/abandoned-cart Abandoned Cart For WHMCS.]''' <br />
+
|style="padding: 10px 0px 30px 30px;"|✔ '''Save 25%''' For '''3 Months''' On The MetricsCube Platform With Coupon: '''WHMCS25%_MC'''
−
We will guide you step by step through the whole installation and configuration process. <br/>
+
 
|}
 
|}
 +
 +
=Installation and Synchronization=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 10px 0px 15px 15px;"|'''We have prepared a short but comprehensive tutorial that will show you how to successfully install [https://www.modulesgarden.com/products/whmcs/metricscube-business-analytics MetricsCube Business Analytics For WHMCS] module and synchronize your WHMCS with MetricsCube.'''<br/>
 +
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==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_1.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''1. First of all, you need the package, therefore log in to our client area and download the module.'''
 
|}
 
|}
−
<!--
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. In the downloaded file you will find a package that supports PHP 7.4 up to 8.1.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP74_81.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''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.'''<br />
 +
The content of your package should look like on the below screen:
 
|}
 
|}
−
-->
 
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC1_1.png]]
−
Extracted files in your WHMCS directory should look like this:
+
 
|}
 
|}
 +
 +
==Activate The Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_2.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''3. Now, you have to activate the addon module in your WHMCS system.'''<br/>
 +
Please log in to your WHMCS admin area. Once there, navigate to the '' 'System Settings' '' section and select '' 'Addon Modules'.'' <br/>
 +
Find 'MetricsCube Connector' on the list of addons and click the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Abandoned Cart For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC2.png]]
−
This file is located in '' 'modules/addons/AbandonedCart/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_3.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. After the module has been activated, you will need to enable access to your Admin Role.'''<br/>
 +
To do that, click on '' 'Configure','' select the admin roles that should have access to the module, and save changes.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''  <br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC2_1.png]]
−
Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_4.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''Your module has just been successfully installed and activated!'''
 
|}
 
|}
 +
 +
==Sign Up And Synchronize With MetricsCube==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In the next step, set up the '' 'storage' '' folder as recursively writable.'''<br />
+
|style="padding: 10px 0px 20px 15px;"|Now, move to [https://www.metricscube.io metricscube.io] to learn more about MetricsCube, create a new account and activate your free 14-day trial of the platform or use a [https://dashboard.metricscube.io/sign-up direct link] to the sign up page.
−
This folder is available at '' 'your_whmcs/modules/addons/AbandonedCart/' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|Enter your email address and a strong password. Remember to read and then agree to the Privacy Policy before signing up!<br/>
−
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Abandoned Cart' '' and press the '' 'Activate' '' button.
+
There are no other steps required to create an account, you may continue right after.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|On pressing the Sign Up button you will be automatically moved to the MetricsCube Wizard.<br/>
−
To do so, click on the '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
'' 'Step 1' '' - select the platform you are going to synchronize with MetricsCube - in our case that will be 'WHMCS'.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Abandoned Cart For WHMCS!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|In '' 'Step 2' '' you will be asked to select the installation method. <br/>
−
You can access your module at '' 'Addons' '' → '' 'Abandoned Cart'. ''
+
Go for method 3, ''' 'WHMCS Module - Already Installed ', ''' as you have just installed the addon module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC6.png]]
 
|}
 
|}
−
 
−
=Configuration and Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Abandoned Cart For WHMCS''' allows you to control all the actions that take place in your marketplace. <br/>  
+
|style="padding: 0px 0px 15px 15px;"|When moved to '' 'Step 3' '' you will see an activation code presented on your screen.<br/>  
−
Check the manual below to learn how to configure the module to take all the advantages it has to offer.
+
Copy it, use the copy icon next to it and keep it safe as you will need it in further steps of synchronization.  
 
|}
 
|}
−
==Addon Module==
 
−
===Dashboard===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the dashboard you can find the summary graphs of recently created shopping cart.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC7.png]]
−
The first graph illustrates the number of all shopping carts created within the selected period of time. You may choose between 1, 3, 6 and 12 months to show the statistics for.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_9.png]]
+
|style="padding: 0px 0px 15px 15px;"|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.<br/>
 +
Press the '' 'Synchronize' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The second graph is dedicated to show the summary of completed orders only.  
+
|style="padding: 0px 0px 20px 15px;"|The last step of installation has just begun! Wait until MetricsCube wizard has finished synchronizing data between your WHMCS system and the platform.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC8_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|The last graph "Existing Clients Carts / All Carts (%)" represents the percentage of cars created by the existing clients ''(unlogged guests are not taken into consideration)''<br/> towards the number of all carts ''(created by existing clients and guests together)''.  
+
|style="padding: 0px 0px 20px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|You've nailed it! There is nothing to stop you now from using all MetricsCube tools and boosting the productivity of your business processes!
 
|}
 
|}
  
−
===Shopping Carts===
+
=MetricsCube Connector Addon Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The '' 'Shopping Carts' '' section, as its name suggests, contains a list of all identified carts, with details included, as follows:<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/>  
−
* client full name and its company name ''(if known)''
+
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.
−
* the URL to the order if created
+
−
* the cart details<br/>  
+
−
Press the "Snapshots" button to find more specific information on the cart content and actions performed within that cart.
+
 
|}
 
|}
 +
 +
==Process==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_13.png]]
+
|style="padding: 10px 0px 5px 15px;"|When synchronizing your WHMCS with MetricsCube platform for the first time, data download is divided into two parts:<br/>
 +
* 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.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Under "Snapshots" there are details on the cart content, visible at the moment of the last snapshot being taken. <br/> You will find there also the history of changes made by the client, such as:
+
|style="padding: 0px 0px 20px 15px;"|In your addon you may control the current status of synchronization and details on when it was run for the last time.
−
* adding a new product/addon/domain
+
−
* removing a product/addon/domain
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC11.png]]
 
|}
 
|}
 +
 +
==Data Synchronization==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Right next to the shopping cart details you will find a button which after pressing shows a direct URL to the abandoned cart.  
+
|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 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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC20.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_2.png]]
+
|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 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.<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 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 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'''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|This URL can be automatically placed in the email message sent to a client provided a dedicated "Restore Abandoned Cart" option has been previously enabled [[#General_Settings|(more here)]].<br/> On pressing, the client can get his abandoned cart restored and he will be allowed to continue shopping with the already filled in cart with all the items.<br/> You may also use this URL to resend it manually.
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC21.png]]
 
|}
 
|}
 +
<!-- do wywalenia ale potem
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You may send email template reminders to preferred clients directly from the shopping carts list. Send emails to single clients or choose several recipients.
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC23.png]]
 
|}
 
|}
 +
-->
 +
 +
<!--
 +
==Webhooks Synchronization Method==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_14_4.png]]
+
|style="padding: 10px 0px 15px 15px;"|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'''. <br/>
 +
'' 'Webhooks' '' is a default synchronization method that MetricsCube Connector For WHMCS works with.<br/>
 +
The process starts with the MetricsCube server that makes a connection to your WHMCS.<br/>
 +
Once the synchronization is initiated, the MetricsCube Connector For WHMCS module transfers the data via our API.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_14_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC12.png]]
 
|}
 
|}
  
−
===Reminders===
+
===Cron===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|"Reminders" is the clue section of the whole module. Compose the reminders settings to deliver adjusted notifications to clients who abandoned their cart. <br/> Press '' 'Create Reminder' '' button to create your first rule.
+
|style="padding: 10px 0px 20px 15px;"|As another option, you can take advantage of the '' 'Cron' '' synchronization method once you have established the connection to your WHMCS.<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/>
 +
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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_15.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC13.png]]
 
|}
 
|}
−
{|
+
-->
−
|style="padding: 0px 0px 15px 15px;"|Configure the reminder by providing the details as explained below:
+
−
* '''Status''' - enable/disable the reminder
+
  
−
* '''Name''' - give the reminder a unique name
+
==Logs==
−
 
+
{|
−
* '''Email Template for Existing Clients''' - choose the email template that will be used to send an email message notifying your already logged in/registered client; "Abandoned Cart - Logged In Client Notification" is the default module template.
+
|style="padding: 10px 0px 20px 15px;"|The MetricsCube Connector For WHMCS addon module allows to download Connector Logs. Press the button as shown on the screen to fetch logs.
−
 
+
−
* '''Email Template for Guests''' - choose the email template that will be used send an email message notifying your guest clients who visited your client area and started shopping; "Abandoned Cart - Open Ticket For Guest" is the default module template. <br/> You may preview and adjust the email templates content at ''your WHMCS → System Settings → Email Templates.''<br/> '''''Note:''' A support ticket is opened at the same time within a dedicated support department.''
+
−
 
+
−
* '''Related Products/Addons/Domains''' - select items; if any has been added to the cart, a related reminder will be sent to the interested client (logged in or guest who provided the email address)
+
−
 
+
−
* '''Include Carts Created More Than X Days Ago''' - type in the number of days, only carts created BEFORE will be verified
+
−
 
+
−
* '''Include Carts Created Less Than X Days Ago''' - type in the number of days, only carts created AFTER will be verified,<br/> as illustrated: only carts created between the last 3 and 7 days will be checked
+
−
 
+
−
Press '' 'Confirm' '' when your reminder configuration is ready.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_16.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|The just created reminder rule will appear on the list with crucial details visible on the front page for a quick and easy preview. <br/>  
+
|style="padding: 0px 0px 15px 15px;"|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. <br/>
−
You may enable/disable the reminder, edit and delete it using the actions buttons.  
+
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. <br/>  
 +
When ready, patiently wait until the next synchronization.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_17.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC15.png]]
 
|}
 
|}
  
−
===General Settings===
+
==Connect New Account==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Under the '' 'General Settings' '' section you will find the cron details - setting it up is crucial for the module's correct behavior and configuration.
+
|style="padding: 10px 0px 20px 15px;"|It is possible to connect your WHMCS to MetricsCube with another account from one addon. Simply, press the second button on the addon dashboard.
−
'''Cron Task'''<br/>
+
−
Set up the cron that is responsible for sending email messages, based on created reminders as explained in the [[#Reminders|previous step]]. Once a day is recommended to assure fluent module performance.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC16.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''General Settings:'''
+
|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 with your existing MetricsCube account.<br/>  
−
* '''Client Email Address''' - related to new visitors only; when a guest client starts to browse your store, he or she will be asked to provide an email address before being allowed to continue and complete the order:
+
You will have to go through the process from the beginning.
−
**Disabled
+
−
**Require email address - the client will be forced to enter the email address to be able to continue the shopping
+
−
**Allow to skip this step - the client can type in the email address or press "Skip" to continue shopping, if "Skip" is pressed, no data will be collected by the module
+
−
 
+
−
* '''Force Login/Registration''' - related to new visitors and unlogged clients; when a client adds an item to the cart, he or she will be forced to either log in (if the account already exists) or register a new account (new clients).<br/> Otherwise, continuing the shopping will be impossible.<br/> '''''Important:''' Being logged in or at least providing an email address is required for the module correct behavior, without the email address no messages will be sent to remind clients about their abandoned carts.''<br/> '''''Note:''' We highly recommend enabling just one of the options, otherwise, guest clients will be forced to provide an email address in the first step and register an account in the next one.''
+
−
+
−
* '''Restore Abandoned Cart''' - if enabled, clients will receive a direct link to their abandoned cart, in the module reminding email message, with its all contents restored to easily complete the order.
+
−
 
+
−
* '''Support Department''' - select one of the available support departments. A ticket to remind the guest clients about their abandoned carts will be opened within this department. <br/>
+
−
When your configuration is ready, do not forget to press the '' 'Submit' '' button to save your changes.
+
−
 
+
−
* '''Allow To Save Shopping Carts''' - when turned on, customers have the ability to save their shopping carts while placing an order.<br/> They can later access these carts from their profiles and share them with other customers using session URLs, instantly restoring the cart's contents.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_19.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC17.png]]
 
|}
 
|}
−
 
+
==Enhanced WHMCS Experience==
−
===Logs===
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The '' 'Logs' '' section contains information an all actions taken by the module.
+
|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:AC_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_0.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You may always delete the logs if their number is extensive.<br/>
+
|style="padding: 0px 0px 20px 15px;"|Mark the features to take advantage of your MetricsCube data on specific pages directly in your WHMCS.
−
Use the action button for mass removal of all existing log entries.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_20_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_1.png]]
 
|}
 
|}
−
 
−
==Client Area==
 
−
===Email/Login Requirement===
 
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|Once an unlogged client visits your marketplace, they will be asked to leave some of their personal data. The extent of what exactly must be provided depends on the module [[#General_Settings|configuration]].
+
|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 15px 15px;"|The moment the client starts browsing your store, they will be either:
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24_2.png]]
−
*forced to provide an email address in order to be allowed to complete the shopping ''([[#General_Settings|"Client Email Address"]] option is set to "Require email address")''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_22.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;"|
 
|style="padding: 0px 0px 20px 15px;"|
−
*asked to enter an email address in order to be allowed to complete the shopping ''([[#General_Settings|"Client Email Address"]] option is set to "Allow to skip this step")''
+
* '''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:AC_22_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC32.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 15px;"|
 
|style="padding: 0px 0px 20px 15px;"|
−
*forced to log in or register a new account in order to be allowed to complete the shopping ''([[#General_Settings|"Force Login/Registration"]] option is enabled)''
+
* '''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:AC_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC28.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If '' 'Log in' '' is selected, the potential customer will be redirected to the standard client area login page.
+
|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:AC_23_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC29.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|For '' 'Register' '' choice, the visitor will be asked to create a new account using a standard form.
+
|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:AC_23_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Being logged in or leaving an email address is required for the module to be able to send email messages to clients reminding them about abandoned carts and their content.<br/>
+
|style="padding: 0px 0px 20px 15px;"|
−
This is how an exemplary email notification sent to a client might look like:
+
* '''MetricsCube Link in Main Menu''' - press and you will be redirected to the MetricsCube login page.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC31.png]]
 
|}
 
|}
 +
 +
 +
===Admin Roles Permissions===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Guest clients who leave only the email address and have no account in your system will get quite a similar notification email.<br/>  
+
|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.  
−
'''''Note:''' The system will open a new support ticket in a dedicated department at the same time. Only the assigned admin will have access to this ticket.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_25.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC24.png]]
 
|}
 
|}
−
 
−
===Shopping Lists===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Clients have the convenience of storing their shopping carts to be viewed and finalized in the future.<br/> By clicking the "Save Cart" button while in your cart, the current contents of the cart will be promptly saved and stored in your shopping lists.
+
|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:AC_28.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_29.png]]
+
|style="padding: 0px 0px 15px 15px;"|
 +
* '''Client Profile Popup'''
 +
** Personal Information
 +
** Income
 +
** Services
 +
** Tickets History
 +
** User Activity
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once you have saved the cart as a shopping list, you can then access the list and manage it according to your needs.<br/> You will find the "My Shopping Lists" button in your account details dropdown menu.
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC25_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_30.png]]
+
|style="padding: 0px 0px 15px 15px;"|
 +
* '''Tags'''
 +
** Create New Tags
 +
** Manage Client Tags
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once you navigate to the "My Shopping Lists" page, you will find all your stored carts with basic details on the dashboard.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC26.png]]
−
Allowed actions on a :
+
−
- Shopping cart URL
+
−
- Shopping cart items
+
−
- Delete saved shopping cart
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_31.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC26_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Clients may copy a direct URL to the cart and distribute it to others by providing them with the link. Upon opening the link, they will receive an identical copy of your shopping cart, allowing them to place their orders more quickly.
+
|style="padding: 0px 0px 15px 15px;"|
 +
* '''Comments'''
 +
** Add Comments
 +
** Remove Comments
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_32.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC27.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Explore the contents of this shopping list by previewing the items. Check details on the item types and their current availability in the store.
+
|style="padding: 0px 0px 30px 25px;"|[[File:MCC27_1.png]]
 
|}
 
|}
 +
 +
=MetricsCube Platform=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AC_33.png]]
+
|style="padding: 10px 0px 15px 15px;"|Here it is! Ready, complex and so much detailed analysis of your business.<br/>
 +
Quickly [https://dashboard.metricscube.io/sign-in sign in] to your account and start the exploration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Easily remove individual carts or utilize the mass action button to eliminate multiple items at once.
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC17_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AC_34.png]]
+
|style="padding: 0px 0px 15px 15px;"| Most of all, accurate and flexible reports that will help you look deep into your company's performance.<br/>
 +
Browse, change the periods and search for anything you might only need. 
 
|}
 
|}
−
 
−
=WithoutDNS platform=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|
+
|style="padding: 0px 0px 20px 25px;"|[[File:MCC18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:MCC19.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"| 1. The module collects information on products, addons and domains left in the cart. No data on configurable options, custom fields etc. related to products is stored.  
+
|style="padding: 10px 0px 10px 15px;"|1. Take a look at our [https://www.youtube.com/@MetricsCube YouTube] channel! You will find there short videos presenting three different methods of installing your MetricsCube Connector For WHMCS.<br/>
 +
Stay tuned as other videos are coming soon!
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. Step into the MetricsCube [https://www.metricscube.io/blog Blog] where you will find the latest Release Notes together with thought-provoking Business Guides.<br/>
 +
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.  
 
|}
 
|}
  
Line 358: Line 383:
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. In case of connection problems, please 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 12:08, 3 April 2025

Contents

About WithoutDNS For WHMCS

  • Synchronization Benefits:
✔ Access 91 Powerful Business Reports
  • General Features:
✔ Secure Synchronization With No Personal Data Stored
✔ Fully GDPR Compliant
✔ Supports PHP 8.2 Back To PHP 7.3
✔ Supports WHMCS V8.12 Back To WHMCS V7.2
  • Exclusive Promo Code From ModulesGarden:
✔ Save 25% For 3 Months On The MetricsCube Platform With Coupon: WHMCS25%_MC

Installation and Synchronization

We have prepared a short but comprehensive tutorial that will show you how to successfully install MetricsCube Business Analytics 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=WithoutDNS_For_WHMCS&oldid=75411"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
WithoutDNS For WHMCS