Docs

Unbxd Recommendations - Magento

The Unbxd Recommendations extension for magento lets you employ the recommendation widgets on your online store. The extension's interface helps you install, configure, and integrate with Unbxd Recommendations right from the Magento Admin Panel.

The following sections provide step-wise instructions along with screenshots to set up the Recommendation extension on your Magento based store.

1. Installation

Recommended Version

The extension is compatible with only Magento 1.5 and later versions. If you are on an older version, it is highly recommended that you upgrade before you start the installation.

Note

The Unbxd extension does not change or modify the design of your ecommerce application in any manner.

  1. Go to the Unbxd Recommendations extension page on Magento Connect website.
  2. Click Install Now.
    If you have not yet signed up with (or logged in to) Unbxd Recommendations, you will be asked to do so before you start the installation. Learn how to set up your console.
  3. Select the I agree to the extension license agreement checkbox and click Get Extension Key.
  4. Click Select and copy the Extension key.
  5. On your Magento Admin Panel, navigate to System → Magento Connect → Magento Connect Manager on the main menu. You will be redirected to the Magento Connect Manager page.
  6. Navigate to ExtensionsInstall New ExtensionPaste extension key to install and insert the extension key.
  7. Click Install.
  8. This will start installing the Unbxd Recommendations extension in your application.

Once the extension is successfully installed, Unbxd Recommendations extension will appear on the list of extensions under the Manage Existing Extensions section.

An Unbxd tab will be added on the main menu.

If in case you are using any other Unbxd extension, the Unbxd tab will be already present on the main menu. This tab will then have combined options for both the extensions.

2. Authentication

Ensure that: Main Website is selected in the Choose Website option on the left navigation pane.

After you have installed the extension, you need to authenticate it. Authenticate requires your 2 Unbxd account keys, Site Key and Secret Key.

To access your account keys on the Unbxd Recommendations console, navigate to Manage → Configure Site.
Learn more about Unbxd account keys.

We also provide these keys in a Welcome mail sent to your registered email address.

To authenticate the extension, do the following:

  1. On your Magento Admin Panel, navigate to → UnbxdAuthentication and paste the keys in their respective fields.
  2. Click AUTHENTICATE. REAUTHENTICATE if required. This is will authenticate the Unbxd Recommendations extension for your account.

3. Catalog

Your product catalog information is essential in order for the extension to work. Therefore it is important that you sync your catalog data with us.

Catalog configuration involves:

  1. Mapping Catalog Attributes
  2. Adding Custom Attributes
  3. Filtering Catalog Data
  4. Syncing your Catalog
  • Unbxd attributes: Unbxd feature fields.
  • Magento Attributes: Default Magento fields.
  • Custom Attributes:Your custom fields synced with Magento.

3.a Map Catalog Attributes

Mapping Magento fields with Unbxd's feature fields will enable the extension to correctly relate to your products and thereby fetch right results. To map your catalog attributes, do the following:

  1. Navigate to Catalog → Map Catalog Attributes.
  2. A table shows Unbxd attributes listed against Magento attributes. Verify the map. Remap if required. To re-map catalog attributes:
  3. Click Edit Attributes at the bottom of the table.
  4. Select an appropriate Magento Attribute for the corresponding Unbxd feature field.
  5. Ensure that correct fields are mapped as any conflict may result in irrelevant recommendations. If you are unable to find the right Magento attribute for it Unbxd counterpart, retain the default map.

3.b Add Custom Attributes

You can add the remaining product fields as custom attributes. All the fields you have added on Magento will be listed here. To add a Custom Attribute, do the following:

  1. Click Add Attribute.
  2. Click the + button to add new rows.
  3. Select the attribute and specify its datatype.
  4. Click Save to save the changes.

Click the Cancel (X) button to delete a row.

3.c Filter Catalog Data

You can also exclude the products you do not want to be displayed in the recommendations based on its fields by creating a filter.

To create a filter, do the following:

  1. Click Filter Catalog Data [Optional].
  2. Click Add a new rule.
  3. Select the desired Attribute (Field) from the list.
  4. Choose the filter operator: Equal to or In between according to the attribute. Equal to is used for single value fields and In between to specify a range.
  5. Enter the values.

You can also add new rules which will work in conjunction with other rules.

You can add up to 3 filters.

3.d Sync you Catalog

After you have finished configuring your catalog data, you can sync your catalog. To initiate a catalog sync,navigate to Sync the Catalog Data section and click SYNC CATALOG.

Set up a Cron Job

IMPORTANT:

Setting up a Cron Job is an crucial step as your catalog may undergo frequent updates and must be synced with Unbxd in order to show updated recommendations to visitor.

You can set up a cronjob using Magento cron, which performs a catalog sync at regular intervals. To setup a cronjob, Contact Unbxd Support.

If you wish to setup a cron job manually in your Magento store, click here.

Analytics

Tracking visitor analytics and behaviour is essential in order to provide appropriate and relevant recommendations to your visitors. Unbxd analyzes every visitor events anonymously and tracks their product clicks, cart additions, and orders. This information is then used for displaying personalized recommendations back to the visitors.

We make use of browser cookies to track visitors on your store. This browser cookie helps tag visitors with a unique information (uid) in order to recognize their revisits.

Know more about Unbxd Analytics.

Testing Analytics

You can test if the visitor events are being correctly tracked by manually performing each event on your magento-based store.

To check whether the events were successfully tracked or not, navigate to Magento Admin panel → Unbxd menu tab → Analytics. If the Unbxd analytics has tracked the events you performed on your store, you would see a check mark under each category (SEARCH HITS, PRODUCT VIEWS, CART ADDITIONS, ORDERS).

Tracking may not work out of the ready if your store has highly customized templates. In that case, you would see a waiting/loading symbol against the each category and tracking tags have to be manually added. Learn how to insert tracker tags.

Recommendation Widget Integration

Adding recommendation widget to your Magento site is simple. All you need to do is add a HTML code snippet to the respective template files. There are 2 ways of integrating the widgets, they are:

  1. Integration through the CMS.
  2. Integration using the store templates.

Integrating through CMS

To integrate through the CMS, do the following:

Steps

  1. On the Magento Admin Panel, navigate to CMSPages.
  2. You will be re-directed to the Manage pages section.
  3. In the Manage pages section, select the page you want to paste the widget.
  4. On the left navigation menu, click Content to view the page information.
  5. Paste the code snippet in the appropriate location.

Integration using Store Template Files

Unbxd Recommendations can be displayed by pasting snippets on appropriate template files. The table below shows HTML code snippets for each widget that need to be pasted on its respective template files.

It is highly recommended to not integrate the Viewed also Viewed and Bought also Bought widget together on the same PDP (Product Detail Page) as it would prevent the widgets from showing duplicate products. This scenario may arise right after integrating the widgets due to the lack of site data.

Recommendation WidgetCode snippetSite Property
Recently Viewed <div id="unbxd_recently_viewed"></div>Home Page, Product Page
Recommended For You <div id="unbxd_recommended_for_you"></div>Home Page, Product Page
More Like These<div id="unbxd_more_like_these"></div>Home Page, Product Page
Viewed also Viewed <div id="unbxd_also_viewed"></div>Product Pages
Bought also Bought <div id="unbxd_also_bought"></div>Product Pages
Cart Recommendations/td><div id="unbxd_cart_recommendations"></div>Cart pages
Homepage Top Sellers<div id="unbxd_top_sellers"></div>Product Pages
Category Top Sellers <div id="unbxd_category_top_sellers"></div>Category/Sub-category Pages
Brand Top Sellers <div id="unbxd_brand_top_sellers"></div>Brand Pages
Product Detail Page Top Sellers <div id="unbxd_pdp_top_sellers"></div>Product Pages

Refer the table below to locate template files for each Page Type on your Magento Admin Panel.

Page TypeTemplate File
Home Page app/design/frontend/{your_package}/{your theme}/template/sample/home.phtml
Product Page app/design/frontend/{your_package}/{your theme}/template/catalog/product/view.phtml
Cart pageapp/design/frontend/{your_package}/{your theme}/template/checkout/cart.phtml
Category Listing Page app/design/frontend/{your_package}/{your theme}/template/catalog/product/list.phtml
Brand Pages app/design/frontend/{your_package}/{your theme}/template/catalog/product/list.phtml