Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Prerequisites

  • Active HawkSearch account

  • Magento running on the server which has the following

Installation

Install via Composer

  1. Install composer packages

    Code Block
    languagebash
    composer require hawksearch/esindexing-magento-2 --no-update
    composer update hawksearch/esindexing-magento-2
  2. Setup the extension in Magento

    Code Block
    languagebash
    bin/magento module:enable --clear-static-content HawkSearch_Connector HawkSearch_EsIndexing
    bin/magento setup:upgrade
    bin/magento cache:flush

Configuration

Hawksearch Account

Before Hawksearch can be used with Magento, a Hawksearch account is needed. Having the account, it’s possible to configure the Magento extension to work properly.

Contact your account manager at https://www.hawksearch.com/ and request for an account.

Magento Settings

To configure the Magento extension you need the following Hawksearch credentials:

...

In the administration section of your Magento project, navigate to Stores > Configuration > HAWKSEARCH > Connection Settings and fill in the form with all the information required.
Specify Run Mode setting depending on the site environment. Read more in Domains and Environments documentation sectionEnable Indexing in Indexing Settings and make your first data push to HawkSearch.

Tune-in Hawksearch Dashboard

Fields Configuration

Before you push Magento data to HawkSearch it requires some Fields to be created in Hawksearch Dashboard. There are several Default System Fields which are used to correctly identify documents in Hawksearch index as well as mandatory Products and Pages fields.

Indexing

After extension is configured and Fields are created data from Magento should be initially pushed to HawkSearch. The process is called indexing. Enable Indexing in Indexing Settings and make your first data push to HawkSearch. To accomplish this run the following CLI command:

Code Block
languagebash
php bin/magento indexer:reindex hawksearch_products

Read in details about the indexing process.