Skip to end of metadata
Go to start of metadata

 

Icon

Having hard time finding an answer to your question?

Check out our Knowledge Base.

 

Extension page: http://ecommerce.aheadworks.com/magento-extensions/popup.html


The Pop-Up+ extension by aheadWorks is a perfect solution for those who want to notify their customers about something special. The extension allows you to display some useful and important information at your store pages via pop-ups.


Installation

1. Backup your web directory and store database.

 Click to view details

You can make backup copies with any tool you find appropriate

If you are going to use the native Magento backup function, navigate to System -> Tools -> Backups and perform System and Database backups

 2. Log in to the Magento backend

 3. Disable compilation

 Click to view details

Navigate to System -> Tools -> Compilation.

If Compiler status is Disabled, you can skip to the next step

If Compiler is enabled, disable it.

IMPORTANT: after the extension is installed, you can enable the compilation again; IT IS CRUCIAL that you use "Run Compilation Process" function, not just "Enable button"

Icon

Installing an extension with the Compilation enabled will result in store downtime.

 4. Flush store cache

 Click to view details

You can flush the store cache in 2 ways:

  • via the backend:

Navigate to System -> Cache Management menu, and click Flush Magento Cache button

  • via filesystem:

On your server, navigate to Magento root folder, then proceed to /var/cache/; delete all the content there.

 5. Download the extension package from your account and extract the downloaded archive

 6. Copy the content of /Step_1/ folder to your store's root directory

If you are using a custom theme,

Icon
 read the instructions here.

The extension comes with 2 design packages: /base/default/ and /rwd/default/ .

In case you are using a custom theme, it is recommended to copy the design files to your current theme's folders. In case there are several themes in use at the same store, the design files must be copied to each of them.

  • Find this folder in the package: /step_1/app/design/frontend/base/default/ ; copy its content to /app/design/frontend/[your_package]/[your_theme]/
  • Find this folder in the package: /step_1/skin/frontend/base/default/ ; copy its content to /skin/frontend/[your_package]/[your_theme]/

 7. Copy the content of /Step_2/ folder to your store's root directory

 8. Flush store cache again; log out from the backend and log in again.



 

Configuration

General settings

To configure the extension, go to the System > Configuration > aheadWorks Extensions > Popup or CMS > Popup management > Settings backend page. Here you can define after which period of time this popup will disappear. Also here you can set the default alignment for a popup and cookies lifetime.

Interface Settings tab:

  • Hide automatically in seconds - defines the delay before the pop-up will be automatically closed.
  • Default popup position - defines the default vertical screen position (Top, Middle, Bottom)
  • Cookies lifetime, seconds - sets the extension's cookie lifetime

    Icon
     What are the cookies for?

    The Pop-Up+ extension uses cookies to disable pop-ups for the users who have already viewed them

    When a visitor sees a given pop-up for the 1st time, a cookie is set in their browser. As long as this cookie is present, the customer won't see this very pop-up again (all the other pop-up instances at the store will be displayed)

    After a cookie expires (or the customer manually clears the browser cookies), the pop-up will be displayed once again.

    The same cookie is also used to count the number of per-visitor pop-up shows.

Show settings tab:

  • Hide popup if User-Agent matches - disables pop-ups display for the selected user agents.

 

 


 

Managing Pop-Ups

The pop-ups can be managed in the CMS-> Popup management-> List popups backend grid. New pop-ups can be added via Add New button in this grid, or, directly through the menu entry CMS-> Popup management-> Add new


General tab

 

Name, Date From-To, Storeview and Status are standard options. See extension-specific settings description below:

 

  • Display At - this option defines the pop-up display mode:

    • Specified Pages - the pop-up will be displayed in certain store areas;

      Icon
       How do I select the target areas?

      You should just select the necessary rows in the Show At selector below.

      E.g., if Show at = "Category View" , the pop-up will be displayed on all the categories



    • Specified URL - the pop-up will be displayed on the certain page.

      Icon
       How do I define the target page?

      You should specify the URL key in the Display popup only if page URL contains field. The pop-up will be shown on all the pages that have the specified text in their URL.

     

  • Align - defines the pop-up screen position (Top, Middle, Bottom). Overrides the Default popup position option
  • General number of shows - restricts the maximum number of displays of this given pop-up
  • Number of shows per customer - restricts the maximum number of displays for a given visitor
  • Number of times popup was shown - once you save an activate a new pop-up, this counter will show the total number of pop-up displays.
  • Width, px and Height, px - define the popup dimensions
  • Sort order - defines the pop-up priority

 

 

Content tab

 

In this tab, you can create the actual content of the pop-up window, via Magento WYSIWYG editor or in plain html code.

 

The Pop-Up+ extension supports any kind of content allowed for the standard Magento CMS static blocks.


Market Segmentation Suite integration

The Pop-Up+ module is integrated with Market Segmentation Suite extension. If the latter is installed, you will have an option to link a pop-up to an MSS rule. In this case, this very pop-up will only be displayed if the MSS rule conditions are met.

Icon
 Click to see the screenshot

 

 

 


 

Uninstallation


If you just need to temporary disable the extension, you can just do the steps 1-5, without deleting the files of the extension.

  1. Disable compilation, in case it is enabled.
  2. Login to your FTP, navigate to app/etc/modules/
  3. Open the file AW_Popup.xml and change the following line:

     

    <active>true</active>

     

    to

     

    <active>false</active>

     

    Now your Magento is unaware of the existence of this module.

  4. Clear the cache under var/cache
  5. Make sure that the site is working properly, otherwise roll back the changes and apply to our technical support.
  6. If everything works fine, it is safe to delete the files of the extension.
  7. In case you need to clean the database, backup your database and then run the following queries in MySQL: 

     

     

     

    delete from core_resource where code ='popup_setup'

     

    Note, if you are using the table with prefixes, you must specify them in all table names. 

    If you are not sure how to do that or expect any troubles with it, please contact your server administrator regarding the matter.
    If you remove the tables as it is described above, you will need to create all popups again after the extension is reinstalled. 


Troubleshooting

After the extension installation the store gives an error, or blank page, or suggests to start Magento installation procedure.

Change the owner of the extracted extension files to the web server user and set 775 permissions on them. Clear the store cache and try again.

There is no aheadWorks extensions under my configuration section, or having the extension tab clicked I get a blank page, or Access Denied error.

Clear the store cache, browser cookies, logout and login again.

I've set up everything correctly, inserted the HTML code but there is nothing on that page.

Clear the store cache, clear your browser cache and domain cookies and refresh the page.

My configuration changes do not appear on the store.

 Clear the store cache, clear your browser cache and domain cookies and refresh the page.



You can always find the latest version of the software, full documentation, demos, screenshots and reviews at http://ecommerce.aheadworks.com
License agreement: http://ecommerce.aheadworks.com/LICENSE-M1.txt
Contact us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2015 aheadWorks  http://www.aheadworks.com

 

  • No labels