[Index]
Overview
Sync scheduling involves scheduling actions to take place at a specified time, or to repeat.
Currently, the action is to execute.
Single or multiple actions can be executed on one or more resources:
Care should be taken when transactions are scheduled. For example, data syncs should be scheduled outside of peak times. The size and scope of the transactions that run determine the length of the time that they need to run. This therefore impacts on the start time. The number of clusters on the system and their size need to be considered as part of a data sync approach.
Best practice for scheduling syncs
Enable a scheduled data sync
Tip
Use the Action search to navigate Automate
This procedure enables the scheduled data sync so that it executes regularly.
Note
Setting up a Cisco UCM or CUC device in Automate:
See Manually run the default data sync in the Core Feature Guide
- Creates a Change Notification Sync type (on the Data Sync page). Manually running the change notification sync is not supported.
- Creates a scheduled data sync (disabled by default) to execute a data sync every 14 days. This topic describes how to enable this regular sync.
Enable the scheduled data sync
Log in as provider administrator.
Go to the Scheduling page.
Choose the schedule instance that matches this naming convention: HcsSync-<ip_address>-<device_name>-SCHED
For example: HcsSync-192.0.2.24-CUCM01-SCHED
Select the Active checkbox.
On the Multiple Executions tab, update the interval, as required.
Click Save.
The full data sync executes immediately, and executes again according to the schedule.
Add or edit a schedule
Tip
Use the Action search to navigate Automate
This procedure displays and edits existing schedules, and adds a new schedule.
Note
Automate also provides a tool to deactivate and reactivate schedules in bulk, if required.
See Bulk Schedule Activation / Deactivation in the Core Feature Guide
Log in to the Admin Portal and select the relevant hierarchy.
Go to Sync Scheduling to open the list view.
View existing schedules in the summary list view, which includes a number of attributes for each schedule.
Note
Resource attributes are used for filtering when you want to choose a resource.
Choose an option:
Configure the schedule.
The table describes sync schedule settings on the Details tab/panel:
| Setting | Description |
|---|---|
| Schedule Name | The name of the schedule. |
| Last Executed (UTC Time) | Read-only. Displays the last time this schedule executed. |
| Owner | The schedule owner. The user who created this schedule. Read-only for existing schedules. |
| Schedule Type | Mandatory. Select the schedule type. Either Single Execution or Multi Execution. See below for the configurable settings for either single execution or multi execution. |
| Active | This checkbox defines whether the scheduled sync is enabled (active) or disabled. Clear the checkbox to disable the sync schedule. If you're enabling the sync schedule and there is a "next execution" in the past, the sync executes immediately when you save. To prevent the execution of this past sync schedule, select Skip execution on activation. |
| Skip execution on activation | Prevents the execution of a "next execution" in the past if you're choosing to enable the schedule now. Selecting this option prevents a situation where, for example, you wish to pause the execution of scheduled syncs for a period, perhaps to perform an upgrade. Post-upgrade, when activating the schedule, a number of pending syncs may execute immediately. This setting clears pending scheduled syncs so that the schedule executes again only at the next scheduled execution time, after the schedule is set to "active". |
| Scheduled resources | Mandatory. Displays only when Active is selected. Adds one or more scheduled resources. Configure the following:
|
The table describes sync schedule settings on the Multiple Executions or Single Execution tab/panel. The tab/panel that displays depends on the option selected for Schedule Type:
| Schedule Type | Settings |
|---|---|
| Single Execution |
|
| Multiple Executions | Choose one or more of the following options:
Configure settings for the options you selected. When choosing two or more options, the first scheduled time takes priority. If a schedule is in a state where the last executed and next execution time are equal, the next execution time is recalculated to ensure its execution. |
Click Save to create (or update) the schedule.
The schedule you added (or updated) displays in the Scheduling list view.
The Schedule model allows scheduling of execute actions. Scheduling can be performed once, or multiple times, depending on the choices given to the schedule instance.
| Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Schedule Name * | Name of this Schedule |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Last Executed (UTC Time) | Last time that this schedule executed |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Owner | A business key that identifies the data/User who created the schedule. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Schedule Type * | Type of Schedule |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Active | Is the entire schedule active or not. Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Skip execution on activation. | Skip immediate execution on activation. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Scheduled resources | List of resources that will be actioned |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Action * | Action to perform |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Resource Type * | Resource types to which this schedule will apply. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Resource Attribute * | Resource attribute that will be used to filter/choose from. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Resource * | DESCRIPTION |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Perform Action | DESCRIPTION Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Single Execution | Single Execution |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Date (YYYY-MM-DD. Local date) | Execution Date |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Time (HH:MM:SS. Local time) | Execution Time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Multiple Executions | Multi Execution |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Use Specific Executions | Use specific executions. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Use Calendar Executions | Use calendar executions. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Use Timed Executions | Use timed executions. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Specific Execution Dates | Specific Execution Dates |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Date (YYYY-MM-DD. Local date) | Execution Date |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Time (HH:MM:SS. Local time) | Execution Time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Calendar Executions | Repeated Execution by Calendar |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Calendar Month | Calendar Month |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Calendar Day | Calendar Day |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Calendar Hour | Calendar Hour |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Calendar Minute | Calendar Minute |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Timed Executions | Timed Execution |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| First Execution Date (YYYY-MM-DD. Local date) | Execution Date |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| First Execution Time (HH:MM:SS. Local time) | Execution Time |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| First Execution Timezone (Local timezone) | Timezone for Execution Default: 0 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Repeat after (x) Days | Repeat Days |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Repeat after (x) Hours | Repeat Hours |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Repeat after (x) Minutes | Repeat Minutes |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Number of Repeats (0 = infinite) | Number of Repeats |
|
|||||||||||||||||||||||||||||||||||||||||||||||