How to install Doofinder in WooCommerce

or send an email to support@doofinder.com

Plugin Installation

To complete the tutorial you will have to perform some steps both in your WordPress app and the Doofinder control panel.

First of all, install the Doofinder for WooCommerce extension in your WordPress installation. Notice that this extension requires having WooCommerce previously installed.

To install the extension you can go to the Plugins > Add New menu, search the extension in the WordPress Plugin Directory and choose Install Now. You will find the plugin in the official WordPress plugins repository.

If you have problems installing the extension and need comprehensive documentation about how to install extensions for WordPress, please take a look at the official WordPress Codex documentation.

Doofinder Configuration

Create a Search Engine

To continue you'll need a valid Doofinder account. If you don't have one, sign up in a minute with a valid email and a strong password here.

If you've signed up right now, you'll end in a wizard page that will guide you through the required steps to have your new, shiny search engine working in a few minutes. If you already had an account, you'll probably know how to create search engines but, just in case, you have to press the New Search Engine button in the search engines list.

Give your search engine a descriptive name. As you may have more than one store, setting a good name will help you identify which search engine relates to what store.

Finally, enter the URL of your store. A good value for the URL field usually is the main site domain (include the path to your store if it's not in the root of the site).

Once done press Continue.

In the next screen you will be asked to choose a platform. If we managed to detect that your site is using WooCommerce, that's the platform that will be selected by default. Otherwise choose WooCommerce.

Once done press Continue.

Notice: Doofinder will try to detect the extension by accessing a special URL. In case of error you'll get a warning saying that the extension couldn't be detected. Make sure you also enabled it after the installation finished. If everything looks right but the problem persists, please, contact us at support@doofinder.com.

If you use a compatible multi-language plugin, you will be asked to choose a language in the next screen. To use Doofinder with the rest of the languages in your site you will have to create a new search engine for each language.

Once done, Doofinder will start reading products data from the module in the background, and you'll be ready to continue with the creation of the Layer script. Press Yes, let's go!.

Create a Layer script

If you chose to create the layer you will be presented a screen with a copy of your site and a wizard on the left.

These are the steps to follow:

  1. Confirm that the site URL is correct and select Other in the Platform selector.
  2. Choose the type of layer you want to use.
  3. Press Choose Search Box to enable selection mode. You'll see a message saying: Waiting for selection…. Click on your site's search box to use it to configure your javascript layer.
  4. Customize other options in the last step.

Once done press Save.

The code for your Javascript layer will be available at Configuration > Doofinder Layer > Setup.

When required, you'll have to go there and copy the code to paste it into the Doofinder plugin settings.

Obtain an API key

If you plan to use server search, you'll need an API key.

To get one, in the Doofinder control panel, click your e-mail address on the top-right corner of the page, and click API keys in the drop down menu.

Click the New API Key button and, in the dialog, check the option I will use this API Key with the Management API. Optionally, give your API Key a name and press Create API Key.

You will need the value of the API Key later to enable internal search in the WooCommerce module.

Configure the plugin

Before switching to your WordPress admin, let's go to the search engines listing in the Doofinder control panel and annotate the unique identifier of your new search engine, the so called Hash ID.

Log into your WordPress admin and go to the Doofinder settings screen. You will find it by clicking at WooCommerce > Settings in the left menu, and as a new tab in that page.

Javascript Layer

Go to Doofinder Layer in the Doofinder Settings tab.

Then check the option Enable the Layer and paste the layer script into the big text area, ans save the options.

If you only want to give Doofinder a try, this will suffice. You'll get a nice javascript search engine your users will be able to interact with through the search box of your online shop.

If you want to fully integrate Doofinder in your WooCommerce store then continue reading.

Go to Internal Search in the Doofinder Settings tab.

Fill in the API Key and Hash ID text boxes with the data we obtained from the previous steps done in the Doofinder admin, and ensure that the Enable checkbox is checked.

If you use a compatible multi-language plugin, you will have to fill the Hash ID again for the other search engines you created for the other languages, or disable internal search for them.

Optional: Data Feed Settings

It's also possible to configure some aspects of the product data indexed in Doofinder. Those options are available from the Data Feed and the Data Feed Attributes tabs.

Data Feed

  • Protect feed with password: Add a password to your feed to get it secure. Don’t forget to update the data feed URL in your Doofinder control panel at Configuration > Data Sources.
  • Feed password: Choose the password you want to use to protect your data feed.
  • Export product prices: Include product prices in the data feed. The price will be included following your currency and taxes settings in WooCommerce.
  • Export product tags: Export product tags in the data feed.
  • Split Variable products: Show all the variables in the search results.
  • Export values with units where applicable: Width, height, length and weight of the products will be exported with units. If the option is not selected then only the number will be exported.

Data Feed Attributes

You may add extra attributes to your data feed. Simply choose the attribute you want to export and give it a field name. Field names must not include space characters and is better if they are lowercased.

When you make changes to the Data Feed and Data Feed Attributes section, do not forget to reindex the feed in your Doofinder control panel at Configuration > Data Sources.

That's all!

If you reached this point you should now be set up and ready to begin your 30-day free trial!

If you have any questions or doubts about the integration please do not hesitate to contact us on: support@doofinder.com

Disclaimer: Doofinder offers this module just to help customers to integrate easily. We are not responsible of any issue or unexpected behavior. We also encourage you to contribute and improve the module in our open repository.

You will find the latest version of the plugin for WooCommerce and instructions on how to install and configure it in the WordPress Plugin Repository:

https://wordpress.org/plugins/doofinder-for-woocommerce/

If you prefer browsing the source code you can visit our repository in Github:

https://github.com/doofinder/doofinder-woocommerce