Client Area Popup For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


Contents

About Client Area Popup For WHMCS

Client Area Popup For WHMCS is a module that lets you create fully customized pop-ups that will be visible to your clients in their panel.
Prepare a ready pop-up in a form of an image, raw or HTML text to pass a message directly to your clients.
Design it using predefined styles, which can be always altered and upgraded to implement your idea perfectly.
  • Admin Area Features:
✔ Create Pop-ups Using Predefined Styles
✔ Preview Pop-up With Single Click
✔ Archive Pop-ups For Later Use
✔ View Pop-up Restrictions
✔ View Number of Pop-up Displays
✔ Create Styles To Be Used By Pop-up
✔ Preview Style With Single Click
  • Client Area Features:
✔ View Pop-up If Restrictions Are Met
✔ Close Pop-up Permanently
  • Pop-up Features:
✔ Define Pop-up Restrictions:
✔ Display Frequency - How Often Pop-up Should Be Displayed
✔ Hide - Client Can Close Pop-up Permanently
✔ Pages - Define Pages Where Pop-up Is Displayed
✔ Required Languages
✔ Required User Groups
✔ Required Active Products
✔ Required Active Products In Groups
✔ Required Active Products With Servers
✔ Required Active Addons
✔ Required Active Domains With Chosen TLDs
✔ Lack Of Chosen Active Products
✔ Lack Of Chosen Active Addons
✔ Lack Of Active Domains With Chosen TLDs
✔ Define Time Frames For Pop-up To Be Shown
✔ Define Pop-up Size
✔ Assign Style To Pop-up
✔ Choose Type And Provide Pop-up Content:
✔ Raw Text
✔ HTML
✔ Image
  • General Info:
✔ Supports Default And Custom WHMCS Templates
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS V6 and V7

Installation

This tutorial will show you how to successfully install and configure Client Area Popup For WHMCS.

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

1. Log in to your client area and download the module.
CAP 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

CAP 2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Sdftsert.png
4. When you install Client Area Popup For WHMCS for the first time you have to rename 'license_RENAME.php' file.

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

CAP 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 your client area → 'My Products'.

CAP 4.png
6. Set permissions to file: 'modules/addons/PopupModule/templates/clientarea/assets/popup' to '0777'.
7. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Addon Modules'. Afterwards, find 'Client Area Popup' and press 'Activate' button.

CAP 5.png
8. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

CAP 6.png
9. You have just successfully installed Client Area Popup For WHMCS!

You can access your module under 'Addons' 'Client Area Popup'.

CAP 7.png

Configuration and Management

Client Area Popup For WHMCS is a module which allows you to notify your clients by showing them customized pop-ups directly in their panel.

Below, you will find instructions on how to draft and customize such pop-ups.

Configuration

The module does not require advanced configuration.
That is why, we will immediately move to the most crucial part, which is creating a pop-up.

Create Pop-up

To add a new pop-up simply press an appropriate button.
CAP 8.png

General

Start with naming the pop-up.
Note: the title will not be displayed in any way on the final pop-up.
CAP 9.png
If you added any pop-ups in the past, you may copy their settings to the newly created one to save time.

Finally, select the initial status:

  • Active - for enabled pop-ups.
  • Archived - for pop-ups awaiting activation.
CAP 10.png

Look And Feel

The next part of creating a pop-up process concerns its interface, layout and general design.
  • Size

Auto - it automatically adjusts to the content.
Custom - if you want a customized size, then simply enter appropriate width and height.

  • Style

Select style from the list of available and previously defined styles.
More about styles can be found here.

CAP 11.png
  • Type

The pop-up may have a simple text form - select 'Text' and then format the text.
See the visualization here.

CAP 12.png
Provide ready code snippet that you want to insert into the pop-up content.

See the visualization here.

CAP 13.png
Upload an 'Image'.

See the visualization here.

CAP 14.png

Restrictions

Restrictions - this is the place where a pop-up is conditioned. Please set up the rules according to which the pop-up will be displayed to clients.
Only one restriction rule per group is required to show pop-up. If you choose restrictions from multiple conditions then at least one rule in each group must be fulfilled to show pup-up.

For example: If you choose three products under 'Has Active Product' rule then client needs to have only one of active products to see the pop-up.
But if you choose three products under 'Has Active Product' rule and three addons under 'Has Active Addon' rule then client will have to have at least one active product and at least one active addon from selected conditions to see the pop-up.

General options:
  • Display Frequency - define how often the pop-up will be displayed to a client, you may also make it visible all the time.
  • Hide - if selected, clients will be allowed to close the pop-up permanently, even if it was configured to appear repeatedly.
  • Non-logged In Users - if selected, the pop-up will be displayed to all guests and unlogged visitors.
  • Pages - provide here specific wildcards URL of sites where the pop-up should be available from. Use comma to separate them if you plan to add more than one page.
    e.g.: '*action=invoices, *action=quotes' etc.

Conditions:
Press required text area and available options will appear.

  • Languages - show the pop-up if a client uses one of the selected languages.
  • User Groups - show the pop-up if a client belongs to one of the selected groups.
  • Has Active Product - show the pop-up if a client has at least one active product from the selected ones.
  • Has Active Addon - show the pop-up if a client has at least one active addon from the selected ones.
  • Has Active Product In Group - show the pop-up if a client has active products in at least one of the selected groups. Note: At least one product in group is required.
  • Has Active TLD - show the pop-up if a client owns at least one active domain with one of the selected TLDs.
  • Has No Product - show the pop-up if a client does not own at least one active product from the selected ones.
  • Has No Addon - show the pop-up if a client does not own at least one active addon from the selected ones.
  • Has No TLD - show the pop-up if a client does not own at least one active domain with one of the selected TLDs.
  • Has Active Product With Server - show the pop-up if a client has at least one active product with one of the selected servers assigned.

If any of the above options is left blank, it will not be taken into consideration when creating a final list of clients to see the pop-up.

CAP 15.png
You will also find there an explanation of the checking process:
CAP 16.png

Timing

In the last section define time period within which the pop-up shall be active - when it will be displayed with the set up previously frequency.

Choose a specific day and time to schedule the pop-up activation or select option 'Immediately' - then the pop-up will be active once you have saved the changes.

Set up ending date in the same way. Provide specific date when the pop-up will be marked as 'Inactive'.
You may also select 'Never' option, if you do not want it to be deactivated.

CAP 17.png
Press 'Save' button once you have finished the configuration.
CAP 18.png

Pop-ups

The first and main section of the module is called 'Pop-ups'.

You will find there all the most important information on existing pop-ups together with any possible action that can be taken on them.
Go through the following section to learn more.

CAP 19.png

Actions

1. Preview the pop-up - a sample page with a visible pop-up will appear. This is the final look a client will receive.
2. Edit the pop-up - change the restrictions, timing or style.
3. Set the pop-up as inactive, it will be moved to 'Inactive' tab.
4. Move the pop-up to archive, you will be able to restore it at any time in the future.
5. Delete the pop-up. You must be completely sure, you will not be able to have it back in any way.
6. You may also perform bulk actions on multiple selected entries simultaneously.

CAP 20.png

Types

There are three types of pop-ups in the system:
  • Active
  • Inactive
  • Archived
CAP 21.png
Inactive pop-ups are those for which the end date has been exceeded and they are no longer displayed to clients.

Just like in case of active pop-ups all actions are available. You may edit it to change the end date and at the same time activate it again.

CAP 22.png
Pop-ups in archive are moved there manually, these can be the previously active or inactive pop-ups (use action button to move entry to 'Archive').

You may restore archived pop-ups any time and, depending on the end date of the resorted pop-up, it will be moved either to 'Active' or 'Inactive' group.

CAP 23.png

Styles

'Styles' section contains a list of all predefined styles, that position your pop-ups.
There are 26 types of different styles, that vary from one another with up or down position, right/left/center, overlay option etc.
CAP 24.png
Before you start using any of the styles you can see their preview in the client area.

See the visualization here.

CAP 24 2.png
If none of the predefined styles perfectly matches your needs, you may edit the styles..

Press the icon as marked on the screen.

CAP 25.png
You are moved to the style edition page with CSS and HTML details. You may edit them if you need to adjust the style to your preferences.
CAP 26.png

New Style

In case the predefined styles are not sufficient and you do not want to lose any by editing its content, you may always add a new style.
Press the button as on the screen to do so.
CAP 26 1.png
Provide your customized content or copy and modify a predefined style content.

Subsequently save the changes.

CAP 26 2.png

Documentation

The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
CAP 27.png

Visualizations

Now, let's take a look what Client Area Popup For WHMCS may give you in practice.
Underneath, you will find several examples of pup-ups, each in a different style and of a different type.
Type: 'Text'
Style: 'left_up'
CAP 28.png
Type: 'Text'
Style: 'center_overlay'

'Overlay' means there is a gray background behind the pop-up text or image.

CAP 29.png
Type: 'Image',
Style: 'center'
CAP 30.png
Type: 'Image',
Style: 'right_overlay_up'
CAP 31.png

Tips

1. For your comfort, 'HTML' type of pop-up content supports also 'JavaScript' to let you provide your preferable content.
2. The module is ad blocker resistant unless your clients block the popup class deliberately in the tool.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you encounter an error like on the below screen, please make sure you have successfully completed step 6 of the installation instructions.
CAP 32.png
3. If you have problems with your license, please make sure that the content of the file is correct.

Please note that for Client Area Popup For WHMCS V1.0.1 and later the license key begins with:

$client_area_popup_licensekey="ModulesGarden_ClientAreaPopup_W_XXXXXXXXXXXX"; 

Not as it was for the previous version:

$popup_module_licensekey="ModulesGarden_ClientAreaPopup_W_XXXXXXXXXXXX"; 
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Client Area Popup For WHMCS