Entities

what is an entity? we define an entity as a category, cms page or product merchants can also add their own modules to index any custom entity types json api klevu’s data indexing json api is used to index all entity data database 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 admin stores configuration settings 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 by default, klevu will index all enabled entities, even if they are out of stock or not visible individually klevu > data sync > indexing scope enable category sync enable category sync \[store view] controls whether to index category data to klevu default value “yes” enable cms sync \[store view] controls whether to index cms page data to klevu default value “yes” enable product sync \[store view] controls whether to index product data to klevu default value “yes” product image width \[store view] determines the width of the images generated before indexing the link to klevu default value “130” product image height \[store view] determines the height of the images generated before indexing the link to klevu default value “130” 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 klevu > developer settings > indexing cms scope exclude disabled cms pages \[global] controls whether to exclude disabled cms pages from the klevu index default value “yes” klevu > developer settings > indexing products scope exclude disabled products \[global] controls whether to exclude disabled products from the klevu index default value “yes” exclude out of stock products \[global] controls whether to exclude out of stock products from the klevu index default value “no” klevu > developer settings > indexing categories scope exclude disabled products \[global] controls whether to exclude disabled categories from the klevu index default value “yes”