[Index]

Model: relation/HcsTimePeriodREL

Time Periods

Full HTML Help

Overview

A time period specifies a time range that includes a start time and end time. Time periods also specify a repetition interval either as days of the week or a specified date on the yearly calendar. You define time periods and then associate the time periods with time schedules. A particular time period can be associated with multiple time schedules.

Note

VOSS Automate provides one All the time time period, which is a special, default time period that includes all days and hours, and cannot be deleted.

Configure Time Periods

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

  2. Set the hierarchy path to the node where you wish to configure the new time period.

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

  4. Choose an appropriate option:

  5. To add a new time period, if the Network Device List popup window appears, choose the NDL for the time period 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 menu only appears when a time period is added; it does not appear when you edit a time period.

  6. When adding or editing a time period, add or update a unique name for the time period in the Name field. This field is mandatory. Enter a name in the Time Period Name field. The name can comprise up to 50 alphanumeric characters. It can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_).

    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.

  7. Complete the other fields as appropriate.

Option Description
Description Enter a description for the time period.
Time of Day Start

From the drop-down list, choose the time when this time period starts. The available listed start times comprise 15-minute intervals throughout a 24-hour day.

Default: No Office Hours

Note:

To start a time period at midnight, choose the 00:00 value.
Time of Day End

From the drop-down list, choose the time when this time period ends. The available listed end times comprise 15-minute intervals throughout a 24-hour day.

Default: No Office Hours

Note:

To end a time period at midnight, choose the 24:00 value.

  1. Choose a repetition period, and complete the required information:

    Note

    If choosing to repeat the time period by the week, the Repeat Every Year fields are read-only. If choosing to repeat the time period by the year, the Repeat Every Week fields are read-only.

    Repeat Every Week - For time periods defined by the week

    1. From the Start Day drop-down menu, choose a day of the week on which this time period starts.
    2. From the End Day drop-down menu, choose a day of the week on which this time period ends.

    Repeat Every Year - For time periods defined by the year

    1. From the Start Month drop-down menu, choose a month of the year on which this time period starts.
    2. Enter a number from 1 to 31 in the Start Date field to define the day of the month on which this time period starts.
    3. From the End Month drop-down menu, choose a month of the year on which this time period ends.
    4. Enter a number from 1 to 31 in the End Date field to define the day of the month on which this time period ends.

  2. Click Save to save the new or updated time period.

    Next steps: Associate time periods with time schedules. See "Configure Time Schedules".

Note

You can't delete time periods if they're used by any time schedules. Before deleting a time period that is currently in use, perform either or both of these tasks as appropriate:

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: /api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24vOnbp81nCv1gUWYy%24LS%2BHotgxkWaSn07S7EksN7WvyGXNBWmLEqRqfghgJUZKb1ysREvhk0gW46e3Xg%2BHazYlFOhIMN6pg1t7neOU8OnQnJq6CkRphPrrwcm5J1F%2ByrWN6U009PE0GZ1XLtW5REqWf/0jWyoJ1noqkxNoFoypjtnMgtUa2cHz1AWs2BGGDI%2BVK2g/CFjm%2BcGnmI/6BIyRcLOnv1%2B2HeJwXKzCcar7j%2BkmIz28YGsdmEVwY1hDx4XndBxU/h3h5feFc/kAyGCNplJtvlYN9ANurGw5X91btfZ5Bw8XB82QNIpQnyHVlZ6PAPhoBXuexDMZ9O0XXLSuOQT/JpGi0B6ivQ/rTMyFDB/EI07znk0t7Ek/iKZ9uwc68aLbdAXLwEAXW0W7mg%3D%3D%24%3D%3D
  • Target attr: userid
  • Target Model Type: device/cucm/User
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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