Hotfix release available: 2017-02-19e "Frusterick Manners". upgrade now! [49.5] (what's this?)
Hotfix release available fixing CVE-2017-12979 and CVE-2017-12980: 2017-02-19d "Frusterick Manners". upgrade now! [49.4] (what's this?)
integration_documentation:direct_integration:oxid

General

The OXID Direct Integration plugin needs to be implemented in OXID eShop to export the products and their data for a successful implementation of FINDOLOGIC search into OXID eShop. Besides the product export, the plugin also injects the main FINDOLOGIC snippet.

This plugin is going through all the data of the shop and searches for valid products for the export. In order to be exported, the following conditions must be met:

  • product must be set to active
  • product stock must be greater that zero
  • product should not be configured as variant
  • product categories must be active
  • product category should not be set to “Hidden”

Download

The plugin can be downloaded here


Installation

The OXID Direct Integration plugin installation procedure is basically the same as for any other OXID plugin. It can be summed up in a few simple steps:

  • Plugin content needs to be copied into the OXID folder called “Modules”.
  • The file called “findologic_export.php”, which can be found in the plugin root directory needs to be moved into the root directory of the OXID eshop.
  • After this, go to Admin panel under Extension → Modules, “Findologic Search” should be listed as one of the available plugins.

  • After clicking on “Findologic Search” on the lower part of the screen, the plugin info should be displayed. In order to install the plugin, please click “Activate”.

  • After the activation, click on “Settings” and enter the corresponding Shopkey provided by FINDOLOGIC in the available field or fields (depends on how many languages the shop has). Finally, save the settings.

Shopkey must be entered in a valid format, otherwise an error will be shown
  • Finally the cache of the shop must be cleared.

Running Export

The export is called via URL. For example: SHOP_URL/findologic_export.php?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER>

Three parameters are necessary for successfully running export:

  • shopkey → <SHOPKEY> provided by FINDOLOGIC
  • start → <NUMBER> that should not be lower than zero
  • count → <NUMBER> that should not be lower than zero

If any of these parameters is not according to standards, the export would not be run, and an error message will be displayed. The generated XML is validated against predefined xsd scheme contained in “lib” folder.


Export Customization

If standard export does not export all data that is needed, there is a simple way to customize export. In plugin root folder there is a file called “findologicCustomExport_org.php” that should be renamed to “findologicCustomExport.php”. That file contains class “FindologicCustomExport” that extends class “FindologicItemXml” that is responsible for export. In order to change export, simply override already existing methods in “FindologicItemXml” by writing new methods in “FindologicCustomExport” class. Example code is already placed in “findologicCustomExport_org.php”.