integration_documentation:plugin:en:direct_integration:oxid
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
integration_documentation:plugin:en:direct_integration:oxid [2021/01/25 14:10] dominik created |
integration_documentation:plugin:en:direct_integration:oxid [2022/01/17 13:44] daniel removed |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{:integration_documentation:plugins:oxid-logo.png?nolink|}} | {{:integration_documentation:plugins:oxid-logo.png?nolink|}} | ||
| - | ===== Integration with Oxid plugin ===== | + | <markdown> |
| + | ## Integration with OXID plugin | ||
| - | Supports OXID 4.x and 6.x and is used for Direct Integration. | + | Supports OXID 4.x and 5.x/6.x and is used for Direct Integration. |
| + | ## Download | ||
| - | ==== Download ==== | + | ### Main plugin |
| - | === Findologic search & navigation === | + | The **Findologic Search & Navigation** plugin is downloaded from the OXID stackexchange store: |
| - | * At exchange.oxid-esales.com | + | * [CE 4.7.x - 6.3.x](https://exchange.oxid-esales.com/Frontend-and-User-Experience/Search-Navigation-and-Filters/Findologic-Search-Navigation-1-0-0-Stable-CE-4-7-x-6-2-x.html?listtype=search&searchparam=findologic) |
| - | * [[https://exchange.oxid-esales.com/Frontend-and-User-Experience/Search-Navigation-and-Filters/Findologic-Search-Navigation-1-0-0-Stable-CE-4-7-x-6-2-x.html?listtype=search&searchparam=findologic|Oxid 4.7.x - 6.2.x CE]] | + | * [EE/PE 4.7.x/5.0.x - 6.3.x](https://exchange.oxid-esales.com/Frontend-and-User-Experience/Search-Navigation-and-Filters/Findologic-Search-Navigation-1-0-0-Stable-EE-PE-4-7-x-5-0-x-6-2-x.html?listtype=search&searchparam=findologic) |
| - | * [[https://exchange.oxid-esales.com/Frontend-and-User-Experience/Search-Navigation-and-Filters/Findologic-Search-Navigation-1-0-0-Stable-EE-PE-4-7-x-5-0-x-6-2-x.html?listtype=search&searchparam=findologic|Oxid 4.7.x/5.0.x - 6.2.x PE / EE]] | + | |
| - | + | ||
| - | === Findologic export === | + | |
| - | * Download [[https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_4_6_export_plugin.zip|Findologic export plugin]]. | + | ### Demo export plugin |
| - | ==== Install search & navigation plugin ==== | + | The **Findologic Export** plugin zip can be downloaded here: |
| - | * Open the OXID admin and activate the module **Findologic - Search & Navigation Platform**. | + | * [CE/EE/PE 4.7.x - 6.3.x](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_4_6_export_plugin.zip) |
| - | * Click on Settings and insert the shop key provided by Findologic and press save. | + | </markdown> |
| + | <note tip>By default the export plugin contains only demo product data, it's necessary to export the actual product data with the help of libflexport.</note> | ||
| - | {{:integration_documentation:plugins:oxid_shopkey.png|}} | + | <markdown> |
| + | ## Installation | ||
| - | * Clear shop cache or remove tmp files with: | + | See also [OXID documentation](https://docs.oxid-esales.com/developer/en/6.2/development/modules_components_themes/module/tutorials/module_setup.html). |
| - | <code shell> | + | |
| - | rm <shop_directory>/source/tmp/* | + | |
| - | </code> | + | |
| - | ==== Install export plugin ==== | + | ### Main plugin |
| - | * See also [[https://docs.oxid-esales.com/developer/en/6.2/development/modules_components_themes/module/tutorials/module_setup.html|OXID documentation]]. | + | * 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 | ||
| + | ` | ||
| - | * Copy the **findologic-export** folder to the plugin directory at **<shop_directory>/source/modules**. | + | * Register module package: |
| + | ```bash | ||
| + | composer config repositories.findologic/findologic path source/modules/findologic/findologic | ||
| + | composer require findologic/search --no-plugins --no-scripts | ||
| + | ``` | ||
| - | * Install module configuration: | + | #### Activation & Configuration |
| - | <code shell> | + | |
| - | cd <shop_directory> | + | |
| - | vendor/bin/oe-console oe:module:install-configuration source/modules/findologic-export/findologic-export | + | |
| - | </code> | + | |
| - | * Register module package in project composer.json: | + | ##### OXID 6.1 and lower |
| - | <code shell> | + | |
| - | cd <shop_directory> | + | |
| - | composer config repositories.findologic/findologic-export path source/modules/findologic-export/findologic-export | + | |
| - | composer require findologic/export | + | |
| - | </code> | + | |
| - | * Install dependencies: | + | * Open the OXID admin and activate the module **Findologic - Search & Navigation Platform**. |
| - | <code shell> | + | * Click on Settings and insert the shop key provided by Findologic and press save. |
| + |  | ||
| + | |||
| + | * 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: | ||
| + | ```bash | ||
| + | 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: | ||
| + | ```yaml | ||
| + | # ... | ||
| + | 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 | ||
| + | ```bash | ||
| + | composer config repositories.findologic/findologic-export path source/modules/findologic-export/findologic-export | ||
| + | composer require findologic/export --no-plugins --no-scripts | ||
| + | ``` | ||
| + | * Install plugin dependencies: | ||
| + | ```bash | ||
| cd <shop_directory>/source/modules/findologic-export/findologic-export | cd <shop_directory>/source/modules/findologic-export/findologic-export | ||
| composer install | composer install | ||
| - | </code> | + | ``` |
| - | * Open the OXID admin and activate the module **Findologic - Export**. | + | #### Activation & Configuration |
| + | |||
| + | * Open the OXID admin and activate the module **Findologic - Export**. | ||
| + | * By the default the export plugin does not have any configuration options. | ||
| + | |||
| + | </markdown> | ||
| ==== Product export ==== | ==== Product export ==== | ||
| Line 67: | Line 113: | ||
| The export is triggerred by the [[https://github.com/findologic/plugin-oxid-di|plugin-oxid-di]] module and | The export is triggerred by the [[https://github.com/findologic/plugin-oxid-di|plugin-oxid-di]] module and | ||
| - | calls | + | calls the extension plugin: |
| <code php>FindologicExport::startExport</code> | <code php>FindologicExport::startExport</code> | ||
| + | |||
| + | See file **findologic-export/findologic-export/FindologicExport.php**. | ||
| + | |||
| 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:xml_format|xml export documentation]]. The exported XML will be validated against a predefined [[https://github.com/findologic/xml-export/blob/master/src/main/resources/findologic.xsd|XSD Schema]]. | 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:xml_format|xml export documentation]]. The exported XML will be validated against a predefined [[https://github.com/findologic/xml-export/blob/master/src/main/resources/findologic.xsd|XSD Schema]]. | ||
| + | |||
| + | Further information in [[https://github.com/findologic/libflexport/blob/develop/README.md|README]] of libflexport. | ||
| ==== Run export ==== | ==== Run export ==== | ||
| Line 81: | Line 132: | ||
| * **shopkey:** API key provided by Findologic | * **shopkey:** API key provided by Findologic | ||
| - | * **start:** number that should not be lower than zero | + | * **start:** number that should not be lower than zero, default 0. |
| - | * **count:** number that should not lower than zero and “start” number | + | * **count:** number that should not lower than zero and “start” number, default 20. |
| This export url has to be set in the Findologic Account [[https://account.findologic.com/#/app/search-navigation/import-export|Settings]], see [[customer_account:import-export|documentation]]. | This export url has to be set in the Findologic Account [[https://account.findologic.com/#/app/search-navigation/import-export|Settings]], see [[customer_account:import-export|documentation]]. | ||
| - | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | + | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com] |
| + | ]. | ||