10 Managing Oracle Beehive Voicemail

Note:

Oracle Beehive Voicemail functionality requires advanced configuration to enable. Some necessary Cisco configuration is not fully documented in this Guide. Please contact your Oracle support representative for assistance with deploying Oracle Beehive Voicemail.

Oracle Beehive Voicemail is provided by the Voicemail Service. It enables a variety of functionality for Oracle Beehive users, including the ability to access and manage voice messages from a telephone or as audio files in the e-mail Inbox. This module describes how to set up and configure the necessary software components to enable the voicemail functionality. It contains the following sections:

• Introduction to Managing Oracle Beehive Voicemail

• Configuring Oracle Beehive Voice Service

• Auto Attendant Administration Commands

Introduction to Managing Oracle Beehive Voicemail

This section includes the following topics:

• About Facilities

• About Auto Attendants

• About Voicemail Infrastructure

About Facilities

A Facility is an Oracle Beehive group, defined for a physical location that is connected to a single PBX. This concept allows all users at that facility to have common attributes and be treated in a common way. For example, a facility will set the default language for the voicemail users of that facility. Users may also have their own unique parameters as required.

Facilities are optional. You can set preferences and settings at the enterprise level, and those settings not specified at the facility level will default to the enterprise values. Facilities allow you the flexibility of having different settings at different physical locations, each with their own PBX.

About Auto Attendants

An Auto Attendant is an automated call-answering and routing server, which presents a collection of menus that are created for individual phone numbers supported at a facility. The menus allow callers to be routed to the correct department or extension, or expose additional recorded information (such as street directions or operation hours), and the corporate directory.

Auto Attendants are optional. You can deploy Oracle Beehive voicemail functionality with or without the use of Auto Attendants.

About Voicemail Infrastructure

Oracle Beehive voicemail and automated attendant (AA) telephone user interface (TUI) use VoiceXML to present the TUI to the caller via a Cisco VoiceXML capable router. The Cisco router has a VoiceXML browser imbeded inside Cisco IOS. VoiceXML is a W3C standards-based approach for voice applications and services, which leverages a Web-based development and deployment model instead of a propietary telephony hardware and software approach. Since VoiceXML uses a Web based model, all the Oracle Beehive voice applications are executed on the server and only the VoiceXML and audio .wav files are served to the Cisco VoiceXML browser via HTTP or HTTPS.

Figure 10-1 shows an example deployment architecture linking Cisco Call Manager hardware to Oracle Beehive.

Figure 10-1 Oracle Beehive Voicemail Centralized Deployment

Description of "Figure 10-1 Oracle Beehive Voicemail Centralized Deployment"

Cisco Dependencies and Requirements

In order to deploy Oracle Beehive voicemail, Cisco VoiceXML-capable harware and Cisco IOS VXML software is required. The supported Cisco VXML routers are the 2800 and 3800 Series Internet Service Routers (ISR), and the AS5350XM/AS5400XM Universal gateways. These routers offer a VoiceXML IOS featureset to execute the Oracle Beehive voice applications.

Please refer to your Cisco account representative to determine the VXML browser software licensing required for your environment and hardware. Cisco Unified Call Manager 5.0 or greater is the only IP PBX that has been tested with Oracle Beehive voicemail redirection.

Voicemail UDS Requirements

For an Oracle Beehive user to be active for voicemail the destination user's UDS record must contain a voice_principal, voice_pin, and tel: (telephone scheme) address attributes. The voice principal and telephone scheme address must be numbers containing no special characters or spaces. See "Managing and Provisioning Oracle Beehive Users" for complete documentation on configuring the appropiate user record attributes. You can use the beectl command-line tool to add and modify preference profiles, users' voice properties, groups, and group properties.

Voicemail Preference Properties

Voicemail configuration properties follow the Oracle Beehive model of property inheritance: Enterprise, Facility, and User. This allows you to group configuration properties. Enterprise properties apply to all voicemail users. Facility properties apply to the users defined in the UDS group that constitutes a voicemail facility. User properties are defined at the user level inside the user's UDS Voicemail Preference Profile. For example, the user propery PreferedLocale will override the locale defined at the facility.

Enterprise Preference Properties

Voicemail stores application configuration options in Oracle Beehive Preference Property Profiles. The enterprise properties for voicemail are stored in a Preference Profile called VoiceEnterprisePrefs. Before you can add or modify any voicemail properties, you must create the profile.

Facility Preference Properties

Voicemail has the ability to define multiple facilities in order to decentralize the deployment of voicemail router resources in remotes offices without having to run or administer multiple voicemail applications. A voicemail facility is a group of users and properties that share the same physical location and configuration information.

User Preference Properties

User properties are defined inside the user's Voicemail profile. These properties can define the user's PreferedLocale and ActiveGreetingType.

Configuring Oracle Beehive Voice Service

You must perform some configuration before Oracle Beehive Voice mail functionality is enabled. At a minimum, you must configure the enterprise, and you optionally may configure one or more facilities. You must also ensure that all users who will use Oracle Beehive voice mail have required values for the relevant attributes in their user accounts.

If you want to enable the Message Waiting Indicator and graphical user interface features of your telephones, you must configure them. If you want to use an auto attendant to answer and forward calls, you must configure the auto attendant.

This section contains the following topics:

• Configuring the Enterprise

• Creating Voicemail Users

• Managing Facilities

• Configuring the Voicemail Touch-tone User Interface (TUI)

• Configuring the Voicemail GUI and Message Waiting Indicator

• Configuring the Auto Attendant

Configuring the Enterprise

This section describes how to configure enterprise-level properties and preferences for Oracle Beehive voicemail functionality.

Note:

The Enterprise is created during Oracle Beehive installation. The only optional steps are to configure the settings for Voicemail and Auto Attendant. The values are stored in config properties and preferences. You may set either or both; there is no dependency between the two of them.

This section contains the following topics:

• Configuring Enterprise Properties

• Configuring Enterprise Preferences

Configuring Enterprise Properties

You must configure a set of properties located in the Voice Message Service's EnterpriseProperties subcomponent. Perform the following steps:

1. First, create a new voice enterprise object to hold all of the enterprise properties.

   With Oracle Beehive version 1.2 or earlier, use the beectl add_config_object command:

   beectl> add_config_object --alias Voice_<Name of Enterprise> --type oracle.ocs.management.model.VoiceMessageService$EnterpriseProperties
   

   With Oracle Beehive version 1.3 or later, use the beectl add_voice_enterprise command:

   beectl> add_voice_enterprise --name <Name of Enterprise>
   

   These commands will return an alias and an object ID for the new voice enterprise object you have created.

2. Next, use the beectl modify_property command to set the EnterpriseCollabId property to your enterprise's CollabID:

   beectl> modify_property --component <alias or object ID> --name EnterpriseCollabId --value <CollabID of Enterprise>
   

3. Activate your proposed configuration using the beectl activate_configuration command:

   beectl> activate_configuration
   

Table 10-1, "Enterprise Properties" shows the properties that can be set in the voice enterprise config object. You can set these properties using the beectl modify_property. Specify the EnterpriseProperties component, the property name, and the new value. For example, to set the RecordStreamURIs property value:

beectl> modify_property --component <Voice Enterprise Object ID> --name RecordStreamURIs --value http://<host>:<port>/voice-servlet/vmail/crs

Note:

The properties shown in Table 10-1, "Enterprise Properties" are only used when HTTPS Servers are being used for recording and playback, or the audio files for voicemail and the Auto Attendant have been provisioned on machines other than the one hosting the service.

For example, if the Oracle Beehive cluster is front-ended by a load balancer, these URI properties need to be changed to reflect the LBR configuration if HTTPS is being terminated on the LBR. Set the property with the following format:

https://<Load Balancer>:<port>/voice-servlet/vmail/data/shared/playback
https://<Load Balancer>:<port>/voice-servlet/vmail/crs

Table 10-1 Enterprise Properties

Property Name	Type	Example Value	Default Value	Description
RecordStreamURIs	STRING ARRAY		http://<host>:<port>/voice-servlet/vmail/crs	Beehive middle tier
RecordPlaybackURIs	STRING ARRAY		http://<host>:<port>/voice-servlet/vmail/data/shared/playback	Beehive middle tier
ExclusiveAudioContentURIs	STRING ARRAY		audio	The default value is a relative audio path.
SharedAudioContentURIs	STRING ARRAY		../shared-audio	The default value is a relative audio path.

Configuring Enterprise Preferences

These are set as part of the Enterprise Preferences:

Use the following commands to set any of the Enterprise Preference properties listed in Table 10-2, "Enterprise Preference Properties".

1. First, get the identifier for your enterprise by using the beectl list_enterprises command:

   beectl> list_enterprises
   

2. Then, use the enterprise identifier with the beectl list_preference_profiles command to get the Active Preference Profile identifier:

   beectl> list_preference_profiles --consumer <Enterprise identifier>
   

   Look for output similar to the following:

   Name : ActivePreferenceProfile
   Identifier : prfp=ActivePreferenceProfile,enpr=Oracle
   

3. Create a preference set using the beectl add_preference_set command:

   beectl> add_preference_set --parent <Preference Profile identifier> --name VoiceEnterprisePrefs
   

   The console will output an identifier for the new Preference Set.

4. Use the beectl add_preference_property command to set preference properties. :

   beectl> add_preference_property --set <Preference Set identifier> --name <name> --value <value> --type <type>
   

   See Table 10-2, "Enterprise Preference Properties" for the values of the --name, --value, and --type attributes. Repeat this step for each enterprise property.

Inheritance Rules

In general, the heirarchy is Enterprise -> Facility -> User, such that property values set at the lowest level are used first, and if no value is set, the property value at the next-higher level is used. This general flow is not followed in some cases.

The following rules are applied for determining inheretence of property values:

• UNDEFINED VALUES

  When the Enterprise value is not defined, then the default value is used. When the default value is not defined, then the Facility's value, if defined, is used. When neither value is defined, then the application determines a value, which may cause undesirable results.

• BOOLEAN

  When the Enterprise value is true, then the Facility's value, if set, is used. If not set, then true is used. If the Enterprise value is false, then all Facilities will use the value false, even if specified at the Facility level.

• INTEGER

  When the Enterprise value is -1, then the Facility's value is used.

• STRING and STRING ARRAY

  Both of these types behave as UNDEFINED VALUES

Table 10-2 Enterprise Preference Properties

Property Name	Type	Example Value	Default Value	Description
isRetrievalEnabled	BOOLEAN	true	true	Determines whether Users of the entire Enterprise are allowed to retrieve their messages.
isMWIEnabled	BOOLEAN	true	true	Determines whether Users of the entire Enterprise will have their MWI (Message Waiting Indicator) enabled or not.
isOperatorConfigured	BOOLEAN		true	Determines whether a caller can transfer to an Operator during their call.
MaxRecordingDuration	INTEGER		-1	Specifies the maximum duration a recording can be. -1 means that the Facility's value will be used. If not set at the Facility level, then 180 is used.
RTPServerURI	STRING	http://<BH_MT>:<PORT>/voice-servlet/rtp_server/RtpServer.jsp		The URI to access the RTP Server
RTPServerUserName	STRING	RtpClient		This value must be defined, but the username is only used for internal communication
RTPServerPassword	STRING	RtpPassword		This value must be defined but the password is only used for internal communication
isGlobalLookupFallbackEnabled	BOOLEAN		true
isPhoneNumberPresentable	BOOLEAN		true
StoreMsgMenuLocale	STRING	en-US		The locale to use when messages are being left for a User.
RetrieveMsgMenuLocale	STRING	en-US		The locale to use when messages are being retrieved by a caller. This locale is always used at the login, but the User's locale, if specified, will be used after he/she is authenticated.
IpPhoneUserName	STRING	bhvmgui		Username of the account defined in Cisco Call Manager which has device control over the users' telephones for audio playback and return call functionality in the Voicemail GUI Note: this attribute was added in Oracle Beehive version 1.3
IpPhonePassword	STRING	<bhvmgui_password>		Password of the account defined in Cisco Call Manager which has device control over the users telephones for audio playback and return call functionality in Voicemail GUI Note: this attribute was added in Oracle Beehive version 1.3
IpPhonePasswordSeed	STRING			This only needs to be set if local IP phone authentication is used. Oracle recommends you use CCM AXL configuration for IP authentication
IpPhonePasswordAlgorithm	STRING			This only needs to be set if local IP phone authentication is used. Oracle recommends you use CCM AXL configuration for IP authentication
IpPhonePasswordNumBits	INTEGER			This only needs to be set if local IP phone authentication is used. Oracle recommends you use CCM AXL configuration for IP authentication
IpPhoneRtpMinPort	INTEGER
IpPhoneRtpMaxPort	INTEGER
IpPhoneHttpProxyHost	STRING			This only needs to be set if the Oracle Beehive middle tier needs to communicate through a proxy to reach the IP Phones' HTTP server
IpPhoneHttpProxyPort	INTEGER			This only needs to be set if the Oracle Beehive middle tier needs to communicate through a proxy to reach the IP Phones' HTTP server
MwiAlgorithm	STRING	SHA1PRNG		Defines the algorithm used to create the SIP NOTIFY messages for MWI which must be set
MwiCcmHost	STRING			The IP address of the Call Manager SIP trunk configured to accept SIP NOTIFY messages
MwiCcmPort	INTEGER		5060	The port of the Call Manager SIP trunk configured to accept SIP NOTIFY messages
MwiSipProxyHost	STRING			SIP Proxy Host that is authorized to send SIP messages to Call Manager SIP MWI trunk
MwiSipProxyPort	INTEGER			SIP Proxy Port that is authorized to send SIP messages to Call Manager SIP MWI trunk
MwiMinLocalPort	INTEGER	5061		Lowest SIP port in the range that the Oracle Beehive SIP messages will be sent and listening for return messages
MwiMaxLocalPort	INTEGER	5080		Highest SIP port in the range that the Oracle Beehive SIP messages will be sent and listening for return messages
MwiSourcePhone	STRING	16505551234		Voicemail DNIS phone number that is presented in the SIP NOTIFY message
RtpServerHost	STRING	beehive.example.com		Host where the RTP Server is running
RtpServerMinPort	INTEGER		20480	Lowest port in the range used by the RTP server to send RTP packets
RtpServerMaxPort	INTEGER		32768	Highest port in the range used by the RTP server to send RTP packets
RtpServerPacketSize	INTEGER		160	RTP Packet Size. Leave at default for Cisco IP phones
RtpServerHttpProxyHost	STRING			This value must be set if the RtpServer has been deployed on a standalone host which can only be accessed by the Oracle Beehive middle tear via proxy
RtpServerHttpProxyPort	INTEGER			This value must be set if the RtpServer has been deployed on a standalone host which can only be accessed by the Oracle Beehive middle tear via proxy
AxlConfigA	STRING	https://<CCM_HOST>:8443/axl/,https://<CCM_HOST>:8443/realtimeservice/services/RisPort,,,bhvmgui,password,f,f	none	The comma seperated fields, in order, are: The AXL URL The realtime info URL The proxy host The proxy port The user provisioned for AXL access (read only) The password for the AXL user Whether certificate validation is enabled for SSL connections to CCM Whether hostname verification is enabled for SSL connections to CCM
AxlConfigB	STRING	https://192.188.175.105:8443/axl/,https://192.188.175.105:8443/realtimeservice/services/RisPort,,,bhvmgui,password,f,f STRING_LIST		This field's contents are the same as for AxlConfigA, and are used for backup AXL services running on another Cisco Call Manager Node This attribute was added in Oracle Beehive version 1.3.

Creating Voicemail Users

Generally, you can follow the instructions in "Managing and Provisioning Oracle Beehive Users" to create users with access to Oracle Beehive voicemail functions. You must provide values for any voicemail user for the following specific user attributes, in addition to the required user attributes:

• --voice_principal <phone number>

• --voice_pin <PIN>

• --address <type>:tel:<phone number>

Managing Facilities

This section describes how to create and configure a Facility. Facilities allow you to deploy more than one voice mail system (such as, at different physical locations), each with its own properties. Those properties not set at the facility level, will default to their enterprise-level values.

This section contains the following topics:

• Creating a Facility

• Facility Properties

• Config Properties

• Sample Facility XML File

Creating a Facility

To create a Facility, you must create both a group and a config object. The group's values: Enterprise CollabID, Name, Properties, and so on, are defined in an XML file. The values of these properties are defined in Table 10-3, "Facility Properties". See Example 10-1, "Sample Facility XML File" for an example Facility XML file.

Perform the following steps to create a Facility:

1. Create a group by using the beectl add_group command:

   beectl> add_group --file <path to Group XML file>
   

   See Table 10-3, "Facility Properties" for the properties to include in the XML file. See Example 10-1, "Sample Facility XML File" for an example Facility XML file.

2. Add a voice facility object.

   In Oracle Beehive version 1.2 or earlier, use the beectl add_config_object command:

   beectl> add_config_object --alias <voicemail service phone number OR auto attendant service phone number> --type oracle.ocs.management.model.VoiceMessageService$FacilityProperties
   

   In Oracle Beehive version 1.3 or later, use the beectl add_voice_facility command:

   beectl> add_voice_facility --name <voicemail service phone number OR auto attendant service phone number>
   

3. Use the beectl list_groups command to get the identifier of the group:

   beectl> list_groups
   

4. Use the beectl modify_property command to set the voice facility object to associate the group identifier to the alias "FacilityCollabId":

   beectl> modify_property --id <voice facitlity object id> --name FacilityCollabId --value <Group identifier>
   

5. Run the beectl activate_configuration command to validate and apply your configuration changes:

   beectl> activate_configuration
   

Facility Properties

Use the values in Table 10-3, "Facility Properties" for the Facility Properties that are set in the XML file when creating the group for a given facility.

Table 10-3 Facility Properties

Property Name	Type	Example Value	Default Value	Description
isMWIEnabled	BOOLEAN	true	true
PhoneList	STRING ARRAY	165055		This value must be set for the Voicemail GUI to look up by phone number for the facility. This matches the digits of the phone number range. For example, if the facility has a phone humber range of 16505551234-1650556999 The common string is 165055
TimeZone	STRING
ExtensionTranslationRules	STRING ARRAY	13125550???| 1650506????		The ExtensionTranslationRules is a pipe (|) delimited String containing simple rules for defining how extensions are expanded. A caller may enter 3-5 digits to indicate an extension. The extension is matched against the patterns provided and if a match is found, then the full set of digits is returned. For example, the extension 61234 would return 16505061234. While 789 would return 13125550789.
OperatorTransferNumber	STRING	tel:[phone]		The tel:address phone number of the operator for the facility. Only set if isOperatorConfigured is set to true
isUserLookupEnabled	BOOLEAN		true
isExtensionDialingEnabled	BOOLEAN		true
isOperatorConfigured	BOOLEAN		false
BusinessHourAttendantName	STRING
DefaultAttendantName	STRING
HolidayAttendantName	STRING
MaxRecordingDuration	INTEGER		180
RTPServerURI	STRING
RTPServerUserName	STRING
RTPServerPassword	STRING
SpecialAttendantName	STRING
isGlobalLookupFallbackEnabled	BOOLEAN		true
isPhoneNumberPresentable	BOOLEAN		true
isFaxReceiptEnabled	BOOLEAN		true
StoreMsgMenuLocale	STRING	en-US
RetrieveMsgMenuLocale	STRING	en-US
IpPhonePasswordSeed	STRING
IpPhonePasswordAlgorithm	STRING
IpPhonePasswordNumBits	INTEGER
IpPhoneRtpMinPort	INTEGER
IpPhoneRtpMaxPort	INTEGER
IpPhoneHttpProxyHost	STRING
IpPhoneHttpProxyPort	INTEGER
MwiAlgorithm	STRING
MwiCcmHost	STRING
MwiCcmPort	INTEGER
MwiSipProxyHost	STRING
MwiSipProxyPort	INTEGER
MwiMinLocalPort	INTEGER
MwiMaxLocalPort	INTEGER
MwiSourcePhone	STRING
RtpServerHost	STRING
RtpServerMinPort	INTEGER
RtpServerMaxPort	INTEGER
RtpServerPacketSize	INTEGER
RtpServerHttpProxyHost	STRING
RtpServerHttpProxyPort	INTEGER
FaxEmailAddress	STRING
SpecialDates	STRING	112707:0000-2359,123107:1400-2359		Represented as a comma separated list of dates and time intervals representing special dates. Use values in the same format as for BusinessHours
BusinessHours	STRING	0900-1700,0900-1700,0900-1700,0900-1700,0900-1700		Represented as a list of seven comma separated time intervals showing the open hours for each day of the week starting with Monday. Time intervals are in the format HHMM-HHMM in 24-hour notation. For example, "0900-1700,0900-1700,0900-1700,0900-1700,0900-1700,," represents 9AM to 5PM Monday through Friday. Note the trailing commas; there must be one "slot" for each day even if it is empty
Holidays	STRING	112707:0000-2359,123107:1400-2359		Represented as a comma separated list of dates and time intervals representing holidays. For example, "112707:0000-2359,123107:1400-2359" represents all day Nov 27th 2007, and after 2PM on Dec 31st, 2007

Config Properties

Table 10-4, "Facility Config Properties" lists the properties you can set in the Facility config object.

You can set the config properties of the Facility config object by using the beectl modify_property command:

beectl> modify_property --component <config object id or Alias defined by adding the configuration object> --name FacilityCollabId --value <Facility group identifier>

After modifying properties, use the beectl activate_configuration command to validate and activate your changes:

beectl> activate_configuration

Table 10-4 Facility Config Properties

Property Name	Type	Example Value	Default Value	Description
RecordStreamURIs	STRING ARRAY		http://<host>:<port>/voice-servlet/vmail/crs
RecordPlaybackURIs	STRING ARRAY		http://<host>:<port>/voice-servlet/vmail/data/shared/playback
ExclusiveAudioContentURIs	STRING ARRAY		audio	The default value is a relative audio path.
SharedAudioContentURIs	STRING ARRAY		../shared-audio	The default value is a relative audio path.

Sample Facility XML File

Example 10-1, "Sample Facility XML File" is a sample XML-formatted file for creating the Group when setting up a Facility. Be sure to replace the name, description, and scope values with the correct ones for the Facility you are creating.

Example 10-1 Sample Facility XML File

<?xml version="1.0" encoding="utf-8"?>
<groups>
  <group type="grup">
    <name>18665552020</name>
    <description>18665552020 Voicemail Facility</description>
    <scope>
      <cen>178B:5E25:enpr:360B9A7289F63579E040578C05156389000000018845</cen>
    </scope>
    <members>
      <add>
        <actor>
          <item>
            <!-- User 1 -->
            <cen>178B:5E25:user:63386283615A46D59306642C37BF3D07000000000000</cen>
          </item>
        </actor>
      </add>
     </members>
    <properties>
      <add>
        <item>
          <name>isMwiEnabled</name>
          <value>true</value>
          <description>MWI Enabled</description>
        </item>
        <item>
          <name>VMPhoneNumber</name>
          <value>18665552020</value>
          <description>VM DNIS</description>
        </item>
        <item>
          <name>OperatorTransferNumber</name>
          <value>13125554399</value>
          <description>Operator or AA Phone Number</description>
        </item>
        <item>
          <name>isOperatorConfigured</name>
          <value>true</value>
          <description>Enable Operator Transfer Number</description>
        </item>
        <item>
          <name>StoreMsgMenuLocale</name>
          <value>en-US</value>
          <description>Facility Default Message Leaving Language</description>
        </item>
        <item>
          <name>RetrieveMsgMenuLocale</name>
          <value>en-US</value>
          <description>Facility Default Message Retrieval Language</description>
        </item>
        <item>
          <name>isUserLookupEnabled</name>
          <value>true</value>
          <description>Allow User Directory Lookup</description>
        </item>
        <item>
          <name>isGlobalLookupFallbackEnabled</name>
          <value>true</value>
          <description>Allow User Directory Lookup Local to Global</description>
        </item>
        <item>
          <name>PhoneList</name>
          <value>1866</value>
          <description>IP Phone GUI User Finder</description>
        </item>
        <item>
          <name>ExtensionTranslationRules</name>
          <value>186655?????</value>
          <description>Extension Dialing</description>
        </item>
      </add>
    </properties>
  </group>
</groups>

Example 10-2, "Sample Modifying Facility XML File" shows the XML for modifying a facility. Note that when modifying a group, you do not provide the enterprise identifier, so you should remove the <scope> element tags. The facility group's identifier is used. In this XML file, a second user (User 2) is added.

Example 10-2 Sample Modifying Facility XML File

<?xml version="1.0" encoding="utf-8"?>
<groups>
  <group type="grup" cen="178B:5E25:grup:63386283615A46D59306642C37BF3D0700000000003F">
    <name>18665552020</name>
    <description>18665552020 Voicemail Facility</description>
    <members>
      <remove>
        <actor>
            <!-- User 1 -->
            <cen>178B:5E25:user:63386283615A46D59306642C37BF3D07000000000000</cen>
          </item>
          <item>
            <!-- User 2 -->
            <cen>178B:5E25:user:63386283615A46D59306642C37BF3D07000000000009</cen>
          </item>
        </actor>
      </remove>
     </members>
    <properties>
      <remove>
        <item>
          <name>isMwiEnabled</name>
          <value>true</value>
          <description>MWI Enabled</description>
        </item>
        <item>
          <name>VMPhoneNumber</name>
          <value>18665552020</value>
          <description>VM DNIS</description>
        </item>
        </remove>
        <add>
        <item>
          <name>isGlobalLookupFallbackEnabled</name>
          <value>true</value>
          <description>Allow User Directory Lookup Local to Global</description>
        </item>
        <item>
          <name>PhoneList</name>
          <value>1866</value>
          <description>IP Phone GUI User Finder</description>
        </item>
        <item>
          <name>ExtensionTranslationRules</name>
          <value>186655?????</value>
          <description>Extension Dialing</description>
        </item>
      </add>
    </properties>
  </group>
</groups>

Configuring the Voicemail Touch-tone User Interface (TUI)

For the Voicemail TUI to function the only required action is to create users with the required attribute values, as described in "Creating Voicemail Users". Once a user is created you can call into the voice service, and leave and listen to voice messages.

Configuring the Voicemail GUI and Message Waiting Indicator

Telephones within your deployment may have a Message Waiting Indicator (MWI), which lights up when the phone number has recieved one or more voice mail messages. Additionally, sophisticated phones may have a Graphical User Interface (GUI), which presents a menu of choices to the user.

In order to enable the use of voicemail features through an IP phone's GUI, or to enable MWI operation, you must set the properties identified in Table 10-5, "Voicemail Properties". These are a subset of the total set of properties, which are listed in Table 10-2, "Enterprise Preference Properties". You must set these properties at the Enterprise level of scope, but you can also set them at a Facility level; at a given Facility, the Facility-level properties override the global Enterprise-level properties.

The properties listed are for configuring using local IP Phone authentication.

To use local IP Phone configuration every device in Call Manager needs to be configured with the authentication server URL: http://<Beehive_HOST>:<port>/voice-servlet/cisco-ip-phones/authenticate.jsp

"Configuring Enterprise Properties" describes how to set the voicemail properties.

Table 10-5 Voicemail Properties

Property	Value	Type
IpPhonePasswordSeed		STRING
IpPhonePasswordAlgorithm	AES	STRING
IpPhonePasswordNumBits	128	INTEGER
IpPhoneRtpMinPort	20480	INTEGER
IpPhoneRtpMaxPort	32768	INTEGER
RtpServerHost		STRING
RTPServerUserName	RTPClient	STRING
RTPServerPassword	RTPpwd	STRING
RTPServerURI		STRING
MwiAlgorithm	SHA1PRNG	STRING
MwiCcmHost		STRING
MwiCcmPort	5060	INTEGER
MwiSipProxyHost		STRING
MwiSipProxyPort	15060 (optional property)	INTEGER
MwiMinLocalPort	5060	INTEGER
MwiMaxLocalPort	5080	INTEGER
MwiSourcePhone		STRING

Configuring the Auto Attendant

This section contains the following topics:

• Installing an Auto Attendant

• Associating an Auto Attendant with a Facility

• Voicemail TUI Optional Steps

Installing an Auto Attendant

To install an Auto Attendant, create an Auto Attendant Markup Language (AAML) document for your attendant, and record your voice prompts, making sure that they are 8000Hz mono u-law WAVE files. Make the files accessible from the computer on which Oracle Beehive is installed.

Use the beectl add_attendant command to add the auto attendant:

beectl> add_attendant --file <AAML file>

Next, use the beectl upload_attendant_prompt command to upload your recorded audio prompts:

beectl> upload_attendant_prompt --name <attendant name> --lang <language> --type <type> --file <prompt file>

You can review the VoiceXML at http://<host>:<port>/voice-servlet/aa/view/<attendant name>.do.

Associating an Auto Attendant with a Facility

To associate an Auto Attendant to a facility, first create one or more facilities by following the directions in "Managing Facilities". When you create a Facility, you create both a group and a config object. The group's values, such as identifier, Name, Properties, and so on, are defined in an XML file. See Example 10-1, "Sample Facility XML File" for an example Facility XML file.

See "Managing Facilities" for instructions on creating a Facility.

In Oracle Beehive version 1.2 or earlier, create a config object (alias) by using the beectl add_config_object command:

beectl> add_config_object --alias <voicemail service phone number OR auto attendant service phone number> --type oracle.ocs.management.model.VoiceMessageService$FacilityProperties

In Oracle Beehive version 1.3 or later, create a facility object by using the beectl add_voice_facility command:

beectl> add_voice_facility --name <voicemail service phone number OR auto attendant service phone number>

Next, use the beectl list_groups command to get the name and identifier of the group:

beectl> list_groups

Use the beectl modify_property command:

beectl> modify_property --component <config object id or Alias defined by adding the configuration object> --name FacilityCollabId --value <Group identifier>

Use the beectl activate_configuration command to validate and activate the configuration changes:

beectl> activate_configuration

For more inforamation on administration commands for the auto attendant, see "Auto Attendant Administration Commands".

Voicemail TUI Optional Steps

An Enterprise is not required for Facility values to be used. You may specify all settings at the Facility level, by following the instructions in the section "Creating a Facility", and skipping these Enterprise steps.

You can create Enterprise-level settings, which are used by default if you do not specify a given setting at the Facility level.

To create Enterprise-level settings:

1. Load defaultfacility.xml as a group ( see "Sample Facility XML File"). The default Facility must be created for Enterprise values to be used

2. Set Enterprise values, by following the instructions in "Configuring the Enterprise"

Auto Attendant Administration Commands

This section lists the various beectl commands used for managing the Auto Attendant, along with descriptions.

• add_attendant

  Adds an auto attendant using the information from an AAML document. The name of the attendant will be taken from the name attribute of the root element, "attendant". It should not contain any white space.

• delete_attendant

  Deletes an auto attendant by name.

• modify_attendant

  Updates an existing auto attendant with a new AAML file. You can also use this command to rename an existing attendant.

• upload_attendant_prompt

  Uploads a prompt for an attendant.

• delete_attendant_prompt

  Deletes a prompt.

• list_attendant_prompts

  List all prompts that have been uploaded for an attendant.

• list_attendant_aaml

  Prints the Auto Attendant Markup Language document for an auto attendant.

• modify_ip_phone_password_seed

  Resets the seed of the password generator for IP phones. To send commands to an IP phone the requestor must be authenticated. The password is generated based on information in the phone but must be seeded to ensure security.