User Guide: Bloomreach DiscoveryExtension for Magento

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

Note: Please follow Installation guide to install/uninstall/upgrade extension

Index Page No

Bloomreach Connector Module:Magento 2 1Authentication 1Indexing 2Search Module Options 3

Auto-Suggest 3Site Search 5

Category 6Pixel 7

Pixel mainly collect data for these events, when you: 7Data Bloomreach collect: 7

Recommendation Widget 9How to enable Recommendation Widget: 9How to use Recommendation Widget : 10

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

Page 1

Please get your Account Id, Auth key, Domain key and Tracking cookie from Bloomreach,please contact support@bloomreach.com for more details.

Login to admin, if not already logged-in

1. Go to Store->Configuration2. Find "Bloomreach" Section3. Click on "Settings" Tab under Bloomreach Section4. Under this tab “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. Thiswill help you to get information in the correct language.

○ Auth Key○ Tracking Cookie○ Search Endpoint: use this highlighted and replace domain name with

<your_domain_name> http://<your_domain_name>/catalogsearch/result/○

IndexingWhen you make any catalog changes on your Magento store, then you will need to re-indexthose with Bloomreach to reflect on your site. Bloomreach support will set up a pipeline toimport your product feed, you can contact your Integrations lead or send email atsupport@bloomreach.com

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

Page 2

2. Go to Store->Configuration3. Find "Bloomreach" Section4. Click on "Indexing" Tab under Bloomreach Section5. Now click on the button named “Contact Integration" to initiate an email to support.

Search Module Options

Auto-Suggest

Enable customers to use fast and secure way to search products, and seamlessexperience.

To enable it, you can configure it from the admin panel.

1. Login to admin, if not already logged-in2. Go to Store->Configuration3. Find "Bloomreach" Section4. Click on "Search" Tab under Bloomreach Section5. Here you can configure Auto-suggest by setting Yes for Enable Autosuggest6. Now enter or cross verify your frontend quick search input selector (id/css path)7. Here you can select No. of Terms, products, categories to show by default in

Quicksearch result popup.8. Save configuration and Clean/Flush cache.

Page 3

Once done then you can type any text in the quick search bar in the frontend to get the result.

Page 4

Site Search

Replace existing search result page with more efficient and fast search results. You canfollow the above steps from Auto Suggest both Configuration groups are on the same page.

1. You can configure Site Search i.e site search result page with Bloomreach search pagefor fast and efficient search result, in this same page where you have Autosuggest.

2. Enable Site search by setting YES to Enable Site Search3. Do not change "Css Selector" value, until you know what exactly you are going to

do4. Configure other options like: No of products to show, Show Variants, Show Layered

Navigation etc.5. Save configuration and Clear/Flush Cache.

Once done then you can type any text in the quick search bar in the frontend and hit the enter ofsearch button to see the result on the search result page.

Page 5

CategoryReplace existing product listing page/ category view page with Bloomreach productlisting page.

It works similar to site search and has the same options as site search have. Navigate toCategory Tab under Bloomreach Section

1. Enable Category by setting YES to Enable For Category2. Do not change "Css Selector" value, until you know what exactly you are going to

do3. Configure other options like: No of products to show, Show Variants, Show Layered

Navigation etc.4. Save configuration and Clear/Flush Cache.

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

Page 6

PixelYou can enable Bloomreach pixel by just setting Yes, under Bloomreach’s Settings Tab. Pixelcollects customer's behavioral data, like what they are looking into (category, products), whatthey have added to cart and conversion (order placed).

You can install Bloomreach Pixel Validator in Chrome browser to validate these events.

You as Admin these data are very useful which gives insights of your customer needs that youcan use for giving more related information and products to customers, and will be used forPersonalized Recommendation widget. (will be covering in next section)

Pixel mainly collect data for these events, when you:

● Visit Homepage or any CMS page● Visit Category page● Visit Product Page● Search for anything and land into search result page● Add to cart any product● Quick view of any product (not integrated by default, can be done manually. See below)● Placed an order and went to order success page after order completion

Data Bloomreach collect:

● Page url● User id (logged-in customer unique id encrypted hash)● Product id● Product Sku● Product Name● Order grand total● Order item info (sku, qty ordered, name, unit price)● Event type

Excluding Quick View all other above listed events are already integrated in this extension.There is already pixel integrated for add to cart event which you can find in template at thispath: Bloomreach/Connector/view/frontend/templates/product/, there are 2 files under it

Page 7

● list.phtml● view/addtocart.phtml

These files can be used as a reference to integrate Add to cart events when you have acustom or 3rd party theme.

sample the code which is added for add to cart event, looks something like this:

<button type="submit"data-blm-add-to-cartdata-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>

As you may know in Magento there is no Quick view feature by default, so this event is notadded in the current extension. Whilst you can add a Quick View button event if you haveintegrated any 3rd party quick view extension

To integrate a Quick view event you can override that 3rd party listing file or any file where aquick view button is added. Then add the following attribute to that Quick viewbutton/anchor.

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

Note: Replace sku, product id, and product name with respective getter functions ofproduct object.

It may be look like, something similar:

<button type="button"data-blm-quickviewdata-blm-quickview-sku="<?= $block->escapeHtml($_product->getSku()) ?>"data-blm-quickview-prod-id="<?= /* @noEscape */ $_product->getId() ?>"

Page 8

data-blm-quickview-prod-name="<?= $block->escapeHtml($_product->getName()) ?>"title="<?= $block->escapeHtmlAttr($buttonTitle) ?>"class="action quick-view">

Recommendation WidgetThis widget allows you as Admin to add widgets into any CMS page or block on the page.

It has various widget type options:

1. Global Trending2. Category3. Keyword4. Personalized5. For specific Item

Which can be selected at time of inserting this widget.

How to enable Recommendation Widget:

1. To enable widget you can Navigate to Recommendations Tab under BloomreachSection

2. Set Yes for Enable Recommendation Widget3. Save configuration and Clean/Flush Cache.

How to use Recommendation Widget :

Page 9

1. Inset the widget in any CMS Page or block and see the effect on the frontend.

2. Or you can use frontend builder with any of the below methodsa. Inset html container and inder widget: follow this link to inset a html container and

widget:Elements - HTML Code | Magento User Guide

b. Or you can insert this Widget using cms block,i. so first you need to create a CMS Block in admin then insert a widget

there in the CMS block and save it.ii. Then follow this url to insert a CMS block in page builder:

Add Content - Block | Magento User Guide

Page 10

3. You can use Content->Widgets -> Add new to insert on a page, then add/select widgetoptions in page

Please make sure you have already created these widget rules in Bloomreach MainDashboard, 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.

Page 11