Advanced Newsletter Getting Started. How to install extension. How to upgrade extension

Size: px

Start display at page:

Download "Advanced Newsletter Getting Started. How to install extension. How to upgrade extension"

Everett Kenneth Hubbard
6 years ago
Views:

1 Advanced Newsletter Getting Started Welcome to the Advanced Newsletter Documentation. Whether you are new or an advanced user, you can find useful information here. Next steps: How to install extension Configuration Settings How to install extension 1. Login to Magento backend. 2. Go to System > Tools > Compilations. If Compiler Status is Enabled, disable the compilation by clicking the button Disable in the upper right corner. 3. Backup your store database and web directory. 4. Download extension from your Personal Account. 5. Unzip the extension locally. 6. Copy contents of the folder step1 to the root directory of Magento store. 7. Copy contents of the folder step2 to the root directory of Magento store. 8. Completely clear the site cache. Go to System > Cache Management. Click button Flush Magento Cache. If you want to clear the cache manually, you need to remove a folder /var/cache at the server. 9. Logout from Magento backend and login again. 10. Setup a cron job for Magento. See How to Setup Cron for Magento. 11. Go to System > Configuration > Mirasvit Extensions > System, at form Installed Extensions press the button Run validation tests for all extensions for check extension installation and configuration. 12. If compilation was enabled before installation, you need to run recompilation process to enable compilation. Go to System > Tools > Compilation and click on Run Compilation Process. If you did not disable compilation and store is down after installation, follow the link and make next steps to recover the store. Next steps: How to Setup Cron for Magento Configuration settings How to upgrade extension

2 To upgrade extension follow next steps: 1. Login to Magento backend. 2. Go to System > Tools > Compilations. If Compiler Status is Enabled, disable the compilation by clicking the button Disable in the upper right corner. 3. Backup your store database and web directory. If you have customizations, please, create a separate backup of app/code/local/mirasvit before upgrading to the new version. 4. Download new extension package from your Personal Account. 5. Unzip the extension locally. 6. Temporary disable extension. Check Temporary Disabling. 7. Copy contents of the folder step1 to the root directory of Magento store. 8. Copy contents of the folder step2 to the root directory of Magento store. 9. Completely clear the site cache. Go to System > Cache Management. Click button Flush Magento Cache. If you want to clear the cache manually, you need to remove a folder /var/cache at the server. 10. Logout from Magento backend and login again. 11. If necessary adjust css styles to fit your store's frontend theme. 12. If compilation was enabled before upgrade, you need to run recompilation process to enable compilation. Go to System > Tools > Compilation and click on Run Compilation Process. If you did not disable compilation and store is down after installation, follow the link and make next steps to recover the store. Temporary Disabling To temporary disable extension please follow the next steps: Disable Compilation Mode (if enabled). Remove file app/etc/modules/mirasvit_advn.xml. If you have only one extension from Mirasvit installed, remove file app/etc/modules/mirasvit_mstcore.xml. Login in to Magento back-end and refresh site cache (if enabled). Extension Removing To uninstall extension please follow the next steps: Disable Compilation Mode (if enabled). Remove file app/etc/modules/mirasvit_advn.xml. If you have only one extension from Mirasvit installed, remove file app/etc/modules/mirasvit_mstcore.xml. Login in to Magento back-end and refresh site cache (if enabled). Remove folder app/code/local/mirasvit/advn.

3 How to Setup Cron for Magento Setting Up a Newsletter Newsletter, is one of the main entitites of the extension (another one is a subscriber). In general, the newsletter is regularly distributed publication that covers a topic which is of interest to its subscribers. To create a new newsletter, follow these steps: 1. Go to Advanced Newsletter > Manage Newsletter. Press button Add New 2. Enter all the required values there: General Information Title - the name of a newsletter. Status - newsletter status. You can select one of the following statuses: Draft - newsletter will not be sent. Scheduled - newsletter is ready to be delivered. Sending - newsletter delivery has been started and happening right now. Sent - newsletter had already been delivered. Paused - temporarily suspend delivery of newsletter s. Scheduled On - a planned start date of sending a newsletter. Groups - groups of a newsletter. Stores - the store view, for which will be sent a newsletter. Template From Name - sender name From Address - sender address Subject - subject for newsletter Template - template used for newsletter 3. Press Save. 4. After saving the newsletter, you can test newsletter. At the grid of newsletters the following fields are available for viewing: Title - name of a newsletter. Status - current status of a newsletter. Groups - groups of a newsletter. Stores - the store view, for which will be sent newsletter. Start At - start date of sending a newsletter. Info - some information and report data on a newsletter. Click on the newsletter and you will see detailed information about newsletter at the next tabs: General information, Template, Tracking, Report. The extension automatically removes the 30 days old s from this section.

4 Template To edit newsletter template, follow these steps: 1. Go to Advanced Newsletter > Manage Newsletter. Open newsletter and go to the tab Template 2. Enter all the required values there: From Name - the name of a sender. From Address - sender . Subject - newsletter subject. Template - template used for newsletter. Other fields match and depend on the editable areas available at the selected template. Here you can edit the content of these areas. Under the fields you can find a preview of an template, to make it visible just start edit one of the editable areas.

6 Tracking Extension allows to analyze number of visits, conversion rate, number of clicks. Google Analytics should be configured and activated in order to use this feature. To configure Google Analytics Campaign, follow these steps: 1. Go to Advanced Newsletter > Manage Newsletters. Click on newsletter from the list. Select the Tracking tab. 2. Fill in 3 required fields: Campaign Source - Identifies a search engine, newsletter name, or other source.(i.e. , follow-up- , newsletter) Campaign Medium - Identifies a medium such as or cost-per-click. (i.e. cpc, banner, newsletter ) Campaign Name - Identifies a specific product promotion or strategic campaign. (i.e product, promo code, or slogan) Also, you can optionally fill in optional fields: Campaign Term - Identifies paid keywords Campaign Content - Differentiates ads or links that point to the same URL 3. Save the newsletter. After configuring Google Analytics Campaign, extension will automaticaly add special get params to all links in s. Thus, you don't need to do additional configuration adjustments. (i.e. url will be converted to To track Google Analytics Campaign log in into your account and go to Traffic Sources > Campaigns. Select campaign source from the list. For more information about Google Campaigns, see Google Custom Campaigns and Campaigns & Traffic Sources

7 Report On this tab you can find some report information on a specific newsletter, specifically: Number of unique readers - number of unique subscribers who opened the received from you. Number of visits from newsletter - number of unique clicks on links in a newsletter made by your subscribers. Number of orders - number of orders placed by your subscribers after they click on links in a

8 newsletter. For more detailed and precise information about the sent s we recommend you to configure Google Analytics. Testing the newsletter To test newsletter follow these steps: 1. Go to Advanced Newsletter > Manage Newsletters and open newsletter. 2. At top right corner press Send Test 3. Fill your address and press Send 4. Extension will send an associated with the newsletter for each selected store For test , extension will generate test data based on current customers Manage Subscriber Groups Groups, allows you to segment your subscribers by interests. To create a new group, follow these steps: 1. Go to Advanced Newsletter > Groups > Manage Groups. Press button Add New 2. Input all needed values there: Title - the name of a group. Code - the unique code of a group. Position - position of a group within list of groups. Stores - the store view at which group will be visible. Is Visible at Frontend - set Yes to make a group visible at frontend for customers, or set No to not allow customers select this group. Is Default - allows to assign a group to a subscriber by default. 3. Press Save.

9 Auto Management Rules Rules, allows you to dynamically move your subscribers between different groups based on specified conditions. To create a new Rule, follow these steps: 1. Go to Advanced Newsletter > Groups > Auto-Management Rules. Press button Add New 2. Input all needed values there: General: Title - the name of a rule Is Active Conditions - here you can set up conditions for the Rule Actions: Remove subscriber from - if the specified conditions are met a subscriber is removed from selected group(s) Add subscriber to - if the specified conditions are met a subscriber is added to the selected group(s) 3. Press Save. The rules are applied automatically by cron once a day at 1 a.m., however, you can apply the rules manually, for this press the button Apply

10 Setting Up an Template To create a new template, follow these steps: 1. Go to Advanced Newsletter > Templates > Manage Templates. Press button Add Template 2. Input all needed values there: Name - the name of template. Description Design - the one of defined designes. Subject - the subject of . In subject you can use variables. 3. Press Save. 4. Open saved template. 5. Depends on desing, you can fill content areas.

12 List of Methods Global Methods getunsubscribeurl - a direct link to unsubscribe from newsletter Subscriber will be unsubscribed from all newsletters. Usage: <a href="<?php echo $this->getunsubscribeurl()?>">unsubscribe</a> getviewinbrowserurl - a direct link to open in browser Usage: <a href="<?php echo $this- >getviewinbrowserurl()?>">view it in your browser.</a> getstoreurl - a direct link to store home page Usage: <?php echo $this->getstoreurl()?> getstorename - a curent store name Usage: <?php echo $this->getstorename()?> getstore - a curent sender address used for general contact at Store Addresses Usage: <?php echo $this->getstore ()?> getstorephone - a curent store contact telephone used at store information in general settings Usage: <?php echo $this->getstorephone()?> getstoreaddress - a curent store contact address used at store information in general settings Usage: <?php echo $this->getstoreaddress()?> getlogourl - a curent log image URL specified at the design section Usage: <?php echo $this- >getlogourl()?> getlogoalt - a curent log image alt specified at the design section Usage: <?php echo $this- >getlogoalt()?> Subscriber Methods getfullname - returns subscriber's full name Usage: Dear <?php echo $this->getfullname()?> getfirstname - returns subscriber's firstname Usage: Dear <?php echo $this->getfirstname()?> getlastname - returns subscriber's lastname Usage: Dear <?php echo $this->getlastname()?> getcustomername - returns customer's full name Usage: Dear <?php echo $this- >getcustomername()?> Setting Up an Design To create a new design, follow these steps: 1. Go to Advanced Newsletter > Templates > Manage Designs. Press button Add Design 2. Input all needed values there: Name - the name of design. Description Type - the content type HTML Text

Template - the template of design. In this textarea you need create html markup. You can use variables and methods inside design or template. Additionaly you can use directive <?

13 Template - the template of design. In this textarea you need create html markup. You can use variables and methods inside design or template. Additionaly you can use directive <?php echo $this->area('header_content')?> to create editable area in template, where header_content is a name of the area. 3. Press Save. Now you can use new design in your templates. General settings Go to System > Configuration > Mirasvit Extensions > Advanced Newsletters. Subscription Display subscription block at left sidebar (mainly on category pages) - if option enabled, subscription block will be displayed at the left sidebar Display subscription block at customer registration form - if option enabled, subscription block will be displayed at the customer registration page Synchronization Auto-synchronization with Magento newsletter

14 Enabled - if option enabled, extension will import native newsletter subscribers to Advanced Newsletter. Cron expression for synchronization - frequency used for automatic synchronization. Synchronization with MailChimp Advanced Newsletter allows to synchronize your account in MailChimp: Enabled - if option enabled, extension will synchronize with store MailChimp account. Auto-synchronization - if option enabled, store MailChimp account will be synchronized automatically. API Key - API Key of the store MailChimp account. To find your API Key, log in to MailChimp account and go to Account > Extras > Api Keys. XML-RPC URL - MailChimp API URL. At the moment MailChimp API version is 2.0, so you can use this API: For more information about MailChimp API, see MailChimp API Documentation You can also synchronize the subscribers manually at any time. Notification Settings Success Template Success Sender Confirmation Template Confirmation Sender Unsubscription Template Unsubscription Sender Configure SMTP In order to increase number of delivered letters and reduce number of letter going to spam we recommend to use aligned SMTP server. If for some reason your local mailing software is not good, we recommend to connect to the external SMTP server. For configure custom SMTP, follow these steps: 1. Go to System > Configuration > SMTP. 2. Set up options you need: Enabled - enable/disable custom SMTP server. Host - host or ip address of your smtp server. Port - the default port is 25, but some smtp server use a custom port. Authorization type - most of smtp servers need an authentication (login/password). Check it if required. Use SSL/TLS - checked it only if the smtp server need a secured connection (ssl, tsl) Login Password 3. Press Save Config

15 Example settings for GMail Smtp Enabled: Yes Host: smtp.gmail.com Port: 587 Authorization type: Login Use SSL/TLS: TLS Login: Password: Synchronization The extension allows to synchronize your subscribers, go to Advanced Newsletter > Synchronization. The following types of synchronization are available: 1. Synchronization with Magento newsletter: Import - Import native newsletter subscribers to Advanced Newsletter. 2. Synchronization with MailChimp: Import - Import subscribers from MailChimp to Advanced Newsletter. Export - Export Advanced Newsletter subscribers to MailChimp. In order to synchronize subscribers with MailChimp you should set up a connection between your subscriber's groups and MailChimp lists. After you enabled MailChimp synchronization and set an API key the new tab MailChimp appears at the Group edit page, where you can associate MailChimp list with current group. 3. Import CSV: Import - Import subscribers from CSV file to Advanced Newsletter. Required fields: Field delimiter used in a CSV file. CSV file used as the source of subscribers. You can use this CSV file as a template to import subscribers. In this template a semi-colon is used as the field delimiter. Change Log ( ) Improvements Increase default limit to fetch mailchimp lists to 100 by default ( ) Improvements New condition 'Customer: Billing Country'

16 ( ) Improvements Add information field to the newsletter edit page Reduce frequency of sending newsletter s ( ) Fixed Import subscribers from MailChimp to ADVN automatically (affects all) ( ) Improvements Add indexes to newsletter subscriber table ( ) Documentation Documentation for the extension ( ) Fixed Fix error 'Item with the same id already exist' (affects all) Improvements Populate subscriber with customer details automatically ( ) Improvements Option for disabling advn subscription block on left sidebar ( ) Fixed Fix problem with method 'getcustomername' Improvements Use subscriber to identify customer in rules Support of variables and methods from transactional s ( ) Fixed Correctly retrieve default store ID from within the admin panel

17 1.0.3 ( ) Improvements Ability to unselect groups at auto-management rules ( ) Fixed Issue with the tracking image in Gmail ( ) Fixed Problem with auto-management rules when adding or removing multiple groups ( ) Improvements New rule "Customer: Subscription status" Fixed Problem applying the rule 'Customer: is subscriber of newsletter' System config was renamed Unique name for cron job

Manual Getting Started. How to install extension

Manual Getting Started. How to install extension Manual Getting Started Welcome to the Banner Management System documentation. Whether you are new or an advanced user, you can find useful information here. Next steps: How to install extension Configure