Skip to main content

Rules Management

Overview

The Rules is designed to help administrators customize and improve the search experience by defining specific conditions and consequences for search queries. Rules allow you to control search behavior by specifying what actions should happen when certain conditions match. This enables you to create, edit, and remove search rules easily, ensuring better user experience and more relevant search results.

Why Use Rules?

Rules give you powerful control over how your search engine reacts to different search queries or contexts. You can:

  • Customize search results - Enhance what users see in the browse interface
  • Pin important items - Promote specific products based on search context
  • Hide irrelevant items - Filter out unwanted content from results
  • Control rules based on time - Schedule seasonal campaigns and promotions
  • Remove unnecessary words - Configure which words to ignore during search

Real-World Example:

If you have a seasonal offer on winter jackets, you can create a rule to pin promotional items whenever users search for "winter" or "jacket".


Key Sections of the Page

The rules interface provides comprehensive management tools

Rules Table
SectionDescriptionFeatures & Functions
1. Search BarLocated at the top of the page for quick rule lookupSearch rules based on:
  • Query text
  • Context
  • Rule ID
Helps you quickly locate rules in a long list
2. Toggle Columns (☰ Menu)Allows customization of visible table columnsShow/hide columns:
  • Rule ID
  • Conditions
  • Consequences
  • Last Updated (UTC)
Useful when managing many rules
3. Rules TableMain display area showing all search rules with detailed informationTable Columns:
  • Rule ID: Unique identifier (e.g., rule-176286...)
  • Conditions: What triggers the rule (query/context)
  • Consequences: Actions taken (pin, hide, remove word)
  • Last Update (UTC): Last modified time
  • Actions: Control icons for rule management
Available Actions:
  • View rule details
  • Edit rule settings
  • Delete rule permanently
  • Enable/disable rule
4. Rows Per PagePagination control for table displayOptions:
  • Choose number of rules to display per page
  • Default setting: 10 rules per page
  • Helps manage large rule lists efficiently

Conditions Section

Conditions Rules Configuration

Query Condition

  • Toggle ON
  • Choose match type: Contains / Is / Starts with / Ends with
  • Enter search term

Query conditions work alongside query suggestions and banned expressions to control search behavior.

Context Condition

Context conditions integrate with your search configuration to provide targeted rule application.

Context Condition Configuration

Context means the situation in which a user is performing the search. It helps you apply a rule only to specific users or scenarios instead of applying it to everyone.

You use Context Condition when you want a rule to work only in certain situations like:

  • Device Type - Apply the rule only for mobile users or only for desktop users. (Example: Show different results on mobile vs desktop, works with responsive search interface)
  • Language - Apply the rule only when the user is searching in a specific language. (Example: A rule should work only for English users)
  • Custom Parameters - Any extra conditions your system uses (like user group, region, campaign, etc.). (Example: A rule should only apply to users from "India" or "VIP customers")

In simple words: Context decides who the rule applies to, and in what situation the user is searching. If you don't need targeting, you can skip adding context.


Rule Configuration Options

Rule Configuration Options
Configuration TypeConsequences SectionDescriptionTimeframe (UTC)
Configuration

You can choose from:

  • Pin an item – Show specific items at the top
  • Hide an item – Remove from search results
  • Remove Word – Ignore specific words from the query

Optional text describing what the rule does.

Allows scheduling:

  • From (start date)
  • Until (end date)
  • Option: "Pinned items must match active filters to be displayed"

Great for seasonal campaigns.

Details & Options

Choose the action to be performed when rule conditions are met

Helps identify and organize rules for better management

Control when rules are active for time-sensitive campaigns


Editing and Managing Rules

Editing and Managing Rules
Action TypeEdit a RuleView Rule DetailsDelete a RuleEnable/Disable Rule
Steps
  1. Click Edit ()
  2. Update conditions or consequences
  3. Click Save

Click View () to preview.

  1. Click Delete ()
  2. Confirm
  3. Rule gets removed permanently

Use Toggle () to activate or deactivate without deleting.

Pending changes will show:

  • Discard
  • Review and Save
Purpose

Modify existing rule conditions and consequences to improve search results

Preview rule details without making any changes

Permanently remove unwanted or outdated rules from the system

Temporarily control rule activation without permanent deletion


Performing Multiple Actions at Once

Performing Multiple Actions at Once

When you select multiple rules by checking their checkboxes, you can perform bulk actions on them.

Bulk Actions Available:

  • Clear Selection - Unselect all currently selected rules
  • Enable All - Activate all selected rules at once
  • Disable All - Deactivate all selected rules at once
  • Delete All - Permanently remove all selected rules

How it works:

  1. Select rules by clicking the checkboxes next to them
  2. The system shows "X rules selected" at the bottom
  3. Choose your desired bulk action from the available buttons
  4. Confirm the action when prompted

Notes

  • A rule can have multiple consequences

  • Search matching is case-insensitive (follows search configuration settings)

  • Changes are tracked in API logs


Frequently Asked Questions

When to pin items?

Use for:

  • Promotions

  • Seasonal campaigns (schedule with timeframes)

Difference between Hide and Remove Word?

Should I apply plurals/synonyms/typos?

Use when you want broader matching.