On Demand - Catalog product filtering

CatalogBrowserFilterRule

Notification level: Not applicable

Key	Value
ID	CatalogBrowserFilterRule
Translation key	Overload parameter "label"

Behavior

This business rule is only available through the Kitchen Expert Suite offer.

The objective of this rule is to filter the products available in the catalog of the application according to the desired rules. These rules have to be set directly in the overload parameters of the business rule.

Example: The retailers want to set a filter rule to exclude some type of products in the application based on height.

---

Trigger Conditions

This business rule is triggered when the user clicks on the link "On demand rules" present at the botton of the Help Center feature.

A popin in then displayed and the user can decide to active the rule or not.

If the rule is activated by the user and if we take the example shown in the image above, the filter is applied and only the base cabinets with the height other than 792 mm and 864 mm will be displayed in the product catalogs.

---

Overload Parameter

The overload is formatted as a JSON object, in which each property is a rule that defines the mapping between the parameters.

Key name	Type	Default value	Description
label	object	–	Mandatory Object containing translations depending on the locale definition like "en-GB", "fr-FR".
filters	array	–	Mandatory. Define the key, the types and the values to filter the product in catalogs.
freeTags	array	–	Mandatory Define the list of the product freeTags to take into account for product filtering.

For example: In this example, the applicative rule will start by looking the filters set in the "filters" array of object especially the key, type and the values parameters.

The key represents the name of the parameter of the product to take into account. The type corresponds to the type of the filter. The values array defines the values of the parameter which has to be filtered

The freeTags array lists the type of the products which will be considered for the filter to apply.

{
    "label": {
        "en-GB": "Exclude 792 & 864 height base cabinets",
        "fr-FR": "Exclure les meubles bas de hauteur 792 et 864"
    },
    "filters": [
        {
            "key": "commercialHeight",
            "type": "parameter_filter",
            "values": [
                "792",
                "864"
            ],
            "parameter_type": "integer"
        }
    ],
    "freeTags": [
        "BaseUnitWithDoors",
        "BaseUnitWithDoorsAndDrawers",
        "BaseUnitWithDrawers",
        "OpenBaseUnit",
        "CornerBaseUnits",
        "BaseUnitUnderSink",
        "CornerSinkUnits",
        "BaseUnitsOvenMicrowave",
        "BaseUnitsCooktop",
        "BaseUnitsDishwasher",
        "BaseUnitsFridge",
        "GolaBaseUnitWithDoors",
        "GolaBaseUnitWithDoorsAndDrawers",
        "GolaBaseUnitWithDrawers",
        "GolaOpenBaseUnit",
        "GolaCornerBaseUnits",
        "GolaBaseUnitUnderSink",
        "GolaCornerSinkUnits",
        "GolaBaseUnitsOvenMicrowave",
        "GolaBaseUnitsCooktop",
        "GolaBaseUnitsDishwasher",
        "GolaBaseUnitsFridge"
    ]
}