[Index]

Model: relation/HcsTimePeriodREL

Time Periods

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

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.

Configure Time Schedules

This procedure assigns a time period to a time schedule.

Prerequisites:

Note

VOSS Automate 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.

Perform these steps:

  1. Log in to the Admin Portal as a Provider, Reseller, or Customer administrator.

  2. Set the hierarchy path to the node where you want to create the new time schedule.

  3. Choose an appropriate option, based on your login:

  4. Choose an appropriate action:

  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 the Plus icon (+) 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

    • If multiple time periods are associated with a schedule where the time periods overlap, time periods with Day of Year settings take precedence over time periods with Day of Week settings. Day of Year is applicable when Year Start value is set and the End value is left blank.

      Example: If a Time Period configured for January 1 is configured as No Office Hours and another time period is configured for the same day of the week (for example, Sunday to Saturday) as 08:00 to 17:00, the time period for January 1 is used. In this example, No Office Hours takes precedence.

    • Time interval settings take precedence over No Office Hour settings for the same day of the year or day of the week.

      Example: One time period specifies for Saturday as No Office Hours. Another time period specifies Saturday hours of 08:00 to 12:00. In this example, the resulting time interval specifies 08:00 to 12:00 for Saturday.

    • If multiple time periods are associated with a schedule where the time periods overlap, time periods with Day of Week settings take precedence over time periods with Range of Days settings. Range of Days applies to when Year Start and End values are set, even if they are configured for the same day.

      Example: If a Time Period configured for Day of Week (for example, Sunday to Saturday) is configured as No Office Hours and another time period is configured for January 1 until December 31 as 08:00 to 17:00, the time period for Day of Week is used. In this example, No Office Hours takes precedence.

  11. To save the new time schedule, click Save, or to update time schedule, click Update.

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

Next Steps

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 device/cucm/TimePeriod element.

Model Details: relation/HcsTimePeriodREL

Title Description Details
Name * Enter a name in the Time Period Name field. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each time period name is unique to the plan. Note    Use concise and descriptive names for your time periods. The hours_or_days format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a time period. For example, office_M_to_F identifies a time period for the business hours of an office from Monday to Friday. Cisco Unified Communications Manager provides the All the time time period. This special, system time period includes all hours, is published to end users, and cannot be deleted; this time period can be copied.
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
Day of Week End Default: None
  • Field Name: endDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Day of Week Start Default: None
  • Field Name: startDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Description Enter a description for this time period.
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Is Published TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published.
  • Field Name: isPublished
  • Type: Boolean
  • Cardinality: [0..1]
Month of Year End Default: None
  • Field Name: monthOfYearEnd
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["None", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
Month Of Year Default: None
  • Field Name: monthOfYear
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["None", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
Time Of Day Start From the drop-down list box, choose the time when this time period starts. The available listed start times comprise 15-minute intervals throughout a 24-hour day. The default value is No Office Hours. Note    To start a time period at midnight, choose the 00:00 value. Default: No Office Hours
  • Field Name: startTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Day of Month End
  • Field Name: dayOfMonthEnd
  • Type: Integer
  • Cardinality: [0..1]
Tod Owner Id Name
  • Field Name: todOwnerIdName
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Time of Day End From the drop-down list box, choose the time when this time period ends. The available listed end times comprise 15-minute intervals throughout a 24-hour day. The default value is No Office Hours. Note    You must choose an End Time that is later than the Start Time that you chose. Note    To end a time period at midnight, choose the 24:00 value. Default: No Office Hours
  • Field Name: endTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Day of Month
  • Field Name: dayOfMonth
  • Type: Integer
  • Cardinality: [0..1]
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024