manuel-inhertz / magento2-module

AccelaSearch module for Magento2

Accelasearch Magento 2

This document is available in English, Italian.

Installation

Composer Installation

Install the module through Composer:

composer require accelasearch/magento2

Enable the module:

bin/magento module:enable AccelaSearch_Search

Upgrade Magento's database and dependencies:

bin/magento setup:upgrade

Compile dependency injection:

bin/magento setup:di:compile

Compile static content:

bin/magento setup:static-content-deploy

Clear cache:

bin/magento cache:flush

Manual Installation

Download package from GitHub:

wget https://github.com/accelasearch/magento2-module/archive/refs/heads/main.zip

Extract the zip file:

unzip main.zip

Copy its content into Magento's appropriate location:

cp -R main/* app/code/AccelaSearch/Search

Enable the module:

bin/magento module:enable AccelaSearch_Search

Upgrade Magento's database and dependencies:

bin/magento setup:upgrade

Compile dependency injection:

bin/magento setup:di:compile

Compile static content:

bin/magento setup:static-content-deploy

Clear cache:

bin/magento cache:flush

Feed Configuration

---

Feed Status

Enables or disables feed export

---

Use Vue Storefront

If enabled it will be possible to specify a custom image size for the export process

---

Export Directory

Specifies destination directory for the XML feeds, relative to Magento 2 root

---

Custom Base URL

Allows to specify a custom base URL, for example when using VUE to retrieve images of products

---

Category

Specifies whether selected categories should be included or excluded

---

Exclude from Path generation

Specifies categories which shall be excluded by the category path generation process. As an example, if some categories are specific for some language, they should be excluded from the feed of other Storeviews.

---

Search

Specifies endpoint where the JavaScript code of AccelaSearch can be accessed, as well as an optional CSS to be included for overriding and customization

---

Fields

Specifies main fields for the feed. Some fields will be inherited form the GoogleShopping module and will not be used by AccelaSearch

Allows to specify additional values for custom fields which will be mapped as key => value

Allows to specify attributes with multiple values which will be exploded over multiple rows, as dictated by Google Shopping specifications

---

Cron Configuration

Allows to enable a cronjob to scheduler generation of feeds, as well as configure the relative cron expression and schedule the process as soon as possible.

---

Notification

Allows to specify a set of email addresses to which notify products affected by errors during the feed generation process

---

Dynamic Price

Exposes an endpoint which AccelaSearch can query to get dynamic prices depending on type of customer and currency code.

• Listing price: Attribute used to identify prices
• Public Visitor Type: Whether to export customer group
• Public Currency Code: Whether to export currency code
• Cache Lifetime: Time to live of dynamic price (used for caching)

Comandi Manuali

Generates feeds as configured:

bin/magento accelasearch:generate:feed

Cron

Default cron expression (configurable through user interface):

0 1 * * *

NOTE

This modules generates a lock file under var/locks in order to prevent concurrent feed generation processes.