integration_documentation:shopware

integration_documentation:shopware

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:shopware [2020/10/06 07:28]
daniel
— (current)
Line 1: Line 1:
-===== Integration with Shopware 5 Plugin ===== 
  
-==== Download from Shopware store ==== 
-  * [[https://​store.shopware.com/​en/​fin1848466805161f/​findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] 
- 
----- 
- 
-==== Installation ==== 
- 
-  * As with other Shopware plugins: 
-    * Install the plugin via the Shopware store or the plugin manager in the Shopware backend. 
-    * Activate the plugin. 
- 
----- 
- 
-==== Plugin configuration ==== 
- 
-In the plugin manager open the configuration by clicking on the pen icon. 
- 
-{{:​integration_documentation:​plugins:​shopware_5_plugin_config.png?​direct|}} 
- 
-  * **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. 
- 
----- 
- 
-==== Configure search word length ==== 
- 
-  * 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. 
- 
-  * Clear Shopware cache after saving the setting. 
- 
-{{:​integration_documentation:​plugins:​shopware_minimum-search-word-length.png|}} 
- 
- 
----- 
- 
-==== Running export ==== 
- 
-The export is called via URL. For example: <​SHOP_URL>/​findologic?​shopkey=<​SHOPKEY>&​start=<​NUMBER>&​count=<​NUMBER>​ 
- 
-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 
- 
-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]]. 
- 
-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]]. 
- 
----- 
- 
-==== Additional templates ==== 
- 
-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:​ 
- 
-<code smarty> 
-{include file='​frontend/​fin_search_unified/​promotion.tpl'​} 
-</​code>​ 
- 
-This will add the following block of HTML to template: 
- 
-<code smarty> 
-{block name="​frontend_listing_promotion"​} 
-  {if $finPromotion} 
-    <div id="​fl-promotion"​ class="​panel has--border is--rounded">​ 
-      <div class="​panel--body is--wide">​ 
-        <a href="​{$finPromotion.link}"><​img class="​image"​ src="​{$finPromotion.image}"></​a>​ 
-      </​div>​ 
-    </​div>​ 
-  {/if} 
-{/block} 
-</​code>​ 
- 
----- 
- 
-==== Implementing Smart Did-You-Mean ==== 
- 
- 
-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 ==== 
- 
-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 is going through all the shop's data, finding valid products to export. In order to be exported, following conditions must be met: 
- 
-  * product must be set to active 
-  * active category must be set 
-  * product is visible in standard search and on product detail site 
- 
- 
-==== Troubleshooting ==== 
- 
-  * Filters / Facets 
-    * In the Findologic customer account you can set and configure the filters which should be displayed in the shop. 
-    * The order of the filters is specified by Findologic and the visualization is handled by the Shopware template. 
- 
-  * Upgrading from earlier versions 
-    * If there were no customizations made to the FinSearchAPI plugin, there is nothing todo. 
-    * If there were customizations (do this in a dev environment if possible): 
-      * Backup old plugin 
-      * Upgrade plugin 
-      * Reimplement old logic if needed by using another plugin as mentioned in the [[https://​docs.findologic.com/​doku.php?​id=integration%20documentation:​shopware#​export_customization|customization part]] of this documentation.