integration_documentation:plugin:en:direct_integration:oxid
Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
integration_documentation:plugin:en:direct_integration:oxid [2021/02/17 09:31] dominik |
integration_documentation:plugin:en:direct_integration:oxid [2022/01/17 13:44] daniel removed |
||
---|---|---|---|
Line 12: | Line 12: | ||
The **Findologic Search & Navigation** plugin is downloaded from the OXID stackexchange store: | The **Findologic Search & Navigation** plugin is downloaded from the OXID stackexchange store: | ||
- | * [CE 4.7.x - 6.2.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) | + | * [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) |
- | * [EE/PE 4.7.x/5.0.x - 6.2.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) | + | * [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) |
- | ### Export plugin | + | ### Demo export plugin |
The **Findologic Export** plugin zip can be downloaded here: | The **Findologic Export** plugin zip can be downloaded here: | ||
- | * [CE/EE/PE 4.7.x - 6.2.x](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_4_6_export_plugin.zip) | + | * [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) |
+ | |||
+ | </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> | ||
+ | <markdown> | ||
## Installation | ## Installation | ||
Line 27: | Line 31: | ||
### Main plugin | ### Main plugin | ||
- | * Copy the `findologic` folder to the plugin directory at `<shop_directory>/source/modules`. | + | * Copy the `findologic` folder to the plugin directory `<shop_directory>/source/modules`. |
* Move the file `findologic/findologic/findologic_export.php` to `<shop_directory>/source` | * Move the file `findologic/findologic/findologic_export.php` to `<shop_directory>/source` | ||
- | * Install module configuration: | + | * Install module configuration: `vendor/bin/oe-console oe:module:install-configuration source/modules/findologic/findologic |
- | ```bash | + | ` |
- | cd <shop_directory> | + | |
- | vendor/bin/oe-console oe:module:install-configuration source/modules/findologic/findologic | + | |
- | ``` | + | |
- | * Register module package in project composer.json: | + | * Register module package: |
```bash | ```bash | ||
composer config repositories.findologic/findologic path source/modules/findologic/findologic | composer config repositories.findologic/findologic path source/modules/findologic/findologic | ||
Line 41: | Line 42: | ||
``` | ``` | ||
- | ### Activation & Configation | + | #### Activation & Configuration |
- | #### OXID 6.1 and lower | + | ##### OXID 6.1 and lower |
- | * Open the OXID admin and activate the module Findologic - Search & Navigation Platform. | + | * Open the OXID admin and activate the module **Findologic - Search & Navigation Platform**. |
* Click on Settings and insert the shop key provided by Findologic and press save. | * Click on Settings and insert the shop key provided by Findologic and press save. | ||
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_shopkey.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_shopkey.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_shopkey.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:oxid_shopkey.png) | ||
- | * Clear shop cache or remove tmp files with | + | * Clear shop cache or remove tmp files manually: `rm <shop_directory>/source/tmp/*` |
- | ```bash | + | |
- | rm <shop_directory>/source/tmp/* | + | |
- | ``` | + | |
- | #### OXID 6.2 and higher | + | ##### OXID 6.2 and higher |
- | * Open the OXID admin and activate the module Findologic - Search & Navigation Platform. | + | * Open the OXID admin and activate the module **Findologic - Search & Navigation Platform**. |
* Generate configuration files: | * Generate configuration files: | ||
```bash | ```bash | ||
Line 81: | Line 79: | ||
# ... | # ... | ||
``` | ``` | ||
- | * Clear shop cache or remove tmp files with | + | * Clear shop cache or remove tmp files manually: `rm <shop_directory>/source/tmp/*` |
- | ```bash | + | |
- | rm <shop_directory>/source/tmp/* | + | |
- | ``` | + | |
### Export plugin | ### Export plugin | ||
* Copy the `findologic-export` folder to the plugin directory at `<shop_directory>/source/modules`. | * Copy the `findologic-export` folder to the plugin directory at `<shop_directory>/source/modules`. | ||
- | * Install module configuration | + | * Install module configuration: `vendor/bin/oe-console oe:module:install-configuration source/modules/findologic-export/findologic-export` |
- | ```bash | + | |
- | cd <shop_directory> | + | |
- | vendor/bin/oe-console oe:module:install-configuration source/modules/findologic-export/findologic-export | + | |
- | ``` | + | |
* Register module package in composer.json | * Register module package in composer.json | ||
Line 108: | Line 99: | ||
#### Activation & Configuration | #### Activation & Configuration | ||
- | * Open the OXID admin and activate the module Findologic - Export. | + | * Open the OXID admin and activate the module **Findologic - Export**. |
* By the default the export plugin does not have any configuration options. | * By the default the export plugin does not have any configuration options. | ||
Line 122: | 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 136: | 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] |
+ | ]. |