Personal tools
Namespaces

Variants
Actions

Client Profile Viewer For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Upgrade Guide)
 
(36 intermediate revisions by 3 users not shown)
Line 27: Line 27:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Define Delay Time To Show Tooltip
 
|style="padding: 0px 0px 0px 30px;"|✔ Define Delay Time To Show Tooltip
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Select Number Of Columns To Display Widgets
 
|}
 
|}
 
{|
 
{|
Line 33: Line 36:
 
*'''Widgets:'''
 
*'''Widgets:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Income
+
|style="padding: 10px 0px 0px 30px;"|✔ Client Admin Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Quotes
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Tickets
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount
+
|style="padding: 0px 0px 0px 30px;"|✔ Credit Card Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes
+
|style="padding: 0px 0px 0px 30px;"|✔ Income
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes
+
|style="padding: 0px 0px 0px 30px;"|✔ Invoices
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes
+
|style="padding: 0px 0px 0px 30px;"|✔ List Of Users
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status
+
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions
+
|style="padding: 0px 0px 0px 30px;"|✔ Multibrand - Integrated With [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand For WHMCS]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs
+
 
|}
 
|}
 
{|
 
{|
Line 69: Line 69:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client
+
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Send SMS - Integrated With SMS Center For WHMCS [https://www.modulesgarden.com/products/whmcs/sms-center (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Multibrand - Integrated With Multibrand For WHMCS [https://www.modulesgarden.com/products/whmcs/multibrand (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Quotes
 
|}
 
|}
−
*'''Widgets Configuration:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Income:
+
|style="padding: 0px 0px 0px 30px;"|✔ Recent Emails
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Range Of Income Statistic
+
|style="padding: 0px 0px 0px 30px;"|✔ Send Email
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Tickets:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Tickets To Count And Display
+
|style="padding: 0px 0px 0px 30px;"|✔ Send SMS - Integrated With [https://www.modulesgarden.com/products/whmcs/sms-center SMS Center For WHMCS]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define If Product/Domain Status Is Shown
+
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Links To Show
+
|style="padding: 0px 0px 10px 30px;"|✔ Tickets
 
|}
 
|}
 +
 +
*'''Widgets Configuration:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes:
+
|style="padding: 10px 0px 0px 30px;"|✔ Client Admin Notes:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Note Length In Tooltip
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Note Length In Tooltip
 
|}
 
|}
 
{|
 
{|
Line 118: Line 113:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Per Group
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Limit Of Notes Per Group
 
|}
 
|}
 
{|
 
{|
Line 130: Line 125:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions:
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Limit Of Notes Displayed In Tooltip
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Notes Length Displayed In Tooltip
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Income:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Select Range Of Income Statistic
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Invoices:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Lines
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Invoices To Count And Display
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Open In New Tab
 
|}
 
|}
 
{|
 
{|
Line 143: Line 165:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Invoices:
+
|style="padding: 0px 0px 0px 45px;"|✔ Define If Product/Domain Status Is Shown
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Invoices To Count And Display
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Links To Show
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Lines
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Tickets:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Tickets To Count And Display
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Quotes:
 
|style="padding: 0px 0px 0px 30px;"|✔ Quotes:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Lines
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 
|}
 
|}
 
{|
 
{|
Line 161: Line 210:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.2 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.7 Back To WHMCS V8.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/client-profile-viewer#open-source-version Open Source Version]
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/client-profile-viewer#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Client Profile Viewer For WHMCS.''' <br/>
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/client-profile-viewer Client Profile Viewer 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.  
 
|}
 
|}
Line 182: Line 234:
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
 +
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
+
|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/client-profile-viewer#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''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.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
−
The content of PHP version files should look like this.  
+
The content of the package to upload should look like this.  
 
|}
 
|}
 
{|
 
{|
Line 197: Line 260:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Client Profile Viewer 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 Client Profile Viewer For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br/>
−
File is located in '' 'modules/addons/clientsprofiler/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
+
File is located in '' 'modules/addons/clientsprofiler/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
Line 211: Line 274:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br/>
 
|style="padding: 0px 0px 15px 15px;"|'''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 '' 'Client Profile Viewer' '' and press '' 'Activate' '' button.
+
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Client Profile Viewer' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
Line 218: Line 281:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br />
−
To do so, click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes' ''.
+
To do so, click on '' 'Configure' '' button, define the access control and grant permissions to manage the module to desired admin roles. Press '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
Line 261: Line 324:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you wish to change the order in which widgets are displayed, simply drag widget to a desired location and drop it.  
+
|style="padding: 0px 0px 20px 15px;"|If you wish to change the order in which widgets are displayed, simply drag widget to a desired location and drop it, do not forget to save the changes in the end.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_11.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create' '' to confirm creation of the configuration.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_12.png]]
+
 
|}
 
|}
  
Line 320: Line 377:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Services Amount'''
 
|style="padding: 0px 0px 15px 15px;"|'''Services Amount'''
 +
Define a number of lines you want to be displayed on the widget.
 
*'' 'Product Status' '' - shows product's status
 
*'' 'Product Status' '' - shows product's status
 
*'' 'Domain Status' '' - shows domain's status
 
*'' 'Domain Status' '' - shows domain's status
Line 354: Line 412:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Tickets'''
 
|style="padding: 0px 0px 15px 15px;"|'''Tickets'''
 +
*Columns:
 +
*:Declare the number of columns to view the chosen tabs
 
*checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type.   
 
*checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type.   
 
|}
 
|}
Line 361: Line 421:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Quotes'''
 
|style="padding: 0px 0px 15px 15px;"|'''Quotes'''
 +
*Define:
 +
*:the number of columns to view the chosen tabs
 +
*:the number of visible lines
 
*Select required statuses of quotes, only quotes with pointed here statuses will appear in the final widget.
 
*Select required statuses of quotes, only quotes with pointed here statuses will appear in the final widget.
 
|}
 
|}
Line 368: Line 431:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Invoices'''
 
|style="padding: 0px 0px 15px 15px;"|'''Invoices'''
−
**checkboxes - marking a checkbox enables counting selected types of inoice.
+
*Define:
 +
*:the number of columns to view the chosen tabs
 +
*:the number of visible lines
 +
**checkboxes - marking a checkbox enables counting selected types of invoice.
 
|}
 
|}
 
{|
 
{|
Line 381: Line 447:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|[https://www.modulesgarden.com/products/whmcs/multibrand '''Multibrand (Sold Separately)''']
 +
*'' 'Multibrand' '' - allows direct logging into a brand the client is assigned to.
 +
*:''Please note that this widget works properly only with Multibrand For WHMCS module purchased, activated and correctly configured!''
 +
*:''For more information on Multibrand For WHMCS, visit its [https://www.docs.modulesgarden.com/Multibrand_For_WHMCS Wiki].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_14_6.png]]
 
|}
 
|}
  
Line 386: Line 461:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' '' page contains global settings for the module such as:<br/>
 
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' '' page contains global settings for the module such as:<br/>
−
*'''Hide Tooltip''' - if checked, tooltip automatically disappears when cursor is moved outside of it.<br/>
+
*'''Hide Tooltip''' - if checked, tooltip automatically disappears when the cursor is moved outside of it.<br/>
 
*'''Show After''' - defines delay time for showing the tooltip.<br/>
 
*'''Show After''' - defines delay time for showing the tooltip.<br/>
−
*'''Hide After''' - defines delay time for hiding the tooltip when cursor is outside.
+
*'''Hide After''' - defines delay time for hiding the tooltip when the cursor is outside.
 +
*'''Number Of Columns''' - decide whether the widgets will be displayed in a single column view or will it be divided into two or three-column view.
 
|}
 
|}
 
{|
 
{|
Line 427: Line 503:
 
|}
 
|}
  
−
===Profile Tabs===
+
===Log In As Client===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
+
|style="padding: 10px 0px 15px 15px;"|This widget allows you to quickly log in as a client.<br/>
 +
Press '' 'Log In As Client' '' to do so.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_22.png]]
−
|}
+
−
 
+
−
===Quick Actions===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Move directly form clients profile tooltip to a chosen action section.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_2.png]]
+
 
|}
 
|}
  
Line 448: Line 517:
 
*Client Admin Notes - manages notes from the client's profile → '' 'Summary' '', additionally it allows you to define a maximum number of letters displayed in the tooltip.
 
*Client Admin Notes - manages notes from the client's profile → '' 'Summary' '', additionally it allows you to define a maximum number of letters displayed in the tooltip.
 
*Client Notes - manages notes from the client profile → '' 'Notes'.''
 
*Client Notes - manages notes from the client profile → '' 'Notes'.''
−
*Client Custom Notes - enables you to add notes visible in the tooltip only for you, your admin role or all admins.<br/>
+
*Client Custom Notes - enables you to add and edit notes visible in the tooltip only for you, your admin role or all admins.<br/>
 
Additionally, as you can see on the following screen, you can see the number of notes added and a maximum number of notes you can add.
 
Additionally, as you can see on the following screen, you can see the number of notes added and a maximum number of notes you can add.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
 +
|}
 +
 +
===Credit Card Information===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'' 'Credit Card Information' '' widget displays you all credit cards assigned to a particular client.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20_1.png]]
 
|}
 
|}
  
Line 462: Line 539:
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
 
|}
 
|}
−
===Log In As Client===
+
 
 +
===Invoices===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This widget allows you to quickly log in as a client.<br/>
+
|style="padding: 10px 0px 20px 15px;"|'' 'Invoices' '' widget displays the client's invoices selected by status and provides a direct link to them.
−
Press '' 'Log In As Client' '' to do so.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_1.png]]
 
|}
 
|}
  
−
===Services===
+
===List Of Users===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Here you can find client's products, product addons and domains counted by their status.<br/>
+
|style="padding: 10px 0px 20px 15px;"|This widget includes a list of all users, with their email addresses, associated with the client's account.
−
Additionally, you can view all the items in the tooltip along with various links as shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_0.png]]
 
|}
 
|}
  
−
===Tickets===
+
===Multibrand===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'' 'Tickets' '' widget counts your client's tickets by status and provides a direct link to them.
+
|style="padding: 10px 0px 20px 15px;"|Client Profile Viewer is integrated with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand for WHMCS] module. <br/>'' 'Multibrand' '' widget appears only if the module is active and the widget appropriately configured in the addon.<br/>
 +
As you can see on the screen below, you may log in to the client's brands directly from the tooltip.<br/> Please note that the '' 'Log In As Client' '' button is not visible when this feature is on.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_0.png]]
 
|}
 
|}
−
===Invoices===
+
 
 +
===Profile Tabs===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'' 'Invoices' '' widget displays the client's invoices selected by status and provides a direct link to them.
+
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.png]]
 
|}
 
|}
 +
 +
===Quick Actions===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|Move directly from client's profile tooltip to a chosen action section.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_2.png]]
 +
|}
 +
 
===Quotes===
 
===Quotes===
 
{|
 
{|
Line 500: Line 587:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24_1.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24_1.png]]
 +
|}
 +
 +
===Recent Emails===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|In '' 'Recent Email' '' widget you will find a list of the last 7 email messages delivered the client. The list includes the date and the title of the message.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_28_1.png]]
 +
|}
 +
 +
===Send Email===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|'' 'Send Email' '' widget grants you the possibility to send emails effortlessly.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_28.png]]
 
|}
 
|}
  
Line 509: Line 612:
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
 
|}
 
|}
−
===Multibrand===
+
 
 +
===Services===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Client Profile Viewer is integrated with [https://www.modulesgarden.com/products/whmcs/multibrand Multibrand for WHMCS] module. <br/>'' 'Multibrand' '' widget appears only if the module is active and the widget appropriately configured in the addon.<br/>
+
|style="padding: 10px 0px 15px 15px;"|Here you can find client's products, product addons and domains counted by their status.<br/>
−
As you can see on the screen below, you may log in to the client's brands directly from the tooltip.<br/> Please note that the '' 'Log In As Client' '' button is not visible when this feature is on.  
+
Additionally, you can view all the items in the tooltip along with various links as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_0.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_23.png]]
 +
|}
 +
 
 +
===Tickets===
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|'' 'Tickets' '' widget counts your client's tickets by status and provides a direct link to them.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24.png]]
 
|}
 
|}
  
Line 526: Line 638:
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|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/>
+
|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/>
−
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/>
+
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
−
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/>
+
 
|}
 
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/client-profile-viewer#open-source-version Open Source version] of your Client Profile Viewer For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 +
|}
 +
 
=Common Problems=
 
=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.'''
 
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 12:50, 19 April 2024

Contents

[edit] About Client Profile Viewer For WHMCS

Client Profile Viewer For WHMCS is a module which has been created to gather all the key information about each of your clients in one simple tooltip.

Contact details, purchased products and services, income – all of these and many more organized in convenient widgets will be displayed each time you hover over a client's name.
The module enables you to not only conveniently preview the information about each customer but also modify it according to your needs.

  • Addon Module Features:
✔ View Widgets With Client Details In Tooltip On Mouseover
✔ Drag & Drop Configuration Of Each Widget To Change Order
✔ Access Various Parts Of System On Click
✔ Configure Admin Roles Assigned To Each Configuration
✔ Configure Hide Tooltip Option
✔ Define Delay Time To Show Tooltip
✔ Select Number Of Columns To Display Widgets
✔ Automatically Flag Client Tickets To Assigned Admin
  • Widgets:
✔ Client Admin Notes
✔ Client Custom Notes
✔ Client Custom Status
✔ Client Notes
✔ Credit Card Information
✔ Income
✔ Invoices
✔ List Of Users
✔ Log In As Client
✔ Multibrand - Integrated With Multibrand For WHMCS
✔ Person Assigned
✔ Profile Tabs
✔ Quick Actions
✔ Quotes
✔ Recent Emails
✔ Send Email
✔ Send SMS - Integrated With SMS Center For WHMCS
✔ Services Amount
✔ Tickets
  • Widgets Configuration:
✔ Client Admin Notes:
✔ Define Visible Note Length In Tooltip
✔ Client Custom Notes:
✔ Enable/Disable Notes For All, Group Notes And My Notes
✔ Define Notes Length Displayed In Tooltip
✔ Define Limits Of Notes Displayed In Tooltip Per Group
✔ Define Limit Of Notes Per Group
✔ Client Custom Status:
✔ Define Whether To Show Client Status Before Their Name
✔ Define Whether To Color Client Name
✔ Client Notes:
✔ Define Limit Of Notes Displayed In Tooltip
✔ Define Notes Length Displayed In Tooltip
✔ Income:
✔ Select Range Of Income Statistic
✔ Invoices:
✔ Define Number Of Lines
✔ Define Number Of Columns To Display Tabs
✔ Select Statuses Of Invoices To Count And Display
✔ Log In As Client:
✔ Define Whether To Open In New Tab
✔ Profile Tabs:
✔ Define Visible Options
✔ Define Number Of Columns To Display Tabs
✔ Services Amount:
✔ Define If Product/Domain Status Is Shown
✔ Define Additional Links To Show
✔ Define Number Of Lines
✔ Tickets:
✔ Select Statuses Of Tickets To Count And Display
✔ Define Number Of Columns To Display Tabs
✔ Quick Actions:
✔ Define Visible Options
✔ Quotes:
✔ Define Number Of Lines
✔ Define Number Of Columns To Display Tabs
✔ Select Stages Of Invoices To Count And Display
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS V8.7 Back To WHMCS V8.4
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation

This tutorial will show you how to successfully install and configure Client Profile Viewer For WHMCS.

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

1. Log in to our client area and download the module.
CLP 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 74.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

CLP2 2.png
4. When you install Client Profile Viewer For WHMCS for the first time you have to rename 'license_RENAME.php' file.

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

CLP 3.png
5. 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 our client area → 'My Products' .

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

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules' . Afterwards, find 'Client Profile Viewer' and press 'Activate' button.

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

To do so, click on 'Configure' button, define the access control and grant permissions to manage the module to desired admin roles. Press 'Save Changes'.

CLP 6.png
8. You have just successfully installed Client Profile Viewer For WHMCS!

You can access your module under 'Addons' → 'Client Profile Viewer' .

CLP 7.png

[edit] Configuration and Management

Client Profile Viewer 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.

[edit] Configuration

In 'Configuration' page you can manage tooltip configurations as well as add new ones.

Each configuration can have multiple admin roles assigned while one admin role can be assigned to a single configuration only.
As you can see on the following screen, you can view the list of enabled widgets and assigned admin roles of each configuration.

CLP 8.png

[edit] Add Configuration

To add a new configuration, press 'Add New Configuration' button.
CLP 9.png
Afterwards, fill in 'Configuration Name'.

Add admin roles through choosing each of them from a dropdown menu and pressing 'Add'.
Additionally, select widgets in the configuration the same way you have added admin roles.

CLP 10.png
If you wish to change the order in which widgets are displayed, simply drag widget to a desired location and drop it, do not forget to save the changes in the end.
CLP 11.png

[edit] Advanced Configuration

Some of the widgets may have additional configuration, more information about them can be found in this subsection.
Client Admin Notes
  • 'First Letters' - defines the number of letters of a note shown in the main tooltip. All notes are available after pressing '+' button.
CLP 13.png
Client Custom Notes
  • 'My Notes' - shows 'My Notes' in the main tooltip.
  • 'Group Notes' - displays notes visible for my admin role in the main tooltip.
  • 'Notes For All' - if checked, global notes will be visible in the main tooltip.

  • 'My Notes Limit' - defines limit for notes added to 'My Notes' group.
  • 'Group Notes Limit' - defines limit for notes added to 'Group Notes' group.
  • 'Notes For All Limit' - defines limit for notes added to 'Notes For All' group.

  • 'My Notes View Limit' - defines number of 'My Notes' shown in the main widget.
  • 'Group Notes View Limit' - defines number of 'Group Notes' shown in the main widget.
  • 'Notes For All View Limit' - defines number of 'Notes For All' shown in the main widget.

  • 'Notes View Length Limit' - defines length of notes, from each group, shown in the main widget.
CLP 13 1.png
Client Custom Status
  • 'Inline' - if checked, status is displayed before client's name.
  • 'Color' - if checked, client's first and last name are displayed using selected status color.
CLP 14.png
Income
  • 'Range' - enables you to define a time period for invoices taken into consideration.
CLP 14 1.png
Services Amount

Define a number of lines you want to be displayed on the widget.

  • 'Product Status' - shows product's status
  • 'Domain Status' - shows domain's status
  • 'Product Domain' - shows domain of a product

  • 'Product Domain WWW' - shows product's domain www link
  • 'Product WHOIS' - shows product's domain whois link
  • 'Product IntoDNS' - shows product's domain intoDNS link

  • 'Domain WWW' - shows domain www link
  • 'Domain WHOIS' - shows domain whois link
  • 'Domain IntoDNS' - shows domain intoDNS link
CLP 14 3.png
Profile Tabs
  • Tabs Map:
    Select tabs that will be allowed to redirect to from the Client's profile tooltip
  • Columns:
    Declare the number of columns to view the chosen tabs
CLP 14 4.png
Quick Actions
  • Select which of the available actions shall be allowed form the client's profile tooltip
CLP 14 5.png
Tickets
  • Columns:
    Declare the number of columns to view the chosen tabs
  • checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type.
CLP 14 2.png
Quotes
  • Define:
    the number of columns to view the chosen tabs
    the number of visible lines
  • Select required statuses of quotes, only quotes with pointed here statuses will appear in the final widget.
CLP 25 1.png
Invoices
  • Define:
    the number of columns to view the chosen tabs
    the number of visible lines
    • checkboxes - marking a checkbox enables counting selected types of invoice.
CLP 25 2.png
Send SMS (Sold Separately)
  • 'Send SMS' - allows sending text messages to clients, type in the text in a box on pressing the '+' button.
    Please note that this widget works properly only with SMS Center For WHMCS module purchased, activated and correctly configured!
    For more information on SMS Center For WHMCS, visit its Wiki.
CLP 25.png
Multibrand (Sold Separately)
  • 'Multibrand' - allows direct logging into a brand the client is assigned to.
    Please note that this widget works properly only with Multibrand For WHMCS module purchased, activated and correctly configured!
    For more information on Multibrand For WHMCS, visit its Wiki.
CLP 14 6.png

[edit] Settings

'Settings' page contains global settings for the module such as:
  • Hide Tooltip - if checked, tooltip automatically disappears when the cursor is moved outside of it.
  • Show After - defines delay time for showing the tooltip.
  • Hide After - defines delay time for hiding the tooltip when the cursor is outside.
  • Number Of Columns - decide whether the widgets will be displayed in a single column view or will it be divided into two or three-column view.
CLP 16.png

[edit] Tooltip

Tooltip will be displayed across the WHMCS admin area, wherever client's name is displayed.

On the following screen you can see a client tooltip in 'Clients' → 'View/Search Clients' .
As you know, tooltip is made of widgets, let us discuss over each of them.
Note: Most of the widget titles are links to specific parts of the WHMCS system.

CLP 17.png

[edit] Assigned Admin To Client

Allows you to assign admin to a specific client. The assigned admin is visible only from the tooltip.
CLP 18.png
Once an admin is assigned they can automatically assign new tickets to the client and then stop assigning them.
CLP 18 1.png

[edit] Client Custom Status

Enables you to assign custom status and color to a client.
CLP 19.png

[edit] Log In As Client

This widget allows you to quickly log in as a client.

Press 'Log In As Client' to do so.

CLP 22.png

[edit] Client Notes - Admin Notes, Notes And Custom Notes

The screen presents three different widgets in fact, each of them displays notes from a different part of the system.
  • Client Admin Notes - manages notes from the client's profile → 'Summary' , additionally it allows you to define a maximum number of letters displayed in the tooltip.
  • Client Notes - manages notes from the client profile → 'Notes'.
  • Client Custom Notes - enables you to add and edit notes visible in the tooltip only for you, your admin role or all admins.

Additionally, as you can see on the following screen, you can see the number of notes added and a maximum number of notes you can add.

CLP 20.png

[edit] Credit Card Information

'Credit Card Information' widget displays you all credit cards assigned to a particular client.
CLP 20 1.png

[edit] Income

'Income' widget displays the summary value of paid invoices as well as those still waiting for payment.
CLP 21.png

[edit] Invoices

'Invoices' widget displays the client's invoices selected by status and provides a direct link to them.
CLP 26 1.png

[edit] List Of Users

This widget includes a list of all users, with their email addresses, associated with the client's account.
CLP 19 0.png

[edit] Multibrand

Client Profile Viewer is integrated with Multibrand for WHMCS module.
'Multibrand' widget appears only if the module is active and the widget appropriately configured in the addon.

As you can see on the screen below, you may log in to the client's brands directly from the tooltip.
Please note that the 'Log In As Client' button is not visible when this feature is on.

CLP 26 0.png

[edit] Profile Tabs

Quick redirection to tabs in client's profile.
CLP 19 1.png

[edit] Quick Actions

Move directly from client's profile tooltip to a chosen action section.
CLP 19 2.png

[edit] Quotes

'Quotes' widget shows the client's quotes divided into groups by status and includes a direct link to them.
CLP 24 1.png

[edit] Recent Emails

In 'Recent Email' widget you will find a list of the last 7 email messages delivered the client. The list includes the date and the title of the message.
CLP 28 1.png

[edit] Send Email

'Send Email' widget grants you the possibility to send emails effortlessly.
CLP 28.png

[edit] Send SMS

'Send SMS' widget allows quick sending text messages. This functionality is available only if SMS Center For WHMCS is activated!
CLP 26.png

[edit] Services

Here you can find client's products, product addons and domains counted by their status.

Additionally, you can view all the items in the tooltip along with various links as shown on the screen below.

CLP 23.png

[edit] Tickets

'Tickets' widget counts your client's tickets by status and provides a direct link to them.
CLP 24.png

[edit] Tips

1. If you wish some specific information like income to be visible at the top of the tooltip, simply change its position in the configuration.

Drag and drop the desired widget box in a required position.

[edit] Update Instructions

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

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Client Profile Viewer For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[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=Client_Profile_Viewer_For_WHMCS&oldid=66358"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Client Profile Viewer For WHMCS