|
|
Line 2: |
Line 2: |
| <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Area Designer For WHMCS Module."></meta> | | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Client Area Designer For WHMCS Module."></meta> |
| | | |
− | =About [https://www.modulesgarden.com/products/whmcs/client-area-designer Client Area Designer For WHMCS]= | + | =About [https://www.modulesgarden.com/products/whmcs/client-area-designer Email Notifications Organizer For WHMCS]= |
| {| | | {| |
− | |style="padding: 10px 0px 10px 0px;"|'''Client Area Designer For WHMCS''' will allow you to tailor the view of your entire WHMCS client area.<br/> | + | |style="padding: 10px 0px 10px 0px;"|'''Email Notifications Organizer For WHMCS''' will .............. |
− | The module will let you alter the order and visibility of displayed elements, adjust existing widgets and add new ones, or even create customizable slideshows.<br/>
| + | |
− | Additionally, you may set up restrictions rules to show the particular components to selected clients only.
| + | |
| |} | | |} |
| <!-- fixed --> | | <!-- fixed --> |
| *'''Module Features:''' | | *'''Module Features:''' |
| {| | | {| |
− | |style="padding: 10px 0px 0px 30px;"|✔ Customize Your Client Area By Modifying: | + | |style="padding: 10px 0px 0px 30px;"|✔ |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Navbar Elements | + | |style="padding: 0px 0px 0px 30px;"|✔ |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Sidebar Elements | + | |style="padding: 0px 0px 10px 30px;"|✔ |
| |} | | |} |
− | {|
| + | *'''Features:''' |
− | |style="padding: 0px 0px 0px 45px;"|✔ Homepage Widgets
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Add Your Own Elements And Widgets
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Scan Your Client Area In Search Of Custom Elements And Widgets
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 10px 30px;"|✔ View And Modify List Of Known Locations In Your Client Area
| + | |
− | |}
| + | |
− | *'''Navbar Element Features:''' | + | |
| {| | | {| |
| |style="padding: 10px 0px 0px 30px;"|✔ Define Name | | |style="padding: 10px 0px 0px 30px;"|✔ Define Name |
Line 37: |
Line 23: |
| {| | | {| |
| |style="padding: 0px 0px 0px 30px;"|✔ Define URI | | |style="padding: 0px 0px 0px 30px;"|✔ Define URI |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Icon
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Elements Display
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Visibility For:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Logged In Clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Non-Logged In Clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ All Clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Additional Conditions:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Active Products/Domains/Addons
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Inactive Products/Domains/Addons
| |
| |} | | |} |
| {| | | {| |
Line 90: |
Line 37: |
| {| | | {| |
| |style="padding: 0px 0px 0px 30px;"|✔ Define Icon | | |style="padding: 0px 0px 0px 30px;"|✔ Define Icon |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Elements Display
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Visibility For:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Logged In Clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Non-Logged In Clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ All Clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Display Rules:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Client Owns Domain
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Client Owns Product
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Client Is In Location
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Additional Conditions:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Active Products/Domains/Addons
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Inactive Products/Domains/Addons
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Minimum And Maximum Customer Revenue
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Links To Element
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Customize Body And Footer Content - Supports HTML, CSS, JavaScript And Smarty
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Add Content Rotator:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Include Multiple Body Contents And Image Items
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Autoplay
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Define Autoplay Speed
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Dots Display
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Arrows Display
| |
| |} | | |} |
| {| | | {| |
Line 165: |
Line 49: |
| |style="padding: 10px 0px 0px 30px;"|✔ Define Name | | |style="padding: 10px 0px 0px 30px;"|✔ Define Name |
| |} | | |} |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Icon
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Toggle Elements Display
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Style Color
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Define Widget Button
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Links To Element
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Customize Body And Footer Content - Supports HTML, CSS, JavaScript And Smarty
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 30px;"|✔ Add Content Rotator:
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 45px;"|✔ Include Multiple Body Contents And Image Items
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Autoplay
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 45px;"|✔ Define Autoplay Speed
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Dots Display
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Arrows Display
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Infinite Rotation
| + | |
− | |}
| + | |
| {| | | {| |
| |style="padding: 0px 0px 10px 45px;"|✔ Customize HTML Footer | | |style="padding: 0px 0px 10px 45px;"|✔ Customize HTML Footer |
Line 229: |
Line 75: |
| =Installation= | | =Installation= |
| {| | | {| |
− | |style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/client-area-designer Client Area Designer 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-area-designer Email Notifications Organizer 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 236: |
Line 82: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_1.png]] |
| |} | | |} |
| {| | | {| |
Line 244: |
Line 90: |
| {| | | {| |
| |style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]] | | |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 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/client-area-designer#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'.'''
| |
| |} | | |} |
| {| | | {| |
Line 268: |
Line 103: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_3.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_3.png]] |
| |} | | |} |
| {| | | {| |
Line 275: |
Line 110: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_4.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_4.png]] |
| |} | | |} |
| {| | | {| |
Line 282: |
Line 117: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_5.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_5.png]] |
| |} | | |} |
| {| | | {| |
Line 289: |
Line 124: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_6.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_6.png]] |
| |} | | |} |
| {| | | {| |
Line 296: |
Line 131: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_7.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:ENO_7.png]] |
| |} | | |} |
| | | |
| =Configuration and Management= | | =Configuration and Management= |
| {| | | {| |
− | |style="padding: 10px 0px 30px 15px;"|'''Client Area Designer For WHMCS is a module which allows you to adjust the layout of any panels available on your client area as well as add new widgets.'''<br/> | + | |style="padding: 10px 0px 30px 15px;"|'''Email Notifications Organizer For WHMCS is a module which allows .................'''<br/> |
− | The module does not require highly advanced configuration.<br/>That is why we will immediately move to the most crucial aspect, which is customizing the panels layout.
| + | ................ |
| |} | | |} |
| | | |
− | ==Panels== | + | ==123== |
| {| | | {| |
− | |style="padding: 10px 0px 30px 15px;"|Under '' 'Panels' '' tab you will find three sections dedicated to the visibility of different types of panels in your client area. | + | |style="padding: 10px 0px 30px 15px;"|Under '' 'Panels' '' |
− | *Navbars - Management of positions available on the navigation bar in your client area
| + | |
− | *Sidebars - Management of panels available on the left sidebar in your client area
| + | |
− | *Homepage Widgets - Modify and create new widgets available on your home page
| + | |
| |} | | |} |
− | ===Navbars=== | + | ===123s=== |
| {| | | {| |
− | |style="padding: 10px 0px 15px 15px;"|On the first sight you will see two tables, each related to Primary Navbar Left or Right side.<br/> | + | |style="padding: 10px 0px 15px 15px;"|On the first |
− | There are already all the predefined sections outlined with their official names and positions.<br/>
| + | |
− | ''Info:
| + | |
− | If you already see that you have more elements than it is visible in the addon, then use '' 'Scanner' '' to search for them.<br/> Read more about scanning option [[#Scanner|here]].''
| + | |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_8.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_8.png]] |
| |} | | |} |
| {| | | {| |
Line 326: |
Line 155: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_9.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:ENO_9.png]] |
| |} | | |} |
| {| | | {| |
Line 333: |
Line 162: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_10.png]]
| + | |style="padding: 0px 0px 30px 25px;"|[[File:ENO_10.png]] |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|Use action buttons to:
| + | |
− | *edit the section
| + | |
− | *delete '''(only custom elements)'''
| + | |
− | *view child elements
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_11.png]]
| + | |
− | |}
| + | |
− | ====Edit Element====
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|When you are editing an existing parent element, you may:
| + | |
− | *Name - change existing or provide a new element name.<br/>'' '''Note''' that displayed name in the client area of a '''default''' WHMCS element will still be taken from the chosen client's language file, so you need also to modify it accordingly.''
| + | |
− | *URI - provide a URI
| + | |
− | *Icon - add an icon
| + | |
− | *Display - hide an element
| + | |
− | *Visible - select who it will be visible for: logged in clients, not logged or all clients
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_12.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|You may also provide some display rules. Only the clients who fulfill the rules will see the element.<br/>
| + | |
− | If you leave this part empty, the element will be visible to all clients without limitations.
| + | |
− | *Domains - select the domains which clients must own
| + | |
− | *Products - point the products which clients must own
| + | |
− | *Locations - choose the location which clients must enter<br/>
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_13.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|In the last tab, you can specify what conditions have to be met to display an element.<br/>
| + | |
− | If you leave this part empty, the element will be visible to all clients without limitations.
| + | |
− | *Active - choose which services from at least one of each types customers should have active
| + | |
− | *Inactive - choose which services from at least one of each types customers should have inactive (terminated, cancelled, suspended or expired)
| + | |
− | *Revenue - define the minimum and maximum revenue earned from the customer to display an element<br/>
| + | |
− | Do not forget to save changes after specifying the conditions.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_13_2.png]] | + | |
| |} | | |} |
| | | |
− | ====New Parent Element====
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|It is possible add a completely new parent element either on left or right side.<br/> To do so, press '' 'Add'.''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_14.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
| |
− | Start with '' 'General'.'' Provide:
| |
− | *name visible for clients
| |
− | *unique for the system identifier
| |
− | *URI
| |
− | *select icon from available
| |
− | *select '' 'Display' '' to make the panel visible
| |
− | *finally decide who it will be visible for: logged in clients, not logged in or all clients
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_15.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|If you want only some of the clients to see the panel, then set up the '' 'Display Rules'.''<br/>
| |
− | In our case, we decided to select products a client must own to get access to '' 'Support Chat'.''<br/>
| |
− | Save changes.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_16.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|This is what our new panel looks like in the client area:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_17.png]]
| |
− | |}
| |
− |
| |
− | ====New Child Element====
| |
− | {|
| |
− | |style="padding: 10px 0px 20px 15px;"|Let's now add one more element to the already existing '' 'Support' '' panel.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_18.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|You have to fill out the same data as in case of parent element:<br/>
| |
− | *name
| |
− | *identifier
| |
− | *URI
| |
− | *icon
| |
− | *select '' 'Display' '' to make it visible
| |
− | *finally select who it will be visible for: logged in clients, not logged or all clients
| |
− | <br/>
| |
− | This time we want all the clients to have access to our FAQ site, so we do no set any '' 'Display Rules'. ''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_19.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|As a custom element, you may delete it completely or edit.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_20.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|Let's take a look at the new position in the client area:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_21.png]]
| |
− | |}
| |
− |
| |
− | ===Sidebar Panels===
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|Sidebar panels section refers to the elements located on the left side of your client area.<br/>
| |
− | Generally, management of sidebars is very similar to the Navbar panels described in the previous section.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_24.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Available actions:
| |
− | *change positioning by dragging and dropping elements in the selected place
| |
− | *edit the section - change name, icon, content (if possible), display rules and conditions
| |
− | *delete elements - this option is available for custom entries only
| |
− | *view child elements
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_23.png]]
| |
− | |}
| |
− |
| |
− | ====Edit Element====
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|'''General''' section:
| |
− | *provide a new display name
| |
− | *add icon
| |
− | *hide/show the element
| |
− | *change visibility
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_25.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|'''Content:'''
| |
− | You can add two types of content - ''HTML'' and ''Content Rotator''.<br/>
| |
− | '' Note that it is possible only if the element has no child elements.''
| |
− | *''HTML'' - simply change the ''Body'' or ''Footer'' content.<br/>
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_26.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|
| |
− | *''Content Rotator'' - define how many elements can rotate within specified time intervals and choose the panel navigation elements.<br/>
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_26_2.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Here is an example of a simple effect that you can achieve with the content rotator.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_26_3.gif]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|'''Display Rules''' - only clients who fulfill the rules will see the element.<br/>
| |
− | If you leave this part empty, the element will be visible for all clients without limitations.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_27.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|'''Conditions''' - specify what conditions have be met to display an element.<br/>
| |
− | If you leave this part empty, the element will be visible to all clients without limitations.
| |
− | *Active - choose which services from at least one of each types customers should have active
| |
− | *Inactive - choose which services from at least one of each types customers should have inactive (terminated, cancelled, suspended or expired)
| |
− | *Revenue - define the minimum and maximum revenue earned from the customers to display an element<br/>
| |
− | Do not forget to save changes after specifying the conditions.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_27_2.png]]
| |
− | |}
| |
− |
| |
− | ====New Parent Element====
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|You may add a completely new parent element either on left or right side.<br/>Press '' 'Add'.''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_28.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Then you will have to fill out all the general info, content and display rules.<br/>
| |
− | Start with '' 'General'.'' Provide:
| |
− | *name visible for clients
| |
− | *unique for the system identifier
| |
− | *select icon from available
| |
− | *select '' 'Display' '' to make the panel visible
| |
− | *finally decide who it should be visible for: logged in clients, not logged in or all
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_29.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Select content ''Type'' and define ''Body'' and ''Footer'' content.<br/>
| |
− | ''Note: If you provide the content here, you will not be able to add child elements to this item.''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_30.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|If you want only the specified clients to see the panel, set up the '' 'Display Rules' '' or '' 'Conditions' ''.<br/>
| |
− | Save changes.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_31.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|This is what our new panel looks like in the client area:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_32.png]]
| |
− | |}
| |
− |
| |
− | ====New Child Element====
| |
− | {|
| |
− | |style="padding: 10px 0px 20px 15px;"|Let's now add one child element to client's '' 'Shortcuts'.''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_33.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Fill out all the required data to crate a correct link:<br/>
| |
− | *name
| |
− | *identifier
| |
− | *URI
| |
− | *icon
| |
− | *select '' 'Display' ''
| |
− | *define visibility
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_34.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|Any custom element can be deleted. In contrast to the default ones which may be only edited and hidden.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_35.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|Now, you see an additional link under '' 'Shortcuts'.''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_36.png]]
| |
− | |}
| |
− |
| |
− | ===Homepage Widgets===
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|The last type of panels are homepage widgets.<br/>
| |
− | Available actions:
| |
− | *change positioning by dragging and dropping elements in the selected place
| |
− | *edit the widget
| |
− | *view child elements if there are any
| |
− | *delete custom widgets
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_37.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|To visualize, these are the client area widgets we are going to alter in a moment:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_38.png]]
| |
− | |}
| |
− |
| |
− | ====Edit widget====
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|'''General:'''
| |
− | *provide a new display name
| |
− | *change icon
| |
− | *hide the element
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_39.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Under '' 'Content' '' section you can overwrite the default text.<br/>
| |
− | We will leave it empty as we do not want to change the content, just the look and feel of the widget.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_39_1.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|'''Extras''' - here you can change the visual parts:
| |
− | *widget color
| |
− | *button name, URI and icon
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_40.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|That is what our adjusted widget looks like now:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_41.png]]
| |
− | |}
| |
− |
| |
− | ====Add New Widget====
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|For presentation purposes, we will create now a completely new widget.<br/>It will include a button redirection to our Knowledgebase and two links to FAQ and Upload Files form.<br/>
| |
− | To start, simply press '' 'Add' '' button.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_42.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Then fill out all the general info, content and extras.<br/>
| |
− | Start with '' 'General','' provide:
| |
− | *widget name
| |
− | *unique for the system identifier
| |
− | *select icon from available
| |
− | *finally select '' 'Display' '' to make the panel visible
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_43.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|As we are going to add two links inside the widget, so we have to skip this section.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_44.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Finally, customize your widget by defining color and button details.
| |
− | Save changes.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_45.png]]
| |
− | |}
| |
− |
| |
− | ====New Child Widget====
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|Let's now add a child element to the just created '' 'Knowledgebase'.''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_46.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Fill out the required data:<br/>
| |
− | *name
| |
− | *identifier
| |
− | *URI
| |
− | *icon
| |
− | *select '' 'Display' ''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_47.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|As you can see, we added two new entries under the '' 'Knowledgebase' '' widget.<br/>
| |
− | Surely, you can edit each one of them or delete.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_48.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|Here is a final view of our customized client area with new elements:
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_49.png]]
| |
− | |}
| |
− |
| |
− | ==Locations==
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|In this you will find an extended list of all standard locations in your client area with its common name and URI.<br/>
| |
− | These locations are searched through by the module scanner in search of custom panels and are available in the '' 'Locations' '' field when setting up '' 'Display Rules'. ''
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_50.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|Press the button with pencil icon next to the location you are interested in editing.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_51.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 15px;"|There you can edit the name of existing location and its URI.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_52.png]]
| |
− | |}
| |
− | ===New Location===
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|You may also add new if you have some custom locations and you wish to use them in our module.<br/>
| |
− | Please note that your locations have to be manageable by WHMCS.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_53.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|Provide a location name and URI.<br/>
| |
− | When ready, your new location will be from now on used by Client Area Designer module.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_54.png]]
| |
− | |}
| |
− |
| |
− | ==Scanner==
| |
− | {|
| |
− | |style="padding: 10px 0px 15px 15px;"|Scanner is a tool that allows our module to carefully browse through a chosen client's client area in search of any elements in known locations.<br/>
| |
− | Select a client to log in as one and run the scanner.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_59.png]]
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 15px 15px;"|You will see a preview of all locations. When the scan is finished, you will see a summary with the number of found panels.<br/> All newly found elements will be automatically added to proper positions in the addon.
| |
− | |}
| |
− | {|
| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_60.png]]
| |
− | |}
| |
| | | |
| ==Documentation== | | ==Documentation== |
Line 762: |
Line 171: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 30px 25px;"|[[File:CAD_55.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:ENO_55.png]] |
− | |}
| + | |
− | ==Smarty Tags==
| + | |
− | {|
| + | |
− | |style="padding: 10px 0px 15px 15px;"|Starting with the 1.1.0 version, the module allows you to use ''[https://www.smarty.net/ Smarty]'' tags in HTML content.<br/>
| + | |
− | For example, if you use ''{$client.firstname}'', ''{$client.lastname}'' and ''{$client.credit}'' in the following code:
| + | |
− | <pre>Hello <b>{$client.firstname} {$client.lastname}!</b><br/><br/>
| + | |
− | You still have <b>${$client.credit}</b> funds on your account.<br/>
| + | |
− | Find out what you can do with them!
| + | |
− | <br/></pre>
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_57.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 15px;"|The result will be as follows:
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_58.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|You can, of course, use the full scope of ''Smarty'' tags, such as [https://www.smarty.net/docsv2/en/language.function.if.tpl conditional instructions]:
| + | |
− | <pre>
| + | |
− | Hello <b>{$client.firstname} {$client.lastname}!</b><br/><br/>
| + | |
− | {if $client.credit gt 0}
| + | |
− | You still have <b>${$client.credit}</b> funds on your account. <br/>
| + | |
− | Find out what you can do with them!<br/>
| + | |
− | {else}Sorry you have no funds!<br/>
| + | |
− | {/if}
| + | |
− | </pre>
| + | |
− | In this example, if the customer does not have any credit, he will see something like this:
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_58_2.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 15px 15px;"|Of course, this is just a very simple example that will only work for the clients who are logged in. In order to build more advanced elements, please check out the [https://www.smarty.net/documentation Smarty documentation].<br/>
| + | |
− | '' '''Note:''' Remember that the incorrect use of ''Smarty'' tags may lead to a website not operating properly.''<br/>
| + | |
− | If you need to use a more advanced code using ''{php}'' tags, make sure that you have enabled the relevant option in the '' 'General Settings' '' → '' 'Security' ''.
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 20px 25px;"|[[File:CAD_56.png]]
| + | |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 15px;"|For example, you can list all of the template variables using:
| + | |
− | <pre><pre>{php}print_r($template->getTemplateVars());{/php}</pre>
| + | |
| |} | | |} |
| | | |