Create rules from the Rules board

Although Interactive Mode provides an easy way to create some rules, such as those used to pin, block, boost and bury products, other rules can only be created from the Rules board. For example, you can create rules to display custom banner images, filter the list of search results, or redirect customers to a different page on your site.

Rules can be used to customize and improve the relevance of search results. They support a variety of conditions and actions to address a wide range of scenarios.

To create a new rule from the Rules board:

  1. Click the New button to display the Create Rule form.

  2. Specify the following general fields:

    Field Description Mandatory

    Rule name

    Name for the rule

    Yes

    Description

    Optional description of the rule.

    No

    Rule group

    Optional user-defined group that you can use to group your rules.

    No

    Priority

    Integer value, ranging from 1 to infinity, where 1 is the highest priority. Used to determine which rule should apply first if multiple rules are triggered for the same query. If multiple rules have the same value, those rules are applied in a random order.

    Yes

    Tags

    Optional way to organize your rules. Tags are displayed as facets in the Rules Facet List widget, allowing you to filter rules by tag.

    No

    Enabled

    Enabling a rule means that it’s active and can be triggered during a search. If you don’t want a rule to impact live queries, you should disable it before publishing.

    N/A

  3. Click the Next step button and set the rule’s conditions.

    Conditions define the criteria that are used to trigger a rule. A rule without conditions is always triggered, whatever the query. You can also add multiple conditions to the same rule.

    Condition Description Example

    Query

    The rule is triggered when a search term matches either keywords or text:

    • Keywords - the customer’s search term must exactly match one of the search terms specified in the rule.

      Keyword matching is the fastest type of query matching. It is case insensitive.

    • Text - the customer’s search term can partially match one of the search terms specified in the rule (text tokenization).

    With a keywords query, a search for the term watch would not trigger a rule if the Search Term was set to wrist watch. With a text query, the same search would trigger the rule: Text query with search term equals wrist watch

    Field Value

    The rule is triggered when a field name with a particular value is matched, usually when a customer navigates to a set of products using either facets or a category link.

    A field value of on_sale equals true could be used to trigger a rule when a customer clicks on a link for sale items: Field value with on_sale equals true

    Dates

    The rule is triggered only during the specified date and time range. This can be an open-ended range.

    A Halloween specific rule could be set up to trigger a few weeks before October 31 until the early hours of November 01: Field value with on_sale equals true

  4. Click the Next step button and choose the rule’s action. A rule can have many different types of action.

    Action Description

    Banner

    Displays a user-defined banner message (such as an image url).

    Block List

    Hides one or more products from the results list.

    Boost Attributes

    Boosts products with specific attributes to the top of the list.

    Boost List

    Boosts particular products to the top of the results.

    Bury List

    Minimizes the importance of particular products in the search results by moving them to the bottom of the list.

    Filter List

    Changes the search results so that only a specified set of products is shown.

    Pinned

    Pins particular products to fixed positions in the results list.

    Redirect

    Sends customers to a different url instead of the search results.

    Response Value

    Adds content to the response.

    Set Facets

    Sets additional search facets in the Facets List.

    Set Params

    Applies an update policy (append, default, remove, or replace to a Solr query parameter.

  5. Click the Next button and finish creating the rule. The available fields vary according to the action type you select.

  6. Click the Finish button.