Skip to content

Configurations

danneg edited this page Sep 2, 2022 · 13 revisions

If your project has the Data Exporter Layer integrated, please disable.

In the Shopware 6 admin, the configurations are in the Settings >> System >> Plugins >> Boxalino Data Integration for Shopware v6 path (or admin#/sw/plugin/settings/BoxalinoDataIntegration)

The configurations must be set for every Sales Channel individually. Please do not activate the DI processes globally.

General Configurations

  • Active : must be activated on the Sales Channel that use the new DI strategy; must be disabled for the Headless ones.
  • Account is provided by Boxalino on your account kick-off.
  • When "Use Development Data Index" is enabled, the exporter will update the dev data index.
  • Test mode, when enabled, will log the content of the export in a /var/log/boxalino-di-env.log file
  • Data Integration Key and Data Integration Secret are the ADMIN role credentials for the given account and data index mode
  • Product, Orders and Customers export the data based on the configured Data Integration Batch Size. The purpose is to minimize the load on your server (so content will get exported in batches of the configured size). Set a higher value (100000) if you do not need the batch export.

Full Data Integration Configuration

  • Allow Product Data Integration will control the full product data sync, if it has been integrated.
  • Enable User Data Integration will control the full user data sync, if it has been integrated.
  • Enable Order Data Integration will control the full order data sync, if it has been integrated.
  • Threshold is to be configured by the integrator. Purpose: after a full export is received, the export will update your data index if there are at least the amount of declared items per your threshold configuration.
  • Full Data Integration Endpoint is the public service to which the full data syncs requests are made. Please review the public Boxalino documentation

Delta Integration Configuration

  • Allow Product Data Integration will control the delta product data sync, if it has been integrated.
  • Enable User Data Integration will control the delta user data sync, if it has been integrated.
  • Enable Order Data Integration will control the delta order data sync, if it has been integrated.
  • Outsource will load the doc_attribute & doc_attribute_value from the latest available FULL. Purpose is to make the delta faster by only exporting product information and not the attribute data.
  • Delta Data Integration Endpoint is the public service to which the full data syncs requests are made. Please review the public Boxalino documentation

Full & Delta data integration processes can be handled with the use of CLI commands. Please review the wiki pages in regards to Integrations.

Instant Update Configuration

  • Allow Instant Product Update will control the product real time data sync, if it has been integrated.

For product instant update integration - review the wiki page Integration Other real-time data updates (order, customers) are not part of the repository. The flags can be used by the clients` integration team for development purposes.

  • Enable User Data Integration will control the user real time data sync, if it has been integrated.
  • Enable Order Data Integration will control the order real time data sync, if it has been integrated.
  • Instant Update Endpoint is the public service to which the Instant Update requests are made. Please review the public Boxalino documentation

Scheduler Configuration

Available as of tag 3.4.2

Scheduler was introduced in order to restrict the hourly run of the Shopware6 ScheduledTask element. It will allow configuration for the time range when it is allowed to run the delta/instant syncs. The local hour, based of the PHP configurations of the server, is compared to the configured start / end hour. It is possible to declare ranges like from 4 - 23 or from 8 - 3)

  • Enable Scheduler will enable the control of DI exports.
  • Daily Start Hour is used to declare the beginning of delta/instant exports
  • Daily End Hour is used to declare the end of the cycle