Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Hosting Renewals For WHMCS)
Line 1: Line 1:
−
<meta name="keywords" content="hosting renewals for whmcs, hosting renewals configuration, whmcs hosting renewals management, whmcs hosting renewals installation, whmcs hosting renewals common problems, about whmcs hosting renewals, whmcs hosting renewals documentation, whmcs hosting renewals faq, whmcs hosting renewals help, whmcs hosting renewals guide, whmcs hosting renewals wiki, whmcs hosting renewals tutorial, whmcs hosting renewals tips, whmcs hosting renewals wiki"></meta>
+
<meta name="keywords" content="whmcs analyzer, whmcs analyzer configuration, whmcs analyzer management, whmcs analyzer installation, whmcs analyzer common problems, about whmcs analyzer, whmcs analyzer documentation, whmcs analyzer faq, whmcs analyzer help, whmcs analyzer guide, whmcs analyzer wiki, whmcs analyzer tutorial,whmcs analyzer tips, whmcs analyzer wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Renewals For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The WHMCS Analyzer Script."></meta>
  
 +
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links and unclear descriptions!<br/>
 +
We are sorry for the inconvenience caused.</h4>
  
−
=About [http://www.modulesgarden.com/products/whmcs/hosting_renewals/features Hosting Renewals For WHMCS]=
+
=About [http://www.modulesgarden.com/products/whmcs/whmcs_analyzer/features WHMCS Analyzer]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''Hosting Renewals For WHMCS''' is a module which offers your customers a possibility to manage their billing cycles, recurring payments and services' renewals.<br />
+
|style="padding: 10px 0px 5px 0px;"|'''WHMCS Analyzer''' is an innovative product that allows constant monitoring of your WHMCS system. Gather crucial data on your system,<br/> server and many others. Make regular scans to get a list of current issues that may raise and read suggested solutions to avoid or clarify them.  
−
The module will let your clients turn on/off automatic renewals, decide whether and when to renew their web hosting services and even change billing cycles on the fly.<br />
+
−
With our product you will be able to configure billing cycle changing rules, prepare various discounts and send personalized email notifications to your customers.
+
 
|}
 
|}
−
<!--a comment maybe? -->
+
<!-- fixed -->
−
*'''Client Area Features:'''
+
*'''Global Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Renew Services Before Due Date
+
|style="padding: 10px 0px 0px 30px;"|✔ View WHMCS Modification Rating
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Turn On/Off Auto Renewals
+
|style="padding: 0px 0px 0px 30px;"|✔ View Server Environment Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Change Billing Cycle & View Price Difference
+
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Environment Information
 
|}
 
|}
−
 
−
*'''Admin Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Configure Billing Cycle Switching Rules
+
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Files Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Client Area Features Per Product Or Product Group
+
|style="padding: 0px 0px 0px 30px;"|✔ View WHMCS Database Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Disable Auto Renewal For New Products
+
|style="padding: 0px 0px 0px 30px;"|✔ View List Of Possible Issues And Solutions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Auto Renewal For All Instances Of Product
+
|style="padding: 0px 0px 10px 30px;"|✔ Download WHMCS Environment Scan As PDF
 
|}
 
|}
 +
*'''Scan Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Application Of Discount Upon Meeting Defined Rules
+
|style="padding: 10px 0px 0px 30px;"|✔ Files:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Discounts - One Time And Recurring
+
|style="padding: 0px 0px 0px 45px;"|✔ View Brief Files Summary
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Domain Renewal Along With Product
+
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Addon Modules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Notifications About Upcoming Renewals
+
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Template Files
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multiple Email Templates For Email Notification
+
|style="padding: 0px 0px 0px 45px;"|✔ View Installed Order Form Template Files
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Decide Whether Client Should Be Moved To Invoice Immediately After Renewal
+
|style="padding: 0px 0px 0px 45px;"|✔ View Custom Files - Not Existing In Clean WHMCS Installation
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Format Of Displayed Billing Cycle Price Difference
+
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Suspicious Files
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|style="padding: 0px 0px 0px 30px;"|✔ Modules:
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Support For Default WHMCS Options:
+
|style="padding: 0px 0px 0px 45px;"|✔ View Active Addon Modules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ 'Only Auto Provision for Existing'
+
|style="padding: 0px 0px 0px 45px;"|✔ View Active Registrar Modules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ 'No Invoice Email on Order'
+
|style="padding: 0px 0px 0px 45px;"|✔ View Active Payment Gateway Modules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 45px;"|✔ View Active Provisioning Modules
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Hooks:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 0px 45px;"|✔ View Complex Information About Installed Hook Files
 
|}
 
|}
−
 
−
=Installation=
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Hosting Renewals For WHMCS.''' <br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Database:
−
We will guide you step by step through the whole installation and configuration process. <br />
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Hosting Renewals For WHMCS.'''
+
|style="padding: 0px 0px 0px 45px;"|✔ View Basic WHMCS Database Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR1.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View Database Tables List
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ View Logged Database Errors
−
Files in your WHMCS directory should look like these.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR2.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Suspicious Email Templates
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Hosting Renewals for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 10px 0px 0px 30px;"|✔ System Environment:
−
File is located in '' 'modules/addons/hosting_renewals/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR3.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View Server Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ View List Of Installed PHP Modules
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area'' → 'My Products'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR4.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View PHP Configuration
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Now, you have to set up chmod for the '' 'logs' '' folder located in '' 'your_whmcs/modules/addons/hosting_renewals'. '' '''<br />
+
|style="padding: 10px 0px 0px 30px;"|✔ WHMCS Environment:
−
You will be now allowed to read activity logs in the module.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR4_1.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ View Basic WHMCS Settings
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Next, you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 10px 0px 30px 30px;"|✔ Supports WHMCS V5.3.14 and Later
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Hosting Renewals' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR5.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure WHMCS Analyzer.''' <br/>
 +
We will guide you step by step through the whole installation and configuration process.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''1. [http://www.modulesgarden.com/products/whmcs/whmcs_analyzer/download Download] WHMCS Analyzer directly from our webpage.'''
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Renewals!'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the files into the main WHMCS directory.'''<br/>
−
Access your module now at '' 'Addons' '' → '' 'Hosting Renewals'. ''
+
Files in your WHMCS directory should look like on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_2.png]]
 
|}
 
|}
−
 
−
=Configuration and Management=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Hosting Renewals For WHMCS module allows your customers to fully manage their billing cycles and recurring payments.<br />
+
|style="padding: 0px 0px 30px 15px;"|'''3. Now you have to allow access to '' 'analyzer' '' and '' 'temp' '' files, change access rights as writable.'''<br/> Proceed to '' 'YourWHMCS → Analyzer'. '' Set access rights to the mentioned file as writable.<br/>
−
Read through the below instructions to learn how to turn on/off auto-renewals, alter billing cycles and manage customized email notifications.
+
'''That is all, you may move the script itself!'''
 
|}
 
|}
−
 
+
=Management=
−
==Configuration==
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can enable Hosting Renewals For WHMCS only for the products that have recurring payments configured.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''WHMCS Analyzer''' is a disparate product that works outside of your WHMCS system to provide you a comprehensive view on its every single aspect.
−
Proceed to '' 'Addons' '' → '' 'Hosting Renewals' '' → '' 'Configuration' '' and choose product you wish to enable for renewals from a dropdown menu.
+
 
|}
 
|}
 +
==Start Analysis==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR8.png]]
+
|style="padding: 10px 0px 20px 15px;"|In order to start your system analysis, please enter '' 'analyzer' '' directory in your browser, like in the example:
 +
http://your_WHMCS/analyzer
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Press the name of a product with renewals enabled (previous step) and configure its rules.<br />
+
|style="padding: 0px 0px 20px 15px;"|In the every beginning you will be asked to generate htaccess. This step is obligatory due to security reasons.<br/> You will be asked to do that only when using the script for the first time.
−
Available options:<br />
+
−
1. Option checked automatically, you may disable renewals for the product.<br />
+
−
2. If selected, clients are allowed to enable/disable auto-renewal in the client area.<br />
+
−
3. If selected, clients are allowed to renew hosting before its due date.<br />
+
−
4. Check to let clients manage billing cycles.<br />
+
−
''Note that available billing cycles can be set up in 'Change Billing Cycle Rules' table.''<br/>
+
−
5. Disable auto renewal for a new hosting.<br />
+
−
6. Renew domain assigned to service.<br />
+
−
7. If auto renewal option is enabled, email notifications are not delivered.<br />
+
−
Once you have enabled desired options, press '' 'Save Changes'! ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR8_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you have enabled the option allow changing billing cycle in the client area, you must also define between which billing cycles the switch can be made.<br />
+
|style="padding: 0px 0px 20px 15px;"|Please note the generated username and the password, you will need them in the every next step to get access to the product.
−
On the screen below you can see'' 'Change Billing Cycle Rules' '' table with  available billing cycles. Clients will be able to choose between billing cycles from the column of their current billing cycle.<br/>
+
−
For example, settings on the following screen will enable clients to switch any billing cycle only to a longer one.<br/> In our case, if a client currently uses '' 'Quarterly' '' billing cycle, then it can be changed to '' 'Semi-Annual' '' or '' 'Annually'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR8_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Additionally, you can enable/disable auto renewal for all products from a selected configuration.<br />
+
|style="padding: 0px 0px 20px 15px;"|Now, type in the generated in the previous step username and password to continue.  
−
To do so, press '' 'Enable Auto Renewal'/'Disable Auto Renewal' '' button as shown on the following screen.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR8_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_3_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|It is wise to inform your clients about incoming due date, you can do it by setting up notification emails.<br />
+
|style="padding: 0px 0px 20px 15px;"|That's it! You may finally scan your system. Press '' 'Start Scanning' '' button when such appears.
−
You can configure up to five notification emails and specify the time when they shall be sent to the clients depending on a billing cycle the clients use.<br />
+
−
Additionally, you can set up different email templates for each email notification.<br />
+
−
On the screen below you can see settings for a product with monthly, quarterly, semi-annually and annually pricing types.<br />
+
−
For each one of them a client receives only 2 notification emails.<br />
+
−
The first notification will be sent a week before the due date for monthly and quarterly billing cycles and 2 weeks before the due date for semi-annually and annually billing cycles.<br />
+
−
The second notification will be sent for each of the billing cycles a day before the due date.<br />
+
−
Save settings through pressing '' 'Save Changes' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Once you have configured the hosting renewals, new buttons in your admin area product's page should be available.<br />
+
|style="padding: 0px 0px 20px 15px;"| Wait a moment until every part is completed successfully.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR9_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_5.png]]
 
|}
 
|}
−
 
+
==Analysis Summary==
−
==Templates==
+
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|When ''Hosting Renewals For WHMCS'' is  activated, only one email template is created for email notifications.<br />
+
|style="padding: 10px 0px 15px 15px;"|When the analysis process has finished successfully, a full summary will be displayed on your screen.<br/>
−
You can create additional email templates for notifications easily. Move to '' 'Templates' '' section and press '' 'Add Template'. ''
+
Read the below section to get a full view on data you will find there.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_5_1.png]]
 
|}
 
|}
 +
===Total Rating===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you already have some email templates prepared for notification, select it from a dropdown menu and press '' 'Add' '' button.<br />
+
|style="padding: 10px 0px 15px 15px;"|As a very first piece of information you will find '' 'Total Rating'. '' This is an objective evaluation of your system as a whole. <br/> The highest possible rate of any system is 6.0. If you have a lower grade, then your system probably lacks in some of the below features.<br/>
−
As soon as you do that, it will be visible next to '' 'Upcoming Renewal Notice' '' email template and you will be able to assign it to a notification.
+
Aspects taken into consideration when carrying out the evaluation:
 +
*WHMCS version
 +
*PHP version
 +
*detected possible issues
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_6.png]]
 
|}
 
|}
 +
===Analysis In Details===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you want to prepare a new email template, press '' 'Create New Template' '' button.
+
|style="padding: 10px 0px 30px 15px;"|WHMCS Analyzer prepares a detailed summary on your system condition. The results are divided into four general categories, these are:
 +
*System Summary
 +
*Module Version Overview
 +
*Tests Failed
 +
*Tests with Warnings
 +
*Tests Successfull<br/>
 +
Underneath, you will find enumerated all of the scanned options in every category.
 
|}
 
|}
 +
====Files====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10_2.png]]
+
|style="padding: 10px 0px 20px 15px;"|The first section is dedicated to any types of files that exist in your system, with some brief info and divided into categories:
 +
*WHMCS Addons Files
 +
*WHMCS Templates Files
 +
*WHMCS Order Forms Templates Files
 +
*Custom Files
 +
*Suspicious Files
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards, choose '' 'Product/Service' '' as an email template type and type in the name under which email template will be visible in your WHMCS.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_8.png]]
−
Press '' 'Create'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR10_3.png]]
+
|style="padding: 0px 0px 20px 15px;"|You will also find there a list of '' 'Possible Issues'. '' In this box there are always enumerated and described points which may cause some interruptions<br/> in your WHMCS usage. It is important to always analyze them carefully and clarify if possible.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You will be moved to email template edition page. Start by filling in your company name, email address and email subject.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_8_1.png]]
−
Afterwards, create your email template content in a textbox marked on the following screen.<br />
+
−
Press '' 'Save Changes' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR11.png]]
+
|style="padding: 0px 0px 20px 15px;"|In some cases we try to suggest the best action to prevent or solve the issue. Press '' 'Possible Solution' '' to see it, '' 'Hide Solution' '' if you are already familiar with it.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can also use '' 'Merge Fields' '' in your email template.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_8_2.png]]
−
To view a full list of fields, scroll down. These codes are replaced with actual data during sending email.
+
 
|}
 
|}
 +
====Modules====
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12.png]]
+
|style="padding: 10px 0px 20px 15px;"|This section is very short but clear. There is a list of all active addons, payment gateways, registrar and provisioning modules.<br/> Again, possible issues if such exist.
 
|}
 
|}
−
 
−
==Assign Email Template==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can assign any of email templates added at '' 'Templates' '' tab to a desired notification.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_9.png]]
−
To do so, enter product configuration at '' 'Hosting Renewal' '' → '' 'Configuration' '' and select email templates from a dropdown menu next to a desired notification.<br />
+
−
Confirm changes through pressing '' 'Save Changes' '' button.<br />
+
−
On the screen below you can see a previously created '' 'Last Day Notification' '' email template assigned to a notification sent a day before due date.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12_1.png]]
+
 
|}
 
|}
  
−
==Logs==
+
====Hooks====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|All module activities are recorded in log files. To enable this feature, mark '' 'Enable File Logging' '' checkbox.
+
|style="padding: 10px 0px 20px 15px;"|See details of '' 'Main Hook Directory', 'Addons Hooks Files' '' and '' 'Provisioning Hooks Files'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR12_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_10.png]]
 
|}
 
|}
 +
====Database====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You can view any of the logs. Simply, choose it from '' 'File' '' dropdown menu and press '' 'Show' '' button.<br />
+
|style="padding: 10px 0px 20px 15px;"|In this section a complete analysis of the following WHMCS database aspects is available:
−
''Note: You will not be able to choose a log file if there are no logged actions yet.''
+
*Database Table List
 +
*Suspicious Templates
 +
*Logged Errors<br/>
 +
Additionally, there is again a '' 'Brief Info' '' and '' 'Possible Issues' '' sections with suggested solutions.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR12_3.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_11.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Exemplary info log is shown on the following screen.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12_4.png]]
+
−
|}
+
−
 
+
−
==Discounts==
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Discounts' '' section you may set up various discounts for a changing billing cycle.<br /><br />
+
−
'''You can select two types of items:'''<br />
+
−
1. Products - applies to products selected in '' 'Items' '' field.<br />
+
−
2. Product Groups - applies to all products in a product group which is selected in the '' 'Items' '' field.<br /><br />
+
−
'''You can set up two types of discounts:'''<br />
+
−
1. One time discount - it applies to one billing cycle only.<br />
+
−
2. Recurring discount - it will be applied to all billing cycle payments, until your client again changes the billing cycle.<br />
+
−
Now, we will set up one time discount for '' 'Premium Product XL' '' and '' 'testProduct'. ''<br />
+
−
If a client switches to a quarterly billing cycle from any other billing cycle, they will receive a 50% discount for payment in the first billing period.
+
 
|}
 
|}
 +
====System Environment====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR12_5.png]]
+
|style="padding: 10px 0px 15px 15px;"|Under this section you will find information on your system in general. These can be data on:<br/>
 +
''Please note that the below, these are only examples, results will depend on your system customization.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|As you can see on the following screen, all discounts are listed below.<br />
+
|
−
Each of them can be easily removed by pressing '' 'Delete' '' button.
+
*Server Info
 +
*Installed PHP Modules
 +
*apache2handler
 +
*Apache_Environment
 +
*HTTP_Headers_Information
 +
*bcmath
 +
*bz2
 +
*calendar
 +
*Core
 +
*ctype
 +
*curl
 +
*date
 +
*dba
 +
*dom
 +
*ereg
 +
*exif
 +
*fileinfo
 +
*filter
 +
*ftp
 +
*gd
 +
*gettext
 +
*hash
 +
*iconv
 +
|
 +
*imap
 +
*json
 +
*libxml
 +
*mbstring
 +
*mcrypt
 +
*mhash
 +
*mongo
 +
*mysql
 +
*mysqli
 +
*OAuth
 +
*openssl
 +
*pcre
 +
*PDO
 +
*pdo_mysql
 +
*pdo_pgsql
 +
*pgsql
 +
*Phar
 +
*posix
 +
*pspell
 +
*radius
 +
*Reflection
 +
*rrd
 +
*runkit
 +
|
 +
*session
 +
*shmop
 +
*SimpleXML
 +
*snmp
 +
*soap
 +
*sockets
 +
*SPL
 +
*ssh2
 +
*standard
 +
*svn
 +
*sysvmsg
 +
*tokenizer
 +
*wddx
 +
*xml
 +
*xmlreader
 +
*xmlrpc
 +
*xmlwriter
 +
*zip
 +
*zlib
 +
*Environment
 +
*PHP_Variables
 +
*PHP Init
 +
*'''Possible Issues'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR12_6.png]]
+
|style="padding: 20px 0px 20px 25px;"|[[File:WHA_12.png]]
 
|}
 
|}
  
−
==Integration Code==
+
====WHMCS Environment====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this section you have to do two things. First of all, choose a method the prices will be displayed in your client area to your clients. <br/> You can choose between four options. Simply select the one that seems perfect to you.
+
|style="padding: 10px 0px 20px 15px;"|Last but not least section is simple yet very clear. Your '' 'WHMCS Environment' '' includes '' 'Brief Info' '' and '' 'Additional Info' '' boxes and a list of possible issues.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Integration described below allows your customers to manually renew product, turn on/off auto renewal and change billing cycle from their client area.<br/>
+
−
''These options are available for clients only if you have enabled them in the product's configuration!''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Once the integration has been done correctly, your clients should see buttons in the client area as marked on the screen:<br />
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR17.png]]
+
 
|}
 
|}
  
−
==Client Area==
+
===Download File===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Depending on the configuration per product you clients will be allowed to manage their renewals in your client area.<br/>
+
|style="padding: 10px 0px 20px 15px;"|If you want to save your scan results you may download the current analysis. Press '' 'Download Results' '' button to save the results in a ' ''.PDF' '' file.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:HR17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:WHA_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|They can see the current status and use available buttons to perform allowed actions:
+
|style="padding: 0px 0px 20px 15px;"|If you decide to save the results after each scan, it will be possible to easily compare them and see any changes in your system.
−
*Renew service
+
−
*Turn on/off the auto renewal
+
−
*Select billing cycle
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:WHA_16.png]]
 
|}
 
|}
−
 
−
=Additional Information=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|1. If option '' 'Auto Renewal' '' was enabled, an adequate renewal invoice was generated, but then, due to some reasons, '' 'Auto Renewal' '' option is disabled.<br> In such a situation '''NO''' actions are triggered on the already generated invoice. It will not be either canceled or changed.  <br/>
 
−
Additionally, if credit card payment is enabled in your WHMCS, then your system will attempt to charge the credit card. With every failed attempt to charge the credit card,<br/> an email notification will be sent. <br/> <br/>
 
−
''Please be aware that this is due to the WHMCS functionality, not the module itself.''
 
−
|}
 
−
 
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. If your client turns off auto renewal and does not run the renewal manually, then the service status will change to suspended/terminated after a certain time period.<br />
+
|style="padding: 10px 0px 30px 15px;"|1. Due to a huge size of '' 'System Environment' '' section, we advise to use '' 'Ctrl+F' '' keys shortage to look for precise information.  
−
Time period depends on WHMCS settings at '' 'Setup' '' → '' 'Automation Settings' '' → '' 'Automatic Module Functions''. '
+
 
|}
 
|}
 +
=Common Problems=
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|2. Hosting Renewals For WHMCS supports all billing cycles, from monthly to triennially.<br />
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
Depending on the chosen billing cycle, displayed value of a renew button is changing according to the following code which is located in '' 'language' '' directory in your language file:<br />
+
−
$LANG['cyclemonthly']='1 Month';
+
−
$LANG['cyclequarterly']='3 Months';
+
−
$LANG['cyclesemiannually']='6 Months';
+
−
$LANG['cycleannually']='1 Year';
+
−
$LANG['cyclebiennially']='2 Years';
+
−
$LANG['cycletriennially']='3 Years';
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. You can forward a client directly to invoice page after a successful renew.<br />
+
|style="padding: 0px 0px 10px 15px;"|2. In case you encounter an error like on the screen below, please make sure you have completed step three of our installation instruction.  
−
To enable this, go to the '' 'Configuration' '' tab in our module and expand '' 'Additional Options'. ''<br />
+
−
Afterwards, mark '' 'Automatically relocate to the invoice ' '' checkbox and press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:HR16.png]]
+
|style="padding: 0px 0px 10px 25px;"|[[File:WHA_17.png]]
−
|}
+
−
 
+
−
=Common Problems=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
 
|}
 
|}

Revision as of 15:31, 1 June 2016

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.

Contents

About WHMCS Analyzer

WHMCS Analyzer is an innovative product that allows constant monitoring of your WHMCS system. Gather crucial data on your system,
server and many others. Make regular scans to get a list of current issues that may raise and read suggested solutions to avoid or clarify them.
  • Global Features:
✔ View WHMCS Modification Rating
✔ View Server Environment Information
✔ View WHMCS Environment Information
✔ View WHMCS Files Information
✔ View WHMCS Database Information
✔ View List Of Possible Issues And Solutions
✔ Download WHMCS Environment Scan As PDF
  • Scan Features:
✔ Files:
✔ View Brief Files Summary
✔ View Installed Addon Modules
✔ View Installed Template Files
✔ View Installed Order Form Template Files
✔ View Custom Files - Not Existing In Clean WHMCS Installation
✔ View List Of Suspicious Files
✔ Modules:
✔ View Active Addon Modules
✔ View Active Registrar Modules
✔ View Active Payment Gateway Modules
✔ View Active Provisioning Modules
✔ Hooks:
✔ View Complex Information About Installed Hook Files
✔ Database:
✔ View Basic WHMCS Database Information
✔ View Database Tables List
✔ View Logged Database Errors
✔ View List Of Suspicious Email Templates
✔ System Environment:
✔ View Server Information
✔ View List Of Installed PHP Modules
✔ View PHP Configuration
✔ WHMCS Environment:
✔ View Basic WHMCS Settings
  • General Info:
✔ Supports WHMCS V5.3.14 and Later

Installation and Configuration

This tutorial will show you how to successfully install and configure WHMCS Analyzer.

We will guide you step by step through the whole installation and configuration process.

1. Download WHMCS Analyzer directly from our webpage.
WHA 1.png
2. Upload and extract the files into the main WHMCS directory.

Files in your WHMCS directory should look like on the following screen.

WHA 2.png
3. Now you have to allow access to 'analyzer' and 'temp' files, change access rights as writable.
Proceed to 'YourWHMCS → Analyzer'. Set access rights to the mentioned file as writable.

That is all, you may move the script itself!

Management

WHMCS Analyzer is a disparate product that works outside of your WHMCS system to provide you a comprehensive view on its every single aspect.

Start Analysis

In order to start your system analysis, please enter 'analyzer' directory in your browser, like in the example: 
http://your_WHMCS/analyzer
In the every beginning you will be asked to generate htaccess. This step is obligatory due to security reasons.
You will be asked to do that only when using the script for the first time.
WHA 3.png
Please note the generated username and the password, you will need them in the every next step to get access to the product.
WHA 3 1.png
Now, type in the generated in the previous step username and password to continue.
WHA 3 2.png
That's it! You may finally scan your system. Press 'Start Scanning' button when such appears.
WHA 4.png
Wait a moment until every part is completed successfully.
WHA 5.png

Analysis Summary

When the analysis process has finished successfully, a full summary will be displayed on your screen.

Read the below section to get a full view on data you will find there.

WHA 5 1.png

Total Rating

As a very first piece of information you will find 'Total Rating'. This is an objective evaluation of your system as a whole.
The highest possible rate of any system is 6.0. If you have a lower grade, then your system probably lacks in some of the below features.

Aspects taken into consideration when carrying out the evaluation:

  • WHMCS version
  • PHP version
  • detected possible issues
WHA 6.png

Analysis In Details

WHMCS Analyzer prepares a detailed summary on your system condition. The results are divided into four general categories, these are:
  • System Summary
  • Module Version Overview
  • Tests Failed
  • Tests with Warnings
  • Tests Successfull

Underneath, you will find enumerated all of the scanned options in every category.

Files

The first section is dedicated to any types of files that exist in your system, with some brief info and divided into categories:
  • WHMCS Addons Files
  • WHMCS Templates Files
  • WHMCS Order Forms Templates Files
  • Custom Files
  • Suspicious Files
WHA 8.png
You will also find there a list of 'Possible Issues'. In this box there are always enumerated and described points which may cause some interruptions
in your WHMCS usage. It is important to always analyze them carefully and clarify if possible.
WHA 8 1.png
In some cases we try to suggest the best action to prevent or solve the issue. Press 'Possible Solution' to see it, 'Hide Solution' if you are already familiar with it.
WHA 8 2.png

Modules

This section is very short but clear. There is a list of all active addons, payment gateways, registrar and provisioning modules.
Again, possible issues if such exist.
WHA 9.png

Hooks

See details of 'Main Hook Directory', 'Addons Hooks Files' and 'Provisioning Hooks Files'.
WHA 10.png

Database

In this section a complete analysis of the following WHMCS database aspects is available:
  • Database Table List
  • Suspicious Templates
  • Logged Errors

Additionally, there is again a 'Brief Info' and 'Possible Issues' sections with suggested solutions.

WHA 11.png

System Environment

Under this section you will find information on your system in general. These can be data on:

Please note that the below, these are only examples, results will depend on your system customization.

  • Server Info
  • Installed PHP Modules
  • apache2handler
  • Apache_Environment
  • HTTP_Headers_Information
  • bcmath
  • bz2
  • calendar
  • Core
  • ctype
  • curl
  • date
  • dba
  • dom
  • ereg
  • exif
  • fileinfo
  • filter
  • ftp
  • gd
  • gettext
  • hash
  • iconv
  • imap
  • json
  • libxml
  • mbstring
  • mcrypt
  • mhash
  • mongo
  • mysql
  • mysqli
  • OAuth
  • openssl
  • pcre
  • PDO
  • pdo_mysql
  • pdo_pgsql
  • pgsql
  • Phar
  • posix
  • pspell
  • radius
  • Reflection
  • rrd
  • runkit
  • session
  • shmop
  • SimpleXML
  • snmp
  • soap
  • sockets
  • SPL
  • ssh2
  • standard
  • svn
  • sysvmsg
  • tokenizer
  • wddx
  • xml
  • xmlreader
  • xmlrpc
  • xmlwriter
  • zip
  • zlib
  • Environment
  • PHP_Variables
  • PHP Init
  • Possible Issues
WHA 12.png

WHMCS Environment

Last but not least section is simple yet very clear. Your 'WHMCS Environment' includes 'Brief Info' and 'Additional Info' boxes and a list of possible issues.
WHA 13.png

Download File

If you want to save your scan results you may download the current analysis. Press 'Download Results' button to save the results in a ' .PDF' file.
WHA 15.png
If you decide to save the results after each scan, it will be possible to easily compare them and see any changes in your system.
WHA 16.png

Tips

1. Due to a huge size of 'System Environment' section, we advise to use 'Ctrl+F' keys shortage to look for precise information.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. In case you encounter an error like on the screen below, please make sure you have completed step three of our installation instruction.
WHA 17.png
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=25137"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community