Schedule recurring user syncs
User Sync schedules run an existing user sync configuration on a recurring cadence. For example, you can schedule a nightly Active Directory refresh or a weekly CSV import.
Manage User Sync schedules from the User Sync tab on the Schedulers page. This guide covers the steps and detail page information that are specific to User Sync schedules. For shared concepts — including permissions, the list view, the Schedule and History detail tabs, auto-disable behavior, and concurrency — refer to the schedulers overview guide.
Before you start
Before you create a User Sync schedule, make sure a user sync configuration already exists.
Create and manage sync configurations from Administration > Users with the Import & Sync button. For details, refer to the import and sync users guide.
Create a User Sync schedule
From the User Sync tab, select New Schedule in the page toolbar. The wizard includes three steps.
Step one — Basic information
Use this step to name the schedule and choose whether to send notifications.
| Attribute | Required | Description |
|---|---|---|
| Schedule Name | Yes | A descriptive name for this scheduled job. |
| Send notifications | No | When enabled, recipients receive a sync summary email after each run. Failures are also routed to system administrators via the Notification Center. |
Step two — Select sync configuration
Use this step to select the sync configuration the schedule runs.
The picker shows a searchable flat list of all sync configurations visible to you. Select one sync configuration to schedule.
Each schedule can run one sync configuration. To run multiple configurations on different cadences, create one schedule for each configuration.
Step three — Schedule
Use this step to set the schedule cadence, start date and time, and optional end date.
You can choose One time or Recurring. For full field descriptions, refer to the schedule section in the Schedulers overview guide.
Detail page
The User Sync schedule detail page shows the standard four stat cards: Next Run, Last Run, Success Rate, and Avg Duration. It also shows two information cards specific to User Sync schedules.
| Card | Contents |
|---|---|
| Basic Info | Schedule name and notifications setting. Edit action available. |
| Job Details | Target (the sync configuration name), Created, and Modified dates. |
User Sync schedules don’t include Run As User or Delivery cards. Those cards are specific to Process and Report schedules.
The Schedule and History tabs are the same across all scheduler types. Refer to the schedule section and history section in the Schedulers overview guide.