[Index]

Model: relation/HcsCUCxnScheduleREL

CUC Schedules

Schedules

Configuring a CUC device on Automate creates a scheduled data sync to import model data from the device into Automate.

The scheduled data sync ensures that the VOSS Automate cache maintains the most current view of the configured device.

Note

If Holiday Schedules were added to CUC directly, update the default scheduled data sync instance to include the Model Type List called CUCXN Schedules in order to ensure that these holiday schedules are synced into VOSS Automate.

Any changes to the configuration occurring on the device, including additions, deletions, or modifications, reflect in VOSS Automate after the next data sync.

Note

The recurring sync (disabled by default) is scheduled to occur every 14 days. You can enable the sync and modify the schedule (via Apps Management > CUC > Schedules).

When determining the appropriate schedule setting, the frequency of the sync must be weighed against the additional processing and network activity associated with the data sync. You can manually run the data sync at any time, via Apps Management > Advanced > Perform Publisher Actions, or from Administration Tools > Data Sync.

Important

Allow the initial data sync to complete before doing more configuration on Automate that requires information from CUC.

The performance of a data sync can be improved by controlling the types of data that are synced.

Related Topics

LDAP User Sync in the Core Feature Guide.

Model Details: relation/HcsCUCxnScheduleREL

Title Description Details
Name * The name of the schedule.
  • Field Name: name
  • Type: String
  • Target: /api/data/Schedule/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24XvegZTzRzmcKT6bt%24hyIcG7r3dm51fQYrU4b/VqBJBr3YgBLa2As891yOTPCv5gJq2IRxt7qxzrMm9ugtV01XrMUQ1X0cdixVjT2bSAohcBcDsPm9LywitnmzmI3ZESqTaX%2Bqmq1hrxOgniCbOU/KpmSTlXFybQLldbP2Sm7DvYRTjTPbmOImMO%2BfpxvXyMvFYoRfTlOeM6ncO/TXWzQXjr9T%2BJv7tRa5lPFDqyfim791Dm40Q3mHupYUBXBuQMIr1r%2BDlFwBPm%2Bp6EqqkeARq/l58kklNwZh/TQBVKhzTnCSqT578BUK2ynR5dhVUj2N43UKVlBmfOs8LXeBSQTwm%2BC7K/22tVfxoeK8wZQMlf8jkAiWTIUf3foxO7UAAQKxL3tOgkSAYmanHZsPI203CyPppvoVf1RGTWywJnFkB00VwfuwAGbslJ3DfzNMGGJ44l98lbt8sccuilRk6jtgHl6GwNLqd1bb2kxcthpdCazIhN6vjgWgIgqJxfDikp57etf9S/nI2/aGPQ%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Schedule
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Schedule
  • Field Name: schedule
  • Type: Object
Schedule Name * Name of this Schedule
  • Field Name: schedule.name
  • Type: String
Last Executed (UTC Time) Last time that this schedule executed
  • Field Name: schedule.last_executed
  • Type: String
Owner A business key that identifies the data/User who created the schedule.
  • Field Name: schedule.owner
  • Type: String
Schedule Type * Type of Schedule
  • Field Name: schedule.schedule_type
  • Type: String
  • Choices: ["Single Execution", "Multi Execution"]
Active Is the entire schedule active or not. Default: True
  • Field Name: schedule.active
  • Type: Boolean
  • Default: True
Skip execution on activation. Skip immediate execution on activation.
  • Field Name: schedule.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: schedule.scheduled_resources.[n].action
  • Type: String
  • Choices: ["Execute"]
Resource Type * Resource types to which this schedule will apply.
  • Field Name: schedule.scheduled_resources.[n].resource_type
  • Type: String
  • Choices: [""]
Resource Attribute * Resource attribute that will be used to filter/choose from.
  • Field Name: schedule.scheduled_resources.[n].resource_attribute
  • Type: String
  • Choices: [""]
Resource * DESCRIPTION
  • Field Name: schedule.scheduled_resources.[n].resource_instance
  • Type: String
  • Choices: [""]
Perform Action DESCRIPTION Default: True
  • Field Name: schedule.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: schedule.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: schedule.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: schedule.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: schedule.multi_execute.use_specific
  • Type: Boolean
Use Calendar Executions Use calendar executions.
  • Field Name: schedule.multi_execute.use_calender
  • Type: Boolean
Use Timed Executions Use timed executions.
  • Field Name: schedule.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: schedule.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: schedule.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: schedule.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: schedule.multi_execute.calender_execute.calender_month
  • Type: Integer
  • Minimum: 1
  • Maximum: 12
Calendar Day Calendar Day
  • Field Name: schedule.multi_execute.calender_execute.calender_day
  • Type: Integer
  • Minimum: 1
  • Maximum: 31
Calendar Hour Calendar Hour
  • Field Name: schedule.multi_execute.calender_execute.calender_hour
  • Type: Integer
  • Maximum: 23
Calendar Minute Calendar Minute
  • Field Name: schedule.multi_execute.calender_execute.calender_minute
  • Type: Integer
  • Maximum: 59
Execution Timezone (Local timezone) Timezone for Execution Default: 0
  • Field Name: schedule.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: schedule.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: schedule.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: schedule.multi_execute.timed_execute.first_timezone
  • Type: String
  • Default: 0
  • Pattern: ^[-+]?\d+$
Repeat after (x) Days Repeat Days
  • Field Name: schedule.multi_execute.timed_execute.repeat_day
  • Type: Integer
Repeat after (x) Hours Repeat Hours
  • Field Name: schedule.multi_execute.timed_execute.repeat_hour
  • Type: Integer
Repeat after (x) Minutes Repeat Minutes
  • Field Name: schedule.multi_execute.timed_execute.repeat_minute
  • Type: Integer
Number of Repeats (0 = infinite) Number of Repeats
  • Field Name: schedule.multi_execute.timed_execute.repeat_number
  • Type: Integer