integration_documentation:plugin:en:direct_integration:oxid
This is an old revision of the document!
Integration with OXID plugin
Supports OXID 4.x and 5.x/6.x and is used for Direct Integration.
Download
Main plugin
The Findologic Search & Navigation plugin is downloaded from the OXID stackexchange store:
Export plugin
The Findologic Export plugin zip can be downloaded here:
Installation
See also OXID documentation.
Main plugin
- Copy the
findologic
folder to the plugin directory<shop_directory>/source/modules
. - Move the file
findologic/findologic/findologic_export.php
to<shop_directory>/source
Install module configuration:
vendor/bin/oe-console oe:module:install-configuration source/modules/findologic/findologic
Register module package:
composer config repositories.findologic/findologic path source/modules/findologic/findologic composer require findologic/search --no-plugins --no-scripts
Activation & Configuration
OXID 6.1 and lower
- Open the OXID admin and activate the module Findologic - Search & Navigation Platform.
Clear shop cache or remove tmp files manually:
rm <shop_directory>/source/tmp/*
OXID 6.2 and higher
- Open the OXID admin and activate the module Findologic - Search & Navigation Platform.
- Generate configuration files:
vendor/bin/oe-console oe:module:apply-configuration
- Edit the generated configuration file in
var/configuration/shops/<shop-id>.yaml
. - Search for
findologic_module
and insert the shop key provided by Findologic:# ... findologic_module: id: findologic_module # ... moduleSettings: FindologicShopkey_0: group: shopkey type: str value: '<your-de-shopkey>' FindologicShopkey_1: group: shopkey type: str value: '<your-en-shopkey>' # If you have more languages, this list may be longer. # ... # ...
- Clear shop cache or remove tmp files manually:
rm <shop_directory>/source/tmp/*
Export plugin
- Copy the
findologic-export
folder to the plugin directory at<shop_directory>/source/modules
. Install module configuration:
vendor/bin/oe-console oe:module:install-configuration source/modules/findologic-export/findologic-export
Register module package in composer.json
composer config repositories.findologic/findologic-export path source/modules/findologic-export/findologic-export composer require findologic/export --no-plugins --no-scripts
- Install plugin dependencies:
cd <shop_directory>/source/modules/findologic-export/findologic-export composer install
Activation & Configuration
- Open the OXID admin and activate the module Findologic - Export.
- By the default the export plugin does not have any configuration options.
Product export
For the functionality of the plugin it's essential to export the product data from the shop to Findologic. For this purpose, the Findologic export library libflexport is included.
The export is triggerred by the plugin-oxid-di module and calls
FindologicExport::startExport
Please use this example and modify it to your needs. The library provides you with the functionality to export XML according to the xml export documentation. The exported XML will be validated against a predefined XSD Schema.
Run export
The export can be triggered by URL in your browser:
https://<SHOP_URL>/findologic_export.php?shopkey=<SHOP_KEY>&start=<NUMBER>&count=<NUMBER>
- shopkey: API key provided by Findologic
- start: number that should not be lower than zero
- count: number that should not lower than zero and “start” number
This export url has to be set in the Findologic Account Settings, see documentation.
If you have troubles with the export please contact us at support@findologic.com.