integration_documentation:shopware
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
integration_documentation:shopware [2020/06/24 15:55] florian |
integration_documentation:shopware [2021/01/25 14:20] dominik removed |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Integration with Shopware Plugin ===== | + | {{:integration_documentation:plugins:sw5-logo.png?nolink&400|}} |
| - | ---- | + | ===== Shopware 5 plugin integration ===== |
| - | <note>[[https://store.shopware.com/fin1848466805161f/findologic-suche-navigation.html|You can download our plugin for Shopware in the Shopware store]]</note> | + | ==== Download from Shopware store ==== |
| + | * [[https://store.shopware.com/en/fin1848466805161f/findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] | ||
| ---- | ---- | ||
| - | ==== General ==== | + | ==== Installation ==== |
| - | The Findologic Shopware plugin needs to be implemented in the shop to export products and the relevant data for successful implementation of Findologic search. Besides product export, the plugin also injects the main Findologic snippet and automatically handles the implementation of the API or the Direct Integration. | + | * As with other Shopware plugins: |
| - | + | * Install the plugin via the Shopware store or the plugin manager in the Shopware backend. | |
| - | The plugin is going through all the shop's data, finding valid products to export. In order to be exported, following conditions must be met: | + | * Activate the plugin. |
| - | + | ||
| - | * product must be set to active | + | |
| - | * active category must be set | + | |
| - | * product is visible in standard search and on product detail site | + | |
| ---- | ---- | ||
| + | ==== Plugin configuration ==== | ||
| - | ==== Installation ==== | + | In the plugin manager open the configuration by clicking on the pen icon. |
| - | The Findologic plugin installation procedure is basically the same as for any other Shopware 5 plugin. It can be summed up in a few simple steps: | + | {{:integration_documentation:plugins:shopware_5_plugin_config.png?direct|}} |
| - | <note important>Before you install a new Findologic plugin, please remove any other old Findologic plugin.</note> | + | * **Shopkey:** Enter the shopkey provided by Findologic - **required** |
| + | * **Active:** Activate to enable Findologic search for your shop - **required** | ||
| + | * **Active for category pages:** Activate Findologic on navigation pages - for API integration. | ||
| + | * **Cross-Selling categories:** Select categories to exclude the products within from getting exported. Those products will not show up in search or navigation results, used for cross-selling products. | ||
| + | * **CSS class for main cotainter:** In case different html container should be used for Direct Integration, see [[https://docs.findologic.com/doku.php?id=integration_documentation:direct_integration|documentation]]. | ||
| + | * **CSS class for main cotainter on category pages:** In case different html container should be used for Direct Integration, see [[https://docs.findologic.com/doku.php?id=integration_documentation:direct_integration|documentation]]. | ||
| + | * **Integration (read only):** This field is set automatically and shows the used integration, either Direct Integration or API. | ||
| + | * **Findologic Test:** This button is shown when the Findologic integration is still in staging mode. Clicking the button will redirect you to the shop frontend, where Findologic can be tested. Please be aware that a successful product export must happen before the test mode can be used. | ||
| - | * The Findologic plugin needs to be downloaded and installed via the Shopware store (see link above) or the Plugin Manager in the Shopware backend. | + | ---- |
| - | {{:integration_documentation:direct_integration:shopware_di_1.png|}} | + | ==== Findologic Staging mode ==== |
| - | * In the left side menu, click on “Installed”. | + | During integration the Findologic service can be tested with the //Findologic Test// button or by calling |
| + | |||
| + | <code> | ||
| + | https://<SHOP_URL>/?findologic=on | ||
| + | </code> | ||
| - | {{:integration_documentation:direct_integration:shopware_di_2.png|}} | + | The orange Findologic staging banner should be shown. |
| - | * The plugin should be listed in the uninstalled plugins. | + | {{:integration_documentation:shopware_5_staging_mode.png?direct|}} |
| - | * Click on the green circle to install it. | + | |
| - | {{:integration_documentation:direct_integration:shopware_di_3.png|}} | + | <note tip>When the staging mode is used for the first time it's necessary to reload the page with **Ctrl + Shift + R**</note> |
| - | * Then you will be prompted to clear the cache. Click “Yes”. | + | ==== Configure search word length ==== |
| - | {{:integration_documentation:direct_integration:shopware_di_4.png|}} | + | * In order for the **category** and the **vendor** suggestions of the Findologic Smart Suggest to work properly it is necessary to set the minimal allowed length of the search word to 0. |
| - | * Then click on the “Activate” button. | + | * Clear Shopware cache after saving the setting. |
| - | {{:integration_documentation:direct_integration:shopware_di_5.png|}} | + | {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} |
| - | * In the “Configuration” tab you have to: | ||
| - | * Enter the shopkey provided by Findologic. | ||
| - | * Enter the CSS classes, which specify the containers where the content of Findologic is loaded into. Find more information about this topic [[https://docs.findologic.com/doku.php?id=integration_documentation:direct_integration|here]]. | ||
| - | {{:integration_documentation:plugin-config.jpg|}} | + | ---- |
| - | * After you fill in this form, click “Save”. | + | ==== Run export ==== |
| - | <note important>Shopkey must be entered in valid format or error will be shown</note> | + | The export can be triggered by URL in your browser: |
| - | <note>You can test the current integration in a staging via the "Findologic Test" button.</note> | + | |
| - | * In order for the //category// and the //vendor// block of the Findologic Smart Suggest to work properly it is necessary to set the minimal allowed length of the search word to 0. | + | <code> |
| - | {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} | + | https://<SHOP_URL>/findologic?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 | ||
| - | * Finally, the cache of the shop must be cleared. | + | 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]]. |
| - | ---- | + | Products are going to be exported when: |
| + | * Product is active. | ||
| + | * Active category is set. | ||
| + | * Product is visible in standard search and product detail page. | ||
| - | ==== Running export ==== | ||
| - | The export is called via URL. For example: <SHOP_URL>/findologic?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER> | + | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. |
| - | + | ||
| - | Three parameters are necessary for successfully running an export: | + | |
| - | + | ||
| - | * shopkey → <SHOPKEY> provided by Findologic | + | |
| - | * start → <NUMBER> that should not be lower than zero | + | |
| - | * count → <NUMBER> that should not be lower than zero | + | |
| The generated XML is validated against our predefined [[https://raw.githubusercontent.com/FINDOLOGIC/xml-export/master/src/main/resources/findologic.xsd|XSD scheme]] and built with our export library [[https://github.com/findologic/libflexport|libflexport]]. | The generated XML is validated against our predefined [[https://raw.githubusercontent.com/FINDOLOGIC/xml-export/master/src/main/resources/findologic.xsd|XSD scheme]] and built with our export library [[https://github.com/findologic/libflexport|libflexport]]. | ||
| Line 80: | Line 84: | ||
| ---- | ---- | ||
| - | ==== Additional templates ==== | + | ==== Integration of promotions ==== |
| - | + | ||
| - | To be able to provide all the Findologic features which are not support by Shopware out of the box, you need to implement additional templates within the search template of the shop. | + | |
| - | + | ||
| - | **Promotions** | + | |
| The promotion template will be provided by the plugin if there is a match with the query and can be added via the following smarty-plugin: | The promotion template will be provided by the plugin if there is a match with the query and can be added via the following smarty-plugin: | ||
| Line 108: | Line 108: | ||
| ---- | ---- | ||
| - | ==== Implementing Smart Did-You-Mean ==== | + | ==== Integration of Smart Did-You-Mean ==== |
| + | See [[integration_documentation:plugins:shopware_smart_did_you_mean|documentation]]. | ||
| - | In order to implement Smart Did-You-Mean please have a look at the following [[integration_documentation:plugins:shopware_smart_did_you_mean|documentation]]. | ||
| ==== Export customization ==== | ==== Export customization ==== | ||
| - | The plugin can be extended by following the [[https://developers.shopware.com/developers-guide/plugin-extension-by-plugin/|Shopware plugin system standard]]. All important classes are registerd as services. Findologic provides a boilerplate plugin on [[https://github.com/findologic/extend-shopware-unified|Github]] which can be copied and used as a quickstart to customize the export. | + | The plugin can be extended by following the [[https://developers.shopware.com/developers-guide/plugin-extension-by-plugin/|Shopware plugin system standard]]. All important classes are registerd as services. Findologic provides a boilerplate plugin [[https://github.com/findologic/plugin-shopware-5-extension|plugin-shopware-5-extension]] which can be copied and used as a quickstart to customize the export. |
| ---- | ---- | ||