This projects is a native, Magento1 data indexer for Vue Storefront - first Progressive Web App for e-Commerce. It fills the ElasticSearch data index with all the products, categories and static information required by Vue Storefront to work.
Vue Storefront is a standalone PWA storefront for your eCommerce, possible to connect with any eCommerce backend (eg. Magento, Pimcore, Prestashop or Shopware) through the API.
Please note: This indexer is a part of magento1-vsbridge connector for Magento1.
Sign up for a demo at https://vuestorefront.io/ (Vue Storefront integrated with Pimcore OR Magento2).
- version: beta 1.0.0
- extension key: Divante_VueStorefrontIndexer
This module is in beta, however we've used it in some production sites already. Please do feel free to test it and bring Your feedback + Pull Requests :)
Full synchronization: products, categories, attribute, tax rules, cms blocks. Synchronization in real time for: products, categories, attributes, cms blocks.
Module listen on following Magento1 events:
- product save (in backend panel),
- product deletion (in backend panel)
- mass product update,
- category save,
- category deletion,
- attribute save,
- attribute deletion (after attribute is removed full product synchronization will be fired),
- cms block save,
- cms block deletion.
- PHP >= 5.5.0
- Magento 1.9.*
- ElasticSearch 5.*
- ...
- Magento >= 1.9
- Vue Storefront >= 1.7
Command php -f vsf_tools.php -- --action full_reindex --store X will reindex all data to new index.
It will create new index and switch aliases at the end.
If you used previous versions, you will have to delete index from ES manually.
If you won't do that, you will get error when running
"error":{"root_cause":[{"type":"invalid_alias_name_exception","reason":"Invalid alias name [vue_storefront_magento_1], an index exists with the same name as the alias"
- Install Magento module Divante_VueStorefrontIndexer using modman or by coping code from src/
- Configure the module in Magento admin panel and run full indexation
Go to the new ‘Indexer’ section (Stores → Configuration → Vuestorefront → Indexer), available now in the in the Magento Panel, and configure it in the listed areas:
-
General settings → List of stores to reindex
Select stores for which data must be exported to ElasticSearch. By default stores 0 to 1 are selected. For each store view, a new, separate ElasticSearch index is created.
-
Elasticsearch Client
Configure connection with ElasticSearch. Provide a host, port, and set up login and password (optionally).
-
Indices settings
Batch Indexing Size → select size of packages by which you intend to send data to ElasticSrearch. Depending on the project you might need to adjust package size to the number of products, attributes, configurable products variation, etc). By default Batch, Indexing Size is set up for 1000. Indicies settings. Adjust indexing batch size to your data.
Index Alias Prefix → define prefixes for ElasticSearch indexes. The panel allows adding prefix only to the catalog name e.g.: "vue_storefront_catalog". For each store (store view) index name is generated on the base of defined prefix and ID. Aliases cannot be created. Note: change to "vue_storefront_catalog" to make it compatible with mage2vuestorefront import.
Index Identifier → defines the unique store identifier to append to the ElasticSearch indexes. The default value is ID which will append the Store ID to the index name e.g.: "vue_storefront_catalog_1". You can choose to change this to Store Code which will add the Store Code to the index name e.g.: "vue_storefront_catalog_storecode".
Add Index Identifier to Default Store View → defines if we should add Index Identifier to Magento Default Store View. Select "No" - to make it compatible with mage2vuestorefront import.
Example: When we define following indexes: "vue_storefront_catalog_1", "vue_storefront_catalog_2", "vue_storefront_catalog_3", their name will remain unchanged, and only product and category names will be updated. Important: It is crucial to update this configuration in the VSF and VSF-API (one change at the beginning of the whole configuration process).
The maximum number of fields in an index -> allow to setup value for option
index.mapping.total_fields.limit -
Redis Cache Settings
Clear cache → No/Yes (by default this option is disabled)
VSF base Url → URL for VSF
Invalidate Secret cache key → provide the same value as in the VSF configuration
Connection timeout → by default set up for 10 seconds
-
Catalog Settings
Use Short Catalog Urls → by default this option is disabled. The short Catalog Urls must be aligned with the VSF configuration. After any changes in the VSF configuration, the configuration in the Magento Panel must be updated and all products and categories indexed anew.
Types of products to index → by default all product will be exported to ElasticSearch. This option allows for selecting certain product types that should be exported.
After updating the configuration, you can run the indexation. It is also worth query ElasticSearch using CURL, to be sure that the communication works.
You can run full synchronization (for products, categories, attributes, cms blocks) or for specific type.
cd [magento root dir]/shell
php -f vsf_tools.php -- --action full_reindex --store STORE_ID
cd [magento root dir]/shell
php -f vsf_tools.php -- --action full_reindex --store STORE_ID --type [taxrules|products|categories|attributes|cms_blocks]
php -f vsf_tools.php -- --action full_reindex --store STORE_ID --type attributes
It is worth, to begin with taxrules as it is the fastest.
Setup Cron job to update data in ElasticSearch in real time (for products, categories, attributes, cms blocks)
e.g.
*/5 * * * * cd [full path to magento directory]/shell && /usr/bin/flock -n /tmp/vsf_index.lock /usr/bin/php vsf_tools.php --action reindex
MIT
(c) 2018 Divante