integration_documentation:plugin:en:integration:shopware_5
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:integration:shopware_5 [2021/04/22 15:40] daniel |
integration_documentation:plugin:en:integration:shopware_5 [2023/03/14 15:21] (current) tobi |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| ==== Download from Shopware store ==== | ==== Download from Shopware store ==== | ||
| * [[https://store.shopware.com/en/fin1848466805161f/findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] | * [[https://store.shopware.com/en/fin1848466805161f/findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] | ||
| - | |||
| - | ---- | ||
| ==== Installation ==== | ==== Installation ==== | ||
| Line 14: | Line 12: | ||
| * Activate the plugin. | * Activate the plugin. | ||
| - | ---- | + | ==== Configuration ==== |
| - | + | ||
| - | ==== Plugin configuration ==== | + | |
| In the plugin manager open the configuration by clicking on the pen icon. | In the plugin manager open the configuration by clicking on the pen icon. | ||
| Line 26: | Line 22: | ||
| * **Active for category pages:** Activate Findologic on navigation pages - for API integration. | * **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. | * **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. | * **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. | ||
| - | ---- | ||
| ==== Findologic Staging mode ==== | ==== Findologic Staging mode ==== | ||
| Line 54: | Line 46: | ||
| {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} | {{:integration_documentation:plugins:shopware_minimum-search-word-length.png|}} | ||
| - | |||
| ---- | ---- | ||
| - | ==== Run export ==== | + | ===== Product export ===== |
| - | The export can be triggered by URL in your browser: | + | ==== Default export ==== |
| - | <code> | + | Please see [[integration_documentation:plugin:en:integration:shopware_5:export_information|Shopware 5 - Export information]] to get an overview which values are exported by default and where they can be found in your Shopware 5 backend. |
| - | https://<SHOP_URL>/findologic?shopkey=<SHOP_KEY>&start=<NUMBER>&count=<NUMBER> | + | |
| - | </code> | + | |
| - | * **shopkey:** API key provided by Findologic | + | ==== Trigger product export ==== |
| - | * **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]]. | + | The export can be called with |
| + | |||
| + | <code>https://<SHOP_URL>/findologic?shopkey=<SHOP_KEY>&start=<NUMBER>&count=<NUMBER></code> | ||
| + | |||
| + | * **shopkey:** <SHOPKEY> provided by Findologic | ||
| + | * **start:** <NUMBER> that should not be lower than zero, default: 0. | ||
| + | * **count:** <NUMBER> that should be higher than zero, default: 20. | ||
| + | |||
| + | This export url should be used automatically in the [[https://account.findologic.com/#/app/search-navigation/import-export|Findologic Account]] for the data sync, see [[customer_account:import-export|documentation]]. | ||
| Products are going to be exported when: | Products are going to be exported when: | ||
| Line 77: | Line 72: | ||
| * Product is visible in standard search and product detail page. | * Product is visible in standard search and product detail page. | ||
| + | ==== Export specific product ==== | ||
| + | |||
| + | For testing purposes the export can be called for a specific product. If the product is not exported, it will list the errors, otherwise the XML is shown. | ||
| + | <code>https://<SHOP_URL>/findologic?shopkey=<SHOP_KEY>&productId=<PRODUCT_ID></code> | ||
| + | |||
| + | * **shopkey:** <SHOPKEY> provided by Findologic | ||
| + | * **productId:** Id or order number of the product | ||
| + | |||
| + | {{:integration_documentation:plugin:en:integration:shopware_5:debug_product_error.png?600|}} | ||
| + | |||
| + | <markdown> | ||
| + | --- | ||
| + | </markdown> | ||
| 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]]. | ||
| Line 82: | Line 90: | ||
| 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]]. | ||
| - | ---- | + | <markdown> |
| + | --- | ||
| + | |||
| + | ## Plugin extension | ||
| + | To extend the default behavior of the Findologic main plugin and still be able get the to latest plugin updates, we've created the [Findologic extension plugin](https://github.com/findologic/plugin-shopware-5-extension). It already contains some code for extending the export logic, but you can also extend the plugin to override search logic, or even the templates of filters. | ||
| + | |||
| + | For detailed information on how to use the extension and code examples, please follow: | ||
| + | * [Shopware 5 plugin extension](https://docs.findologic.com/doku.php?id=integration_documentation:plugin:en:integration:shopware_5:extension) in the Findologic documentation. | ||
| + | * [Extend an existing plugin via another plugin](https://developers.shopware.com/developers-guide/plugin-extension-by-plugin/) in the Shopware documentation. | ||
| - | ==== Integration of promotions ==== | + | |
| + | ## Integration of 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: | ||
| - | <code smarty> | + | ``` |
| {include file='frontend/fin_search_unified/promotion.tpl'} | {include file='frontend/fin_search_unified/promotion.tpl'} | ||
| - | </code> | + | ``` |
| This will add the following block of HTML to template: | This will add the following block of HTML to template: | ||
| - | <code smarty> | + | ``` |
| {block name="frontend_listing_promotion"} | {block name="frontend_listing_promotion"} | ||
| {if $finPromotion} | {if $finPromotion} | ||
| Line 104: | Line 121: | ||
| {/if} | {/if} | ||
| {/block} | {/block} | ||
| - | </code> | + | ``` |
| ---- | ---- | ||
| - | ==== Integration of Smart Did-You-Mean ==== | + | ## Integration of Smart Did-You-Mean |
| - | See [[integration_documentation:plugins:shopware_smart_did_you_mean|Customize Smart Did-You-Mean in Shopware 5]]. | + | See [Customize Smart Did-You-Mean in Shopware 5](https://docs.findologic.com/doku.php?id=integration_documentation:plugins:shopware_smart_did_you_mean). |
| ---- | ---- | ||
| - | ==== Default export ==== | ||
| - | |||
| - | Please see [[integration_documentation:plugin:en:integration:shopware_5:export_information|Shopware 5 - Export information]] to get an overview which values are exported by default and where they can be found in your Shopware 5 backend. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== 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 [[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. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== Variant export for Direct Integration ==== | ||
| - | The extension plugin already includes the code to export product variants in a JSON property, see | ||
| - | [[https://github.com/findologic/plugin-shopware-5-extension/blob/main/ExtendFinSearchUnified/BusinessLogic/Models/FindologicArticleModel.php|FindologicArticleModel::addVariantsJson()]] | ||
| - | |||
| - | ---- | ||
| - | ==== Troubleshooting ==== | + | ## Upgrade information |
| - | * Filters / Facets | + | Breaking changes to the main plugin will only be released in major releases (e.g. 10.x.x => 11.x.x) and a respective `UPGRADE-x.x` guide can be found at [GitHub](https://github.com/findologic/plugin-shopware-5). |
| - | * 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 | + | </markdown> |
| - | * 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. | + | |