---
title: Entities
slug: klevu-magento-v4/entities
docTags: 
createdAt: 2024-08-06T15:17:24.642Z
---

## 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](https://docs.klevu.com/indexing-apis/swaggeropenapi-specification) 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.

:::hint{type="warning"}
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<br />\[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”. |



![](https://api.archbee.com/api/optimize/816_4eGYZQxALlijMlcBN/UqeawM8r5Vq3188X53w2m_screenshot-2024-03-26-at-095223.png "Stores > Configuration > Klevu > Data Sync > Indexing")

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”. |



![](https://api.archbee.com/api/optimize/816_4eGYZQxALlijMlcBN/EiAbj2IAl5Q1--hl73xMG_screenshot-2024-03-26-at-095254.png "Stores > Configuration > Klevu > Developer Settings > Indexing")