Facets and Custom Fields

Dhaivat Dave

Modified on: Wed, 17 Jul, 2024 at 10:06 AM

Klevu Search supports facets/filters out of the box, including BigCommerce product variant options (eg. colour and size), categories, and custom fields.

Where configured, we will index the custom field values so they are searchable by your customers.

Klevu will automatically create facets on your Search Results Landing Page for these values.

If you would prefer to hide any of these facets, or would prefer that customer could not search for these values, please follow the below instructions according to your requirements. Please remember to perform an on-demand sync after making any of the below changes.

Hiding Facets

If you still want your custom fields to be searchable, but just don't want to use them as a facet, you can disable the facet via the Klevu Merchant Centre, by navigating to Smart Search > Customizations > Facets > Facet Visibility.

Including Custom Fields for Sync

Applies to Klevu installations performed after 21st September 2023. For older installation, please see section on Excluding Custom Fields for Sync.

By default, Klevu sync operations will not include any custom fields as attributes; these fields must be configured within the Klevu App Settings via BigCommerce Admin > Apps > Klevu AI Search & Merchandising > Settings > Include Custom Fields for Sync in Klevu.

You can add fields manually by adding new rows to the table and entering the Custom Field name into the form.

Alternatively, if you have a large number of fields to enter, you can upload a CSV containing each custom field on a new line.

You can export a copy of your current fields via the Import Custom Fields modal (a sample file will be downloaded if you have no custom fields currently configured).

Uploading a CSV file will clear any existing custom fields present in the form and replace them with the content of the CSV file. These changes are not permanent, however, until the form is submitted with the Save Settings button. To revert to your currently saved values, reloading the browser window and navigating back to Settings will reset the form content.

Handling Duplicate Fields

If you enter the same custom field name multiple times in the same form, duplicates will be automatically removed.

Field names are normalised before duplicate detection takes place, by converting to lower case and replacing special characters to underscores.

As such, the following field names would be considered duplicates (“My Custom Field:”, “my custom field-” - both converted to my_custom_field_) though the following would not be, and should be entered separately: “My Custom Field:” (my_custom_field_) and “My Custom Field” (my_custom_field).

Normalisation is not applied to the label’s value, which is used as the Facet Caption in KMC.

Excluding Custom Fields from Search

Older versions of the Klevu App indexed all Custom Fields by default and required individual fields to be explicitly removed from sync.

The process of excluding fields works in the same way as Including Custom Fields (above), with options to manually enter or upload fields via CSV. The only difference concerns how the data is used during feed generation.