Magento Advanced Search With Solr Extension

1. USER MANUAL TABLE OF CONTENTS Introduction .................................................... 1 Benefits of Advance Search With SOLR .......... 1 Installation & Activation ................................. 2 Apache Tomcat & SOLR Installation ........... 2 Installation Steps ........................................ 7 Extension Activation ................................... 8 How it Works? .............................................. 10 Back End Configuration: ........................... 10 Features: ....................................................... 12 Points to Note: .............................................. 18 Advance Search With SOLR Contact Us .................................................... 18 Version: 0.1.1 Compatibility: Magento Community Edition1.4.*.* to 1.9.*.*

2. USER MANUAL – Advance Search With SOLR Introduction AppJetty provides effective solution in the form of Advance Search with Solr which is helpful for entrepreneurs to improve search results of their e-store. An ideal extension for customers which helps them to find exactly what they need. It helps to narrow down and filter the search. Solr boosts the search performance unlike Magento which takes more time to give search results. Benefits of Advance Search With SOLR • Helps to make product search more relevant and faster. • Improves layered navigation of search results of your store. • Support for spelling, synonyms and stop words. • Increases performance and search relevancy. • Helps customers to get more accurate results while searching about a product. www.appjetty.com 1

3. USER MANUAL – Advance Search With SOLR Installation & Activation Apache Tomcat & 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/jdk7-downloads- 1880260.html www.appjetty.com 2

4. USER MANUAL – Advance Search With SOLR 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: www.appjetty.com 3

5. USER MANUAL – Advance Search With SOLR 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 www.appjetty.com 4

6. USER MANUAL – Advance Search With SOLR 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\solr- 4.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 www.appjetty.com 5

7. USER MANUAL – Advance Search With SOLR Step13 • Restart Tomcat by going to Windows > Start > Monitor Tomcat > General Tab > Start Step14 • Test Solr by going to http://localhost:8983/solr/ in your browser. You should see the Solr admin page as below. www.appjetty.com 6

8. USER MANUAL – Advance Search With SOLR Installation Steps Step 1: Check Permissions Make sure the ‘‘app’’, ''skin'' and ''lib'' directories of your Magento and all directories inside it have full written permissions or set permissions on each directory equal to 777 or0777. Important! Change all permissions back after installation. Read more about permission at www.magentocommerce.com/wiki/magentofilesystempermissions Step 2: Disable Compilation Log into MagentoAdmin 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 FTPclient. Step 4: Clear cache Go to System→ Cache Management. Clear the store cache. Step 5: Re-login Logout and log back into Magento Admin Panel. www.appjetty.com 7

9. USER MANUAL – Advance Search With SOLR Step 6: Use Extension Go to System→ Configuration. In the left column you will see the new tab called Biztech Extensions. Extension Activation Step 1: Get an activation key Copy the activation key from the Order Confirmation Mail. OR Login into your account at website 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. Step 2: Activate your extensions Log into Magento Admin Panel and go to System Configuration → Biztech Extensions/Advance Search With SOLR Activation and enter the activation key in the ''Activation Key'' field for the Advance Search With SOLR extension then click the “Save Config” www.appjetty.com 8

10. USER MANUAL – Advance Search With SOLR Step 3: 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. www.appjetty.com 9

11. USER MANUAL – Advance Search With SOLR How it Works? Back End Configuration: Please follow the below steps to configure Advance Search With SOLR extension. Go to System->Configuration In the left column you will see the tab Biztech Extensions -> SOLR. 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. www.appjetty.com 10

12. USER MANUAL – Advance Search With SOLR • 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 www.appjetty.com 11

13. USER MANUAL – Advance Search With SOLR • 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. Features: Back-End Admin Features Integrated Solr and Magento Data • Admin can fetch Solr data from Magento admin panel. • General Configuration • Enable: Enable the extension. This extension is disabled by default. • Solr Server • Hostname or IP: Specify host name or IP on which solr is installed. By default it will take it 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 should say “Timeout”. Authentication Required: Select Yes if solr requires authentication to connect. Select No if authentication is not required. Username: Enter username required to connect to solr. Password: Enter password required connect to solr. Test Connection: Click on Test Connection to test solr connection. Displays successful connection if connection is proper else it will display failed. • • • • • • • • • • • www.appjetty.com 12

14. USER MANUAL – Advance Search With SOLR • 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 searched 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 be deleted from solr. By default it is set to No. • www.appjetty.com 13

15. USER MANUAL – Advance Search With SOLR Index Data • Data is instantly indexed when products are saved once, even after being removed by the admin later on. • Product attributes to boost: • Add the product attributes which you want to be given more priority while searching. • The attributes having less search boost will be given the highest priority while searching of the products. 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: Clicking on this button will re-index data of solr. • • • www.appjetty.com 14

16. USER MANUAL – Advance Search With SOLR Front-End User Features Expedites Search • • Users can easily narrow down their search to a specific product or attribute. Helps customers to simplify by narrowing down and expediting the product search. Conditions Based Search • Search can be done based on multiple conditions like • No. of reviews received by a product • No. of images the product has • No. of products sold and many more Auto Search • • Offers auto search suggestions for customers so that they can select best matching term of their search. When a user types the first few letters of the word, tips of words drops down and a user sees a list of words from catalog that best match to the products he wants to find. www.appjetty.com 15

17. USER MANUAL – Advance Search With SOLR Layered Navigation • • • • • Search results are displayed in layered navigation based on multiple attributes of different products. Enables customers to shop by multiple attributes in a category. Enables customers to filter search results by multiple attributes. Allows showing attributes in a dropdown and multi-select. Multi-select feature is not by default available in Magento. We have configured it for this extension. www.appjetty.com 16

18. USER MANUAL – Advance Search With SOLR Page Results • It displays search engine result page with the listing of no. of top results in single page. • For more information on Advance Search with Solr, please refer to https://www.appjetty.com/magento- advance-search-with-solr.htm www.appjetty.com 17

19. USER MANUAL – Advance Search With SOLR Points to Note: • Products in all the modules of Advance Search With SOLR will only be visible if they are assigned to the website selected while purchasing the Extension. • 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. Contact Us We simplify your business, offer unique business solution in digital web and IT landscapes. Live Chat •Get instant support with our Live Chat. •Visit our product page at: https://www.appjetty.com/magento-advance- search-with-solr.htm and click on the Live Chat button for instant support. Tickets •Raise tickets for your specific question! •Send an email to support@appjetty.com Or you can login to your account @ www.appjetty.com and click on My Support Tickets on your account dashboard, to get answers to your specific questions. Our team will work to respond to your query prompt. Customization: If you would like to customize or discuss about additional feature for Advance Search With SOLR, please write to sales@appjetty.com www.appjetty.com 18