Magento ES Connector User Manual

Introduction

The Hawksearch service enables online retailers and publishers the ability to drive a rich, compelling user experience.  This experience drives visitors to the products and information that they are seeking. 

Hawksearch provides the ability to power the product listing pages for categories and brand pages on the site in addition to driving the search page on the site. This document will cover integration between an existing Magento 2 ES site and Hawksearch v4.0 (ES) version to drive:  Search Results and Landing Pages. 

The Magento 2 ES plugin allows to set up a gateway with Hawksearch Elastic API and export catalog and static content data through the API from Magento to the Hawksearch index.

Requirements and Installation

Configuration

Having a Hawksearch engine is necessary in order to configure Magento ES extension.

Hawksearch Account

Please contact us at success@bridgeline.com to establish Hawksearch license.

Magento Settings

To configure the Magento extension, you need the following Hawksearch credentials:

• Engine Name - this is the engine ID associated with your HawkSearch account.

• API Key - it is used by the module to connect to HawkSearch Rest API.

• Tracking Key - it is used to uniquely identify your account in the image pixel that is added to the order confirmation page on the site to track orders and generate appropriate reports in Hawk Search.

You can find these credentials on the Hawksearch Dashboard on the Admin > Account Info tab. Please follow Hawksearch URLs article to find the dashboard URL depending on the Hawksearch environment.

In the administration section of your Magento project, navigate to Stores > Configuration > HAWKSEARCH and fill in the form in the Connection Settings tab with all the information required.

Domains

Hawksearch has three environments available: Development, Staging/Test and a load-balanced Production. When performing integration, each engine can be accessed by using appropriate domains.

Hawksearch URL Settings

• Hawksearch URL (Development): https://dev.hawksearch.net/

• Hawksearch URL (Staging): https://test.hawksearch.net/

• Hawksearch URL (Production): https://yourenginename.hawksearch.com/ Provided at time of launch. OR dashboard-na.hawksearch.com

Hawksearch Tracking URL Settings

• Hawksearch tracking URL (Development): https://tracking-dev.hawksearch.net/

• Hawksearch tracking URL (Staging): https://tracking-test.hawksearch.net/

• Hawksearch tracking URL (Production): https://tracking-na.hawksearch.com/

Hawksearch Recommendation URL Settings

Note: Recommendations module will be supported in the future connector versions

• Hawksearch recommendation URL (Development): https://recs-dev.hawksearch.net/

• Hawksearch recommendation URL (Staging): https://recs-test.hawksearch.net/

• Hawksearch recommendation URL (Production): https://recs-na.hawksearch.com/

Indexing Settings

Indexing

Open

Enable Indexing

Enable/Disable data indexing to HawkSearch and completely disables the extension if setting is set to 'No'.

Maximum number of items per iteration

The maximum number of items indexed per one API operation call. Please note that Hawksearch indexing The maximum number of items per iteration represents the API limit which is 125 items per iteration. Please contact support@hawksearch.com if you have any questions or need to extend the limit.

Product Settings

Products

Attributes

Specify product attributes your users can index in Hawksearch. After the new attribute is specified and setting is saved the Hawksearch field with the same code will be created. The extended configuration of the Hawksearch field is available within Fields section of Hawksearch Workbench.

Bulk Operations processing

The chapter has been moved to GitHub