Loading ...

Magelia WebStore

  • Example of Search results – Desktop view
  • Example of Search results – Mobile view
  • "Indexes" screen

Search Engine

Version 3.1.354.75 by: Magelia
  • New
  • Magelia Certified
  • Extension sold per seller

Search catalogs, products and content items using the Lucene search engine

Latest version: 3.1.354.75
Other versions:
Designed for Magelia WebStore: v.[3.1,3.2)
Last updated: 7/19/2016
Available language: English
Assistance: Magelia
License: View license
Compatible with Editions: Community - Professional - Enterprise
Free Add to basket
  • Enable visitors to easily find products, categories and contents using the powerful Lucene.NET search engine. 


    Main benefits:
    - Rely on the powerful Lucene.Net search engine.
    - Rich indexing options
    - Supports dynamic content indexation.
    - Search results can be filtered according to the visitor’s culture, currency and country.
    - Extensible indexation models.


    What’s included?
    - Implementation of Lucene Search Engine for the Magelia WebStore data model.
    - Automatic indexes building on data update.
    - WCF service that provides search method and exposes available indexes.


    Also available : Package for the responsive storefront

    - A new SearchEngineManager that relies on WCF Lucene Search Engine service.

    Responsive design template  This package requires that your storefront be based on the responsive design template available here.
    • Before we explain the configuration of the Search engine extension, please find below how the search engine feature has been integrated in a storefront based on the responsive design template


      The search feature is available from each page in the header


      The search feature is available from each page in the header


      And the results corresponding to the search are listed in a responsive user friendly way: 


      Search Results
      (Mobile view)
      Search Results
      (Desktop view)
      Search Results (mobile view)  Search results (Desktop view)


      Now let us move to the configuration of the search engine


      • 1.     Configure the way you want to index products, categories and content items


      The Lucene Search Engine extension adds two new screens to the Administration Console, in the "CONTENT" tab of the main menu:


      Search engine menu


      The "Indexes" screen allows you to configure what the information that has to be indexed and therefore available in search results.


      The "Indexes" screen


      By clicking on the "ADD" button you will access to the index edition screen:


      the index edition screen


      3 indexers are natively provided by the extension (additional indexers could be developed by extension):

      • Category: allows you to index categories data.
      • Product: allows you to index products data.
      • ContentItem: allows you to index content items data by ContentType.


      The following options are available

      • Index: indicate to Lucene Search Engine to take into account the corresponding data while building indexes.
      • Save in index: indicates that the corresponding data has to be saved within the index in order to retrieve it if the element matches the search. Please note that this feature doesn’t mean that Lucene will use the property to answer search queries.
      • Boost: indicate to Lucene how to order search results regarding elements matches. It allows you to give a weight to a property. Please note that the lower the mark, the greater the weight for the Lucene Search Engine weight mechanism.


      Please note that you can manually rebuild indexes by clicking on the “RESET INDEXES” button of the "Indexes" page.


      The "Settings" page lets you configure how Lucene Search Engine have to work:

      • Specify where the indexes created by Lucene will be stored using the “Base directory” field. It should be filled with a folder path on which the IIS account that executes the Administration Console has rights to list, read, write and delete content. By default indexes are stored in the App_Data folder of the Administration Console application using a sub path corresponding to the Seller ID.
      • Configure for each culture of a seller which analyzer and which stop words list Lucene Search Engine has to work with. For more information about analyzers and stopwords please refer to the following documentation : http://codeclimber.net.nz/archive/2009/08/31/lucene.net-the-main-concepts.aspx
        Please note that additional or updated stop words files could be found at: https://code.google.com/p/stop-words


      The "Settings" screen



      • 2.     Building Indexes during the Data Update


      As the data update process generates new services data, which will be available on the frontend, it is important to update search results simultaneously, in order to ensure data consistency. That’s why the search engine extension will automatically add the BuildIndexDataBurstWorkerComponentBehavior to the list of behaviors that the Administration Console will trigger during the data update process:


      Building Indexes during the Data Update

    • Install the extension and the (optional) package for the responsive design template


       Installation of Magelia Webstore extensions and packages


      • 1.     Install the extension


      This extension add new screens to the administration console to configure the extension behavior and provides WCF services.

      Installing the Magelia WebStore WCF extension, proceed as explained in How to Install an extension on Magelia WebStore Console Admin



      If your project is based on your own custom code, you are all set and you do not have to install the package for the responsive storefront.


      If you based your project on the Responsive design template, in order to speed-up your project, please find hereafter an example of how to implement the extension and package.


      • 2.     Install the package to the responsive storefront


      Get the package and proceed as explained in Installing packages for Magelia WebStore responsive storefront


    • The implementation will be slightly different depending on whether your project is based on the responsive design template or not:


      • If your project is based on the responsive design template: please install the Lucene Search Engine package from your dedicated nuget repository. Once installed, search queries will be handled by the WCF service based on Lucene Search Engine.
        Feel free to implement your own indexes as the base ones in the Search action of the SearchController.


      • If you do not rely on the responsive design template for your project: please update Magelia WebStore clients by using the Update-MageliaClient command line in the package manager console of Visual Studio.


      You will see that a new SearchServiceClient is automatically created:


      new SearchServiceClient is automatically created


      You can now to get the list of existing indexers using the "GetIndexers" service method:

      IndexerDefinition[] indexers =  context.SearchServiceClient.GetIndexers();


      According to existing indexers please use the “Search” service method to get a SearchResult handled by Lucene Search Engine:

      SearchResult searchResult = context.SearchServiceClient.Search(9, 978, new Location { CountryId = 840 }, "Product", "keywords", 0, 10);

    • Version 3.0 released May 2014
      - Initial release

  • Please correct the followings errors:

We also recommend: