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 [2018/11/15 15:13] florian [Export customization] |
integration_documentation:shopware [2021/01/25 14:20] dominik removed |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Shopware Unified ===== | + | {{:integration_documentation:plugins:sw5-logo.png?nolink&400|}} |
| - | ==== General ==== | + | ===== Shopware 5 plugin integration ===== |
| - | The FINDOLOGIC Shopware Unified 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. | + | ==== Download from Shopware store ==== |
| + | * [[https://store.shopware.com/en/fin1848466805161f/findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]] | ||
| - | 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: | + | ---- |
| + | |||
| + | ==== Installation ==== | ||
| - | * product must be set to active | + | * As with other Shopware plugins: |
| - | * active category must be set | + | * Install the plugin via the Shopware store or the plugin manager in the Shopware backend. |
| - | * product is visible in standard search and on product detail site | + | * Activate the plugin. |
| ---- | ---- | ||
| - | ==== Download ==== | + | ==== Plugin configuration ==== |
| - | The plugin can be downloaded at [[https://store.shopware.com/fin1848466805161f/findologic-suche-unified.html|the Shopware Community Store]] and installed in Shops with Shopware version above 5.3. | + | 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. | ||
| ---- | ---- | ||
| - | ==== Installation ==== | + | ==== Findologic Staging mode ==== |
| - | The FINDOLOGIC Unified plugin installation procedure is basically the same as for any other Shopware 5 plugin. It can be summed up in a few simple steps: | + | During integration the Findologic service can be tested with the //Findologic Test// button or by calling |
| + | |||
| + | <code> | ||
| + | https://<SHOP_URL>/?findologic=on | ||
| + | </code> | ||
| - | <note important>Before you install a new FINDOLOGIC plugin, please remove any other old FINDOLOGIC plugin.</note> | + | The orange Findologic staging banner should be shown. |
| - | * 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:shopware_5_staging_mode.png?direct|}} |
| - | {{:integration_documentation:direct_integration:shopware_di_1.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> |
| - | * In the left side menu, click on “Installed”. | + | ==== Configure search word length ==== |
| - | {{:integration_documentation:direct_integration:shopware_di_2.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. |
| - | * The plugin should be listed in the uninstalled plugins. | + | * Clear Shopware cache after saving the setting. |
| - | * Click on the green circle to install it. | + | |
| - | {{:integration_documentation:direct_integration:shopware_di_3.png|}} | + | {{:integration_documentation:plugins:shopware_minimum-search-word-length.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. | + | ==== Run export ==== |
| - | {{:integration_documentation:direct_integration:shopware_di_5.png|}} | + | The export can be triggered by URL in your browser: |
| - | * In the “Configuration” tab, enter the shopkey provided by FINDOLOGIC. | + | <code> |
| + | https://<SHOP_URL>/findologic?shopkey=<SHOP_KEY>&start=<NUMBER>&count=<NUMBER> | ||
| + | </code> | ||
| - | {{:integration_documentation:direct_integration:shopware_di_6.png|}} | + | * **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 | ||
| - | * After you fill in this form, click “Save”. | + | 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]]. |
| - | <note important>Shopkey must be entered in valid format or error will be shown</note> | + | Products are going to be exported when: |
| + | * Product is active. | ||
| + | * Active category is set. | ||
| + | * Product is visible in standard search and product detail page. | ||
| - | * Finally, the cache of the shop must be cleared. | + | |
| + | 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]]. | ||
| ---- | ---- | ||
| - | ==== Running export ==== | + | ==== Integration of promotions ==== |
| - | The export is called via URL. For example: <SHOP_URL>/findologic?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER> | + | 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: |
| - | Three parameters are necessary for successfully running an export: | + | <code smarty> |
| + | {include file='frontend/fin_search_unified/promotion.tpl'} | ||
| + | </code> | ||
| - | * shopkey → <SHOPKEY> provided by FINDOLOGIC | + | This will add the following block of HTML to template: |
| - | * 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]]. | + | <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> | ||
| ---- | ---- | ||
| + | |||
| + | ==== Integration of Smart Did-You-Mean ==== | ||
| + | |||
| + | See [[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. |
| + | |||
| + | ---- | ||
| ==== Troubleshooting ==== | ==== Troubleshooting ==== | ||
| - | * Filtes / Facets | + | * Filters / Facets |
| - | * In the FINDOLOGIC customer account you can set and configure the filters which should be displayed in the shop. | + | * 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. | + | * The order of the filters is specified by Findologic and the visualization is handled by the Shopware template. |
| * Upgrading from earlier versions | * Upgrading from earlier versions | ||