Documentation Menu

Solr Search documentation

PRE-REQUISITES

  • The plugin requires you to install the Nop-Station Core plugin first.
  • A Solr core is needed and proper credentials.

INSTALLATION

  • Download the Solr Search Plugin from our store https://nop-station.com/customer/downloadableproducts
  • Go to Administration → Configuration → Local plugins
  • Upload the NopStation.SolrSearch zip file using the "Upload plugin or theme" button

    local-plugins-page

  • Go to Administration, and reload the 'list of plugins'. Install 'Nop-Station Core' Plugin first and then install 'Nop-Station Solr Search'

    install nopStation core

    install solr

  • To make the plugins functional, restart the application

    restart application

SOLR SERVER SETTINGS

  • Go to “Config Files Manager” under the Solr index configuration in the server.
  • We can edit the “solrconfig.xml” file in the server or upload the file that will be provided during the plugin purchase.

CONFIGURATION

  • Go to Admin → Nop Station → Plugins → Solr search → Configuration

Solr Credentials:

solr credentials

  • Server URL: Enter the Solr server URL.
  • Solr Core: Enter the Solr core name.
  • Server username: Enter the Solr server username.
  • Server password: Enter the Solr server password.

Product Settings

solr product settings

Product Search

  • Enabled auto-complete: Check to enable auto-complete in the search box.
  • Auto-complete list size: Enter the number of products that will be shown in the auto-complete list.
  • Show product images in search auto-complete: Check to show product images in search auto-complete.
  • Auto-complete thumb picture size: Enter the number of product thumb picture sizes.
  • Show a link to all search results in the autocomplete box: Determines whether the link to all results should be displayed in the autocomplete search box. Displayed if the number of items found is greater than the displayed quantity in the autocomplete box.
  • Search term minimum length: The search term minimum query length.
  • Allow customers to select page size: Check to allow customers to choose page size.
  • Search page size options: Set the search page size dropdown options.
  • Allow product view mode changing: Check to allow customers to change product view mode.
  • Default view mode: Select the search page default product view mode.

Product Filter

  • Allow category filter: Check to allow customers to filter by product categories.
  • Maximum categories shown in filter: Maximum number of categories shown in filter.
  • Allow vendor filter: Check to allow customers to filter by product vendors.
  • Maximum vendors shown in filter: Maximum number of vendors shown in filter.
  • Allow manufacturer filter: Check to allow customers to filter by product manufacturers.
  • Maximum manufacturers shown in filter: Maximum number of manufacturers shown in filter.
  • Allow specification filter: Check to allow customers to filter by product specifications.
  • Maximum specifications shown in filter: Maximum number of specifications shown in the filter.
  • Allow product sorting: Check to allow customers to sort products. Click 'Update index' if the value of this property is changed.
  • Allowed sorting options: Allowed sorting options. Click 'Update index' if the value of this property is changed.
  • Allow price range filter: Check to allow customers to filter by product price range.
  • Allow rating filter: Check to allow customers to filter by product rating.
  • Show product count: Check to show product count on the product search page.
  • Use AJAX products loading: Check to load products asynchronously (applicable to 'paging', 'filtering', 'view modes') on catalog pages.

Search fields and boosting

solr search field

  • Include product name field in search: Check to include the product name field in the search.
  • Product name field boost value: Enter the boost value for the product name field (Range: 1-100).
  • Include a short description field in the search: Check to include a short description field in the search.
  • Short description field boost value: Set the boost value for the short description field (Range: 1-100).
  • Include full description field in search: Check to include full description field in search.
  • Full description field boost value: Enter the boost value for the full description field (Range: 1-100).
  • Include SE name field in the search: Check to include the SE name field in the search.
  • SE name field boost value: Enter the boost value for the se name field (Range: 1-100).
  • Include SKU field in search: Check to include the SKU field in the search.
  • SKU field boost value: Enter the boost value for the SKU field (Range: 1-100).
  • Include category name field in search: Check to include category name field in search.
  • Category name field boost value: Enter the boost value for the category name field (Range: 1-100).
  • Include keyword field in search: Check to include keyword field in search.
  • Keyword field boost value: Enter the boost value for the keyword field (Range: 1-100).

UPLOAD EXISTING PRODUCTS

    • Go to Admin → Nop Station → Plugins → Solr search → Upload products

solr updatable items

UPDATABLE ITEMS

  • Go to Admin → Nop Station → Plugins → Solr search → Updatable items
  • Here you can see all the products, categories, manufacturers, and vendors list that are not yet updated with Solr.

    solr updatable items

  • Click Update all button to update