Skip to main content

Sync tasks screen

Sync tasks live on the Sync tasks tab of a sync group record.

N
Written by Niyaz

Open a sync group record and select the Sync tasks tab to view its tasks.

Sync task list with endpoint, run status, enabled, and execute columns

Task list

Control

What it shows

Name

The task's name.

Endpoint

The ERP endpoint the task syncs with.

Last Run

The date and time the task last ran, or “-” if it has never run.

Last Status

The outcome of the last run: Success, Failure, Not run yet, or “-”.

Enabled

Whether the task is active.

Execute

Runs the sync task immediately without a confirmation step.

List controls

Control

What it does

ADD SYNC TASK

Opens the task dialog to create a new sync task.

Rows per page

Sets the page size for the task list.

Pagination control

Long lists paginate with a pagination control.

Task dialog

Field or control

What it contains or does

Required

Name

The task's display name.

Yes.

Erp endpoint

Selects the ERP endpoint that the task syncs with; Open opens the selected endpoint.

Yes.

Enabled

Activates or deactivates the task.

No.

Invalidate storefront cache after sync

Turn it on for tasks that sync catalog data shown on product pages, including products, categories, brands, and collections, and leave it off for customers, orders, prices, and stock.

No.

Page size

Sets the OData page size ($top); when empty, the default is 200, and a lower value is recommended if the task hits an ERP idle timeout.

No.

Form state

On the empty form, Save is disabled while the required fields are empty. Save becomes available after the required fields are completed.

Notes

  • Sync tasks have no standalone list; they are nested inside a sync group record.

  • The schedule for a sync task comes from its parent group, not from the task itself.

  • Rows are selected using row checkboxes.

  • The Select all checkbox selects all tasks on the current page.

Related

Did this answer your question?