Skip to main content

Sync groups screen

The Sync groups screen lists sync groups—each holds a schedule and a set of sync tasks that run on that schedule.

N
Written by Niyaz

The Sync groups screen lists sync groups, each with a schedule and a set of sync tasks that run on that schedule. Reach it by selecting Sync in the left navigation.

Sync groups list with columns for name, interval, start time, and enabled state.

List screen

Column

What it shows

NAME

The sync group's name.

INTERVAL TYPE

The frequency unit.

INTERVAL VALUE

How many hours or minutes separate runs.

START FROM

The time of day in HH:MM format when the first sync starts.

ENABLED

Whether the sync group is active.

List controls

Control

What it does

CREATE

Opens the create form to define a new sync group.

Delete

Removes the sync groups selected with the row checkboxes.

Rows per page

The list supports 5, 10, 25, or 50 rows per page, with 10 as the default.

Create form

The create form is headed Create Sync. The create form does not include Interval value or Start from. You set Interval value and Start from after saving the sync group and opening its record to edit it. Save is disabled when the create form is empty. Save becomes available after you enter a name and choose an interval type.

Field

What it holds

Options and constraints

Name

The sync group's display name.

This required field has a character limit of 300.

Interval type

How often the sync runs.

The options are hourly and minute.

Enabled

Whether the sync group is active at creation.

This optional toggle is off by default.

Group record

After saving a sync group, you can view and edit its record. The record adds Interval value and Start from, which do not appear on the create form.

Field

What it holds

Options and constraints

Interval value

How many of the chosen interval units separate runs.

The options are 1, 2, 3, 6, 12, or 24.

Start from

The time of day in HH:MM format when the sync begins.

This time-of-day picker does not include a date.

Tabs

Tab

What it shows

General Info

The group's name, interval type, interval value, start from time, and enabled state.

Sync tasks

A table of sync tasks assigned to the group, showing each task's name, endpoint, last run, last status, and enabled state.

Notes

  • The Interval value number is interpreted according to the Interval type: hours for hourly and minutes for minute.

  • An interval value of 24 with hourly means every 24 hours, while the same value with minute means every 24 minutes.

Related

Did this answer your question?