CRM For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
|
|
| Line 345: |
Line 345: |
| | |style="padding: 0px 0px 20px 25px;"|[[File:CRM_15.png]] | | |style="padding: 0px 0px 20px 25px;"|[[File:CRM_15.png]] |
| | |} | | |} |
| | + | ====Notes==== |
| | + | {| |
| | + | |style="padding: 10px 0px 20px 15px;"| |
| | + | |} |
| | + | {| |
| | + | |style="padding: 0px 0px 20px 25px;"|[[File:CRM_15.png]] |
| | + | |} |
| | + | |
| | ====Quotes==== | | ====Quotes==== |
| | {| | | {| |
Revision as of 13:18, 25 November 2014
| CRM For WHMCS is a module
|
| ✔ Supports WHMCS V5 and Later
|
Installation
This tutorial will show you how to successfully install and configure CRM For WHMCS.
We will guide you step by step through the whole installation and configuration process.
|
Installation
| 1. Log in to your client area and download CRM For WHMCS.
|
2. Upload and extract the module into the main WHMCS directory.
Files in your WHMCS directory should look like on the following screen.
|
3. When you install CRM for the first time you have to rename 'license_RENAME.php' file.
File is located in 'modules/addons/mgCRM/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
|
4. In order to configure your license key, you have to edit the 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 your client area → 'My Products' .
|
5. Additionally, set up 'uploads' folder as writable.
Folder is located in 'your_whmcs/modules/addons/mgCRM/' .
|
Activate The 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 'CRM' and press 'Activate' button.
|
7. In the next step you need to permit access to this module.
To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes' .
|
Basic Configuration
8. Now, you have to set up cron job. Cron job can be found at CRM addon → 'Settings' → 'Cron'.
We advice to set up the cron as often as you wish to send email notifications.
Recommended interval is each 5 minutes.
|
9. You have just successfully installed CRM For WHMCS!
You can access your module at 'Addons' → 'CRM' .
|
Configuration and Management
| CRM For WHMCS is a module which allows you to quickly display clients' details across the WHMCS.
Additionally, you can easily configure access to the clients' information depending on the admin role.
|
Settings
Due to wide variety of possible configurations, we starts the 'Management' section with 'Settings' sub-section to explain them to you.
In 'Settings' page of the module you can check current module status, enable major features and define follow-ups settings.
|
Under Module Status you can find current status of:
- Integration with Asterisk VoIP Center For WHMCS
- Cron job setup
- Amount of CRM email templates
- Chmod of storage folder used by the module
General Settings enables you to decide whether to enable potentials, quotations and admin assignment across the CRM.
|
Follow-ups Settings allows you to define follow-up types (used to sort follow-up in the Lead/Potential page) and email templates used for admin notifications.
You can set up admin notification email templates upon creation of a new follow-up, edition of a follow-up and sending follow-up to the client.
'Note: You can define which notifications should be send upon a creation of a follow-up.
|
API
Our module allows you to connect with it and command various operation through API.
All available commands are listed in the 'API' page which can be accessed in 'Settings' → 'API'.
|
Cron
| In 'Cron' page you can find all the information about the cron such as its path, last run date and interval between cron runs.
|
Custom Fields
'Custom Fields' enables you to define custom fields for Lead and Potential, and define whether they are required or not.
Additionally, you can manage existing fields and change their order through using buttons in the 'Actions' column.
To add a new field, press 'Add New Field' .
|
Each field regardless of its type has its name, description, visibility in Lead and Potentials details, and obviously its type.
Additionally, depending on the chosen type there are additional options available:
- text - 'Required For Lead' , 'Required For Potentials' , 'Validation Regex' and 'Validation Error'.
- textarea - 'Required For Lead' , 'Required For Potentials' , 'Validation Regex' and 'Validation Error'.
- dropdown - 'Field Options' .
- checkbox - this field type has no additional options.
|
Field Views
'Field Views' allows you to define default order and visibility of fields in the main pages of Leads and Potentials.
To change order, drag & drop field to desired position.
To show/hide the field, mark/unmark checkbox next to it.
Press 'Save' to store the settings.
|
Email Templates
Here you can view list of a previously created templates and edit each of them.
Additionally, you are able to create a new CRM email template, which afterwards can be used for follow-ups.
To start creation of a new template, fill in its name and press 'Create Email Template' .
|
As you can see, you was moved to a default WHMCS email templates creation form.
Save the template when you complete it.
|
CRM email templates can be also viewed, edited and removed as any other custom email template
Simply, proceed to 'Setup' → 'Email Templates' , they are stored under 'CRM Messages' section.
|
Impor/Export
Our module enables you to export and import your Leads and Potentials.
This way you can migrate them between two WHMCS systems and made a backup of your Leads, Potential and contacts stored in archive.
Under 'Available Fields' section you can find parameters used by imported/exported files, they depend on fields added in your CRM instance.
|
| In order to export contacts, press 'Download As CSV' under 'Export' section.
|
'Import' section contains last uploaded import file as well as possibility to upload a new one.
Imported file will not affect contacts for as long as you press 'Import' . Contact from the imported file will be added to your Leads and Potentials.
|
Dashboard
In 'Dashboard' you can see overall information such as scheduled follow-ups, latest Leads and Potentials and graphs concerning Leads and Potentials.
Among the graphs, can be distinguished graphs such as amount of Leads and Potentials per status, new contacts per admin, per month and per day.
|
| From the 'Dashboard' you can quickly reschedule any follow-up or even remove them completely.
|
Additionally, for graphs of new contacts per year and per month you can view different time periods.
To do so, simply choose desired time period and press refresh button as shown below.
|
Leads/Potentials
Your contacts can be stored in the Leads, or divided between Leads and Potentials.
Both pages contains the same features, Potentials can be enabled/disabled in the module settings and was introduced to allow separation of more important contacts.
The only diference between them is fact, that you can create new contacts only in the lead page.
As you can see on the following screen, here you can find the list of your contacts.
|
The list of contact is fully modifiable, to show/hide columns, simply press 'Change columns' and mark/unmark checkbox next to desired column.
To restore default settings, press 'Revert to original visibility' .
|
Additionally, you can change column sequence, simply drag & drop column to desired location.
Default settings can be restored by pressing 'Revert to original visibility' in 'Change columns' dropdown menu.
|
To make your life easier, we have also implemented search filters, press 'Show Filters' to display them.
Next, fill in the details of a contact, displayed clients will be updated in the process.
|
Create Contact
| To add a new contact, press 'Create Lead' as shown on the following screen.
|
As you can see, fields are divided into two sections depending on whether they are required or optional.
Additionally, any custom field visible for lead will be displayed here.
Fill out the form and press 'Add Lead' to add the contact to list.
|
Manage Contacts
In 'Actions' column you can find various useful operation which can be performed on a contact.
As you can see, in 'Other' dropdown menu actions such as 'Convert To Potential' , 'Call Out' and 'Remove' can be found.
'Note: 'Call Out' functionality requires you to have VoIP Center For WHMCS installed and configured properly.
|
Now, let's proceed to the contact itself.
Press 'Details' to continue.
|
Base Details
| In the area marked on the following screen, you can find contact name, status, ticket from which he was created and base details of a contact.
|
| Contact's name and status can be changed by pressing pencil icon next to each of them, altering the name/status and pressing 'Update Name' / 'Update Status' button.
|
If option is enabled in the module settings, admin can be assigned to a contact.
Press 'Assign' , choose admin from a dropdown menu and press 'Save' to do so.
|
To edit fields in the 'Main Details' press 'Edit' as shown below.
After you make wanted changes, press 'Save' .
|
| Module also allows assignment of a client account to the contact.<r />
This can be done in two ways, by creating a new client from a contact or by assigning existing client to a contact.
|
Follow-ups
Notes
Quotes
Files
Logs
Tips
Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
|
