Synchronization tasks call ERP endpoints and can run as part of a scheduled group or individually by hand. The Admin Panel has separate Sync and Logs menu items. Sync logs help you investigate task failures, including the reasons recorded for each attempt.
How groups, tasks, and logs relate
A sync group brings tasks together for a scheduled run. Each sync group has the fields Name, Interval type, Interval value, Start from, and Enabled.
A sync task calls an ERP endpoint. A scheduled group run processes enabled tasks in the group. A sync group record has a Sync tasks tab alongside General Info.
Sync logs retain the full error text when a task fails. You can review the separately listed retries to investigate a failure.
Manual runs
You can start a sync task by hand instead of waiting for its group's next scheduled run. A task started by hand that ends as failed raises the same failure event as a scheduled run, so your own test can trigger a notification rule. Running one task by hand produces no group summary, since that event belongs to whole groups.
Where the logs live
Logs is a top-level menu item alongside Sync. The Logs screen has two tabs, Sync and Errors.
The Sync tab is where you review sync task logs.
The Errors tab is where you review errors.
Sync groups were moved to a higher level of the Admin Panel menu, and task logs were split out into their own area.
Why failed tasks need attention
Before a sync task counts as failed, it is retried: four tries in total, one second between each. The sync log lists each retry with its own reason and keeps the full, untruncated error text. You may not notice a failure at first, because shoppers keep seeing the last data that arrived, which can mean out-of-date prices or products you have already removed. If no one is notified, the failure shows up only as an entry in the sync log, and only for whoever checks it. If storefront prices or products look out of date, check the sync log for a failed task. Slow Priority ERP requests can cause a sync task to fail before data arrives. Reducing the page size for the affected endpoint can keep requests within the timeout.
Two events for sync notifications
Two events can report on synchronization: one for each failed task and one for a whole scheduled run. The task failure event sends one message per failure, so it suits a store that wants to be alerted to every failure. The group-finished event sends one summary per scheduled run, including how many of its tasks failed. Choose it if you would rather get one summary after each run than a separate alert for every failed task. The summary is raised even when no task failed. The number of tasks it reports counts only the enabled tasks that were actually processed, which can be fewer than the group contains. If you turn on both events, one failed run produces two messages. Messages from both events go to the store's operations contact, never to shoppers.
Related