SMSNotify Extension. User Documentation. Automated SMS sender and customer relationship tool. SMSNotify User Documentation 1

Transcription

1 SMSNotify Extension User Documentation Automated SMS sender and customer relationship tool SMSNotify User Documentation 1

2 Contents: 1. Extension overview and features Installation process Configuration and work flow description. SMS gateways Front-end templates and custom themes Contacts...10 SMSNotify User Documentation 2

3 Chapter 1. Extension overview and features The SMSNotify extension is a powerful automated SMS sender and customer relationship tool. Using this automated Magento module, your customers will be notified about their orders' statuses changing. Just create specific rules and they will receive SMS notifications as needed based on specified criteria. Features: Unlimited number of tiers in SMS Queue Unlimited number of rules Flexible rules - send as many messages as needed based on specified criteria Ability to preview and send/delete/cancel messages manually Ability to specify countries for which SMS notification is allowed Ability of ISO Character set Conversion To ISO Ability to specify Sender Name, SMS Max Length Allow to turn on Debug mode. The data of all SMS notification will be stored in the system log file. Supports Transaction templates to be used as SMS templates SMSNotify extension is provided as.zip archive that contains Magepilot license agreement and files that should be included to your Magento installation. Please, attentively read Magepilot license agreement before installation. SMSNotify User Documentation 3

4 Chapter 2. Installation process Follow the recommendations below to be sure the everything is installed correctly. Caution! Please, make a backup copy of your Magento files and database before installation. This is a standard security procedure before installing any extensions. Note that in order to be able to install SMS-Notify extension for your Magento store you should have write access to Magento folder (i.e. where app/, media/ and other Magento folders are). Please, do not perform any actions in admin panel while installing extension this guarantees that installation process will pass without any contingencies. Follow the next steps to install SMSNotify extension: 1) disable Magento cache in System Cache management: select all cache types and use disable action. Alternatively you can delete [path_to_magento]/var/cache/ folder; 2) upload.zip archive to your server; 3) extract archive files. If you use terminal (console), use a command like unzip SMSNotify_[your_domain].zip. You should have unzip installed in order to be able to extract.zip archives. 4) Move app/ folder from the extracted files to the root folder of your Magento store (mv [path_to_files]/smsnotify_[yourdomain]/app/[path_to_magento]/app/). Note: You can also extract files on your computer and upload app/ folder via FTP particularly to Magento root folder; 5) confirm files replacing*; 6) logout from admin panel and login again. This allows Magento to install extension and to use new settings and additional routers for admin panel. 7) turn on cache in System Cache management section (if needed). Now you will see SMS Notify menu in the top of Magento dashboard. This means installation have been completed successfully. So, the installation is completed. Now you can proceed to configuring extension. *See Chapter 4. Front-end templates and custom themes. for additional information. SMSNotify User Documentation 4

5 Chapter 3. Configuration and work flow description. SMS gateways This chapter describes main extension's settings and different features that may be needed to customize it. The general work flow is described below. After installing the SMS Notify Extension you will have to fill base settings for the extension to get access to SMS gateways. After that you may create SMS templates (you get a few pre-installed) and define after which events notifications should be sent. From then on each time the event fires extension will add notification to queue and process it if needed. You can change notification status or delete it manually if needed. Let's overview the base principles of how SMS Notify extension may be configured. SMS Notify General settings General extension settings can be accessed through System Configuration Sms Notify or SMS Notify Settings menu. Let's overview all possible settings: 1) SMS gateway is the website through which SMS is sent. For now extension supports the next gateway by defaults: a) Kapow! (UK); b) SMS Global (Worldwide); c) Txtlocal (UK); d) Clickatell (Worldwide); e) Posta Guvercini (Asia). 2) User, Password. Use your gateway credentials for the extension to get access to gateway services. 3) For some gateways you should additionally specify API Key in addition to User name and Password. 4) Mobile Code from Allow Specific Countries, Mobile Code from Specific Countries, Default Country - as a standard Magento feature you can choose countries to which SMS notifications can be sent*. 5) Drop leading zeros option allows to remove unnecessary zeros from the mobile numbers for the countries where this option is needed. For example, Netherlands code is *For now only one gateway can be assigned to all counties. Specific gateways for different countries will be implemented in the next version of SMS Notify extension , but the gateway SMS Global won't send SMS with this code - it should be SMSNotify User Documentation 5

6 +316 (without 0). 6) ISO Charset Conversion To ISO More information on this topic is here: php encoding conversion. 7) Sender name - specify sender name. 8) SMS Max Length - specify maximal SMS length in characters. 9) Debug mode - this function allows to store all SMS in system log file so you can get important data or check something later. 10) Event Enable - enable extension. This option is set to yes by default. SMS Notify Manage Rules This is a section for creating new rules to send SMS. Here you can perform mass actions on SMS or create new / update existing ones. SMS Notify Manage Rules Add new rule General tab Each SMS consists of the next attributes: 1) Title - simply rule name, nothing more. 2) Status - enable / disable event; 3) Event - event that fires sending SMS 4) SMS Notify Time Delay - Time delay after which SMS will be sent. Here you can create SMS queue to sent a few notification with some delay between them. Note that SMS will be sent even if the order changes it's status. Different templates can be assigned for separate notifications in the queue. SMS Notify Manage Rules Add new rule Stores tab Here you can choose to which store you want to apply newly created configuration. SMS Notify SMS Notify Queue In this section you can find all notifications and their status. Base management of notifications consists of the next possibilities: a) view: View SMS what will be send by schedule; b) cancel: Cancel sending SMS with ready status; c) delete: Delete SMS from queue; d) send Now: Send SMS immediately. By viewing notification you can get more information on it such as Order Number, Message text etc. SMSNotify User Documentation 6

7 SMS templates SMS templates doesn't have their own section in admin panel. Instead of this SMS templates are the part of Transactional templates - core Magento functionality for customers' notifications. New template section gives you an opportunity to easily create your own template or to modify an existing one. Good news is that all built-in and custom Magento variables for transactional s are also available for SMS notifications. You can use variables such as order, invoice, shipment, store information etc. Remember that each template name should start with the word SMS. Change customer's SMS number You can see customer's SMS number at order information page in back-end. Just click Edit to manage SMS number. On Edit page you can see old SMS number and field for new SMS number. You can see SMS Queue for this order on also Edit page. Development license You can install SMS Notify extension on development server and you don't need additional license if your domain name looks like this: test.[your domain].com dev.[your domain].com SMSNotify User Documentation 7

8 Chapter 4. Front-end templates and custom themes. SMSNotify extension interacts with default Magento templates in order to give customers an ability to add mobile phone to their profile or to order information. By default the following files are added / replaced: app/design/frontend/default/default/template/customer/address/edit.phtml app/design/frontend/default/default/template/checkout/onepage/billing.phtml In the case these templates were changed already it may be better not to replace them. If you want to use SMSNotify extension with custom themes or modified templates than you should add the following code to customer/address/edit.phtml template or to the template that replaces it: <!-- START: Mobile Number --> <li class="fields"> <div class="field"> <label for="dvsms_mobile_code"><?php echo $this-> ('Mobile Phone Code')?></label> <div class="input-box"> <?php echo Mage::getModel('smsnotify/block')- >getmobilecodehtmlselect($this->getlayout(), $this->getaddress(), 'dvsms_mobile_code', 'dvsms_mobile_code')?> <div class="field"> <label for="dvsms_mobile"><?php echo $this-> ('Mobile Number')? ><span style="font-size: 10px;"> (<?php echo $this-> ('Required field for SMSnotification; for example:')?> )</span></label> <div class="input-box"> <input type="text" name="dvsms_mobile" value="<?php echo $this- >htmlescape($this->getaddress()->getdvsmsmobile())?>" class="input-text" title="<? SMSNotify User Documentation 8

9 php echo $this-> ('Mobile Number')?>" id="dvsms_mobile" /> </li> <!-- END: Mobile Number --> and the following one to checkout/onepage/billing.phtml: <!-- START: Mobile Number --> <li class="fields"> <div class="field"> <label for="billing:dvsms_mobile_code"><?php echo $this- > ('Mobile Phone Code')?></label> <div class="input-box"> <?php echo Mage::getModel('smsnotify/block')- >getmobilecodehtmlselect($this->getlayout(), $this->getaddress(), 'billing:dvsms_mobile_code', 'billing[dvsms_mobile_code]')?> <div class="field"> <label for="billing:dvsms_mobile"><?php echo $this-> ('Mobile Number')?></label> <div class="input-box"> <input type="text" name="billing[dvsms_mobile]" value="<?php echo $this->htmlescape($this->getaddress()->getdvsmsmobile())?>" class="inputtext" title="<?php echo $this-> ('Mobile Number')?>" id="billing:dvsms_mobile" /> </li> <!-- END: Mobile Number SMSNotify User Documentation 9

10 Chapter 5. Contacts You can always contact us on through contact section. We are grateful for your reviews it's the best possibility for us get feedback from our customers and to make SMSNotify extension better than it is! SMSNotify User Documentation 10