Advanced Search with Solr - User Guide by Biztech Store

Advanced Search with Solr - User Guide

Compatibility: Community Edition: 1.6.x.x, 1.7.x.x, 1.8.x.x, 1.9.x.x

Index 1.

Apache Tomcat Installation ............................................................................................................ 3

Extension Installation ...................................................................................................................... 9

Installation (Custom Theme) ....................................................................................................... 11

Extension Activation .................................................................................................................... 12

Configuration ............................................................................................................................... 14

Quick Notes .................................................................................................................................. 18

Apache Tomcat and Solr Installation

The steps below are a guide to help you install Solr versions 4.1 to 4.6 for windows. These steps have been tested and they will lead you to the successful installation.

Step1  Download and install Java SDK.  Download URL : http://www.oracle.com/technetwork/java/javase/downloads/jdk7downloads-1880260.html

Step2  Download and install Apache Tomcat  Apache Tomcat Download URL : http://tomcat.apache.org/download-80.cgi

Step3  Test the Tomcat server in your browser. You should see the following screen:

Step4  You can configure the Tomcat server by going to Windows > Start > Monitor Tomcat

Step5  Stop the Tomcat server by going to Windows > Start > Monitor Tomcat > General Tab> Stop

Step6  Download Solr-4.6.0 and unzip it in your local directory i.e. C:\ Solr-4.6.0 (download zip file).  Download solr URL : http://www.apache.org/dyn/closer.cgi/lucene/solr/4.6.0

Step7  Go to downloaded Solr folder above (step 6) and Copy solr.war file to Apache webapps folder. I.e. Copy C:\solr-4.6.0\dist\solr-4.6.0.war file to C:\Program Files\Apache Software Foundation\Tomcat 8.0\webapps folder (rename solr-4.6.0.war to solr.war).

Step8  Create an empty Solr home folder. i.e. C:\solr.

Step9  Go to downloaded Solr folder above (step 6). Copy all files from C:\solr-4.6.0\solr4.6.0\example\solr folder to C:\solr (Solr home folder). This will be your Solr home folder.

Step10  Look into C:\solr and you will see two folders with name collection1 and bin.

Step11  Copy the jars from C:\solr-4.6.0\example\lib\ext (all jars) into C:\Program Files\Apache Software Foundation\Tomcat 8.0\lib (this is your Tomcat server main library directory).

Step12  Set the Java system property solr.solr.home to your Solr Home. Go to Windows > Start > Monitor Tomcat > Java Tab > Java Options. Enter the following entry at the end (see below screenshot): -Dsolr.solr.home=c:\solr

Step13  Restart Tomcat by going to Windows > Start > Monitor Tomcat > General Tab > Start

Step14 ď&#x192;&#x2DC; Test Solr by going to http://localhost:8983/solr/ in your browser. You should see the Solr admin page as below.

2. Extension Installation

Step 1 Check Permissions Make sure the ‘‘app’’, ”js ”, ”lib “ and “s k in” directories of your Magento and all directories inside it have full written permissions or set permissions on the each directory equal to 777 or 0777.

Important! Change all permissions back after installation. Read more about permission at http://www.magentocommerce.com/wiki/magento_filesystem_permissions

Step 2 Disable Compilation Log into Magento Admin Panel and go to System → Tools → Compilation and disable the compilation. After step 5 you can run the compilation process again.

Step 3 Upload Files Upload all folders from the extension package to the installation directory of your Magento software using an FTP client.

Step 4 Clear cache Go to System → Cache Management. Clear the store cache.

Step 5 Re-login Log out and log back into Magento Admin Panel.

Step 6 Use Extension Go to System → Configuration. In the left column you will see the new tab – Biztech Extensions.

Installation (Custom Theme)

Please do the next steps after the Installation:

Step 1 Copy layout and template folders from app/design/frontend/default/default folder to app/design/frontend/your_package/your_theme folder

Step 2 Copy skin folder from skin/frontend/default/default/folder to skin/frontend/your_package/your_package/

Extension Activation

Step1 Copy an activation key Copy the activation key from the Order Confirmation Mail. OR Login into your account at http://store.biztechconsultancy.comwebsite using the e-mail and Password that you provided at checkout process. Go to Downloadable Options and copy the activation key for the Solr extension.

Step2 Activate an extension Log into Magento Admin Panel and go to System Configuration→ Biztech Extensions /Solr and enter the activation key in the ''Activation Key'' field for the Solr extension then clicks the “Save Config”.

Step3 Select Websites When you enter and save the key it will be verified and you can select the websites where you need to use the Solr extension. Click the ''Save Config'' button after making your selections.

Now, Solr Extension got activated! You just have to set configurations.

5. Configuration

Please follow the below steps to enable S olr ext ensi o n f or cust om er s. Go to System -> Configuration In the left column under Biztech Extension tab click on Solr tab.

In this tab, you can set basic configurations of Solr Extension. Here is the brief description of the configuration.  Hostname or IP: Specify host name or IP on which solr is installed. By default it will take as localhost.  Port Number: Specify on which port solr will run. By default it will take port as 8983.  Path: Specify path which belongs to solr admin panel. By default it will take solr as default path.  Solr Data Config XML Path: Specify the path of data-config.xml.  Solr Schema XML Path: Specify the path of schema.xml.  Solr Admin URL: Specify admin panel URL of solr.  Solr Core: This is a running instance of Lucene index along with the entire Solr configuration required to use it.  Search Timeout (seconds): Specify number of seconds after which solr search timeout.  Authentication Required: Select yes if solr requires authentication to connect. Select No if authentication not required.  Username: Enter username which requires connecting to solr.  Password: Enter password which requires connecting to solr.  Test Connection: Click on Test Connection to test solr connection. Display success if connection gets successful else it will display failed. Below is the result for the same.

Solr Search Results

 Maximum Number of Results: Specify number of records to be displayed per page.  Auto Correct Search Terms: Select yes to automatically correct the search words/terms.  No. of Auto complete Suggestions: Specify number of products to be displayed in auto suggestion.  Enabled Category List Page: If selected yes then category list page will also come from solr. By default it is set to No.

Product Attributes Booster

 Product attributes to boost: Add number of attributes to be indexed in solr documents.  Facet Attributes to boost: Add number of attributes to be displayed in layered navigation.  Sorting Attribute: Attribute based on which you need to sort products in category list page and search result page.  Indexed Data: Click on this button to re-index data of solr.

6. Quick Notes Configuration  PHP version should be 5.3 above.  Solr should be installed on server before using this extension.  Any change made in extension’s configuration and that should not reflect in front then need to restart solr once.

 Mentioned installation steps are for Windows only.  If solr is not installed on your server, contact us we will install this.

All Set! Now, you are ready to use extension.

Technical Support

We welcome all forms of customized Magento e-commerce queries and deliver tailor-made Magento e-store solution,given your distinct business needs! We provide all technical support! Get in touch filling in our online message form to contact our support team or shoot us an email at support@biztechconsultancy.com. Your IT Partner, With You Anytime , Anywhere!