Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Time Periods are configured in Setup / Usage Rating / Rate Types / Time Periods

Overview

Time periods allow you to configure rates that are applicable at certain times (peak hours, evenings, weekends, etc.). Once setup, time periods are selectable when configuring rate groups. Rates in a rate group configured with a time period will only be applicable during the specified time period. Outside of the period rates from another rate group in the rate plan will be used. If the appropriate rates cannot be found in another rate group when usage occurs outside the time period then a rating exception will occur. When using time periods it is important to configure rate plans with multiple groups so that rating exceptions are not generated for usage that occurs outside of the time period.

Prerequisites

Time periods can be setup in the system immediately, there are no prerequisite configuration steps.

The Time Periods Panel

The Time Periods panel on the left of this screen allows you to select time periods so that you can view and edit their details on the Edit Time Periods Panel to the right. Actions are also available which are shown as icons above the Filter text box. The available actions are described below.

Actions

Icon

Description

Image Modified

Deletes the selected time period

Image Modified

Adds a new time period

Time Periods List

The Time Period listing on the left of the screen shows currently configured time periods.

When you select a time period in the list additional details will be displayed in the Edit Time Period Panel to the right. These details are explained below.

The Edit Time Period Panel

The information in this panel reflects the currently selected time period. From here you can change time period configuration details (fields will display a red left border if a value is required and purple text if the field is read-only and cannot be modifiednote: fields with a magenta left border are required).

Details tab

This tab shows the time period details configured for the selected time period. E.g. a time period covering an entire weekend would have two time period details listed, 'Saturday - Start 012:00 AM End 11:59 PM' and 'Sunday - Start 012:00 AM End 11:59 PM'.

From here you can edit, clone and delete the time period details configured on the time period.

References tab

This tab will list all rate groups that are configured to use the selected time period.

...

Adding Time Periods

  1. Under the Time Periods heading on the left click the (blue star) action button

  2. The new time period configuration will be displayed on the right under the Add Time Period heading

  3. Configure the time period

    • Name: enter a descriptive reference that explains the period (e.g. 'Evenings')

    • Details: each detail added covers part or all of a single day (e.g. Monday 5:00pm - 9:00pm). You can use the clone button (blue star) on an existing detail if you need to add an additional day that covers the same time range as the detail you are cloning. To create a new time period detail with an adjustable time frame click the +New button and a modal will appear where you can specify the detail configuration:

      • Day Of Week: the day on which alternate rates (rates in the rate group configured to use the time period) will apply

      • From: the time that rates in the rate group will applicable (start time)

      • To: the time that rates in the rate group will no longer be applicable (stop time)

  4. Once the time period details are populated click the Add or Update button

  5. Continue to add details until the time period configuration covers all the days and times you require

  6. Click Save when you are finished adding details

...

Editing Time Periods

  1. Locate the period on the left under the Time Periods heading or use the Filter text box to narrow down the list

  2. Click on the time period to select the period in the list

  3. Under the Time Period heading the time period Name and Details will be displayed. Edit the Name if desired

  4. Under the Details tab you can edit an existing detail by clicking the (blue star) button next to the detail

  5. On the modal window that appears you can modify the Day Of Week that the alternate rate will apply as well as the From and To hours when the rate will apply

  6. click Update to commit your changes

...

Deleting Time Periods

Info

A Time Period cannot be deleted if it is in use (configured on a usage rate group). If you need to delete a Time Period you can load the References tab to see what Rate Group(s) the Time Period is configured on and then modify those Rate Groups to use another Time Period/no Time Period.

  1. Select the entry on the left under the Time Periods heading or use the Filter text box to narrow down the list

  2. On the left under the Time Periods heading click the (blue star) action button

  3. On the confirmation dialog click Yes to confirm that the selected period should be deleted