Overview - fredhopper/hybris-connector GitHub Wiki

The Fredhopper/SAP Hybris Connector lets you leverage the advanced on-site search, navigation, personalisation, and merchandising capabilities of Fredhopper in your hybris-based online marketplace.

Repository Overview

The Fredhopper/SAP Hybris Connector repository consists of the following components:

  • fredhoppersearch: A hybris extension which contains the entire logic interacting with the hybris code base. It depends on fredhoppercore.
  • fredhoppercore: A prepackaged JAR which contains core classes and beans required both to generate input data and query the Fredhopper index. It does not contain any references to or dependencies on any hybris code. This lets you reuse it in other solutions.
  • fredhoppertemplate: A template for generating a new local extension using ant extgen.

You can override all components of the Fredhopper/SAP Hybris Connector in your project to meet your specific requirements.

NOTE: You need to install the extension locally. For more information, see README.md: Install the Extension.

Extension Overview

The Fredhopper/SAP Hybris Connector extension consists of the following conceptual components:

  • File exporter: responsible for generating and exporting your hybris data as Fredhopper-compatible CSV files.
  • Query engine: responsible for querying the Fredhopper online index.

File Exporter

The exporter acts as a converter between the hybris data model and the Fredhopper input data model. After the conversion is complete, it uploads the resulting ZIP file to the Fredhopper cloud indexing service.

images/Exporter_process.png

The process breaks down to the following stages:

  1. Gathering of the relevant service layer data models in hybris.
  2. Conversion of the service layer data model objects into Fredhopper data transfer objects (DTOs).
  3. Translation to and generation of CSV files out of the populated DTOs.
  4. Uploading of a ZIP file containing the CSV files to Fredhopper.
  5. Triggering of an index update.

NOTE: You need to configure the file exporter yourself. For more information, see README.md: Configure the Export Logic and Wiki: Generating and Publishing Data.

Query Engine

The query engine takes care of sending the queries to your Fredhopper cloud instance and processing the response.

The process breaks down to the following stages:

  1. Querying Fredhopper.
  2. Parsing the response.
  3. Transforming the response into Solr response objects.

NOTE: You need to configure the query engine yourself. For more information, see README.md: Configure the Query Logic and Wiki: Front-End Integration.