[Index]

Model: data/Schedule

Sync Scheduling

Full HTML Help

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

Enable the scheduled data sync

  1. Log in as provider administrator.

  2. Go to the Scheduling page.

  3. Choose the schedule instance that matches this naming convention: HcsSync-<ip_address>-<device_name>-SCHED

    For example: HcsSync-192.0.2.24-CUCM01-SCHED

  4. Select the Active checkbox.

  5. On the Multiple Executions tab, update the interval, as required.

  6. 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

  1. Log in to the Admin Portal and select the relevant hierarchy.

  2. Go to Sync Scheduling to open the list view.

  3. 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.

  4. Choose an option:

  5. 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:

    • Click the Plus icon (+) to add a scheduled resource.

    • Select the action, typically, Execute.

      You can schedule one or more actions or one or more resource types, and choose resource attributes for each.

    • Choose the resource type (resources that can be executed, for example, data/DataSync).

    • Choose the resource attribute to filter on when choosing the resource type, which is typically name.

    • At Resource, select the value of the resource attribute. For example, if the attribute is name, then the name of the resource.

    • At Perform Action, define whether to enable or disable the resource scheduled action.

    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
    • At Execution Date and Time, choose a date and time from the calendar date/time picker.
    • Choose the execution timezone.
    Multiple Executions

    Choose one or more of the following options:

    • Use Specific Executions
    • Use Calendar Executions
    • Use Timed Executions

    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.

  6. 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.

Model Details: data/Schedule

Title Description Details
Schedule Name * Name of this Schedule
  • Field Name: name
  • Type: String
Last Executed (UTC Time) Last time that this schedule executed
  • Field Name: last_executed
  • Type: String
Owner A business key that identifies the data/User who created the schedule.
  • Field Name: owner
  • Type: String
Schedule Type * Type of Schedule
  • Field Name: schedule_type
  • Type: String
  • Choices: ["Single Execution", "Multi Execution"]
Active Is the entire schedule active or not. Default: True
  • Field Name: active
  • Type: Boolean
  • Default: True
Skip execution on activation. Skip immediate execution on activation.
  • Field Name: skip_next
  • Type: Boolean
Scheduled resources List of resources that will be actioned
  • Field Name: scheduled_resources.[n]
  • Type: Array
  • Cardinality: [1..n]
Action * Action to perform
  • Field Name: scheduled_resources.[n].action
  • Type: String
  • Choices: ["Execute"]
Resource Type * Resource types to which this schedule will apply.
  • Field Name: scheduled_resources.[n].resource_type
  • Type: String
  • Choices: [""]
Resource Attribute * Resource attribute that will be used to filter/choose from.
  • Field Name: scheduled_resources.[n].resource_attribute
  • Type: String
  • Choices: [""]
Resource * DESCRIPTION
  • Field Name: scheduled_resources.[n].resource_instance
  • Type: String
  • Choices: [""]
Perform Action DESCRIPTION Default: True
  • Field Name: scheduled_resources.[n].perform_action
  • Type: Boolean
  • Default: True
Single Execution Single Execution
  • Field Name: single_execute
  • Type: Object
Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: single_execute.single_date
  • Type: String
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: single_execute.single_time
  • Type: String
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: single_execute.single_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Multiple Executions Multi Execution
  • Field Name: multi_execute
  • Type: Object
Use Specific Executions Use specific executions.
  • Field Name: multi_execute.use_specific
  • Type: Boolean
Use Calendar Executions Use calendar executions.
  • Field Name: multi_execute.use_calender
  • Type: Boolean
Use Timed Executions Use timed executions.
  • Field Name: multi_execute.use_timed
  • Type: Boolean
Specific Execution Dates Specific Execution Dates
  • Field Name: specific_execute.[n]
  • Type: Array
Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: multi_execute.specific_execute.[n].specific_date
  • Type: String
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: multi_execute.specific_execute.[n].specific_time
  • Type: String
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: multi_execute.specific_execute.[n].specific_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Calendar Executions Repeated Execution by Calendar
  • Field Name: calender_execute
  • Type: Object
Calendar Month Calendar Month
  • Field Name: multi_execute.calender_execute.calender_month
  • Type: Integer
  • Minimum: 1
  • Maximum: 12
Calendar Day Calendar Day
  • Field Name: multi_execute.calender_execute.calender_day
  • Type: Integer
  • Minimum: 1
  • Maximum: 31
Calendar Hour Calendar Hour
  • Field Name: multi_execute.calender_execute.calender_hour
  • Type: Integer
  • Maximum: 23
Calendar Minute Calendar Minute
  • Field Name: multi_execute.calender_execute.calender_minute
  • Type: Integer
  • Maximum: 59
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: multi_execute.calender_execute.calender_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Timed Executions Timed Execution
  • Field Name: timed_execute
  • Type: Object
First Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: multi_execute.timed_execute.first_date
  • Type: String
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
First Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: multi_execute.timed_execute.first_time
  • Type: String
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
First Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: multi_execute.timed_execute.first_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Repeat after (x) Days Repeat Days
  • Field Name: multi_execute.timed_execute.repeat_day
  • Type: Integer
Repeat after (x) Hours Repeat Hours
  • Field Name: multi_execute.timed_execute.repeat_hour
  • Type: Integer
Repeat after (x) Minutes Repeat Minutes
  • Field Name: multi_execute.timed_execute.repeat_minute
  • Type: Integer
Number of Repeats (0 = infinite) Number of Repeats
  • Field Name: multi_execute.timed_execute.repeat_number
  • Type: Integer