Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
Revision as of 11:36, 8 June 2017 by Anita (Talk | contribs)

Jump to: navigation, search


Contents

About Client Profile Viewer For WHMCS

Client Profile Viewer For WHMCS is a module which was 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 The Widgets With Details Of Clients In A Tooltip On Mouseover
✔ Drag & Drop Configuration Of Each Widget Displayed In The Tooltip
✔ Access Various Parts Of System On Click
✔ Configure Admin Roles Assigned To Each Configuration
✔ Define The Manner In Which The Tooltip Disappears
✔ Define The Delay For Showing The Tooltip
✔ Automatically Flag Client Tickets To Assigned Admin
  • Widgets:
✔ Income
✔ Tickets
✔ Services Amount
✔ Client Admin Notes
✔ Client Notes
✔ Client Custom Notes
✔ Client Custom Status
✔ Quick Actions
✔ Profile Tabs
✔ Person Assigned
✔ Log In As Client
✔ Send SMS - Integrated With SMS Center For WHMCS (read more)
  • Widgets Configuration:
✔ Income:
✔ Define The Range Of Income Statistic
✔ Tickets:
✔ Define Which Statuses Of Tickets Are Counted
✔ Services Amount:
✔ Define If Product/Domain Status Is Shown
✔ Define Which Additional Links Are Shown
✔ Client Admin Notes:
✔ Define How Much Of A Note Should Be Shown In The Main Tooltip
✔ Client Custom Notes:
✔ Enable/Disable Notes For All, Group Notes And My Notes
✔ Define The Length Of Notes Displayed In The Main Tooltip
✔ Define The Limits Of Notes Displayed In The Main Tooltip Per Group
✔ Define The Limits Of Notes Per Group
✔ Client Custom Status:
✔ Define Whether To Show Client Status Before Their Name
✔ Define Whether To Color Client Name
✔ Quick Actions:
✔ Define Visible Options
✔ Profile Tabs:
✔ Define Visible Options
✔ Define Amount Of Columns To Display Tabs
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS V6 and V7

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.
CLP 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.

CLP 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' .

CLP 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' .

CLP 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.

CLP 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' .

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

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

CLP 7.png

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.

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

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.
CLP 11.png
Press 'Create' to confirm creation of the configuration.
CLP 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.
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 amount of 'My Notes' shown in the main widget.
  • 'Group Notes View Limit' - 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.

  • '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
  • '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
  • 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
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

Settings

'Settings' page contains global settings for the module such as:
  • Hide Tooltip - if checked, tooltip automatically disappears when 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 cursor is outside.
CLP 16.png

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

Assigned Admin To Client

Allows you to assign admin to specific client.

Admin assigned 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

Client Custom Status

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

Profile Tabs

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

Quick Actions

Move directly form clients profile tooltip to a chosen action section.
CLP 19 2.png

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 → '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.

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

Income

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

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

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

Tickets

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

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

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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community