integration_documentation:plugin:en:direct_integration:magento_2
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
integration_documentation:plugin:en:direct_integration:magento_2 [2021/01/25 14:09] dominik created |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | {{:integration_documentation:plugins:magento_logo.png?nolink&400|}} | ||
| - | ===== Integration with Magento 2 plugin ===== | ||
| - | Supports Magento 2.x for Direct Integration. | ||
| - | |||
| - | ===== Download ===== | ||
| - | |||
| - | - Download Findologic search & navigation from the [[https://marketplace.magento.com/findologic-search-and-navigation-platform.html|Magento Marketplace]]. | ||
| - | - Download the [[https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugins:magento_2_export_plugin.zip|Findologic export plugin]]. The following steps need to be followed also for the export plugin. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | Also available on Github for developers: | ||
| - | * [[https://github.com/findologic/plugin-magento-2-di/|plugin-magento-di]] for Findologic search & navigation platform. | ||
| - | * [[https://github.com/findologic/plugin-magento-2-di-export/|plugin-magento-2-di-export]] for Findologic product export. | ||
| - | |||
| - | ===== Install plugin ===== | ||
| - | |||
| - | - Navigate to the directory of your Magento shop (root directory). | ||
| - | - Extract the plugin archive and move the folder Findologic to the directory **/app/code**. Create **code** directory in case it doesn't exist. | ||
| - | - In the root directory include the [[https://github.com/findologic/libflexport|Findologic export library]] by executing <code shell>composer require findologic/libflexport</code> | ||
| - | |||
| - | When both plugins have been copied the file structure should look like: | ||
| - | {{:integration_documentation:plugins:magento_module_file_structure.png|}} | ||
| - | |||
| - | |||
| - | ===== Enable the extension ===== | ||
| - | |||
| - | There are two ways to enable this extension: | ||
| - | |||
| - | * [[#magento_module_manager|Magento Module Manager]] | ||
| - | * [[#using_the_command_line_interface|Using the command line interface]] | ||
| - | |||
| - | |||
| - | ==== Magento Module Manager ==== | ||
| - | |||
| - | |||
| - | * In your Magento backend navigate to //SYSTEM -> Web Setup Wizard//. | ||
| - | |||
| - | {{:integration_documentation:1_web_setup_wizard.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Choose the Module Manager. | ||
| - | |||
| - | {{:integration_documentation:2_module_manager.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Go to the extension //Findologic_Search// and click //Select -> Enable//. | ||
| - | |||
| - | {{:integration_documentation:3_enable.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Click //Start Readiness Check// and wait for the checks to pass, afterwards click //Next//. | ||
| - | |||
| - | {{:integration_documentation:4_1_readiness.png}} | ||
| - | |||
| - | {{:integration_documentation:4_2_readiness.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Although not strictly required, we highly recommend you to perform a backup. Check all backup options and click //Create Backup//. | ||
| - | |||
| - | {{:integration_documentation:5_1_backup.png}} | ||
| - | |||
| - | {{:integration_documentation:5_2_backup.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Click //Enable// and Magento 2 will enable //Findologic_Search// and clear all relevant caches. | ||
| - | |||
| - | <note>Please note that your shop will be in maintenance mode until the extension is enabled.</note> | ||
| - | |||
| - | {{:integration_documentation:6_enable.png}} | ||
| - | |||
| - | Continue with [[#configure_extension|configure extension]]. | ||
| - | |||
| - | \\ | ||
| - | |||
| - | ==== Using the command line interface ==== | ||
| - | |||
| - | * Go to the root directory of your Magento shop. | ||
| - | * Check status of modules by executing <code bash>bin/magento module:status</code> | ||
| - | * Enable the modules by executing | ||
| - | <code bash>bin/magento module:enable Findologic_Search</code> | ||
| - | <code bash>bin/magento module:enable Findologic_Export</code> | ||
| - | |||
| - | {{:integration_documentation:1_enable.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Clear compiled code and cache by executing <code bash>bin/magento setup:upgrade</code> | ||
| - | |||
| - | {{:integration_documentation:2_upgrade.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Generate application code by executing <code bash>bin/magento setup:di:compile</code> | ||
| - | |||
| - | {{:integration_documentation:3_compile.png}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | * Deploy static view files by executing <code bash>bin/magento setup:static-content:deploy</code> | ||
| - | |||
| - | {{:integration_documentation:4_deploy.png}} | ||
| - | |||
| - | |||
| - | ===== Configure extension ===== | ||
| - | |||
| - | Once the extension Findologic Search & Navigation has been enabled successfully, the last thing left to do is configuring it properly. | ||
| - | |||
| - | * In your Magento backend navigate to //Stores -> Configuration//. | ||
| - | |||
| - | {{:integration_documentation:1_configuration.png}} | ||
| - | |||
| - | * Click on //Findologic -> Configuration//. | ||
| - | * Enter the Shopkey that you received from Findologic to the input field and click //Save Config//. | ||
| - | |||
| - | {{:integration_documentation:2_shopkey.png}} | ||
| - | |||
| - | |||
| - | ===== Product export ===== | ||
| - | |||
| - | For the functionality of the plugin it's essential to export the product data from the shop to Findologic. | ||
| - | For this purpose, the Findologic export library [[https://github.com/findologic/libflexport|libflexport]] | ||
| - | is included. | ||
| - | |||
| - | <note tip>By default the export contains only demo product data, it's necessary to export the actual product data with the help of libflexport.</note> | ||
| - | |||
| - | The export is triggerred by the [[https://github.com/findologic/plugin-magento-2-di/|plugin-magento-di]] and | ||
| - | calls | ||
| - | <code php>Export::startExport</code> | ||
| - | |||
| - | Please use this example and modify it to your needs. The library provides you with the functionality to export XML according to the [[xml_export_documentation:xml_format|xml export documentation]]. The exported XML will be validated against a predefined [[https://github.com/findologic/xml-export/blob/master/src/main/resources/findologic.xsd|XSD Schema]]. | ||
| - | |||
| - | ==== Run export ==== | ||
| - | |||
| - | The export can be triggered by URL in your browser: | ||
| - | |||
| - | <code> | ||
| - | https://<SHOP_URL>/search/Export/ExportController?shopkey=<SHOPKEY>&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 | ||
| - | |||
| - | |||
| - | 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]]. | ||