Connector Setup Step by Step - fredhopper/hybris-connector GitHub Wiki

IMPORTANT: This page is now archived. To learn how to install and configure the extension, see README.md.

The following page describes the mandatory steps needed to integrate the Connector in your project.

Prerequisite: your project is using the Hybris Accelerator.

As per standard Hybris architecture, all components of the Connector can be overridden in your project according to your specific requirements.

1. Install the new extensions in your project

  1. Clone the Fredhopper Git repository to your local machine.
  2. Copy extensions 'fredhoppersearch' and 'fredhoppertemplate' to your Hybris platform (usually hybris/bin/custom)
  3. Generate your own Connector extension starting from the 'fredhoppertemplate', using the standard Hybris "ant extgen" command.
  4. Add both 'fredhoppersearch' and your newly generated Connector extension to your localextensions.xml file.
  5. Configure all required properties in your local.properties file (for a complete list click below).

Click here for more details

2. Configure the export logic

  1. Define your index attributes, using essentialdata_createExportJobConfig.impex as an example. For each attribute you need to define:
  • attributeId
  • Fredhopper baseType
  • name (in all languages needed)
  • value provider
  • optional: Implement value providers if you have requirements which are not addressed by the existing providers.
  1. Customize (or override) the DAOs responsible of fetching products and categories (DefaultFhCategoryDao and DefaultFhProductDao).
  2. Run "ant all", update running system and trigger the cronjob "fredhopperIndexExportJob" to generate and publish your index to Fredhopper.
  3. Connect to Fredhopper and verify your data has been correctly published.

Click here for more details

3. Configure the query logic

  1. Customize (or override) the DocumentSearchResultValuePopulator class, which is responsible at service level for populating the DocumentData.values attribute.
  2. Run "ant all", access your front-end and submit a search request. Your results should be coming from Hybris.

Click here for more details