cc/td/doc/product/voice/uone/srvprov/r41s
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Configuring the UM Application

Configuring the UM Application

The UM application is the core application for voice, fax, and e-mail messaging when you access uOne from the telephone. It is required for all other telephone features to work.

Administering UM.ini File


The UM.ini file is the configuration file for the UM application. This file is set up during the initial configuration of your system. The steps below show how to manually set up basic voice messaging services for the UM application.


Note UM.ini file parsing routines are case and white space sensitive. If you make changes to that file, ensure that the correct case is used for values and that no leading or trailing spaces are used in value or attribute names.

Step 1 Go to the GateServer on which the UM application resides.

Step 2 Type: cd $PARMLIB/apps/UM

Step 3 Edit the UM.ini files and set the following attributes (Figure 1-1).

BillingLogging=
Informational Logging=
MailProtocolDebug=
NetworkInfoExpected=
MailServer=
Postmaster=
LDAPhost=
LDAPBindDn=
LDAPDnPassword=
LDAPsearchbase=


Figure 1-1: UM.ini File Sample Entries for Basic Voice Messaging


UM.ini Attributes

The UM.ini file has seven sections:

Phrase Variables Section

This section contains the attributes that are used to locate the phrases that the UM application needs. Cisco provides three sets of professionally recorded prompts in US English by a female voice talent. The prompt sets include a master prompt set, which has the majority of the application and all of the system prompts. And two subsets of prompts that are distinguished by the type of dialing plan. The North American Numbering Plan (NANP) subset includes 36 prompts that refer to entering a "4, 5, 7 or 10 digit number". The second customized subset of "generic" prompts includes the same 36 prompts as in the NANP subset, with all references to a dialing plan removed from the text.

Each prompt set is recorded in two encoding types, Mu-law and A-law. Mu-law is the encoding method for prompts played over a T1. A-law is the encoding method for prompts played over an E1. The prompt sets are:

Typically, you will not need to modify the values in this section. The default values are set during UM installation for proper operations. You would change the phrase variables if you wanted to change the location of the phrase files. For example, if you want to change the voice, wording, or language of the phrases and still preserve the original phrases.


Note The values specified describe directory locations. These directory locations are based on the GateServer on which the CMA agent resides. They are not based on the server on which the UM application is installed.
Table 1-1: Phrase Variables Section Attributes
Attribute Description Valid Values

AppPhraseDirectory

Phrase directory for the application phrases.

Default = /home2/spmaster/r410/prompts/voice1/UM

SysPhraseDirectory

Phrase directory for the system phrases.

Default = /home2/spmaster/r410/prompts/voice1/SY

TmpPhraseDirectory

Phrase directory to store the temp files created by the application.

Default = /home2/spmaster/r410/TNT/containers/scratch

PhraseLanguage

Language code. This is used for system-level language selection for both Text-to-Speech, as well as prompts. If the subscriber preference is not available, the PhraseLanguage selection will be used.

The PhraseLanguage specifies the sub-directory under the
AppPhraseDirectory in which the prompts are located. The following sub-directories are associated with the following languages

  • 13=USEnglish

  • 14=German

  • 15=Spanish

  • 16=Dutch

  • 17=Italian

  • 18=French

  • USEnglish

  • German

  • Spanish

  • Dutch

  • Italian

  • French

Default = USEnglish

Note If there are multiple language prompt sets, then a separate UM.ini file is required for each prompt set. Telephone numbers need to be associated with the appropriate UM.ini file to ensure the correct system-level prompts are played.

Greetings Section

This section contains the key names for the phrases that are spoken during various greetings of the application. The application uses the values specified in this section as key values for look up in the PromptPhraseList.tab file. If you modify entries in this section, you should make corresponding modifications in the PromptPhraseList.tab file.


Note If you modify the LmmWelcomeGreeting or SubAccessWelcomeGreeting attributes, you do not have to make corresponding modifications in the PromptPhraseList.tab file. The application uses the UM.ini, instead of the PromptPhraseList.tab file, to locate the prompt files for those two key names.
Table 1-2: Greetings Variables Section Attributes
Attribute Description Valid Values

AllCallsGreetingName

The text name used internally for the all calls greeting.

Default = AllCalls

BusyGreetingName

The text name used internally for the busy greeting.

Default = Busy

DistListFolderName

The folder name (under the subscriber number folder of the subscriber's Greeting Administrator account) where distribution lists are stored.

Default = DistList

ExtendedAbsenceGreetingName

The text name used internally for the extended absence greeting.

Default = Extended_Absence

GreetingFolderName

The folder name (under the subscriber number folder of the subscriber's Greeting Administrator account) where greetings are stored.

Default = Greeting

LmmWelcomeGreeting

A greeting always plays when a call is rolled over to leave message module because the subscriber did not answer the phone.

Valid and existing greeting name in the table (do not type the .wav extension) or it could be blank.

Default = N/A

NoAnswerGreetingName

The text name used internally for the no answer greeting.

Default = NoAnswer

OutOfHoursGreetingName

The text name used internally for the Out of hours greeting.

Default = OutOfHours

PostBusyGreeting

A phrase plays after the subscriber's busy greeting when the call is rolled over to leave message module because the subscriber was busy.

Valid and existing greeting name in the table (do not type the .wav extension).

Default = PGA_IS_BUSY

PostNoAnswerGreeting

A phrase plays after the subscriber's no answer greeting when the call is rolled over to leave message module because the subscriber did not answer the phone.

Valid and existing greeting name in the table (do not type the .wav extension).

Default = PGA_IS_NOT_AVAILABLE

PreBusyGreeting

A phrase plays before the subscriber's busy greeting when the call is rolled over to leave message module because the subscriber was busy.

Valid and existing greeting name in the table (do not type the .wav extension) or it could be blank.

Default = N/A

PreNoAnswerGreeting

A phrase plays before the subscriber's no answer greeting when the call is rolled over to leave message module because the subscriber did not answer the phone.

Valid and existing greeting name in the table (do not type the .wav extension) or it could be blank.

Default = N/A

SNRGreetingName

The text name used internally for the SNR greeting. Not used in release 4.1s.

Default = SNRGreeting

SpokenNameGreetingName

The text name used internally for the spoken name.

Default = SpokenName

SubAccessWelcomeGreeting

A greeting always plays when a subscriber dials into the application.

Valid and existing greeting name in the table (do not type the .wav extension) or it could be blank.

Default = LOG_WELCOME_CISCO


UMConfig Section

This section contains the keys specific to the UM application.
Table 1-3: UMConfig Variables Section Attributes
Attribute Description Valid Values

AMISADomain

Used for External Users that are not provisioned in the uOne LDAP database.

Upon determining that a phone number does not match a subscriber, UM will repeat the full number, tell the user that it is not for a subscriber on this system and ask if they want to add it anyway.

If the user doesn't want to add it, UM will proceed normally. Otherwise, an e-mail address is added to the list in the form of PhoneNumber@AMISADomainValue.

Not used in release 4.1s.

Valid e-mail domain name. For example, AMISADomain.com

Default = N/A

AppRunMode

Application's running mode.

Static or Dynamic

Default = Dynamic

AudioSubType

Audio type. This attribute is used in creation of VPIM message. The only value currently supported is wav, but when G726.1 encoding format is available on DSP cards, the applicable values will be extended.

Wav

Default = wav

BillingLogging

Whether the billing records will be output (logged) or not. If it is set to On, UM will log all outbound calls, login/logout for subscriber access, leave message access, and inbound fax access to the AMM agent via event logs. The Unified Messaging System Administration application will log the addition/deletion of subscribers in the network to http logs.

On or Off.

Default = Off

BusyNoAnswerGrt

Whether there will be an option to record busy or no answer greetings

Yes or No

Default=Yes

CompanyName

In headers such as "<Cisco> Fax Message", the company name can be configured with this attribute.

Default=Cisco

DateNTimeFormat

Designates the format in which the message header will be played.

Natural or Euro

Default = Natural

DRSMode

Enables/disables the Deposit/Retrieve Session Mode. If this mode is enabled, the user enters fewer key strokes because the system uses the ANI to determine whether the caller is a subscriber. This mode is mainly used with cell phones.

For this mode to work properly, the following attributes must have these values:

  • NetworkInfoExpected=Yes

  • SNAMode=Disabled

  • DRSMode=Enabled

  • DRSRetrievalNumber=<10 digit number>

Enabled/Disabled

Default=Disabled

DRSRetrievalNum

Identifies the 10-digit number that the subscribers dial to retrieve their messages. The deposit/retrieval of messages is based on the value of this attribute, not the call type.

10-digit retrieval number

Default = blank or 10-digit retrieval number

InformationalLogging

Indicates whether event logging occurs, other than billing information. Information such as imap, ldap, dtmf keys, phrases played will be logged. You can use this information to recreate user problems to troubleshoot problems.

On or Off

Default = Off

InventoryTime

Sets the length of the time interval after which UM will play a prompt while doing message inventory. For example, if the message inventory takes 1 minute and this attribute is set to 10, UM will play a prompt informing the subscriber that the inventory is still in progress every 10 seconds until the inventory is finished.

During message inventory, this attribute also controls the length of time that it takes for an interrupt by the subscriber to take affect.

Any reasonable number.

Unit is seconds.

Default=10

LeaveMessageMenu

To determine whether the person leaving the message will be allowed to perform unrestricted transfer or will be allowed to transfer to operator only. When the transfer is allowed, the security and restriction burden, as well as setting up of the transfer will be responsibility of the switch/telecom configuration.

TransferAllowed or NoTransferAllowed

Default = TransferAllowed

LeaveMsgConfigFile

The file used to determine the phone numbers on which leave message module will run.

Valid filename existing in $PARMLIB/apps/UM directory. For example, LMMFile.

Default = LMMFile

Legacy Default

Used for USDOMESTIC systems. If this attribute is enabled and if a mailbox ID could not be resolved, UM will try to build a mailbox ID using the subscriber ID and knowledge about the form of the incoming telephone number.

Enabled/Disabled

Default=Disabled

LoginExpandSection

This entry will be applied to subscriber login, leave a fax, or leave a message when the user is prompted for the mailbox ID.

Any section name in the DialMap.ini file that can expand a phone number or blank.

Default = DialPlan

MailProtocolDebug

IMAP APIs debug information at the protocol level.

On or Off

Default = Off

MailProtocolTimeout

Controls timeout for SMTP sends and IMAP calls. If MailProtocolTimeout is undefined or is set to 0, the timeout for SMTP sends and IMAP calls would be infinite.

Any reasonable number.

Unit is seconds.

Default=10

MailServer

Mail server. This attribute is used to fine tune the application based upon the backend server characteristics. Currently, only two values are allowed.

Netscape or ATT

Default = Netscape

MaxLoginAttempts

Maximum number of the failed login attempts for the subscriber per session.

Default = 3

MaxMessageSize

Used to warn the subscriber that the message box is full and to inform the caller that he cannot leave a message for the subscriber. A typical 3-minute message using wav encoding results in a 2MB message file which results in 2000 blocks; the default value.

In blocks, the system administrator should decide this value.

Default = 2000

MaxNumberPrompts

The maximum number of any type of message counted when the UM application is announcing the number of messages. For example, if this attribute is set to 50, UM will announce the exact number of messages of a specific type as long as that number doesn't exceed 50. If that number is exceeded, the subscriber will hear a message similar to the following: "You have more than 50 voice messages.

Default=100

MessageVolumeLevel

Volume level that phrases are adjusted to.

1 - 10

Default = 1

NetworkInfoExpected

Informs the application whether the CNA agent is going to provide the network information, such as ANI, RDNIS, and call type.

Yes or No

Default = Yes

Postmaster

Destination e-mail address for non-deliverable messages.

E-mail address of postmaster.

Default = N/A

SchedulingEnabled

Whether messages will be scheduled during send messages.

Yes or No

Default = No

SkipInterval

The number of seconds to move the message forward and backward while it is playing.

Valid value for telecom. For example, 5.

Default = 5

SNAMode

Indicates whether or not Personal Access is enabled.

This attribute is not included in the Samples/UM.ini file. If this attribute is not present, Personal Access is disabled.

Enabled or Disabled.

Default = Enabled

TableDefinition

The table that defines the rest of the table in the application. This attribute should not be changed without consulting development team.

Valid and existing table name. For example, Menus_define.tab.

Default = Menus_define.tab

TableInstance

The table that defines the instances of the tables specified in the TableDefinition. This attribute should not be changed without consulting development team.

Valid and existing table name. For example, Menus_inst.tab.

Default = Menus_inst.tab

TextSubType

Specifies the extension for a text file.

Default=txt

TimeOutValue

Application's time out value.

0 - 30

Default = 5

Version

The application level version control. Only developers can modify this value.

1

Default = 1

LDAPConfig Section

The Directory Server related configuration parameters are defined in this section.
Table 1-4: LDAPConfig Variables Section Attributes
Attribute Description Valid Values

ExpandLists

To allow distribution list expansions for "Netscape" and "Other" type of messaging servers.

Possible and valid combinations:

ExpandLists MailServerType

Netscape ATT Other
Yes= Expanded Not Exp. Expanded
No= Not Exp. Not Exp. Expanded

Yes or No

Default = Yes

LDAPBindDn

The authority to bind as to the directory, and to have sufficient privilege to perform all the operations that UM requests.

Specify all UM operations here.

Default = cn=Directory Manager, o=Organization

LDAPDnPassword

The e-mail password (in other words, the IMAP password) of the above authority.

The password of LDAPBindDn

Default = N/A

LDAPhost

The centralized Directory Server name that UM uses.

Valid machine names separated by commas.

Default = N/A

LDAPport

The port on which slapd (LDAP daemon) is running for the centralized server.

Valid port number. For example, 389.

Default = 389

LDAPsearchbase

Entry DN from which UM can see all entries that will be accessed. Use this attribute to restrict and/or partition the Directory Server from the perspective of UM and other applications. In a large-scale directory setting, an appropriate search base will improve performance.

Top of the directory.

Default =

o=Organization

LDAPTimeout

Controls timeout for LDAP calls. If LDAPTimeout is undefined or is set to 0, the timeout for LDAP calls would be infinite.

Any reasonable number

Unit is seconds.

Default=10

AutoAttendant Section

The Automated Attendant attributes are reserved for future use. However, the Dial-by-Name and Address-by-Name feature use the attributes in Table 1-5.
Table 1-5: Auto Attendant Variables Section Attributes
Attribute Description Valid Values

DirectorySearch

Indicates how the name search is constructed. First name first last name last or last name first and first name last or both.

LastName, FirstName, or Both. For example, John Doe would be:

LastName: Doejohn
FirstName: johndoe
Both: doejohn and johndoe

Default = LastName

DirLookupNumInitialDigits

The minimum number of digits that must be entered by the user both initiating a search unless the name is # terminated.

2 - 5

Default =3

MaxListEntries

Maximum number of names that may be presented to the user for selection when the user # terminates the entered name.

2 - 5

Default = 3

MaxSearchEntries

Maximum number of entries returned from LDAP when searching for matching names.

10 - 20

Default = 10

Broadcast Section

This section contains the keys to enable/disable broadcast notification and/or broadcast message aging in UM.
Table 1-6: Broadcast Variables Section Attributes
Attribute Description Valid Values

DefaultExpDays

The default number of days before a broadcast message expires.

A reasonable number

Default = 3

MaxExpDays

The maximum number of days that a subscriber is able to set in UM for broadcast message expiration.

A reasonable number.

Default = 365

FAX Section

This section lists attributes used by the inbound FAX service.


Note The configuration attributes for outbound FAX services are defined in the FaxPrint.ini file.
Table 1-7: FAX Variables Section Attributes
Attribute Description Valid Values

FAXConfigFile

Filename for FAXFile that contains extensions used for Group Fax numbers.

Valid filename existing in $PARMLIB/apps/UM directory. For example, FAXFile.

Default = FAXFile

FAXInactivityTimeout

InactivityTimeout value passed to CMA before receiving a fax.

0 - 30000
0 indicates no timeout

Default = 0

FaxOnErrorMenu

When set to 'No', there will be no option 3 to leave fax in the 1,2,3 menu.

Yes or No

Default = No

FaxSubType

File type for faxes written to disk. This attribute is used to create VPIM message and should not be changed without consulting development team.

tif

Default = tif



hometocprevnextglossaryfeedbacksearchhelp
Posted: Mon Sep 25 19:47:45 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.