PHPackages                             bloomreach/bloomreach-connector-magento - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. bloomreach/bloomreach-connector-magento

ActiveMagento2-module[Search & Filtering](/categories/search)

bloomreach/bloomreach-connector-magento
=======================================

Bloomreach connector for autosuggest,collection and product search

1.8.2(1y ago)119.8k↓23.3%2proprietaryJavaScriptPHP ~7.4.0||~8.0.0||~8.1.0||~8.2.0||~8.3.0

Since Oct 19Pushed 1y ago11 watchersCompare

[ Source](https://github.com/bloomreach/discovery-connector-magento)[ Packagist](https://packagist.org/packages/bloomreach/bloomreach-connector-magento)[ RSS](/packages/bloomreach-bloomreach-connector-magento/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (6)DependenciesVersions (20)Used By (0)

Bloomreach Connector Module
===========================

[](#bloomreach-connector-module)

The Connector module provides the option to connect with Bloomreach Search Merchandise and other API and pixel integration. The Discovery Magento connector is a community-supported tool. It is fully Open-Sourced and open to contributions.

Installing Magento
------------------

[](#installing-magento)

- Ensure you have installed Docker and it is up to date
- Go to  and create an account or log into that portal
- Navigate to `https://marketplace.magento.com/customer/accessKeys/`
- Have a key ready to be used (create a new one if you need one. Key name does not matter)

Please then run:

```
npm i
npm run magento-install
```

- You will be prompted for a user name and password: UserName = Public Key from marketplace.magento.com Password = Private Key from marketplace.magento.com
- You will later be asked to enter your system password.

After completing all of the steps the server should be running.

Troubleshooting:

All of the videos to understand magento set up via docker is discussed here:

- Many issues can be resolved by reinstalling ```
    npm run magento-uninstall
    npm run magento-install

    ```
- If you have a chmod failure, there is a chance your Adobe keys were not entered in correctly. Please remember to NOT use your account user/pass and use the public and private keys as user/pass.
    - Once the creds have failed they get cached on your local machine. You can find the creds at: `~/.composer/auth.json`. Modify the values there to be correct to make the install script work properly.
- If your demo data didn't load: try running: ```
    # Note, the . at the beginning makes it easier to cd into the folder first or
    # bash will interpret the . as an execute command instead of the path.
    cd .magento
    bin/magento sampledata:deploy
    ```

    or reinstall

Developing
----------

[](#developing)

After magento is installed, you can being developing by using:

```
# Ensure docker desktop is running
npm run dev
```

THe process will be completed when you see the message:

`Development server started.`

This will start your magento instance and make the URL `https://magento.test`available on your local machine. This will also automatically distribute changes to your magento server for viewing in the local environment.

Most changes will appear automatically, but some changes will require magento commands such as the following:

```
cd .magento
# Run when you change any dependency injected parameters in your classes
bin/magento setup:di:compile
# Run when all else fails
bin/magento setup:upgrade
# Run when you think something should be there but isn't loading in the browser
bin/magento cache:flush
```

When you are done developing, if quitting the developer script does not succeed, you can ensure the magento server and resources are stopped via:

```
bin/stop
```

NOTE: You can use the opposite to run your server without any special npm commands:

```
bin/start
```

Configure App First
-------------------

[](#configure-app-first)

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

- Step 1: Login to admin, if not already logged-in
- Step 2: Goto Store->Configuration
- Step 3: Find "Bloomreach" Section
- Step 4: Click on "Settings" Tab under Bloomreach Section
- Step 5: Fill all options: You can get these setting values from your Bloomreach account.
    - Account Id
    - Domain Key: `This may vary for your each store view, if you have multiple locale enable in Magento and you have configured multiple locale in Bloomreach as well.`
    - Auth Key
    - Tracking Cookie
    - Search Endpoint: use this highlighted and replace domain name with `` `http:///catalogsearch/result/`
    - Autosuggest Endpoint: use this highlighted and replace domain name with `` `http:///search/ajax/suggest/`

Trigger Indexing
----------------

[](#trigger-indexing)

When you made any changes on catalog at Bloomreach, then you may need to reindex those to reflect on your site. To do this you can follow these steps to trigger index.

- Step 1: Login to admin, if not already logged-in
- Step 2: Goto Store->Configuration
- Step 3: Find "Bloomreach" Section
- Step 4: Click on "Indexing" Tab under Bloomreach Section
- Step 5: Now click on button named "Trigger Index"

Search Module Options
---------------------

[](#search-module-options)

### Auto-Suggest

[](#auto-suggest)

**Enable customers to use fast and secure way to search products, and seamless experience.**To enable it, you can configure it from admin panel.

- Step 1: Login to admin, if not already logged-in
- Step 2: Goto Store->Configuration
- Step 3: Find "Bloomreach" Section
- Step 4: Click on "Search" Tab under Bloomreach Section
- Step 5: Here you can configure Autosuggest by setting **Yes** for **Enable Autosuggest**
- Step 6: Now enter or cross verify your frontend quick search input selector (id/css path)
- Step 7: Here you can select No. of Terms, products, categories to show by default in quicksearch result popup.
- Step 8: Save configuration and Clean/Flush cache.

### Site Search

[](#site-search)

**Replace existing search result page with more efficient and fast search results.**You can follow **above steps from Auto Suggest** both Configuration groups are in same page.

- Step 9: You can configure Site Search i.e site search result page with Bloomreach search page for fast and efficient search result, in this same page where you have autosuggest.
- Step 10: Enable Site search by setting **YES** to **Enable Site Search**
- Step 11: **Do not change "Css Selector" value, until you know what exactly you are going to do**
- Step 12: Configure other options like: No of products to show, Show Variants, Show Layered Navigation etc.
- Step 13: Save configuration and Clear/Flush Cache.

Category
--------

[](#category)

**Replace existing product listing page/ category view page with Bloomreach product listing page.**

It works similar to site search and have same options as site search have. Navigate to **Category** Tab under **Bloomreach** Section

- Step 1: Enable Category by setting **YES** to **Enable For Category**
- Step 2: **Do not change "Css Selector" value, until you know what exactly you are going to do**
- Step 3: Configure other options like: No of products to show, Show Variants, Show Layered Navigation etc.
- Step 4: Save configuration and Clear/Flush Cache.

Pixel
-----

[](#pixel)

You can enable Bloomreach pixel by just setting **Yes**, under Pixel Tab. Pixel collect customer's behavioral data, like what they are looking into site (category, products), what they have added to cart and conversion (order placed).

\###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 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 collects:

[](#data-bloomreach-collects)

- 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

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

Also, There is already pixel integrated for **add to cart event** which you can find in template at this path: **Bloomreach/Connector/view/frontend/templates/product/**, there are 2 files

- list.phtml
- view/addtocart.phtml

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

```