Skip to main content

Add a sync task

A sync task maps a name to an ERP endpoint within a sync group.

N
Written by Niyaz

Use a sync task to map a name to an ERP endpoint within a sync group and run it on the parent group's schedule.

Before you begin

  • Confirm that the sync group already exists before adding the task.

  • If the sync group does not exist, create a sync group first.

Steps

  1. In the navigation, open Sync, then select the sync group you want to work with.

  2. Select the Sync tasks tab; the Sync Tasks view opens.

  3. Select ADD SYNC TASK; the add form opens.

  4. In the Name field, enter a name for the task.

  5. In the Erp endpoint field, choose the ERP endpoint that the task should call. To inspect the selected endpoint, select Open.

  6. Set the Enabled toggle to match whether the task should be active.

  7. Optional: For tasks that sync catalog data shown on product pages, turn on Invalidate storefront cache after sync.

  8. Optional: In Page size, enter an OData page size, or leave the field empty to use the default of 200. Lower the page size if this task encounters an ERP idle timeout.

  9. After you complete the required fields, confirm that Save is available.

  10. Select Save.

Each row in the Sync tasks list has an Execute action that runs the task immediately without a confirmation prompt. Do not select Execute unless you intend to trigger a live sync immediately.

Result

The new task appears in the sync group's Sync tasks list with its name, endpoint, last run time, last status, and enabled state. The task runs automatically on the parent group's schedule.

Related

Did this answer your question?