boxalino/exporter-magento2

Boxalino Data Exporter for Magento2 plugin

2.5.15 2022-11-30 09:50 UTC

Requires

• php: >=7.2
• magento/framework: *
• magento/module-indexer: *

MIT

• magento
• exporter
• boxalino

README

Notice

The Data Exporter Layer is replaced by the Data Integration Layer. For integrations to come, please use the DI plugin: https://github.com/boxalino/data-integration-magento2

Get in touch with Boxalino for migrations from Data Exporter to Data Integration. Migration to Data Integration documentation available on wiki https://github.com/boxalino/rtux-integration-magento2/wiki/DI:-Migration-from-Exporter-to-Data-Integration

Boxalino Exporter - Magento2

Introduction

For the Magento2 integration, Boxalino comes with a divided approach: data exporter, framework layer and integration layer. The current repository is used for the data exporter layer.

About the data synchronization

With the use of the Boxalino account it is possible to create 2 data indexes: production (your live setup) and development (staging area). The account name, password and the data index have to be configured in the plugin.

In case you plan on using both data indexes, there is a timing restriction: the development data index must be updated at least 2 hours after the production index.

Data synchronization types

The export options have been designed as generic Magento 2 indexers. They can be identified in the Magento`s System >> Index Management view.

1. The Boxalino Exporter (Full) must be executed once/day. The time of the execution has to be after your store data has been updated by the other 3rd party events.

It requires to be configured with the Magento Indexer mode "Update on Save".

1. The Boxalino Delta Exporter can be executed as often as every 25 min. Beware, there should be no delta exports for the 2 hours after a full data export.

It can be configured with the Magento Indexer mode "Update by Schedule". When "Update on Save" is used, the products export logic will rely on the catalog_product_entity.updated_at field to identify latest changes in the products.

Setting up exporter

Check the exporter integration documentation

The exporter can be executed with the use of the Magento cron jobs, mview or CLI.

1. Edit & save the Boxalino Exporter configurations in your Magento Store Configurations.
2. Create a crontab.xml in which the crons can be defined. Pay attention to the scheduler times

<group id="default">
  <job name="boxalino_exporter_delta" instance="Boxalino\Exporter\Model\Indexer\Delta" method="executeFull">
      <schedule>*/30 7-23 * * *</schedule>
  </job>
  <job name="boxalino_exporter" instance="Boxalino\Exporter\Model\Indexer\Full" method="executeFull">
        <schedule>15 2 * * *</schedule>
    </job>
</group>

Add the cron job only for the indexer that uses the "Update on Save" mode (check the Index Management view in Magento2 back-end)

1. If mview is enabled for the project, configure the schedule time to ensure that delta exports do not happen more often than every 30min.

The mview checks the "execute" function of the boxalino_exporter_delta indexer For the mview use, set the "Boxalino Delta Exporter" mode to "Update by Schedule" Check the [exporter integration documentation](https://github.com/boxalino/rtux-integration-magento2/wiki/Exporter

CLI

The data synchronization can also be triggered with the use of a command line:

php bin/magento indexer:reindex boxalino_exporter

php bin/magento indexer:reindex boxalino_exporter_delta

Contact us!

If you have any question, you can reach us at [e-mail]