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/07/17 09:40] daniel [Running export] |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Integration with Shopware Plugin ===== | ||
| - | ---- | ||
| - | |||
| - | <note>[[https://store.shopware.com/fin1848466805161f/findologic-suche-navigation.html|You can download our plugin for Shopware in the Shopware store]]</note> | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== General ==== | ||
| - | |||
| - | 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. | ||
| - | |||
| - | 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 | ||
| - | |||
| - | ---- | ||
| - | |||
| - | |||
| - | ==== Installation ==== | ||
| - | |||
| - | 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: | ||
| - | |||
| - | <note important>Before you install a new Findologic plugin, please remove any other old Findologic plugin.</note> | ||
| - | |||
| - | * 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|}} | ||
| - | |||
| - | * In the left side menu, click on “Installed”. | ||
| - | |||
| - | {{:integration_documentation:direct_integration:shopware_di_2.png|}} | ||
| - | |||
| - | * The plugin should be listed in the uninstalled plugins. | ||
| - | * Click on the green circle to install it. | ||
| - | |||
| - | {{:integration_documentation:direct_integration:shopware_di_3.png|}} | ||
| - | |||
| - | * Then you will be prompted to clear the cache. Click “Yes”. | ||
| - | |||
| - | {{:integration_documentation:direct_integration:shopware_di_4.png|}} | ||
| - | |||
| - | * Then click on the “Activate” button. | ||
| - | |||
| - | {{:integration_documentation:direct_integration:shopware_di_5.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”. | ||
| - | |||
| - | <note important>Shopkey must be entered in valid format or error will be shown</note> | ||
| - | <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. | ||
| - | {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} | ||
| - | |||
| - | |||
| - | * Finally, the cache of the shop must be cleared. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== 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. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== 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. | ||