integration_documentation:plugin:en:direct_integration:oxid

integration_documentation:plugin:en:direct_integration:oxid

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
integration_documentation:plugin:en:direct_integration:oxid [2021/04/20 12:11]
daniel
— (current)
Line 1: Line 1:
-{{:​integration_documentation:​plugins:​oxid-logo.png?​nolink|}} 
  
-<​markdown>​ 
-## 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: 
- 
-* [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) 
-* [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) 
- 
-### Export plugin 
- 
-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) 
- 
-</​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 
- 
-See also [OXID documentation](https://​docs.oxid-esales.com/​developer/​en/​6.2/​development/​modules_components_themes/​module/​tutorials/​module_setup.html). 
- 
-### 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: 
-```bash 
-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**. 
-* 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) 
- 
-* 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 
-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. 
- 
-</​markdown>​ 
- 
-==== 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 [[https://​github.com/​findologic/​libflexport|libflexport]] 
-is included. ​ 
- 
-<note tip>By default the export contains only demo product data, it's necessary to export the actual product data with the help of libflexport.</​note>​ 
- 
-The export is triggerred by the [[https://​github.com/​findologic/​plugin-oxid-di|plugin-oxid-di]] module and  
-calls the extension plugin: 
-<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]]. 
-Further information in [[README|https://​github.com/​findologic/​libflexport/​blob/​develop/​README.md]] of libflexport. 
- 
-==== Run export ==== 
- 
-The export can be triggered by URL in your browser: 
- 
-<​code>​ 
-https://<​SHOP_URL>/​findologic_export.php?​shopkey=<​SHOP_KEY>&​start=<​NUMBER>&​count=<​NUMBER>​ 
-</​code>​ 
- 
-  * **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 [[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]].