Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Web Forms)
 
(386 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<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/>
+
<meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta>
−
We are sorry for the inconvenience caused.</h4>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta>
−
<meta name="keywords" content="crm for whmcs, crm configuration, whmcs crm management, whmcs crm installation, whmcs crm common problems, about whmcs crm, whmcs crm documentation, whmcs crm faq, whmcs crm help, whmcs crm guide, whmcs crm wiki, whmcs crm tutorial, whmcs crm tips, whmcs crm wiki"></meta>
+
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The CRM For WHMCS Module."></meta>
+
  
−
=About [https://www.modulesgarden.com/products/whmcs/crm CRM For WHMCS]=
+
=About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''CRM For WHMCS''' is a module created to expedite the management process of potential clients.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.
−
You will be able to add new contacts, define their type as a lead or a potential and create accounts directly in the addon.<br />
+
Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<br />
−
The module will allow you to send automated notifications, create quotes and notes as well as add custom fields to leads' and potentials' profiles according to your needs.<br />
+
You can also define email templates and view details of each sent notification owing to logs.
−
What is more, all the information about leads and potentials will be shown in a graphic presentation in the dashboard.<br />
+
−
'''TIP''': You can extend the functionality of CRM For WHMCS by integrating the module with Asterisk VoIP Center For WHMCS, Quotes Automation For WHMCS and SMS Center For WHMCS.
+
 
|}
 
|}
−
<!-- fixed -->
+
<!--a comment maybe? -->
−
*'''Addon Module Features:'''
+
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Contacts:
+
|style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Leads
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Potentials
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Custom Types
+
|style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Convert Contact Type
+
|style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Mass Email & SMS To:
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ All Clients
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Chosen Client Groups
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Contacts From Chosen Campaigns
+
|style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Restrict Access To Contact Types
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Client Account To Contact
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Administrator To Contact
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Ticket To Contact
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Quickly Edit Contact Details
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Add And Manage Contact's Follow-ups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Add And Manage Contact's Notes
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View, Create And Synchronize Quotes For Contact
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Contact Tickets
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Contact Orders
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Email From Template Or Custom Message - Include Files And Quote
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Email Using Custom Mailbox
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Send Ticket Response
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Upload And Manage Files From Contact Profile
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Announcements For Administrators
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Logs Concerning Contact
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Dashboard Containing Incoming Follow-ups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Calendar With All Reminders Sorted By Type
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View CRM Statistics And Graphs Concerning Contacts
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Import Contacts In Chosen File Formats: CSV, XSL, XSLX and ODS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Export Contacts In Chosen File Formats: CSV, XSL, XSLX, ODS and PDF
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Upon Removing, Contact Is Moved To Archive Where They Can Be Restored From If Needed
+
−
|}
+
−
*'''Follow-up Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ 3 Types Of Notifications: Now, On Follow-up Date, Before Follow-up Date - Both For Administrators And Clients
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Administrator To Notify - Defines Included Administrators Per Notification Type
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Notify Administrator and Clients via Email And SMS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Notify Administrator via Pop-up Alarm
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Follow-up Type - Easier Determination Of Follow-up Purpose
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Use Email Template Or Place Custom Message
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Synchronize Follow-ups With:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Google Calendar
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 45px;"|✔ WHMCS Calendar
+
−
|}
+
−
*'''Campaign Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Campaign
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Campaign Duration Time
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Leads To Campaign Using Filters
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Manually Assign Campaign To Lead
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Display Dashboard Per Campaign
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Display Campaign Description Inside Of Assigned Lead Profile
+
−
|}
+
−
*'''Web Form Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Web Form
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Allow Your Site Guests To Create New Contacts Via Web Form
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Details Of Web Form Created Contact:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign Fields To Web Form
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Contact Type
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Contact Status
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Assigned Admin
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Get Generated Web Form To Be Placed On Your Site
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ View Number Of Contacts Created From Each Web Form
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Notify Administrators About New Contact Creations
+
−
|}
+
−
*'''Addon Settings Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ View Module Status - Contains Status Of CRM Key Elements
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Whether To Use Quotes And Administrator Assignment
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Follow-up Types And Default Notifications On Follow-up Reschedule
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Temporary And Permanent Notifications For Administrators
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define If Notification Needs To Be Acknowledged By Administrators
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Custom Fields:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Create Fields Groups
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Create Custom Fields - Text, Textarea, Checkbox, Radio And Select
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Add Description To Custom Field
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Add Validators To Custom Fields
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define WHMCS - CRM Fields Mapping - Automatically Fill Out Form With Appropriate Values
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Custom Contact Types:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Contact Type Color And Icon
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Contact Type Visibility On Navigation
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Default View Of Leads And Potentials Lists - Visibility And Order In Columns
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Permissions Per Administrator Role Group
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Personal Settings:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Avatar
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Fields And Their Order For Leads, Potentials And Dashboard
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Configure Default View Of Leads And Potentials Lists - Visibility And Order In Columns
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Create CRM Email Templates
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ View Information About CRM Cron
+
−
|}
+
−
*'''Admin Area Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ WHMCS Support Tickets System - Create Lead, Quickly View Its Details And Move To CRM Contact Profile
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ WHMCS Quotes - Quotes Created From CRM Profile Are Assigned To Contact Automatically
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>Asterisk VoIP Center For WHMCS</u> - Call Your Clients At Any Time [http://www.modulesgarden.com/products/whmcs/asterisk_voip_center/features (read more)]
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Quotes Automation For WHMCS</u> - Extend Your Quotes Possibilities [http://www.modulesgarden.com/products/whmcs/quotes_automation/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>SMS Center For WHMCS</u> - Send Reminders & Mass Messages via SMS [http://www.modulesgarden.com/products/whmcs/sms_center/features (read more)]
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Connect With CRM Using Its API
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Migration Tool - Migrate Leads/Potentials And Settings From CRM For WHMCS 1.2.4
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Standalone Mode - Display CRM Outside Of WHMCS
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Display Any Page Or Panel In Full Screen Mode
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.5.9 Up To PHP 7
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7
+
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure CRM For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.''' <br />
−
We will guide you step by step through the whole installation and configuration process.  
+
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download the module.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file, you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.5.9, while the second one is aimed at PHP 7.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
 
|}
 
|}
 
{|
 
{|
Line 315: Line 72:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:drfere.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install CRM For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'modules/addons/mgCRM/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''  
+
File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
−
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'. ''
+
Enter your license key between 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:CRM_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''6. The next step is setting up '' 'Storage' '' folder as writable.'''<br />
+
−
It is located in '' 'your_whmcs/modules/addons/mgCRM2/app/'.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM_4_2.png]]
+
 
|}
 
|}
  
−
==Activate The Addon==
+
==Configuration of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Now you have to activate the module in your WHMCS system. '''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system.'''<br />
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'CRM' '' and press '' 'Activate' '' button.
+
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br />
+
To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''.
−
'''CRM as standalone page''' - if selected, CRM page will be visible in standalone mode by default, no matter which template is used.<br />
+
−
'''Full Access Admin''' - select admins that will have full access to your module.<br />
+
−
'''Access Control''' - select admin groups that will have access to your module.<br />
+
−
Now, press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]]
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Now, you have to set up a cron job, which can be found in CRM Addon → '' 'Settings' '' → '' 'General' '' → '' 'System Overview'. '' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br />
−
We advise to set up the cron as frequently as possible to send email notifications, 5 minutes interval is recommended.
+
You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_46.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 25px 15px;"|'''10. You have just successfully installed CRM For WHMCS!'''<br />
+
−
You can access your module in '' 'Addons' '' → '' 'CRM'. ''
+
 
|}
 
|}
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''CRM For WHMCS is a module which allows you and your staff to manage relations with your current as well as possible clients in one place.
+
|style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.'''
 
|}
 
|}
−
 
+
==Configuration==
−
==Dashboard==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|When you proceed to '' 'Addons' '' → '' 'CRMv2', '' you are automatically moved to the application dashboard.
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br />
−
From there you have a quick preview of the most important information in your CRM.<br />
+
You can enable/disable any of them, as well as alter or completely remove them.<br />
−
View follow-ups on the calendar, the list of latest leads/potentials and last activities.
+
Press '' 'Create New Group' '' to proceed.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_42.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|It is possible to adjust the dashboard view according to applied filters. Choose dashboard view of CRM for a selected administrator.<br/> Select '' '--Any' '' if you want to show all content.<br/><br/> Additionally, you may impose campaign filters. Choose which campaign records shall be viewed. <br/>Select '' '--Not Applied' '' to disable this filter.  
+
|style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br />
 +
You can choose between two types of resource usage counting:<br />
 +
*Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
 +
*Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_42_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.png]]
 
|}
 
|}
−
===Standalone Mode===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Use cross arrows icon to switch into standalone mode, your CRM module pages will be then accessed outside of WHMCS.<br/>
+
|style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br />
−
Press it again to come back to WHMCS view.
+
As you can see, we have defined limits for both bandwidth and disk.<br />
 +
Settings shown below result in sending notification to client upon:
 +
*bandwidth usage growth by 5GB during 21 days.
 +
*disk usage growth by 100GB over period of 14 days.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_43.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]]
 
|}
 
|}
−
 
+
==Logs==
−
==Contacts==
+
−
===Create Contact===
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To create a new contact press button marked on the screen below.
+
|style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_11_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]]
 
|}
 
|}
 +
==Notifications==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You are moved to a contact creation form. As you can see below, fields are divided into two sections: Options and Information.<br /> Fill out the form and press '' 'Add' '' to add the contact to the list. There may be visible some custom fields if they have been added and enabled.<br/>
+
|style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br />
−
''Note: Only staff members with full privileges can assign admins to the contacts.''
+
The only requirement is their type being set to '' 'Product/Service' ''.<br />
 +
Additionally, you can use {if} statement, as shown below:
 +
{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
 +
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}
 +
It will allow you to use this email template for bandwidth and disk notifications at the same time.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Immediately, after a new contact is added you are moved to its summary, where you can find/edit some additional data.<br/>
+
−
Read more about them in the following section.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_12.png]]
+
 
|}
 
|}
  
−
===Manage Contacts===
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Actions' '' column you can find various useful operations which can be performed on a contact.<br />
+
|style="padding: 10px 0px 30px 15px;"|
−
As you can see, in dropdown menu, actions such as '' 'Convert To Potential' '' and '' 'Move To Archive' '' can be found.<br />
+
−
'' 'Note: '' 'Call Out' '' functionality is available as well if you have [https://www.modulesgarden.com/products/whmcs/asterisk-voip-center Asterisk VoIP Center For WHMCS] installed and configured properly.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Now, let's proceed to the contact itself.<br />
+
−
Press pencil icon to move to the contact's summary page.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_14.png]]
+
 
|}
 
|}
  
−
====Summary====
+
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To edit any of the options in the contact summary page, simply press a pencil icon that appears when you hover your mouse cursor on the option.<br/> In this way, you may reassign the administrator, alter the name and change the current status. Mark the appropriate number of stars to change the contacts priority:
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
−
*Low
+
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
−
*Medium
+
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
−
*Important
+
−
*Urgent
+
 
|}
 
|}
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_20.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|As mentioned above, when you press the pencil icon, you may select current status, choose from:
 
−
*Pending ''(custom)''
 
−
*New
 
−
*Active
 
−
*Closed
 
−
*Urgent<br/>
 
−
Every time you are editing any information please press the green confirmation button to save the changes.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_19.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In the area marked on the following screen, you can find fields where an existing client can be assigned,<br/> ticket from which the contact was created, its basic details and campaigns if this contact belongs to any.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_15.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|The module allows assignment of a client account to the contact.<br />
 
−
This can be done in two ways, by creating a new client from a contact or by selecting an existing client to a contact.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_16.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|In the same way, you may assign a support ticket to a contact. Then, you can easily and quickly find details of the contact background.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_17.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|When you hover over the email address, two icons appear. Press the first one and you will be redirected to a section where you can send email messages from.<br/> When you decide to edit (2.), simply type in the new address.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_18.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Just like in a case of any other option in this section, you may assign your contact to any campaign if such exists. <br/>When assigned, campaign details appear in a separate widget.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_18_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Summary' '' page you may also find a brief conclusion on created notes, the list of flow-ups and quickly do actions like:
 
−
*adding new notes
 
−
*sending emails
 
−
*sending SMS messages (for SMS Center integration)
 
−
*adding follow-ups
 
−
*sending tickets responses ''(if assigned)''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_21.png]]
 
−
|}
 
−
 
−
====Follow-ups====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Follow-ups allow you to send email templates or text messages to contacts and staff members and create ToDo entries.<br />
 
−
Any follow-up can be rescheduled (1.) or removed (2.) using buttons in the '' 'Actions' '' column.<br />
 
−
You can search for the desired follow-up using the search box and sort by one of the columns.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_21_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|To add a new follow-up, fill out the '' 'New Follow-up' '' form.<br />
 
−
Here you can define:
 
−
*Date - (required) time when the notifications will be sent.
 
−
*Description - (required) short description of a follow-up, it will be afterwards visible in the follow-up list.
 
−
*Follow-up Type - allows you to define the type of a follow-up for easier determination of its purpose.
 
−
*Admin - admin whom ToDo entry will be assigned.<br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_22.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|The last step is defining reminders, we will discuss each of them below.
 
−
Reminders for Administrators
 
−
*'' 'On Create' '' - Notification is sent to an admin, who is assigned to a Lead/Potential, immediately when a follow-up is created.
 
−
*'' 'Follow-up Due Date ' '' - notification is sent to an admin, who is assigned to a Lead/Potential, on the set date.
 
−
*'' 'Before Follow-up Due Date ' '' - Specify time (date/hours/minutes etc) before the Follow-up Due Date to send the notification to an admin, who is assigned to a Lead/Potential.
 
−
Reminders for Clients
 
−
*'' 'On Create' '' - Notification is sent to a client, who is assigned to a Lead/Potential, immediately when a follow-up is created.
 
−
*'' 'Follow-up Due Date ' '' - Notification is sent to a client, who is assigned to a Lead/Potential, on the set date.
 
−
*'' 'Before Follow-up Due Date ' '' - Specify time (date/hours/minutes etc) before the Follow-up Due Date to send the notification to a client, who is assigned to a Lead/Potential.<br/>
 
−
Choose whether you wish to send reminders via email or SMS (if SMS Center for WHMCS is activated) or perhaps both.<br/> Once the option is marked and the path was chosen, you will have to fill out the details for chosen reminder, separate for emails and separate for SMS.<br/>
 
−
Press '' 'Add Follow-up' '' to finalize the process.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_23.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Added follow-up will turn up on the list of all follow-ups of the lead. Use action buttons to delete the follow-up, reschedule and edit.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_24.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In order to reschedule a follow-up, you must always give the reason!
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_25.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Edit follow-up details:
 
−
*edit details
 
−
*add reminders
 
−
*manage existing reminders
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_26.png]]
 
−
|}
 
−
 
−
====Notes====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Notes' '' enables you to make and manage notes about the contact.<br />
 
−
On the following screen you can see how to add an exemplary note.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_27.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Any existing note can be modified and hidden as presented below.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_28.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Please note that only hidden notes can be deleted. <br/>To show hidden notes press '' 'Display Hidden'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_29.png]]
 
−
|}
 
−
 
−
====Emails====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Any staff member can send an email from the contact's profile.<br />
 
−
As you can see, you can manually fill out email subject and content.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_30.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Alternatively, you can choose one of email templates to send.<br />
 
−
Whatever way you choose, you can choose the address to send from, as well as attach files and quotes.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_31.png]]
 
−
|}
 
−
 
−
====Orders====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Move to orders page where you can place orders for the contact. When you press '' 'Add New Order' '' and you will be redirected to your WHMCS page where order can be placed.<br/>Preview details of all orders and edit them if required.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_32.png]]
 
−
|}
 
−
 
−
====Quotes====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Quotes can be created for any CRM contact.<br />
 
−
As you can see on the screen below, in the '' 'Quotes' '' section of the contact page, brief information about quotes assigned to the contact is displayed.<br />
 
−
You can edit any of these quotes through using buttons in '' 'Actions' '' column.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_34.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|You can also create a new quote for the contact, press '' 'Add New Quote' '' as shown on the following screen.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_35.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Now, create a quote for your contact.<br />
 
−
You can do it in two ways, if a client is assigned to the contact, they will be automatically linked to the quote.<br />
 
−
Otherwise, module will ask you to fill in a new client account details from to complete quote.<br />
 
−
In the second scenario, client account will not be created in the process, unless you use '' 'Convert to Invoice' '' functionality.<br />
 
−
'''Important:''' For extended functionality related to quotes we recommend our [http://www.modulesgarden.com/products/whmcs/quotes_automation/features Quotes Automation For WHMCS].<br />
 
−
It extends quotes with functionalities like adding product addons and domains to the quote, their automatic provision, and quote acceptance from the client area.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_36.png]]
 
−
|}
 
−
 
−
====Tickets====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Tickets' '' tab shows all tickets created by client.<br />
 
−
If you want to create manually a new ticket for the client click '' 'Add New Ticket'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_36_2.png]]
 
−
|}
 
−
 
−
====Files====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Files' '' tab allows you to upload and manage files related to your contact.<br />
 
−
To upload a new file, select file to upload and describe it shortly, press '' 'Upload'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_37.png]]
 
−
|}
 
−
{|
 
−
|style="padding:0px 0px 15px 15px;"|Any uploaded file can be downloaded from the CRM by pressing its name or using actions icons.<br />
 
−
It can be also removed by clicking on dustbin icon.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_38.png]]
 
−
|}
 
−
 
−
====Logs====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|To view the latest actions performed on the contact, go to '' 'Logs' '' tab.<br />
 
−
As you can see, it contains all details you might want to find in the logs.<br />
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_39.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|'' 'Logs' '' page, apart form displaying all the logs concerning the contact, contains search box.<br />
 
−
Using the search option you can find logs of actions performed by specific administrators, at desired time and concerning desired actions.<br />
 
−
On the following screen we were searching logs of associated with any event on client.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_40.png]]
 
−
|}
 
−
 
−
==Calendar==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Access calendar tab and you will find a fully manageable and adjustable calendar.<br/>
 
−
Switch between days, month and week views to have a clear and precise view of your scheduled events (click on a selected day to see details).<br/><br/>
 
−
Month view:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_43_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Under the calendar, there is a detailed legend of visible items with enumerated types of follow-ups.<br/>
 
−
Click on any follow-up to see its details.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_43_2.png]]
 
−
|}
 
−
 
−
==Campaigns==
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|Another functionality that CRM For WHMCS has to offer is the possibility to create customized campaigns.<br/>
 
−
If you decide to apply this option, you will be able to create many various campaigns with selected contacts included and  filtered according to your personal configurations.<br/>
 
−
Let's check how this functionality works.
 
−
|}
 
−
===Add Campaign===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In order to add a new campaign use '' 'Create Campaigns' '' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_41.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Start with filling out some basic data about the campaign such as its name and descriptions. Select color that will be used to distinguish items.<br/> Assign admins who will have access to the campaign entries and declare beginning and ending dates.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_41_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In the second part you need to select filters to assign wanted record to this campaign. You may use both predefined system fields and your custom fields.<br/>Finally '' 'Add Campaign'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_41_2.png]]
 
−
|}
 
−
===Campaigns List===
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Find all the created campaigns stored together on a convenient list with the most crucial data close at hand.<br/>
 
−
Use Action buttons to:<br/>
 
−
1. Manually force record reassignment <br/>
 
−
2. Move to edition page<br/>
 
−
3. Delete unused campaign
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_41_3.png]]
 
−
|}
 
−
 
−
==Settings==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Due to the wide variety of possible configurations, '' 'Settings' '' section has been moved to underneath to make the presentation more precise.<br />
 
−
In '' 'Settings' '' → '' 'General' '' page of the module you can check current module status, enable major features and define follow-ups' settings.
 
−
|}
 
−
 
−
===General===
 
−
====System Overview====
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Under '''System Overview''' you can find information about:
 
−
*Integration with Asterisk VoIP Center For WHMCS
 
−
*Integration with SMS Center
 
−
*Cron job setup
 
−
*Number of CRM email templates
 
−
*Storage folder used by the module
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_45.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Cron Details', '' you can find all the information about the cron such as its path, last execution date and interval between cron runs.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_46.png]]
 
−
|}
 
−
 
−
====Options====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Additional Options' '' quotations may be enabled for leads and potentials as well as possibility to assign leads to administrators.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_47.png]]
 
−
|}
 
−
 
−
====Follow-ups====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In the next section of General Settings there are few options to configure follow-ups. <br/>
 
−
In settings part, you may activate alarms which will show pop-up notifications on coming follow ups.
 
−
Next, follow-up per day, it means that a follow-up can be added within a day, not a specific hour.<br/>
 
−
You may also choose email template used to notify admins about a follow-up being rescheduled.<br/>
 
−
'' Note: Pop-up alarms are sending once per minute. If follow-up starts e.g. at 12:15 hour the alarm might be shown at 12:14. '' <br/>
 
−
'' Moreover if 'Follow-ups Per Day' option is enabled then if follow-up starts e.g. 07.08.2017 the alarm might be shown on 06.08.2017 at 23:59 hour. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_48.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"| If you enable follow-up alarms, the pop-up notifications will be look like on the image below:
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_48_3.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|
 
−
Additionally you can enable follow-ups synchronization with WHMCS and Google Calendar <br/>
 
−
For 'WHMCS Calendar' no additional configuration is required. For 'Google Calendar' configuration look [https://www.docs.modulesgarden.com/CRM_For_WHMCS#Google_Calendar here].
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_48_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|At the end, you can add a new follow-up type by entering its name, assigning a color and finally enabling it to use. Once added you will see in the list of available underneath.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_49.png]]
 
−
|}
 
−
=====Google Calendar=====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|
 
−
To set up a connection with Google Calendar go to '' 'Settings' '' → '' 'General' '' → '' 'Follow-ups' '' tab. <br/>
 
−
Then select from the dropdown Google Calendar and click on 'Update Settings'. You will see a box to configure API data.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_67.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|To find your ''' 'Client ID' ''' and ''' 'Client Secret' ''' go to '' '[https://console.developers.google.com Google API Manager]' '' and log in if necessary.<br/>
 
−
On 'API Manager' go to the '' '[https://console.developers.google.com/apis/library Library]' '' and select Calendar API. Accept 'Terms of Service' if shown.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_68.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Next, press 'Create Project', and enter a new project name.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_69.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|After project creation, you will be able to enable calendar API.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_70.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Now press 'Credentials' tab.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_71.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"| Click on 'Create credentials' and select '0Auth client ID'
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_72.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"| On the second step provide the project name you want, your main website URL and callback URL in the following format:<br/>
 
−
<nowiki>http://yourdomain.com/admin/crm.php/api/settings/general/auth/google/json</nowiki>
 
−
''Note that your 'admin' folder might also have a custom name.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_73.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"| You will now obtain your 'client ID and 'client secret'.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_74.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"| Now copy and paste them into your CRM authorization settings. <br/>
 
−
Press 'Authorization' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_75.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"| On the last step allow authorization.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_76.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"| Your Google Calendar should be now synchronized with CRM follow-ups.<br/>
 
−
''Please note that this synchronization will work only for newly created follow-ups and only one way, from CRM to Google Calendar.''
 
−
|}
 
−
 
−
====API Connection====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| You may easily connect with our module through its own API. To learn more details please visit this [https://github.com/modgarden/modulesgarden-crm-api page].
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_49_1.png]]
 
−
|}
 
−
 
−
===Personal===
 
−
====Personal Settings====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Provide a URL to your avatar to personalize your CRM as you only wish!
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_50.png]]
 
−
|}
 
−
 
−
====Fields' View====
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In this place you may decide which columns exactly and even in what order they will appear in each of the possible sections<br/>(Contact's page and Dashboard). Click on each section one by one to set its view.<br/>
 
−
Drag and drop available fields to create a perfect configuration.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_51.png]]
 
−
|}
 
−
===Outgoing Mailbox===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In this section you can add and assign custom mailboxes to administrators who shall use them as default for sending emails to contacts<br/>
 
−
This might be handy if you want to use different mailbox than configured in WHMCS settings. To begin press 'Create Mailbox' button.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_77.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Next, provide the name that will be shown in contact's mail massage, choose admin you with to assign and fill the rest fields with your mailbox data configuration. <br/>
 
−
Press 'Add Mailbox' button when ready.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_78.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|From now when the admin will want to send the email to the contact, their will be able to use the configured mailbox.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_78.png]]
 
−
|}
 
−
 
−
===Fields===
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|Manage '' 'Fields' '' fully, add new fields, group them, define statuses and map existing fields.<br />
 
−
|}
 
−
 
−
====List Of Fields====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Each field, regardless of its type, has its name, description, assigned group and obviously its type.<br />
 
−
Available types and validators for each of the types (seen when editing existing field)
 
−
*text: ''required, min, max, email, url, ip, regex''
 
−
*textarea: ''required, min, max, regex''
 
−
*radio: ''required, min, max''
 
−
*checkbox: ''required, min, max''
 
−
*select: ''required, min, max''
 
−
On the following screen you can see an example of a dropdown type custom field.<br />
 
−
To add a field, press '' 'Create Field'. ''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_53.png]]
 
−
|}
 
−
 
−
====Groups====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Place where groups to segregate fields are created. Once you already know how you want to group your fields, create an adequate group.<br/>Name them, assign a color and enable to start using it.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_54.png]]
 
−
|}
 
−
 
−
====Status====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Exactly, just like in case of groups, you may add hare statuses that later on will be used to segregate fields.<br/>Name the new status, assign a color and enable to start using it.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_55.png]]
 
−
|}
 
−
 
−
====Fields Mapping====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Fields Mapping' '' option allows you to bond CRM fields with WHMCS standard or client custom fields.<br />
 
−
This way during creation a lead from client's ticket or a client from lead, mapped fields will be automatically filled out.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_56.png]]
 
−
|}
 
−
===Contact Types===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'' 'Leads' '' and '' 'Potentials' '' are the only predefined contact types that are available from the beginning you start using your CRM.<br/>
 
−
However, to make our CRM for WHMCS even more customizable and user friendly we have implemented a function which allows creating new contact types and their full management. <br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_56_1.png]]
 
−
|}
 
−
====Add New====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|To add a new type simply fill out the visible on the screen below form.<br/>
 
−
*Enter its name and choose color
 
−
*Enter icon code - the icon will be always visible next to this contact type name, remember to use available formats, e.g.: '' 'fa fa-empire', 'fa fa-plus-circle'' '
 
−
*Visibility in navigation bar - choose whether you wish to have the new contact type visible on the main navigation menu and submenu (under '' 'Contacts' '' tab)
 
−
*Dashboard - if you select this option, the new type will be visible on dashboard, and you will be able to filter the view by this type.<br>
 
−
Press '' 'Add' '' button to finish the process.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_56_2.png]]
 
−
|}
 
−
 
−
====Contacts Management====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Under the creation form, there is a list of all available in your CRM contact types, together with the predefined '' 'Leads' '' and '' 'Potentials'. ''<br/>
 
−
Here you can fully customize your contact by:
 
−
*changing assigned color or icon,
 
−
*turning on/off its availability in navigation menus and dashboard
 
−
*activating/deactivating the contact
 
−
*deleting useless types.<br/>
 
−
'''Important!'''<br/>
 
−
''Any changes made in this section require reloading the page or clearing browser cache! Changes to contact types are not instant.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_56_3.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|If you want to delete a contact type, you will be asked to choose another type to which any contacts of the deleted type will be reassigned to.<br/>
 
−
If you do not want to reassign the contacts to another type, you can move them to the archive, to do so, simply select  '' 'Move to Archive' '' option.<br/>
 
−
''Still, you will have to choose a type for contacts. It will be used in case you decide in future to restore these contacts from the archive.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_56_4.png]]
 
−
|}
 
−
 
−
===Permissions===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The last but one section in '' 'Settings' '' is responsible for assigning permissions to certain roles of group of administrators.
 
−
Select permissions for each existing role.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_57.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Once you have added a new role, use actions buttons to move the page where you can choose single permission rights for the group.<br/>
 
−
Select the one you need and '' 'Update' '' the settings.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_52.png]]
 
−
|}
 
−
 
−
===Import/Export===
 
−
====Export File====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In order to export a file from your CRM system, simply choose a target file format ''(CSV, XLS, XLSX, ODS or PDF)'' and press '' 'Export' '' button.<br/> A file with a list of contacts available in your system with their details such as name, type, priority, phone etc will download shortly.<br/>
 
−
'''A list of available fields that can be included in the file to either import or export are available underneath.'''<br/>
 
−
<span style="color: red;">'''Important!'''<br/> It is required that you use only the fields that are visible underneath. In case you name your columns in any other way, the import action will fail!</span>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_57_1.png]]
 
−
|}
 
−
====Import File====
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In order to import a file to your CRM system, simply select a file from your disc and press '' 'Upload' '' button.<br/>
 
−
A file with uploaded list of contacts will be available shortly.<br/>
 
−
''Note: you can upload files of 'csv', 'xls', 'xlsx' or 'ods' format only.''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_57_2.png]]
 
−
|}
 
−
 
−
===Web Forms===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Web Forms give the possibility to collect contacts' details from different sources.<br/>
 
−
In your CRM for WHMCS you may now generate sample web forms which you can then locate in your external sites. Your customers then will fill out their data<br/> which will be automatically delivered into your CRM. Creating new contacts is now much faster and easier.<br/>
 
−
 
−
Proceed to '' 'Settings' → 'Web Forms'. '' There is a list of all already created web forms. You may edit them or delete at any time. <br/>
 
−
Here you  will also find a raw HTML code of the web form, which must be used to locate it in your desired web site ''(see action buttons). ''<br/>
 
−
 
−
Press button marked on the screen to create a new web form.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_57_4.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|To generate a web form, you must provide some basic details:
 
−
*Your web form name
 
−
*URL of the site where you want to locate the web form (required for CORS)
 
−
*Define contact type for a new customer and its initial status.
 
−
*Optionally choose administrators who will be informed of the addition of a new client from web form.
 
−
Additionally, you may select fields that will be visible to fill out. Drag a field and drop in the currently created web form box.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_57_5.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Once your web form draft is ready, you have to now manually add it to the desired location.<br/>Underneath, you will find a sample instruction on how to add a web form as a widget to word press application.<br/>
 
−
'''1. Log in to your admin area on your Word Press.'''<br/>
 
−
'''2. Move to '' 'Appearance' → 'Widgets' '' and press '' 'Manage in Customizer'. '''''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_57_6.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
'''3. Select '' 'Widgets' → 'Content Sidebar'. '' '''<br/>
 
−
'''4. Press '' 'Add a Widget' → 'Text'. '''''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_57_7.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
'''5. Title your widget.'''<br/>
 
−
'''6. Paste the HTML code copied from your web form into '' 'Content'. '' '''<br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_57_8.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Ready! Your web form with empty fields that can be filled out by your clients is ready.<br/> If your clients provide required data, new contacts will be automatically added to your CRM. <br/>
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_57_9.png]]
 
−
|}
 
−
 
−
==Utilities==
 
−
===Statistics===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'Statistics' contains graph concerning your leads and potentials.
 
−
 
−
Among the graphs, there can be distinguished graphs showing for example: the number of Leads and Potentials per status, new contacts per admin, per month and per day.<br/>
 
−
Additionally, administrators with extended permissions are able to view statistics of chosen administrators.
 
−
 
−
In '' 'Statistics' '' you can find the overall information such as graphs on Leads and Potentials of chosen status. <br/>
 
−
See a list of recently added leads/potentials with details such as assigned admins, status or creation date.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_58.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|There are graphs and statistics tables presenting number of leads/potentials added within certain periods of time (year/month)
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_60.png]]
 
−
|}
 
−
 
−
===Notifications===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In this part you can manage any notifications that shall be delivered to any administrator depending on the configuration.<br/>
 
−
Let's check how it works. Press '' 'Create Notification' '' to begin.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_59.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|You are moved to '' 'New Notification' '' creation form. Fill out the data to tailor the notification base perfectly in accordance with your needs.<br/>
 
−
*Choose its '' 'Type' '' from '' 'Temporary' '' and '' 'Permanent'. ''
 
−
*Select importance: '' 'Normal', 'Information', 'Warning' '' and '' 'Danger'. ''
 
−
*Mark administrators that this notification will be displayed to. You may surely select more than one admin.
 
−
*In '' 'Message' '' field simply type in the text of the notification. It is allowed to use HTML code here.
 
−
*Select '' 'Starting' '' and '' 'Ending' '' dates for '' 'Temporary' '' notifications
 
−
*'' 'Confirmation' '' - if you select this box, administrator will have to confirm reading such notification by pressing '' 'Accept' '' button visible on the notification
 
−
*'' 'Hide Once Accepted' '' - decide whether accepted notification should disappear from the widget
 
−
Press '' 'Create Notification' '' button when ready.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_59_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|A newly created notification form is now visible on the list of all notifications in the system.<br/>
 
−
You may easily edit the notification ''(you will be moved to creation form where you can make any changes)'' or delete useless notification.<br/>
 
−
You will see here information if notifications have been accepted by administrators (if required) and by which ones exactly.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_59_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Created notifications are visible for selected in the configuration admins on any page of their CRM system.<br/>
 
−
'' 'Accept' '' your notifications if it is required. Such info boxes like on the screen below will be visible until the specified in the configuration '' 'Ending Date', ''<br/> or once accepted if '' 'Hide Once Accepted' '' option has been selected.
 
−
You may easily hide it by pressing icon in the top right corner of the widget.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_59_3.png]]
 
−
|}
 
−
 
−
===Mass Messages===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Configure mass messages templates that can be used in your campaigns!<br/>
 
−
Press '' 'Create Mass Message' '' and fill out the template form.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_60_1.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|
 
−
*Choose a group the messages will be delivered to, these can be single users, groups of users or campaigns.<br/>
 
−
*Select message type: email or SMS ''(if integrated with [https://www.modulesgarden.com/products/whmcs/sms-center SMS Center For WHMCS])''
 
−
*Enter subject of the message
 
−
*Select date when messages will be placed on the list to send (triggered by cron)
 
−
*Select user groups/users or campaigns (depending in the chosen target)
 
−
*Describe the template shortly
 
−
*Create the message
 
−
**Enter the main content of the message, use an advanced tool to edit the input (email only) and available merge fields.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_60_2.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Once added, mass message template will be visible on the list. You will find there short info on each template.<br/>
 
−
Use action buttons to edit or remove a template.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_60_3.png]]
 
−
|}
 
−
 
−
===Archive===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|List of unused leads/potentials. Use action buttons to edit entries and convert them back to lead or potential from the archive.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM2_61.png]]
 
−
|}
 
−
 
−
==Migration==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|If you have already used any of the previous versions of CRM, the very first thing that you need to do with your module before moving to any further steps<br/> is migrating data from old CRM to CRM V2.0.0. To do so, move to '' 'Addons' → 'CRM' → 'Settings' → 'Migrator'. ''<br/>
 
−
You need to note that not all data can be migrated due to some incompatibility between systems.<br/>
 
−
These are:
 
−
*follow-ups
 
−
*uploaded files
 
−
<br/>
 
−
'''Important!''' Before you proceed to migration itself, you must always make a backup copy of your database for safety reasons.<br/> In case of any unpredicted issues you will not lose any data and will be able to restore the previous version.<br/> <br/>
 
−
If you fulfill all conditions, press '' 'Begin Migration' '' to start the process.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_62.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Prepare mapping of statuses used in CRM V 1.2.4 that you wish to map to CRM V2.0.0.<br/> Confirm that you have done the mapping correctly and then move to custom fields mapping configuration.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_64.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Map fields used in CRM V 1.2.4, confirm proper configuration and move to the last step.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_65.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Read carefully all the information about migration consequences, if you agree with them, start the migration.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM2_66.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|Congratulations! You have successfully migrated your database from old CRM to the latest version!<br/>Now, you can enjoy a much improved management of your contacts with potential clients.
 
−
|}
 
−
 
−
==Tickets==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Our module offers additional integration in your WHMCS support tickets system.<br />
 
−
As you can see on the screen below, your support operators can convert tickets directly into Contact Lead.<br />
 
−
This way you can track relations with your valuable clients.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM_53.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|Any ticket of such client will be displayed with contact name, status and assigned staff member.<br />
 
−
Additionally, after pressing '' 'Details' '' extended information about the contact will be displayed in a popup.<br />
 
−
''Note: Any contact can be transferred between being lead and potential from the ticketing system as shown below (blue arrow).''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM_54.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Your staff will be also able to quickly move to the contact profile in CRM For WHMCS by pressing '' 'Show Contact' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM_55.png]]
 
−
|}
 
−
 
−
==Asterisk VoIP Center For WHMCS Integration==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Integration with [http://www.modulesgarden.com/products/whmcs/asterisk_voip_center/features Asterisk VoIP Center For WHMCS] extends your possibilities with ability to originate calls to your CRM contacts.<br />
 
−
As soon as you install the module, you can originate a call by pressing '' 'Call Out' '' button.<br />
 
−
If everything is set up correctly, you should see something similar to the screen below.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:CRM_56.png]]
 
−
|}
 
−
 
−
==Workflow==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"| In order to familiarize you with the module even more, we are presenting here an example workflow.<br />
 
−
In the beginning, let's point the differences between privileges groups:<br />
 
−
*'''Full Privileges Group''' - access to everything. '' 'Settings' '' tab is available only for this group.
 
−
*'''Sales Manager''' - ability to manage each Lead and Potential. Additionally, access to the dashboard with stats of each staff member and ability to export contacts.
 
−
*'''Sales Person''' - he can maintain only his own Leads and Potentials. Dashboard with only his stats.
 
−
On the following screen you can see the settings for each of the groups.<br />
 
−
*Full Administrator - Full Privileges Group<br />
 
−
*Sales Manager - Sales Manager<br />
 
−
*Sales Person - Sales Person<br />
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:CRM_57.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 15px;"|'''Storytelling'''<br />
 
−
Let's say we have admin X with full privileges and admin Y who has sales person privileges.<br />
 
−
'''1.''' Admin X obtains a new contact, which is called Company X and creates Lead profile in CRM.<br />
 
−
Additionally, he assigns admin Y to the Company X and leaves some notes in the profile.<br />
 
−
'''2.''' Admin Y can now read these notes and choose newsletters and promotion notifications from email templates.<br />
 
−
He sets them as a follow-ups spread over the next two weeks. Luckily, one of the newsletters draws the attention of Company X.<br />
 
−
'''3.''' They respond to the newsletter, so that, admin Y changes this contact type to Potential.<br />
 
−
This way he can track the relation with that contact better.<br />
 
−
'''4.''' After a few emails with Company X, admin Y decides to prepare an interesting offer for the contact in the form of a quote.<br />
 
−
'''5.''' Once the quote has been accepted, admin Y creates client account for the contact.<br />
 
−
Additionally, owing to the integration with Quotes Automation For WHMCS, he is able to quickly generate the invoice & the order from the quote.<br />
 
−
'''6.''' The following month a few more offers are accepted, and both your company and Company X benefit from it.<br />
 
−
'''7.''' All the time admins X and Y can easily track their contact with Company X.<br />
 
−
Thanks to the quotes in the contact profile they can see current offers made for Company X.<br />
 
−
While notes and files can give more information about progress in making current agreements.
 
−
|}
 
−
 
−
=Additional Information=
 
−
{|
 
−
|style="padding: 10px 0px 20px 15px;"|A full list of supported variables for reminders and email templates:
 
−
|}
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|
 
−
|
 
−
'''Reminders:'''                                         
 
−
*{$contact.id}                                                                             
 
−
*{$contact.name}
 
−
*{$contact.status_id}
 
−
*{$contact.email}
 
−
*{$contact.phone}
 
−
*{$contact.priority}
 
−
*{$contact.type_id}
 
−
*{$contact.admin_id}
 
−
*{$contact.client_id}
 
−
*{$contact.ticket_id}
 
−
*{$contact.created_at}
 
−
*{$contact.updated_at}
 
−
*{$contact.deleted_at}
 
−
*{$contact.status}
 
−
*{$contact.client.id}
 
−
*{$contact.client.uuid}
 
−
*{$contact.client.firstname}
 
−
*{$contact.client.lastname}
 
−
*{$contact.client.companyname}
 
−
*{$contact.client.email}
 
−
*{$contact.client.address1}
 
−
*{$contact.client.address2}
 
−
*{$contact.client.city}
 
−
*{$contact.client.state}
 
−
*{$contact.client.postcode}
 
−
*{$contact.client.country}
 
−
*{$contact.client.phonenumber}
 
−
*{$contact.client.password}
 
−
*{$contact.client.authmodule}
 
−
*{$contact.client.authdata}
 
−
*{$contact.client.currency}
 
−
*{$contact.client.defaultgateway}
 
−
*{$contact.client.credit}
 
−
*{$contact.client.taxexempt}
 
−
*{$contact.client.latefeeoveride}
 
−
*{$contact.client.overideduenotices}
 
−
*{$contact.client.disableautocc}
 
−
*{$contact.client.datecreated}
 
−
*{$contact.client.notes}
 
−
*{$contact.client.billingcid}
 
−
*{$contact.client.securityqid}
 
−
*{$contact.client.securityqans}
 
−
*{$contact.client.groupid}
 
−
*{$contact.client.cardtype}
 
−
*{$contact.client.cardlastfour}
 
−
*{$contact.client.cardnum}
 
−
*{$contact.client.startdate}
 
−
*{$contact.client.expdate}
 
−
*{$contact.client.issuenumber}
 
−
*{$contact.client.bankname}
 
−
*{$contact.client.banktype}
 
−
*{$contact.client.bankcode}
 
−
*{$contact.client.bankacct}
 
−
*{$contact.client.gatewayid}
 
−
*{$contact.client.lastlogin}
 
−
|
 
−
*{$contact.client.ip}
 
−
*{$contact.client.host}
 
−
*{$contact.client.status}
 
−
*{$contact.client.language}
 
−
*{$contact.client.pwresetkey}
 
−
*{$contact.client.emailoptout}
 
−
*{$contact.client.allow_sso}
 
−
*{$contact.client.created_at}
 
−
*{$contact.client.pwresetexpiry}
 
−
*{$contact.client.ticket.id}
 
−
*{$contact.client.ticket.tid}
 
−
*{$contact.client.ticket.userid}
 
−
*{$contact.client.ticket.name}
 
−
*{$contact.client.ticket.email}
 
−
*{$contact.client.ticket.title}
 
−
*{$contact.field.<fieldID>.id}
 
−
*{$contact.field.<fieldID>.type}
 
−
*{$contact.field.<fieldID>.active}
 
−
*{$contact.field.<fieldID>.name}
 
−
*{$contact.field.<fieldID>.description}
 
−
*{$contact.field.<fieldID>.data}
 
−
*{$contact.field.<fieldID>.options}
 
−
 
−
*{$followup.id}
 
−
*{$followup.resource_id}
 
−
*{$followup.type_id}
 
−
*{$followup.admin_id}
 
−
*{$followup.description}
 
−
*{$followup.date}
 
−
*{$followup.created_at}
 
−
*{$followup.updated_at}
 
−
*{$followup.deleted_at}
 
−
*{$followup.resource.id}
 
−
*{$followup.resource.name}
 
−
*{$followup.resource.status_id}
 
−
*{$followup.resource.email}
 
−
*{$followup.resource.phone}
 
−
*{$followup.resource.priority}
 
−
*{$followup.resource.type_id}
 
−
*{$followup.resource.client_id}
 
−
*{$followup.resource.ticket_id}
 
−
*{$followup.resource.created_at}
 
−
*{$followup.resource.updated_at}
 
−
*{$followup.resource.deleted_at}
 
−
*{$followup.resource.status}
 
−
*{$followup.resource.client.id}
 
−
*{$followup.resource.client.firstname}
 
−
*{$followup.resource.client.lastname}
 
−
*{$followup.resource.client.email}
 
−
*{$followup.resource.ticket.id}
 
−
*{$followup.resource.ticket.tid}
 
−
*{$followup.resource.ticket.userid}
 
−
*{$followup.resource.ticket.name}
 
−
*{$followup.resource.ticket.email}
 
−
*{$followup.resource.ticket.title}
 
−
|}
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|'''Email Templates:'''
 
−
*{$resource.client.id}
 
−
*{$resource.client.firstname}
 
−
*{$resource.client.lastname}
 
−
*{$resource.client.email}
 
−
 
−
*{$resource.id}
 
−
*{$resource.name}
 
−
*{$resource.status_id}
 
−
*{$resource.email}
 
−
*{$resource.phone}
 
−
*{$resource.piority}
 
−
*{$resource.type_id}
 
−
*{$resource.admin_id}
 
−
*{$resource.client_id}
 
−
*{$resource.ticket_id}
 
−
*{$resource.created_at}
 
−
*{$resource.updated_at}
 
−
*{$resource.deleted_at}
 
−
*{$resource.status}
 
−
 
−
*{$fields.<fieldID>.id}
 
−
*{$fields.<fieldID>.type}
 
−
*{$fields.<fieldID>.active}
 
−
*{$fields.<fieldID>.name}
 
−
*{$fields.<fieldID>.description}
 
−
*{$fields.<fieldID>.data}
 
−
 
−
*{$company_name}
 
−
*{$company_domain}
 
−
*{$company_logo_url}
 
−
*{$whmcs_url}
 
−
*{$whmcs_link}
 
−
*{$whmcs_admin_url}
 
−
*{$whmcs_admin_link}
 
−
*{$signature}
 
−
*{$date}
 
−
*{$time}
 
−
|}
 
−
=Tips=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|1. If you want to see a specific part of your CRM, a single widget only, use full-screen mode for widgets.<br/>
 
−
You will find it in the top right corner of each widget.
 
−
|}
 
−
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 15px;"|2. In case you have problems with your CRM, for example empty tables, no follow-ups in the calendar or you cannot add new status, group, follow-up, then please make sure that <br/>your ''.htaccess'' or ''vhost'' do not block the module in any way.<br/>
+
−
Underneath there is an exemplary input of a ''.htaccess'' file, which will unblock the connections and methods:<br/>
+
−
 
+
−
RewriteCond %{REQUEST_FILENAME} !-f
+
−
RewriteCond %{REQUEST_FILENAME} !-d
+
−
RewriteRule ^(.*)crm.php(.*)$ /admin/crm.php [QSA, L]
+
−
+
−
<Limit PUT DELETE OPTIONS>
+
−
    Order allow,deny
+
−
    Allow from all
+
−
</Limit>
+
−
 
+
−
Please note that ''admin'' file may have a custom name, remember to adjust the file input to your naming.
+
−
|}
+
−
{|
+
−
|style="padding: 00px 0px 30px 15px;"|'''
+
−
3. If you get an error that '' 'Directory <your_whmcs>/modules/addons/mgCRM2/app/Storage is NOT Writable. Unable to continue.' '' please make sure that this folder has writeable permissions set.
+
 
|}
 
|}

Latest revision as of 11:02, 13 September 2018

Contents

[edit] About Hosting Quota Notifications For WHMCS

Hosting Quota Notifications For WHMCS allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage.

Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.
You can also define email templates and view details of each sent notification owing to logs.

  • Admin Area Features:
✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage
✔ Configure Notification Groups
✔ Choose Between Two Types Of Group Counting:
✔ Tiered - Define Tiers Of Usage
✔ Fixed - Define Usage Grow Over Time
✔ Assign Multiple Products To Single Notification Group
✔ Assign Email Templates Per Notification Group
✔ Enable/Disable Notification Groups
✔ View Logs Of Sent Notifications
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7

[edit] Installation

This tutorial will show you how to successfully install and configure Hosting Quota Notifications For WHMCS.

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

[edit] Installation

1. Log in to our client area and download the module.
HQN 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' › 'System' › 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Drfere.png
4. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/hosting_quota_notifications/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

HQN 3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products' .

HQN 4.png

[edit] Configuration of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules' . Afterwards, find 'Hosting Quota Notifications' and press 'Activate' button.

HQN 5.png
7. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near required admin role groups and press 'Save Changes' .

HQN 6.png
8. You have just successfully installed Hosting Quota Notifications For WHMCS!

You can access your module in 'Addons' → 'Hosting Quota Notifications' .

HQN 7.png

[edit] Configuration and Management

In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.

[edit] Configuration

In 'Configuration' page you can find the list of configured notification groups.

You can enable/disable any of them, as well as alter or completely remove them.
Press 'Create New Group' to proceed.

HQN 9.png
Now, you can define all products related to this configuration and email template which will be used to notify your clients.

You can choose between two types of resource usage counting:

  • Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent.
  • Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent.
HQN 10.png
For example, shown below module uses fixed counting type.

As you can see, we have defined limits for both bandwidth and disk.
Settings shown below result in sending notification to client upon:

  • bandwidth usage growth by 5GB during 21 days.
  • disk usage growth by 100GB over period of 14 days.
HQN 11.png

[edit] Logs

Under 'Logs' page you can view information about sent notifications.
HQN 12.png

[edit] Notifications

You can create as many notifications as you wish.

The only requirement is their type being set to 'Product/Service' .
Additionally, you can use {if} statement, as shown below: 

{if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if}
{if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if}

It will allow you to use this email template for bandwidth and disk notifications at the same time.

HQN 13.png

[edit] Tips

[edit] Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=41245"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community