Entities

We define an entity as a Category, CMS page or Product. Merchants can also add their own modules to index any custom entity types.

Klevu’s Data Indexing JSON API is used to index all entity data.

Upon installation, the Klevu module will create a database table klevu_indexing_entity to maintain the status of all entities. This database is automatically populated via entity discovery (run via cron 5 minutes after account integration). This database table is updated whenever relevant entity data is changed. e.g. a name change or an entity is enabled/disabled. These changes will update the next_action column. The next_action will be set to either , Add, Update or Delete. This column defines what will happen during the next sync.

Indexing for each entity type can be controlled in the admin. Navigate to Stores > Configuration > Klevu > Data Sync under the Indexing tab you’ll see the following settings to enable/disable indexing for each entity type. You can also set the height and width of the images indexed to Klevu.



There are further indexing settings located Stores > Configuration > Klevu > Developer Settings. These settings enable you to control if Entity status or stock levels should be considered when adding or removing an entity from indexing.