Backend Functionality
Search Indexes| Panel |
|---|
 Image Added
|
- Search Indexes allow you to manage how different types of content appear in search results. You can control indexing, update data through reindexing, and manage visibility and order of search result sections.
| Field | Description |
|---|
| Add New Index | Creates a new search index configuration for additional content types or custom data. | | ID | Displays the unique identifier of the search index. | | Title | Defines the name of the index (e.g., Products, Categories, CMS Pages). | | Type | Indicates the type of content being indexed, such as Product, Category, or CMS Page. | | Position | Determines the display order of indexes in search results or tabs. | | Status | Shows the current status of the index (e.g., Ready), indicating whether it is properly indexed and available for search. | | Action (Select) | Provides row-level actions to manage the index. | | Edit | Allows modification of the selected search index configuration. | | Reindex | Rebuilds the selected index to update search data and reflect recent changes. | | Delete | Removes the selected search index from the system. |
Add New Index| Panel |
|---|
 Image Added
|
- This section allows administrators to configure how a specific content type (e.g., products) is indexed and prioritized in search results. You can control visibility, ordering, and relevance by assigning weights to different attributes.
| Field | Description |
|---|
| Back | Navigates back to the Search Indexes grid without saving changes. | | Delete | Removes the current search index configuration. | | Reset | Resets all unsaved changes and restores default values. | | Save and Continue Edit | Saves the current configuration and allows further editing. | | Save | Saves the search index configuration. | | Status | Enables or disables the search index. Only enabled indexes are used in search results. | | Title | Defines the name of the search index (e.g., Products). | | Type | Specifies the content type being indexed (e.g., Product, Category, CMS Page). | | Position | Determines the display order of this index in search results or tabs. | | Attributes for Search | Lists the attributes included in search indexing and relevance calculation. | | Attribute | Specifies the product attribute used for search matching (e.g., SKU, Name, Description). | | Weight | Defines the importance of each attribute in search relevance. Higher values increase priority in search results. | | Add Attribute | Allows adding additional attributes to be considered in search indexing. | | Delete (Attribute) | Removes the selected attribute from the search configuration. |
Product Score Rules| Panel |
|---|
 Image Added
|
- Product Score Rules allow administrators to influence search result rankings by applying custom scoring logic. These rules help prioritize specific products dynamically based on conditions and defined time periods.
| Field | Description |
|---|
| Apply Rules | Applies all configured score rules to update product rankings in search results. | | Add New Rule | Creates a new scoring rule to modify product relevance in search results. | | ID | Displays the unique identifier of the rule. | | Title | Defines the name of the scoring rule for easy identification. | | Score | Specifies the score multiplier applied to matching products, affecting their ranking in search results. | | Start From | Defines the date and time from which the rule becomes active. | | End To | Defines the date and time until which the rule remains active. | | Status | Indicates whether the rule is currently enabled or disabled. | | Filters | Allows filtering the rule list based on specific criteria. | | Default View | Enables switching between saved grid views. | | Columns | Allows customization of visible columns in the grid. | | Action (Select) | Provides row-level actions to manage individual rules. | | Edit | Allows modification of the selected scoring rule. | | Delete | Removes the selected rule from the system. |
Add New Rule| Panel |
|---|
 Image Added
|
- This section allows administrators to create and manage product score rules that influence search result rankings. Rules can be scheduled, scoped per store, and applied dynamically to boost product visibility.
| Field | Description |
|---|
| Back | Navigates back to the rule listing page without saving changes. | | Delete | Deletes the current rule. | | Apply Now | Immediately applies the rule without waiting for scheduled execution. | | Save and Continue Edit | Saves the rule and allows further modifications. | | Save | Saves the rule configuration. | | Status | Enables or disables the rule. Only active rules affect search results. | | Title | Defines the name of the rule for identification. | | Start From | Specifies the date from which the rule becomes active. | | End To | Specifies the date until which the rule remains active. | | Store | Defines the store views where the rule will be applied. | | General (Section) | Contains basic rule configuration such as status, scheduling, and store scope. | | Product Score | Allows defining scoring logic to boost or adjust product ranking. | | Product Rule | Defines conditions to determine which products the rule will apply to. |
| Panel |
|---|
 Image Added
|
- Product score allows administrators to control how product ranking is adjusted in search results by applying scoring logic. You can increase or decrease product visibility dynamically based on selected factors such as popularity or ratings.
| Field | Description |
|---|
| Product Current Score | Defines whether the product score should be increased or decreased based on the applied rule. | | Score | Specifies the value used to adjust the product score. | | Score Factor Unit | Determines how the score value is applied, either as a multiplier (times) or as a fixed addition (points). | | Score Factor | Selects the basis for score calculation, such as initial score, product popularity (orders), or product rating (reviews). |
| Panel |
|---|
 Image Added
|
- Product rule allows administrators to define conditions to control which products the scoring rule will apply to. Rules are applied only to products that match all specified conditions, enabling targeted ranking adjustments.
| Field | Description |
|---|
| Apply the Rule Only for the Following Products | Defines the scope of products to which the rule will be applied based on specified conditions. | | Conditions (If ALL of These Conditions Are TRUE) | Ensures that the rule is applied only when all defined conditions are satisfied. | | Attribute Condition | Specifies the product attribute used for filtering (e.g., Category, Color, New). | | Operator | Defines how the condition is evaluated (e.g., contains, is, equals). | | Value | Specifies the value that the attribute must match for the condition to be true. | | Add Condition (+) | Allows adding additional conditions to refine product selection. | | Delete Condition | Removes an existing condition from the rule. |
Search Synonyms| Panel |
|---|
 Image Added
|
- This section allows administrators to manage synonym groups to improve search accuracy and relevance. It ensures that different keywords with similar meanings return consistent search results
| Field | Description |
|---|
| Import Synonyms | Allows bulk import of synonym groups using a predefined format. | | New Synonym Group | Creates a new group of related keywords that will be treated as equivalent in search queries. | | Search by Keyword | Enables quick searching of existing synonym groups. | | Actions | Allows performing bulk actions on selected synonym groups. | | ID | Displays the unique identifier of the synonym group. | | Synonyms | Lists the grouped keywords that are treated as interchangeable in search queries. | | Website | Indicates the website scope where the synonym group is applied. | | Store View | Specifies the store views where the synonym group is active. | | Action (Select) | Provides row-level actions for managing synonym groups. | | View/Edit | Allows viewing or modifying the selected synonym group. | | Delete | Removes the selected synonym group from the system. |
Add New Synonym Group| Panel |
|---|
 Image Added
|
- This section allows administrators to create and manage groups of related keywords that are treated as equivalent in search queries. It helps improve search accuracy by ensuring users find relevant results even when using different terms.
| Field | Description |
|---|
| Back | Navigates back to the synonym group listing page without saving changes. | | Delete Synonym Group | Deletes the current synonym group. | | Reset | Clears all unsaved changes and restores default values. | | Save and Continue Edit | Saves the synonym group and allows further modifications. | | Save Synonym Group | Saves the newly created synonym group. | | Scope | Defines the store view or website scope where the synonym group will be applied. | | Synonyms | Specifies a list of keywords separated by commas that will be treated as interchangeable in search queries. | | Merge Existing Synonyms | Merges the entered synonyms with any existing groups instead of creating duplicates. | | General Information | Section containing basic configuration for synonym group creation. |
Manage Stopwords| Panel |
|---|
 Image Added
|
| Field | Description |
|---|
| Stopwords | Defines common words (e.g., the, and, with) that should be ignored during search queries to improve relevance. | | Add New Stopword | Allows administrators to manually add new stopwords that should be excluded from search processing. | | Import Stopwords | Enables bulk upload of stopwords for faster configuration and management. | | Store View | Specifies the store view where the stopword rule will be applied, supporting multi-store configurations. | | Edit | Allows modification of an existing stopword entry. | | Delete | Removes a stopword from the list so it will be considered again in search queries. | | Filters & Grid | Helps manage and view stopwords efficiently using filters, pagination, and column controls. |
Add New Stopword| Panel |
|---|
 Image Added
|
| Field | Description |
|---|
| Stopword | Enter the word that should be ignored during search queries (e.g., and, the, with) to improve result relevance. | | Store View | Select the store view where this stopword will be applied, allowing store-specific search optimization. | | Save | Saves the stopword configuration and applies it to the search processing. | | Back | Returns to the stopwords grid without saving changes. |
Validate Search
| Panel |
|---|
 Image Added
|
- This section allows administrators to test and analyze how search queries are processed and executed. It helps validate search accuracy, debug query behavior, and understand how results are generated.
| Field | Description |
|---|
| Search Term | Enter the keyword or phrase to test how it performs in search results. | | Validate | Executes the search query and displays detailed results and query analysis. | | Catalogsearch Fulltext / Store | Indicates the search index and store view used for validation. | | ES Query | Displays the actual Elasticsearch/OpenSearch query generated by the system for the entered search term. | | Abstract Query | Shows a simplified representation of how the search query is interpreted internally. | | Search Results Data | Displays the resulting data along with scoring details used to rank products. | | Back | Navigates back to the previous page. |
| Panel |
|---|
 Image Added
|
- This section allows administrators to validate how a specific entity (e.g., product) is indexed in the search engine. It helps inspect indexed data, verify attribute values, and troubleshoot indexing or search-related issues.
| Field | Description |
|---|
| Entity ID | Enter the ID of the entity (e.g., product ID) to validate its indexed data. | | Validate | Executes the validation process and retrieves indexed data from the search engine. | | Catalogsearch Fulltext / Store | Indicates the search index and store view used for validation. | | Indexed Data (JSON View) | Displays the raw indexed data stored in the search engine, including all attributes and values for the entity. | | _index / _type / _id | Shows technical identifiers of the indexed record in the search engine. | | _score | Represents the relevance score assigned to the entity during search. | | _source | Contains the full set of indexed attribute data used for search queries. |
Search Landing Pages| Panel |
|---|
 Image Added
|
- This section allows administrators to create dedicated landing pages for specific search queries or categories. It helps optimize search experience by redirecting users to curated pages with predefined filters and content.
| Field | Description |
|---|
| Add Landing Page | Creates a new search landing page with custom configuration. | | ID | Displays the unique identifier of the landing page. | | Name | Defines the name of the landing page for internal reference. | | URL Key | Specifies the SEO-friendly URL path for the landing page. | | Categories | Assigns categories to control which products are displayed on the landing page. | | Store View | Defines the store views where the landing page is available. | | Filters | Displays applied filters used to refine product results on the landing page. | | Search Term | Defines the keyword that triggers this landing page. | | Redirect | Indicates whether search queries will redirect users to this landing page. | | Status | Shows whether the landing page is active or inactive. | | Action (Select) | Provides row-level actions to manage landing pages. | | Edit | Allows modification of the landing page configuration. | | Delete | Removes the selected landing page. |
Add Landing Page| Panel |
|---|
 Image Added
|
- After clicking on Add Landing Page, a new configuration page opens where administrators can define the landing page behavior, visibility, and redirection rules. This setup ensures targeted search experiences based on specific conditions.
| Field | Description |
|---|
| Back | Navigates back to the landing page listing without saving changes. | | Delete | Deletes the current landing page. | | Save and Continue Edit | Saves the configuration and allows further editing. | | Save | Saves the landing page configuration. | | Active | Enables or disables the landing page. Only active pages are visible on the storefront. | | Store View | Defines the store views where the landing page will be available. | | Enable Redirect | Redirects users to this landing page when configured conditions (such as search term, category, or filters) are met. | | Name | Specifies the internal name of the landing page for identification. | | General (Section) | Contains core configuration settings such as status, store scope, and redirect behavior. |
| Panel |
|---|
 Image Added
|
- This section allows administrators to configure SEO-related settings for the landing page, ensuring better visibility in search engines. It helps optimize how the page appears in search results and improves discoverability.
| Field | Description |
|---|
| Robots Meta Tags | Defines how search engines should crawl and index the page (e.g., INDEX, FOLLOW). | | URL Key | Specifies the SEO-friendly URL path for the landing page. | | Page Title | Defines the title displayed on the browser tab and search results. | | Meta Title | Specifies the SEO title used by search engines. | | Meta Description | Provides a brief description of the page for search engine listings. | | Search Engine Optimization (Section) | Contains SEO configuration settings to improve search engine ranking and visibility. |
| Panel |
|---|
 Image Added
|
- This section allows administrators to design and manage the visual and informational content of the landing page. It helps create a customized user experience by adding descriptions, CMS blocks, and layout updates.
| Field | Description |
|---|
| Description | Allows adding custom content for the landing page using Page Builder or HTML. | | Edit with Page Builder | Opens the Page Builder interface to design and structure page content visually. | | Top CMS Block | Selects a CMS block to display at the top of the landing page. | | Bottom CMS Block | Selects a CMS block to display at the bottom of the landing page. | | Layout Update XML | Allows adding custom XML code to modify the layout and structure of the landing page. | | Content (Section) | Contains all settings related to managing and displaying landing page content. |
| Panel |
|---|
 Image Added
|
- This section allows administrators to define which products will appear on the landing page based on categories, search terms, and attribute-based filters. It helps create targeted product listings for specific search experiences.
| Field | Description |
|---|
| Categories | Selects the categories from which products will be displayed on the landing page. | | Search Term | Defines the keyword that triggers this landing page when searched by users. | | Filters | Allows applying attribute-based conditions to refine the product collection displayed on the landing page. | | Attribute | Specifies the product attribute used for filtering (e.g., Activity, Color). | | Options | Defines the attribute values that products must match to be included. | | Actions (Delete) | Removes the selected filter condition. | | Add Record | Adds a new filter condition to further refine product selection. | | Products (Section) | Contains all configurations related to selecting and filtering products for the landing page. |
Search Volume Report| Panel |
|---|
 Image Added
|
- This report provides insights into how users interact with search on the store, including search frequency, user behavior, and popular search terms. It helps administrators analyze trends and optimize search performance and product visibility.
| Field | Description |
|---|
| From Date | Defines the start date for generating the search report data. | | To Date | Defines the end date for the search report data range. | | Group By | Groups the report data by a selected time interval (e.g., daily). | | Update Report | Refreshes and generates the report based on selected filters. | | Total Searches | Displays the total number of searches performed within the selected period. | | Unique Searches | Shows the number of distinct search queries entered by users. | | Unique Users | Indicates the number of individual users who performed searches. | | Avg Searches/Day | Calculates the average number of searches performed per day. | | Avg Searches/User | Shows the average number of searches performed per user. | | Search Volume Analytics | Visual representation (chart) showing distribution of search activity. | | Search Volume Distribution | Displays percentage breakdown of total searches, unique searches, and users. | | Top Search Terms | Lists the most frequently searched keywords along with usage metrics. | | Search Count | Number of times a specific search term was used. | | Unique Users (per term) | Number of distinct users who searched for a specific term. |
|
