Important Notes

Please read these notes before starting the installation process.

✓ This plugin is currently in BETA, so if you want to test it, install it only in staging. We welcome your feedback to continue improving our products and services.

✓ Make sure to correctly UNINSTALL the old version of the plugin before installing the new Doofinder’s Magento 2 plugin. This applies in case you have a previous Doofinder plugin installed.

✓ Magento recommends having a BACKUP of your database so, please, make sure you have one before initiating the uninstalling process.

Pre-requisites

  1. This module requires Magento 2.3 or greater.
  2. This module is heavily based on Cron. Magento 2 requires Cron to properly work, so you must have Cron up and running in your server for the module to work.

Uninstallation

To uninstall the module, execute the following command on the root folder where your Magento is installed:

bin/magento module:uninstall Doofinder_Feed Doofinder_FeedCompatibility

If there is any problem with the uninstalling process of the plugin, you need to make sure that:

  • The composer tool is accessible by Magento (type down composer in your terminal and see if there is any response)
  • The established memory limit for your PHP is equal or higher than 4 GB (this is configured in your php.ini file)

Verify this module is no longer in your installed modules list. To check this out, run:

bin/magento module:status Doofinder_Feed Doofinder_FeedCompatibility

and check the response.

Installation Process

The module is installed through composer.

You need to specify the location of the Doofinder module in the composer.json file of the Magento 2 installation:

"minimum-stability": "dev", // Probably want to search against an under-development package
"prefer-stable": true,
"repositories": [
    ...
    {
        "type": "git",
        "url": "https://github.com/doofinder/doofinder-magento-101.git"
    },
    ...
],

Append the repository from the new module, so that composer can find this package.

Now, run:

composer require df/df-magento2:dev-main

The module should now be installed and working on the platform.

To activate it, run the following command in the Magento root folder:

bin/magento setup:upgrade

A new “Doofinder” menu should have been added to your Magento Admin Panel.

Click on the Doofinder icon under Stores to display the option’s menu.

Module configuration

Click on Initial Setup to configure the module in 2 steps.

Step 1: System Integration

Click on Create Integration.

After a few seconds, the integration will be ready and the next step of the configuration flow will be activated.

To link your website to a Doofinder account, you can log in with an existing account or register for a new free trial very easily.

Simply click on the corresponding button and fill in the pop-up form. Once submitted, the pop-up window will close and the initial setup flow will be finished.

📌 Note: If you are creating a new account, be sure to use an email address that you have not used before. This is a unique field. Also, make sure that your website has not been previously linked to a Doofinder account. You can only link your website to one account.

Once you have linked your website to a Doofinder account, the configuration process will automatically create the search engines, indexes and all other settings.

On the following screen, you will have two options:

1. Check index Processing Status:

Here you will find the current status of the indexing process, whether it is OK or there is an error (and the corresponding message), and the date and time of the last synchronization.

Check the following example of a successful indexing process:

2. Go to Configuration:

In this section, you can check if all settings have been created correctly.

Check that the ‘Enabled’ field in Doofinder Layer is set to “Yes” (default is “Yes”).

📌 Note: It is recommended to “save” the settings and clear the system cache to make sure that the module is displayed correctly on the front-end.

Module Configuration Fields

  • Account: In here you will find your API KEY.
  • Doofinder Layer: You can activate or deactivate the search layer by selecting YES or NO.
  • Update on Save: If enabled, when a product is created, updated or deleted this change is sent to Doofinder automatically.
  • Custom Attributes: Attributes selected as ‘Enabled’ will be included in the feed indexation.
  • Doofinder Integration Configuration (Advanced): Find information related to the integration.

Doofinder Layer

The layer will be automatically created in your Magento 2 website.

Magento 2 works with our Live Layer and fullscreen layer by default.

Once the indexing is finished, the layer will be enabled. You can enable or disable the layer in your Magento Store > Doofinder > Configuration >Account > Doofinder Layer.

📌 Note: This module no longer works with V7 and embedded layer.

If you can’t see the Layer in your store, you probably need to clean the cache after installing the module. Go to your Admin Panel > System > Cache Management and choose Flush Magento cache.

Installation ID and Script

The Installation ID and the Script are generated automatically during the installation process.

Should you encounter any problems, please contact support@doofinder.com

Last updated: May, 2022