Upgrade and Migration
If you have previously installed an older version (v2.x or v3.x) of the Klevu module, there will be Klevu Analytics data and configuration already present in your database. This data, however, cannot be used by the latest (v4.x) modules and must be migrated.
This will be done automatically for you the first time bin/magento setup:upgrade is run after installation of the new module.
Note: migration functionality is not available natively during beta release.
Setup patches can be provided on request.
All existing Magento orders which are present in the previous Klevu order sync database table (`klevu_order_sync`) will be created, with a corresponding sync status; the order history will contain a “Migration” entry.
Older versions of the Klevu module tracked order items discretely, with a database entry for each product purchased. This has been replaced by order-level tracking in the latest version of the extension.
Orders which cannot be converted automatically will be recorded to the corresponding store’s Analytics log at an ERROR level.
Unprocessed orders - given a Queued status - will be picked up and sent on the next sync operation.
Records will not be removed from the legacy database table. You may manually truncate or drop the klevu_order_sync if you choose; always remember to back up your data prior to performing destructive actions.
Configuration settings in older versions of the module are stored using a different internal path. During migration, a number of these values are copied to their corresponding v4 paths where applicable.
Legacy settings are not deleted from the native core_config_datatable but will have no impact on the operation of installation after legacy Klevu code is removed.
Settings which are automatically migrated include
Legacy Setting | New Setting | Notes |
|---|---|---|
Klevu > Search Configuration > Data Sync Settings |
|
|
[…] > Enable Order Sync | Klevu > Data Sync > Order Analytics > Order Sync Status |
|
[…] > Order Sync Frequency | Klevu > Data Sync > Order Analytics > Order Sync Frequency |
|
[…] > Custom Order Sync Frequency | Klevu > Data Sync > Order Analytics > Custom Order Sync Frequency | Field is only displayed where Order Sync Frequency is set to “Custom” |
Klevu > Search Configuration > Developer Settings |
|
|
[…] > Order Sync Max Batch Size | Klevu > Developer Settings > Order Analytics > Order Sync Max Batch Size |
|
[…] > IP Address Field for Order Data | Klevu > Developer Settings > Order Analytics > IP Address Field for Order Data |
|
