Client Area Popup For Blesta

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Client Area Popup For Blesta

Client Area Popup For Blesta is an extension which allows you to design fully tailored pop-ups that will be seen by your clients in their panel.

Choosing from different formats: an image, raw or HTML text, create a pop-up that will reach your clients directly.
Compose it using predefined styles, which can always be adapted to suit your needs perfectly.

  • Admin Area Features:
✔ Create Pop-ups Using Predefined Styles
✔ Preview Pop-up With Single Click
✔ Archive Pop-ups For Latter Use
✔ View Pop-up Restrictions
✔ View Number of Pop-up Displays
✔ Create Styles To Be Used By Pop-up
  • 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 Services
✔ Required Active Products In Groups
✔ Required Active Services In Groups
✔ 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:
✔ Text
✔ HTML
✔ Image
  • General Info:
✔ Supports Default Bootstrap And Custom Blesta Templates
✔ Multi-Language Support
✔ Supports Blesta 3.6.2

Installation

This tutorial will show you how to successfully install and activate Client Area Popup For Blesta.

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

1. Log in to your client area and download the plugin.
CAPB1.png
2. Upload and extract the plugin into the main Blesta directory.

Files in your Blesta directory should look like this:

CAPB2.png
3. When you install Client Area Popup For Blesta for the first time you have to rename 'license_RENAME.php' file.

File is located in 'plugins/popup_module/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

CAPB3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'.

CAPB4.png
5. Set permissions to file: 'modules/addons/PopupModule/templates/clientarea/assets/popup' to '0777'.
Now, you have to install the extension in your Blesta system.

Log in to your Blesta staff panel and proceed to 'Settings' → 'Modules' → 'Available'.
Afterwards, find 'Client Area Popup' and press 'Install' button.

CAPB5.png
You have just successfully installed Client Area Popup For Blesta!
A new tab should now appear in your Blesta.
CAPB6.png

Configuration and Management

Client Area Popup For Blesta is an extension which enables you to inform your clients by showing them ready-made and tailored pop-ups directly in their panel.

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

Configuration

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

Create Pop-up

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

General

Start with naming the pop-up.
Note: the title will not be displayed in any way on the final pop-up.
CAB8.png
If you have already other pop-ups created, you may copy their settings to the newly created one to save a lot of time.

Finally, select the initial status:

  • Active - for enabled pop-ups.
  • Archived - for pop-ups awaiting activation in store.
CAPB9.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.

CAPB10.png
  • Type

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

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

See the visualization here.

CAPB12.png
Upload an 'Image'.

See the visualization here.

CAPB13.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 clients who meet all the restriction rules will 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 - select languages, the pop-up will be displayed only to clients who use any of the selected here languages.
  • User Groups - point groups, only clients in these groups will see the pop-up.
  • Has Active Product - select products that must be active.
  • Has Active Product In Group - select groups of products that a client has active products in.
    Note: At least one product in group is required.
  • Has Active TLDs - point TLDs that must be active for the client.
  • Has Active Product With Server - select servers on which client must have an active product.

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.

CAPB14.png
You will also find there an explanation of the checking process:
CAPB15.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 established.

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

In the same way set up ending date. Provide specific date when the pop-up will be marked as 'Inactive'.
You may also check 'Never' if you do not want it to be deactivated.

Press 'Save' button once you have finished the configuration.
CAPB16.png

Pop-ups

The first and main section of the extension 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 performed on them.
Read through the following section to learn more.

CAPB17.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. Move the pop-up to archive, you will be able to restore it at any time in the future.
4. Delete the entry. You must be completely sure, you will not be able to have it back in any way.

CAPB18.png

Types

There are three types of pop-ups in the system:
  • Active
  • Inactive
  • Archive
CAPB19.png
Inactive pop-ups are those for which the end date has been crossed 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.

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

CAPB21.png

Styles

'Styles' section contains a list of all predefined styles, that position your pop-ups.
There are 14 types of different styles, that vary from one another with up or down position, right/left/center, overlay option etc.
CAPB22.png
If non of the predefined styles perfectly matches your needs, you may edit the styles.

Press the icon as marked on the screen.

CAPB23.png
You are moved to the style edition page with CSS and HTML details. You may edit them as you need to adjust the style to your preferences.
CAPB24.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.
CAPB25.png
Provide your customized content or copy and modify a predefined style content.

Save the changes in the end.

CAPB26.png

Documentation

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

Visualizations

Now, let's take a look at what Client Area Popup For Blesta may give you in practice.
Below, you will find several examples of pup-ups, each in a different style and of a different type.
Type: 'Text'
Style: 'left_down'
CABP28.png
Type: 'Text'
Style: 'center_overlay'

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

CAPB30.png
Type: 'Image',
Style: 'right_overlay_up'
CAPB29.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 in the tool your clients block the popup class deliberately.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.

Configuration and Management

Client Area Popup For Blesta is an extension which enables you to inform your clients by showing them ready-made and tailored pop-ups directly in their panel.

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

Configuration

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

Create Pop-up

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

General

Start with naming the pop-up.
Note: the title will not be displayed in any way on the final pop-up.
CAB8.png
If you have already other pop-ups created, you may copy their settings to the newly created one to save a lot of time.

Finally, select the initial status:

  • Active - for enabled pop-ups.
  • Archived - for pop-ups awaiting activation in store.
CAPB9.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.

CAPB10.png
  • Type

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

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

See the visualization here.

CAPB12.png
Upload an 'Image'.

See the visualization here.

CAPB13.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 clients who meet all the restriction rules will 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 - select languages, the pop-up will be displayed only to clients who use any of the selected here languages.
  • User Groups - point groups, only clients in these groups will see the pop-up.
  • Has Active Product - select products that must be active.
  • Has Active Product In Group - select groups of products that a client has active products in.
    Note: At least one product in group is required.
  • Has Active TLDs - point TLDs that must be active for the client.
  • Has Active Product With Server - select servers on which client must have an active product.

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.

CAPB14.png
You will also find there an explanation of the checking process:
CAPB15.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 established.

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

In the same way set up ending date. Provide specific date when the pop-up will be marked as 'Inactive'.
You may also check 'Never' if you do not want it to be deactivated.

Press 'Save' button once you have finished the configuration.
CAPB16.png

Pop-ups

The first and main section of the extension 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 performed on them.
Read through the following section to learn more.

CAPB17.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. Move the pop-up to archive, you will be able to restore it at any time in the future.
4. Delete the entry. You must be completely sure, you will not be able to have it back in any way.

CAPB18.png

Types

There are three types of pop-ups in the system:
  • Active
  • Inactive
  • Archive
CAPB19.png
Inactive pop-ups are those for which the end date has been crossed 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.

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

CAPB21.png

Styles

'Styles' section contains a list of all predefined styles, that position your pop-ups.
There are 14 types of different styles, that vary from one another with up or down position, right/left/center, overlay option etc.
CAPB22.png
If non of the predefined styles perfectly matches your needs, you may edit the styles.

Press the icon as marked on the screen.

CAPB23.png
You are moved to the style edition page with CSS and HTML details. You may edit them as you need to adjust the style to your preferences.
CAPB24.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.
CAPB25.png
Provide your customized content or copy and modify a predefined style content.

Save the changes in the end.

CAPB26.png

Documentation

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

Visualizations

Now, let's take a look at what Client Area Popup For Blesta may give you in practice.
Below, you will find several examples of pup-ups, each in a different style and of a different type.
Type: 'Text'
Style: 'left_down'
CABP28.png
Type: 'Text'
Style: 'center_overlay'

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

CAPB30.png
Type: 'Image',
Style: 'right_overlay_up'
CAPB29.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 in the tool your clients block the popup class deliberately.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools
Namespaces

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