Documentation - Broadleaf Commerce

Overview

Relevancy Rules allow an SEO admin user to create rules that help boost the relevancy of search terms on the site. Here is an example scenario:

Heat Clinic Scenario

There is a company called "The Heat Clinic" that sells hot sauces. The company feels they aren't selling enough of the
enough of the higher margin sauces. After some analysis, they discover and that the products customers
purchase most are the ones that show up first in their search results.

The [Heat Clinic Scenario] is an example where an SEO admin user can use Relevancy Rules to help "boost" the significance of certain products, favoring products that produce a higher profit margin to be returned at the top of search results list.

Table 1. Search Results for term "*pepper*" **Before** `Relevancy Rules`
Order	Product Name	Margin
1	Cool Cayenne Pepper Hot Sauce	0.33
2	Blazin' Saddle XXX Hot Habanero Pepper Sauce	0.25
3	Bull Snort Cowboy Cayenne Pepper Hot Sauce	0.23
4	Roasted Red Pepper & Chipotle Hot Sauce	0.37
5	Green Ghost	0.19
6	Day of the Dead Chipotle Hot Sauce	0.36
7	Day of the Dead Scotch Bonnet Hot Sauce	0.23

Table 2. Search Results for term "*pepper*" **After** `Relevancy Rules`
Order	Product Name	Margin
1	Cool Cayenne Pepper Hot Sauce	0.33
2	Roasted Red Pepper & Chipotle Hot Sauce	0.37
3	Blazin' Saddle XXX Hot Habanero Pepper Sauce	0.25
4	Bull Snort Cowboy Cayenne Pepper Hot Sauce	0.23
5	Green Ghost	0.19
6	Day of the Dead Chipotle Hot Sauce	0.36
7	Day of the Dead Scotch Bonnet Hot Sauce	0.23

Relevancy Rules Admin Page

Tabs Descriptions

Tabs	Descriptions
General	General information where Admin user define about the `Relevancy Rule`
Audit	see Audit Tab

General

General information where Admin user define about the Relevancy Rule

Audit

see Audit Tab

General Tab

Field Group Description

Field Group	Description
General Field Group	Describe the `name` of the rule, the `field` the rule should target, and the `Search Term Regular Expression` that defines how to evaluate the rule. Relevancy Field Group

General Field Group

Describe the name of the rule, the field the rule should target, and the Search Term Regular Expression that defines how to evaluate the rule.

Relevancy Field Group

The Relevancy Field Group is where SEO users can set the Rule Type of Relevancy Rule. By default, there are four(4) different types of Relevancy Rules.

Boost by Search Query	Boosts the document if the field has a match for the search query.
Boost by Matching Value	Boosts the document if the field has a match for a specific value.
Boost by Relative Value	Boosts the document based on the relative value of the field. Primarily used for boosting fields such as margin so that higher margin products score higher.
Boost by Ordinal Value	Boosts the document based on the ordinal value of this field. The ordinal value is the position of this document if ordered from highest to lowest by the value of the field.

The SEO user can also set the Boost Amount, and decide if the relevancy rules should apply for Category Browsing.

Field Name	Description
Boost Amount	This value represents how much this rule boosts documents. Set this value relative to your other boost rules. The greater this value, the greater it influences the score of the document. Feel free to tinker with this to find the best value.
Apply For Category Browsing	Normally, rules are applied when keyword searching. If the rule should also apply when browsing by category, set this to true.

Field Name

Description

Boost Amount

This value represents how much this rule boosts documents. Set this value relative to your other boost rules. The greater this value, the greater it influences the score of the document. Feel free to tinker with this to find the best value.

Apply For Category Browsing

Normally, rules are applied when keyword searching. If the rule should also apply when browsing by category, set this to true.