Read Before Migrating
Klevu v2.x/v3.x uses XML indexing, v4.x uses JSON indexing. Your Klevu account must be upgraded before it will work with JSON indexing. This currently involves some manual steps to be performed by Klevu support. Therefore we do not automatically migrate your Auth Keys. This will lead to Klevu solutions being disabled on the frontend until your Auth Keys are re-integrated.
Please contact support to ensure your account can be upgraded before beginning any development work.
We are actively working on automating this upgrade of your account from XML indexing to JSON indexing and it is planned for an upcoming release.
To ensure all Klevu solutions continue to work on the frontend of your production site during migration please follow the recommended production migration process.
JSv1 is deprecated and therefore not supported in v4.x. If you are using JSv1 in v2.x/v3.x you can either remain on v2.x/v3.x or migrate to JSv2. Support for JSv1 will not be added in the future.
This is not currently supported in v4. Please do not upgrade if you are using Preserve Layout. This is planned for a future release.
Customisations to indexing (data sync) in v2.x/v3.x will not automatically work in v4
Customisations to the frontend in v2.x/v3.x may not automatically work in v4.x.
Indexing has been completely rebuilt from the ground up and has switched from using Klevu XML indexing to JSON indexing. If you have any customisations which extend a class or plugin to a class these will no longer work and will have to be re-created.
You may find that some customisations are no longer required due to improvements made, please see the indexing documentation for more information.
The frontend has been completely rebuilt. Any blocks/containers added by Klevu in v2.x/v3.x no longer exist. If you have used these blocks/containers to add any templates they will need to be added to new blocks/containers. If you have added templates via Magento core blocks/containers these will continue to be injected as expected.
Some frontend customisations may no longer be required. Changes to the Klevu options/settings object can now be made either via di.xml or the admin or both. Please see the Theme JS section of the Frontend documentation for more information.
Please also see the recommended best practice for making Theme JS changes as some of your existing templates may be improved upon.
