Personal tools
Namespaces

Variants
Actions

Cloud Billing For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
−
<meta name="keywords" content="aws billing for whmcs, cloud billing for whmcs, azure billing for whmcs, google cloud billing for whmcs, microsoft csp billing for whmcs, amazon web services whmcs, amazon web services billing whmcs, amazon aws whmcs, amazon aws billing whmcs, cloud billing configuration, whmcs cloud billing management, whmcs cloud billing installation, whmcs cloud billing common problems, about whmcs cloud billing, whmcs cloud billing documentation, whmcs cloud billing faq, whmcs cloud billing help, whmcs cloud billing guide, whmcs cloud billing wiki, whmcs cloud billing tutorial, whmcs cloud billing tips"></meta>
+
<meta name="keywords" content="client profile viewer for whmcs, client profile viewer configuration, whmcs client profile viewer management, whmcs client profile viewer installation, whmcs client profile viewer common problems, about whmcs client profile viewer, whmcs client profile viewer documentation, whmcs client profile viewer faq, whmcs client profile viewer help, whmcs client profile viewer guide, whmcs client profile viewer wiki, whmcs client profile viewer tutorial, whmcs client profile viewer tips, whmcs client profile viewer wiki"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Cloud Billing For WHMCS Solution."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Profile Viewer For WHMCS Module."></meta>
  
−
=About [https://www.modulesgarden.com/products/whmcs/cloud-billing Cloud Billing For WHMCS]=
+
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!<br/>
 +
We are sorry for the inconvenience caused.</h4>
 +
 
 +
=About [https://www.modulesgarden.com/products/whmcs/client-profile-viewer Client Profile Viewer For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Cloud Billing For WHMCS''' is a sophisticated module that consists of:
+
|style="padding: 10px 0px 10px 0px;"|'''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.<br />
 +
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.<br />
 +
The module enables you to not only conveniently preview the information about each customer but also modify it according to your needs.
 
|}
 
|}
 +
<!-- fixed -->
 +
*'''Addon Module Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ AWS Billing For WHMCS
+
|style="padding: 10px 0px 0px 30px;"|✔ View Widgets With Client Details In Tooltip On Mouseover
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Azure Billing For WHMCS ''(coming soon)''
+
|style="padding: 0px 0px 0px 30px;"|✔ Drag & Drop Configuration Of Each Widget To Change Order
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Google Cloud Billing ''(coming soon)''
+
|style="padding: 0px 0px 0px 30px;"|✔ Access Various Parts Of System On Click
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Microsoft CSP Billing For WHMCS ''(coming soon)''
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Admin Roles Assigned To Each Configuration
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|''''' AWS Billing For WHMCS '''''offers you a powerful billing model management of Amazon Web Services to broaden your target audience. The module allows you to gather all your AWS services in one place, connect to AWS in two different ways- with the use of your account  or your customer account.<br /> Except for setting percentage billing margin for WHMCS products per AWS service, you are given a possibility to generate detailed reports on billing management, earnings, resource usage per service and much more.
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Hide Tooltip Option
 
|}
 
|}
−
*'''Core Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Efficiently Bill Customers For Management of Amazon Web Services
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Delay Time To Show Tooltip
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Earn From Your Percentage Margins Based On User AWS Services
+
|style="padding: 0px 0px 10px 30px;"|✔ Automatically Flag Client Tickets To Assigned Admin
 
|}
 
|}
 +
*'''Widgets:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Connect With Amazon Web Services Using:
+
|style="padding: 10px 0px 0px 30px;"|✔ Income
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Own Account With All Services Of Your Customers
+
|style="padding: 0px 0px 0px 30px;"|✔ Invoices
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ With Customers' Accounts To Keep Their Management Separate
+
|style="padding: 0px 0px 0px 30px;"|✔ Quotes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Keep Customers Up To Date With Their Current And Upcoming Costs
+
|style="padding: 0px 0px 0px 30px;"|✔ Tickets
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Access Insightful Expenses, Earnings And Resources Usage Graphs
+
|style="padding: 0px 0px 0px 30px;"|✔ Services Amount
 
|}
 
|}
−
 
−
*'''Admin Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Dashboard Summaries:
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Invoices And Earnings Per Last Week/Month/Quarter/Year
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Expenses And Earnings
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Earnings Per Service
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Most Profitable Clients
+
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Latest Invoices
+
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Paid API Requests Usage
+
|style="padding: 0px 0px 0px 30px;"|✔ Person Assigned
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Pricing Groups With Multiple Pricing Margins Per AWS Services
+
|style="padding: 0px 0px 0px 30px;"|✔ Log In As Client
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign WHMCS Products To Selected Pricing Groups
+
|style="padding: 0px 0px 0px 30px;"|✔ Credit Card Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Select Billing Method For Product:
+
|style="padding: 0px 0px 0px 30px;"|✔ Send Email
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ On WHMCS Invoice Generation
+
|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 45px;"|✔ On First Day Of Month
+
|style="padding: 0px 0px 10px 30px;"|✔ Multibrand - Integrated With Multibrand For WHMCS [https://www.modulesgarden.com/products/whmcs/multibrand (read more)]
 
|}
 
|}
 +
*'''Widgets Configuration:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ On Last Day Of Month
+
|style="padding: 10px 0px 0px 30px;"|✔ Income:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create And Manage Service Relations Between:
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Range Of Income Statistic
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Tickets:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Clients And Their WHMCS Products
+
|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;"|✔ Services Amount:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Pricing Groups
+
|style="padding: 0px 0px 0px 45px;"|✔ Define If Product/Domain Status Is Shown
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Used API Credentials
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Additional Links To Show
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Chosen Billing Types:
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Visible Lines
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Default - Billing Services Based On Assigned Tag Names On Your AWS Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Admin Notes:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Organization - Bill Services Based On Provided Organization ID On Your AWS Account
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Note Length In Tooltip
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Custom Details - Bill All Services From Individual Customer AWS Account
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Notes:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Service Details:
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable/Disable Notes For All, Group Notes And My Notes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Total Paid And Charged Amount Per Client
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Notes Length Displayed In Tooltip
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Current Usage With Cost And Charged Amount Per Service
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Limits Of Notes Displayed In Tooltip Per Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Changes Per Service Graph
+
|style="padding: 0px 0px 0px 45px;"|✔ Define The Limits Of Notes Per Group
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Generated Invoices Per Service
+
|style="padding: 0px 0px 0px 30px;"|✔ Client Custom Status:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Created Invoices Per Client
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Show Client Status Before Their Name
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Provide Multiple API Credentials:
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Whether To Color Client Name
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ To Your Own AWS Accounts
+
|style="padding: 0px 0px 0px 30px;"|✔ Quick Actions:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ To Your Individual Customers Accounts
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Run API Connection Test
+
|style="padding: 0px 0px 0px 30px;"|✔ Profile Tabs:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Service Details, Usage And Charges From Client's Products/Services Tab
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Visible Options
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Access Your License Information With Selected Plan Based On Current Income
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Debug Mode For API Request Logging
+
|style="padding: 0px 0px 0px 30px;"|✔ Invoices:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Module Logs
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Visible Lines
 
|}
 
|}
−
 
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View Current Usage Per Service
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Charges Per Service Graph:
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Statuses Of Invoices To Count And Display
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Services Types
+
|style="padding: 0px 0px 0px 30px;"|✔ Quotes:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 45px;"|✔ Define Graph Scope
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Visible Lines
 
|}
 
|}
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports All Offered AWS Services
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Number Of Columns To Display Tabs
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Multiple AWS Accounts
+
|style="padding: 0px 0px 10px 45px;"|✔ Select Stages Of Invoices To Count And Display
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
Line 179: Line 191:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.9 And Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V7.9 And Later
+
|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]
 
|}
 
|}
  
−
*'''Requirements:'''
+
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 30px;"|✔ Amazon Web Services Account
+
|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.
 
|}
 
|}
−
 
−
=Installation and Configuration=
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/cloud-billing Cloud Billing For WHMCS] smoothly.''' <br />
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
−
We will guide you step by step through the whole process.
+
 
|}
 
|}
−
 
−
==Installation==
 
−
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_1.png]]
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
 +
In the most recent versions of the module, you will find only one package that supports PHP 7.1 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 15px 15px;"|'''2. Upload and extract the extension into the main WHMCS directory.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_74.png]]
−
Extracted files in your WHMCS directory should look like this:
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_2.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.0, and the second one addressed to PHP 7.1 up to PHP 7.3.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 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 15px 15px;"|'''3. When you install AWS Billing For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]]
−
The file is located in '' 'modules/addons/CloudBilling/license_RENAME.php'.''  Rename it from '' 'license_RENAME.php' '' to '' 'license.php'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_3.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;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
−
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'.''
+
The content of the package to upload should look like this.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP2_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In the next step, set up the  '' 'storage' '' folder as recursively writable.'''<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/>
−
This folder is available at '' 'your_whmcs/modules/addons/CloudBilling/' ''.
+
File is located in '' 'modules/addons/clientsprofiler/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_3.png]]
 
|}
 
|}
−
 
−
==Activating Addon Module==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''6. Now, you have to activate the module in your WHMCS system.'''<br />
+
|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/>
−
Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterward, find '' 'Cloud Billing' '' and press the '' 'Activate' '' button.<br />
+
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:AWS_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. In the next step, you need to grant access to this module.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br/>
−
To do so, click on the '' 'Configure' '' button, go to the '' 'Access Control' '' area and check the required admin role groups. Press '' 'Save Changes'.''<br />
+
Log in to your WHMCS admin area. Go to '' 'System Settings' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Client Profile Viewer' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''8. Good job! You have just successfully installed AWS Billing For WHMCS! Now in your WHMCS press '' 'Addons' '' and then '' 'Cloud Billing'. '' '''
+
|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, define the access control and grant permissions to manage the module to desired admin roles. Press '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_6.png]]
 
|}
 
|}
−
<!--
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Before you finish the configuration process, you need to set up the following folders as recursively writable:<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Client Profile Viewer For WHMCS!'''<br/>
−
<pre>'your_whmcs/modules/addons/CloudBilling/storage/logs'  
+
You can access your module under '' 'Addons' '' → '' 'Client Profile Viewer' ''.
−
'your_whmcs/modules/addons/CloudBilling/storage/app'  
+
−
'your_whmcs/modules/addons/CloudBilling/storage/crons'</pre>
+
−
|}-->
+
−
 
+
−
==AWS Billing For WHMCS==
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|'''9. In order to continue the configuration process. At first, proceed to the '' 'API Credentials' '' section as presented on the screen.<br/>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_7.png]]
 
|}
 
|}
 +
 +
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''To complete the previous step and connect to the platform properly, you need to generate your AWS access details.'''<br/>
+
|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/>
−
Underneath, you will find detailed instructions on where to find this information.
+
Additionally, you can easily configure access to the clients' information depending on the admin role.
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Log in to your [https://aws.amazon.com/console/ Amazon AWS Management Console] and find '' 'My Security Credentials' '' section under your account name dropdown.
+
|style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can manage tooltip configurations as well as add new ones.<br/>
 +
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 20px 25px;"|[[File:ALS_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_8.png]]
 
|}
 
|}
 +
===Add Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. There, move to the '' 'Access Keys (access key ID and secret access key)' '' section.
+
|style="padding: 10px 0px 20px 15px;"|To add a new configuration, press '' 'Add New Configuration' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ALS_7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. If you do not have any active keys yet, then press the '' 'Create New Access Key' '' button to generate a new set of details.
+
|style="padding: 0px 0px 15px 15px;"|Afterwards, fill in '' 'Configuration Name'.''<br/>
 +
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:ALS_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. A modal with Access Key ID and Secret Access Key will appear, so copy this information and keep it safe. You may also download a suitable file with these details. '''<br/>
+
|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.  
−
'' '''Note:''' This is the only place where you can find the corresponding secret key later. It will not be visible next to the Key ID in the panel.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ALS_9.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_11.png]]
 
|}
 
|}
 +
 +
===Advanced Configuration===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Now, come back the '' 'API Credentials' '' section and press the '' 'Add Credentials' '' button. In the new pop-up window, provide a name, API Key, API Secret.  
+
|style="padding: 10px 0px 20px 15px;"|Some of the widgets may have additional configuration, more information about them can be found in this subsection.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_10.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the new pop-up window, provide a name, API Key, API Secret. Press '' 'Add' '' when ready.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_12.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''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.<br /><br />
 +
 
 +
*'' '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.<br /><br />
 +
 
 +
*'' '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.<br /><br />
 +
 
 +
*'' 'Notes View Length Limit' '' - defines length of notes, from each group, shown in the main widget.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. To check if the entered data is correct, click on the '' 'Test Connection' '' button.
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_13_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_13.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.
 
|}
 
|}
−
 
−
=Management=
 
−
==Pricing Groups==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this section, you can easily create new pricing groups. To do so, please click on the button as shown below.
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_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 20px 15px;"|Here, you will be asked to provide a group name and set up the default pricing margin. <br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_1.png]]
−
'''Note:''' ''The default pricing margin means the percentage that will be added to the invoice.<br/> If you do not define the margin for a particular product, then the module will use the margin which is given in the  'Others'  field. ''  <br/>
+
−
'''Example: If  the Amazon's charge is 10$ and we set up 20% margin, the client will receive an invoice for 12$.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_15.png]]
+
|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
 +
*'' '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 15px;"|If you wish to add more payable services, click on the '' 'Add Billing Service' '' button to add a new one.
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_16.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 15px;"|Next, you can choose the services what will be payable.
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_4.png]]
−
'''Note:''' '' Please remember that if you do not select any service type from the drop-down list, the pricing margin that you enter will be automatically assigned to the 'Other' service type. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_17.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 15px;"|Pricing groups may be easily edited. If you wish to delete any of your pricing groups, firstly, make sure that the particular pricing group is not used anywhere. Otherwise, you will not be able to delete it.
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_18.png]]
+
|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.
 
|}
 
|}
−
 
−
==Products==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The '' 'Products' '' section grants you a possibility to add a new product and assign a pricing group to it. Moreover, you can select one of three available billing methods which will be allotted to the newly created product.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_14_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_19.png]]
+
|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|This image presents what the summary of your products should look like:
+
|style="padding: 0px 0px 15px 15px;"|'''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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you wish to disable a particular product, just click the following button:
+
|style="padding: 0px 0px 15px 15px;"|[https://www.modulesgarden.com/products/whmcs/sms-center '''Send SMS (Sold Separately)''']
−
'''Note:''' '' Please remember that a disabled product may be activated again anytime. ''
+
*'' '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 [https://www.docs.modulesgarden.com/SMS_Center_For_WHMCS Wiki].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_22.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you need to introduce some changes to your product, then click on the '' 'Edit' '' button. If some products are no longer necessary, then '' 'Delete' '' them.  
+
|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:AWS_23.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_14_6.png]]
 
|}
 
|}
−
{|
 
  
−
==Services==
+
==Settings==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Under this tab, new services can be added. To do so, click the '' 'Add Service' '' button.
+
|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 the cursor is moved outside of it.<br/>
 +
*'''Show After''' - defines delay time for showing the tooltip.<br/>
 +
*'''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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_24.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_16.png]]
 
|}
 
|}
 +
 +
==Tooltip==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the newly opened window, you will be asked to complete the following information:<br />  
+
|style="padding: 10px 0px 15px 15px;"|Tooltip will be displayed across the WHMCS admin area, wherever client's name is displayed.<br/>
−
*'' 'Client' '' - select one of your clients,
+
On the following screen you can see a client tooltip in '' 'Clients' '' → '' 'View/Search Clients' ''. <br/>
−
*'' 'Service' '' - choose one service which was ordered by your client,
+
As you know, tooltip is made of widgets, let us discuss over each of them.<br/>
−
*'' 'Pricing Group' '' - decide which of the previously created pricing groups should be allotted to this service,
+
''Note: Most of the widget titles are links to specific parts of the WHMCS system.''
−
*'' 'Credentials' '' - if you created more than one credentials then you can define which one will be assigned to this service,
+
−
*'' 'Billing Type' '' - determines the way of searching the resources that your clients will be billed for, there are three options available:
+
−
**'' 'Default' '' – all resources containing tag names provided by you will be billed,<br /> For instance, when you enter ‘WHMCS’ in the '' 'Tag Name' '' field, this tag name with the value of the service will be automatically searched for in Amazon,
+
−
**'' 'Organization' '' – all resources in a particular company will be billed,
+
−
**'' 'Custom details' '' – all resources in a particular account will be billed. The module connects to AWS and sums everything what is available there,
+
−
*'' 'Tag Name' '' – if you wish your Amazon services to be filtered according to the particular tag names, then type a tag name here.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_25.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_17.png]]
 
|}
 
|}
 +
 +
===Assigned Admin To Client===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Here you can check what the newly added service looks like:<br />
+
|style="padding: 10px 0px 15px 15px;"|Allows you to assign admin to a specific client. The assigned admin is visible only from the tooltip.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_26.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:CLP_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| If you wish to check more details, press the following button. <br />
+
|style="padding: 0px 0px 20px 0px;"|Once an admin is assigned they can automatically assign new tickets to the client and then stop assigning them.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_27.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_18_1.png]]
 
|}
 
|}
 +
 +
===Client Custom Status===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| Now, you will be redirected to a new subpage. <br />
+
|style="padding: 10px 0px 20px 15px;"|Enables you to assign custom status and color to a client.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_28.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19.png]]
 
|}
 
|}
 +
 +
===Log In As Client===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| Please remember that there is a difference between '' 'Cost' '' and '' 'Charge Amount' '' in the '' 'Current Usage' ''section. <br />
+
|style="padding: 10px 0px 15px 15px;"|This widget allows you to quickly log in as a client.<br/>
−
*'' 'Cost' '' refers to the amount that is billed by Amazon.
+
Press '' 'Log In As Client' '' to do so.
−
* '' 'Charge Amount' ''  is the amount that your client will be billed.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If any values for usage have been counted, there will be a possibility to create invoices. To generate an invoice, simply press the icon as shown in the picture: <br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_22.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_29.png]]
+
 
|}
 
|}
  
−
==Settings==
+
===List Of Users===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to collect the data properly, the following cron tasks may be needed.
+
|style="padding: 10px 0px 20px 15px;"|This widget includes a list of all users, with their email addresses, associated with the client's account.
−
''' Note:'''  '' Please remember that the following picture is only a suggestion how to set up cron and of course it can be modified by you.<br /> Keep in mind that each cron should be used once a day because Amazon charges for every API request. '' <br />
+
−
'''Note:'''  It is possible to collect your '' 'Billing Data' '' from the preferred period of time. To do so, add date range  '''--from --to''' at the end of your cron command as shown in the following example:<br />
+
−
<pre>  php -q /your_whmcs/modules/addons/CloudBilling/cron/cron.php billing --from 2020-01-05 --to 2020-01-10</pre>
+
−
Once you enter this command, you will receive the '' 'Billing Data' ''  from 05.01.2020 to 10.01.2020. <br />
+
−
'''To obtain precise information, we highly recommend performing the '' 'Billing Data Collecting' '' cron at 22:00 UTC time and the '' 'Invoicing' '' cron at 23:00 UTC time. ''' <br/> <br/>
+
−
You may also define the '' 'Cron Setup' '' by providing one of the following values: 1, 2, 3, 4, 6, 8 that can be selected from the dropdown menu. <br/> These are the factors of 24. As an example, if you choose '4' then the cron task will be run 4 times within 24 hours (about every 6 hours).
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_30.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_0.png]]
 
|}
 
|}
−
 
+
===Profile Tabs===
−
==Dashboard==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|It is possible to count the number of your API requests as well as their cost. This option is located at the bottom of the ‘Dashboard’ section.  
+
|style="padding: 10px 0px 20px 15px;"|Quick redirection to tabs in client's profile.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_31.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_1.png]]
 
|}
 
|}
  
−
==Invoices==
+
 
 +
 
 +
===Client Notes - Admin Notes, Notes And Custom Notes===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"| All generated invoices are gathered in the '' 'Invoices' '' tab. <br /> Here you can check the most essential information of a particular invoice such as '' 'ID' '', '' 'Client' '', '' 'Status' '', '' 'Amount' '' and the creation date. The search box allows you to filter invoices of a particular client.  
+
|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 → '' '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.<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 20px 25px;"|[[File:AWS_32.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20.png]]
 
|}
 
|}
 +
===Credit Card Information===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In order to check the details of a specific invoice, please click the info button as presented below: <br />
+
|style="padding: 10px 0px 15px 15px;"|'' 'Credit Card Information' '' widget displays you all credit cards assigned to a particular client.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_33.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_20_1.png]]
 
|}
 
|}
 +
 +
===Income===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Next, you will be redirected to the details of the selected invoice.  
+
|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:AWS_34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_21.png]]
 
|}
 
|}
  
−
==Logs==
+
 
 +
===Services===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|The '' 'Logs' '' section stores the history of all actions performed in the module. <br /> If you wish to filter the history by one of these options: '' 'ID' '', '' 'Service ID' '', '' 'Message' '', '' 'Type' '', '' 'Date' '', simply click on the preferred one.
+
|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 20px 25px;"|[[File:AWS_35.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_23.png]]
 
|}
 
|}
 +
 +
===Tickets===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|There is a possibility to delete the selected item from the '' 'Logs' '' section by pressing the following icon.<br />
+
|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:AWS_36.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24.png]]
 
|}
 
|}
−
 
+
===Invoices===
−
==Documentation==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Once you click on the '' 'Documentation' '' section, you will be redirected to the website you are currently reading.  
+
|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: 0px 0px 30px 25px;"|[[File:AWS_37.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_1.png]]
 
|}
 
|}
−
 
+
===Quick Actions===
−
==Admin Area==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Cloud Billing For WHMCS allows you to monitor and manage your customer services from the admin area of your WHMCS system.
+
|style="padding: 10px 0px 20px 15px;"|Move directly form clients profile tooltip to a chosen action section.
−
This includes supervision of such features as:
+
−
 
+
−
*Module commands to allow easy and quick management of the service,
+
−
*Service details,
+
−
*Current Usage,
+
−
*Charges per Service,
+
−
*Service Invoices.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_37_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_19_2.png]]
 
|}
 
|}
  
−
==Client Area==
+
===Quotes===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In the client area, proceed to  '' 'My Products&Services' '' → '' 'Product Details' ''. <br /> Here, you can check the '' 'Current Usage' '' as well as '' 'Charges per Service' '' which can be modified according to your preferences.  
+
|style="padding: 10px 0px 20px 15px;"|'' 'Quotes' '' widget shows the client's quotes divided into groups by status and includes a direct link to them.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_38.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_24_1.png]]
 
|}
 
|}
 +
 +
===Recent Emails===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Once clicked on the edit icon, a new pop-up will show up.<br />
+
|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 20px 25px;"|[[File:AWS_39.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_28_1.png]]
 
|}
 
|}
 +
===Send Email===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Here, you can select a type of your service and choose a time frame for a graph from these available ones: '' 'Current Month' '', '' 'Last Month' '', '' 'Last Quarter' '', '' 'This Year' ''.
+
|style="padding: 10px 0px 20px 15px;"|'' 'Send Email' '' widget grants you the possibility to send emails effortlessly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:AWS_40.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_28.png]]
 
|}
 
|}
  
−
<!-- == Cloud Billing ==
+
===Send SMS===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Under this section you can easily analyze the '' 'Current Usage' '', '' 'Charges per Services' '', '' 'Services List' ''.<br />
+
|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!
−
Please remember that from this place in the module, you can also modify the '' 'Charges per Services' '' section as it was described previously. To do so, simply click on the edit icon and define the data to be displayed.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:AWS_41.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26.png]]
 
|}
 
|}
 +
===Multibrand===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the '' 'Services List' ''part you are able to find the selected services and check their details by pressing the appropriate icon:
+
|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:AWS_42.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:CLP_26_0.png]]
 
|}
 
|}
−
-->
 
  
−
=Update Instructions=
+
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.
+
|style="padding: 10px 0px 30px 15px;"|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.<br/>
 +
Drag and drop the desired widget box in a required position.  
 
|}
 
|}
  
 +
=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/>
 +
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/>
 +
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/>
 +
|}
 
=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.'''
 
|}
 
|}

Revision as of 10:10, 1 March 2021

Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.

Contents

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
✔ Automatically Flag Client Tickets To Assigned Admin
  • Widgets:
✔ Income
✔ Invoices
✔ Quotes
✔ Tickets
✔ Services Amount
✔ Client Admin Notes
✔ Client Notes
✔ Client Custom Notes
✔ Client Custom Status
✔ Quick Actions
✔ Profile Tabs
✔ Person Assigned
✔ Log In As Client
✔ Credit Card Information
✔ Send Email
✔ Send SMS - Integrated With SMS Center For WHMCS (read more)
✔ Multibrand - Integrated With Multibrand For WHMCS (read more)
  • Widgets Configuration:
✔ Income:
✔ Select Range Of Income Statistic
✔ Tickets:
✔ Select Statuses Of Tickets To Count And Display
✔ Define Number Of Columns To Display Tabs
✔ Services Amount:
✔ Define If Product/Domain Status Is Shown
✔ Define Additional Links To Show
✔ Define Number Of Visible Lines
✔ 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 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 Number Of Columns To Display Tabs
✔ Invoices:
✔ Define Number Of Visible Lines
✔ Define Number Of Columns To Display Tabs
✔ Select Statuses Of Invoices To Count And Display
✔ Quotes:
✔ Define Number Of Visible Lines
✔ Define Number Of Columns To Display Tabs
✔ Select Stages Of Invoices To Count And Display
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 7.1 Up To PHP 7.4
✔ Supports WHMCS V7.9 And Later
✔ Easy Module Upgrade To Open Source Version

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.1 and later.

PHP71 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.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.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

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, do not forget to save the changes in the end.
CLP 11.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 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

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

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

Client Custom Status

Enables you to assign custom status and color to a client.
CLP 19.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

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

Profile Tabs

Quick redirection to tabs in client's profile.
CLP 19 1.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 → '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

Credit Card Information

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

Income

'Income' widget displays the summary value of paid invoices as well as those still waiting for payment.
CLP 21.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

Invoices

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

Quick Actions

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

Quotes

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

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

Send Email

'Send Email' widget grants you the possibility to send emails effortlessly.
CLP 28.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

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

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.

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.

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=Cloud_Billing_For_WHMCS&oldid=54499"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Cloud Billing For WHMCS