DONATIONS ULTIMATE USER GUIDE 1
Important Notice MageWorx reserves the right to make corrections, modifications, enhancements, improvements, and other changes to its products and services at any time and to discontinue any product or service without notice. Customers should obtain the latest information before placing an order and should verify that such information is current and complete. All products are subject to the MageWorx terms and conditions of sale supplied at the time of order acknowledgment. MageWorx warrants performance of its products to the specifications applicable at the time of sale in accordance with the company s standard warranty. Testing and other quality control techniques are used to the extent MageWorx deems necessary to support this warranty. Except where mandated by government requirements, testing of all parameters of each product is not necessarily performed. MageWorx assumes no liability for applications assistance or customer product design. Customers are responsible for their products and applications using MageWorx components. To minimize the risks associated with customer products and applications, customers should provide adequate design and operating safeguards. MageWorx does not warrant or represent that any license, either express or implied, is granted under any MageWorx patent right, copyright, mask work right, or other MageWorx intellectual property rights relating to any combination, machine, or process in which MageWorx products or services are used. Information published by MageWorx regarding third-party products or services does not constitute a license from MageWorx to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property of the third party, or a license from MageWorx under the patents or other intellectual property of MageWorx. Resale of MageWorx products or services with statements different from or beyond the parameters stated by MageWorx for that product or service voids all express and any implied warranties for the associated MageWorx product or service and is an unfair and deceptive business practice. MageWorx is not responsible or liable for any such statements. All company and brand products and service names are trademarks or registered trademarks of their respective holders. Copyright 2017 MageWorx DONATIONS ULTIMATE USER GUIDE 2
Table of Contents 1. Extension Description... 4 2. Extension Installation... 5 3. General Settings... 6 4. Donations Statistics... 7 5. Charity... 8 6. Product Donations... 9 7. Cart Donations... 11 8. CMS Donations... 12 9. Checkout Donations... 13 10. Other Features... 14 11. Support... 14 DONATIONS ULTIMATE USER GUIDE 3
1. Extension Description Magento Donations Ultimate extension allows you to add a donation block/link to any product and CMS page and accept donations from your customers. Donation can be added to the order s total from a product page (from the customer s shopping cart), from a CMS page or directly on the last checkout step. Charity - Create the list of charity organizations customers can donate to. Add a detailed description and upload logos of each charity. Set the minimum donated sum. Track the amount each charity collects. Product Donations - Add a donation block/link to any product page. Specify donation products. Cart Donations - Let customers select charities right on the cart page. Choose one of the 6 predefined positions for the donations block placement. Checkout Donations - Accept donations during the checkout. Enable Automatic Round Up feature to calculate the donation amount as a rounding of an order s total. Customize a donate-to-charity message. CMS/Static block Donations - Let customers donate without buying. Add a donation link or block to any CMS page or Static block. Donations Reports - Check the number of customers donated & the total donation amount. Export the report in.xml and.csv formats. DONATIONS ULTIMATE USER GUIDE 4
2. Extension Installation To install the extension, please follow the steps below: 1. Disable the Compilation Mode (if enabled) 2. Log out from Magento Admin Panel (if logged in) 3. Unpack the contents of the Extension folder (depending on your current Magento version) from the package file purchased from Mageworx to your Magento root folder 4. Log into Magento Admin Panel 5. Go to System Cache Management section, choose Refresh under the All Cache dropdown menu and press the Save Cache Settings (if Cache Control is enabled in Magento) 6. Run the Compilation Mode back if necessary (not enable but run it) 7. Go to System Configuration MageWorx tab Extensions & Support section. If you see Donations Ultimate in the list of installed MageWorx extensions, the installation is done. DONATIONS ULTIMATE USER GUIDE 5
3. General Settings To configure the extension, log into Magento Admin panel and go to System Configuration MAGEWORX Donations section. Here is what each setting does: Accept Donations - enables/disables donation functionality on your site. Accept Cart Donations - enables/disables a donations block on the cart page. Cart Donations Block Position - specifies the position of a donations block on the cart page. You can select any preferable position of the donation block on the cart page. Accept Product Donations - allows accepting donations on the product page. Add Border on Product Page - adds/hides the border for the donations block on the product page. Enable Charity - enables/disables charity functionality on your site. Default Charity - defines the default charity, that will be preselected on the front-end. Charity Image - specifies the size of a charity logo. Enable Automatic Round Up - calculates the donation amount as a rounding of an order s decimal part to the whole number during the checkout. If enabled, customers will see a check-box Donation to on the last checkout step. Minimal Donation - specifies the value of a minimum donation value. Automatic Round Up Message - a message, which will be displayed to the customers on the last checkout step in case of an automatic donation is enabled. Donation Product - specifies a donation product to be used when customers add donations from CMS pages without purchasing other products. DONATIONS ULTIMATE USER GUIDE 6
4. Donations Statistics To check a report for all orders with donations, go to Sales Donations Statistics: The report contains the following data: an order s ID and date, a Store View paid from, a customer s name, a donation amount and a charity (if applicable), an order s status and a link to view this order in the back-end. The statistics calculates and displays a number of customers, who donated and a total donation amount with the percentage of a site total: DONATIONS ULTIMATE USER GUIDE 7
5. Charity To add or edit the charities section, go to Sales Donations - Charity: The following information is available here: the list of organizations, the date when the charity campaign was added, the sum each charity collected. To add a new charity you should click on the Add Charity button: Under these settings you can specify the name of the charity and its description, upload a logo, define the sort order and the status of this charity. Note! HTML code is allowed in the description. Charities will be included in the the pop-up customers see when clicking the Add Donation link (on a product or CMS page): DONATIONS ULTIMATE USER GUIDE 8
From here, customers can select a charity they want to donate to, specify a donation amount or remove the donation. Charities are also available on the cart page: Admin can select charities when creating orders manually on the back-end or editing already placed orders. 6. Product Donations To add the Add Donation link to product pages, go to System - Configuration - Donations and accept product donations: DONATIONS ULTIMATE USER GUIDE 9
On the front-end customers will see the link right under the product description: If the charities are enabled and added, the Add Donation link will open the pop-up window. Here customers can select a charity and add a donation for it: If the charities are disabled or you didn t add any charity, the link will expand the fields for adding a donation directly on the product page: DONATIONS ULTIMATE USER GUIDE 10
Note! Customers can donate without purchasing anything from your store. In this case, a donation product will be added to the cart (this product is created in the extension s settings). 7. Cart Donations To add donations directly on the cart page, go to System - Configuration - Donations and select to accept cart donations. Choose one of the 6 predefined positions for the donations block placement (to adjust the block to your custom template). DONATIONS ULTIMATE USER GUIDE 11
8. CMS Donations To add the donation link to any CMS page, use the following code: {{block type="donations/donation"template="donations/cart_donation.phtml"}} {{block type="donations/donation" template="donations/product_donation.phtml"}} <a onclick="donations.togglepopup()">add Donation</a> Add Donation link on the CMS page behaves the same way as it does on the product page. To add the donation block, insert the same code: {{block type="donations/donation"template="donations/cart_donation.phtml"}} {{block type="donations/donation" template="donations/product_donation.phtml"}} <a onclick="donations.togglepopup()">add Donation</a> BUT! disable the charity setting in System - Configuration - Donations: DONATIONS ULTIMATE USER GUIDE 12
9. Checkout Donations To accept checkout donations, go to System - Configuration - Donations and enable the Automatic Round Up setting and specify the Automatic Round Up message. If enabled, the customers will see the check-box on the last checkout step offering to donate a rounding of the order s total. For example, if the order s total is $14.45 the donation amount will be $0.55. To change the charity and the donation amount, hit the change link: DONATIONS ULTIMATE USER GUIDE 13
10. Other Features Donations are kept when editing orders in the back-end Donations are available when creating orders manually in the back-end You can keep or refund the donations in credit memos Donations Ultimate supports multi-stores 11. Support GOT QUESTIONS? MageWorx offers FREE lifetime support and updates for any extension developed for Magento. If you need support related to MageWorx extension usage, feel free submit a ticket from http://support.mageworx.com GETTING HELP WITH MAGENTO MageWorx offers outstanding services developing custom tailored solutions for Magento platform to attain your ecommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe. You are most welcome to contact us at sales@mageworx.com DONATIONS ULTIMATE USER GUIDE 14