Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can find these credentials on the Hawksearch Dashboard on the Admin > Account Info tab. Please follow Hawksearch URLs article to find the dashboard URL depending on the Hawksearch environment.

In the administration section of your Magento project, navigate to Stores > Configuration > HAWKSEARCH and fill in the form in the Connection Settings tab with all the information required.

...

Domains

Hawksearch has three environments available: Development, Staging/Test and a load-balanced Production. When performing integration, each engine can be accessed by using appropriate domains. In most cases it doesn’t require to change default values of URL settings.

Hawksearch URL Settings

Hawksearch Tracking URL Settings

Hawksearch Recommendation URL Settings

DataFeed Settings

...

This is the list of the sites that is currently installed on your Magento instance. Select the site(s) you need to generate the feeds for. The separate file will be created for each store per each data type. See Data Feeds section for more details

Setting is available on ‘Default Config’ Scope only.

...

This setting allows you to specify an email address that an email should go out to, once the feed has been generated.

Fileds Mapping

There is an ability to create new Hawksearch fields from Magento configurations page and then map Hawksearch fields to Magento Attributes. The Hawksearch field is created with the setting “Do not store in index?“ set to Yes. Please fine tune the field settings in Hawksearch Workbench after it is created from Magento configuration page. You can find more details about Fields configuration in Wiki section in Confluence.

Adding new field

To add new field please scroll down the field list and find Add button at the very end of the list. Fill in “HawkSearch Label“ and “HawkSearch Code“ input boxes and optionally select Magento attribute. You need to Save Config to apply changes.

...

Pulling fields from Hawksearch

To pull all fields created in Hawksearch Workbench push the button “Pull Fields from HawkSerch“. All fields available in HawkSearch will be added on the page. You need to Save Config to apply changes.

Note: if field is removed in Hawksearch Workbench when field and corresponding Magento attribute mapping will be removed from Magento Configuration. The exiting mapping will NOT be reset after pulling fields.

Map Hawksearch fields to Magento attributes

If you want to have attribute data appeared in Datafeed this attribute should be mapped to any Hawksearch field. To map Magento attribute to Hawksearch field just select attribute code from the “Magento Attribute“ dropdown list. To remove mapping specify “--Please Select--“ option in “Magento Attribute“ dropdown list. You need to Save Config to apply changes.

There is a “Dedicated method“ option in “Magento Attribute“ dropdown list which is a reserved option for the following Hawksearch field codes:

  • url_detail

  • group_id

  • is_on_sale

  • metric_inventory

  • category_id

  • rating_summary

  • reviews_count

Do not use “Dedicated method“ for other fields because it does nothing.

SFTP Settings

...

Settings in this section are available on ‘Default Config’ Scope only.

...

Setting is available on ‘Default Config’ Scope only.

For manual categories synchronization there is a CLI command specified:

Code Block
bin/magento hawksearch:proxy:sync-categories

Cron expression

This setting allows you to specify the cron expression to control the schedule for running the synchronization task. Enter a standard 5 part cron expression. See https://en.wikipedia.org/wiki/Cron for more information about cron expressions. Note that the job cannot be scheduled to run more frequently than hourly.

...

For more details about Data feed files please refer to Standard Data Feed Requirements for Datafeed-based indexing documentation

Generate Data Feeds

...