User Guide: Bloomreach Connector Extension for Magento - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

User Guide: Bloomreach Connector Extension for Magento

The Extension module provides the option to connect with Bloomreach Search, Merchandising, Recommendations, & Pixel integration.

Please follow the Installation guide to install/uninstall/upgrade the extension

 

Authentication

To integrate any options from this extension, you need to fill the app configuration settings. To do this, you can follow these steps to configure settings:

Please have your Bloomreach Account ID, Authentication key, Domain key, and Tracking cookie. Contact [email protected] for more details.
  1. Login to admin, if not already logged-in

  2. Go to Store > Configuration

  3. Find the Bloomreach section

  4. Click on the Settings tab under Bloomreach

  5. In Settings, click Fill all options. You can get these setting values from your Bloomreach account.

    • Account Id

    • Domain Key: This may vary for each store view. If you have multiple locales enabled in Magento2 store, then you can configure multiple locales in Bloomreach as well for each locale. This will help you to get information in the correct language.

    • Auth Key

    • Tracking Cookie

    • Search Endpoint

 

 

Indexing

When you make any catalog changes on your Magento store, then you will need to re-index them with Bloomreach to reflect the changes on your site. Bloomreach Support will set up a pipeline to import your product feed, you can contact your Integrations lead or send an email to [email protected]

  1. Login to admin, if not already logged-in

  2. Go to Stores > Configuration

  3. Find the Bloomreach section

  4. Click on the Indexing tab under Bloomreach

  5. Click on Contact Integrations to initiate an email to support

 

Search Module Options

Autosuggest

Enable a seamless product search experience that is fast and secure. 

To enable Autosuggest, configure it from the admin panel.

  1. Login to admin, if not already logged-in

  2. Go to Stores > Configuration

  3. Find the Bloomreach section

  4. Click on the Search tab under Bloomreach

  5. Set Enable Autosuggest to Yes

  6. Enter or cross-verify your frontend quick search input selector (id/css path)

  7. Here, you can set the No. of Terms, products, and categories to show by default in Quicksearch result popup

  8. Click Save Config then Clean/Flush the cache

After configuration, you can type any text in the quick search bar in the frontend to view the result.

 

Site Search

Replace existing search result pages with more efficient and faster search results.

To configure Site Search, you can follow the same steps above for configuring Autosuggest. Both configuration groups are on the same page.

  1. Login to admin, if not already logged-in

  2. Go to Stores > Configuration

  3. Find the Bloomreach section

  4. Click on the Search tab under Bloomreach

  5. Set Enable Site Search to Yes

  6. Do not change Css Selector value until you know what exactly you are going to do

  7. You may configure other options as you like

  8. Click Save Config then Clear/Flush the cache

After configuration, you can submit a search in the frontend to see the search result page.

 

Category

Replace existing product listing pages or category view pages with Bloomreach product listing pages.

Category works similarly to Site Search and has the same configuration options.

  1. Login to admin, if not already logged-in

  2. Go to Stores > Configuration

  3. Find the Bloomreach section

  4. Click on the Category tab under Bloomreach

  5. Set Enable For Category to Yes

  6. Do not change Css Selector value until you know what exactly you are going to do

  7. You may configure other options as you like

  8. Click Save Config then Clear/Flush the cache

Once done then you can visit any category page to see the effect.

 

Pixel

You can enable Bloomreach pixel by setting Enable Pixel to Yes, under the Bloomreach Settings tab. The pixel collects customer behavioral data, such as which products or categories they view, or what they have added-to-cart and which orders they have placed.

You can install the Bloomreach Pixel Validator for Chrome to validate these events.

You can use this data to provide related information and products to customers through the Personalized Recommendation widget.

Pixel event data:

  • Visit Homepage or any CMS page

  • Visit Category page

  • Visit Product Page

  • Search and land into search result page

  • Add-to-cart (any product)

  • Quick view of any product (not integrated by default, see manual integration steps below)

  • Placed an order and land into order success page after order completion

Data collected by Bloomreach:

  • Page url

  • User id (logged-in customer unique id encrypted hash)

  • Product id

  • Product Sku

  • Product Name

  • Order grand total

  • Order item info (sku, quantity, name, unit price)

  • Event type

All events listed above are already integrated in this extension, except Quick view events. There is a pixel already integrated for Add-to-cart events, which you can find in the template at this path: Bloomreach/Connector/view/frontend/templates/product/. This path contains two files:

  • list.phtml

  • view/addtocart.phtml

These files can be used as a reference to integrate Add-to-cart events when you have a custom or 3rd party theme. Refer to this sample code for Add-to-cart events:

<button type="submit"
       data-blm-add-to-cart
       data-blm-add-to-cart-sku="<?= $block->escapeHtml($_product->getSku()) ?>"
       data-blm-add-to-cart-prod-id="<?=  /* @noEscape */ $_product->getId() ?>"
       data-blm-add-to-cart-prod-name="<?= $block->escapeHtml($_product->getName()); ?>"
       title="<?= $block->escapeHtmlAttr($buttonTitle) ?>" class="action primary tocart"
       id="product-addtocart-button">
      <span><?= $block->escapeHtml($buttonTitle) ?></span>
</button>
Note: Magento does not contain a Quick View feature by default, so Quick View events are not added in the current extension. You can add a Quick View button event if you have integrated any 3rd party quick view extension.

To integrate a Quick View event, you can override any file where a Quick View button is added. Then add the following attribute to that Quick View button/anchor.

data-blm-quickview
data-blm-quickview-sku="Chair123"
data-blm-quickview-prod-id="60765"
data-blm-quickview-prod-name="Weathered Gray Wood Jozy Dining Chairs Set of 2"

Replace sku, prod-id, and prod-name with the respective getter functions of the product object.

Here is a example of how the Quick View event integration may look:

<button type="button"
         data-blm-quickview
         data-blm-quickview-sku="<?= $block->escapeHtml($_product->getSku()) ?>"
         data-blm-quickview-prod-id="<?=  /* @noEscape */ $_product->getId() ?>"
         data-blm-quickview-prod-name="<?= $block->escapeHtml($_product->getName()) ?>"
         title="<?= $block->escapeHtmlAttr($buttonTitle) ?>"
         class="action quick-view">

 

Recommendation Widget

This widget allows you as Admin to add widgets into any CMS page or block on the page. There are various Recommendation widget type options:

  1. Global Trending

  2. Category

  3. Keyword

  4. Personalized

  5. For specific Item

You can select the widget type when you insert the widget.

How to enable Recommendation Widget

  1. Navigate to the Recommendations tab under the Bloomreach Section

  2. Set Enable Recommendation Widget to Yes

  3. Click Save Config, then Clean/Flush Cache

How to use Recommendation Widget

  1. Insert the widget into any CMS Page or block, then see the effect on the frontend.

  2. Or you can use frontend builder with any of the below methods

  • Method 1 - Insert html container and widget: Read the linked document to learn how to insert a html container and widget:

Elements - HTML Code | Magento User Guide

  • Method 2 - Insert widget using CMS block:
  1. First create a CMS Block in admin, then insert a widget in the CMS block and save it.
  2. Read the linked document to learn how to insert a CMS block in page builder:
    Add Content - Block | Magento User Guide

 

  1. You can use Content > Widgets > Add new to insert on a page, then add/select widget options in page

Please make sure you have already created these widget rules in the Bloomreach Dashboard, where you will get Widget id, which is required to load any widget in Magento. For each widget type, you will have a different widget id in Bloomreach Main Dashboard.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?