2. Set up your **Additional Product Attributes**:
### Base attributes (non-configurable)
The base set of attributes is always included in product indexing,
except when using the [`attributeListOverride` job step parameter](/doc/integration/salesforce-commerce-cloud-b2c/indexing/product-indexing/ongoing-indexing#scope),
which overrides both the base attributes and any additional product attributes configured for that job.
| Attribute | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name` | Name of the product |
| `__primary_category` | A hierarchy of the primary category. Used to create a [`hierarchicalMenu`](/doc/api-reference/widgets/hierarchical-menu/js). |
| `categoryPageId` | Array of category IDs assigned to the product. Used to create [category pages](/doc/guides/solutions/ecommerce/browse/tutorials/category-pages) |
| `url` | URL of the product's product detail page (PDP) |
| `image_groups` | Array of product image URLs |
| `in_stock` | `true` if the number of products available is greater than or equal to [In-Stock Threshold](/doc/integration/salesforce-commerce-cloud-b2c/getting-started/custom-preferences) you've set, `false` otherwise |
| `price` | Product price |
### Configurable attributes
You can choose to send additional Product record attributes such as the following to Algolia by defining them in **Additional Product Attributes**.
You should start with the following attributes: `short_description`, `long_description`, then expand the list according to your use case (for example `brand`, `color`, `size`).
| Attribute | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `EAN` | European Article Number of the product |
| `UPC` | Universal Product Code of the product |
| `brand` | Brand of the product. |
| `bundle` | Whether this product instance is a product bundle |
| `bundled` | Whether this product instance is bundled within at least one product bundle |
| `bundledProducts` | Collection containing all products that participate in the product bundle |
| `color` | Product color |
| `colorVariations` | Array with an entry for each color variation. Each entry contains the `image_groups` of the variation, the `variationUrl`, and the variation `color` |
| `long_description` | Full description of product |
| `lsImage` | Expose the first product image at the root of the Algolia record. Used by the [Looking Similar widget](/doc/integration/salesforce-commerce-cloud-b2c/guides/algolia-recommend#looking-similar-widget) |
| `manufacturerName` | Name of the product manufacturer |
| `manufacturerSKU` | Value of the manufacturer's stock keeping unit |
| `master` | Whether this product instance is a product master |
| `masterID` | ID of the master product |
| `newArrival` | Whether this product is part of the `newarrivals` category |
| `online` | Online status of the product. This is determined based on the product's `online` status flag, and the `onlineFrom` and `onlineTo` dates |
| `optionProduct` | Whether the product has options |
| `pageDescription` | Product page description in the default locale |
| `pageKeywords` | Product page keywords in the default locale |
| `pageTitle` | Product page title in the default locale |
| `productSetProduct` | Whether this product is part of any product set |
| `productSet` | Whether the instance represents a product set |
| `promotionalPrice` | Product's lowest promotional price, from the currently active promotions. |
| `promotions` | Array of promotions associated with the product. |
| `refinementColor` | Search refinement bucket of the `color`. |
| `searchable` | Whether the product is searchable |
| `size` | Product size |
| `short_description` | Short description of the product |
| `unit` | Sales unit of the product |
| `variant` | Whether this product instance belongs to a product master |
### Flexible attribute indexing based on default behavior
From version 24.5.0, the Algolia cartridge supports indexing any product attribute, even if they aren't explicitly listed as [configurable attributes](#configurable-attributes).
This feature simplifies the process of indexing custom or specific attributes, allowing for more flexible and comprehensive product data in your Algolia index without requiring extensive configuration.
For attributes that aren't explicitly listed, the cartridge uses the following default indexing configuration:
```js JavaScript icon=code theme={"system"}
{
attribute: attributeName,
localized: false,
variantAttribute: true
}
```
This means that by default, all unlisted attributes:
* Aren't localized
* Are indexed in the `variants` array (for the **[Base product](#base-product-record-example)** and **[Attribute-sliced](#attribute-sliced-record-example)** record models)
* Use the default Salesforce B2C Commerce attribute name (with dot notation)
To change this default behavior, override it with [advanced attributes configuration](#advanced-attributes-configuration).
#### Nested attributes
Nested attributes are grouped under their parent object in the Algolia record.
For example, if you want to index `activeData.impressionsDay` and `activeData.revenueDay`, they will be indexed in Algolia as:
```json JSON icon=braces theme={"system"}
{
"activeData": {
"impressionsDay": 5,
"revenueDay": 141
}
}
```
If you prefer indexing these attributes at the root level of your Algolia records, use the method described in the [advanced attributes configuration](#advanced-attributes-configuration) section.
### Usage
To use this feature:
1. Add the corresponding Salesforce B2C attribute names (including nested attributes) to the **Additional Product Attributes** list in the Algolia Business Manager module [Custom Preferences](/doc/integration/salesforce-commerce-cloud-b2c/getting-started/custom-preferences). Refer to custom attributes as `custom.- The full path to the SFCC Product attribute name, separated by dots.
- A function that takes the current product as parameter and returns data to be indexed in the Algolia record. | | `localized` | `boolean` | (*Optional*, default: `false`) Should be true if the attribute is localized. | | `variantAttribute` | `boolean` | (*Optional*, default: `false`) Only used with the **[Base product](#base-product-record-example)** and **[Attribute-sliced](#attribute-sliced-record-example)** record models, to identify attributes indexed in the `variants` array. | | `computedFromBaseProduct` | `boolean` | (*Optional*, default: `false`) Only used with the **[Variation product](#variation-product-record-example)** record model, to identify attributes computed once from the base product, and indexed into each variant. | The `attribute` property lets you declare attributes with their direct name (simple values like `name`, `brand`, etc.) or their "path", for nested values with direct access. For example, you can access the `revenueWeek` attribute of a product's `activeData` object by declaring `activeData.revenueWeek`. Other values are more complex and must be computed. For that, the `attribute` property accepts a function to define how to export such complex attributes. ```js JavaScript expandable icon=code theme={"system"} /* productAttributesConfig.js */ module.exports = { /* ... */ algoliaAttributeName: { /* Access directly a product's property (or nested property) */ attribute: "activeData.revenueWeek", localized: false, }, siblings: { /* Compute an array of variants IDs from the base product */ attribute: function (product) { const variantIds = []; const variantsIt = product.variants.iterator(); while (variantsIt.hasNext()) { var variant = variantsIt.next(); if (variant.getAvailabilityModel().isInStock()) { variantIds.push(variant.ID); } } return variantIds; }, computedFromBaseProduct: true, }, }; ``` A more complete example is available [in the cartridge code](https://github.com/algolia/algoliasearch-sfcc-b2c/blob/master/cartridges/int_algolia/cartridge/configuration/productAttributesConfig.example.js). Any new attribute declared must be added to the **Additional Product Attributes** site preference in the Algolia BM module. You can also remove the base attributes by adding an empty declaration: ```js JavaScript icon=code theme={"system"} module.exports = { in_stock: {}, }; ```
The cartridge adds the selected values to the record root.
You can use them as custom ranking attributes.
* In the **Base product** and **Attribute-sliced** record models, these values come from the base product.
* In the **Variation product** record model, these values come from each variant.
The cartridge has built-in handlers for all `ProductActiveData` attributes.
To index a property that isn't in the checkbox list, add its ID (without the `activeData.` prefix) to **Additional Product Attributes**:
```text Additional product attributes theme={"system"}
revenueYear, ordersYear, salesVelocityWeek
```
#### Attribute-sliced records use base product active data
In the **Attribute-sliced** model, active data added with the bare field name, such as `revenueWeek`, comes from the base product.
The cartridge creates one record for each variation value, such as one record for each color.
However, it doesn't calculate active data for only the variants in that slice.
Each slice gets the same value, calculated across all variants of the base product.
For example, a red slice doesn't get the `revenueWeek` value for only the red variants. It gets the base product's `revenueWeek` value.
To index active data for each slice, compute the value with a custom function using the [extension mechanism](#extend-attributes-declarations).
### Index per-variant active data
To index active data for each variant in the `variants[]` array of the **Base product** or **Attribute-sliced** record models, use a nested or flat approach.
They produce different shapes inside each variant.
#### Nested per-variant value
Add the dotted field name, such as `activeData.