Prerequisites
The steps outlined in this article assume some steps have already been completed:
- You have already registered for a Klevu Account.
- You have already completed the Klevu Cartridge Installation.
Configuring your Store
Head over to the Merchant Tools → Site Preferences → Custom Preferences section of the Salesforce Business Manager, where you will find the “Klevu” configuration section. Here you will find the following Klevu settings:
- Enable Klevu Storefront
Whether or not to enable Klevu powered quick search and search results page on your frontend. Note that disabling this will not impact your data sync, which is controlled separately via Salesforce Jobs.
- Enable Klevu Category Page
Whether or not to enable Klevu powered category pages. Note that Klevu Category Merchandising is a feature which must first be enabled within your Klevu account. - Storefront Search URL
Please enter your APIv2 Cloud Search URL, which can be found via the Klevu Merchant Centre → Shop Info, eg. "https://eucs32v2.ksearchnet.com/cs/v2/search". - API Key
Your public Klevu JS API Key, which can be found via the Klevu Merchant Centre → Shop Info, eg. klevu-123456789. - Rest Key
Your private Klevu REST API Key, which can be found via the Klevu Merchant Centre → Shop Info. - Number of Products in Single File
Please leave this at its default value, unless you have been instructed to change it by Klevu Support. - Storefront Item Search Limit
Please leave this at its default value, unless you have been instructed to change it by Klevu Support. - Product Attributes *
These fields allow you to specify which attributes are indexed with Klevu. We will go into more detail on these settings in the dedicated sections below.
Product Attributes Mapping Mandatory
These are the required attributes. Please enter the following in this section, and do not modify this section further unless you are instructed to do so by Klevu Support.
[
{
"klevu_id": "id",
"sfcc_id": "ID",
"sfcc_type": "system"
},
{
"klevu_id": "title",
"sfcc_id": "name",
"sfcc_type": "system"
}
] The following Klevu attributes are automatically handled by the cartridge, without explicitly mentioning them within these Site Preferences:
- item_group_id
- item_type
- sku
- link
- availability
- categories
- price
- sale_price
- image_link
- additional_image_link
Product Attributes Mapping Optional
The following are optional attributes which will be indexed with Klevu. The sfcc_id is the name of the attribute within Salesforce, and klevu_id is the attribute name this will be mapped to when indexed with Klevu.
For your first installation, we recommend copying the following to get things up and running. Then if you prefer certain attributes to be added or removed, you can modify this JSON and modify as you wish.
[
{
"klevu_id": "keywords",
"sfcc_id": "pageKeywords",
"sfcc_type": "system"
},
{
"klevu_id": "brand",
"sfcc_id": "brand",
"sfcc_type": "system"
},
{
"klevu_id": "short_description",
"sfcc_id": "shortDescription",
"sfcc_type": "system"
},
{
"klevu_id": "description",
"sfcc_id": "longDescription",
"sfcc_type": "system"
},
{
"klevu_id": "mpn",
"sfcc_id": "manufacturerSKU",
"sfcc_type": "system"
},
{
"klevu_id": "gtin",
"sfcc_id": "UPC",
"sfcc_type": "system"
},
{
"klevu_id": "swatch_color",
"sfcc_id": "color",
"sfcc_type": "custom"
},
{
"klevu_id": "swatch_label",
"sfcc_id": "refinementColor",
"sfcc_type": "custom"
},
{
"klevu_id": "size",
"sfcc_id": "size",
"sfcc_type": "custom"
}
]
Product Attributes Dynamic
These are additional attributes which you may freely define. You can specify multiple values for each attribute and also whether it should be searchable or treated as a facet. You can leave this field empty for the time being by entering [].
As you identify attributes within Salesforce that you would like to be made available in Klevu, either for consideration in search or to be returned so you can display them to your customers, you may add those attributes in the following format.
[
{
"sfcc_id": "tabDetails",
"is_facet": false,
"is_searchable": false,
"is_return": true
}
]
The above example will inform the Klevu Cartridge to look for a Salesforce attribute called tabDetails. It will be sent to Klevu and should be returned in the response, but it should not be searchable and not used as a facet.
- sfcc_id
The attribute ID within Salesforce. - is_facet
Whether to use this attribute as a Facet. The default value is: false. - is_searchable
Whether the values provided should be searchable. The default value is: true. - is_return
Whether the values provided should be returned with search results. Set this to true if you want to render the values on your frontend. The default value is: false.