USER MANUAL TABLE OF CONTENTS · USER MANUAL – Advance Search With SOLR 1 Introduction AppJetty...
Transcript of USER MANUAL TABLE OF CONTENTS · USER MANUAL – Advance Search With SOLR 1 Introduction AppJetty...
USER MANUAL
Advance Search with
SOLR
Version: 0.1.1
Compatibility:
Magento Community Edition 1.4.*.* to 1.9.*.*
TABLE OF CONTENTS
Introduction ......................................................1
Benefits of Advance Search with SOLR ...........1
Installation & Activation ...................................2
Installation Steps...........................................2
Extension Activation .....................................4
How it Works?...................................................5
Back End Configuration ................................5
Front-End Features .......................................9
Points to Note ................................................ 12
Contact Us ...................................................... 13
USER MANUAL – Advance Search With SOLR
www.appjetty.com 1
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
USER MANUAL – Advance Search With SOLR
www.appjetty.com 2
Installation & Activation
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 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
Logout and log back into Magento Admin Panel.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 3
Step 6: Use Extension
Go to System -> Configuration. In the left column you will see the new tab called Biztech
Extensions / SOLR.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 4
Extension Activation
Get 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.
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’
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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 5
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. Now fetch SOLR data
from Magento admin panel by following below steps.
General Configuration
Enable: Enable the extension. This extension is disabled by default.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 6
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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 7
SOLR Core: This is a running instance of Lucien 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
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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 8
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.
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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 9
Front-End 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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 10
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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 11
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
USER MANUAL – Advance Search With SOLR
www.appjetty.com 12
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.
USER MANUAL – Advance Search With SOLR
www.appjetty.com 13
Contact Us
We simplify your business, offer unique business solution in digital web and IT landscapes.
Customization: If you would like to customize or discuss about additional feature for Advance Search with SOLR, please
write to [email protected]
Tickets
Raise tickets for your specific question!
Send an email to [email protected]
or you can login to your account @
www.appjetty.com and click on My Sup-
port Tickets on your account dashboard,
to get answers to your specific questions.
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.