bubble dynamiccategory user guide v1.0

9
Bubble Dynamic Category for Magento User Guide Author: Johann Reinke Version: User Guide v1.0 (for Dynamic Category v2.x) Website: https://www.bubbleshop.net Support: [email protected]

Upload: rakib-hasan

Post on 09-Feb-2016

23 views

Category:

Documents


3 download

DESCRIPTION

Bubble Dynamiccategory User Guide v1.0

TRANSCRIPT

Page 1: Bubble Dynamiccategory User Guide v1.0

Bubble Dynamic Category for Magento

User Guide

Author: Johann Reinke

Version: User Guide v1.0 (for Dynamic Category v2.x)

Website: https://www.bubbleshop.net

Support: [email protected]

Page 2: Bubble Dynamiccategory User Guide v1.0

2

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

Table of Contents 1   Introducing Bubble Dynamic Category .................................................................................................................. 3  

1.1   Features ...................................................................................................................................................................................... 3  1.2   Compatibility ............................................................................................................................................................................. 3  

2   Installation ................................................................................................................................................................... 3  

3   Configuration ............................................................................................................................................................... 3  

4   How it works ................................................................................................................................................................ 4  

5   General Conditions ..................................................................................................................................................... 4  

6   Special Conditions ..................................................................................................................................................... 4  

6.1   Introduction ............................................................................................................................................................................... 4  6.2   Product Type ............................................................................................................................................................................. 5  6.3   In Promo ..................................................................................................................................................................................... 5  6.4   Special Price Applied ............................................................................................................................................................... 6  6.5   Total Child Products Quantity In Stock ................................................................................................................................ 6  6.6   Replace Matching Simple Products By Parent Products .................................................................................................. 6  

7   Import Category Conditions ..................................................................................................................................... 7  

8   Matching Products Indexation ................................................................................................................................. 7  

8.1   Scheduled Task ......................................................................................................................................................................... 7  8.2   Manual Indexation .................................................................................................................................................................... 7  

9   Frontend Navigation .................................................................................................................................................. 8  

10   Disable/Uninstall Extension ..................................................................................................................................... 8  

Page 3: Bubble Dynamiccategory User Guide v1.0

3

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

1 Introducing Bubble Dynamic Category

1.1 Features Bubble Dynamic Category comes with the following features:

• Define conditions by selecting any product attribute • Special conditions available to retrieve discounted and new products for example • Import conditions from another category • Automatic products indexation (cron task) • Respect coding standards • Easy & fast installation • 100% open source • No license key • 1 month of support period included

1.2 Compatibility Extension has been tested successfully on the following Magento versions:

• Magento CE 1.7.x, 1.8.x, 1.9.x. • Magento EE v1.14.x

2 Installation

• Backup your existing database • Download and unzip extension in your Magento root folder • Clear cache via “System > Cache Management > Flush Magento Cache” • Logout and login again to Magento Admin Panel (ACL refreshing)

3 Configuration

You can access the extension configuration via “System > Configuration > Bubble Dynamic Category > General Settings”:

Page 4: Bubble Dynamiccategory User Guide v1.0

4

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

4 How it works

With default Magento installation, you can only assign products to categories manually. Dynamic Category extension helps you defining some product conditions in order to retrieve products that you want to assign to the category you are modifying. You’ll be able to select or unselect matching products and, of course, to define custom products positions if needed.

The matching products are indexed for performance purpose. It means that if a product does not match the defined conditions anymore, you’ll have to wait until the scheduled task has finished (every 24 hours by default) for the product to be removed from the list. By the way, you can hit the Refresh Button manually and periodically if you want to force the list to be refreshed quickly.

5 General Conditions

If you are familiar to Magento Promotion Rules, you’ll be able to create products conditions easily because it works the same way. You just have to combine conditions bases on product attributes.

For example:

6 Special Conditions

6.1 Introduction In addition to default product conditions, Dynamic Category comes with very useful additional conditions that allow you to customize products conditions combination easily.

Page 5: Bubble Dynamiccategory User Guide v1.0

5

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

6.2 Product Type You can select one or multiple product types for matching products:

6.3 In Promo This condition uses the native price indexation table that is populated by Magento after Product Prices indexation process has finished. This table does not care how the product price has been modified. It can be due to a promotion rule, a special price applied or anything else that modifies product prices.

Page 6: Bubble Dynamiccategory User Guide v1.0

6

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

6.4 Special Price Applied This condition is different that the one above because it only checks if a product has a special price applied and does not verify promotion rules or another process that may modify product prices.

6.5 Total Child Products Quantity In Stock It is sometimes useful to filter configurable or grouped products by the quantity the assigned simple products have in stock. Note that each simple product quantity is added for each parent product.

Here is an example to retrieve all blue products that have more than 10 simple products in stock:

6.6 Replace Matching Simple Products By Parent Products This special condition is particularly useful when you have configurable products containing simple products and when the attribute values are stored in the simple products while you want to select parent products.

For example, retrieve parent products that have children with attribute color value Blue.

Keep Orphans: if a simple product does not have a parent product, it will be kept.

Discard Orphans: simple products that don’t have parent products will be removed.

Page 7: Bubble Dynamiccategory User Guide v1.0

7

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

7 Import Category Conditions

Another great feature of Dynamic Category extension is the possibility to import conditions from another category. It will save you some time when you have lots of conditions to reproduce. Do not forget to save the category when you have imported the conditions, they are not automatically saved but just initialized.

8 Matching Products Indexation

8.1 Scheduled Task For better performances in frontend, products that match conditions are indexed in the native Magento database table. Thanks to that, products are retrieved in frontend just like Magento default behaviour and in the order you have defined in backend.

Because products may not match defined conditions anymore (attribute has changed or promo has expired), the products have to be indexed periodically in order to refresh product list both in backend and in frontend. That’s why a scheduled task is available in Magento Configuration where you can define a delay that has to expire before refreshing product list.

Do not forget to configure the default Magento cron.php task for this to work.

8.2 Manual Indexation If you want to index matching products manually and not wait for the scheduled task to process, you can do it by hitting the Refresh button that has been added in the matching products grid in backend:

Page 8: Bubble Dynamiccategory User Guide v1.0

8

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

9 Frontend Navigation

Frontend navigation just stay unchanged and product list is retrieved automatically according to the conditions defined in backend.

You may have to clear the BLOCK_HTML cached after saving conditions if you have configured your strategy to cache product list.

10 Disable/Uninstall Extension

If you want to disable the extension, you can disable it from app/etc/modules/Bubble_DynamicCategory.xml.

If you want to remove it totally, just remove the following files and clear Magento caches:

• app/code/local/Bubble/DynamicCategory/Block/Adminhtml/Category/Dynamic/Conditions/Import.php • app/code/local/Bubble/DynamicCategory/Block/Adminhtml/Category/Dynamic/Conditions.php • app/code/local/Bubble/DynamicCategory/Block/Adminhtml/Category/Tree.php • app/code/local/Bubble/DynamicCategory/controllers/Adminhtml/Dynamic/CategoryController.php • app/code/local/Bubble/DynamicCategory/etc/adminhtml.xml • app/code/local/Bubble/DynamicCategory/etc/config.xml • app/code/local/Bubble/DynamicCategory/etc/system.xml • app/code/local/Bubble/DynamicCategory/Helper/Data.php • app/code/local/Bubble/DynamicCategory/Helper/Indexer.php • app/code/local/Bubble/DynamicCategory/Model/Observer.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Combine.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Boolean.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Created.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/New.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Parent.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Price/Special/Applied.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Promo.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Quantity.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Salable.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Stock.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/TotalChildQty.php • app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product/Type.php

Page 9: Bubble Dynamiccategory User Guide v1.0

9

Bubble Dynamic Category for Magento

© BubbleShop https://www.bubbleshop.net © BubbleShop https://www.bubbleshop.net

• app/code/local/Bubble/DynamicCategory/Model/Rule/Condition/Product.php • app/code/local/Bubble/DynamicCategory/Model/Rule.php • app/code/local/Bubble/DynamicCategory/sql/bubble_dynamiccategory_setup/install-1.0.0.php • app/code/local/Bubble/DynamicCategory/sql/bubble_dynamiccategory_setup/upgrade-1.2.0-1.3.0.php • app/code/local/Bubble/DynamicCategory/sql/bubble_dynamiccategory_setup/upgrade-1.3.6-2.0.0.php • app/design/adminhtml/base/default/template/bubble/dynamiccategory/conditions/import.phtml • app/design/adminhtml/base/default/template/bubble/dynamiccategory/conditions.phtml • app/design/adminhtml/base/default/template/bubble/dynamiccategory/promo/fieldset.phtml • app/design/adminhtml/base/default/template/bubble/dynamiccategory/wrapper.phtml • app/etc/modules/Bubble_DynamicCategory.xml • app/locale/en_US/Bubble_DynamicCategory.csv • app/locale/fr_FR/Bubble_DynamicCategory.csv