[Index]

Model: relation/HcsTimeScheduleREL

Time Periods

A time schedule includes a group of time periods. Time schedules are assigned to partitions to set up time-of-day call routing. Time schedules determine the partitions where calling devices search when they are attempting to complete a call during a particular time of day. Multiple time schedules can use a single time period.

Once you have configured a time period in Configure Time Periods, perform this procedure to assign the time period to a time schedule.

Note

VOSS-4-UC provides one 'All the time' schedule. The 'All the time' schedule is a special, default time schedule that includes all days and hours, and cannot be deleted.

Procedure

  1. Log in as provider, reseller, or customer administrator.

  2. Make sure that the hierarchy path is set to the node where you want to create the new time schedule.

  3. Perform one of the following:

  4. Perform one of the following:

  5. If the Network Device List popup window appears, select the NDL for the time schedule from the drop-down menu. The window appears when you are on a nonsite hierarchy node. If you are at a site hierarchy node, the NDL associated with the site is automatically used.

    Note:

    The Network Device List drop-down only appears when a time schedule is added; it does not appear when you edit a time schedule.

  6. Enter a unique name for the new time schedule in the Name field, or modify the existing Name if desired. This field is mandatory. The name can comprise up to 50 alphanumeric characters. The name of the time schedule can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_).

  7. (Optional) Enter a description for the time schedule in the Description field.

  8. Click + to open the Time Periods form.

  9. From the Time Period drop-down box, choose a time period for the time schedule.

  10. Repeat Steps 8 and 9 to add another time period to the time schedule.

    Note:

  11. To save the new time schedule, click Save. To save the updated time schedule, click Update.

  12. Repeat Steps 3 to 11 to configure another time schedule.

What to Do Next

You cannot delete time schedules that partitions are using. Before deleting a time schedule that is currently in use, perform either or both of the following tasks:

Warning

Before you delete a time schedule, check carefully to ensure that you are deleting the correct time schedule. You cannot retrieve deleted time schedules. If you accidentally delete a time schedule, you must rebuild it.

This relation wraps the default CUCM Time Schedule element.

Model Details

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
Is Published TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published.
  • Field Name: isPublished
  • Type: Boolean
  • Cardinality: [0..1]
Time Schedule Category Default: Regular
  • Field Name: timeScheduleCategory
  • Type: String
  • Cardinality: [0..1]
  • Default: Regular
  • Choices: ["Regular", "Holiday or Vacation"]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Member
  • Field Name: member.[n]
  • Type: Array
  • Cardinality: [1..n]
Time Period Name *
  • Field Name: members.member.[n].timePeriodName
  • Type: String
  • Cardinality: [1..1]
Tod Owner Id Name
  • Field Name: todOwnerIdName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Description
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024
API reference for relation/HcsTimeScheduleREL