Using hours versions and hour codes

Hour codes specify the hours during which phone calls and email messages are allowed. There are two types of hour codes: Consumer (recipient) hours and Call Center hours, Consumer hours specify when consumers can be contacted and are evaluated relative to the consumer’s time zone. Typically multiple calling windows are defined for consumer hours. Call Center hours define when the client's call center is open, and are typically used for applications that contact consumers by voice and transfer them to a call center. Call Center hours are evaluated relative to a fixed time zone, typically the location of the call center.

For details about hour codes, see Understanding hours and windows.

An hours version is a collection of hour codes that can be managed as a single unit. Hours versions enable testing of new project versions that may involve changes to hours without affecting the production traffic. Client users can see hours versions but they cannot create or modify them. Typically, Nuance manages hours versions and there is no need to modify them.

The hours version control has the following panels:

  • Version, for setting and displaying the name of the hours version.
  • Hour Codes, for specifying Consumer and Call Center hour codes (calling windows and time zones).

Only Nuance internal users have the ability to create hours versions or apply them to project versions.

Adding an hour code to an hours version

  1. From the header bar, click CONTROLS.
  2. From the left navigation bar, click Hours Versions.
  3. Click an hours version to edit. Be sure to select the hours version for the project you're working on under the PROJECTS tab. (Look for the Hours Version under the project name.) For details, see Open a project for editing (MOD projects only).

  4. Expand the Hour Codes panel and click Add. The New Hour Code dialog is displayed.
  5. Enter a name and Id.
  6. Select a Type (Callcenter or Consumer) and then enter values for the fields. If you selected, Callcenter, you must specify a value for Call Center Timezone. For details, see the Understanding the settings used in the Hour Code dialog below.

  7. After you have entered the information, click SAVE.
  8. If you want to add additional hour codes, go back to Step 4.

Editing an hour code

  1. From the header bar, click CONTROLS.
  2. From the left navigation bar, click Hours Versions.
  3. Click the hours version containing the hour code you want to edit. This displays the hour codes defined for that version.
  4. In the Hour Codes panel, click the name of the hour code you want to edit. Depending on its type, the code may appear under Callcenter or Consumer. If the list of codes is long, type the name of the code into the search box to filter the list. Alternatively, you can browse the list using the Previous and Next buttons.

  5. Make your changes to the hour code, then save your changes.

Understanding the settings used in the Hour Code dialog

This table describes the settings that appear in the Hour Code dialog. The hour code types are Callcenter and Consumer and each type uses different criteria to determine the time zone for the purposes of dispatching. For call centers, the platform uses the time zone specified in the hours code. For consumers, the platform attempts to determine each consumer's time zone based on the project type and geographic information in the record.

Setting Description
Type
  • Callcenter: Call center time zone setting is used.
  • Consumer: Time zone is determined by project type and consumer geographic information (zip code, area code, etc.
Call Center Timezone

The time zone for the call center.

Setting hours for the default hours set

Each hour code has a default hours set, which specifies the permitted calling (or messaging) hours for each day of the week. It is important to specify the calling hours for the default hours set before you assign it to a campaign. If you don't, the hour code will block messaging 24 hours a day, every day of the week.

For details about hours sets, see Using hours sets.

  1. From the header bar, click CONTROLS.
  2. From the left navigation bar, click Hours Versions.
  3. Click an hours version to edit.
  4. Click the Hour Codes panel, then click the hour code you want to edit. The details will display. This image shows details for the Remind Consumer hour code:

  5. In the Hours Sets panel, click Default. This displays details about the default hours set.
  6. Click Edit to display the Edit Hours dialog. This is where you define the default messaging hours for each day of the week.

  7. Click and drag the mouse to select hours and days in the schedule when you want to permit messaging. After each selection click ACCEPT TIME SELECTION.

  8. When you have finished specifying hours, click SAVE HOURS.

Adding additional hours sets to Consumer hour codes

Occasionally you may need to set up windows that differ slightly based on dispatch record criteria, such as time zone, state code or delivery type (channel). For example, if you want SMS dispatches to use the same Consumer hour code as Voice dispatches, but have different windows, you could define an additional hours set for that.

Consumer hour codes can have any number of hours sets, in addition to the default hours set. Call Center hour codes only have the default hours set. The following procedure can be performed on Consumer hour codes only.

  1. From the header bar, click CONTROLS.
  2. From the left navigation bar, click Hours Versions.
  3. Click an hours version to edit.
  4. Click the Hour Codes panel, then click the hour code you want. The details will display. This image shows details for the Consumer 2 hour code:

  5. In the Hours panel, click Add Hours Set. The New Hours dialog is displayed.

  6. Enter values for each field in the dialog. For details about these fields, see Understanding the settings used in the Hours Set dialog.

  7. Click and drag the mouse to select hours and days in the schedule when you want to permit messaging. After each selection click ACCEPT TIME SELECTION.

  8. When you have finished specifying hours, click SAVE HOURS.

Understanding the settings used in the Hours Set dialog

This table describes the settings that appear in the Hours Set dialog for a Consumer hour code. The Name field is required. In addition, at least one other field must be specified. The hours set will be applied to records having fields that match all the values you specify in the dialog.

Setting Description
Name A display name for the hours set. (Required.)
Country The country where the consumer is located.
State The state or province where the consumer is located.
Time Zone The time zone of the consumer.
Service Type The service type of the consumer. Choose one of Any, None, Unavailable, Land, Cell, Toll Free, Test, Pager, or Special.
Delivery Type The delivery type of the consumer. Choose one of Any, Email, SMS, or Voice.

Setting exceptions for an hour code

Hour code exceptions give you the ability to override Consumer and Call Center hours for a specified date. This override feature is similar to holiday hours, but unlike holiday hours, hour code exceptions are not tied to a specific calendar and campaign. Use hour code exceptions to specify overrides to an hour code for a specific day and year. An hour code exception defines only one window per day and when in effect, it will limit dispatching to that one window. It takes precedence over any holiday hour code defined for that day. All of the other standard rules for computing the span of messaging windows still apply, and the exception is included as part of the computation. The exception is specific to the specified date and year and does not recur in subsequent years.

This is an advanced feature and shouldn't be needed by most clients, for whom holiday hours should suffice.

  1. From the header bar, click CONTROLS.
  2. From the left navigation bar, click Hours Versions.
  3. Click the hours version containing the hour code you want to edit.
  4. Click the Hour Codes panel, then click the hour code you want to edit. The details will display. This example shows details for the Call Center HTC 1 hour code. There are panels for Hour Codes, Hours, and Exceptions:

  5. In the Exceptions panel, click Add Exception. This displays the Add Exception dialog:

  6. For Date, select the year and date that exception should be in effect. An exception is in effect for the specified date in the specified year. It does not repeat in subsequent years.
  7. Enter the Start Time and End Time that the exception will be in effect.
  8. Click SAVE EXCEPTION.