User Tools

Site Tools


Sidebar

magento_2:product_parts_finder

For more details see the Product Parts Finder for Magento 2 extension page.

Product Parts Finder for Magento 2

Troubleshooting checklist

  1. The finder block should be added to the results page. Filtering will work only when the Finder block is on the same page with resulting products. If you don't want it to be displayed you can hide it with CSS, but you still need to place the block on the results page.
  2. Make sure that there are products to filter on the page which the finder uses to display results. The finder works as a product filter. If there are no products to filter the Finder won't be able to do much.
  3. Try disabling Magento cache. If this helped, please try adding Finder block through the default.xml file as described below.

How to's

How to add Finder block to a category

Open the following file:

/app/code/Amasty/Finder/view/frontend/layout/default.xml

There you can find the commented part of the example code:

Simply move the XML comment markings to make the code look like this:

This will add the finder with ID=1 to a sidebar on all category pages. If you want to put there the finder with a different ID simply replace the 1 inside argument name=“id” tag with the ID of your finder. You can check finder IDs on the Parts Finder grid: {{ :magento_1:product-finder:amfinder-xml-grid.png?direct |

Save changes, flush Magento cache and do a redeploy of static files and compilation. And here's the result:


How to add Finder block to other places

To use finder on the home page or on the category without products, we do recommend to add the finder block to the root category.

In the same exact file as before:

/app/code/Amasty/Finder/view/frontend/layout/default.xml

Find the same exact code:

Move the comment marking and see the marked part of the code:

This is where we define the place for the Finder block on the page by changing the sidebar.main.

Possible options:

  • sidebar.main
  • left
  • right
  • content
  • top.links
  • header
  • footer
Please note that whether the Finder will be displayed in some block or not depends on how your store layout is configured. For example, if you don't have the right sidebar displayed in your categories then putting the Finder in the right position won't do much good.

And here you can define the Finder template that will be used:

Possible options:

  • responsive
  • vertical
  • horizontal

Setting up Finder in five steps

This guide covers basic Finder settings. After taking the steps described we will get a fully-functioning Finder block on our store.

Step 1. Store pre-configuration

Our example store sells car parts. Let's say, we have a very particular case: we want our customers to be able to filter Wheels category, so they can browse only wheels compatible with their cars.

This is what the Product Finder extension does best.

In our example store all wheels are in the same category. But if in your store you have subcategories for different wheel manufacturers you will need to set and Anchor to a parent category so all your wheels will be available in one place.


Step 2. Setting up Finder

I consider three options for my filter: car make, car model and wheel diameter. So let's create a Finder with 3 dropdowns. You can do it in Products > Product Finder > Add New Item

There is no way to change the number of dropdowns after the Finder is created. You can set the number of dropdowns only when creating a new Finder instance.

Please be careful with the Custom Destination URL setting. Here you set the page to which the Finder block will redirect you after hitting the Find button to show you the results. Since I want to filter only Wheels category, I've set “wheels.html” there to redirect me to example.com/wheels.html where my Wheels category is.

Hit Save and Continue Edit to proceed.


Step 3. Filling up Finder with data

You can create records in the Finder manually, but it may not be the best solution when you want to import hundreds or thousands of records. In this case, CSV import will perfectly work. Below you can see an example CSV file with the data containing all the variations for Make, Model and Diameter and bind these variations to products in my Magento Catalog.

Please pay attention to the number of columns in your CSV file. There should be a column for each dropdown plus one extra for a SKU. We have three dropdowns in our Finder so there should be four columns in CSV file.

Open the Import tab, drag and drop the CSV file and hit Import. After the import is done hit the Save and Continue Edit button.


Step 4. Placing Finder block on storefront

Navigate to the General tab in the Finder you've just set up. Find the Code for inserting in Layout Update XML setting and copy the XML code.

Then navigate to Products > Categories > Select your category (in this case Wheels). In the Design section find Layout Update XML field and paste the code there. Hit Save and we're done!


Step 5. The result

When we navigate to the Wheels category we'll see our newly-created Finder block sitting there.

Now we select options in the dropdown and hit Finder.

And that is all, now we have functioning Finder filter in our category.


Extension settings overview

You will find the settings menu at Stores > Configuration > Amasty Extensions > Product Parts Finder

  • Display `Find` button when - this setting controls when the Find button will be displayed: after picking options in all dropdowns or after picking the first.
  • Use `universal` products - enables and disables Universal products in one clock.
  • Show `universal` products last - when enabled, Universal products will be put at the end of filtered results.
  • Apply filter for current category only - useful when you have one Finder instance across the whole store. When enabled, filtering parameters will be reset when a customer browses different categories.
  • Custom Destination URL - Find button will redirect to the page specified in this setting. It can be set individually for each Finder instance.
  • Start search when value in the last dropdown is selected - when enabled, the Finder will automatically initiate filtering once value in the last dropdown is selected.
  • Reset finder to - sets the destination of Reset button.
  • Clear other (previous) finders conditions - when enabled and you have more than one Finder on the page, only selection in the active instance will apply filtering, all other Finders will be reset.
  • Redirect to product page when there is only one product in result - When there is only one position in the search results, it is possible to redirect straight to the product page. Instead of displaying the list with one item, you can lead the customers to a wanted product.
  • Import history lifetime (days) - sets the lifetime of import error log.
  • Max rows per import - a batch size in lines which the import script will try to process during one run.

Finder block settings

General tab

  • Title - Finder block name.
  • Template - specifies the Finder block layout. Can be set as vertical, horizontal or responsive.
  • Custom Destination URL - determines the page to which the Finder will redirect customers when the Find button is pressed.
  • Code for inserting - the code for inserting in CMS block.
  • Code for inserting in Layout Update XML - the code for inserting in Layout Update XML.

Dropdowns tab. There is no limit to the number of dropdowns in a single Finder block.

  • Name - the dropdown name that will be displayed on the storefront.
  • Sort - sort method for data in dropdown.
  • Range - if you enable this option and then import the data for this drop-down using ranges like “2006-2017” in CSV, the Finder will automatically create rows for each individual value in the range.
Please note that Range will only work for data you import after the Range option is enabled.

Product import in Finder

You can import records to the finder with CSV files.

Deciding on CSV format is very simple: count the number of dropdowns you have and add one more for the SKU column. For example, if you have three dropdowns, adding one makes it four-column CSV.

There are two ways to import files into the Finder: manually from the Finder page or by uploading the file to the specific folder in the Magento directory. The latter is useful when you want to import a large file which your web-server might not allow to upload due to size restrictions.

To import files from the Folder in Magento you should put the file to the following directory: /magento_folder/pub/media/amasty/finder/ftp_import/finder_id/

Please note that the finder_id part in the path should be replaced with the ID of the Finder you want to import the file into. After the file upload is done, open the Import tab and the file you've uploaded will appear ready to import.

SKU bundling

If certain selection can output multiple different SKUs in the result, you can bundle these SKUs and import the whole thing in one line. Here's the example: Make1,Model1,Year1,“sku1,sku2,sku3,sku4,sku5,sku6” Make1,Model2,Year2,“sku3,sku4,sku5,sku6,sku7,sku8”

With these two lines Finder will generate twelve unique records, one for each Make-Model-Year-SKU combination.

Please note that bundling only works for SKUs

Generating Range

By enabling Range in the dropdown settings you'll be able to automatically generate records for numeric data, like a list of years.

Now, when you import a CSV or XLS file you can simply define a range like “2001-2017” and it will generate 17 records automatically when the file is imported.

Here's how the CSV example may look like: Make1,Model1,“2001-2017”,SKU1

The example above will create 17 records in the Finder database which will differ only by the Year value.

Find out how to install the Product Parts Finder extension for Magento 2 via Composer.

Rate the user guide
 stars  from 1 votes (Details)
magento_2/product_parts_finder.txt · Last modified: 2017/12/08 17:48 by panamarenka