Integration
During installation configuration settings from v2.x/v3.x have been migrated to v4.x except for the Auth Keys.
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.
To integrate your Klevu Auth keys with your Magento store.
- Login to Magento admin
- Navigate to Stores > Configuration > Klevu > Integration
- Select the store from the table to integrate and click Integrate Store in the actions column.
- A modal will open containing the integration form.
- Your Auth Keys from v2.x/v3.x will pre-populate the integration form. If this store was not previously integrated then the form will be empty.
- Click Check API Keys to check if the provided keys:
- are for an enabled account,
- are registered for a Magento store,
- are set up for JSON indexing and not XML indexing
If this validation fails, error messages will be displayed at the top of the modal with more information.
- Account Details will be displayed for this account. Ensure this is the account you wish to integrate with this store. If so, click Save API Keys This step may take a moment while. There are 3 processes running:
- Trigger Attribute Discovery - find all your attributes, calculate if they need to be registered with Klevu and populate the klexu_indexing_attribute table.
- Trigger Attribute Registration - registering those attributes, via API, that need to be registered with Klevu to enable entity sync.
- Queue Entity Discovery - add a cron task to find all your entities, calculate if they need to be indexed with Klevu and populate the klexu_indexing_entity table. This step is triggered via cron rather than synchronously as it can take some time depending on how many entities (categories, CMS pages and products) your store has.
- At this point the integration is complete. The remaining steps guide where to find certain settings within the Klevu plugin related to frontend, analytics and indexing. They can be skipped by closing the modal if you desire.
Note: The discovery and indexing of entities is not triggered during the integration, but is handled via the cron. In a production environment the cron must be running, however, while testing the cron may not be running. Entity indexing can also be triggered via CLI (see Indexing - Entities).
As with all cron tasks added by version v4.x of the Klevu integration, entity discovery and sync cron tasks use the dedicated klevu group, allowing granular configuration of scheduling and run options.
We recommend using the native Magento cron to run these jobs, configuring schedules if necessary, rather than a custom server-side cron implementation of the CLI command.
