Personal tools
Namespaces

Variants
Actions

Client Area Popup For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation)
(→‎Configuration and Management)
Line 157: Line 157:
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Client Profile Viewer For WHMCS is a module which allows you to quickly display clients' details across the WHMCS.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Client Area Popup For WHMCS is a module which allows you to quickly display clients' details across the WHMCS.<br />
 
Additionally, you can easily configure access to the clients' information depending on the admin role.
 
Additionally, you can easily configure access to the clients' information depending on the admin role.
 
|}
 
|}
 
==Configuration==
 
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can manage tooltip configurations as well as add new ones.<br />
+
|style="padding: 10px 0px 15px 15px;"|.....
−
Each configuration can have multiple admin roles assigned while one admin role can be assigned to a single configuration only.<br />
+
−
As you can see on the following screen, you can view the list of enabled widgets and assigned admin roles of each configuration.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_8.png]]
 
|}
 
|}
−
===Add A Configuration===
+
===Create Pop-up===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To add a new configuration, press '' 'Add New Configuration' '' button.
+
|style="padding: 10px 0px 20px 15px;"|To add a ne
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, fill in '' 'Configuration Name'.''<br />
+
|style="padding: 0px 0px 15px 15px;"|Afterwards,  
−
Add admin roles through choosing each of them from a dropdown menu and pressing '' 'Add'.''<br />
+
−
Additionally, select widgets in the configuration the same way you have added admin roles.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|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;"|
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Press '' 'Create' '' to confirm creation of the configuration.
+
|style="padding: 0px 0px 20px 15px;"|............
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_12.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_12.png]]
 
|}
 
|}
  
Line 206: Line 202:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CAP_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Client Custom Notes'''
+
|style="padding: 0px 0px 30px 15px;"|RESTRICTIONS
−
*'' 'My Notes' '' - shows '' 'My Notes' '' in the main tooltip.
+
*'' '.......My Notes' '' - shows '' 'My Notes' '' in the main tooltip.
−
*'' 'Group Notes' '' - displays notes visible for my admin role in the main tooltip.
+
*'' '.......' '' - 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.<br /><br />
+
*'' '........' '' - if checked, global notes will be visible in the main tooltip.<br /><br />
  
−
*'' 'My Notes Limit' '' - defines limit for notes added to '' 'My Notes' '' group.
+
*'' '..........' '' - defines limit for notes added to '' 'My Notes' '' group.
−
*'' 'Group Notes Limit' '' - defines limit for notes added to '' 'Group Notes' '' group.
+
*'' '.........' '' - defines limit for notes added to '' 'Group Notes' '' group.
−
*'' 'Notes For All Limit' '' - defines limit for notes added to '' 'Notes For All' '' group.<br /><br />
+
*'' '........' '' - defines limit for notes added to '' 'Notes For All' '' group.<br /><br />
  
−
*'' 'My Notes View Limit' '' - defines amount of '' 'My Notes' '' shown in the main widget.
+
*'' '............' '' - defines amount of '' 'My Notes' '' shown in the main widget.
−
*'' 'Group Notes View Limit' '' - defines amount of '' 'Group Notes' '' shown in the main widget.
+
*'' '............' '' - defines amount of '' 'Group Notes' '' shown in the main widget.
−
*'' 'Notes For All View Limit' '' - defines amount of '' 'Notes For All' '' shown in the main widget.<br /><br />
+
*'' '.....' '' - defines amount of '' 'Notes For All' '' shown in the main widget.<br /><br />
  
−
*'' 'Notes View Length Limit' '' - defines length of notes, from each group, shown in the main widget.
+
*'' '.........' '' - defines length of notes, from each group, shown in the main widget.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''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.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Income'''
+
−
*'' 'Range' '' -  enables you to define a time period for invoices taken into consideration.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_14_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Services Amount'''
+
−
*'' 'Product Status' '' - shows product's status
+
−
*'' 'Domain Status' '' - shows domain's status
+
−
*'' 'Product Domain' '' - shows domain of a product<br /><br />
+
−
 
+
−
*'' '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<br /><br />
+
−
 
+
−
*'' 'Domain WWW' '' - shows domain www link
+
−
*'' 'Domain WHOIS' '' - shows domain whois link
+
−
*'' 'Domain IntoDNS' '' - shows domain intoDNS link
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Profile Tabs'''<br/>
+
−
*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
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_4.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Quick Actions'''
+
−
*Select which of the available actions shall be allowed form the client's profile tooltip
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Tickets'''
+
−
*checkboxes - marking a checkbox enables counting that type of tickets as well as shows direct link to the ticket's list of that type. 
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|[http://www.modulesgarden.com/products/whmcs/sms_center/features '''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 [http://www.docs.modulesgarden.com/SMS_Center_For_WHMCS Wiki].''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
+
 
|}
 
|}
  
 
==Settings==
 
==Settings==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Settings' '' page contains global settings for the module such as:<br />
+
|style="padding: 10px 0px 15px 15px;"|'' '...........
−
*'''Hide Tooltip''' - if checked, tooltip automatically disappears when cursor is moved outside of it.<br />
+
−
*'''Show After''' - defines delay time for showing the tooltip.<br />
+
−
*'''Hide After''' - defines delay time for hidding the tooltip when cursor is outside.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_16.png]]
 
|}
 
|}
  
−
==Tooltip==
+
==.....==
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Tooltip will be displayed across the WHMCS admin area, wherever client's name is displayed.<br />
+
−
On the following screen you can see a client tooltip in '' 'Clients' '' → '' 'View/Search Clients' ''. <br />
+
−
As you know, tooltip is made of widgets, let us discuss over each of them.<br />
+
−
''Note: Most of the widget titles are links to specific parts of the WHMCS system.''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_17.png]]
+
−
|}
+
−
 
+
−
===Assigned Admin To Client===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Allows you to assign admin to specific client.<br />
+
−
Admin assigned is visible only from the tooltip.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 25px;"|[[File:CLP_18.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 0px;"|Once an admin is assigned they can automatically assign new tickets to the client and then stop assigning them.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 25px;"|[[File:CLP_18_1.png]]
+
−
|}
+
−
 
+
−
===Client Custom Status===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Enables you to assign custom status and color to a client.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19.png]]
+
−
|}
+
−
 
+
−
===Profile Tabs===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.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]]
+
−
|}
+
−
 
+
−
===Client Notes - Admin Notes, Notes And Custom Notes===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|The screen presents three different widgets in fact, each of them displays notes from a different part of the system.<br />
+
−
*Client Admin Notes - manages notes from the client's profile → '' 'Sumary' '', 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 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.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
+
−
|}
+
−
 
+
−
===Income===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|'' 'Income' '' widget displays the summary value of paid invoices as well as those still waiting for payment.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
+
−
|}
+
−
===Log In As Client===
+
−
{|
+
−
|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_22.png]]
+
−
|}
+
−
 
+
−
===Services===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Here you can find client's products, product addons and domains counted by their status.<br />
+
−
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]]
+
−
|}
+
−
 
+
−
===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]]
+
−
|}
+
−
===Send SMS===
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'' 'Send SMS' '' widget allows quick sending text messages. This functionality is available only if SMS Center For WHMCS is activated!
+
|style="padding: 10px 0px 15px 15px;"|.................
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CAP_17.png]]
 
|}
 
|}
  

Revision as of 11:17, 1 July 2016


Contents

About Client Area Popup For WHMCS

Client Area Popup For WHMCS is a module
  • Addon Module Features:
✔
✔
✔
✔
✔
✔
✔
  • Widgets:
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
  • Widgets Configuration:
✔
✔
✔
✔
✔
✔
✔
✔
✔
✔
  • General Info:
✔ Multi-Language Support
✔ Supports WHMCS V5 and V6

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 your client area and download Client Profile Viewer For WHMCS.
CAP 1.png
2. Upload and extract the module into the main WHMCS directory.

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

CAP 2.png
3. When you install Client Profile Viewer 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' .

CAP 3.png
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' .

CAP 4.png
5. 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 'Client Profile Viewer' and press 'Activate' button.

CAP 5.png
6. 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' .

CAP 6.png
7. You have just successfully installed Client Profile Viewer For WHMCS!

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

CAP 7.png

Configuration and Management

Client Area Popup 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.

Configuration

.....
CAP 8.png

Create Pop-up

To add a ne
CAP 9.png
Afterwards,
CAP 10.png
CAP 11.png
............
CAP 12.png

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 amount of letters of a note shown in the main tooltip. All notes are available after pressing '+' button.
CAP 13.png
RESTRICTIONS
  • '.......My Notes' - shows 'My Notes' in the main tooltip.
  • '.......' - displays notes visible for my admin role in the main tooltip.
  • '........' - if checked, global notes will be visible in the main tooltip.

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

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

  • '.........' - defines length of notes, from each group, shown in the main widget.

Settings

'...........
CAP 16.png

.....

.................
CAP 17.png

Tips

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_Area_Popup_For_WHMCS&oldid=25889"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Client Area Popup For WHMCS