Cisco Unity System Administration Guide (With IBM Lotus Domino), Release 4.0(5)
Directory Handler Settings

Table Of Contents

Directory Handler Settings

Overview: Directory Handler Settings

Creating and Modifying Directory Handlers

Creating Directory Handlers

Synchronizing Directory Handlers with the Subscriber Database

Modifying and Deleting Directory Handlers

Directory Handler Profile Settings

Directory Handler Search Options Settings

Directory Handler Match List Options Settings

Directory Handler Caller Input Settings


Directory Handler Settings


Overview: Directory Handler Settings

Directory handlers provide directory assistance in Cisco Unity that callers can use to reach subscribers. When a caller searches on a subscriber name or part of a name, a directory handler looks up the extension and routes the call to the appropriate subscriber. Note that subscribers cannot be accessed by using directory handlers unless they have recorded names.

Each directory handler contains settings that specify how it searches for names, what it does when it finds one or more matches, and what it does when it detects no caller input.

The multiple directory handler feature provides quick, effective, and secure directory searches for systems with hundreds or thousands of subscribers. Multiple directory handlers are also used for call routing in headquarters and branch office deployments where Cisco Unity provides centralized call processing. Administrators can create as many directory handlers as they need to manage caller searches for subscribers.

See the following sections in this chapter for more information:

Creating and Modifying Directory Handlers

Directory Handler Profile Settings

Directory Handler Search Options Settings

Directory Handler Match List Options Settings

Directory Handler Caller Input Settings

Creating and Modifying Directory Handlers

See the following sections:

Creating Directory Handlers

Synchronizing Directory Handlers with the Subscriber Database

Modifying and Deleting Directory Handlers

Creating Directory Handlers

You can use the default pre-defined directory handler or any other existing directory handler as a template to create additional directory handlers. Create as many directory handlers as needed to route calls to subscribers by using available filters such as location, class of service, and public distribution list membership.

You can also modify or delete directory handlers; however, note that the default directory handler can be modified, but not deleted.

Subscribers can be listed in more than one directory handler.

Because directory handlers do not have greetings, use call handlers or one-key dialing to route callers to a directory handler, and use the call handler greeting to explain caller options for each directory handler.

To Create a Directory Handler


Step 1 In the Cisco Unity Administrator, go to any Call Management > Directory Handlers > page.

Step 2 Click the Add icon.

Step 3 In the Add a Directory Handler dialog box, enter information as applicable in the Name field.

Step 4 Select New Handler or Based on Existing Handler. If you select Based on Existing Handler, select the applicable directory handler in the Based On field.

If you base a new directory handler on an existing one, all of the settings are copied except for the extension and recorded name. If you select New Handler, the new directory handler is based on the default directory handler.

Step 5 Click the Add button.

Step 6 Specify the settings for your new directory handler, as applicable, and then click the Save icon.

Note that there may be a delay in synchronizing and accessing new directory handlers. See the "Synchronizing Directory Handlers with the Subscriber Database" section for more information.


Synchronizing Directory Handlers with the Subscriber Database

Depending on the complexity of the Cisco Unity system configuration, synchronization of a new directory handler can take several minutes to several hours to complete. Factors that can affect synchronization speed include:

System configuration, including multi-domain environments, organization unit structure, synchronization timer setting, and public distribution list complexity

Cisco Unity Digital Networking configuration

Number of subscribers and public distribution lists

When a directory handler is scoped by a distribution list, the membership is synchronized from the IBM Lotus Notes Directory into the Cisco Unity SQL database. Changing the distribution list by which the directory handler is scoped requires a synchronization. This synchronization takes place when the Cisco Unity directory services (AvDSAD and AvDSGlobalCatalog) poll the directory for any changes to be applied to the SQL database, which usually occurs within 15 to 20 minutes after the directory handler scope change is made in the Cisco Unity Administrator.

If an outside caller calls into Cisco Unity and navigates to a recently created or modified directory handler on which synchronization has not yet completed, the Cisco Unity conversation may not present the full list of the directory members and/or may fail to find some directory members. This can also occur if the system administrator calls into Cisco Unity to verify directory handler additions or changes immediately after the changes are made in the Cisco Unity Administrator.

To initiate an immediate synchronization, do the following procedure.

To Manually Synchronize the Cisco Unity Database and Verify That Subscribers Can Be Located in the Directory Handler


Step 1 In the Cisco Unity Administrator, go to the System > Configuration > Settings page.

Step 2 In the Replicate Cisco Unity Directory Objects section, click Changed Objects.

The Settings page is refreshed and the database changes will be synchronized in the background.

Step 3 Wait a few minutes, then call in to Cisco Unity and confirm that the subscriber(s) can be located in the directory handler.

Step 4 If the subscriber(s) still cannot be located, confirm that they have recorded names. Subscribers cannot be accessed by using directory handlers unless they have recorded names.


Modifying and Deleting Directory Handlers

To Modify a Directory Handler


Step 1 In the Cisco Unity Administrator, go to any Call Management > Directory Handler page.

Step 2 Click the Find icon.

Step 3 Double-click the directory handler that you want to modify.

Step 4 Change settings as applicable, and then click the Save icon.

Note that there may be a delay in synchronizing and accessing new directory handlers. See the "Synchronizing Directory Handlers with the Subscriber Database" section for more information.


To Delete a Directory Handler


Step 1 In the Cisco Unity Administrator, go to any Call Management > Directory Handler page.

Step 2 Click the Find icon.

Step 3 Double-click the directory handler that you want to delete.

Step 4 Click the Delete icon.

Step 5 On the Cisco Unity server desktop, double-click the Cisco Unity Tools Depot icon.

Step 6 In the left pane, under Diagnostic Tools, double-click DbWalker.

Step 7 In the Automatic Repairs tab, check the following check boxes, as applicable, to initiate repairs:

Remove Orphaned Call Handlers

Delete Empty Private Distribution Lists

Set Broken User Keys to Ignore

Remove References to Missing Greeting or Voice Name Wav Files


Tip Alternatively, you can run the Cisco Unity Directory Walker (DbWalker) utility without any check boxes checked to determine whether there are links to the deleted directory handler from other objects, such as call handlers, as well as to identify other database problems. Based on what you learn from the DbWalker output, you can then run the utility a second time, with your choice of automatic repairs selected.


Step 8 In the Logging pane, enter the location for the output log file.

Step 9 Click Walk Database.

Step 10 Click OK, then click OK again to view the output log to see the errors that were identified and what automatic repairs, if any, were made.

Step 11 Click Exit.


Directory Handler Profile Settings

The profile settings specify who owns a directory handler, the extension (if any) that callers dial to reach the directory handler, and the language in which callers hear system prompts.

Use the following table to learn more about profile settings.

Table 19-1 Call Management > Directory Handler > Profile Page 

Field
Considerations
Name

Display only. This setting shows the name of the selected directory handler.

Created

Display only. This setting shows the date and time that the directory handler was created.

Owner

This setting shows the directory handler owner. The owner can be any subscriber who has the authority to request changes to the directory handler. To change the owner, click Change.

Default: Example Administrator.

Owner Type

A directory handler can be owned only by a subscriber.

Recorded Voice

This setting shows the recorded name of the directory handler.

To record the directory handler name, use the Media Master control bar. Use the Paste From File option on the Options menu of the Media Master control bar to use a prerecorded WAV file as the recording. Note that the Media Master is not available across a firewall that blocks DCOM communications.

Extension

Enter the extension, if any, that callers dial to reach the directory handler. When the directory handler is reached only from one-key caller input, do not enter an extension here.

Default: 555 or blank, depending on how the directory handler was created.

Language

Select the language in which Cisco Unity plays the handler system prompts. If you choose Inherited, Cisco Unity determines the language to use for system prompts on a per-call basis, depending on the handler or routing rule that processed the call. If the language is set to Inherited for every rule and handler that processes a call, then the system prompts are played in the default phone language.

The default phone language and the list of languages shown here are set on the System > Configuration > Phone Languages page.

Default: Inherited.

Play All Names

Check the check box to play the names of subscribers in the directory for caller selection, rather than requiring the caller to search by spelled name.

Cisco Unity plays the names of all subscribers in the directory when either of the following conditions are true:

One to five subscriber names are listed in the directory.

The caller chooses to play all names listed in the directory. When there are more than five (but fewer than 51) subscriber names listed in the directory, the Cisco Unity phone conversation allows callers the choice of either searching for a subscriber in the directory by spelled name or having Cisco Unity play all names listed in the directory.

When a directory handler includes more than 50 subscriber names, Cisco Unity requires the caller to search for a subscriber by spelled name.

When there are no subscriber names listed in the directory, Cisco Unity sends the caller to the call handler specified on the Caller Input page.

Default: Check box not checked.


Directory Handler Search Options Settings

The search options settings specify whether a directory handler searches for subscribers by using first name first, or last name first. Additionally, these settings allow you to restrict directory handler searches to the local Cisco Unity server, a public distribution list, a class of service, or if your organization uses Digital Networking to network Cisco Unity servers within a dialing domain, to expand searches to Cisco Unity servers at other locations. For more information on dialing domains, refer to the "Dialing Domains" section in the "Digital Networking" chapter of the Networking in Cisco Unity Guide. (The guide is available at http://www.cisco.com/en/US/products/sw/voicesw/ps2237/products_feature_guides_list.html.)

Even if you have Digital Networking set up, you may want to consider limiting directory handler searches to the local server if either of the following conditions is true:

If there are a large number of subscribers with the same name in your organization. In this situation, if you enable directory handler searches for multiple locations, the list of matching names presented to callers may be too long to be useful.

If it is important to retain the individual call transfer settings for subscribers associated with other networked locations. If you enable directory handler searches for multiple locations, any calls transferred from a directory handler to subscribers not associated with the local server are automatically handled by the phone system—rather than by Cisco Unity—even if these subscribers are set up for supervised transfers on their own local Cisco Unity servers. As a result, the call screening, call holding, and announce features would not be available on these calls. See the "Subscriber Template Call Transfer Settings" section on page 10-11 for more information on call transfer types.

Use the following table to learn more about search option settings.

Table 19-2 Call Management > Directory Handler > Search Options Page 

Field
Considerations
Search In

Select the scope for directory handler searches:

Local Cisco Unity Server Only—Restricts directory handler searches to subscribers associated with the Cisco Unity server that the caller dialed.

Location—Restricts directory handler searches to subscribers associated with the primary and local delivery locations for the selected Cisco Unity server.

Class of Service—Restricts directory handler searches to subscribers associated with the selected Class of Service on the local Cisco Unity server.

Dialing Domain—Expands directory handler searches to include subscribers associated with other Cisco Unity servers within a dialing domain. Do not use this option if your organization has large numbers of subscribers with the same name at multiple locations or if it is important to retain call transfer settings for subscribers who are not associated with the local Cisco Unity server. Instead, choose Local Unity Server Only, a Public Distribution List, or a Class of Service.

Public Distribution List—Restricts directory handler searches to subscribers associated with the selected Public Distribution List. Note that all Public Distribution Lists are presented, including lists that may contain Cisco Unity subscribers who do not have recorded names (and thus will not be presented to callers), and/or lists that may contain members who are not Cisco Unity subscribers.

Provide information in the call handler greeting that routes callers to this directory handler, explaining how callers can contact other Cisco Unity locations.

Default: Local Cisco Unity Server Only.

Search By

Select the method that callers use to spell a subscriber name:

First Name, Last Name—For example, callers press 535 (KEL) to reach Kelly Bader.

Last Name, First Name—For example, callers press 223 (BAD) to reach Kelly Bader.

Include instructions that reflect the Search By selection in the call handler greeting that routes callers to this directory handler.

Default: Last Name, First Name.


Directory Handler Match List Options Settings

The match list options settings specify whether, on a unique match, Cisco Unity routes the caller to the extension automatically, or first asks the caller to confirm the match. This page also specifies how Cisco Unity presents directory matches to callers—either by stating the extensions ("for Pat Amos, press 123; for Gerry Anderson, press 234...") or by offering a menu of choices ("for Pat Amos, press 1; for Gerry Anderson, press 2...").

Use the following table to learn more about match list options settings.

Table 19-3 Call Management > Directory Handler > Match List Options Page 

Field
Considerations
On a Unique Match

Select one of the following settings:

Route Automatically—Cisco Unity routes the call to the extension assigned to the subscriber without prompting the caller to verify the match.

Request Caller Input First—Cisco Unity prompts the caller to verify the match.

Default: Request Caller Input First.

Announce Matched Names Using

Select one of the following settings:

Extension Format—Cisco Unity announces the names and extensions of matching subscribers. For example, "For Pat Amos, press 123. For Gerry Anderson, press 104." Callers enter the extension number to choose a subscriber.

The Play All Names option on the Directory Handler > Profile Page is not supported for use with Extension Format. If the Play All Names check box is checked when Extension Format is selected and when Cisco Unity plays all names listed in the directory (rather than the caller searching for a subscriber by spelled name), Cisco Unity announces the names of matching subscribers, but not their extensions. For example, "Pat Amos. To repeat, press 1. To choose the name, press 2. To go to the next name, press #."

Menu Format—Cisco Unity provides a menu of subscribers. For example, "For Pat Amos, press 1. For Gerry Anderson, press 2." Callers enter the menu number to choose a subscriber.

When Menu Format is selected in combination with the following fields, Cisco Unity provides three different menu options:

When the Play All Names check box is checked on the Directory Handler > Profile page, and when Cisco Unity plays all names listed in the directory (rather than the caller searching for a subscriber by spelled name), Cisco Unity plays the names of subscribers in the directory for caller selection, rather than requiring the caller to search by spelled name. For example, "Pat Amos. To repeat, press 1. To choose the name, press 2. To go to the next name, press #."

When the Announce Extension with Each Name check box is checked, and when Cisco Unity plays all names listed in the directory (rather than the caller searching for a subscriber by spelled name), Cisco Unity provides a menu of subscribers that includes subscriber extensions. For example, "For Pat Amos at extension 123, press 1. For Gerry Anderson at extension 104, press 2."

When both the Announce Extension with Each Name and the Play All Names check boxes are checked, Cisco Unity provides a menu of subscribers that includes subscriber extensions. For example, "Pat Amos at extension 123. To repeat, press 1. To choose the name, press 2. To go to the next name, press #."

Default: Menu Format.

Announce Extension with Each Name

Cisco Unity provides a menu of subscribers that includes subscriber extensions. Callers enter the menu number to select a subscriber. For example, "For Pat Amos at extension 123, press 1. For Gerry Anderson at extension 104, press 2." Callers might take note of subscriber extensions to skip directory assistance the next time they call.

This functionality is supported only when Menu Format is selected in the Announce Matched Names Using field.

Default: Check box checked.


Directory Handler Caller Input Settings

The caller input settings specify the number of seconds a directory handler waits for caller input, the number of times the caller is prompted to spell a name, and the action that Cisco Unity takes if the caller exits a directory handler.

Use the following table to learn more about caller input settings.

Table 19-4 Call Management > Directory Handler > Caller Input Page 

Field
Considerations
Timeout if No Input in Seconds

Enter the number of seconds that Cisco Unity waits for caller input. When the caller does not press any key, Cisco Unity asks for confirmation that the caller is still there. If there is no response, Cisco Unity performs the action selected in the If Caller Exits Send To field.

Default: Five seconds.

Timeout After Last Input in Seconds

Enter the number of seconds that Cisco Unity waits after caller input before performing the action indicated by the input.

Default: Four seconds.

Times to Repeat Name Entry Prompt

Enter the number of times to reprompt the caller for input. When the caller does not press any key after being reprompted, Cisco Unity asks for confirmation that the caller is still there. If there is no response, Cisco Unity performs the action selected in the If Caller Exits Send To field.

Default: One time.

If Caller Exits Send To

Select the destination to which calls are sent when the caller exits the directory handler by pressing *:

Call Handler—Sends the call to another call handler that you specify.

Directory Handler—Sends the call to another directory handler that you specify.

Greetings Administrator—Sends the call to a conversation for changing call handler greetings over the phone.

Hang Up—Disconnects the call. Use carefully; unexpected hang-ups can appear rude to callers.

Interview Handler—Sends the call to the interview handler that you specify.

Sign-In—Sends the call to the subscriber logon conversation.

Subscriber—Sends the call to the subscriber that you specify.

Subscriber System Transfer—Sends the call to a conversation that allows subscribers to transfer to a number that they specify. Subscribers are prompted to log on and then can enter numbers that are not associated with Cisco Unity subscribers—such as lobby and conference room phones, and even phone numbers outside the organization. Cisco Unity performs the transfer only when the subscriber restriction table permits it.

Caller System Transfer—Sends the call to a conversation that allows callers to transfer to a number that they specify. For example, callers may want to dial a lobby or conference room phone that is not associated with a Cisco Unity subscriber. Cisco Unity performs the transfer only when the CS_Default_System_Transfer restriction table permits it.

Default: Call Handler.

If No Input Send To

Select the destination to which calls are sent when the caller does not respond to the name entry prompt:

Call Handler—Sends the call to another call handler that you specify.

Directory Handler—Sends the call to another directory handler that you specify.

Greetings Administrator—Sends the call to a conversation for changing call handler greetings over the phone.

Hang Up—Disconnects the call. Use carefully; unexpected hang-ups can appear rude to callers.

Interview Handler—Sends the call to the interview handler that you specify.

Sign-In—Sends the call to the subscriber logon conversation.

Subscriber—Sends the call to the subscriber that you specify.

Default: Call Handler.

Note This option is not valid if "Play All Names" has been selected on the Profile page.

If No Selections Send To

Select the destination to which calls are sent when the caller enters a name but does not select an item from the resulting match list, or when the Play All Names check box on the Directory Handler > Profile Page is checked and the caller does not respond to prompts:

Call Handler—Sends the call to another call handler that you specify.

Directory Handler—Sends the call to another directory handler that you specify.

Greetings Administrator—Sends the call to a conversation for changing call handler greetings over the phone.

Hang Up—Disconnects the call. Use carefully; unexpected hang-ups can appear rude to callers.

Interview Handler—Sends the call to the interview handler that you specify.

Sign-In—Sends the call to the subscriber logon conversation.

Subscriber—Sends the call to the subscriber that you specify.

Default: Call Handler.

If Caller Presses Zero Send To

Select the destination to which calls are sent when the caller exits the directory handler by pressing 0:

Call Handler—Sends the call to another call handler that you specify.

Directory Handler—Sends the call to another directory handler that you specify.

Greetings Administrator—Sends the call to a conversation for changing call handler greetings over the phone.

Hang Up—Disconnects the call. Use carefully; unexpected hang-ups can appear rude to callers.

Interview Handler—Sends the call to the interview handler that you specify.

Sign-In—Sends the call to the subscriber logon conversation.

Subscriber—Sends the call to the subscriber that you specify.

Default: Call Handler.