Export (0) Print
Expand All
Expand Minimize

White Paper: Unified Messaging Technical Reference - Part 6

 

Topic Last Modified: 2007-09-11

Jon Hoerlein, Technical Writer, Microsoft Exchange Server

September 2007

This white paper is a technical reference that you can use to help you deploy, manage, and troubleshoot a server that is running Microsoft Exchange Server 2007 that has the Unified Messaging server role installed. It includes information about each Exchange Management Shell cmdlet that you can use to configure Unified Messaging. It also includes information about the Unified Messaging settings that you can configure by using the Exchange Management Console. Additionally, this white paper provides information about Unified Messaging performance counters and Unified Messaging Application log events.

Microsoft Exchange Server 2007

Table of Contents

This white paper is a technical reference that you can use to help you deploy, manage, and troubleshoot an Exchange 2007 server that has the Unified Messaging server role installed. It includes information about each Exchange Management Shell cmdlet that you can use to configure Unified Messaging (UM). It also includes information about the Unified Messaging settings that you can configure by using the Exchange Management Console. Additionally, this white paper provides information about Unified Messaging performance counters and Unified Messaging Application log events.

This white paper does not contain detailed step-by-step procedures. To review detailed procedures that correspond to the information in this technical reference, see Managing Unified Messaging.

Objectives and acknowledgements   Much of the information in this white paper originally appeared as individual Help topics in the Exchange Server 2007 Help. In this white paper, we have combined this information to provide an end-to-end, printable guide that you can use as a technical reference for Unified Messaging.

noteNote:
To print this white paper, click Printer Friendly Version in the Web browser.

This white paper is divided into the following sections:

  • Unified Messaging Exchange Management Shell Cmdlets

  • Unified Messaging Exchange Management Console Settings

    • Organizational Settings

    • Server Settings

    • Recipient Configuration

  • Unified Messaging Errors and Events Reference

  • Performance Counter Reference for Unified Messaging

Return to top

This section provides information that will help you manage the Microsoft Exchange Server 2007 Unified Messaging server role by using the Exchange Management Shell.

The Exchange Management Shell cmdlets that you use to manage Unified Messaging can be grouped into the following categories:

  • Unified Messaging Auto Attendant Cmdlets

  • Unified Messaging Dial Plan Cmdlets

  • Unified Messaging Hunt Group Cmdlets

  • Unified Messaging IP Gateway Cmdlets

  • Unified Messaging Mailbox Cmdlets

  • Unified Messaging Mailbox PIN Cmdlets

  • Unified Messaging Mailbox Policy Cmdlets

  • Unified Messaging Server Cmdlets

  • Unified Messaging Troubleshooting and Monitoring Cmdlets

  • Unified Messaging Virtual Directory Cmdlets

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging auto attendants by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging auto attendants:

  • New-UMAutoAttendant

  • Remove-UMAutoAttendant

  • Get-UMAutoAttendant

  • Set-UMAutoAttendant

  • Enable-UMAutoattendant

  • Disable-UMAutoAttendant

  • Copy-UMCustomPrompt

Return to top

The New-UMAutoAttendant cmdlet creates a new Unified Messaging auto attendant.

New-UMAutoAttendant -Name <String> -UMDialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-PilotIdentifierList <MultiValuedProperty>] [-SpeechEnabled <$true | $false>] [-Status <Enabled | Disabled>] [-TemplateInstance <PSObject>]

The New-UMAutoAttendant cmdlet lets you create one or more UM auto attendants. Unified Messaging auto attendants have a forest-wide scope in the configuration container in Active Directory. When you create a new UM auto attendant, it is linked to a single UM dial plan that contains a list of extension numbers. Linking the UM auto attendant to the UM dial plan enables the associated Unified Messaging servers to answer incoming calls by using the UM auto attendant.

To run the New-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Name

Required

System.String

This parameter specifies the display name for the UM auto attendant. The display name for the new UM auto attendant can contain as many as 64 characters.

UMDialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan identifier for the UM dial plan to be associated with this UM auto attendant.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

DTMFFallbackAutoAttendant

Optional

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies a secondary UM auto attendant. A secondary UM auto attendant can be used only if the SpeechEnabled parameter is set to $true.

PilotIdentifierList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies a list of one or more pilot numbers. Pilot numbers route incoming calls to UM servers. The calls are then answered by the UM auto attendant.

SpeechEnabled

Optional

System.Boolean

This parameter specifies whether the UM auto attendant is speech-enabled. The default value is $true. If this parameter is omitted, or if the value is $false, the UM auto attendant is not speech-enabled.

Status

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.StatusEnum

This parameter specifies whether the UM auto attendant that is being created will be enabled. If this parameter is not supplied, the UM auto attendant is created but left in a disabled state.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to this parameter, the cmdlet will use the configuration of that object to create an identical copy of the object on a local or target server.

Description

The first example creates a new UM auto attendant named MyUMAutoAttendant that can accept incoming calls but is not speech-enabled.

The second example creates a new speech-enabled UM auto attendant named MyUMAutoAttendant.

Code

New-UMAutoAttendant -Name MyUMAutoAttendant -UMDialPlan MyUMDialPlan -PilotIdentifierList 55000 -Enabled $true

New-UMAutoAttendant -Name MyUMAutoAttendant -UMDialPlan MyUMDialPlan -PilotIdentifierList 56000,56100 -SpeechEnabled $true

Return to top

The Remove-UMAutoAttendant cmdlet deletes a Unified Messaging (UM) auto attendant.

Remove-UMAutoAttendant -Identity <UMAutoAttendantIdParameter> [-DomainController <Fqdn>]

The Remove-UMAutoAttendant cmdlet deletes an existing UM auto attendant from Active Directory. The Remove-UMAutoAttendant cmdlet deletes the UM auto attendant, and also deletes instances of the UM auto attendant from any associated UM dial plans. When the UM auto attendant is deleted, incoming telephone calls to the configured extensions will no longer be answered by the UM auto attendant.

To run the Remove-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the identifier for the UM auto attendant that is being deleted. This is the directory object ID for the UM auto attendant.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example shows how to delete a UM auto attendant named MyUMAutoAttendant.

Code

Remove-UMAutoAttendant -Identity MyUMAutoAttendant

The Get-UMAutoAttendant cmdlet retrieves the properties and the values for a Unified Messaging (UM) auto attendant.

Get-UMAutoAttendant [-Identity <UMAutoAttendantIdParameter>] [-DomainController <Fqdn>]

The Get-UMAutoAttendant cmdlet retrieves the properties for a single UM auto attendant or for a list of UM auto attendants. If no parameter is supplied with the cmdlet, the cmdlet will return all UM auto attendants in the Active Directory directory service forest. If the UM dial plan ID is supplied but no name is supplied, the cmdlet will return all UM auto attendants that are linked to the UM dial plan.

To run the Get-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the identifier for the UM auto attendant that is being viewed. This is the directory object ID for the UM auto attendant.

Description

The first code example returns a formatted list of all UM auto attendants in the Active Directory forest.

The second code example displays the properties of a UM auto attendant named MyUMAutoAttendant.

Code

Get-UMAutoAttendant | Format-List

Get-UMAutoAttendant -Identity MyUMAutoAttendant

Return to top

The Set-UMAutoAttendant cmdlet modifies an existing Unified Messaging auto attendant.

Set-UMAutoAttendant -Identity <UMAutoAttendantIdParameter> [-AfterHoursKeyMapping <MultiValuedProperty>] [-AfterHoursKeyMappingEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptFilename <String>] [-AfterHoursTransferToOperatorEnabled <$true | $false>] [-AfterHoursWelcomeGreetingEnabled <$true | $false>] [-AfterHoursWelcomeGreetingFilename <String>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-BusinessHoursKeyMapping <MultiValuedProperty>] [-BusinessHoursKeyMappingEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptFilename <String>] [-BusinessHoursSchedule <ScheduleInterval[]>] [-BusinessHoursTransferToOperatorEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingFilename <String>] [-CallSomeoneEnabled <$true | $false>] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | AddressList>] [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-HolidaySchedule <MultiValuedProperty>] [-InfoAnnouncementEnabled <True | False | Uninteruptible>] [-InfoAnnouncementFilename <String>] [-Language <UMLanguage>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias | InheritFromDialPlan>] [-Name <String>] [-NameLookupEnabled <$true | $false>] [-OperatorExtension <String>] [-PilotIdentifierList <MultiValuedProperty>] [-SendVoiceMsgEnabled <$true | $false>] [-SpeechEnabled <$true | $false>] [-TimeZone <String>] [-TimeZoneName <UMTimeZone>]

Set-UMAutoAttendant [-AfterHoursKeyMapping <MultiValuedProperty>] [-AfterHoursKeyMappingEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptEnabled <$true | $false>] [-AfterHoursMainMenuCustomPromptFilename <String>] [-AfterHoursTransferToOperatorEnabled <$true | $false>] [-AfterHoursWelcomeGreetingEnabled <$true | $false>] [-AfterHoursWelcomeGreetingFilename <String>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-BusinessHoursKeyMapping <MultiValuedProperty>] [-BusinessHoursKeyMappingEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptEnabled <$true | $false>] [-BusinessHoursMainMenuCustomPromptFilename <String>] [-BusinessHoursSchedule <ScheduleInterval[]>] [-BusinessHoursTransferToOperatorEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingEnabled <$true | $false>] [-BusinessHoursWelcomeGreetingFilename <String>] [-CallSomeoneEnabled <$true | $false>] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | AddressList>] [-DomainController <Fqdn>] [-DTMFFallbackAutoAttendant <UMAutoAttendantIdParameter>] [-HolidaySchedule <MultiValuedProperty>] [-InfoAnnouncementEnabled <True | False | Uninteruptible>] [-InfoAnnouncementFilename <String>] [-Instance <UMAutoAttendant>] [-Language <UMLanguage>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias | InheritFromDialPlan>] [-Name <String>] [-NameLookupEnabled <$true | $false>] [-OperatorExtension <String>] [-PilotIdentifierList <MultiValuedProperty>] [-SendVoiceMsgEnabled <$true | $false>] [-SpeechEnabled <$true | $false>] [-TimeZone <String>] [-TimeZoneName <UMTimeZone>]

The Set-UMAutoAttendant cmdlet lets you change or modify the settings of an existing UM auto attendant. By default, some UM auto attendant parameters are required and are created. However, after a UM auto attendant is created, not all properties for the UM auto attendant are writable. Therefore, some of the values for the UM auto attendant cannot be changed or modified unless the UM auto attendant is deleted and a new one is created.

To run the Set-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the identifier for the UM auto attendant that is being viewed. This parameter is the directory object ID for the UM auto attendant.

AfterHoursKeyMapping

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the key mappings to be used for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator.

Example for a custom table that has 2 entries:

“Sales, 77899”,"Service, 78990”. The default is disabled.

AfterHoursKeyMappingEnabled

Optional

System.Boolean

This parameter specifies whether to enable or disable key mappings for after business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator.

Example for a custom table that has 2 entries:

“Sales, 77899”,"Service, 78990”.

AfterHoursMainMenuCustomPromptEnabled

Optional

System.Boolean

This parameter specifies whether the after business hours custom main menu is enabled. The default is disabled.

AfterHoursMainMenuCustomPromptFilename

Optional

System.String

This parameter specifies the .wav file to be used for the after business hours custom main menu prompt.

AfterHoursTransferToOperatorEnabled

Optional

System.Boolean

This parameter specifies whether to allow calls to be transferred to the operator's extension number after business hours.

AfterHoursWelcomeGreetingEnabled

Optional

System.Boolean

This parameter specifies whether the after hours greeting is enabled. The system default audio will be used if this parameter is set to disabled. The default is disabled.

AfterHoursWelcomeGreetingFilename

Optional

System.String

This parameter specifies the .wav file to be used for the after hours greeting message.

AllowDialPlanSubscribers

Optional

System.Boolean

This parameter specifies whether to allow the dial plan subscribers to dial numbers that are resolved to a subscriber in the same dial plan. The default is $true.

AllowedInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the list of in-country/region dial group names that are allowed. The names must match group names that are defined in the dial plan. The string must have fewer than 128 characters.

AllowedInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the list of international dial group names that are allowed. The names must match group names that are defined in the dial plan. The string must have fewer than 128 characters.

AllowExtensions

Optional

System.Boolean

This parameter specifies whether callers can make calls to extensions that have the same number of digits as the number that is specified on the dial plan object. The default is $false.

BusinessHoursKeyMapping

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the key mappings for business hours for the UM auto attendant. A key mapping is defined as an entry in a table that has as many as 9 entries. The 0 key is reserved for a transfer to the operator.

Example for a custom table that has 2 entries:

“Sales, 77899”,"Service, 78990”. The default is disabled.

BusinessHoursKeyMappingEnabled

Optional

System.Boolean

This parameter specifies whether the custom menus for business hours will be enabled or disabled. The default is disabled.

BusinessHoursMainMenuCustomPromptEnabled

Optional

System.Boolean

This parameter specifies whether the business hours custom main menu prompt is enabled. The default is disabled.

BusinessHoursMainMenuCustomPromptFilename

Optional

System.String

This parameter specifies the .wav file to be used for the business hours custom main menu prompt.

BusinessHoursSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

This parameter specifies the hours the business is open.

BusinessHoursTransferToOperatorEnabled

Optional

System.Boolean

This parameter specifies whether to allow call transfer to the operator's extension number during business hours.

BusinessHoursWelcomeGreetingEnabled

Optional

System.Boolean

This parameter specifies whether the custom business hours greeting is enabled. The system default audio will be used if this parameter is set to disabled. The default is disabled.

BusinessHoursWelcomeGreetingFilename

Optional

System.String

This parameter specifies the .wav file to be used for the welcome message.

CallSomeoneEnabled

Optional

System.Boolean

This parameter specifies whether the Call Someone feature is enabled.

ContactAddressList

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

This parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, it will define the scope for directory searches.

ContactRecipientContainer

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This parameter specifies the name or identity of the container that will be used for directory searches.

ContactScope

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialScopeEnum

This parameter specifies the scope of the directory search that will be given to callers when they access the UM auto attendant and specify a user's name.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

DTMFFallbackAutoAttendant

Optional

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the dual tone multi-frequency (DTMF) auto attendant that will be used if the speech-enabled auto attendant is unavailable. If the SpeechEnabled parameter is set to $true, this auto attendant must have an associated DTMF auto attendant to use as the fallback auto attendant.

HolidaySchedule

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the holiday schedule for the organization. The schedule is formatted as an array of strings. Each string contains three parts:

  • The name - limited to 64 characters.

  • The day (date) of the holiday.

  • The file name for the audio prompt. The audio prompt will be in the .wma format.

Example:

“Christmas, 12/25/2005, Christmas.wav”.

InfoAnnouncementEnabled

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.InfoAnnouncementEnabledEnum

This parameter specifies whether to enable the informational greeting. The default setting is $true.

InfoAnnouncementFilename

Optional

System.String

This parameter specifies the .wav file to be used for the informational announcement.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMAutoAttendant

This parameter specifies the UM auto attendant object input parameter. This parameter is required if the Identity parameter is not used.

Language

Optional

Microsoft.Exchange.Data.UMLanguage

This parameter specifies the language that is used by the UM auto attendant. This language is selected from the list of available dial plan languages.

MatchedNameSelectionMethod

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AutoAttendantDisambiguationFieldEnum

This parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following:

  • Department

  • Title

  • Location

  • None

  • Prompt for alias

  • Inherited from UM dial plan

Name

Optional

System.String

This parameter specifies the display name to be used for the UM auto attendant. This name is limited to 64 characters.

NameLookupEnabled

Optional

System.Boolean

This parameter specifies whether to allow callers to perform directory lookups by dialing the name or by speaking the name. This parameter can prevent callers from connecting to unknown extensions.

OperatorExtension

Optional

System.String

This parameter specifies the extension number of the operator. If this parameter is not specified, the dial plan operator will be used. If the dial plan operator is not specified, the feature will not be enabled.

PilotIdentifierList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies a list of one or more pilot numbers. Pilot numbers are used to route incoming calls to Unified Messaging servers. They are then answered by the auto attendant.

SendVoiceMsgEnabled

Optional

System.Boolean

This parameter specifies whether to allow the Send Message feature.

SpeechEnabled

Optional

System.Boolean

This parameter specifies whether the auto attendant is speech-enabled. The default setting on the auto attendant is DTMF.

Timezone

Optional

System.String

This parameter specifies the time zone that will be used with the auto attendant. The default time zone is the time zone setting that is on the server.

TimeZoneName

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMTimeZone

This parameter specifies all or part of a Microsoft Windows time zone display name. The string is compared to the display names in the local system registry to identify a simple "contains" match. An error will be returned is if it is not unique.

Description

The first example configures a UM auto attendant named MySpeechEnabledAA to fall back to the MyDTMFAA, sets the operators extension to 50100, and enables transfers to this extension number after business hours.

The second example configures a UM auto attendant named MyAutoAttendant that has business hours configured to be 10:45 A.M. to 1:15 P.M. (Sunday), 9:00 A.M. to 5:00 P.M. (Monday), and 9:00 A.M. to 4:30 P.M. (Saturday) and holiday times and their associated greetings configured to be "New Years" on 2 January 2006, and "Building closed for construction" from 24 through 28 April 2006.

Code

Set-UMAutoAttendant -Identity MySpeechEnabledAA -DTMFFallbackAutoAttendant MyDTMFAA -OperatorExtension 50100 -AfterHoursTransferToOperatorEnabled $true

Set-UMAutoAttendant -Identity MyUMAutoAttendant -BusinessHoursSchedule 0.10:45-0.13:15,1.09:00-1.17:00,6.09:00-6.16:30 -HolidaySchedule "New Year,newyrgrt.wav,1/2/2006","Building Closed for Construction,construction.wav,4/24/2006,4/28/2006"

Return to top

The Enable-UMAutoAttendant cmdlet enables an existing Unified Messaging auto attendant that is disabled.

Enable-UMAutoAttendant -Identity <UMAutoAttendantIdParameter> [-DomainController <Fqdn>]

The Enable-UMAutoAttendant cmdlet lets you enable an existing UM auto attendant that is currently disabled. The Enable-UMAutoAttendant cmdlet enables the UM auto attendant by modifying its status variable.

To run the Enable-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the identifier for the UM Auto Attendant object that is being disabled.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example enables a UM auto attendant named MyUMAutoAttendant.

Code

Enable-UMAutoAttendant -Identity MyUMAutoAttendant

Return to top

The Disable-UMAutoAttendant cmdlet disables an existing Unified Messaging auto attendant that is enabled.

Disable-UMAutoAttendant -Identity <UMAutoAttendantIdParameter> [-DomainController <Fqdn>]

The Disable-UMAutoAttendant cmdlet lets you disable an existing UM auto attendant that is currently enabled. The Disable-UMAutoAttendant cmdlet disables the UM auto attendant by modifying its status variable. The Disable-UMAutoAttendant cmdlet cannot disable the UM auto attendant if it is linked or associated to the UM hunt group that is associated with the default UM dial plan.

To run the Disable-UMAutoAttendant cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the identifier for the UM auto attendant that is being disabled.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example disables a UM auto attendant named MyUMAutoAttendant.

Code

Disable-UMAutoAttendant -Identity MyUMAutoAttendant

Return to top

The Copy-UMCustomPrompt cmdlet validates and then copies a .wav audio file from a specified location to the UM prompt publishing point on a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging server role installed. You can also use this cmdlet to copy a .wav audio file from the UM prompt publishing point to a file.

Copy-UMCustomPrompt -Path <String> -UMDialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>]

Copy-UMCustomPrompt -Path <String> -UMAutoAttendant <UMAutoAttendantIdParameter> [-DomainController <Fqdn>]

Copy-UMCustomPrompt -UMDialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>]

Copy-UMCustomPrompt -UMAutoAttendant <UMAutoAttendantIdParameter> [-DomainController <Fqdn>]

The Copy-UMCustomPrompt cmdlet is used to validate and then copy a .wav audio file to the UM prompt publishing point. The UM prompt publishing point is a shared folder that is created on the first Unified Messaging server that is installed and is used to distribute UM custom prompts to other Unified Messaging servers in the Exchange 2007 organization. The Copy-UMCustomPrompt cmdlet supports the use of UM custom audio prompts by copying the specified audio file to the correct location for distribution to other Unified Messaging servers in the Exchange 2007 organization.

Unified Messaging servers access the UM prompt publishing point at set intervals and copy the necessary .wav audio files to their local installation folder. After the file has been copied locally to the Unified Messaging server, the Unified Messaging server can provide the audio for a given custom prompt when it is required by the telephone user interface (TUI).

To run the Copy-UMCustomPrompt cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Path

Required

System.String

This parameter specifies the full path and name of the source file. The source file is the file that will be copied to the UM prompt publishing point.

UMAutoAttendant

Required

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the identifier for the UM auto attendant. This identifier is the directory object ID for the UM auto attendant.

UMDialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the identifier for the UM dial plan. This identifier is the directory object ID for the UM dial plan. This parameter is not required if the UMAutoAttendant parameter is used.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the command.

Description

The first example copies the prompt file that is named Main Welcome.wav into the directory C:\Prompts so that it can be used as a set of custom prompts for the UM dial plan named Contoso. The prompt that is copied replaces the default welcome greeting for the dial plan. Therefore, the Copy-UMCustomPrompt cmdlet should be followed by the Set-UMDialPlan cmdlet. This sets the WelcomeGreetingFilename property to the value Campus Main Welcome.wav.

The second example copies the prompt file that is named Tech Support Menu.wav in the current working directory into the set of custom prompts for the auto attendant that is named Technical Support. The prompt that is copied replaces the custom menu prompt that is used during business hours. Therefore, the Copy-UMCustomPrompt cmdlet should be followed by the Set-UMAutoAttendant cmdlet. This sets the BusinessHoursMainMenuFilename property to the value Tech Support Menu.wav.

Code

Copy-UMCustomPrompt -Path "C:\Prompts\Main Welcome.wav" -UMDialPlan Contoso

Copy-UMCustomPrompt -Path "Tech Support Menu.wav" -UMAutoAttendant "Technical Support"

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging dial plans by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging dial plans:

  • New-UMDialplan

  • Remove-UMDialplan

  • Get-UMDialplan

  • Set-UMDialplan

Return to top

The New-UMDialplan cmdlet creates a new Unified Messaging dial plan that is used to establish a link between UM IP gateways, UM hunt groups, and Unified Messaging servers to enable communication between UM components.

New-UMDialPlan -Name <String> -NumberOfDigitsInExtension <Int32> [-AccessTelephoneNumbers <MultiValuedProperty>] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-GenerateUMMailboxPolicy <$true | $false>] [-NDREnabled <$true | $false>] [-TemplateInstance <PSObject>] [-URIType <TelExtn | E164 | SipName>] [-VoIPSecurity <SIPSecured | Unsecured>]

The New-UMDialplan cmdlet is used to create a new UM dial plan in Active Directory. A UM dial plan object has an organization-wide scope and contains all configuration information that is related to a telephony dial plan. A UM dial plan is a required component for establishing Unified Messaging communications with Microsoft Exchange Server 2007. When you create a new UM dial plan, you must have a good understanding of telephony configurations and the implications of adding to or modifying a UM configuration.

noteNote:
After the new UM dial plan is created, a UM IP gateway and a Unified Messaging server must be associated with the UM dial plan to enable UM operations.

To run the New-UMDialplan cmdlet, the account you use must be delegated the following Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Name

Required

System.String

This parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters.

NumberOfDigitsInExtension

Required

System.Int32

This parameter specifies the fixed number of digits in an extension number. The range for this parameter is 3 to 7.

AccessTelephoneNumbers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the telephone number or numbers that will be used for subscriber access. These numbers are sometimes referred to as pilot or pilot ID numbers. The telephone number is limited to 32 characters.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

FaxEnabled

Optional

System.Boolean

This parameter specifies whether the users who are associated with the UM dial plan can receive fax messages. The default setting is $true.

GenerateUMMailboxPolicy

Optional

System.Boolean

This parameter specifies whether a default UM mailbox policy will be created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created.

NDREnabled

Optional

System.Boolean

This parameter specifies whether UM call answering messages that are submitted will request non-delivery notifications. The default setting is $false.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to this parameter, the cmdlet will use the configuration of that object to create an identical copy of the object on a local or target server.

UriType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMUriType

This parameter specifies the integer that represents the Uniform Resource Identifier (URI) type to be sent and received with Session Initiation Protocol (SIP) messages from the Private Branch eXchange (PBX).

VoIPSecurity

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType

This parameter specifies whether the signaling channel is encrypted using MTLS. The default setting is UnSecured.

Description

The first example creates a new UM dial plan named MyUMDialPlan that uses four-digit extension numbers.

The second example creates a new UM dial plan named MyUMDialPlan that uses five-digit extension numbers that supports SIP URIs.

The third example creates a new unsecured UM dial plan named MyUMDialPlan that supports E164 numbers.

Code

New-UMDialplan -Name MyUMDialPlan -NumberofDigits 4

New-UMDialplan -Name MyUMDialPlan -UriType SIPName -NumberofDigits 5

New-UMDialplan -Name MyUMDialPlan -UriType E164 -NumberofDigits 5 -VOIPSecurity Unsecured

Return to top

The Remove-UMDialplan cmdlet deletes an existing Unified Messaging (UM) dial plan.

Remove-UMDialPlan -Identity <UMDialPlanIdParameter> [-DomainController <Fqdn>]

The Remove-UMDialplan cmdlet is used to delete an existing UM dial plan from Active Directory. The administrator must make sure that the UM dial plan is not being used by other UM objects such as UM mailbox policies or UM IP gateways. When you are deleting an existing UM dial plan, the cmdlet verifies that the specified UM dial plan is not referenced by a Unified Messaging server, UM IP gateway, or UM mailbox policies. The only benefit gained from deleting an obsolete UM dial plan is to reuse the name or perform general Active Directory housekeeping.

To run the Remove-UMDialplan cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the identifier for the UM dial plan that is being deleted. This is the directory object ID for the UM dial plan.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example deletes an existing UM dial plan named MyUMDialPlan.

Code

Remove-UMDialplan -Identity MyUMDialPlan

Return to top

The Get-UMDialplan cmdlet displays the properties of a single Unified Messaging (UM) dial plan, or returns a list of all UM dial plans associated with a Unified Messaging server.

Get-UMDialPlan [-Identity <UMDialPlanIdParameter>] [-DomainController <Fqdn>]

The Get-UMDialplan cmdlet lets you view all properties for a UM dial plan. This cmdlet can be executed to view the values set. When the Get-UMDialplan cmdlet is run, if no parameter is supplied, the cmdlet will return all UM dial plans in the Active Directory forest.

To run the Get-UMDialplan cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan ID. This parameter specifies the directory object identifier for the UM dial plan.

Description

The first code example displays a list of all the UM dial plans in the Active Directory forest.

The second code example displays a formatted list of properties for a UM dial plan named MyUMDialPlan.

Code

Get-UMDialPlan -Identity MYDomainDialPlan
Get-UMDialPlan -Identity MyUMDialPlan | format-list

Return to top

The Set-UMDialplan cmdlet can be used to set various properties on a Unified Messaging dial plan.

Set-UMDialPlan -Identity <UMDialPlanIdParameter> [-AccessTelephoneNumbers <MultiValuedProperty>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AudioCodec <G711 | Wma | Gsm>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallSomeoneEnabled <$true | $false>] [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>] [-ConfiguredInternationalGroups <MultiValuedProperty>] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | Extension | AutoAttendantLink | AddressList>] [-CountryOrRegionCode <String>] [-DefaultLanguage <UMLanguage>] [-DialByNamePrimary <LastFirst | FirstLast | SMTPAddress>] [-DialByNameSecondary <LastFirst | FirstLast | SMTPAddress | None>] [-DomainController <Fqdn>] [-EquivalenceDialPlan <Guid>] [-Extension <String>] [-FaxEnabled <$true | $false>] [-FDSPollingInterval <Int32>] [-InCountryOrRegionNumberFormat <NumberFormat>] [-InfoAnnouncementEnabled <True | False | Uninteruptible>] [-InfoAnnouncementFilename <String>] [-InputFailuresBeforeDisconnect <Int32>] [-InputRetries <Int32>] [-InputTimeout <Int32>] [-InternationalAccessCode <String>] [-InternationalNumberFormat <NumberFormat>] [-LogonFailuresBeforeDisconnect <Int32>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias>] [-MaxCallDuration <Int32>] [-MaxRecordingDuration <Int32>] [-Name <String>] [-NationalNumberPrefix <String>] [-NDREnabled <$true | $false>] [-OperatorExtension <String>] [-OutsideLineAccessCode <String>] [-PromptPublishingPoint <String>] [-RecordingIdleTimeout <Int32>] [-SendVoiceMsgEnabled <$true | $false>] [-TUIPromptEditingEnabled <$true | $false>] [-UMAutoAttendant <UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured | Unsecured>] [-WelcomeGreetingEnabled <$true | $false>] [-WelcomeGreetingFilename <String>]

Set-UMDialPlan [-AccessTelephoneNumbers <MultiValuedProperty>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AudioCodec <G711 | Wma | Gsm>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallSomeoneEnabled <$true | $false>] [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>] [-ConfiguredInternationalGroups <MultiValuedProperty>] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan | GlobalAddressList | Extension | AutoAttendantLink | AddressList>] [-CountryOrRegionCode <String>] [-DefaultLanguage <UMLanguage>] [-DialByNamePrimary <LastFirst | FirstLast | SMTPAddress>] [-DialByNameSecondary <LastFirst | FirstLast | SMTPAddress | None>] [-DomainController <Fqdn>] [-EquivalenceDialPlan <Guid>] [-Extension <String>] [-FaxEnabled <$true | $false>] [-FDSPollingInterval <Int32>] [-InCountryOrRegionNumberFormat <NumberFormat>] [-InfoAnnouncementEnabled <True | False | Uninteruptible>] [-InfoAnnouncementFilename <String>] [-InputFailuresBeforeDisconnect <Int32>] [-InputRetries <Int32>] [-InputTimeout <Int32>] [-Instance <UMDialPlan>] [-InternationalAccessCode <String>] [-InternationalNumberFormat <NumberFormat>] [-LogonFailuresBeforeDisconnect <Int32>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias>] [-MaxCallDuration <Int32>] [-MaxRecordingDuration <Int32>] [-Name <String>] [-NationalNumberPrefix <String>] [-NDREnabled <$true | $false>] [-OperatorExtension <String>] [-OutsideLineAccessCode <String>] [-PromptPublishingPoint <String>] [-RecordingIdleTimeout <Int32>] [-SendVoiceMsgEnabled <$true | $false>] [-TUIPromptEditingEnabled <$true | $false>] [-UMAutoAttendant <UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured | Unsecured>] [-WelcomeGreetingEnabled <$true | $false>] [-WelcomeGreetingFilename <String>]

The Set-UMDialplan cmdlet lets you change or modify the properties of an existing UM dial plan. Some UM dial plan properties are required and are created by default. However, in some cases, after the UM dial plan is created, not all properties for the UM dial plan are writable. Therefore, some of the properties cannot be changed unless the existing UM dial plan is deleted and a new one is created.

importantImportant:
UM dial plans are important to the operation of Unified Messaging. Modifications to an existing UM dial plan should be performed by an administrator who understands the implications of changes to UM dial plans.

To run the Set-UMDialplan cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes to dial plans and Unified Messaging servers to dial plans.

AccessTelephoneNumbers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to the administrator when a user is being enabled for Unified Messaging.

AllowDialPlanSubscribers

Optional

System.Boolean

This parameter specifies whether to let subscribers dial numbers that resolve to a subscriber within the same dial plan. The default is $true.

AllowedInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name that is specified in the UM dial plan.

AllowedInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the list of international dial group names that are allowed. The international dial group name must match the group name that is specified in the dial plan.

AllowExtensions

Optional

System.Boolean

This parameter specifies whether to allow calls to dial plan extensions. The default is $false.

AudioCodec

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum

This parameter specifies the audio codec that is used for recording. WMA is the default setting.

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

This parameter specifies whether speech recognition is enabled for users who are members of the dial plan.

CallSomeoneEnabled

Optional

System.Boolean

This parameter specifies whether the Call Someone feature is enabled.

ConfiguredInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the in-country groups that can be used. Each string consists of four parts:

  • A group name (up to 32 characters)

  • AllowedNumberString

  • DialNumberString

  • TextComment

ConfiguredInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the international groups that can be used. Each string consists of four parts:

  • A group name (up to 32 characters)

  • AllowedNumberString

  • DialNumberString

  • TextComment

ContactAddressList

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

This parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, it will define the scope for directory searches.

ContactRecipientContainer

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This is the name or identity of the container that will be used for directory searches.

ContactScope

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.CallSomeoneScopeEnum

This parameter specifies the scope of the directory search that will be given to callers when they access the UM dial plan and specify a user's name

CountryOrRegionCode

Optional

System.String

This parameter specifies the country or region code for a given country or region. This is the number that will be dialed for a specific country or region. For example, 1 in the United States.

DefaultLanguage

Optional

Microsoft.Exchange.Data.UMLanguage

This parameter specifies the default language of the system. This default language is selected from the list of available languages. The default is US English.

DialByNamePrimary

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialByNamePrimaryEnum

This parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default is Last, First name.

DialByNameSecondary

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialByNameSecondaryEnum

This parameter specifies that the secondary Dial by Name lookup key is to be created from the specified source. The default is SMTP.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

EquivalenceDialPlan

Optional

System.Guid

This parameter specifies the name of the equivalency dial plan in another forest. When a telephony dial plan spans two forests and when a second dial plan object is created, the GUID from the original dial plan is copied to the user's proxy address in the other forest.

Extension

Optional

System.String

This parameter specifies the extension number that is used by the Call Someone feature when a call is transferred.

FaxEnabled

Optional

System.Boolean

This parameter specifies whether the system supports faxing. The Unified Messaging server will not load the fax components if the dial plan does not support faxing. The default is $true.

FDSPollingInterval

Optional

System.Int32

The interval, in minutes, between checks for new content made by the File Distribution Service on the publishing point. The range is from 1 to 1440 minutes. The default is 5 minutes.

InCountryOrRegionNumberFormat

Optional

Microsoft.Exchange.Data.NumberFormat

This parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from inside the same country or region code.

InfoAnnouncementEnabled

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.InfoAnnouncementEnabledEnum

This parameter specifies whether an informational announcement is enabled. This parameter can be set to Enabled, Disabled, or Uninterruptible. The default is $true.

InfoAnnouncementFilename

Optional

System.String

This parameter specifies the audio file name for an informational announcement.

InputFailuresBeforeDisconnect

Optional

System.Int32

This parameter specifies the number of sequential user input errors that will be allowed before the call is disconnected. The default is 3.

InputRetries

Optional

System.Int32

This parameter specifies the number of times a caller can re-enter input when the system times out. This applies to authenticated users and also call answering or auto attendant users. The default is 3.

InputTimeout

Optional

System.Int32

This parameter specifies the length of time that the system will wait for user input. This time limit applies to authenticated users and also call answering or auto attendant users. The default is 5 seconds.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMDialPlan

This parameter specifies the input parameter that represents a new dial plan object.

InternationalAccessCode

Optional

System.String

This parameter specifies the code that is pre-appended to a telephone number to dial international calls. For example, 011 to call the United States.

InternationalNumberFormat

Optional

Microsoft.Exchange.Data.NumberFormat

This parameter specifies the prefix string to use, and the number of digits to take from the directory, when dialing into this dial plan from a different country code.

LogonFailuresBeforeDisconnect

Optional

System.Int32

This parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default is 3.

MatchedNameSelectionMethod

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DisambiguationFieldEnum

This parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following:

  • Department

  • Title

  • Location

  • None

  • Prompt for alias

  • Inherited from UM dial plan

MaxCallDuration

Optional

System.Int32

This parameter specifies the maximum length of time that a call can last before it is interrupted and the call is dropped. The default is 30 minutes.

MaxRecordingDuration

Optional

System.Int32

This parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes.

Name

Optional

System.String

This parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters.

NationalNumberPrefix

Optional

System.String

This parameter specifies the code that is pre-appended to a telephone number to dial out-of-area, in-country calls. For example, 1 in North America.

NDREnabled

Optional

System.Boolean

This parameter specifies whether UM call answering messages that are submitted will request non-delivery reports (NDRs). If this parameter is set to $false, messages will be submitted without requests for NDRs. The default is $false.

OperatorExtension

Optional

System.String

This parameter specifies the extension number of the operator. If this parameter is not specified, the Do Not Allow Transfer to the Operator feature will be unavailable.

OutsideLineAccessCode

Optional

System.String

This parameter specifies the code that is pre-appended to a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default is 9.

PromptPublishingPoint

Optional

System.String

This parameter specifies the Windows file shares path of the server and share where custom prompts will reside. The default path is set to the first Unified Messaging server when it is added to a UM dial plan.

RecordingIdleTimeout

Optional

System.Int32

This parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default is 5 seconds.

SendVoiceMsgEnabled

Optional

System.Boolean

This parameter specifies whether the Send Message feature is enabled.

TUIPromptEditingEnabled

Optional

System.Boolean

This parameter specifies whether authorized users are permitted to record UM dial plan or automated attendant prompts by using the telephone user interface (TUI). The default setting is $false.

UMAutoAttendant

Optional

Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter

This parameter specifies the auto attendant that is executed when the caller presses the star key (*). If this parameter is specified, it will override the Call Someone feature.

VoIPSecurity

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType

This parameter specifies whether the signaling channel is encrypted by using MTLS. The default setting is UnSecured.

WelcomeGreetingEnabled

Optional

System.Boolean

This parameter specifies whether a custom Welcome greeting is enabled. The default is $false.

WelcomeGreetingFilename

Optional

System.String

This parameter specifies the audio file name for the welcome greeting.

Description

The first example configures a UM dial plan named MyUMDialPlan to use 9 for the outside line access code.

The second example configures a UM dial plan named MyUMDialPlan to use a welcome greeting.

The third example configures a UM dial plan named MyUMDialPlan with dialing rules.

Code

Set-UMDialPlan -Identity MyDialPlan -OutsideLineAccessCode 9

Set-UMDialPlan -Identity MyDialPlan -WelcomeGreetingEnabled $true -WelcomeGreetingFilename welcome.wav

$csv=import-csv "C:\MyInCountryGroups.csv"
Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryGroups $csv
Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryGroups "local, long distance"

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging hunt groups by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging hunt groups:

  • New-UMHuntGroup

  • Remove-UMHuntGroup

  • Get-UMHuntGroup

Return to top

The New-UMHuntGroup cmdlet creates a new Unified Messaging hunt group that is used to link incoming calls to a specific UM dial plan.

New-UMHuntGroup -Name <String> -PilotIdentifier <String> -UMDialPlan <UMDialPlanIdParameter> -UMIPGateway <UMIPGatewayIdParameter> [-DomainController <Fqdn>] [-TemplateInstance <PSObject>]

The New-UMHuntGroup cmdlet creates a new UM hunt group in Active Directory. Running this cmdlet enables all Unified Messaging servers that are associated with UM dial plans to communicate with an IP/VoIP gateway. A UM hunt group must be created to allow communication between a UM IP gateway and a UM dial plan.

To run the New-UMHuntGroup cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Name

Required

System.String

This parameter specifies the UM hunt group name that is used for display purposes. This string can contain as many as 64 characters, and it must be unique.

PilotIdentifier

Required

System.String

This parameter specifies the number string that is used to uniquely identify the pilot access number for the specified IP gateway. This number must match the subscriber access number that is configured in the UM dial plan.

UMDialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan that will be used with the UM hunt group.

UMIPGateway

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the UM IP gateway to be associated with the UM hunt group.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to this parameter, the cmdlet will use the configuration of that object to create an identical copy of the object on a local or target server.

Description

The first example creates a UM hunt group named MyUMHuntGroup that has a pilot identifier of 12345.

The second example creates a UM hunt group named MyUMHuntGroup that has multiple pilot identifiers.

Code

New-UMHuntGroup -Name MyUMHuntGroup -PilotIdentifier 12345  -UMDialplan MyUMDialPlan -UMIPGateway MyUMIPGateway

New-UMHuntGroup -Name MyUMHuntGroup -PilotIdentifier 5551234,55555 -UMDialplan MyUMDialPlan -UMIPGateway MyUMIPGateway

Return to top

The Remove-UMHuntGroup cmdlet removes and deletes an existing Unified Messaging hunt group.

Remove-UMHuntGroup -Identity <UMHuntGroupIdParameter> [-DomainController <Fqdn>]

The Remove-UMHuntGroup cmdlet deletes an existing UM hunt group from the Active Directory directory service. When the Remove-UMHuntGroup cmdlet is used, the UM hunt group is removed from the UM IP gateway and then deleted from Active Directory. If the operation leaves the UM IP gateway without any remaining configured UM hunt groups, the IP/VoIP gateway will be unable to handle or process UM calls.

To run the Remove-UMHuntGroup cmdlet, the account you use must be delegated the Exchange Organization Administrator role,

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMHuntGroupIdParameter

This parameter specifies the identifier for the UM hunt group that is being deleted. This is the directory object ID for the UM hunt group object.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the cmdlet.

Description

This example deletes a UM hunt group named MyUMHuntGroup.

Code

Remove-UMHuntGroup -Identity MyUMHuntGroup

Return to top

The Get-UMHuntGroup cmdlet displays the properties and values for an existing Unified Messaging hunt group.

Get-UMHuntGroup [-Identity <UMHuntGroupIdParameter>] [-DomainController <Fqdn>]

The Get-UMHuntGroup cmdlet retrieves the properties for a single UM hunt group or a list of UM hunt groups. If only the UMIPGateway parameter is specified, the cmdlet will return all UM hunt groups that are associated with the UM IP gateway. If only the Identity parameter is specified, the properties for the UM hunt group are returned. If neither parameter is specified, all UM hunt groups in the Active Directory forest will be returned.

To run the Get-UMHuntGroup cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.UMHuntGroupIdParameter

This parameter specifies the identifier for the UM hunt group that is being viewed. This is the directory object ID for the UM hunt group.

Description

The first example displays all the UM hunt groups in the Active Directory forest.

The second example displays the details of a UM Hunt Group named MyUMHuntGroup in a formatted list.

Code

Get-UMHuntGroup

Get-UMHuntGroup -Identity MyUMHuntGroup | format-list

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging IP gateways by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging IP gateways:

  • New-UMIPGateway

  • Remove-UMIPGateway

  • Get-UMIPGateway

  • Set-UMIPGateway

  • Enable-UMIPGateway

  • Disable-UMIPGateway

Return to top

The New-UMIPGateway cmdlet creates a new Unified Messaging IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP/VoIP gateway or a Session Initiation Protocol (SIP)-enabled IP/PBX.

New-UMIPGateway -Name <String> -Address <UMSmartHost> [-DomainController <Fqdn>] [-TemplateInstance <PSObject>] [-UMDialPlan <UMDialPlanIdParameter>]

The New-UMIPGateway cmdlet creates a new UM IP gateway. A UM IP gateway has organization-wide scope and references a single physical IP/VoIP gateway. The new UM IP gateway that is created is used to establish a connection to an IP/VoIP gateway or a SIP-enabled IP/PBX.

To run the New-UMIPGateway cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Address

Required

Microsoft.Exchange.Data.UMSmartHost

This parameter specifies the IP address that is configured on the IP/VoIP gateway or SIP-enabled IP/PBX.

Name

Required

System.String

This parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to this parameter, the cmdlet will use the configuration of that object to create an identical copy of the object on a local or target server.

UMDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan to be associated with the UM IP gateway.

Description

The first code example creates a new UM IP gateway named MyUMIPGateway that will enable a Unified Messaging server to start accepting calls from an IP/VoIP gateway that has an IP address of 10.10.10.1.

The second code example creates a new UM IP gateway named MyUMIPGateway that will enable a Unified Messaging server to start accepting calls from an IP/VoIP gateway that has an FQDN of MyIPGateway.contoso.com.

Code

New-UMIPGateway -Name MyUMIPGateway -Address 10.10.10.1

New-UMIPGateway -Name MyUMIPGateway -Address "MyUMIPGateway.contoso.com"

Return to top

The Remove-UMIPGateway cmdlet deletes a Unified Messaging IP gateway.

Remove-UMIPGateway -Identity <UMIPGatewayIdParameter> [-DomainController <Fqdn>]

The Remove-UMIPGateway cmdlet deletes a specified UM IP gateway. After the UM IP gateway is deleted, Unified Messaging servers will no longer accept new call requests from the IP/VoIP gateway. The Remove-UMIPGateway cmdlet should be run only by an administrator who fully understands the implications of disabling communication with a SIP-enabled IP/PBX or IP/VoIP gateway.

To run the Remove-UMIPGateway cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the identifier for the UM IP gateway that is being deleted. This parameter specifies the directory object ID for the UM IP gateway.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example deletes a UM IP gateway named MyUMIPGateway.

Code

Remove-UMIPGateway -Identity MyUMIPGateway 

Return to top

The Get-UMIPGateway cmdlet returns a list of properties and values for a specified UM IP gateway or for a list of UM IP gateways.

Get-UMIPGateway [-Identity <UMIPGatewayIdParameter>] [-DomainController <Fqdn>] [-IncludeSimulator <SwitchParameter>]

The Get-UMIPGateway cmdlet displays the properties and values for a specified UM IP gateway, such as the display name, the IP address, status, and outcall settings. If no parameter is specified, all UM IP gateways in the Active Directory forest will be returned.

To run the Get-UMIPGateway cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the identifier for the UM IP gateway that is being viewed. This parameter is the directory object ID for the UM IP gateway.

IncludeSimulator

Optional

System.Management.Automation.SwitchParameter

This parameter retrieves the simulator of the UM IP gateway that is being viewed. A simulator allows a client to connect to the Unified Messaging server. This connection is typically used with the Exchange UM Test Phone application.

Description

The first example displays a formatted list of all the UM IP gateways in the Active Directory forest.

The second example displays the properties for a UM IP gateway named MyUMIPGateway.

The third example displays all the UM IP gateways including IP/VoIP gateway simulators in the Active Directory forest.

Code

Get-UMIPGateway |format-list

Get-UMIPGateway -Identity MyUMIPGateway

Get-UMIPGateway -IncludeSimulator $true

Return to top

The Set-UMIPGateway cmdlet is used to modify the configuration settings for a single Unified Messaging IP gateway or return a list of configuration settings that can be modified on a given UM IP gateway.

Set-UMIPGateway -Identity <UMIPGatewayIdParameter> [-Address <UMSmartHost>] [-DomainController <Fqdn>] [-Name <String>] [-OutcallsAllowed <$true | $false>] [-Port <Int32>] [-Simulator <$true | $false>] [-Status <Enabled | Disabled | NoNewCalls>]

Set-UMIPGateway [-Address <UMSmartHost>] [-DomainController <Fqdn>] [-Instance <UMIPGateway>] [-Name <String>] [-OutcallsAllowed <$true | $false>] [-Port <Int32>] [-Simulator <$true | $false>] [-Status <Enabled | Disabled | NoNewCalls>]

The Set-UMIPGateway cmdlet modifies configuration settings for a given UM IP gateway, for example, the IP address to the IP/VoIP gateway. These modifications include allowing outgoing calls and controlling communications with a SIP-enabled IP/PBX or IP/VoIP gateway.

importantImportant:
It is possible that modifications to the UM IP gateway settings may disrupt communication between Unified Messaging servers and the SIP-enabled or IP/PBX IP gateway. Modifications to a UM IP Gateway object should be performed only by an administrator who fully understands the implications of making configuration changes to the UM IP gateway.

To run the Set-UMIPGateway cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the identifier for the UM IP gateway that is being modified. This parameter is the directory object ID for the UM IP gateway.

Address

Optional

Microsoft.Exchange.Data.UMSmartHost

 This parameter specifies the IP address that is configured on the IP gateway or SIP-enabled IP/PBX.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMIPGateway

This parameter specifies the input parameter that represents a new IP gateway.

Name

Optional

System.String

This parameter specifies the display name that will be used for the UM IP gateway. This display name is limited to 64 characters.

OutcallsAllowed

Optional

System.Boolean

This parameter specifies whether to allow this IP Gateway object to be used for outgoing calls. This does not govern call transfers.

Port

Optional

System.Int32

This parameter specifies the IP port on which the IP/VoIP gateway or IP/PBX is listening. By default, it is port 5060. The range for this parameter is 0 to 65535.

Simulator

Optional

System.Boolean

This parameter specifies the simulator that will be used for the UM IP gateway that is being viewed. A simulator allows a client to connect to the Unified Messaging server. This connection is typically used in the Exchange Test Phone application.

Status

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.GatewayStatus

This parameter specifies whether to enable or disable the UM IP gateway.

Description

The first code example modifies the IP address of a UM IP gateway named MyUMIPGateway.

The second code example prevents the UM IP gateway from accepting incoming calls and prevents outgoing calls.

The third example enables the UM IP Gateway to function as an IP/VoIP simulator.

Code

Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1

Set-UMIPGateway -Identity MyUMIPGateway -Address 10.10.10.1 -Status 2 -OutcallsAllowed $false

Set-UMIPGateway -Identity MyUMIPGateway -Simulator $true

Return to top

The Enable-UMIPGateway cmdlet enables a Unified Messaging IP gateway.

Enable-UMIPGateway -Identity <UMIPGatewayIdParameter> [-DomainController <Fqdn>]

The Enable-IPGateway cmdlet modifies the status variable on a UM IP gateway that exists in Active Directory. You can control the operation of the UM IP gateway by setting its status variable. The status variable for the UM IP gateway can be used to enable or disable calls that are destined for the IP/VoIP gateway.

To run the Enable-IPGateway cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the identifier for the IP gateway that is being enabled. This is the directory object ID for the UM IP gateway.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example enables a UM IP gateway named MyUMIPGateway.

Code

Enable-UMIPGateway -Identity MyUMIPGateway

Return to top

The Disable-UMIPGateway cmdlet disables a Unified Messaging IP gateway.

Disable-UMIPGateway -Identity <UMIPGatewayIdParameter> [-DomainController <Fqdn>] [-Immediate <$true | $false>]

The status variable for a UM IP gateway can be used to enable or disable call answering that is destined for the IP/VoIP gateway. The Disable-IPGateway cmdlet disables a UM IP gateway in Active Directory by modifying its status variable.

To run the Disable-IPGateway cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the identifier for the UM IP gateway that is being disabled. This is the directory object ID for the UM IP gateway.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Immediate

Optional

System.Boolean

This parameter specifies whether the Unified Messaging server will drop calls that are associated with this UM IP gateway immediately or wait for the current calls to finish processing.

Description

The first example disables a UM IP gateway named MyUMIPGateway and stops it from accepting incoming calls from the IP/VoIP gateway.

The second example disables a UM IP gateway named MyUMIPGateway and disconnects all current calls immediately.

Code

Disable-UMIPGateway -Identity MyUMIPGateway

Disable-UMIPGateway -Identity MyUMIPGateway -Immediate $true

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging recipient mailboxes by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging recipient mailboxes:

  • Enable-UMMailbox

  • Disable-UMMailbox

  • Get-UMMailbox

  • Set-UMMailbox

Return to top

The Enable-UMMailbox cmdlet enables Unified Messaging for an existing mail-enabled user.

Enable-UMMailbox -Identity <MailboxIdParameter> -UMMailboxPolicy <MailboxPolicyIdParameter> [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-DomainController <Fqdn>] [-Extensions <MultiValuedProperty>] [-NotifyEmail <String>] [-PilotNumber <String>] [-Pin <String>] [-PinExpired <$true | $false>] [-SIPResourceIdentifier <String>] [-ValidateOnly <SwitchParameter>]

The Enable-UMMailbox cmdlet enables Unified Messaging for an existing mail-enabled Exchange 2007 user. When the mail-enabled user is enabled for Unified Messaging, the settings from a UM mailbox policy are applied to the user. After the user is enabled for Unified Messaging, they can use the UM features that are included with Exchange 2007.

To run the Enable-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.

UMMailboxPolicy

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the name of the Unified Messaging mailbox policy to be associated with the user.

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

This parameter enables Automatic Speech Recognition (ASR) to be used with the UM mailbox. ASR is only available if the user's specified language preference is installed.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Extensions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. If this parameter is not included, a default telephone number value from Active Directory is used.

NotifyEmail

Optional

System.String

This parameter specifies the e-mail address to which the server will send the e-mail message that contains the Unified Messaging welcome information. By default, the message is sent to the SMTP address of the enabled user.

PilotNumber

Optional

System.String

This parameter specifies the subscriber access number that the user can dial to gain access to their mailbox. The default value is the subscriber access number that is specified on a Dial Plan object in Active Directory.

PIN

Optional

System.String

This parameter specifies the value for the initial PIN to be used with the UM mailbox. The PIN will be checked against the UM mailbox policy rules. The PIN value must be between 4-24 numeric characters. If no PIN is specified, a PIN generated by the system will be e-mailed to the user. The PIN generated by the system contains 6 numeric characters, the default.

PINExpired

Optional

System.Boolean

This parameter specifies whether the PIN will be treated as expired. If this parameter is supplied and is set to $false, the user will not be required to reset their PIN the next time that they log on. If the PIN is not supplied, the PIN will be treated as expired and the user will be prompted to reset their PIN the next time that they log on.

SIPResourceIdentifier

Optional

System.String

This parameter specifies the SIP address for the user. This property will be compared to the Uniform Resource Identifier (URI) format that is defined on the UM dial plan.

ValidateOnly

Optional

System.Management.Automation.SwitchParameter

This parameter specifies to check all the prerequisites needed to successfully run the cmdlet without actually performing an action.

Description

The first example enables Unified Messaging on the mailbox for yanli@contoso.com, sets the extension and PIN for the user, and then assigns a UM mailbox policy named MyUMMailboxPolicy to the user’s mailbox.

The second example enables Unified Messaging on a SIP-enabled mailbox for yanli@contoso.com, associates a UM mailbox policy named MYUMMailboxPolicy, and sets the extension number, SIP Resource identifier, and PIN for the user.

Code

Enable-UMMailbox -Identity yanli@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -NotifyEmail administrator@contoso.com -PINExpired $true

Enable-UMMailbox -Identity yanli@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -NotifyEmail administrator@contoso.com -SIPResourceIdentifier "yanli@contoso.com" -PINExpired $true

Return to top

The Disable-UMMailbox cmdlet disables Unified Messaging (UM) for a UM-enabled recipient.

Disable-UMMailbox -Identity <MailboxIdParameter> [-DomainController <Fqdn>] [-KeepProperties <$true | $false>]

The Disable-UMMailbox cmdlet disables Unified Messaging for an Exchange 2007 recipient who is currently UM-enabled. After the task has finished running, Unified Messaging servers will no longer handle calls for the extension number that is associated with the mailbox. You can continue to use the Exchange 2007 mailbox for all other operations that are not related to Unified Messaging.

To run the Disable-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

KeepProperties

Optional

System.Boolean

This parameter specifies whether the mailbox and directory resident properties should be retained. If this parameter is not included, the user's Unified Messaging properties will be retained.

Description

This example disables Unified Messaging on the mailbox for yanli@contoso.com.

Code

Disable-UMMailbox -Identity yanli@contoso.com

Return to top

The Get-UMMailbox cmdlet displays the Unified Messaging (UM) properties for a recipient who is UM-enabled.

Get-UMMailbox [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

Get-UMMailbox [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

Get-UMMailbox [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

The Get-UMMailbox cmdlet retrieves the UM properties for a single UM mailbox. It can also return a list of UM-enabled mailboxes.

To run the Get-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Anr

Optional

System.String

This parameter specifies a string on which to perform an ambiguous name resolution search. You can specify a partial string and search for objects that have an attribute that matches that string. The default attributes that are searched are as follows:

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

Credential

Optional

System.Management.Automation.PSCredential

This parameter specifies the user name and password to use to access the Active Directory directory service.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the cmdlet.

Filter

Optional

System.String

This parameter lets you filter the results returned by the cmdlet.

For more information about the filterable properties, see Filterable Properties for the -Filter Parameter in Exchange 2007 RTM.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This parameter specifies an organizational unit (OU) and is used to limit the results. If you use this parameter, you will retrieve only mailboxes in the container that you specify. You can use the OU or the domain name. If you use the OU, you must specify the canonical name of the OU.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter specifies that the user information will be read from a domain controller in the user's domain. If you have set the recipient scope to include all recipients in the forest and if you do not use this parameter, the user information may be read from a global catalog whose information is outdated. If you do use this parameter, multiple reads may be necessary to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

This parameter lets you specify a maximum number of results to be returned. Otherwise a maximum number is not specified and the cmdlet will return all results.

SortBy

Optional

System.String

This parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. You can sort by the following attributes:

  • Alias

  • DisplayName

  • Name

The results will be sorted in ascending order.

Description

The first code example displays a list of all the UM-enabled mailboxes in the Active Directory forest in a formatted list.

The second code example displays the UM mailbox properties for yanli@contoso.com.

Code

Get-UMMailbox | format-list

Get-UMMailbox -Identity yanli@contoso.com

Return to top

The Set-UMMailbox cmdlet sets the Unified Messaging properties for a user who is currently UM-enabled.

Set-UMMailbox -Identity <MailboxIdParameter> [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm>] [-DisplayName <String>] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-MissedCallNotificationEnabled <$true | $false>] [-Name <String>] [-OperatorNumber <String>] [-SubscriberAccessEnabled <$true | $false>] [-TUIAccessToAddressBookEnabled <$true | $false>] [-TUIAccessToCalendarEnabled <$true | $false>] [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <MailboxPolicyIdParameter>]

Set-UMMailbox [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm>] [-DisplayName <String>] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-Instance <UMMailbox>] [-MissedCallNotificationEnabled <$true | $false>] [-Name <String>] [-OperatorNumber <String>] [-SubscriberAccessEnabled <$true | $false>] [-TUIAccessToAddressBookEnabled <$true | $false>] [-TUIAccessToCalendarEnabled <$true | $false>] [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <MailboxPolicyIdParameter>]

The Set-UMMailbox cmdlet lets you set UM properties that are associated with a user who has been UM-enabled. Many of the UM properties for the user are stored on the user’s mailbox, and other UM properties for the user are stored in Active Directory. This cmdlet can be used to set UM properties individually by using either the Identity parameter or the Instance parameter.

To run the Set-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.

AllowUMCallsFromNonUsers

Optional

Microsoft.Exchange.Data.Directory.Recipient.AllowUMCallsFromNonUsersFlags

This parameter specifies whether to exclude the mailbox from directory searches.

AnonymousCallersCanLeaveMessages

Optional

System.Boolean

This parameter specifies whether diverted calls without a caller ID will be allowed to leave a message.

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

This parameter specifies whether the user can use ASR when they log on to their mailbox This parameter can only be set to $true if there is ASR support for the language selected by the user in Outlook Web Access Options.

CallAnsweringAudioCodec

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum

This parameter specifies the audio codec to use for call answering messages. The default for the user's mailbox is the audio codec that is configured on the UM dial plan.

DisplayName

Optional

System.String

This parameter specifies the display name for the user.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

FaxEnabled

Optional

System.Boolean

This parameter specifies whether a user is allowed to receive incoming faxes.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.UMMailbox

The Instance parameter specifies the object input parameter. The Instance parameter is required if the Identity parameter is not used.

MissedCallNotificationEnabled

Optional

System.Boolean

This parameter specifies whether to send missed call notifications.

Name

Optional

System.String

This parameter specifies the display name for the user. The display name is limited to 64 characters.

OperatorNumber

Optional

System.String

This parameter specifies the string of digits for the personal operator.

SubscriberAccessEnabled

Optional

System.Boolean

This parameter specifies whether the user is allowed subscriber access to their individual mailbox. If it is set to $true, the user, after they are authenticated, will be able to retrieve voice mail over the telephone.

TUIAccessToAddressBookEnabled

Optional

System.Boolean

This parameter specifies whether a user can access the directory and contact information over the telephone.

TUIAccessToCalendarEnabled

Optional

System.Boolean

This parameter specifies whether a user can access their individual calendaring over the telephone.

TUIAccessToEmailEnabled

Optional

System.Boolean

This parameter specifies whether a user can access their individual e-mail over the telephone.

UMMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the UM mailbox policy that is associated with the UM-enabled user's mailbox.

Description

The first example modifies the secondary address and UM dial plan for yanli@contoso.com.

The second example prevents the user from accessing their calendar and e-mail when they are using Outlook Voice Access.

The third example modifies the properties of a UM mailbox for yanli@contoso.com.

Code

Set-UMMailbox -Identity yanli@contoso.com

Set-UMMailbox -Identity yanli@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false

Set-UMMailbox -Identity yanli@contoso.com -DialPlan MyUMDialPlan -UMMailboxPolicy MyUMMailboxPolicy -FaxEnabled $true

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging mailbox PINs by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging mailbox PINs:

  • Get-UMMailboxPIN

  • Set-UMMailboxPIN

Return to top

The Get-UMMailboxPIN cmdlet returns information from a UM-enabled user's mailbox.

Get-UMMailboxPin [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>]

The Get-UMMailboxPIN cmdlet returns information that is calculated from the PIN data that is stored in encrypted form in the user’s mailbox. By using the Get-UMMailboxPIN cmdlet, you can view information from the user's mailbox. You can also use this cmdlet to show whether the mailbox or user access has been locked out.

To run the Get-UMMailboxPIN cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Credential

Optional

System.Management.Automation.PSCredential

This parameter specifies the user name and password to use to access the Active Directory directory service.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the identifier that can be used to retrieve information about the mailbox. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter specifies that the user information will be read from a domain controller in the user's domain. If you have set the recipient scope to include all recipients in the forest and if you do not use this parameter, the user information may be read from a global catalog whose information is outdated. If you do use this parameter, multiple reads may be necessary to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

This parameter lets you specify a maximum number of results to be returned. If a maximum number is not specified, the cmdlet will return all results.

Description

The first code example displays the Unified Messaging mailbox PIN properties for all UM-enabled users.

The second code example displays the Unified Messaging mailbox PIN related properties for yanli@contoso.com.

Code

Get-UMMailboxPIN
Get-UMMailboxPIN -Identity yanli@contoso.com

Return to top

The Set-UMMailboxPIN cmdlet resets the PIN for a UM-enabled mailbox.

Set-UMMailboxPIN -Identity <MailboxIdParameter> [-DomainController <Fqdn>] [-LockedOut <$true | $false>] [-NotifyEmail <String>] [-Pin <String>] [-PinExpired <$true | $false>]

The Set-UMMailboxPIN cmdlet is used when a UM-enabled user has been locked out of their mailbox because they tried to log on by using an incorrect PIN multiple times or because they have forgotten their PIN. You can use this cmdlet to set the user's PIN. The new PIN must comply with the PIN policy rules that are specified on the user's mailbox policy. The new PIN will be sent to the user in e-mail, or sent to an alternative e-mail address. You can control whether the user must reset the PIN at logon, and if the mailbox will continue to be locked.

To run the Set-UMMailboxPIN cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.

DomainController

Optional

.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the cmdlet.

LockedOut

Optional

System.Boolean

This parameter specifies whether the mailbox will continue to be locked. If set to $true, the mailbox will be marked as locked out. By default, if this parameter is omitted or set to $false, the task will clear the locked out status on a mailbox.

NotifyEmail

Optional

System.String

This parameter specifies the e-mail address to which the server will send the e-mail message that contains the PIN reset information. By default, the message is sent to the SMTP address of the enabled user.

Pin

Optional

System.String

This parameter specifies a new PIN for use with this mailbox. The PIN will be checked against the PIN rules that are defined in the UM policy. If the PIN is not supplied, the task will generate a new PIN for the mailbox and include it in an e-mail message sent to the user.

PINExpired

Optional

System.Boolean

This parameter specifies whether the PIN will be treated as expired. If this parameter is supplied and is set to $false, the user will not be required to reset their PIN the next time that they log on. If the PIN is not supplied, the PIN will be treated as expired and the user will be prompted to reset their PIN the next time that they log on.

Description

The first example resets the PIN on the UM-enabled mailbox for yanli@contoso.com.

The second example resets the initial PIN on the UM-enabled mailbox for yanli@contoso.com to 1985848 and then sets the PIN as expired so that the user will be asked to change the PIN the next time that they log on.

The third example locks the UM-enabled mailbox for yanli@contoso.com to prevent the user from accessing their mailbox.

The fourth example unlocks the UM-enabled mailbox for yanli@contoso.com and allows them to access to their mailbox.

Code

Set-UMMailboxPIN -Identity yanli@contoso.com

Set-UMMailboxPIN -Identity yanli@contoso.com -PIN 1985848 -PinExpired $true

Set-UMMailboxPIN -Identity yanli@contoso.com -LockedOut $true

Set-UMMailboxPIN -Identity yanli@contoso.com -LockedOut $false

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging mailbox policies by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging mailbox policies:

  • New-UMMailboxPolicy

  • Remove-UMMailboxPolicy

  • Get-UMMailboxPolicy

  • Set-UMMailboxPolicy

Return to top

The New-UMMailboxPolicy cmdlet creates a new Unified Messaging (UM) mailbox policy.

New-UMMailboxPolicy -Name <String> -UMDialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>] [-TemplateInstance <PSObject>]

The New-UMMailboxPolicy cmdlet creates a new UM mailbox policy that has organization-wide scope. UM mailbox policies provide a set of policy values to be applied to UM-enabled users who are associated with a particular UM dial plan. UM mailbox policies are directly associated with UM dial plans. Therefore, the settings that are contained within a UM mailbox policy apply only to UM-enabled users of the UM dial plan to which the UM mailbox policy is associated. You can also use the New-UMMailboxPolicy cmdlet to create a UM mailbox policy template that can be used to create additional UM mailbox policies.

To run the New-UMMailboxPolicy cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Name

Required

System.String

This parameter specifies the display name for the UM mailbox policy. The name for the UM mailbox policy can contain as many as 64 characters.

UMDialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the identifier for the UM dial plan to be associated with the UM mailbox policy. This parameter is the directory object ID for the UM dial plan.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to this parameter, the cmdlet will use the configuration of that object to create an identical copy of the object on a local or target server.

Description

This example creates a new UM mailbox policy named MyUMMailboxPolicy that is associated with a UM dial plan named MyUMDialPlan.

Code

New-UMMailboxPolicy -Name MyUMMailboxPolicy -UMDialPlan MyUMDialPlan

Return to top

The Remove-UMMailboxPolicy cmdlet deletes a Unified Messaging mailbox policy.

Remove-UMMailboxPolicy -Identity <MailboxPolicyIdParameter> [-DomainController <Fqdn>]

The Remove-UMMailboxPolicy cmdlet is used to delete or remove a UM mailbox policy. If the UM mailbox policy is deleted from Active Directory, the UM mailbox policy cannot be used when configuring UM-enabled users. The UM mailbox policy cannot be deleted if the UM mailbox policy is referenced by any UM-enabled mailboxes.

To run the Remove-UMMailboxPolicy cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the identifier for the UM dial plan that is being deleted. This parameter is the directory object ID for the UM dial plan.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the cmdlet.

Description

This example deletes a UM mailbox policy named MyUMMailboxPolicy.

Code

Remove-UMMailboxPolicy -Identity MyUMMailboxPolicy

Return to top

The Get-UMMailboxPolicy cmdlet displays the properties and values of a Unified Messaging mailbox policy.

Get-UMMailboxPolicy [-Identity <MailboxPolicyIdParameter>] [-DomainController <Fqdn>]

The Get-UMMailboxPolicy cmdlet retrieves the configuration properties and values for a UM mailbox policy or returns a list of UM mailbox policies. If the Identity parameter is supplied, the properties and values for the specified UM mailbox policy object are returned. If no parameter is specified at the command line, all UM mailbox policies in the Active Directory forest are returned.

To run the Get-UMMailboxPolicy cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the identifier for the UM mailbox policy that is being viewed. This is the directory object ID for the UM mailbox policy.

Description

The first code example returns a formatted list of all UM mailbox policies in the Active Directory forest.

The second code example returns the properties and values for a UM mailbox policy named MyUMMailboxPolicy and in a formatted list.

Code

Get-UMMailboxPolicy | format-list

Get-UMMailboxPolicy -Identity MyUMMailboxPolicy

Return to top

The Set-UMMailboxPolicy cmdlet modifies a Unified Messaging (UM) mailbox policy.

Set-UMMailboxPolicy -Identity <MailboxPolicyIdParameter> [-AllowCommonPatterns <$true | $false>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AllowMissedCallNotifications <$true | $false>] [-DomainController <Fqdn>] [-FaxID <String>] [-FaxMessageText <String>] [-LogonFailuresBeforePINReset <Unlimited>] [-MaxGreetingDuration <Int32>] [-MaxLogonAttempts <Unlimited>] [-MinPINLength <Int32>] [-Name <String>] [-PINHistoryCount <Int32>] [-PINLifetime <Unlimited>] [-ResetPINText <String>] [-UMDialPlan <UMDialPlanIdParameter>] [-UMEnabledText <String>] [-VoiceMailText <String>]

Set-UMMailboxPolicy [-AllowCommonPatterns <$true | $false>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AllowMissedCallNotifications <$true | $false>] [-DomainController <Fqdn>] [-FaxID <String>] [-FaxMessageText <String>] [-Instance <UMMailboxPolicy>] [-LogonFailuresBeforePINReset <Unlimited>] [-MaxGreetingDuration <Int32>] [-MaxLogonAttempts <Unlimited>] [-MinPINLength <Int32>] [-Name <String>] [-PINHistoryCount <Int32>] [-PINLifetime <Unlimited>] [-ResetPINText <String>] [-UMDialPlan <UMDialPlanIdParameter>] [-UMEnabledText <String>] [-VoiceMailText <String>]

When the Set-UMMailboxPolicy cmdlet is used to modify UM Mailbox Policy objects, you can change settings such as PIN policies, message text settings, and dialing restrictions for a single UM-enabled recipient or multiple UM-enabled recipients. UM mailbox policies are associated with UM-enabled mailboxes and can be configured to increase the level of security for UM-enabled users.

To run the Set-UMMailboxPolicy cmdlet, the account you use must be delegated the Exchange Organization Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the identifier for the UM mailbox policy that is being modified. This is the directory object ID for the UM mailbox policy.

AllowCommonPatterns

Optional

System.Boolean

This parameter specifies whether to allow obvious PINs. For example, subsets of the telephone number, sequential numbers, or repeated numbers. If set to $false, sequential and repeated numbers and the suffix of the mailbox extension will be rejected. If set to $true, only the suffix of the mailbox extension will be rejected.

AllowDialPlanSubscribers

Optional

System.Boolean

This parameter specifies whether to let subscribers in a dial plan dial a number that resolves to another subscriber within the same dial plan. The default is $true.

AllowedInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies whether to let subscribers dial the list of in-country/region dial group names. The names that subscribers are allowed to dial must match the group names that are defined in the UM dial plan. The string is limited to 128 characters or fewer.

AllowedInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies whether to let subscribers dial the list of international dial group names. The names subscribers dial must match the group names that are defined in the dial plan.

AllowExtensions

Optional

System.Boolean

This parameter specifies whether to let subscribers dial calls to the number of digits that are specified on the UM dial plan. The default is $true.

AllowMissedCallNotifications

Optional

System.Boolean

This parameter specifies if missed call notifications will be enabled for users who are associated with the UM mailbox policy.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

FaxId

Optional

System.String

This parameter specifies the fax identifier.

FaxMessageText

Optional

System.String

This parameter specifies the text that is included in the body part of fax messages. This text is limited to 512 characters.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMMailboxPolicy

This parameter specifies the object input parameter. This parameter is required if the Identity parameter is not used.

LogonFailuresBeforePINReset

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to Unlimited. If this parameter is not set to Unlimited, it must be set to less than MaxLogonAttempts. The range is 0 to 999. The default setting is 5.

MaxGreetingDuration

Optional

System.Int32

This parameter specifies the maximum greeting length. The range is 1 to 10 minutes. The default is 5 minutes.

MaxLogonAttempts

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the number of times a user can try unsuccessfully to log on, in sequence, before the UM mailbox is locked. The range is 1 to 999. The default is 15.

MinPINLength

Optional

System.Int32

This parameter specifies the minimum number of digits that are required in a PIN for UM-enabled users. The range is 4 to 24. The default is 6.

Name

Optional

System.String

This parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters.

PINHistoryCount

Optional

System.Int32

This parameter specifies the number of previous PINs that will be remembered and will not be allowed during a PIN reset. This number includes the first time that the PIN was set. The range is 1 to 20. The default is 5.

PINLifetime

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the number of days until a new password is required. The range is 1 to 999. The default is 60. If you specify Unlimited, the users' PIN will not expire.

ResetPINText

Optional

System.String

This parameter specifies the text to be included in the PIN-reset e-mail message. This text is limited to 512 characters.

UMDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan to associate with the UM mailbox policy.

UMEnabledText

Optional

System.String

This parameter specifies the text to be included in the UM-enabled e-mail message. This text is limited to 512 characters.

VoiceMailText

Optional

System.String

This parameter specifies the text to be included in the body part of voice messages. The parameter applies to call answering messages in addition to messages that are originated by an authenticated subscriber. This text is limited to 512 characters.

Description

The first example sets the PIN settings for users that are associated with a UM mailbox policy named MyUMMailboxPolicy.

The second example selects the in-country or region groups and international groups from those configured on the UM dial plan that is associated with the UM mailbox policy. UM enabled users associated with this UM mailbox policy will be able to place outbound calls according to the rules defined on these groups.

The third example configures the text of fax and voice messages that are sent to UM-enabled users and the text that is included in an e-mail that is sent to a user that has been UM-enabled.

Code

Set-UMMailboxPolicy -identity MyUMMailboxPolicy -LogonFailuresBeforePINReset 8 -MaxLogonAttempts 12 -MinPINLength 8-PINHistoryCount 10 -PINLifetime 60 -ResetPINText "The PIN that is used to allow you access to your mailbox using Outlook Voice Access has been reset." 

Set-UMMailboxPolicy -identity MyUMMailboxPolicy -AllowDialPlanSubscribers $true -AllowedInCountryOrRegionGroups InCountry/RegionGroup1,InCount/RegionGroup2 -AllowedInternationalGroups InternationalGroup1,InternationalGroup2 -AllowExtensions $true 

Set-UMMailboxPolicy -identity MyUMMailboxPolicy -FaxID "Sent by Microsoft Exchange 2007 Unified Messaging." -FaxMessageText "You have received a fax message from Exchange 2007 Unified Messaging." -UMEnabledText "You have been enabled for Unified Messaging." -VoiceMailText "You have received a voice message from Microsoft Exchange 2007 Unified Messaging." 

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging servers by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging servers:

  • Enable-UMServer

  • Disable-UMServer

  • Get-UMServer

  • Set-UMServer

Return to top

The Enable-UMServer cmdlet sets the status of a Unified Messaging server to enabled. This enables the Unified Messaging server to process UM calls.

Enable-UMServer -Identity <UMServerIdParameter> [-DomainController <Fqdn>]

The Enable-UMServer cmdlet sets the status of a Unified Messaging server. A Unified Messaging server has a logical status variable that is controlled by using the enable and disable cmdlets. A Unified Messaging server will not process any new calls unless it is in the enabled state. The status variable lets you start or stop call processing on a Unified Messaging server so that the Unified Messaging server can be brought online or taken offline in a controlled way.

To run the Enable-UMServer cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

This parameter specifies the identifier for the Unified Messaging server that is being enabled. This is the directory object ID for the Unified Messaging server.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Description

This example enables Unified Messaging on the Unified Messaging server that is named MyUMServer.

Code

Enable-UMServer -Identity MyUMServer

Return to top

The Disable-UMServer cmdlet sets the status of a Unified Messaging server to disabled. This prevents the Unified Messaging server from processing UM calls.

Disable-UMServer -Identity <UMServerIdParameter> [-DomainController <Fqdn>] [-Immediate <$true | $false>]

The Disable-UMServer cmdlet sets the status of a Unified Messaging server. A Unified Messaging server has a logical status variable that is controlled by using the enable and disable cmdlets. A Unified Messaging server will not process any new calls unless it is in the enabled state. This status variable lets an administrator start or stop call processing on a Unified Messaging server so that the Unified Messaging server can be brought online or taken offline in a controlled way.

To run the Disable-UMServer cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

This parameter specifies the identifier for the Unified Messaging server that is being disabled. This is the directory object ID for the UM server object.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Immediate

Optional

System.Boolean

This parameter specifies whether the Unified Messaging server will drop all current calls or enable current calls to finish. If this parameter is set to $true, all calls that are currently connected will be disconnected.

Description

The first example disables Unified Messaging on the Unified Messaging server named MyUMServer but does not disconnect calls that are being processed.

The second example disables Unified Messaging on the Unified Messaging server named MyUMServer and disconnects all calls that are being processed.

Code

Disable-UMServer -Identity MyUMServer

Disable-UMServer -Identity MyUMServer -Immediate $true

Return to top

The Get-UMServer cmdlet displays the properties for a single computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging server role installed or displays a list of servers that are enabled for Unified Messaging.

Get-UMServer [-Identity <UMServerIdParameter>] [-DomainController <Fqdn>]

The Get-UMServer cmdlet retrieves the properties for a Unified Messaging server or returns a list of available Unified Messaging servers from Active Directory. When the cmdlet is used for a single Unified Messaging server, it returns the Unified Messaging server properties including status, MaxCalls, MaxFaxCalls, and UMDialPlans. The properties and their values for the Unified Messaging server are stored in the UM section of the Exchange Server configuration object in Active Directory.

The ExchangeVersion attribute that is returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute is not the same as the version of Microsoft Exchange that is displayed in the Exchange Management Console when you select Server Configuration.

To run the Get-UMServer cmdlet on a computer that has the Unified Messaging server role installed, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

This parameter specifies the name of the Unified Messaging server. If this parameter is not supplied, a list of all Unified Messaging servers will be returned.

Description

The first example displays a list of all the Unified Messaging servers in the Active Directory forest.

The second example displays a formatted list of properties for the Unified Messaging server named MyUMServer.

Code

Get-UMServer

Get-UMServer -Identity MyUMServer | format-list

Return to top

The Set-UMServer cmdlet lets you set the properties on a Unified Messaging server.

Set-UMServer -Identity <UMServerIdParameter> [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-MaxASRSessionsAllowed <Nullable>] [-MaxCallsAllowed <Nullable>] [-MaxFaxCallsAllowed <Nullable>] [-MaxTTSSessionsAllowed <Nullable>] [-Status <Enabled | Disabled | NoNewCalls>]

Set-UMServer [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-Instance <UMServer>] [-MaxASRSessionsAllowed <Nullable>] [-MaxCallsAllowed <Nullable>] [-MaxFaxCallsAllowed <Nullable>] [-MaxTTSSessionsAllowed <Nullable>] [-Status <Enabled | Disabled | NoNewCalls>]

The Set-UMServer cmdlet is used to set specific properties on a Unified Messaging server. This cmdlet can be used to set individual Unified Messaging parameters for a specified Unified Messaging server.

To run the Set-UMServer cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

This parameter specifies the ID for the Unified Messaging server object that is to be configured. This parameter specifies the directory object ID for the UM server. This parameter is required if the Instance parameter is not used.

DialPlans

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies all the dial plans for which this server will handle UM calls. If no dial plans are defined, the Unified Messaging server will not handle UM calls.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the cmdlet.

GrammarGenerationSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

This parameter specifies the scheduled times to start speech grammar re-generation. This parameter allows only one start time per day.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.UMServer

This parameter specifies the object input parameter. This parameter is required if the Identity parameter is not used.

MaxASRSessionsAllowed

Optional

System.Nullable

This parameter specifies the maximum number of concurrent ASR sessions.

MaxCallsAllowed

Optional

System.Nullable

This parameter specifies the maximum number of concurrent calls that the Unified Messaging server will allow.

MaxFaxCallsAllowed

Optional

System.Nullable

This parameter specifies the maximum number of concurrent fax calls that the Unified Messaging server will allow.

MaxTTSSessionsAllowed

Optional

System.Nullable

This parameter specifies the maximum number of concurrent Text-to-Speech (TTS) sessions that the Unified Messaging server will allow.

Status

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ServerStatus

This parameter lets the administrator manipulate the Unified Messaging server status. Enabled, Disabled, and NoNewCalls are the available options.

Description

The first code example prevents a Unified Messaging server named MyUMServer from accepting new calls.

The second code example removes a Unified Messaging server named MyUMServer from all UM dial plans.

The third code example adds the Unified Messaging server named MyUMServer to a UM dial plan named MyUMDialPlanName and also sets the maximum number of incoming voice and fax calls.

The fourth code example changes the grammar generation schedule to 2:30-3:00 every day on a Unified Messaging server named MyUMServer.

Code

Set-UMServer -Identity MyUMServer -Status NoNewCalls

Set-UMServer -Identity MyUMServer -DialPlans $null

Set-UMServer -Identity MyUMServer -DialPlans MyUMDialPlanName -MaxCalls 50 -MaxFaxCalls 15

Set-UMServer -Identity MyUMServer -GrammarGenerationSchedule 1.02:30-1.03:00, 2.02:30-2.03:00, 3.02:30-3.03:00, 4.02:30-4.03:00, 5.02:30-5.03:00, 6.02:30-6.03:00

Return to top

This section provides information that will help you troubleshoot and monitor Microsoft Exchange Server 2007 Unified Messaging (UM) by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to troubleshoot and monitor Unified Messaging:

  • Test-UMConnectivity

  • Get-UMActiveCalls

Return to top

The Get-UMActiveCalls cmdlet returns information about the calls that are active and being processed by the Unified Messaging server.

Get-UMActiveCalls [-DomainController <Fqdn>] [-Server <ServerIdParameter>]

Get-UMActiveCalls -InstanceServer <UMServer> [-DomainController <Fqdn>]

Get-UMActiveCalls -DialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>]

Get-UMActiveCalls -IPGateway <UMIPGatewayIdParameter> [-DomainController <Fqdn>]

The Get-UMActiveCalls cmdlet returns information about the active calls that are being processed. If the Get-UMActiveCalls cmdlet specifies either the UM dial plan or UM IP gateway, it will look in the Active Directory directory service to determine which Unified Messaging servers must be contacted. If the Unified Messaging server is specified in the command line, the Get-UMActiveCalls cmdlet returns the active calls that are being processed by the server that is specified.

noteNote:
When a Unified Messaging server is process cycling, the Get-UMActiveCalls cmdlet will not return a list of all calls for both the discontinued process and the active process. It will return the active calls only for the new process.

To run the Get-UMActiveCalls cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

DialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan for which you want to retrieve active calls.

InstanceServer

Required

Microsoft.Exchange.Data.Directory.Management.UMServer

This parameter specifies the Unified Messaging server for which you want to retrieve active calls.

IPGateway

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the UM IP gateway for which you want to retrieve active calls.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

This parameter specifies the Unified Messaging server for which you want to retrieve active calls.

Description

The first code example displays the details of all active calls on the local Unified Messaging server.

The second code example displays the details of all active calls on a Unified Messaging server named MyUMServer.

The third code example displays details of all active calls that are being processed by a UM IP gateway named MyUMIPGateway.

The fourth code example displays a list of active calls that are associated with the UM dial plan named MyUMDialPlan.

Code

Get-UMActiveCalls

Get-UMActiveCalls -Server MyUMServer

Get-UMActiveCalls -IPGateway MyUMIPGateway

Get-UMActiveCalls -DialPlan MyUMDialPlan

Return to top

The Test-UMConnectivity cmdlet can be used to test the operation of a computer that has the Unified Messaging server role installed.

test-UMConnectivity [-DomainController <Fqdn>] [-Fax <$true | $false>] [-ListenPort <Int32>] [-MonitoringContext <$true | $false>] [-Secured <$true | $false>] [-Timeout <Int32>]

test-UMConnectivity -ResetPIN <$true | $false> [-DomainController <Fqdn>] [-MonitoringContext <$true | $false>]

test-UMConnectivity -Phone <String> -UMIPGateway <UMIPGatewayIdParameter> [-DomainController <Fqdn>] [-Fax <$true | $false>] [-ListenPort <Int32>] [-MonitoringContext <$true | $false>] [-Secured <$true | $false>] [-Timeout <Int32>]

test-UMConnectivity -TUILogonAll <$true | $false> [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MonitoringContext <$true | $false>] [-Secured <$true | $false>] [-Timeout <Int32>]

test-UMConnectivity -Phone <String> -PIN <String> -TUILogon <$true | $false> -UMDialPlan <UMDialPlanIdParameter> [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MonitoringContext <$true | $false>] [-Secured <$true | $false>] [-Timeout <Int32>]

The two diagnostic tests are designed to test the operation of the Microsoft Exchange Server 2007 Unified Messaging server software (mode 1) and the operation of the whole system that includes the connected telephony components (mode 2).

The Test-UMConnectivity cmdlet can be used to test the operation of a Unified Messaging server and related connected telephony equipment. When an administrator runs this cmdlet and includes the IPGateway parameter, the Unified Messaging server tests the full end-to-end operation of the UM system. This includes the telephony components that are connected to the Unified Messaging server, such as IP gateways, Private Branch eXchanges (PBXs), and cabling. If the IPGateway parameter is not specified, the Unified Messaging server will test only the operation of the UM components that are installed and configured on the server.

To run the Test-UMConnectivity cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Phone

Required

System.String

This parameter specifies the telephone number that will be used when the test call is redirected. The extension number should be configured in the PBX to call forward to the UM hunt group.

PIN

Required

System.String

This parameter lets you specify the PIN that is associated with the UM-enabled mailbox.

TUILogon

Required

System.Boolean

This parameter specifies whether you want the cmdlet to try to log on to one or more UM-enabled mailboxes. The mailboxes must be UM-enabled and associated with the UM dial plan to which the Unified Messaging server belongs. The default setting is false.

TUILogonAll

Required

System.Boolean

This parameter specifies whether to test all mailboxes in the current Active Directory site then test connectivity to each UM-enabled mailbox. The default setting is false.

UMIPGateway

Required

Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter

This parameter specifies the name of the UM IP gateway or IP/PBX to use for the outgoing test call.

UMDialPlan

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter specifies the UM dial plan that will be tested. It must be used with the TUILogin parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

Fax

Optional

System.Boolean

This parameter specifies that the call being tested is a fax call. The default setting is $true.

ListenPort

Optional

System.Int32

This parameter specifies the IP port number on which to listen. If not specified, IP port 9000 will be used.

MonitoringContext

Optional

System.Boolean

This parameter specifies whether the cmdlet will run at a command line or whether the output object will be passed to Microsoft Operations Manager. By default, the cmdlet will run from the command line.

Secured

Optional

System.Boolean

This parameter specifies whether the test will be run in secured mode.

Timeout

Optional

System.Int32

This parameter specifies the length of time to wait for the test operation to finish (in seconds). The default is 180 seconds. You can set this parameter with a value of less than 5 seconds. However, we recommend that you always configure this parameter with a value of 5 seconds or more.

ResetPIN

Required

System.Boolean

This parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

Description

The first example performs connectivity and operational tests on the local Unified Messaging server and then displays the Voice over IP (VoIP) connectivity information.

The second example tests the ability of the local Unified Messaging server to use an unsecured Transmission Control Protocol (TCP) connection instead of a secured Mutual Transport Layer Security (MTLS) connection to place a call through a UM IP gateway named MyUMIPGateway by using the telephone number 56780.

Code

Test-UMConnectivity

Test-UMConnectivity -UMIPGateway MyUMIPGateway -Phone 56780 -Secured $false

Return to top

This section provides information that will help you manage Microsoft Exchange Server 2007 Unified Messaging virtual directories by using the Exchange Management Shell.

The following are the Exchange Management Shell cmdlets that you can use to manage Unified Messaging virtual directories:

  • New-UMVirtualDirectory

  • Remove-UMVirtualDirectory

  • Get-WebServicesVirtualDirectory

  • Set-WebServicesVirtualDirectory

Return to top

The New-UMVirtualDirectory cmdlet lets you create a new virtual directory on the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

New-UMVirtualDirectory [-ApplicationRoot <String>] [-AppPoolId <String>] [-BasicAuthentication <$true | $false>] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-TemplateInstance <PSObject>] [-WebSiteName <String>] [-WindowsAuthentication <$true | $false>]

The New-UMVirtualDirectory cmdlet lets you create a new Unified Messaging virtual directory on the Exchange 2007 Client Access server. You can create a single or multiple UM virtual directories.

To run the New-UMVirtualDirectory cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

ApplicationRoot

Optional

System.String

Use this parameter to specify the Web site path that is defined in the Internet Information Service (IIS) metabase. By default, it is set to /W3SVC/1/ROOT, where 1= the default Web site.

AppPoolId

Optional

System.String

Use this parameter to specify the IIS application pool name. This setting can be configured in <SERVERNAME>\Application Pools on the Web site in IIS Manager. By default, it is set to MSExchangeUMAppPool.

BasicAuthentication

Optional

System.Boolean

Use this parameter to specify whether to enable Basic authentication on the virtual directory.

DigestAuthentication

Optional

System.Boolean

Use this parameter to specify whether to enable Digest authentication on the virtual directory.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

ExternalUrl

Optional

System.Uri

Use this parameter to specify the host name that will be used to connect to the Exchange server from outside the perimeter network.

InternalUrl

Optional

System.Uri

Use this parameter to specify the host name of the Exchange server host for connection from inside the perimeter network.

Path

Optional

System.String

Use this parameter to specify the local path on the Client Access server where the UMWebservice files are located. The default location is %ExchangeInstallDir%\UnifiedMessaging\WebService.

TemplateInstance

Optional

System.Management.Automation.PSObject

If an existing object is supplied to this parameter, the command will use the configuration of that object to create an identical copy of the object on a local or target server

WebSiteName

Optional

System.String

Use this parameter to specify the name of the Web site under which to create the new virtual directory. This parameter should not be used when you are creating a new virtual directory under the default Web site.

WindowsAuthentication

Optional

System.Boolean

Use this parameter to specify whether to enable Windows Integrated authentication on the virtual directory.

Description

This code example creates a new Unified Messaging virtual directory named MyUMWeb.

Code

New-UMVirtualDirectory -MyUMWeb -WebsiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/UMwebservices.aspx"

Return to top

The Remove-UMVirtualDirectory cmdlet removes an existing virtual directory from a computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

Remove-UMVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-DomainController <Fqdn>]

The Remove-UMVirtualDirectory cmdlet removes an existing virtual directory from an Exchange 2007 Unified Messaging server. You can remove the default Exchange Unified Messaging Web Services virtual directory or another Exchange Unified Messaging Web Services virtual directory.

To run the Remove-UMVirtualDirectory cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

Use this parameter to specify the name of the virtual directory that you are removing.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the FQDN of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command

Description

This code example removes the virtual directory named UnifiedMessaging from the server named MyCASServer1.

Code

Remove-UMVirtualDirectory -Identity MyCASServer1\UnifiedMessaging

Return to top

The Get-UMVirtualDirectory cmdlet retrieves the configuration settings for a Unified Messaging virtual directory on a computer that is running Microsoft Exchange 2007 that has the Client Access server role installed.

Get-UMVirtualDirectory [-Identity <VirtualDirectoryIdParameter>] [-DomainController <Fqdn>]

Get-UMVirtualDirectory -Server <ServerIdParameter> [-DomainController <Fqdn>]

The Get-UMVirtualDirectory cmdlet retrieves the configuration settings for a Unified Messaging virtual directory on an Exchange 2007 Client Access server.

The Get-UMVirtualDirectory cmdlet can be run on a local server, or run remotely if the server name is specified in the Identity or Server parameters. It can also be run without parameters to retrieve the configuration settings from all Outlook Web Access virtual directories on all Internet Information Services (IIS) Web sites that are located on the Client Access servers in the organization.

The Get-UMVirtualDirectory cmdlet can be run on any server that has the Exchange Server administration tools installed. The account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

Use this parameter to specify the name or GUID of the server that hosts the virtual directories that you want to display.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

Use this parameter to specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. Include the DomainController parameter in the cmdlet.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

Use this parameter to specify either the GUID of the server, the name of the Web site, or the name of the virtual directory that you want to display.

Description

The first code example returns the settings for the virtual directory named UnifiedMessaging under the default Web site in IIS.

The second code example retrieves all settings for the UnifiedMessaging virtual directories on a server named CAS01.

Code

Get-UMVirtualDirectory
Get-UMVirtualDirectory -Identity CAS01

Return to top

The Set-UMVirtualDirectory cmdlet lets you modify an existing Exchange Unified Messaging virtual directory on an Exchange 2007 computer that has the Client Access server role installed.

Set-UMVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-BasicAuthentication <$true | $false>] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-WindowsAuthentication <$true | $false>]

Set-UMVirtualDirectory [-BasicAuthentication <$true | $false>] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Instance <ADUMVirtualDirectory>] [-InternalUrl <Uri>] [-WindowsAuthentication <$true | $false>]

The Set-UMVirtualDirectory cmdlet lets you modify an existing Exchange Web Services virtual directory on an Exchange 2007 Client Access server.

To run the Set-UMVirtualDirectory cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server:

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

Use this parameter to specify the name of the virtual directory. You can also specify a wildcard character instead of the Default Web site.

BasicAuthentication

Optional

System.Boolean

Use this parameter to specify whether Basic authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with FormsAuthentication, or with DigestAuthentication and WindowsAuthentication.

DigestAuthentication

Optional

System.Boolean

Use this parameter to specify whether Digest authentication is enabled on the virtual directory.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

Use this parameter to specify the FQDN of the domain controller that retrieves data from Active Directory. Include the DomainController parameter in the cmdlet.

ExternalUrl

Optional

System.Uri

Use this parameter to specify the host name that will be used to connect to the Client Access server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ADUMVirtualDirectory

Use this parameter to pass a whole object to the cmdlet to be processed. It is mainly used in scripts where a whole object must be passed to the cmdlet.

InternalUrl

Optional

System.Uri

Use this parameter to specify the host name of the Client Access server for connections from inside the firewall. This setting is also important when SSL is used.

WindowsAuthentication

Optional

System.Boolean

Use this parameter to specify whether Windows Integrated authentication is permitted on the Unified Messaging virtual directory.

Description

The first code example sets the authentication method to Digest authentication for the virtual directory named UnifiedMessaging on the server named UMserver1. This code example also sets the external and internal URLs for this virtual directory.

The second code example uses a wildcard character instead of "default Web site".

Code

Set-UMVirtualDirectory -Identity UMServer1\UnifedMessaging -ExternalUrl https://www.contoso.com/UnifiedMessaging/webservices.aspx -ExternalAuthenticationMethods Digest -InternalUrl https://contoso.internal.com/UnifiedMessaging/webservices.aspx
Set-UMVirtualDirectory -Identity UMServer1\UnifedMessaging* -ExternalUrl https://www.contoso.com/UnifiedMessaging/webservices.aspx

Return to top

This section provides information about the options you can configure by using the Exchange Management Console. The Exchange Management Console options that you can use to manage Unified Messaging can be divided into the following categories:

  • Organizational Configuration

  • Server Configuration

  • Recipient Configuration

Return to top

In Exchange Server 2007, the Unified Messaging server role is one of several server roles that you can install and then configure on a computer that is running Exchange 2007. The Unified Messaging server role is new to Microsoft Exchange.

The Unified Messaging server role depends on the Exchange 2007 Hub Transport, Mailbox, and Client Access server roles. For a user to be able to use the Unified Messaging features found in Exchange 2007, they must have an Exchange 2007 mailbox.

Use the Unified Messaging objects and properties to customize your configuration.

noteNote:
To modify how objects are displayed in the MMC, click View in the action pane. For more information about the View options, see Organization Configuration.
UM Dial Plans

Use the UM Dial Plan tab to configure UM dial plans. A UM dial plan is an Active Directory container object that logically represents sets or groupings of Private Branch eXchanges (PBXs) that share common user extension numbers. In practical terms, users' extensions that are hosted on PBXs share a common extension number. Users can dial one another’s telephone extensions without appending a special number to the extension or dialing a full telephone number. A UM dial plan is a logical representation of a telephony dial plan.

UM IP Gateways

Use the UM IP Gateway tab to manage UM hunt groups and other UM IP gateway configuration settings. The UM IP gateway is an Active Directory container object that contains one or more Active Directory UM hunt groups and other UM IP gateway configuration settings. UM IP gateways are created within Active Directory to logically represent a physical hardware device called an IP gateway or VoIP gateway. The UM IP gateway can represent either an IP/VoIP gateway or an IP/PBX. The combination of the IP/VoIP gateway object and a UM hunt group object establishes a logical link between an IP/VoIP gateway hardware device and a UM dial plan.

UM Mailbox Policies

Use the UM Mailbox Policies tab to create, apply, and standardize UM configuration settings. Unified Messaging Active Directory mailbox policies are required when you enable users for Exchange 2007 Unified Messaging. They are useful for applying and standardizing Unified Messaging configuration settings for UM-enabled users. You create UM mailbox policies to apply a common set of policies or security settings to a collection of UM-enabled mailboxes. You use Unified Messaging mailbox policies to set Unified Messaging settings for UM-enabled users, such as the following:

  • PIN policies

  • Dialing restrictions

  • Other general UM mailbox policy properties

For example, you can create a UM mailbox policy to increase the level of PIN security by reducing the maximum number of logon failures for a specific group of UM-enabled users, such as executives.

UM Auto Attendants

Use the UM Auto Attendant tab to configure UM auto attendants. In telephony or Unified Messaging environments, an automated attendant or auto attendant menu system transfers callers to the extension of a user or department without the intervention of a receptionist or a human operator. In many auto attendant systems, a receptionist or operator can be reached by pressing or saying zero. The automated attendant is a feature that is found in most traditional and Unified Messaging telephony environment.

Exchange Server 2007 Unified Messaging enables you to create a single or multiple UM auto attendants, depending on the needs of your organization. Unlike other Unified Messaging objects, such as UM dial plans and UM IP gateways, you are not required to create UM auto attendants. However, auto attendants help internal and external callers locate users or departments that exist in an organization and transfer calls to them.

Return to top

A Unified Messaging dial plan is an Active Directory object that is a logical representation of a Private Branch eXchange (PBX) or telephony dial plan. A UM dial plan is a logical object that establishes a link between the users within a UM dial plan and a telephony network. A dial plan is created by using an organization-wide scope and contains all the configuration information that is related to your telephony network.

  • The result pane enables you to view a subset of properties for a UM dial plan. This includes the UM servers, IP gateways, and mailbox policies that are associated with the UM dial plan.

UM Dial Plan

This column in the result pane lets you view the display name for each dial plan that has been created. If your organization uses multiple dial plans, you should use meaningful names when naming them. The maximum length for a display name is 64 characters and it can contain spaces.

# digits

This column in the result pane lets you view the number of digits found in the extension numbers for the dial plan. You configure the number of digits for the dial plan when you create it.

Associated UM Servers

This column in the result pane lets you view the Unified Messaging servers that are associated with this dial plan. A single or multiple Unified Messaging servers can be associated with a UM dial plan.

Associated UM IP Gateways

This column in the result pane lets you view the UM IP gateways that are associated with the dial plan. After you create a dial plan, you must create at least one UM IP gateway and UM hunt group. The UM IP gateway can be associated with a dial plan by using the New UM IP Gateway wizard.

Associated UM Mailbox Policies

This column in the result pane let you view the UM mailboxes that are associated with the dial plan. When you create a dial plan, a UM mailbox policy is also created. It is associated with the dial plan when the dial plan is created.

Remove

You can use the action pane to remove a UM dial plan. You can optionally right-click the UM dial plan and select Remove from the list of available options. You must first remove any associations with other UM components such as UM mailbox policies, Unified Messaging servers, or UM IP gateways.

Properties

You can use the action pane to view the properties of a dial plan or make changes to the dial plan's configuration. You can optionally right-click the dial plan and select Properties from the list of available options.

After you install the Unified Messaging server role on a server that is running Exchange 2007, you must create, configure, and manage at least one dial plan. After you create the dial plan, you must complete the following tasks:

Return to top

Use the General tab to configure the dial plan settings for Unified Messaging. For example, you can configure UM dial plan settings to include the voice message originator e-mail address, send non-delivery reports, and enable users who are associated with the dial plan to receive faxes. The settings that you configure on the UM dial plan will affect all users who are associated with the dial plan.

Associated servers
  • This section displays the Unified Messaging servers that are associated with a dial plan. The Unified Messaging servers that are listed in this section process incoming calls for users who are associated with the dial plan.

  • Unified Messaging servers can be associated with single or multiple dial plans. You must use the UM Server Settings properties tab in the Unified Messaging server's properties to add a Unified Messaging server to a dial plan.

Associated UM IP gateways
  • This section displays the UM IP gateways that are associated with a dial plan. The UM IP gateways that are listed in this section process incoming calls for users who are associated with the dial plan.

  • A UM hunt group establishes a link between a UM dial plan and a UM IP gateway and can also be associated with a dial plan by first being associated with a UM IP gateway.

  • You can associate a UM IP gateway with a dial plan when you create a UM hunt group.

Number of digits in extension
  • Use this text box to specify the number of digits in the extension numbers for users who are associated with this dial plan. For example, if a user associated with a dial plan dials a 4-digit extension to call another user in the same dial plan, select 4 as the number of digits in the extension.

  • The number of digits for extension numbers is based on the telephony dial plan that is created on a PBX. This is a required field that has a value range from 1 to 20. The typical extension length is from 3 to 7 digits.

  • If your existing telephony environment includes extension numbers, you should specify a number of digits that matches the number of digits in those extensions.

Send a non-delivery report if message delivery fails
  • Select this check box to allow a non-delivery report (NDR) to be sent if the voice message could not be delivered.

  • If you enable this option an NDR will not be sent until you associate the 'Microsoft Exchange' recipient with a mailbox. To associate the 'Microsoft Exchange' recipient to a mailbox, see Set-OrganizationConfig.

  • By default, this option is disabled.

Allow users to receive faxes
  • Select this check box to allow fax messages to be received by users who are associated with the dial plan.

  • If you do not select this check box, all users who are associated with the dial plan will be unable to receive fax messages in their Inbox.

  • By default, this setting is enabled.

After you configure the options on this tab, click Apply to accept the changes.

Return to top

Use the Subscriber Access tab of the UM dial plan that you have selected to configure subscriber access settings for the Unified Messaging dial plan. A subscriber is an internal business user or network user who is enabled for Exchange Server 2007 Unified Messaging. Outlook Voice Access enables subscribers to access their individual mailboxes to retrieve e-mail, voice messages, contacts, and calendaring information by using a telephone.

Welcome greeting
  • This display-only field shows the name of the sound file that will be used for the welcome greeting. Click Modify to specify the audio (.wav) file to use for the welcome greeting. If you do not specify an audio file, callers will hear a default welcome greeting that says, "Welcome, you are connected to Microsoft Exchange."

  • The welcome greeting is used when Outlook Voice Access users or another caller calls the subscriber access number. This audio file is the default greeting for a given UM dial plan. However, you may want to change this greeting and provide another welcome greeting that is specific to your company, such as, "Welcome to Outlook Voice Access for Contoso, Ltd."

  • If you decide to customize this greeting, you must first record the customized greeting, save it as a *.wav file, and then configure the dial plan to use this customized greeting. The file name and path must not exceed 255 characters.

Informational announcement
  • This display-only field shows the name of the sound file to use for the informational announcement. Click Modify to specify the sound (.wav) file to use. By default, no informational announcement is configured. However, you may want to provide one for callers.

  • The informational announcement is used for general announcements that change more frequently than the welcome greeting or for announcements that are required by corporate compliance policies.

  • If you decide to use the informational announcement on the dial plan, you must first record the informational announcement, save it as a .wav file, and then configure the dial plan to use this informational announcement.

  • When it is important that callers hear the whole informational announcement, it can be configured as uninterruptible. This prevents callers from pressing a key or speaking a command to interrupt and stop the informational announcement.

Enter the telephone number to associate
  • Use this field to add a telephone number or extension that a user will call to access the Unified Messaging system by using Outlook Voice Access. In most cases, you will enter an extension number or an external telephone number. However, because this field will accept alphanumeric characters, a SIP URI can be used if you are using an IP/PBX.

  • By default, when a dial plan is created, no subscriber access numbers are configured. To enable subscriber access, you must configure at least one telephone number.

  • When you configure this number on the dial plan, this number will be displayed in the Outlook 2007 and Outlook Web Access for Exchange 2007 voice mail options.

  • The number of alphanumeric characters cannot exceed 20.

For more information about the options that can be configured for the welcome greeting or the informational announcement, see Organization Configuration > Unified Messaging > UM Auto Attendant > Greetings Tab > Greetings Setting Dialog Box later in this white paper.

Return to top

Use the Dial Codes tab to configure the dial codes for a UM dial plan. Several dial code settings can be configured on the dial plan. These include incoming and outgoing calling options.

Outside line access code
  • Use this field to type the number or numbers that are used to access an outside telephone number for outgoing external calls. This number will be prepended to the telephone number that is dialed. This is also called a trunk access code. This field will accept 1-16 digits.

  • For many organizations, this number is 9. By default, this field is not populated.

  • Frequently, this setting is used in telephony environments where a PBX is located onsite or maintained in an organization. It may not have to be configured if your organization's telephony environment is maintained by an external business or vendor.

International access code
  • Use this field to type the number code that is used to access international telephone numbers for outgoing calls. This number will be prepended to the telephone number that is dialed. By default, this field is not populated. This field will accept 1-4 digits.

  • For example, the international access code for the United States is 011; for Europe, it is 00.

National number prefix
  • Use this field to type the number code that is used to dial telephone numbers that are out of an area code but within the country/region. This number will be prepended to the telephone number that is dialed. By default, this field is not populated. This field will accept 1-4 digits

  • For example, 0 is used in Europe and 1 is used in North America.

Country/region code
  • Use this field to type the country/region code number that is to be used for outgoing calls. This number will be prepended to the telephone number that is dialed. By default, this field is not populated. This field will accept 1-4 digits.

  • For example, in the United States the country/region code is 1. In the United Kingdom it is 44.

In-country/region number format
  • Use this field to specify how a user's telephone number should be dialed by the UM Server in a different dial plan, but having the same country code. This is used by an auto attendant and when an Outlook Voice Access subscriber searches and tries to call the user in the directory.

  • This entry consists of a number prefix and n number of x characters (for example, 020xxxxxxx).

  • To determine the telphone number, UM will append the last n-digits from the telephone number that is specified in the directory to the prefix that is specified.

International number format
  • Use this field to specify how a user's telephone number should be dialed by the UM Server in a different dial plan, but having a different country code. This is used by an auto attendant and when an Outlook Voice Access subscriber searches and tries to call the user in the directory.

  • This entry consists of a number prefix and n number of x characters (for example, 4420xxxxxxx).

  • To determine the telphone number, UM will append the last n-digits from the telephone number that is specified in the directory to the prefix that is specified.

Return to top

Use the Features tab to configure the Unified Messaging (UM) dial plan features. Several features can be configured on the UM dial plan. These include transferring calls and sending voice messages.

Allow callers to transfer users
  • Select this check box to enable callers to transfer calls to users. By default, this option is enabled. This lets users associated with the dial plan transfer calls to users in the same UM dial plan. After you select this check box, you can set the group of users to whom callers can transfer by selecting the appropriate option under the Callers can contact section on this page.

  • If you disable this option and disable the Allow callers to send voice message setting, the options under Callers can contact will also be disabled.

Allow callers to send voice message
  • Select this check box to enable callers to send voice messages to users. By default, this option is enabled. This lets users who are associated with the dial plan send voice messages to users in the same UM dial plan. After you select this check box, you can set the group of users to whom callers can send voice messages by selecting the appropriate option under the Callers can contact section on this page.

  • If you disable this option and disable the Allow caller to transfer to users setting, the options under Callers can contact will also be disabled.

  • If you disable this option, the auto attendant will not invite callers to send a voice message during a system prompt.

Callers can contact
  • Use these options to determine a grouping of users to use. By default, the Users within dial plan option is selected. However, you can change the grouping of users to allow callers to transfer calls or send voice messages to users located in the global address list (GAL) or to a specific set of users that is contained in a custom address list by choosing from the following:

    • Users within this dial plan   Use this option to allow callers who connect to the UM auto attendant to locate and contact users who are within the dial plan that is associated with the UM auto attendant.

    • Anyone in the default global address list   Use this option to allow callers who connect to the UM auto attendant to locate and contact anyone who is listed in the GAL. This includes all users who have been mailbox-enabled.

    • Only this extension   Use this option to allow callers to connect to an extension number that you have specified in the field for this option. This field accepts only numeric digits. The number of digits that you define in this field must match the number of digits that are configured on the dial plan that is associated with the auto attendant.

    • Only this auto attendant   Use this list to allow callers to connect to a UM auto attendant and then connect to another auto attendant. You must create this auto attendant to allow callers to be transferred to another auto attendant that is specified.

    • Anyone in address list   Use this option to allow callers who connect to the UM auto attendant to locate and contact users who are within a defined custom address list. This includes all users who have been mailbox-enabled.

      importantImportant:
      The All Address Lists container is an empty container object and differs from the global address list (GAL) container. If you choose the All Address Lists container when you browse for a custom address list, there will be no UM-enabled users for callers to contact. If you want to select all the address lists in your organization, choose the Anyone in the default global address list option.
Matched name selection method
  • Use this field to select the method the dial plan uses to differentiate between users who have similar names. When a caller is prompted to enter letters to find a particular user in the organization, sometimes more than one name matches the caller's input. Select one of the following methods for providing the caller with more information to help them locate the correct user in the organization:

    • None   No additional information will be given when matches are listed. By default, this method is selected.

    • Title   The auto attendant will include each user's title when matches are listed.

    • Department   The auto attendant will include each user's department when matches are listed.

    • Location   The auto attendant will include each user's location when matches are listed.

    • PromptForAlias   The auto attendant will prompt the caller for the user's alias.

  • By default, all UM auto attendants that are associated with this dial plan will inherit this setting. However, you can change this setting on each UM auto attendant that is created.

Return to top

Use the Settings tab to configure dial plan settings for Unified Messaging. When you configure settings on this tab, you can control how internal and external callers locate users in the system, the number of logon failures that are allowed when an internal user tries to access their voice mail, and the default language that the dial plan uses.

Dial by name primary method
  • Use this list to select the primary way that callers can locate a user when they dial into the system.

  • By default, Last First is selected. This means that when users are searching for a user in the directory, they will enter the user's last name first and then their first name.

  • When a subscriber or a UM-enabled user uses the subscriber access number to access the Unified Messaging system, they can access the menu that enables them to spell the name or alias to locate a user in the system. The option that is selected is the default method that is used by UM-enabled users.

  • You must select one of the supported methods to be able to use the dial-by-name primary method. The following methods are supported:

    • Last name, first name (default)

    • First name, last name

    • SMTP address

Dial by name secondary method
  • Use this list to select the secondary way that callers can locate a user when they dial into the system.

  • By default, SMTP address is selected. This means that when users search for a user in the directory, they will enter the user's e-mail alias or SMTP address.

  • When a subscriber or a UM-enabled user uses the subscriber access number to access the Unified Messaging system, they can access the menu that enables them to spell the name or alias to locate a user in the system.

  • You are not required to select one of the four methods that are supported. However, if you do not select a secondary method, callers are given only one method to use to spell a user's name in the system. The following four options are available:

    • Last name, first name

    • First name, last name

    • SMTP address (default)

    • None

Audio codec
  • Use this list to select the audio codec that will be used by the dial plan.

  • When a caller places a call to a user who is associated with the dial plan, Unified Messaging uses the audio codec that you select from this list to record voice messages that will be sent to UM-enabled users.

  • The following three audio codecs are supported:

    • Windows Media Audio (WMA)

    • G.711 Pulse Code Modulation (PCM) Linear

    • Group System Mobile 06.10 Global System for Mobile Communications (GSM).

  • By default, WMA is selected. WMA is used because it is highly compressed and has high-quality format properties. G.711 PCM Linear is a telephone quality audio codec format that is the least compressed and has the lowest quality format. GSM 06.10 is an audio codec format that used by cellular telephone vendors and is the standard for digital cellular telephone services.

  • If you are concerned about users' disk quotas, select WMA as the audio codec. Voice files that are saved in .wma format are approximately half the size of the same voice recording made by using one of the other audio codecs.

Operator extension
  • Use this text box to enter the telephone number or an extension number for the dial plan's operator.

  • You can configure this setting to transfer calls to an auto attendant if one is configured, to a human operator, to external telephone numbers, or to extension numbers.

  • When a caller who is using the telephone keypad presses the pound key (#), or they say "reception" or "operator," or the number of Input retries threshold is exceeded, the caller is transferred to the telephone number that you specify in this text box.

  • This telephone number can be a number that is external to the organization or an internal telephone extension number. For example, if the extension number for the receptionist or operator is 81964 and your organization has only one dial plan, enter 81964.

  • By default, this setting is blank. If you do not enter a number in this text box, the ability to transfer calls to the operator is disabled and callers are politely disconnected because there is no one to answer the call.

  • We recommend that you populate this text box with a telephone number that transfers callers to an operator if they cannot locate a given user in the directory.

Logon failures before disconnect
  • Use this text box to enter the number of sequential unsuccessful logon attempts that are allowed before a caller is disconnected.

  • The value of this setting can be between 1 and 20. Setting this value too low can frustrate users. For most organizations, this value should be set to the default of three attempts.

Max call duration (min)
  • Use this text box to enter the maximum number of minutes that an incoming call can be connected to the system without being transferred to a valid extension number before the call is ended.

  • This setting applies to all kinds of calls. This includes incoming subscriber access calls, voice calls that are internal to your organization, voice calls that are external to your organization, and incoming fax calls.

  • The value of this setting can be between 10 and 120. Setting this value too low can cause incoming calls to be disconnected before they are completed. For example, if your organization receives many large fax messages, you may want to consider increasing this value from the default so that all the pages for fax messages are received.

  • For most organizations, this value should be set to the default of 30 minutes.

Max recording duration (min)   
  • Use this text box to enter the maximum number of minutes that are allowed for each voice recording when a caller leaves a voice mail message.

  • The value of this setting can be between 5 and 100. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes.

  • This setting is important if you have implemented strict disk quotas for users. This value must be less than the value that is set for the Max call duration (min) setting.

  • For most organizations, this value should be set to the default of 20 minutes.

Recording idle timeout (sec)
  • Use this text box to enter the number of seconds of silence that the system allows when a voice message is being recorded before the call is ended.

  • The value of this setting can be between 2 and 16. Setting this value too low can cause the system to disconnect callers before they are finished leaving their voice messages. Setting this value too high allows lengthy silences in voice messages.

  • For most organizations, this value should be set to the default of 5 seconds.

Input idle timeout (sec)
  • Use this text box to enter the number of seconds that the system will wait for the caller to speak or use touch tone inputs before the user hears a voice command.

  • This setting applies to authenticated subscribers and call answering or calls answered by a UM auto attendant.

  • The value of this setting can be between 3 and 32. Setting this value too low can prevent callers from making selections in the menu before they are disconnected. Setting this value too high makes the system seem non-responsive.

  • For most organizations, this value should be set to the default of 5 seconds.

Input retries
  • Use this text box to enter the number of times that the system prompts a caller for input before the caller is transferred to an operator, if an operator is configured on the UM dial plan.

  • For example, if the Input retries value is set to 1, the system operator prompts the caller only one time before the caller is transferred to the UM dial plan operator.

  • The value of this setting can be between 1 and 16. Setting this value too low may prematurely transfer the caller to an operator.

  • For most organizations, this value should be set to the default of three retries.

Input failures before disconnect
  • Use this text box to configure the number of times that a caller can enter incorrect data before they are disconnected.

  • Examples of incorrect data include when a caller requests an extension number that is not found in the system, the system cannot locate the user's extension number to transfer the call, or the caller presses a menu option that is not valid.

  • The value of this setting can be between 1 and 20. Setting this value too low may prematurely disconnect the caller.

  • For most organizations, this value should be set to the default of three attempts. This is an important setting for speech-enabled UM dial plans.

Default language
  • Use this list to specify the default language that will be used by callers.

  • When a caller places a call to a user who is associated with a dial plan, this is the default language that the voice recorded operator uses. The system prompts that callers will hear are also played in the default language.

  • This language is also used by the text-to-speech engine when it reads e-mail messages or calendar items or when a personal voice greeting has not been recorded.

  • By default, if you install the US-English version of Exchange Server 2007, you will have only one language listed in this list. To have other language options available, you must install the UM language pack for the required language.

  • Adding other languages lets subscribers use a language other than US-English. For example, if a subscriber calls in to the Unified Messaging system by using the subscriber access number from a desk telephone, they are greeted with a prerecorded operator's voice in English. Even if the same user selects a different language in Outlook Web Access, such as French, the menus are still read to them in US-English. For the user to be able to hear the prerecorded operator menus in French, you must install the appropriate language. To add other languages, you must install a language pack. The language packs can be found in the <dvdroot>\UMLang\<language> folder on the Exchange Server 2007 installation DVD.

After you configure the settings on this tab, click Apply to accept the changes.

Return to top

Use the Dialing Rule Groups tab on the UM dial plan to specify dialing rule groups in-country/region and international calls that will be placed by UM-enabled users. Each dialing rule entry that is defined on the dial rule group determines the types of calls that users within a specific dial rule group can make. After you use the Dialing Rule Groups tab to configure a dialing rule group, you must configure the UM mailbox policy to use the appropriate dialing rule group. After you configure the UM mailbox to use a dialing rule group, the dialing restrictions that are configured apply to all UM-enabled users who are associated together with the UM mailbox policy. For example, you can configure a dialing rule group that does not require users who are associated with the dial plan to dial an outside line access code when they place a call to an in-country/region telephone number.

In-country/region Rule Groups

Use this text box to add, remove, or edit in-country/region dialing rule groups that are used by UM mailbox policies.

  • Add   Use this option button to create an In-country/region dialing rule entry and configure the appropriate number mask and dialed number for the dialing rule entry.

  • Edit   Use this option button to change the In-country/region dialing rule entry settings.

  • Remove   Use this option button to delete a In-country/region dialing rule entry.

International Rule Groups

Use this text box to add, remove, or edit international dialing rule groups that are used by UM mailbox policies.

  • Add   Use this option button to create an international dialing rule entry and configure the appropriate number mask and dialed number for the dialing rule entry.

  • Edit   Use this option button to change the international dialing rule entry settings.

  • Remove   Use this option button to delete a international dialing rule entry.

For more information about the settings that can be changed on a dialing rule entry, see Organization Configuration > Unified Messaging > UM Dial Plan > Dialing Rules Tab > Dial Rules Entry later in this white paper.

Return to top

Use the Dialing Rule Entry dialog box on the UM dial plan properties to define the telephone numbers and number masks for in-country/region and international calls that will be made by UM-enabled users. Each dialing rule determines the types of calls that users within a dial group can make. However, you will have to correctly configure the dial group entry with a number mask and a dial number. After you use the Dialing Rules tab to configure a dialing rule, you must configure the UM mailbox policy to use the appropriate dialing group.

Name

Use this list to select a name of an existing dialing rule or, if you want to create a dialing rule, type the name of the dialing rule. This is the display name for the dialing rule that will be displayed in the Exchange Management Console. This field can contain only text characters. The display name for the dial rule can contain up to 32 characters.

Number Mask

Use this text box to define the number mask for the dialing rule. A number mask is used to define the telephone number format that a Unified Messaging server will use to determine what outgoing telephone number it will dial for a user. When an outgoing call is made to a number that is matched by the number mask on the dialing rule, the UM server will substitute the digits that are matched into the dialed number. It will then use the digit string from this match to make the outgoing call. An example of a valid number mask is 91425xxxxxxx. This field can contain only numbers and the letter 'x'.

Dialed Number

Use this text box to define the dialed number for the dialing rule. The dialed number is used to determine the actual dial string that sent to the IP/VoIP gateway. This number can be different from the number that is obtained by Unified Messaging for the outgoing call. However, your PBX can also be configured to omit the area code for local calls and can be configured for private voice numbering plans. Any wildcard (x) characters in the dial string are substituted with the digits from the original number that were matched by the number mask on the dialing rule. An example valid dialed number is 9xxxxxxx. This field can contain only numbers and the character "x".

Comment

Use this text box to input a comment or description for the dialing rule that you are adding or modifying. By default, this text box is blank.

A UM dial plan is created by using an organization-wide scope and contains configuration information that is related to your telephony network. Use the New Dial Plan Wizard to create a new UM dial plan for use by Exchange Server 2007 Unified Messaging. A UM dial plan logically represents sets or groupings of PBXs that share common user extension numbers. In practical terms, user extensions that are hosted on a PBX share a common extension number and have the ability to dial one another’s telephone extensions without appending a special number to the extension or dialing a full telephone number for the other users.

After the UM dial plan is created, you must perform the following tasks:

To create a new UM dial plan, in the New UM Dial Plan Wizard, on the New page, complete the following information:

Dial plan name    
  • A UM dial plan name is required and must be unique, but it is used only for display purposes in the Exchange Management Console and the Exchange Management Shell. If you have to change the display name of the dial plan after it has been created, you must first delete the existing UM dial plan and then create another dial plan that has the appropriate name. If your organization uses multiple UM dial plans, we recommend that you use meaningful names for your UM dial plans. The maximum length of a UM dial plan is 64 characters, and it can include spaces. However, it cannot include any of the following characters: " / \ [ ] : ; | = , + * ? < >.

Number of digits in extension    
  • The number of digits for extension numbers is based on the telephony dial plan that is created on a PBX. For example, if a user associated with a telephony dial plan dials a 4-digit extension to call another user in the same telephony dial plan; you select 4 as the number of digits in the extension. This is a required field that has a value range from 1 to 20. The typical extension length is from 3 to 7. If your existing telephony environment includes extension numbers, you must specify a number of digits that matches the number of digits in those extensions.

After you complete the fields on this page of the New UM Dial Plan Wizard, click New to create the new UM dial plan.

Return to top

Use the Completion page to confirm whether the new UM dial plan was created successfully. Click Finish to complete the New UM Dial Plan wizard.

A status of Completed indicates that the wizard completed the task successfully. A status of Failed indicates that the task was not completed. If the task failed, review the summary for an explanation, and then click Back to make any configuration changes.

For more information about how to make configuration changes to the UM dial plan, see How to Modify a Unified Messaging Dial Plan.

The summary pane lists the following fields:

Management Shell command

This field lists the Exchange Management Shell command that was used to create the new UM dial plan. If the task is successful, this text is displayed as Management Shell command completed. If the task fails, this text is displayed as Management Shell command attempted.

For more information about the New-UMDialplan cmdlet, see New-UMDialplan earlier in this white paper.

For more information about the Exchange Management Shell, see Using the Exchange Management Shell.

Elapsed Time

This field indicates the time that it took for the wizard to complete the task. If the elapsed time is 00:00:00, the task took less than 1 second to be completed.

noteNote:
You can press CTRL+C to copy the text in the summary pane to the Clipboard. After the text has been copied to the Clipboard, you can paste it into a document or screen.

After the UM dial plan is created, we recommend that you perform the following tasks:

Return to top

Use the Unified Messaging UM IP Gateway tab to create and maintain IP gateways for your Unified Messaging configuration. UM IP gateways are created in Active Directory to represent a Voice over Internet Protocol (VoIP) gateway device. UM IP gateways are created in an enabled state. A UM IP gateway establishes a logical link between the IP/VoIP gateway, the UM dial plan, and a single or multiple UM hunt groups.

Before the IP/VoIP gateway can process calls, it must be represented by a UM IP gateway. You must then associate the UM IP gateway with a UM dial plan. You can associate a UM IP gateway with one or more UM dial plans by creating one or more UM hunt groups. For more information about Unified Messaging IP gateways, see Understanding Unified Messaging IP Gateways.

The result pane enables you to view a subset of properties for a UM IP gateway. This includes the name, associated dial plan, and its status.

Name

This column in the result pane lets you view the display name for UM IP gateways that have been created. If your organization uses multiple UM IP gateways, you should use meaningful names for the UM IP gateways. The maximum length for a display name is 64 characters and it can contain spaces.

UM Dial Plans

This column in the result pane lets you view the UM dial plans that are associated with the UM IP gateways that have been created. After you create a dial plan, you must create a UM IP gateway and associate it with a UM dial plan. After the UM IP gateway is created, the dial plan that is associated with the UM IP gateway cannot be changed. If you need to associate a UM IP gateway with a different dial plan, you must delete the UM IP gateway and then associate it with the correct dial plan after you re-create it.

Pilot Identifier

This column in the result pane lets you view the pilot numbers that are configured on the UM IP gateway. The pilot identifier or pilot ID is configured on the UM hunt group when it is created. You cannot change the pilot ID after the UM hunt group is created. You must delete the UM hunt group, and then re-create the UM hunt group to include the correct pilot ID.

Address

This column in the result pane lets you view the IP address that is configured on each IP gateway or Session Initiation Protocol (SIP)-enabled IP-PBX. By viewing the properties for a UM IP gateway, you can change the IP address of the UM IP gateway if the IP address of the IP/VoIP gateway has changed.

Status

This column in the result pane lets you view the status of the UM IP gateway and whether each UM IP gateway is enabled or disabled. If the UM IP gateway is disabled, UM servers that are associated with the UM dial plan will not receive incoming calls from the IP/VoIP gateway.

Outgoing Calls Allowed

This column in the result pane lets you enable or disable outgoing calls. This setting can be disabled if you do not want users who are associated with the UM dial plan to place outgoing calls through the UM IP gateway.

New Hunt group

You can use the action pane to start the New UM Hunt Group Wizard. Use this task to create a new UM hunt group that will be associated with a UM IP gateway. A UM hunt group is used to forward incoming calls to a specific UM dial plan.

Disable after completing calls

You can use the action pane to force the UM server that is associated with the UM IP gateway to stop handling new calls that are presented by the IP/VoIP gateway.

Disable immediately

You can use the action pane to force all associated UM servers to drop existing calls that are being processed.

Properties

You can use the action pane to view the properties of a UM IP gateway or change the UM IP gateway configuration. You can also right-click the UM IP gateway, and then select Properties from the list of available options.

After you install the Unified Messaging server role on a server that is running Microsoft Exchange Server 2007, you must create, configure, and manage at least one dial plan. After you create a UM auto attendant, you may also need to perform one of the following tasks:

Return to top

Use the General tab to configure settings for the UM IP gateway. For example, you can configure the IP address that points to an IP/VoIP gateway or PBX that is enabled for SIP on your network. You can also change the display name of the UM IP gateway that was configured when the UM IP gateway was created.

Status
  • This display-only field shows the status of the UM IP gateway.

Modified
  • This display-only field shows the date that the UM IP gateway was last modified.

Address
  • Use this field to specify the IP address that is configured on the IP/VoIP gateway or SIP-enabled IP/PBX. This IP address is configured when the UM IP gateway is created.

  • You can use an IP address or a Fully Qualified Domain Name (FQDN) in this field. Alphabetical and numeric characters are accepted in this text box. For legacy PBXs, a numeric value is used for an IP address.

Allow outgoing calls through this UM IP gateway
  • Select this check box to allow the UM IP gateway to accept and process outgoing calls. This setting does not affect call transfers or incoming calls from an IP/VoIP gateway.

  • By default, when the UM IP gateway is created, this setting is enabled. If you disable this setting, users that are associated with the dial plan will be unable to make outgoing calls through the IP/VoIP gateway that is defined in the Address field.

Return to top

Use the New UM IP Gateway Wizard to create a new UM IP gateway for use by Microsoft Exchange Server 2007 Unified Messaging (UM). A UM IP gateway establishes a logical link between the IP/VoIP gateway device, a UM IP gateway, and single or multiple UM hunt groups.

A UM IP gateway is created by using an organization-wide scope and is a container object that logically represents a physical IP/VoIP gateway hardware device. Before the IP/VoIP gateway device can process Unified Messaging calls, the IP/VoIP gateway must be represented by an object in the Active Directory directory service and then associated with one or more UM dial plans.

After a UM IP gateway is created, you may have to create and associate a UM hunt group with a UM dial plan. For more information about how to create a UM hunt group, see How to Create a New Unified Messaging Hunt Group.

After a UM IP gateway is created, you may also have to enable users for Unified Messaging. For more information about how to enable users for Unified Messaging, see How to Enable a User for Unified Messaging.

To create a new UM IP gateway, in the New UM IP Gateway Wizard, on the New page, complete the following information:

UM IP gateway name   
  • Use this text box to specify a unique name for the UM IP gateway. This is a display name that appears in the Exchange Management Console. If you must change the display name of the UM IP gateway after it has been created, you must first delete the existing UM IP gateway, and then create another UM IP gateway that has the appropriate name. The UM IP gateway name is required, but it is used for display purposes only. Because your organization may use multiple UM IP gateways, we recommend that you use meaningful names for your UM IP gateways. The maximum length of a UM IP gateway is 64 characters, and it can include spaces.

IP Address   
  • Use this text box to enter the IP address for the IP/VoIP gateway or SIP–enabled PBX. This is the IP address that is configured on the network or LAN interface of the IP/VoIP gateway or SIP-enabled PBX. You can change the IP address after the UM IP gateway has been created. However, changing this setting may disrupt communication between Unified Messaging servers and the IP/VoIP gateway or SIP-enabled IP/PBX. Modifications to a UM IP gateway should be performed only by an administrator who fully understands the implications of making configuration changes to the UM IP gateway. This text box will accept only IP addresses that are valid and formatted correctly.

Fully qualified domain name (FQDN)
  • Use this text box to enter the FQDN for the UM IP gateway. This is the FQDN that is configured on a host record for the UM IP gateway in the DNS forward lookup zone on the authoritative DNS server.

  • This text box will accept only fully qualified domain names (FQDNs) that are valid and formatted correctly.

Dial plan   
  • Click the Browse button to select the UM dial plan that you want to associate with the UM IP gateway. When you select a UM dial plan to associate with a UM IP gateway, a default UM hunt group is also created and associated with the UM dial plan that you selected. If you do not select a UM dial plan, you must manually create a UM hunt group and then associate that UM hunt group with the UM IP gateway that you create. After you associate the UM IP gateway with a UM dial plan, the IP/VoIP gateway will answer incoming calls.

After you complete the text boxes on this page of the New UM IP Gateway Wizard, click New to create the new UM IP gateway.

Return to top

Use the Completion page to confirm whether the new UM IP gateway was created successfully. Click Finish to complete the New UM IP Gateway wizard.

A status of Completed indicates that the wizard completed the task successfully. A status of Failed indicates that the task was not completed. If the task failed, review the summary for an explanation, and then click Back to make any configuration changes.

For more information about how to make configuration changes to the UM IP gateway, see How to Modify a Unified Messaging IP Gateway.

The summary pane lists the following fields:

Management Shell command

This field lists the Exchange Management Shell command that was used to create the new UM IP gateway. If the task is successful, the text in this field is displayed as Management Shell command completed. If the task fails, the text in this field is displayed as Management Shell command attempted.

For more information about the New-UMIPGateway cmdlet, see New-UMIPGateway earlier in this white paper.

For more information about the Exchange Management Shell, see Using the Exchange Management Shell.

Elapsed Time

This field indicates the time that it took for the wizard to finish the task. If the elapsed time is 00:00:00, this indicates that the task took less than 1 second to finish.

noteNote:
You can press CTRL+C to copy the text in the summary pane to the Clipboard. After the text has been copied to the Clipboard, you can paste it into a document or screen.

After the UM IP gateway is created, we recommend that you perform the following tasks:

Return to top

A UM hunt group provides the communication link between UM IP gateways and UM dial plans. When you create a new UM hunt group, you enable Unified Messaging servers in the specified UM dial plan to communicate with a UM IP gateway. When you create a new UM hunt group, you must specify the UM dial plan and the pilot identifier or pilot number that will be used with the new UM hunt group.

After a UM hunt group is created, no changes or modifications can be made to the object. Therefore no settings can be configured for the UM hunt group. If the UM hunt group object was misconfigured, you must remove or delete the hunt group and re-create a new UM hunt group with the appropriate and correct settings.

noteNote:
A default UM hunt group will be created every time that you create a UM IP gateway and associate the UM IP gateway with a UM dial plan. Multiple UM hunt groups can be associated with a single UM IP gateway.
Remove

Click this button to remove or delete the existing UM hunt group. You cannot make any configuration changes after the UM hunt group is created.

Return to top

Use the New UM Hunt Group Wizard to create a new UM hunt group. When you create a UM hunt group, a UM hunt group object is created in Active Directory and is a logical representation of an existing PBX or IP/PBX hunt group. A UM hunt group acts as a connection or link between a UM IP gateway and a dial plan. After you create a UM hunt group, you cannot change any of the settings that you have defined. If you want to change the UM hunt group settings, you must delete the hunt group and then create another hunt group that has the appropriate settings.

Associated UM IP gateway
  • This display-only field shows the name of the UM IP gateway that will be associated with the UM hunt group.

Hunt group name
  • Use this text box to create the display name for the UM hunt group.

  • A UM hunt group name is required and must be unique, but it is used only for display purposes in the Exchange Management Console and the Exchange Management Shell. If you have to change the display name of the hunt group after it has been created, you must first delete the existing hunt group and then create another hunt group that has the appropriate name.

  • If your organization uses multiple hunt groups, we recommend that you use meaningful names for your hunt groups. The maximum length that a UM hunt group name can be is 64 characters, and it can include spaces. However, it cannot include any of the following characters: " / \ [ ] : ; | = , + * ? < >..

Dial plan
  • Click the Browse button to select the dial plan that will be associated with the UM hunt group. Associating a hunt group with a dial plan is required.

  • A UM hunt group can be associated with only one UM IP gateway and one UM dial plan.

Pilot identifier
  • Use this text box to specify a string that uniquely identifies the pilot identifier or pilot ID that is configured on the PBX or IP/PBX.

  • An extension number or a Session Initiated Protocol (SIP) Uniform Resource Identifier (URI) can be used in this field. Alphanumeric characters are accepted in this field. For legacy PBXs, a numeric value is used as a pilot identifier. However, some IP-PBXs can use SIP URIs.

Return to top

Use the Completion page to confirm whether the new Unified Messaging (UM) hunt group was created successfully. Click Finish to complete the New UM Hunt Group Wizard.

A status of Completed indicates that the wizard completed the task successfully. A status of Failed indicates that the task was not completed. If the task failed, review the summary for an explanation, and then click Back to make any configuration changes.

After you have created a UM hunt group, you will be unable to modify properties for that UM hunt group. You should delete the UM hunt group that you created and then create a UM hunt group that has the correct settings. For more information about how to view the configuration properties of a UM hunt group, see, How to View the Properties of a Unified Messaging Hunt Group.

The summary pane lists the following fields:

Management Shell command

This field lists the Exchange Management Shell command that was used to create the new UM hunt group. If the task is successful, the text in this field is displayed as Management Shell command completed. If the task fails, the text in this field is displayed as Management Shell command attempted.

For more information about the New-UMHuntGroup cmdlet, see New-UMHuntGroup earlier in this white paper.

For more information about the Exchange Management Shell, see Using the Exchange Management Shell.

Elapsed Time

This field indicates the time that it took for the wizard to finish the task. If the elapsed time is 00:00:00, this indicates that the task took less than 1 second to finish.

noteNote:
You can press CTRL+C to copy the text in the summary pane to the Clipboard. After the text has been copied to the Clipboard, you can paste it into a document or screen.

After the UM hunt group is created, we recommend that you perform the following tasks:

Return to top

Use this tab to create, view, and configure mailbox policies for Unified Messaging. Unified Messaging Active Directory mailbox policies are required when you enable users for Exchange Server 2007 Unified Messaging. UM mailbox policies let you apply and standardize Unified Messaging configuration settings for UM-enabled users. By default, a single UM mailbox policy is created every time that you create a UM dial plan. The new UM mailbox policy will be associated with the UM dial plan and part of the dial plan name will be included in the display name of the UM mailbox policy. You can use UM mailbox policy to apply a common set of policies or security settings to a collection of UM-enabled mailboxes. You use Unified Messaging mailbox policies to set Unified Messaging settings for UM-enabled users such as the following:

  • PIN policies

  • Dialing restrictions

  • Other general UM mailbox policy properties

After you create a UM mailbox policy, link one or more UM-enabled mailboxes to the UM mailbox policy. When a user is enabled for Unified Messaging, you must link an existing UM mailbox policy to the UM-enabled user's mailbox. Although a single UM mailbox policy is required, you can create additional UM mailbox policies and apply a common set of policy settings to other groups of users. After you install the Unified Messaging server role on a computer that is running Exchange Server 2007, you must create a UM dial plan and associate a Unified Messaging server with the dial plan. When you create the first UM dial plan, a default UM mailbox policy that has default settings is also created. If your environment requires changes to the default UM mailbox policy, you can either change the settings on the default UM mailbox policy or create additional UM mailbox policies to meet your organizational needs.

When you create a UM dial plan, a UM mailbox policy is also created. Table 1 includes the list of the settings and their default values that are configured on the UM mailbox policy.

Table 1   UM mailbox policy default settings

 

UM mailbox setting Default value
  • Maximum greeting duration (minutes)

5 minutes

  • Allowed missed call notifications

Enabled

  • Fax identity

Microsoft Exchange

  • Text sent when a UM mailbox is enabled

To use your telephone to access your e-mail, calendar, and contacts, call your access number and enter your PIN at the prompt.

  • Text sent when a PIN is reset

Your Exchange Unified Messaging PIN has been reset. You will be able to access your e-mail, calendar, and contacts in 15 minutes or less. Call your access number and enter your new PIN at the prompt.

  • Text included with a voice message

You have received a voice mail from <number>.

  • Text included with a fax message

 

  • Minimum PIN length

6

  • PIN Lifetime (days)

60

  • Number of PINs to disallow

5

  • Allow common patterns in PIN

Disabled

  • Number of incorrect PIN entries before PIN is automatically reset

5

  • Number of incorrect PIN entries before UM mailbox is locked out

15

  • Allow call to users within the same dial plan

Enabled

  • Allow calls to extensions

Disabled

  • Select allowed in-country groups from dial plan

No in-country groups configured.

  • Select allowed international groups from dial plan

No international groups configured.

After you create a UM dial plan and the default UM mailbox policy is created, you may have to perform the following tasks:

Return to top

Use the General tab to view and configure settings for a UM mailbox policy. For example, you can view the dial plans that are associated with the UM mailbox policy or disable missed call notifications for users who are associated with a specific UM mailbox policy.

When you modify the settings found on a UM mailbox policy, the settings are applied to all users who are associated with the UM mailbox policy. UM mailbox policies let you apply a common set of settings to a collection or group of mailboxes. You must create a UM mailbox policy before you can enable users for Unified Messaging.

Use this page to configure the following settings for a UM mailbox policy:

Associated dial plan
  • Displays the name of the dial plan that is associated with the UM mailbox policy. This is the name of the dial plan that is displayed in the Exchange Management Shell.

  • When a new UM mailbox policy is created, it must be associated with a dial plan. After the UM mailbox policy is created and associated with a dial plan, the settings that are defined on the mailbox policy are applied to the users who are associated with the dial plan.

  • A UM mailbox policy cannot be changed after it is associated with a dial plan.

Modified
  • Displays the date of the last modification or change that was made to the UM mailbox policy.

Maximum greeting duration (minutes)
  • Use this text box to enter the maximum number of minutes that users who are associated with the UM mailbox policy can use when they record their voice mail greeting.

  • The valid range for the greeting is from 1 to 10 minutes. The default setting is 5 minutes.

  • You can modify this setting after the UM mailbox policy is created. Only numeric characters are allowed.

Allow missed call notifications
  • Select this check box to enable or disable missed call notifications for users associated with the UM mailbox policy.

  • A missed call notification is an e-mail message that is sent to a user's mailbox when the user does not answer an incoming call. This is a different e-mail message than the e-mail message that contains the voice mail message that is left for a user.

  • Typically, when a user misses an incoming call, they receive two e-mail messages: an e-mail message that contains the voice mail message and a missed call notification message.

  • By default, missed call notifications are enabled when a UM mailbox policy is created.

After you modify the fields on this page, click Apply to accept the changes.

Return to top

Use the Unified Messaging (UM) mailbox policy Message Text tab to configure message text settings for users who are associated with a UM mailbox policy. For example, you can specify the e-mail message text that is sent to a user after they reset their UM PIN or the e-mail message text that is included when a user receives a fax message in their Inbox.

Use this tab to configure the following settings:

Fax Identity
  • The text that is entered in this text box is the text that the sender's fax machine receives. This text includes identification information about the receiving fax system.

  • This identification information appears on the sender's fax machine display when a fax message is sent to a UM-enabled user. This text is seen by users who send fax messages from inside and outside your organization. You can use this text box to include information such as the name of your organization, or other distinguishing information about the group of UM users covered by a mailbox policy.

  • If text is not entered in this text box, no information is included to identify the recipient's fax system.

  • This text box is limited to 32 characters. By default, Microsoft Exchange is defined in this text box.

Text sent when UM Mailbox is enabled
  • The text that is entered in this text box appears in the e-mail message that is sent to users when they are enabled for Unified Messaging. When a recipient's mailbox is enabled for Unified Messaging, an e-mail message that welcomes the user to Unified Messaging is sent to the user.

  • This welcome message contains welcome text and the PIN information that the user will use to access the Unified Messaging system. The text entered in this text box is included at the bottom of this welcome message. You can use this text box to include information such as the Unified Messaging technical support telephone numbers or subscriber access numbers.

  • If text is not entered in this text box, the default text that is generated by the UM system is included in the e-mail message.

  • This text box is limited to 512 characters. By default, no text is defined in this text box.

Text sent when UM PIN is reset
  • The text that is entered in this text box is included in the e-mail message that is sent to a UM-enabled user when their UM PIN is reset.

  • A PIN is reset by the Unified Messaging system if the number of failed logon attempts exceeds 10 (by default) or if the user resets their PIN by using the Unified Messaging features included with Microsoft Office Outlook 2007, Microsoft Exchange Server 2007, Outlook Web Access, or Outlook Voice Access from a telephone. You can use this text box to include information such as security notices or other security-related information in the e-mail message.

  • If text is not entered in this text box, the default text that is generated by the Unified Messaging system is included in the e-mail message.

  • This text box is limited to 512 characters. By default, no text is defined in this text box.

Text included by UM with voice message
  • The text that is entered in this text box is included in the e-mail message that is sent to a user when they receive a voice mail message from an incoming caller.

  • For example, this text can include disclaimers that contain information about forwarding voice mail messages or system security policies that describe the correct way to handle voice mail messages in your organization.

  • If text is not entered in this text box, the default text that is generated by the system is included in the e-mail message.

  • This text box is limited to 512 characters. By default, no text is defined in this text box.

Text included by UM with fax message
  • The text that is entered in this text box is included in the e-mail message that is sent to a user when they receive an incoming fax message in their Inbox. You can use this text box to include disclaimers that contain information about forwarding fax messages or other system security policies about the correct way to handle fax mail messages in your organization.

  • If text is not entered in this text box, the default text that is generated by the system is included in the e-mail message.

  • This text box is limited to 512 characters. By default, no text is defined in this text box.

After you modify the fields on this page, click Apply to accept the changes.

Return to top

The Unified Messaging (UM) mailbox policies PIN Policies tab is used to configure PIN settings for users who are associated with a UM mailbox policy. Unified Messaging PINs enable users to access their Inboxes by using a telephone. By configuring settings on this page, you can specify the minimum number of digits for a UM PIN or the number of failed logon attempts before a user is locked out of their UM mailbox.

Make sure that you plan carefully for the UM PIN policies that you implement in your environment. If you do not plan and implement the appropriate UM PIN policies, you may introduce security threats and mistakenly allow unauthorized access to your network.

Use this page to configure the following settings for a UM mailbox policy:

Minimum PIN length
  • Use this text box to specify the minimum number of digits that a Unified Messaging user's PIN can contain.

  • Increasing the number of digits that are required for a PIN increases the level of security for your Unified Messaging system. Decreasing the number of digits required for a PIN reduces the level of security for your network. The fewer the digits that are required in a PIN, the easier it is for a potential attacker to guess a user's PIN.

  • If this setting is set too high, users might have problems remembering their PINs. However, if the setting is too low, you risk unauthorized access to the Unified Messaging system.

  • The default setting is six digits. The range is from 4 to 24 numeric digits. This setting cannot be disabled.

PIN lifetime (days)
  • Use this text box to configure the number of days until the UM-enabled user's PIN expires.

  • After the PIN expires, the user must create a new UM PIN.

  • The value of this setting can be between 0 and 999. If it is set to 0, PINs never expire. Setting this value too low can frustrate users because they are required to create and memorize new PINS too frequently.

  • For most organizations, this value should be set to the default of 60 days.

Failed logon attempts before automatic PIN reset
  • Use this text box to enter the number of sequential unsuccessful or failed logon attempts that can occur before the Unified Messaging system automatically resets a user's PIN.

  • The value of this setting can be between 0 and 999. If you set this setting to 0, this setting is disabled and the system will not automatically reset users' PINs. Setting this value too low can frustrate users; setting it too high it gives malicious users more attempts to determine the PIN.

  • For most organizations, this value should be set to the default of 5 attempts.

  • This setting must be set to a number that is lower than the number configured in the Failed logon attempts before lockout setting. This setting is designed to help prevent a brute force attack on user PINs.

Failed logon attempts before lockout
  • Use this text box to enter the maximum number of sequential unsuccessful or failed logon attempts before a user is locked out of their mailbox.

  • For example, if a user tries to log on to their mailbox unsuccessfully five times, based on the Failed logon attempts before automatic PIN reset setting, the system will reset the user's PIN. If the user tries to use their new PIN five more times unsuccessfully, the system will again reset their PIN. If the user tries to use this new PIN five more times unsuccessfully, the user is then locked out of their mailbox. After a user is locked out, an administrator must manually reset or unlock the mailbox for the user.

  • This value can be set between 1 and 999. Setting this value too low can frustrate users; setting it too high it gives malicious users more attempts to determine the PIN. For most organizations, this value should be set to the default of 15 attempts.

  • This number must be greater than the number that is set in the Failed logon attempts before automatic PIN reset This setting is designed to help prevent a brute force attack on user PINs.

Number of previous PINs to disallow
  • Use this setting to set the number of unique PINs that a user must use before they can reuse an old PIN.

  • You can set the value of this setting between 1 and 20. Setting this value too high can frustrate users because it can be difficult to memorize many PINs. Setting it too low may introduce a security threat to your network.

  • For most organizations, this value should be set to the default of 5 PINs that the system will remember. PIN history cannot be disabled.

Allow common patterns in PIN
  • Use this setting to set PIN complexity requirements for Unified Messaging. These complexity requirements are enforced on PIN changes or when new PINs are created.

  • As a security best practice, it is recommended that you enable this setting. If this setting is enabled, user PINs cannot contain the following:

    • Sequential numbers, such as 123456 or 456789.

    • Repeated numbers, such as 111111 or 8888888.

    • Suffix of the mailbox extension.

  • If this option is disabled, sequential and repeated numbers and the suffix of the mailbox extension will be rejected. If this option is enabled, only the suffix of the mailbox extension will be rejected.

Return to top

Use the New UM Mailbox Policy Wizard to create a new UM mailbox policy. UM mailbox policies link a UM-enabled user with a UM dial plan and apply a common set of policies or security settings to a collection of UM-enabled mailboxes. UM mailbox policies are useful for applying and standardizing UM configuration settings for UM-enabled users.

By default, when a UM dial plan is created, a UM mailbox policy is also be created. However, there are other times that you may have to create additional UM mailbox policies or modify existing UM mailbox policies after you deploy Unified Messaging in your Exchange Server 2007 organization.

After you create a new UM mailbox policy, you associate UM-enabled users to the UM mailbox policy that you created.

Mailbox policy name
  • Use this text box to specify a unique name for the UM mailbox policy. This is a display name that appears in the Exchange Management Console.

  • If you must change the display name of the UM mailbox policy after it has been created, you must first delete the existing UM mailbox policy, and then create another UM mailbox policy that has the appropriate name. To delete the UM mailbox policy, there must not be any UM-enabled users who are associated with the UM mailbox policy.

  • The UM mailbox policy name is required, but it is used for display purposes only. Because your organization may use multiple UM mailbox policies, we recommend that you use meaningful names for your UM mailbox policies.

  • The maximum length of a UM mailbox policy name is 64 characters, and it can include spaces. However, it cannot include any of the following characters: " / \ [ ] : ; | = , + * ? < >.

Select associated dial plan

Click Browse to select the UM dial plan that will be associated with the UM mailbox policy. You must associate a UM mailbox policy with at least one UM dial plan. A single UM mailbox policy must be associated with at least one UM dial plan. However, you can also associate multiple UM mailbox policies with a single dial plan.

Return to top

Use the Completion page to confirm whether the new UM mailbox policy was created successfully. Click Finish to complete the New UM Mailbox Policy wizard.

A status of Completed indicates that the wizard completed the task successfully. A status of Failed indicates that the task was not completed. If the task failed, review the summary for an explanation, and then click Back to make any configuration changes.

For more information about how to make configuration changes to the UM mailbox policy, see How to Modify a Unified Messaging Mailbox Policy.

The summary pane lists the following fields:

Management Shell command

This field lists the Exchange Management Shell command that was used to create the new UM mailbox policy. If the task is successful, the text in this field is displayed as Management Shell command completed. If the task fails, the text in this field is displayed as Management Shell command attempted.

For more information about the New-UMMailboxPolicy cmdlet, see New-UMMailboxPolicy earlier in this white paper.

For more information about the Exchange Management Shell, see Using the Exchange Management Shell.

Elapsed Time

This field indicates the time it took for the wizard to finish the task. If the elapsed time is 00:00:00, this indicates that the task took less than 1 second to finish.

noteNote:
You can press CTRL+C to copy the text in the summary pane to the Clipboard. After the text has been copied to the Clipboard, you can paste it into a document or screen.

After the UM mailbox policy is created, we recommend that you perform the following tasks:

Return to top

Use the Dialing Restrictions tab on the Unified Messaging (UM) mailbox policy properties to configure dialing rules for UM-enabled users who are associated with this UM mailbox policy. Unified Messaging mailbox policies are required to enable users for Unified Messaging. They are useful for applying and standardizing Unified Messaging configuration settings for UM-enabled users. You can create UM mailbox policies to apply a common set of policies or security settings to a collection of UM-enabled mailboxes.

Allow calls to subscribers within the same dial plan
  • Select this check box to allow UM-enabled users who are associated with this UM mailbox policy to place calls to users within the same dial plan. By default, this setting is enabled.

  • When this setting is enabled, a user who has been UM-enabled and is associated with this UM mailbox policy can place calls to users within the same dial plan that also have an Exchange Unified Messaging (EUM) proxy address. For the user to have a EUM proxy address, they must be UM-enabled. To view the EUM proxy address, view the recipient properties. For more information about how to view the properties for a recipient, see Recipient Configuration > Mailbox > Reset Unified Messaging PIN later in this white paper.

  • When you disable this setting, users who are associated with this UM mailbox policy will be unable to place calls to users within the same dial plan who have a EUM proxy address or place calls to other extension numbers. This is because, by default, the Allow calls to extensions setting is disabled.

Allow calls to extensions
  • Select this check box to allow UM-enabled users who are associated with this UM mailbox policy to dial calls to the number of digits set on the dial plan. By default, this setting is disabled.

  • When this setting is disabled, users who are associated with the UM mailbox policy cannot place calls to non UM-enabled users or other extension numbers that are not associated with a UM-enabled user.

  • Enabling this setting is useful in an environment where not all users have been UM-enabled. It is also useful when you want to allow users who are associated with the UM mailbox policy to call extension numbers that are not associated with a UM-enabled user.

Select allowed in-country/region rule groups from dial plan
  • Use this section to add or remove allowed in-country/region dial group names. By default, there are no in-country/region dial groups configured on UM dial plans or on UM mailbox policies.

  • To add in-country/region dialing groups, you must first create the appropriate in-country/region groups on the dial plan that is associated with the UM mailbox policy.

  • Adding in-country/region groups to the UM mailbox policy can be useful when users who are placing calls to in-country/region telephone numbers do not want to dial an outside line access code.

Select allowed international rule groups from dial plan
  • Use this section to add or remove allowed international dial group names. By default, there are no international dial groups configured on UM dial plans or on UM mailbox policies.

  • To add international dialing groups, you must first create the appropriate international groups on the dial plan that is associated with the UM mailbox policy.

  • Adding international groups to the UM mailbox policy can be useful when users who are placing calls to international telephone numbers do not want to dial an outside line access code.

Return to top

Use the Auto Attendant tab to create, delete, and manage Unified Messaging (UM) auto attendants. Unified Messaging enables you to create a single or multiple UM auto attendants, depending on the needs of your organization. Unlike other Unified Messaging components, such as UM dial plans and UM IP gateways, you are not required to create UM auto attendants.

In telephony or Unified Messaging environments, an automated attendant or auto attendant menu system transfers callers to the extension of a user or department without the intervention of a receptionist or an operator. A UM auto attendant lets callers navigate the menu system, place calls, or locate users by using dual tone multi-frequency (DTMF) or voice inputs.

A UM auto attendant has the following features:

  • It provides corporate or informational greetings.

  • It provides custom corporate menus. You can customize these menus to have more than one level.

  • It provides a directory search function that enables a caller to search the organization's directory for a name.

  • It enables a caller to connect to the telephone of, or leave a message for, members of the organization.

The result pane lets you view a subset of properties for a UM auto attendant. This includes the name, associated dial plan, and its status.

Name

This column in the result pane lets you view the display name for auto attendants that have been created. If your organization uses multiple auto attendants, you should use meaningful names for the auto attendants. The maximum length for a display name is 64 characters and it can contain spaces.

UM Dial Plan

This column in the result pane lets you view the UM dial plans that are associated with auto attendants that have been created. After you have created an auto attendant, the dial plan that is associated with the auto attendant cannot be changed. If you need to associate an auto attendant with a different dial plan, you must delete it and then associate the auto attendant with the proper dial plan when you re-create it.

Status

This column in the result pane lets you view the status of the auto attendant. Auto attendants can be enabled or disabled. However, by default, an auto attendant is disabled when you create it.

Enable

You can use the action pane to enable a UM auto attendant. If an auto attendant is enabled, incoming calls will be answered by the auto attendant.

Disable

You can use the action pane to disable a UM auto attendant. If an auto attendant is disabled, no incoming calls will be answered.

Remove

You can use the action pane to remove a UM auto attendant. Alternatively, you can right-click the UM auto attendant and select Remove from the list of available options.

Properties

You can use the action pane to view the properties of an auto attendant or make any changes to the auto attendant's configuration. Alternatively, you can right-click the auto attendant and select Properties from the list of available options.

After you install the Unified Messaging server role on a server that is running Microsoft Exchange Server 2007, you must create, configure, and manage at least one dial plan. After you create a UM auto attendant, you may also need to perform one or more of the following tasks:

Return to top

Use the General tab to view display-only information about the Unified Messaging (UM) auto attendant and to perform management tasks on a UM auto attendant. For example, you can add, remove, and edit extension numbers that are associated with the auto attendant. You can also enable or disable Automatic Speech Recognition (ASR) for the auto attendant.

Status
  • This field shows whether the UM auto attendant is enabled or disabled. To enable or disable the auto attendant, close the General tab and use the action pane commands to enable or disable the auto attendant.

Associated dial plan
  • This field displays the UM dial plan that is associated with the auto attendant. After you have created an auto attendant, the dial plan that is associated with the auto attendant cannot be changed. If you need to associate an auto attendant with a different dial plan, you must delete the dial plan and then associate the auto attendant with the correct dial plan after you re-create it.

Modified
  • This field shows the last date and time the auto attendant settings were modified.

Extension number to associate
  • Use this field to enter the extension number that, when it is called, leads callers to the auto attendant. By default, there are no extension numbers that are configured when you create an auto attendant.

  • The number of digits in the extension number you provide must match the number of digits for an extension number that is configured on the UM dial plan that is associated with the UM auto attendant. You can also add a SIP address to this field. A SIP address is used by some IP/PBXs.

  • However, you can create the new auto attendant without listing an extension number. An extension number is not required. To add an extension, type the number in this field, and then click Add. You can associate more than one number with an auto attendant. You can also edit or remove an existing extension number. To edit an existing extension number, click the Edit button. To remove an existing extension number from the list, click the Remove button.

Auto attendant is speech-enabled
  • Use this option to enable callers to respond verbally to auto attendant prompts to navigate the menu system. By default, when an auto attendant is created it is not speech-enabled.

  • If you decide to create the UM auto attendant but not to speech-enable it, you can use the Exchange Management Console or the Exchange Management Shell to speech-enable it after you finish the New UM Auto Attendant Wizard. You can then view the properties of the auto attendant and enable this option.

Use DTMF fallback
  • Select this check box to enable the UM auto attendant to use a DTMF fallback auto attendant. A DTMF fallback auto attendant can be used only if the Auto attendant is speech-enabled option is selected. You must first create a DTMF fallback auto attendant, and then click the Browse button to locate the appropriate DTMF auto attendant.

  • A DTMF fallback auto attendant is used when the UM speech-enabled auto attendant cannot understand or recognize the speech inputs from the caller. If the DTMF auto attendant is used, the caller is required to use DTMF inputs to navigate the menu system, spell a user's name, or use a custom menu prompt. A caller will be unable to use voice commands to navigate this auto attendant.

  • If you do not configure a DTMF fallback auto attendant, we recommend that you configure an operator extension number on the auto attendant. If you do not configure an operator extension numbers, when callers use a speech-enabled auto attendant and the system does not recognize their voice inputs, they will be unable to navigate the system or be transferred to an operator for help.

  • Although it is not required, we recommend that you configure the DTMF fallback auto attendant to have the same configuration as the speech-enabled auto attendant. The DTMF fallback auto attendant should not be speech-enabled.

Return to top

When you install the Unified Messaging server role, a set of default audio files for system prompts for UM dial plans and auto attendant are copied to the Unified Messaging server. Even though the system prompts must not be replaced or changed, there is a good chance that you will want to customize the audio files that will be used for greetings, announcements, and auto attendant menu prompts.

Although the system prompts must not be replaced or changed, you will probably want to customize the greetings, informational announcements, and menu prompts that are used with UM dial plans and auto attendants. After the Unified Messaging server role is installed, you can configure the UM dial plans and auto attendants to use custom audio files. You must perform the following three steps before you can enable custom voice prompts for callers:

  1. Record the custom greeting and save it as a .wav file. The Linear PCM (16 bit/sample), 8-kilohertz (kHz) audio codec must be used to encode the .wav file.

  2. Copy the customized greeting to the appropriate folder on a Unified Messaging server by using the Copy-UMCustomPrompt Exchange Management Shell cmdlet. For information about the Copy-UMCustomPrompt cmdlet, see Copy-UMCustomPrompt earlier in this white paper.

  3. Configure the auto attendant to use the customized greeting.

Use the Greetings tab on the auto attendant's Properties sheet to manage recorded greetings for the current UM auto attendant. You can select default greetings or previously recorded custom greetings for business hours and non-business hours.

Business hours greeting
  • This is the initial greeting that is played when a caller calls the auto attendant during your organization's business hours. By default, it is a system prompt that says, "Welcome to the Exchange auto attendant." This greeting plays during your organization's business hours. The business and non-business hours are configured on the auto attendant Times tab.

  • You may want to customize this greeting to represent your company such as, “Thank you for calling Woodgrove Bank." You can configure a customized business hours greeting by clicking Modify to select a previously recorded custom greeting file.

Non-Business hours greeting
  • This is the initial greeting that is played when a caller calls the auto attendant during your organization's non- business hours. By default, there are no business or non-business hours configured. Therefore, there is no default non-business hours greeting. You can configure the business and non-business hours on the auto attendant Times tab.

  • You may want to customize this greeting to represent your company, for example, “Thank you for calling Woodgrove Bank but we are now closed." You can configure a customized business hours greeting by clicking Modify to select a previously recorded custom greeting file.

Informational announcement
  • When it is enabled, this optional recording plays right after the business or non-business hours greeting. An informational announcement may state the organization's hours of operation, for example, “Our business hours are 8:30 A.M. to 5:30 P.M., Monday through Friday and 8:30 A.M. to 1:00 P.M. on Saturday.” An information announcement can also provide information that is required for compliance with company policy, for example, “Calls may be monitored for training purposes.” If it is important that callers hear the whole informational announcement, it can be marked as uninterruptible.

Business hours main menu prompt
  • The business hours main menu prompt for an auto attendant is the list of options callers hear during business hours that are defined on the Times tab. For example, "For technical support, press or say 1. For corporate offices and administration, press or say 2. For sales, press or say 3."

  • To enable a business hours main menu prompt, you must perform the following steps:

    1. Specify a custom menu prompt audio file. To use a custom business hours menu prompt, click Modify to select the default prompt or to specify a previously recorded prompt.

    2. Configure the appropriate business hours by using the Business hours option on the Times tab.

    3. Enable business hours key mapping and configure key mappings on the Key Mapping tab for the auto attendant.

Non-Business hours main menu prompt
  • The non-business hours main menu prompt for an auto attendant is the list of options callers hear during the non-business hours that are defined on the Times tab. For example, "Your call is very important to us. However, you have reached Woodgrove Bank after normal business hours. If you want to leave a message, please press or say 1 and we will return your call as soon as possible."

  • To enable a non-business hours main menu prompt, you must perform the following steps:

    1. Specify a custom menu prompt audio file. To use a custom non-business hours main menu prompt, click Modify to select the default prompt or to specify a previously recorded prompt.

    2. Configure the appropriate business hours by using the Business hours option on the Times tab.

    3. Enable non-business hours key mapping and configure key mappings on the Key Mapping tab for the auto attendant.

For more information about the secondary dialog boxes that you can use to configure custom greetings, see Organization Configuration > Unified Messaging > UM Auto Attendant > Greetings Tab > Greetings Setting Dialog Box later in this white paper.

Return to top

Use the Greeting Settings dialog box to configure a customized greeting, informational announcement, or main menu prompt audio file. You can select default greetings or custom greetings, announcements, or main menu prompts that you previously recorded for business hours and non-business hours. For more information about custom greetings, announcements, and main menu prompts, see Managing Custom Audio Prompts.

Although the Unified Messaging system prompts must not be replaced or changed, you will probably want to customize the greetings, informational announcements, and menu prompts that are used with UM dial plans and auto attendants. After the Unified Messaging server role is installed, you can configure the UM dial plans and auto attendants to use these custom audio (*.wav) files. You must perform the following steps before you can enable custom voice prompts for callers:

  1. Record the custom greeting and save it as a .wav file. The Linear PCM (16 bit/sample), 8-kilohertz (kHz) audio codec must be used to encode the .wav file.

  2. Copy the customized greeting to the appropriate folder on a Unified Messaging server by using the Copy-UMCustomPrompt cmdlet in the Exchange Management Shell. For more information about the Copy-UMCustomPrompt cmdlet, see Copy-UMCustomPrompt earlier in this white paper.

  3. Configure the auto attendant to use the customized greeting.

Greetings
  • Use this dialog box to enable or disable a custom welcome greeting. By default, callers will hear a default welcome greeting that says, “Welcome, you are connected to Microsoft Exchange.” Use the following options to specify a customized welcome greeting that is specific to your organization. The recordings must have already been recorded as .wav files. However, you may want to provide an alternative welcome greeting that is specific to your company, such as, “Welcome to Outlook Voice Access for Contoso, Ltd.”

    • Use default greeting   Use this option to enable the default welcome greeting to be played to callers. By default, this option is enabled.

    • Use custom greeting file   Use this option when you want to enable a custom welcome greeting file to be played to callers. Click Browse to locate a custom welcome greeting file that was previously recorded.

Business hours greeting
  • Use this dialog box to enable or disable a custom recording for the greeting that plays for callers during your organization's business hours. You set the open business hour schedule for your organization on the UM auto attendant Times tab.

  • This is the initial greeting that is played when a caller calls the auto attendant during business hours. By default, it is a system prompt that says, "Welcome to the Exchange Auto Attendant." However, you may want to provide a customized business hours greeting that is specific to your company, such as, “Thank you for calling Contoso, Ltd.”

    • Use default greeting   Use this option to enable the default business hours greeting to be played to callers. By default, this option is enabled.

    • Use custom greeting file   Use this option when you want to enable a custom business hours greeting file to be played to callers. Click Browse to locate a custom business hours greeting file that was previously recorded.

Non-Business hours greeting
  • Use this dialog box to enable or disable a custom recording for the non-business hours greeting that plays for callers during your organization's non-business hours. You set the open business hour schedule for your organization on the UM auto attendant Times tab.

  • This is the initial greeting that is played when a caller calls the auto attendant during your organization's non-business hours. There is no default non-business hours greeting because, by default, there are no business or non-business hours configured. However, you may want to provide a customized non-business hours greeting that is specific to your company, such as, "You have reached Contoso, Ltd. after business hours. Our business hours are from 8:00 A.M. until 5:00 P.M., Monday through Friday."

    • Use default greeting   Use this option to enable the default non-business hours greeting to be played to callers when a business hours schedule has been configured on the auto attendant. By default, this option is enabled.

    • Use custom greeting file   Use this option when you want to enable a custom business hours greeting file to be played to callers. Click Browse to locate a custom business hours greeting file that was previously recorded.

Informational announcement
  • Use this dialog box to enable or disable an informational announcement and to select a custom recording that plays immediately after a greeting. An informational announcement may state the company’s working week, for example, “Our business hours are 8:30 A.M. to 5:30 P.M., Monday through Friday, and 8:30 A.M. to 1:00 P.M. on Saturday.” It may also provide information that is required for compliance with company security policies, for example, “By using this system you agree to follow all corporate policies when you are accessing this system.” When it is important that the caller hears the whole informational announcement, it can be marked as uninterruptible.

  • By default, there is no informational announcement configured on UM dial plans or auto attendants. Use the following options to enable an informational announcement and use a custom audio file that is specific to your organization. The recordings must have already been recorded as .wav files.

    • Disable announcement   Use this option to disable an informational announcement. By default, this option is configured.

    • Informational announcement file   Use this option when you want to enable an informational announcement to be played to callers. Click Browse to locate a custom informational announcement file that was previously recorded.

    • Allow informational announcement to be interrupted   Use this option to enable the informational announcement to be interrupted by the caller. This should be enabled if you have long informational announcements. Callers may become frustrated if the informational announcement is long and they cannot interrupt the informational announcement to access the options that are provided by the UM dial plan or auto attendant.

Business hours main menu prompt
  • Use this dialog box to enable or disable a custom business hours main menu prompt. By default, if you have enabled and defined business hours key mappings on the Key Mapping tab on the UM auto attendant, the Unified Messaging Text-to-Speech (TTS) engine will synthesize a business hours main menu prompt. Alternatively, you can create a customized audio file that can be used for the business hours main menu prompt for a speech-enabled auto attendant that would say, for example, "For sales, say 1. For technical support, say 2. For administration, say 3. To reach an operator, press zero."

  • The business hours main menu prompt is the list of options that callers hear during the business hours that have been defined on the Times tab. The recordings must have already been recorded as .wav files.

    • Use default greeting   Use this option to enable the default business hours main menu prompt to be played to callers when a business hours schedule has been configured on the auto attendant. By default, this option is enabled.

    • Use custom greeting file   Use this option when you want to enable a custom business hours main menu prompt file to be played to callers. Click Browse to locate a previously recorded custom business hours greeting file.

Non-Business hours main menu prompt
  • Use this dialog box to enable or disable a custom non-business hours main menu prompt. By default, if you have enabled and defined non-business hours key mappings on the Key Mapping tab on the UM auto attendant, the Unified Messaging TTS engine will synthesize a business hours main menu prompt. Alternatively, you can create a customized audio file that can be used for the non-business hours main menu prompt for a speech-enabled auto attendant that would for say, for example, "To leave a voice message for sales, say 1. To leave a voice message for technical support, say 2. To leave a voice message for administration, say 3. To reach an after hours operator, press zero."

  • The business hours main menu prompt is the list of options callers hear during non-business hours as defined on the Times tab. The recordings must have already been recorded as .wav files.

    • Use default greeting   Use this option to enable the default non-business hours main menu prompt to be played to callers when a non-business hours schedule has been configured on the auto attendant. By default, this option is enabled.

    • Use custom greeting file   Use this option when you want to enable a custom non-business hours main menu prompt file to be played to callers. Click Browse to locate a custom business hours greeting file that was previously recorded.

Return to top

Use the Times tab on the auto attendant Properties sheet to determine the organization's open business hours. During business hours, callers hear the default business hours greeting or a customized greeting and the business hours main menu prompt if the appropriate business hours key mappings are configured on the Key Mapping tab.

Business hours
  • Use this list to select a standard schedule, or you can click Customize to create your own user-defined schedule.

  • If your business hours vary only slightly from one of the system defined schedules, you can select a schedule, and then click Customize to refine your business hours schedule.

Select time zone
  • Use this list to select your time zone. Consider whether the dial plan that is associated with the auto attendant covers more than one time zone when you set your schedule.

  • By default, the time zone is configured by using the local server's system time when the Unified Messaging server role was installed.

Holiday schedule
  • Use the Holiday schedule schedule to define days, from 12:00 A.M through 11:59 P.M., for which your organization will be closed for a holiday. Callers who reach the auto attendant during the times that you specify in the Select Holiday dialog box will hear a custom holiday greeting audio file that you define. When you configure the holiday schedule, you must also define the Holiday start date and Holiday end date.

    • Add   Use Add to create a holiday and designate a custom greeting for that holiday.

    • Edit   Use Edit to change the dates or name of a holiday and to designate a custom greeting for the holiday.

    • Remove   Use Remove to delete a holiday from the auto attendant.

For more information about how to configure the holiday schedule and greeting file in the Select Holiday dialog box, see Organization Configuration > Unified Messaging > UM Auto Attendant > Times Tab > Select Holiday later in this white paper.

Return to top

Use the Select Holiday page to define the dates your organization will be closed for holidays. Between the start and end dates you specify in the dialog box, callers who reach the auto attendant will hear the holiday greeting that you specify. After the caller hears the holiday greeting that you have provided, the non-business hours greetings and menu prompts will be played for the caller. You can also create a holiday time in an existing holiday schedule. When you are creating multiple holiday schedules, Unified Messaging lets you overlap your scheduled holiday times.

Holiday name
  • Use this text box to specify a unique name for the holiday. This is a display name that appears on the Times tab.

  • The holiday name is required, but it is used only for display purposes. Because you may want to specify multiple holidays, we recommend that you use meaningful names for your holiday schedules. The maximum length that a holiday name can be is 64 characters, and it can include spaces. However, it cannot include any of the following characters: " / \ [ ] : ; | = , + * ? < >.

Holiday greeting file
  • Click Browse to select a holiday greeting that was previously recorded. For example, "Happy Arbor Day. Contoso, Ltd. is closed until 8:00 A.M. tomorrow." This is a required field.

Holiday start date
  • Use this list to select the day that you want the holiday to start. The holiday setting start time will take effect at midnight on the day that is specified in this list.

Holiday end date
  • Use this list to select the day that you want the holiday to end. The holiday settings will end at 11:59 P.M. on the day that is specified in this list.

For more information about custom audio prompt publishing, see Understanding Custom Prompt Distribution.

Return to top

Use the Features tab on the auto attendant's Properties sheet to define the features that are available to callers who dial in to the Unified Messaging (UM) auto attendant. For example, you can configure auto attendant features such as the language that is used when callers call into the auto attendant and the ability for callers to transfer to an operator's extension number that you have defined on this property sheet.

Language
  • Use this list to select the language that callers hear when they reach the auto attendant.

  • The default language is determined when you install Microsoft Exchange Server 2007. By default, if you install the U.S. English version of the product, U.S. English is used because the auto attendant uses the language setting on the UM dial plan. If you install the German version of the product, German is listed as the default language for the auto attendant because German is listed as the default language on the UM dial plan.

  • Although you can select a different language than the language that is selected on the UM dial plan that is associated with the auto attendant, we recommended that the language settings on the dial plan and the auto attendant match. If language settings do not match, when callers call an extension number that is defined on the dial plan, callers will be presented with prompts in one language and when they dial an extension number that is associated with an auto attendant, they will be presented with prompts in a different language.

  • The language that is selected in this list is used when callers call the extension number that is defined on the properties for the UM auto attendant.

Operator extension
  • Use this box to type the extension number that is used to call an operator. This extension number can also connect the caller to a human operator or a UM-enabled mailbox or can be configured to call an external telephone number.

Allow caller to transfer to users
  • Select this check box to enable callers to transfer calls to users. By default, this option is enabled, and lets users who are associated with the dial plan transfer calls to users in the same UM dial plan. After you select this check box, you can set the group of users to whom callers can transfer by selecting the appropriate option under the Callers can contact section on this page.

  • If you disable this option and disable the Allow callers to send voice message option, the options under Callers can contact are also disabled.

Allow callers to send voice message
  • Select this check box to enable callers to send voice messages to users. By default, this option is enabled and lets users who are associated with the dial plan send voice messages to users in the same UM dial plan. After you select this check box, you can set the group of users to whom callers can send voice messages by selecting the appropriate option under the Callers can contact section on this page.

  • If you disable this option and disable the Allow caller to transfer to users option this, the options under Callers can contact are also disabled.

  • If you disable this option, the auto attendant will not invite callers to send a voice message during a system prompt.

Callers can contact
  • Use these options to determine a grouping of users to use. By default, the Users within dial plan option is selected. However, you can change the grouping of users to allow callers to transfer calls or send voice messages to users who are located in the global address list (GAL) or to a specific set of users who are contained in custom address lists by choosing from the following:

    • Users within dial plan   Use this option to allow callers who connect to the UM auto attendant to locate and contact users who are in the dial plan that is associated with the UM auto attendant.

    • Anyone in the default global address list   Use this option to allow callers who connect to the UM auto attendant to locate and contact anyone that is listed in the GAL. This includes all users who are mailbox-enabled.

    • Anyone in this address list   Use this option to allow callers who connect to the UM auto attendant to locate and contact users who are in a defined custom address list. This includes all users who are mailbox-enabled.

      importantImportant:
      The All Address Lists container is an empty container object and differs from the global address list (GAL) container. If you choose the All Address Lists container when you browse for a custom address list, there will be no UM-enabled users for callers to contact. If you want to select all the address lists in your organization, choose the Anyone in the default global address list option.
Matched name selection method
  • Use this list to select the matched name selection method for the UM auto attendant. The matched name method is used when two or more users who have the same name exist in the directory. This is also called a disambiguation field.

  • By default, the auto attendant is set to inherit from the dial plan. However, by default, the auto attendant is unable to disambiguate between two or more users who have the same name because the default setting for the Matched name selection method on the dial plan is set to None.

  • You can configure this setting on this property sheet, or you can leave the default setting on the auto attendant and configure this setting on the dial plan.

  • Select one of the following methods that provide the caller more information to help the caller select the correct user in the organization:

    • Title   Select this option to have the auto attendant include each user's title when listing matches.

    • Department   Select this option to have the auto attendant include each user's department when listing matches.

    • Location   Select this option to have the auto attendant include each user's location when listing matches.

    • None   Select this option to have no additional information given when listing matches.

    • PromptForAlias   Select this option to have the auto attendant prompt the caller for the user's alias.

    • InheritFromDialPlan   Select this option to have the auto attendant use the default setting from the dial plan that is associated with the auto attendant.

Allow transfer to operator during business hours
  • Use this check box to enable callers to be transferred a human operator during business hours by using the extension number that you configure in the Operator extension box on this property sheet. By default, this option is disabled.

  • It is useful to enable this option so that when a caller is unsuccessful at using the menu prompts or directory search to locate the required person during business hours, they can leave a voice message or connect to a human operator. After you enable this option, you can configure the operator extension number on a UM-enable mailbox that is monitored and the caller can leave a voice message or a human operator who has the extension number can help the caller.

Allow transfer to operator after business hours
  • Use this check box to enable callers to be transferred a human operator after business hours by using the extension number that you configure in the Operator extension box on this property sheet. By default, this option is disabled.

  • It is useful to enable this option so that when a caller is unsuccessful at using the menu prompts or directory search to locate the required person after business hours, they can leave a voice message or connect to a human operator. After you enable this option, you can configure the operator extension number configured on a UM-enable mailbox that is monitored and the caller can leave a voice message or a human operator who has the extension number can help the caller.

Return to top

Use the Key Mapping tab on the auto attendant's Property sheet to define the telephone keys that callers can press when they reach the Unified Messaging (UM) auto attendant. You can define separate key mappings for business hours and non-business hours. A key mapping is defined as an entry in a table that has as many as nine entries. The 0 (zero) key is reserved for a transfer to the operator.

For example, a key mapping that is used during business hours may enable a call transfer to another extension where a human operator or receptionist is available. For non-business hours, the option to transfer to another extension may not be available, or the call may be forwarded to a UM-enabled mailbox so the caller can leave a voice message.

Enable business hours key mapping

Use this check box to enable specific key mappings that will be used during business hours. When you enable business hours key mapping, you can add new key mappings for business hours.

  • Add   Use this option button to create a key mapping and configure the appropriate key mappings.

  • Edit   Use this option button to change the key mappings for a key mapping entry.

  • Remove   Use this option button to delete a key mapping entry.

Enable non-business hours key mapping

Use this check box to enable specific key mappings that will be used during non-business hours. When you enable non-business hours key mapping, you can add new key mappings for non-business hours.

  • Add   Use this option button to create a key mapping and configure the appropriate key mappings.

  • Edit   Use this option button to change the key mappings for a key mapping entry.

  • Remove   Use this option button to delete a key mapping entry.

For more information about the Key Mapping Entry dialog box, see Organization Configuration > Unified Messaging > UM Auto Attendant > Key Mapping Tab > Key Mapping Entry later in this white paper.

Return to top

Use the Key Mapping Entry dialog box to configure a single or multiple key mappings for business or non-business hours main menu prompts. You can define the operation that will be performed when the key on the telephone keypad is selected, for example, transferring the call to an extension number or another auto attendant.

Key pressed
  • Use this button to enable a key mapping. The key mapping is the number key that a caller would push to have the auto attendant perform a specific operation, for example, forwarding the caller to another auto attendant or to an operator. By default, no entries are defined.

  • Use the text box to type the numeric key (1-9) that the caller must press. Zero (0) is reserved for the auto attendant operator.

Timed out because no key was pressed
  • Use this button to enable the caller to be transferred to an extension number or to another auto attendant if they do not press a key on the telephone keypad. For example, "Please stay on the line and your call will be answered by the next available representative." By default, this option is disabled.

  • If you enable this option, a blank key mapping will be created.

Name
  • Use this field to type the name of the key mapping entry. The key mapping name is used for display purposes only. This is a required field and you must provide a display name for the key mapping entry.

  • Because you may want to specify multiple key mappings, we recommend that you use meaningful names for your key mappings. The maximum length of the name for the key mapping is 64 characters, and it can include spaces. However, it cannot include any of the following characters: " / \ [ ] : ; | = , + * ? < >.

Enable Audio File
  • Use this check box to enable an audio file to play when a caller presses the key that is specified in the Key pressed setting. By default, this setting is disabled.

    • Audio file   Use this text box to enter the name and location of the audio file to play. Click Browse to locate the audio file that you want to play.

  • If you enable this option, the audio file that you specify here will be played to the caller after the business hours or non-business main menu prompt plays.

Enable call transfer
  • Select this check box to enable calls to be transferred to an extension number or another auto attendant.

    • Extension   Click this button to transfer the call to an extension number. Use the text box to type the extension where the call will be transferred. This field allows only numeric characters. It cannot include any of the following characters: " / \ [ ] : ; | = , + * ? < >.

    • Auto attendant   Click this button to transfer the call to an auto attendant. Click Browse to locate the auto attendant that you want to use. Before you enable this option, you must first create and configure the auto attendant. This option is used when you are creating a parent/child structure of UM auto attendants.

Return to top

Use the New UM Auto Attendant page to create a new auto attendant. Microsoft Exchange Server 2007 Unified Messaging (UM) enables you to create a single or multiple UM auto attendants, depending on the needs of your organization. Unlike other Unified Messaging objects, such as UM dial plans and UM IP gateways, you are not required to create UM auto attendants. However, auto attendants help internal and external callers locate users or departments that exist in an organization and transfer calls to them.

Auto Attendant name
  • Use this text box to create the display name for the UM auto attendant. A UM auto attendant name is required and must be unique. However, it is used only for display purposes in the Exchange Management Console and the Exchange Management Shell.

  • If you have to change the display name of the auto attendant after it has been created, you must first delete the existing UM auto attendant and then create another auto attendant that has the appropriate name. If your organization uses multiple UM auto attendants, we recommend that you use meaningful names for your UM auto attendants.

  • The maximum length of a UM auto attendant name is 64 characters, and it can include spaces.

  • The number of extension numbers that are entered is unlimited.

Select associated dial plan
  • Click the Browse button to select the UM dial plan to be associated with this UM auto attendant. Selecting and associating a UM dial plan with the auto attendant is required. A UM auto attendant can be associated with only one UM dial plan.

Extension numbers
  • Use this field to enter the extension number that callers will use to reach the auto attendant. Type an extension number in the field, and then click Add to add the extension to the list. The number of digits in the extension number that you provide do not have to match the number of digits for an extension number that is configured on the associated UM dial plan. This is because direct calls are allowed to UM auto attendants.

  • You can enter a maximum of 16 extensions. However, you may create the new auto attendant without an extension number listed. An extension number is not required.

  • You can edit or remove an existing extension number. To edit an existing extension number, click the Edit button. To remove an existing extension number from the list, click the Remove button.

Create auto attendant as enabled
  • Select this option to enable the auto attendant to answer incoming calls when you complete the New Auto Attendant Wizard. By default, a new auto attendant is created as disabled.

  • If you decide to create the UM auto attendant as disabled, you can use the Exchange Management Console action pane or the Exchange Management Shell to enable the auto attendant after you finish the wizard.

Create auto attendant as speech-enabled
  • Select this check box to speech-enable the UM auto attendant. By speech-enabling the auto attendant, callers can respond to the system or custom prompts that are used by the UM auto attendant by using touchtone or voice inputs. By default, the auto attendant will not be speech-enabled when it is created.

  • For callers to use a speech-enabled auto attendant, you must install the appropriate Unified Messaging language pack that contains Automatic Speech Recognition (ASR) support and configure the properties of the auto attendant to use this language.

Return to top

Use the Completion page to confirm whether the new UM auto attendant was created successfully. Click Finish to complete the New UM Auto Attendant wizard.

A status of Completed indicates that the wizard completed the task successfully. A status of Failed indicates that the task was not completed. If the task failed, review the summary for an explanation, and then click Back to make any configuration changes.

For more information about how to make configuration changes to the UM auto attendant, see How to Modify a Unified Messaging Auto Attendant.

The summary pane lists the following fields:

Management Shell command

This field lists the Exchange Management Shell command that was used to create the new UM auto attendant. If the task is successful, the text in this field is displayed as Management Shell command completed. If the task fails, the text in this field is displayed as Management Shell command attempted.

For more information about the New-UMAutoAttendant cmdlet, see New-UMAutoAttendant earlier in this white paper.

For more information about the Exchange Management Shell, see Using the Exchange Management Shell.

Elapsed Time

This field indicates the time that it took for the wizard to finish the task. If the elapsed time is 00:00:00, this indicates that the task took less than 1 second to finish.

noteNote:
You can press CTRL+C to copy the text in the summary pane to the Clipboard. After the text has been copied to the Clipboard, you can paste it into a document or screen.

After the UM auto attendant is created, we recommend that you perform the following task:

Return to top

In Microsoft Exchange Server 2007, the Unified Messaging server role is one of several server roles that you can install and then configure on a computer that is running Exchange 2007. Unified Messaging combines voice messaging, fax, and e-mail messaging into one store that users can access from a telephone and a computer.

There are several post-installation tasks that must be performed to successfully deploy an Exchange 2007 Unified Messaging (UM) server. After you verify that you successfully installed the Unified Messaging server role on a computer that is running Exchange 2007, you must do the following:

  • Verify or create and then configure several UM components.

  • Associate the Unified Messaging server with a UM dial plan.

  • Configure and deploy an IP/VoIP gateway.

  • Test your Unified Messaging configuration by using the UM Test Phone.

After you install the Unified Messaging server role, verify that the following UM components are created:

  • Verify that a UM dial plan has been created. When you create a new UM dial plan, a new UM mailbox policy will also be created. For more information about how to create a new UM dial plan, see How to Create a New Unified Messaging Dial Plan.

  • Verify that a UM mailbox policy has been created. By default, when you create a UM dial plan, a UM mailbox policy is also created. However, you may want to create additional UM mailbox policies. For more information about how to create a new UM mailbox policy, see How to Create a New Unified Messaging Mailbox Policy.

  • Verify that a UM IP gateway has been created. When you create a new UM IP gateway and associated it with a UM dial plan, a UM hunt group will also be created. For more information about how to create a new UM IP gateway, see How to Create a New Unified Messaging IP Gateway.

  • Verify that a UM hunt group has been created. This may be optional if you created a UM IP gateway and associated it with a UM dial plan. However, you may also need to create additional UM hunt groups. For more information about how to create a new UM hunt group, see How to Create a New Unified Messaging Hunt Group.

  • Optionally you may want to create a new UM auto attendant. For more information about how to create a new Unified Messaging auto attendant, see How to Create a New Unified Messaging Auto Attendant.

After you create all the required UM components, you must associate the Unified Messaging server with a UM dial plan. For more information about how to associate a Unified Messaging server with a UM dial plan, see How to Add a Unified Messaging Server to a Dial Plan.

After you install, enable, and configure Unified Messaging (UM) in Exchange 2007, you can use the Exchange UM Test Phone application (ExchangeUMTestPhone.exe) to help you test the overall operation and functionality of the Unified Messaging server. You can use the UM Test Phone application (ExchangeUMTestPhone.exe) to isolate problems that may occur or to help you troubleshoot Unified Messaging. For more information about the UM Test Phone, see Testing a Unified Messaging Server with the Unified Messaging Test Phone.

Return to top

Unified Messaging combines voice messaging, fax, and e-mail messaging into one store that users can access from a telephone and a computer. Microsoft Exchange Server 2007 Unified Messaging integrates Microsoft Exchange with telephony networks and brings the Unified Messaging features to the core of Exchange.

There are multiple methods that you can use to install the Unified Messaging server role on a computer that is running Exchange 2007. You can install the Unified Messaging server role on a single computer that has no other Exchange 2007 server roles installed or on a computer that is running another Exchange 2007 server role.

noteNote:
To modify how server configuration objects are displayed in Microsoft Management Console (MMC), click View in the action pane. For more information about view options, see Server Configuration.

After you install the Unified Messaging server role, you must perform other tasks before the Unified Messaging server can process incoming calls.

Although the operational status of the Unified Messaging server is set to enabled after installation, the Unified Messaging server maintains a logical status parameter that is used to control the operational status of the Exchange 2007 Unified Messaging server. The logical status parameter lets you stop call processing so that you can take the Unified Messaging server offline in a controlled way.

You can control the operational status of the Unified Messaging server by using the enable and disable commands in the Exchange Management Console and the Exchange Management Shell. There are three status modes for Unified Messaging servers:

  • Enabled - Process all incoming calls.

  • Disable immediately - Do not accept any new calls and drop all existing calls.

  • Disable after completing calls- Do not accept any new calls but process all existing calls.

For more information about how to enable a Unified Messaging server, see How to Enable Unified Messaging on Exchange 2007.

For more information about how to disable a Unified Messaging server, see How to Disable Unified Messaging on Exchange 2007.

Return to top

Use the UM Server Configuration tab to view and configure settings for the Unified Messaging (UM) server. For example, you can add or remove the UM dial plans that are associated with the UM server or view the languages that are supported by the UM server.

After the Unified Messaging server role has been installed on a computer that is running Microsoft Exchange Server 2007, you can change UM server-specific settings. The settings that you modify apply only to the local UM server. When you modify the settings found on the UM server, those modifications are applied immediately after you click Accept.

Use this page to configure the following settings for a UM server:

Associated Dial Plans
  • Use this text box to view the UM dial plans that are associated with the UM server.

  • When you install the Unified Messaging server role on a computer that is running Exchange 2007, the server is left in an enabled state. However, for the Unified Messaging server to answer and process incoming calls, you must also associate a UM dial plan with the UM server.

  • An Exchange 2007 Unified Messaging server can be associated with multiple UM dial plans at the same time. After you associate the UM server with a UM dial plan, the UM server will process incoming calls for users who are associated with the UM dial plan.

  • Modifications to the UM dial plans that are associated with the UM server should be performed only by an administrator who fully understands the implications of making configuration changes to the UM server.

Prompt languages
  • Use this text box to view the languages that are supported by the Unified Messaging server. The languages that are listed in this text box are the languages or language packs that are installed on the UM server.

  • For example, in the US-English release of Exchange 2007, US-English is the only language installed on the UM server. However, in the French release of Exchange 2007, French and US-English are the languages available by default.

  • If you want to install additional languages, you can install them on the UM server by running the Setup.com /AddUMLanguagePack command.

  • After the language pack is installed on the UM server, the UM server supports the additional languages. The language packs are located in the <dvdroot>\UMLang\<language> folder on the Exchange 2007 installation DVD.

Maximum concurrent calls
  • Use this text box to specify the number of concurrent incoming voice call connections that the Unified Messaging server will accept.

  • When you increase the number of concurrent connections on a UM server, more system resources are required than if you decrease the number of concurrent voice call connections. Decreasing this setting is especially important on low-end, slower computers on which Unified Messaging is installed.

  • The range for this setting is 0 to 200. The default setting is 100. There are performance counters that you can use to monitor the current number of voice calls that are connected to a UM server.

Maximum concurrent fax calls
  • Use this text box to specify the maximum number of fax connections that the Unified Messaging server will accept.

  • When you increase the number of concurrent fax connections on a Unified Messaging server, more system resources are required than if you decrease the number of concurrent connections. Decreasing this setting is especially important on low-end, slower computers on which Unified Messaging is installed.

  • The range for this setting is 0 to 200. The default setting is 100. There are performance counters that you can use to monitor the current number of fax calls that are connected to a UM server.

After you modify the settings on this page, click Apply to accept the changes.

Return to top

The following are additional settings that you can use to manage Unified Messaging users and mailboxes:

  • Recipient Configuration > Mailbox > Reset Unified Messaging PIN

  • Enable Unified Messaging Wizard > Enable Unified Messaging

  • Enable Unified Messaging Wizard > Completion Page

  • Mailbox User Properties > Mailbox Features Tab > Unified Messaging Properties

Return to top

Use the Reset Unified Messaging PIN dialog box to reset the Outlook Voice Access PIN for a specific user. You can configure Unified Messaging to automatically generate a PIN or you can manually specify the PIN for Outlook Voice Access users.

Automatically generate PIN to access Outlook Voice Access
  • Use this option to automatically generate the PIN that is used by the user to gain access to their mailbox by using Outlook Voice Access. By default, this setting is enabled.

  • The automatically generated PIN will be sent in an e-mail message to the user's mailbox. After they receive the PIN and log on to their mailbox, they will be prompted to change the PIN to a PIN that is more familiar to them.

  • Outlook Web Access for Microsoft Exchange Server 2007 and Office Outlook 2007 let the user reset their PIN. The PIN is automatically generated based on the PIN policies that are configured on the UM mailbox policy that is associated with the user's mailbox.

  • We recommend that you automatically generate PINs for Outlook Voice Access users.

Manually specify PIN
  • Use this option to manually specify a PIN for an Outlook Voice Access user. By default, this setting is disabled.

  • If you specify a PIN for a user, the PIN will be sent in an e-mail message to the user's mailbox. After they receive the PIN and log on to their mailbox, they can change the PIN by configuring personal options in Outlook Voice Access. However, in Outlook Web Access for Exchange 2007 and Outlook 2007, there is no option to manually specify a PIN.

Require user to reset PIN at first logon
  • Use this option to require the user to reset their PIN when they first log on to Outlook Web Access. By default, this option is disabled.

  • If you select the option to automatically generate a PIN for a user, enabling this option that requires users to change their PIN when they first log on to Outlook Voice Access helps protect the user's PIN.

Return to top

Use the Enable Unified Messaging Wizard to enable an existing Microsoft Exchange Server 2007 user's mailbox for Unified Messaging. After you successfully enable the user's mailbox for Unified Messaging, UM servers that are associated with the UM dial plan that the user is associated with will accept incoming calls for the extension number that is configured for the user. You can configure this extension number automatically or manually by using the Enable Unified Messaging Wizard. An extension number is required for each UM-enabled user. The extension number must be the correct number of digits, as specified in the UM dial plan for the UM Mailbox policy.

After a mailbox-enabled recipient is enabled for Unified Messaging, you should perform the following tasks:

To enable a user for Unified Messaging by using the Enable Unified Messaging wizard, on the Enable Unified Messaging page, complete the following information:

Unified Messaging Mailbox Policy
  • Use this text field to select the Unified Messaging mailbox policy that you want to associate with a user's mailbox.

  • UM mailbox policies define settings such as PIN policies, dialing restrictions, and message text for Unified Messaging messages that are sent to the user. Each UM-enabled user is required to be associated with at least one UM mailbox policy. However, the UM-enabled user can be associated with only one UM mailbox policy.

  • You must create the UM mailbox policy before you enable Unified Messaging for a user's mailbox.

Automatically generated mailbox extension
  • Click this button if you want the extension number for the user's mailbox to be automatically generated from the telephone number specified in Active Directory and used to populate the field. This setting is enabled by default.

  • For the user's extension number to populate this field, you can enter the telephone number in the Business field on Address and Phone tab in the user properties in the Exchange Management Console. You can also configure a telephone number for a user by configuring the Telephone number field on the General tab on the user account by using Active Directory Users and Computers.

  • If you select this option, the extension number that is generated automatically for the user will comply with the number of digits that is specified for the dial plan with which the UM mailbox policy that you selected is associated. For example, if the dial plan is configured with 5-digit extension numbers, the Unified Messaging server will take the last 5 digits of the user's telephone number and use those digits to populate this field.

  • UM dial plans are typically configured to have extensions that are three to seven digits long.

Manually entered mailbox extension
  • Click this button if you want to manually configure the extension number for the user's mailbox.

  • If you select this option, you must supply the extension number for the user. If you select this option, you must provide a valid extension number for the user and must match the number of digits specified on the dial plan. You can configure this field to contain a value range of numeric characters or digits from 1 to 20. The typical extension number is from three to seven digits long and is configured on the dial plan with which the UM mailbox policy is associated.

  • If your existing telephony environment includes extension numbers, you should specify a number of digits that matches the number of digits in those extensions. The number of digits that you specify is the default setting after a UM mailbox policy is selected.

Automatically generate PIN to access Unified Messaging
  • Click this button to automatically generate a PIN for the UM-enabled user. This is the default setting.

  • If this option is selected, a PIN is automatically generated based on the PIN policies that are configured on the UM mailbox policy that is associated with the recipient.

  • It is generally recommended that you use this setting to help protect the user's PIN.

  • The first time that the user logs on to their mailbox using Outlook Voice Access, they will be prompted to change their PIN.

Specify PIN to access Unified Messaging
  • Click this button to manually specify a PIN that a recipient will use to access the Unified Messaging system.

  • The PIN must comply with the PIN policy settings that are configured on the UM mailbox policy that is associated with this recipient. For example, if the UM mailbox policy is configured to only accept PINs that contain seven or more digits, the PIN you enter in this text box must be at least seven digits long.

Require user to reset PIN on first telephone logon
  • Use this check box to force the user to reset their Unified Messaging PIN when they access the Unified Messaging system from a telephone.

  • It is a security best practice to force a UM-enabled user to change their PIN at their first logon to help protect against unauthorized access to their data and Inbox. This is the default setting.

After you complete the fields on the Enable Unified Messaging page of the Enable Unified Messaging Wizard, click Enable to enable Unified Messaging on the user's mailbox.

Return to top

Use the Completion page to confirm whether the user was successfully enabled for Unified Messaging. Click Finish to complete the Enable Unified Messaging Wizard.

A status of Completed indicates that the wizard completed the task successfully. A status of Failed indicates that the task was not completed. If the task failed, review the summary for an explanation, and then click Back to make any configuration changes.

For more information about how to make configuration changes to a UM-enabled user, see How to Modify the Unified Messaging Properties for a User.

The summary pane lists the following fields:

Management Shell command

This field lists the Exchange Management Shell command that was used to enable a user for UM. If the task is successful, the text in this field is displayed as Management Shell command completed. If the task fails, the text in this field is displayed as Management Shell command attempted.

For more information about the Enable-UMMailbox cmdlet, see Enable-UMMailbox earlier in this white paper.

For more information about the Exchange Management Shell, see Using the Exchange Management Shell.

Elapsed Time

This field indicates the time that it took for the wizard to finish the task. If the elapsed time is 00:00:00, this indicates that the task took less than 1 second to finish.

noteNote:
You can press CTRL+C to copy the text in the summary pane to the Clipboard. After the text has been copied to the Clipboard, you can paste it into a document or screen.

After you have enabled a user for UM, we recommend that you perform the following tasks:

Return to top

Use the Unified Messaging Properties page to view or change the Unified Messaging (UM) properties for an existing Exchange Server 2007 recipient who is UM-enabled. When you change a user's UM properties, you can control the various UM features for the user that are found in Microsoft Exchange Server 2007. For example, you can enable or disable Automatic Speech Recognition (ASR) or fax receiving or associate the user's mailbox with a different UM mailbox policy.

UM Mailbox Status
  • This display-only field shows the status of the user's mailbox. By default, when a user is UM-enabled, the mailbox status is listed as Not locked out. However, if the user has input an incorrect Outlook Voice Access PIN multiple times, the status is listed as Locked Out.

Unified Messaging Mailbox Policy
  • This display-only field shows the name of the UM mailbox policy that is associated with the UM-enabled user. You can specify the UM mailbox policy to be associated with this UM mailbox by clicking the Browse button.

  • If you want to change the UM mailbox policy that is associated with multiple users, consider using the Set-UMMailbox cmdlet in the Exchange Management Shell. For information about the Set-UMMailbox cmdlet, see Set-UMMailbox earlier in this white paper.

Mailbox extensions
  • Use this field to specify one or more extension numbers for the user. This field accepts only numeric characters. This field is required.

  • When you add a mailbox extension number, it must be valid for the dial plan that is associated with the UM mailbox policy that is specified in the Unified Messaging mailbox policy. The extension number must also be unique within the given dial plan. For example, if the dial plan is configured to use a 5 digit extension number, you will have to input a 5 digit extension number for the user.

Enable for Automatic Speech Recognition
  • Select this option to specify whether the user can use ASR when they log on to their mailbox. By default, a UM-enabled user can use voice commands when they use Outlook Voice Access to access their mailbox.

  • Even if an Outlook Voice Access user is speech-enabled, they must still use the key pad to enter their extension number, PIN, and personal options.

Allow UM Calls from non-users
  • Select this option to specify whether to allow incoming calls from unauthenticated callers through an auto attendant to be transferred to the UM-enabled user. By default, this setting is enabled. Enabling this setting allows callers from outside an organization to be transferred to a user inside an organization.

  • The user's mailbox can still be accessed by using directory searches, but if an external caller tries to transfer to a user for whom this setting is disabled, the system will say, "I'm sorry, I am unable to transfer the call to this user." The caller is then transferred to the operator that is configured on the auto attendant.

  • This setting does not apply to callers who have logged on to their mailbox by using Outlook Voice Access and are sending a voice mail message to a user.

Allow faxes to be received
  • Select this option to specify whether a user is allowed to receive incoming faxes. By default, this setting is enabled, but it can be disabled if you do not want the user to receive incoming faxes.

  • This setting is also configured on dial plans. If you enable this setting for a UM-enabled user, but the dial plan is configured to disable fax receiving, the UM-enabled user will be unable to receive faxes.

Diverted calls without a caller ID can leave a message   
  • Select this option to specify whether diverted calls without a caller ID will be allowed to leave a message. By default, this option is enabled.

  • This enables the UM-enabled user to accept anonymous calls from callers.

Personal operator extension
  • Use this field to specify the operator extension number for the user. By default, an extension number is not configured. The range for the extension number is 1 to 20 characters. This enables incoming calls for the UM-enabled user to be forwarded to the extension number that you specify in this field.

  • You can configure other types of operator extension numbers on dial plans and auto attendants. However, those extensions are generally meant for company-wide receptionists or operators. The personal operator extension setting could be used when an administrative assistant or personal assistant answers incoming calls before they are answered for a particular user.

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) components, features, and services generate errors and events to enable you to effectively troubleshoot and monitor a Unified Messaging server.

Event Viewer maintains logs about program, security, and system events on your computer. You can use Event Viewer to view and manage the event logs, gather information about hardware and software problems, and monitor Windows security events. Although Event Viewer is a Microsoft Windows operating system tool and not a Microsoft Exchange tool, Event Viewer is useful when you troubleshoot problems with Microsoft Exchange. This section describes the basic concepts related to Event Viewer.

This section also describes the events that Unified Messaging lists in Event Viewer, explains how to use them to monitor Unified Messaging, and describes the error messages that are generated by a Unified Messaging server.

Unified Messaging generates errors and events in Event Viewer so that you can troubleshoot and verify the performance of Unified Messaging components, features, and services. Event Viewer tracks error events, warning events, and informational events in order of importance. The logs in Event Viewer provide an audited record of all services and processes in the Microsoft Windows Server 2003 operating system.

Unified Messaging errors and events are grouped into six categories that are based on core components, processes, and services of Unified Messaging. You can also filter the errors or events that have been generated by a Unified Messaging server by category. The categories for Unified Messaging error and events include the following:

  • UMCallData

  • UMClientAccess

  • UMCore

  • UMManagement

  • UMService

  • UMWorkerProcess

The following is a list of the Unified Messaging errors and events. They are grouped according to the administrative functionality of the errors and events that are generated by a Unified Messaging server.

  • Unified Messaging Administrative Errors and Events

  • Unified Messaging Auto Attendant Errors and Events

  • Unified Messaging Call Answering Errors and Events

  • Unified Messaging Call Transfer Errors and Events

  • Unified Messaging Fax Answering Errors and Events

  • Unified Messaging Outdialing Errors and Events

  • Unified Messaging Performance Errors and Events

  • Unified Messaging Prompt Publishing Errors and Events

  • Unified Messaging Speech Grammar Error and Events

  • Unified Messaging Subscriber Access Errors and Events

  • Unified Messaging System Errors and Events

  • Unified Messaging Active Directory Errors and Events

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates administrative events in Event Viewer so that you can troubleshoot and verify the performance of UM administrative components, features, and services. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 2 provides a list of the UM administrative events that you can use to troubleshoot and monitor Unified Messaging.

Table 2   Administrative events

Event ID Category Event type Logging Value or description Class

1015

UMManagement

Information

LogAlways

User "%1" has been successfully enabled for Unified Messaging.

Administrative

1016

UMManagement

Information

LogAlways

User "%1" has been disabled for Unified Messaging.

Administrative

1017

UMManagement

Information

LogAlways

The Unified Messaging mailbox for UM-enabled user "%1" has been successfully unlocked.

Administrative

1018

UMManagement

Information

LogAlways

The Outlook Voice Access PIN for user "%1" has been changed.

Administrative

1060

UMManagement

Information

LogAlways

A new UM dial plan named "%1" was created.

Administrative

1061

UMManagement

Information

LogAlways

A new UM IP gateway named "%1" with IP address "%2" has been created.

Administrative

1062

UMManagement

Information

LogAlways

A new Unified Messaging hunt group named "%1" has been created with pilot identifier "%2" and is associated with UM dial plan "%3".

Administrative

1063

UMManagement

Information

LogAlways

The dial plan named "%1" has been removed.

Administrative

1064

UMManagement

Information

LogAlways

IP gateway "%1", which has IP address "%2", has been removed.

Administrative

1065

UMManagement

Information

LogAlways

The UM hunt group "%1" with the pilot identifier "%2" that is associated with UM dial plan "%3" has been removed.

Administrative

1066

UMManagement

Information

LogAlways

Unified Messaging server "%1" has been enabled.

Administrative

1067

UMManagement

Information

LogAlways

The UM IP gateway "%1" with IP address "%2" has been enabled.

Administrative

1068

UMManagement

Information

LogAlways

The Unified Messaging server named "%1" has been disabled.

Administrative

1069

UMManagement

Information

LogAlways

The Unified Messaging IP gateway "%1" with the IP address "%2" has been disabled.

Administrative

1070

UMManagement

Information

LogAlways

A new UM auto attendant named "%1" was created and associated with UM dial plan "%2".

Administrative

1071

UMManagement

Information

LogAlways

The UM auto attendant named "%1" has been enabled.

Administrative

1072

UMManagement

Information

LogAlways

The auto attendant named "%1" has been disabled.

Administrative

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates UM auto attendant events in Event Viewer so that you can troubleshoot and verify the performance of the UM auto attendant components, features, and services. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 3 provides a list of the UM auto attendant events that you can use to troubleshoot and monitor Unified Messaging.

Table 3   Auto attendant events

Event ID Category Event type Logging Value or description Class

1128

UMService

Error

LogPeriodic

No operator extension number has been configured for the UM auto attendant named "%1", or for the dial plan to which it belongs. Therefore, incoming calls received by this UM auto attendant cannot be transferred to the operator.

Auto Attendant

1129

UMService

Warning

LogAlways

The Unified Messaging auto attendant "%1" has not been configured with a valid time zone. Incoming calls answered by the UM auto attendant will be answered according to the time zone that has been configured on the Unified Messaging server that answers the call. To resolve this error, configure a valid time zone on the UM auto attendant.

Auto Attendant

1154

UMCore

Warning

LogAlways

An error occurred while adding a custom menu speech grammar entry for "%1" in auto attendant "%2". Details follow: "%3"

Auto Attendant

1156

UMCore

Warning

LogAlways

Auto attendant "%1" is configured to use "%2", a language that is not supported on this Unified Messaging server. The auto attendant will use "%3", which is the default language of the associated dial plan "%4"'.

Auto Attendant

1164

UMCore

Warning

LogAlways

A call to auto attendant "%1" was not handled. "%2"

Auto Attendant

1172

UMCallData

Information

LogAlways

Call data: "%1"

Auto Attendant

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates call answering events in Event Viewer so that you can troubleshoot and verify the performance of the call answering components, features, and services. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 4 provides a list of the call answering events that you can use to troubleshoot and monitor Unified Messaging.

Table 4   Call answering events

Event ID Category Event type Logging Value or description Class

1004

UMCore

Information

LogAlways

A call was received with the following parameters: Calling Party: "%1", Called Party: "%2", Diversion Information: "%3", Call ID "%4".

Call Answering

1006

UMCore

Information

LogAlways

The Unified Messaging server has received a call from "%1", with user extension "%2" and a call ID of "%3".

Call Answering

1021

UMCore

Warning

LogAlways

The Unified Messaging server rejected an incoming call with the ID "%1". Reason: "%2"

Call Answering

1081

UMCore

Warning

LogAlways

The Unified Messaging server failed to receive an incoming call for user "%1" during the call with ID "%2" because a Hub Transport server is currently busy or not available. To correct this error, make sure that there is at least one Hub Transport server installed in the same Active Directory site as the Unified Messaging server and that a Hub Transport server is available.

Call Answering

1082

UMService

Error

LogAlways

The Unified Messaging server was unable to submit messages to a Hub Transport server because there is no Hub Transport server available to process the request with UM header file "%1". Make sure that there is a Hub Transport server located in the same Active Directory site as the UM server. In addition, make sure that the Microsoft Exchange Transport service is started on the Hub Transport server.

Call Answering

1109

UMCore

Warning

LogAlways

The Unified Messaging server has received an inbound call that has an invalid extension "%1" for UM dial plan "%2". The call ID is "%3".

Call Answering

1146

UMCore

Warning

LogAlways

The Unified Messaging server was unable to resolve the caller ID "%1" to a user in Active Directory or personal contact before attempting to submit voice mail to the Hub Transport server. The recipient of the message was "%2". More information: "%3"

Call Answering

1153

UMCore

Information

LogAlways

The Unified Messaging server received an incomplete number of digits for the extension number with ID "%1". The number of digits received was %2. This does not match the number of digits that was configured on dial plan "%3", which is %4. Because the number of digits does not match the number configured on the dial plan, the Unified Messaging server will send this call to the dial plan pilot number.

Call Answering

1169

UMCore

Warning

LogAlways

The user with extension "%1" is not enabled for Unified Messaging.

Call Answering

1170

UMCallData

Information

LogAlways

Call data: %1

Call Answering

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates call transfer events in Event Viewer so that you can troubleshoot and verify the performance of call transfers in Unified Messaging. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 5 provides a list of the UM call transfer events that you can use to troubleshoot and monitor Unified Messaging.

Table 5   Call transfer events

Event ID Category Event type Logging Value or description Class

1024

UMCore

Information

LogAlways

The Unified Messaging server is transferring a call from "%1", with diversion "%2", to extension number "%3". The call ID is "%4".

Call Transfer

1025

UMCore

Error

LogAlways

The voice call with ID "%1" did not transfer to "%2" because: "%3"

Call Transfer

1026

UMCore

Information

LogAlways

A call was transferred successfully from "%1", with diversion information "%2", to extension number "%3". The call ID was "%4".

Call Transfer

1073

UMManagement

Information

LogAlways

The Unified Messaging server transferred a call to "%1".

Call Transfer

1136

UMCore

Warning

LogAlways

An error occurred while transferring the call to the phone number "%1". The call ID is: "%2".

Call Transfer

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates fax answering events in Event Viewer so that you can troubleshoot and verify the performance of the Unified Messaging fax answering components, features, and services. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 6 provides a list of the fax answering events that you can use to troubleshoot and monitor Unified Messaging.

Table 6   Fax answering events

Event ID Category Event type Logging Value or description Class

1022

UMCore

Information

LogAlways

The Microsoft Exchange Unified Messaging service has received a fax call with ID "%1".

Fax

1023

UMCore

Information

LogAlways

The fax call with ID "%1" ended for the following reason: "%2"

Fax

1027

UMCore

Information

LogAlways

The Unified Messaging server has successfully received a fax from "%1" for "%2" at extension number "%3". The fax contains %4 pages. The fax call was %5 seconds long. The call was received from IP gateway "%6".

Fax

1028

UMCore

Information

LogAlways

The fax call from "%1" for "%2" at number "%3" was received but no pages were received. The fax call was %4 seconds long. The fax call was received from UM IP gateway "%5".

Fax

1029

UMCore

Information

LogAlways

A fax call from "%1" for "%2" at number "%3" failed to complete. The fax contained %4 pages. The fax call was %5 seconds long. The call was received from UM IP gateway "%6".

Fax

1030

UMCore

Information

LogAlways

The Unified Messaging server has received both fax and audio media from "%1" for "%2" at number "%3". The fax contains %4 pages. The fax call was %5 seconds long. The call came through IP/VoIP gateway "%6".

Fax

1031

UMCore

Warning

LogAlways

The fax call has exceeded the configured time for a call. The call was made from %1 for %2 at number %3. The fax contains %4 pages. The fax call was %5 seconds long. The call came through gateway %6.

Fax

1032

UMCore

Warning

LogAlways

The UM dial plan that is associated with the Unified Messaging server is not configured to receive fax messages or the maximum number of concurrent fax calls on the Unified Messaging server is set to 0. The fax message that originated from telephone number "%1" and was destined for user "%2" at extension "%3" was terminated. To resolve this issue, use the Exchange Management Console or the Set-UMDialPlan cmdlet to enable the dial plan to receive incoming faxes or increase the maximum number of concurrent fax calls that can be accepted by the Unified Messaging server.

Fax

1033

UMCore

Warning

LogAlways

The Unified Messaging-enabled user "%1" is not configured to receive fax messages. The fax message that originated from phone number "%2", destined for extension "%3", was terminated. To resolve this issue, use the Exchange Management Console or the Set-UMMailbox cmdlet to enable the user to receive incoming fax messages.

Fax

1034

UMCore

Warning

LogAlways

The number of fax calls currently connected to the Unified Messaging server has exceeded the maximum number (%1) that is allowed. The fax call that originated from telephone number "%3" for user "%3" at extension "%4" was disconnected. To resolve this warning, increase the maximum number of concurrent fax connections that the Unified Messaging server will accept or install another Unified Messaging server to accept incoming fax calls.

Fax

1150

UMCore

Warning

LogAlways

The Unified Messaging server was unable to create a message for the fax call with ID "%1". The following invalid media details were received in the session description: "%2".

Fax

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates outdialing events in Event Viewer so that you can troubleshoot and verify the performance of the outdialing feature in Exchange 2007 Unified Messaging. Event Viewer tracks the following kinds of events in the following order, based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 7 provides a list of the outdialing events that you can use to troubleshoot and monitor Unified Messaging.

Table 7   Outdialing events

Event ID Category Event type Logging Value or description Class

1005

UMCore

Information

LogAlways

The Unified Messaging server is initiating an outgoing call. The calling party is "%1", the party being called is "%2", and the call ID is "%3".

Outdialing

1075

UMCore

Information

LogAlways

The Unified Messaging server received a Play on Phone request from "%1". The calling number "%2" is dialing "%3" using the IP/VoIP gateway "%4".

Outdialing

1076

UMCore

Warning

LogAlways

The Unified Messaging server received a Play on Phone request from user "%1", but the telephone number "%2" cannot be dialed as specified. To correct this issue, make sure that you have properly configured the dialing rules on the UM dial plan and the dial restrictions on the UM mailbox policy that is associated with the user. Diagnostic information: "%3".

Outdialing

1085

UMCore

Warning

LogAlways

The Unified Messaging server attempted to translate "%1" into a number that can be dialed. "%2". Check the following warning messages: "%3".

Outdialing

1087

UMCore

Warning

LogAlways

An outgoing call to "%1" could not be established. The selected outgoing IP/VoIP gateway "%2" returned the error: "%3". The caller ID for this call was "%4". For help troubleshooting the SIP response error code that was specified in the event description, contact the vendors who support your IP/VoIP gateway and IP/PBX hardware. You can also run diagnostic tests on your IP/VoIP gateway or IP/PBX hardware to make sure that the devices are operating correctly. More information: "%5"

Outdialing

1173

UMCallData

Information

LogAlways

Call data: "%1"

Outdialing

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates events related to performance in Event Viewer so that you can troubleshoot and verify the performance of UM components, features, and services. Event Viewer tracks the following types of events in the following order:

  1. Error events

  2. Warning events

  3. Informational events

Table 8 provides a list of performance-related events that you can use to troubleshoot and monitor Unified Messaging.

Table 8   Unified Messaging performance-related events

Event ID Category Event type Logging Value or description Class

1054

UMService

Information

LogAlways

The Unified Messaging Worker Process was terminated because its startup time exceeded the configured maximum, %1 seconds.

Performance

1089

UMService

Warning

LogPeriodic

SIP IP gateway %1 did not respond within %2 seconds to the Session Initiation Protocol (SIP) option request that was sent by the Unified Messaging server. Make sure that the IP gateway has no performance bottleneck. Also, make sure that there are no network connectivity issues between the IP gateway and the Unified Messaging server.

Performance

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates prompt publishing events in Event Viewer so that you can troubleshoot and verify the performance of the prompt publishing feature in Exchange 2007 Unified Messaging. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 9 provides a list of the prompt publishing events that you can use to troubleshoot and monitor Unified Messaging.

Table 9   Prompt publishing events

Event ID Category Event type Logging Value or description Class

1094

UMManagement

Information

LogAlways

The user "%1" modified a custom prompt for UM dial plan "%2". The custom prompt file name is "%3" and the custom prompt publishing point is "%4".

Prompt Publishing

1095

UMManagement

Warning

LogAlways

User "%1" attempted to modify a custom prompt for dial plan "%2". The operation failed. Make sure that the UM administrator is a member of the local Administrators group, has been delegated the Exchange Organization Administrator role, and has at least read and write permissions to the UM prompt publishing point shared folder. More information: "%3"

Prompt Publishing

1096

UMCore

Information

LogAlways

The Unified Messaging server updated the custom prompt cache for UM dial plan "%1". The name of the file that was updated is "%2".

Prompt Publishing

1097

UMManagement

Warning

LogAlways

The custom prompts that are associated with UM dial plan "%1" could not be removed. More information: %2

Prompt Publishing

1098

UMManagement

Information

LogAlways

User "%1" has modified a custom prompt for UM auto attendant "%2". The custom prompt file name was "%3" and the custom prompt publishing point was "%4".

Prompt Publishing

1099

UMManagement

Warning

LogAlways

User "%1" attempted to modify a custom prompt for auto attendant "%2". The operation failed. Make sure that the UM administrator is a member of the local Administrators group and has been delegated the Exchange Organization Administrator role, and has at least read and write permissions to the UM prompt publishing point shared folder. More information: "%3"

Prompt Publishing

1100

UMCore

Information

LogAlways

The Unified Messaging server updated the custom prompt cache for UM auto attendant "%1". The name of the file that was updated is "%2".

Prompt Publishing

1101

UMManagement

Warning

LogAlways

The Unified Messaging server could not delete the custom prompt files associated with UM auto attendant "%1" from the prompt publishing point. No user action is required. To avoid this warning being logged in the future, make sure that the appropriate permissions have been configured on the prompt publishing point shared folder. More information: "%2".

Prompt Publishing

1160

UMCore

Warning

LogPeriodic

The Unified Messaging server could not find a local copy of the following custom prompt files for UM auto attendant "%1": "%2". If these custom prompt files were added recently, you must allow time for prompt distribution.

Prompt Publishing

1161

UMCore

Warning

LogPeriodic

The following custom prompt files were not found for UM dial plan "%1": "%2". If new custom prompt files were published recently, you must allow time for them to be copied to all Unified Messaging servers in the dial plan.

Prompt Publishing

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates speech grammar generation events in Event Viewer so that you can troubleshoot and verify the performance of speech grammar generation in Exchange 2007 Unified Messaging. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 10 provides a list of the speech grammar events that you can use to troubleshoot and monitor Unified Messaging.

Table 10   Speech grammar events

Event ID Category Event type Logging Value or description Class

1086

UMCore

Warning

LogAlways

Automatic Speech Recognition (ASR) has been enabled on the UM auto attendant "%1". However, the speech grammar file "%2" cannot be found. Until this problem is corrected, ASR will be disabled for this auto attendant.

Speech Grammar

1102

UMCore

Warning

LogAlways

Automatic Speech Recognition (ASR) has been enabled for personal contacts, but the speech grammar file "%1" for personal contacts cannot be found. Until this problem is corrected, ASR will be disabled for contacts.

Speech Grammar

1130

UMCore

Warning

LogAlways

The Unified Messaging server encountered an error when generating or updating a grammar file. Error details: "%1"

Speech Grammar

1131

UMWorkerProcess

Information

LogAlways

The Unified Messaging Worker Process has started grammar generation for Automatic Speech Recognition. The log file is "%1".

Speech Grammar

1132

UMWorkerProcess

Information

LogAlways

The Unified Messaging Worker Process has completed the scheduled speech grammar generation.

Speech Grammar

1137

UMCore

Warning

LogAlways

The Microsoft Exchange Unified Messaging service or the galgrammargenerator.exe command failed to update the msExchUMDtmfMap Active Directory attribute for UM-enabled recipients. More information: "%1"

Speech Grammar

1139

UMCore

Information

LogAlways

The speech grammar generation log file will be written to"'%1".

Speech Grammar

1140

UMCore

Information

LogAlways

"%1". The grammar file is named "%2".

Speech Grammar

1141

UMCore

Information

LogAlways

The Unified Messaging server has created a grammar file named "%1". The grammar file was then compiled into a file named "%2".

Speech Grammar

1157

UMCore

Warning

LogAlways

The Unified Messaging server encountered an error in the speech grammar filter list at line "%1", character "%2". The error is "%3". Generation of the speech grammar files on the Unified Messaging server has been canceled.

Speech Grammar

1158

UMCore

Warning

LogAlways

The Unified Messaging server encountered an error while processing the speech grammar filter list that is used for Automatic Speech Recognition (ASR). Generation of the speech grammar files on the Unified Messaging server has been canceled. "%1"

Speech Grammar

1162

UMWorkerProcess

Information

LogAlways

The following dial plans were added to the server: "%1","%2". The Unified Messaging Worker Process has started grammar generation for these dial plans.

Speech Grammar

1163

UMWorkerProcess

Information

LogAlways

The Unified Messaging Worker Process has finished updating the speech grammar files for UM dial plans that are associated with the Unified Messaging server.

Speech Grammar

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates subscriber access events in Event Viewer so that you can troubleshoot and verify the performance of the subscriber access components and services. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 11 provides a list of the subscriber access events that you can use to troubleshoot and monitor Unified Messaging.

Table 11   Subscriber access events

Event ID Category Event type Logging Value or description Class

1012

UMCore

Warning

LogAlways

User "%1" is locked out of their mailbox because they have entered an incorrect PIN "%2" consecutive times. The PIN must be reset before the user can log on to the mailbox from the telephone again.

Subscriber Access

1013

UMCore

Warning

LogAlways

User "%1" was disconnected by the Unified Messaging server because the user failed to log on "%2" consecutive times. The user did not enter the correct PIN.

Subscriber Access

1019

UMCore

Warning

LogAlways

User "%1" was unable to log on to their mailbox using Outlook Voice Access because the checksum for the user's PIN is not valid. The user will not be able to log on to the system until their PIN is reset.

Subscriber Access

1036

UMCore

Information

LogAlways

The Unified Messaging server successfully authenticated user "%1". The call ID is "%2".

Subscriber Access

1080

UMCore

Warning

LogAlways

The Unified Messaging (UM) server failed to process messages for user "%1" during the call with ID "%2" because the user has exceeded their mailbox quota.

Subscriber Access

1134

UMCore

Warning

LogAlways

The Unified Messaging server detected corrupt user configuration data for user "%1". This data contains information such as whether the user has previously logged on to their mailbox or has set their Out of Office status, and also contains any personalized voice mail greetings the user has recorded. The Unified Messaging server will use default configuration data for the user.

Subscriber Access

1135

UMCore

Error

LogAlways

The Microsoft Exchange Unified Messaging service detected a corrupted PIN for user "%1". The user's UM configuration data contains information such as the user's current PIN and the number of consecutive times the user has entered an incorrect PIN. The user will not be able to log on to the Unified Messaging system until their PIN is reset.

Subscriber Access

1171

UMCallData

Information

LogAlways

Call data: "%1"

Subscriber Access

Return to top

Unified Messaging generates system events in Event Viewer so that you can troubleshoot and verify the performance of Unified Messaging system components, features, and services. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 12 provides a list of Unified Messaging system events that you can use to troubleshoot and monitor Unified Messaging.

Table 12   Unified Messaging system events

Event ID Category Event type Logging Value or Description Class

1000

UMWorkerProcess

Information

LogAlways

The Unified Messaging Worker Process was started successfully on port "%1".

System

1001

UMWorkerProcess

Error

LogAlways

The Microsoft Exchange Unified Messaging Worker Process (UMWorkerProcess.exe) was unable to start. More information: %1.

System

1002

UMWorkerProcess

Information

LogAlways

The Unified Messaging Worker Process has been stopped successfully.

System

1003

UMWorkerProcess

Error

LogAlways

An unhandled exception occurred while the UM Worker Process (UMWorkerProcess.exe) was stopping. Exception details follow: %1

System

1007

UMCore

Information

LogAlways

The Unified Messaging server has ended a call with ID "%1" because the user at the far end disconnected.

System

1008

UMCore

Error

LogAlways

The Microsoft Exchange Unified Messaging service failed to initialize because an exception occurred when it was loading the globcfg.xml configuration file or the finite state machine (FSM) files. To resolve this error, replace the globcfg.xml file or the FSM files with the default files located on the Exchange Server 2007 DVD. More information: "%1".

System

1009

UMCore

Information

LogAlways

The telephone user interface is starting activity "%1" for the call with ID "%2".

System

1010

UMCore

Information

LogAlways

The telephone user interface definitions were successfully loaded from the configuration file: "%1"

System

1011

UMCore

Information

LogAlways

The telephone user interface activity "%1" will play the following prompts: "%2"

System

1014

UMCore

Error

LogAlways

The Unified Messaging Worker Process (UMWorkerProcess.exe) encountered an unhandled exception "%1" during an incoming call with ID "%2". The call was disconnected.

System

1035

UMCore

Error

LogAlways

The Unified Messaging server encountered an error when trying to access the mailbox for user "%1". Error: %2 Object: %3

System

1037

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has started successfully.

System

1038

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service was unable to start. More information: "%1"

System

1039

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has been stopped successfully.

System

1040

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service could not be stopped. More information: "%1"

System

1041

UMService

Error

LogAlways

The operating system was unable to create job object "%1" during the initialization of the Microsoft Exchange Unified Messaging service. Job objects allow multiple processes to be managed as a unit. The Microsoft Exchange Unified Messaging service was stopped. To resolve this error, first try restarting the Unified Messaging server. The Win32 exception error that was returned was: "%2"

System

1042

UMService

Error

LogAlways

The operating system was unable to set properties on job object "%1" during the initialization of the Microsoft Exchange Unified Messaging service. A job object allows a group of processes to be managed as a unit. The Microsoft Exchange Unified Messaging service was stopped. To resolve this error, first try restarting the Unified Messaging server. The Win32 exception error that was returned was: "%2"

System

1043

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service was not able to start because the executable file "%1" for the Unified Messaging Worker Process does not exist. To resolve this issue, copy the default file located on the Exchange Server 2007 DVD into the \bin folder in the installation directory.

System

1044

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service failed to create an instance of the Unified Messaging Worker Process. %1

System

1045

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service stopped because the Unified Messaging Worker Process exceeded the configured maximum number of consecutive failures, %1. To resolve this error, restart the Microsoft Exchange Unified Messaging service.

System

1046

UMService

Information

LogAlways

The Unified Messaging (UM) Worker Process has terminated. The state of the UM Worker Process is "%1".

System

1047

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has requested that a new Unified Messaging Worker Process be created.

System

1048

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging (UM) Worker Process because it was unable to get data from the old UM Worker Process.

System

1049

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging Worker Process because the number of incoming calls ("%1") has exceeded the configured maximum, "%2".

System

1050

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging Worker Process because the number of threads ("%1") exceeded the configured maximum, "%2".

System

1051

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging Worker Process because the working set ("%1 MB") has exceeded the configured maximum: "%2 MB"

System

1052

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging Worker Process. The previous Worker Process had been running since "%1", and reached its configured maximum age at "%2".

System

1053

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging Worker Process because the number of health monitoring "heartbeats" missed ("%1") exceeded the configured maximum, "%2".

System

1055

UMService

Information

LogAlways

The Unified Messaging Worker Process was terminated because the configured maximum lifetime was exceeded.

System

1056

UMService

Information

LogAlways

The state of the Unified Messaging Worker Process has changed. Previous state = "%1". Current state = "%2".

System

1057

UMWorkerProcess

Error

LogAlways

An unhandled exception occurred in a Unified Messaging Worker Process: "%1".

System

1058

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service was not able to redirect the call with ID "%1" to an available Unified Messaging Worker Process.

System

1059

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has terminated the Unified Messaging Worker Process because a control channel could not be established.

System

1074

UMService

Error

LogAlways

The Unified Messaging server failed to submit the message to the Hub Transport server using header file "%1". The header file was moved to "%2". Make sure that your antivirus software is not modifying the header files in the voice mail folder. Error "%3".

System

1077

UMCore

Information

LogAlways

The Unified Messaging server has received a request to disconnect the user "%1" on the call with ID "%2".

System

1078

UMCore

Warning

LogAlways

The Unified Messaging Worker Process is attempting to recover from an exception "%1" that was encountered during a call with ID "%2".

System

1079

UMCore

Warning

LogAlways

The VoIP platform encountered an exception "%1" during the call with ID "%2". This exception occurred at the Microsoft Exchange Speech Engine VoIP platform during an event-based asynchronous operation submitted by the Unified Messaging server. The Unified Messaging server will attempt to recover from this exception. If this warning occurs frequently, contact Microsoft Product Support.

System

1083

UMClientAccess

Warning

LogAlways

The Unified Messaging Web service was unable to process a "%1" request for user "%2". The error was "%3".

System

1084

UMCore

Information

LogAlways

The call with ID "%1" ended because the Unified Messaging server disconnected.

System

1088

UMService

Warning

LogPeriodic

The IP gateway or IP-PBX did not respond to a PING request from the Unified Messaging server. The error code that was returned is "%2" and the error text is "%3".

System

1090

UMService

Information

LogAlways

The IP gateway at %1 responded promptly to a PING request.

System

1091

UMService

Warning

LogAlways

The Unified Messaging server was unable to issue a Session Initiation Protocol (SIP) Option request to the IP/VoIP gateway or IP-PBX named "%1". The operational status of the IP/VoIP gateway or IP-PBX will not be sent to the server. The error received was "%2".

System

1092

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has created a new Unified Messaging Worker Process because the temporary directory size reached "%1" MB, which exceeded the maximum specified size, which is "%2" MB.

System

1103

UMService

Error

LogAlways

XML schema validation failed for file "%1" at line "%2". The error was "%3". A Unified Messaging configuration data file has been modified and the new changes do not match the expected schema. To resolve this issue, undo any recent changes you have made to the file or replace the file on the Unified Messaging server with the file of the same name located on the Exchange Server 2007 DVD.

System

1104

UMService

Warning

LogAlways

The Microsoft Exchange Unified Messaging service was unable to read the Unified Messaging Worker Process retire time from the configuration data. The Unified Messaging Worker Process retire time is being set to the default value, which is "%1". Reason: "%2"

System

1105

UMWorkerProcess

Warning

LogAlways

The Unified Messaging server could not find a UM IP gateway that allows outgoing calls.

System

1112

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service will attempt to use a certificate with the following details: IssuerName = "%1", SerialNumber = "%2", Thumbprint = "%3", IsSelfSigned = "%4", NotValidAfter = "%5". The path to this certificate is "%6".

System

1113

UMService

Warning

LogPeriodic

The Unified Messaging server failed to exchange the required certificates with a UM IP gateway to enable Transport Layer Security (TLS) for an incoming call. More information: "%1".

System

1114

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service will attempt to start in secured mode.

System

1115

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service will attempt to start in unsecured mode.

System

1116

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service has received notification that a new Transport Layer Security (TLS) certificate must be used. The Microsoft Exchange Unified Messaging service will not process any new calls from an IP/VoIP gateway until the new TLS certificate can be used.

System

1117

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service was configured to use a new certificate and used the new certificate successfully.

System

1118

UMService

Error

LogAlways

The Microsoft Exchange Unified Messaging service has encountered a problem trying to use the newly assigned certificate for Transport Layer Security (TLS). The Microsoft Exchange Unified Messaging service was stopped. To resolve this issue, replace the current certificate with another one. The exception error was "%1".

System

1119

UMService

Information

LogAlways

The Microsoft Exchange Unified Messaging service created a new Unified Messaging Worker Process so that a new certificate can be used.

System

1120

UMService

Warning

LogAlways

The certificate that is used to establish secure communication with an IP/VoIP gateway using Transport Layer Security (TLS) is nearing its expiration date. By default, this event is first logged 30 days before the certificate expires, and then logged one time each day until the certificate is replaced. If the certificate that is stored on the Unified Messaging server is not replaced before it expires, the Microsoft Exchange Unified Messaging service will stop, and the Unified Messaging server will not be able to process any calls. To resolve this issue, install a new certificate on the Unified Messaging server and the IP/VoIP gateways that are being used by the Unified Messaging server.

System

1124

UMService

Warning

LogAlways

No IP/VoIP gateways were found for the Microsoft Exchange Unified Messaging service.

System

1125

UMClientAccess

Information

LogAlways

The Microsoft Exchange Unified Messaging service will attempt to use a certificate with the following information: IssuerName = "%1", SerialNumber = "%2", Thumbprint = "%3", IsSelfSigned = "%4" , NotValidAfter = "%5"

System

1126

UMWorkerProcess

Warning

LogPeriodic

The Unified Messaging server failed to exchange the required certificates to enable Transport Layer Security (TLS) with an IP/VoIP gateway. More information: "%1".

System

1127

UMWorkerProcess

Warning

LogAlways

The Audio Compression Manager failed to convert from the audio format "%1" to audio format "%2": "%3". If this conversion continues to fail, you can either change the audio codec setting on the UM dial plan or change the audio codec setting on the user's UM-enabled mailbox.

System

1133

UMCore

Error

LogAlways

Unified Messaging detected a corrupted custom greeting "%1" for user "%2". The user's custom greeting will be deleted and the Unified Messaging server will use a default greeting until the user records another custom greeting.

System

1138

UMCore

Error

LogAlways

The Microsoft Exchange Unified Messaging service failed to start. The service was not able to create and register the Simple Mail Transfer Protocol (SMTP) service principal name (SPN) for the Unified Messaging server. The Win32 error code returned was "%1".

System

1142

UMCore

Information

LogAlways

"%1" active calls that were associated with remote end point "%2" were disconnected. An administrator with the appropriate permissions chose to disable all incoming calls immediately on Unified Messaging server "%3".

System

1143

UMCore

Information

LogAlways

"%1" active calls have been disabled on the Unified Messaging server. An administrator with the appropriate permissions chose to disable all incoming calls immediately.

System

1147

UMCore

Warning

LogAlways

The Unified Messaging server was unable to retrieve the IP address for IP/VoIP gateway "%1".

System

1148

UMService

Warning

LogAlways

The Unified Messaging server could not obtain a DNS record for the following hosts: "%1". Verify that your UM IP gateway and DNS server have been configured correctly.

System

1149

UMWorkerProcess

Warning

LogAlways

The Unified Messaging server could not locate a DNS record for the following hosts: "%1". To resolve this issue, verify that your UM IP gateways and your DNS server are configured correctly.

System

1151

UMService

Warning

LogPeriodic

The Session Initiation Protocol (SIP) stack that is installed on the Unified Messaging server has encountered an unhandled exception. More information: "%1".

System

1152

UMCore

Warning

LogAlways

The Unified Messaging server has received a SIP header that is not valid from an incoming call with ID "%1". Header details follow: "%2"

System

1159

UMCore

Warning

LogAlways

The call with ID "%1" was disconnected by the Unified Messaging server because of a system error.

System

1165

UMWorkerProcess

Warning

LogAlways

No IP/VoIP gateways were found for the Microsoft Exchange Unified Messaging service.

System

1166

UMWorkerProcess

Warning

LogAlways

The Unified Messaging server encountered an error while trying to access the Active Directory directory service to determine the UM IP gateways that are associated with this server. More information: "%1"

System

1167

UMService

Warning

LogAlways

The Unified Messaging server encountered an error while trying to access the Active Directory directory service to determine the UM IP gateways that are associated with this server. More information: "%1"

System

1168

UMCallData

Information

LogAlways

Call data: %1

System

1174

UMWorkerProcess

Warning

LogAlways

An error occurred while the Unified Messaging server was performing the following operation: "%1" for user "%2". "%3"

System

1175

UMCore

Warning

LogAlways

The UM IP gateways "%1" and "%2" cannot be configured with the same IP address. Check your UM IP gateway and DNS server configuration.

System

1176

UMCore

Warning

LogAlways

UM dial plan "%2" does not include the following dial groups "%1".

System

Return to top

Microsoft Exchange Server 2007 Unified Messaging (UM) generates Active Directory errors and events in Event Viewer so that you can troubleshoot and verify the performance when an Exchange 2007 Unified Messaging server accesses the Active Directory directory service. Event Viewer tracks the following kinds of events in the following order based on importance:

  1. Error events

  2. Warning events

  3. Informational events

Table 13 provides a list of Active Directory events that you can use to troubleshoot and monitor Unified Messaging.

Table 13   Active Directory system events

Event ID Category Event type Logging Value or Description Class

1020

UMCore

Information

LogAlways

Directory search key "%1" returned the following results: "%2".

Active Directory

1106

UMWorkerProcess

Warning

LogAlways

The Unified Messaging server encountered an error while trying to access Active Directory in the call with ID "%1". "%2"

Active Directory

1107

UMWorkerProcess

Warning

LogAlways

The Unified Messaging server encountered an error during the call with ID "%1" while trying to read from Active Directory. The operation cannot be retried. Additional information: "%2"

Active Directory

1108

UMWorkerProcess

Warning

LogAlways

The Unified Messaging server encountered a data error while trying to read information stored in Active Directory during the call with ID: "%1". This event may have been caused because the UM configuration data that is stored in Active Directory is internally inconsistent. Additional information follows: "%2"

Active Directory

1110

UMCore

Warning

LogAlways

The Unified Messaging server failed to register for directory change notifications on the UM DialPlan container. The Unified Messaging server will retry this operation after "%1" minutes. Additional information: "%2"

Active Directory

1111

UMCore

Warning

LogAlways

The Unified Messaging server failed to register for directory change notifications on the UM IPGateway container. The Unified Messaging server will retry this operation after "%1" minutes. Additional information: "%2"

Active Directory

1121

UMCore

Warning

LogAlways

The Unified Messaging server failed to register for directory change notifications on the Servers container. The Unified Messaging server will retry this operation after "%1" minutes. Additional information: "%2"

Active Directory

1122

UMCore

Warning

LogAlways

The Unified Messaging server failed to register for directory change notifications on the UM AutoAttendant container. The Unified Messaging server will retry this operation after "%1" minutes. Additional information: "%2"

Active Directory

1144

UMCore

Warning

LogAlways

An unhandled exception occurred while an Active Directory configuration change notification was being processed. This error may have been caused by network connectivity issues between Active Directory domain controllers and the Unified Messaging server. Additional information: "%1"

Active Directory

1145

UMCore

Warning

LogAlways

The Unified Messaging server failed to register for directory change notifications on the UM HuntGroup container. The Unified Messaging server will retry this operation after "%1" minutes. Additional information: "%2"

Active Directory

1155

UMCore

Error

LogAlways

The Active Directory directory service failed to initialize. Additional information: "%1"

Active Directory

Return to top

You can use the Performance tool to automatically collect performance data from local or remote computers that are running Microsoft Exchange Server 2007 that have the Unified Messaging server role installed. You can define start and stop times for automatic log generation, manage multiple logging sessions from a single console window, and set an alert on a computer that enables a message to be sent or a log to be started when your criteria are met. This section discusses the performance counters for Unified Messaging.

The Microsoft Windows Server 2003 family defines the performance data it collects with regard to objects, counters, and instances. By using the Performance tool and Performance Logs and Alerts, you can select performance objects, counters, and instances to collect, and then present data about the performance of system components or installed software.

Several performance objects, which contain many performance counters, are installed when you install the Unified Messaging server role. A performance object measures the activity for a given resource, application, or service. Performance objects and counters obtain performance data from the Unified Messaging components, features, and services on your computer as they are used. This performance data is typically named for the component that generates the data. Performance counters are used for gathering specific information or data for a given performance object.

Each Unified Messaging performance object measures an aspect of UM performance. For example, MSExchangeUMCallAnswering monitors call answering, MSExchangeUMFax monitors fax messages, and MSExchangeAvailability monitors UM system resources and availability.

Each UM performance object has at least one instance. An instance is a unique copy of a particular object type. However, the MSExchangeUMAutoAttendant performance object is the only UM performance object that supports multiple instances.

There are several performance objects that monitor Unified Messaging. Depending on the features that you implement, you may be able to monitor the following UM performance objects:

  • MSExchangeUMGeneral

  • MSExchangeUMCallAnswering

  • MSExchangeUMFax

  • MSExchangeUMSubscriberAccess

  • MSExchangeUMAutoAttendant

  • MSExchangeAvailability

  • MSExchangeUMPerformance

Performance counters measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received. Do not expect to obtain a list of details from a performance counter, such as a list of error messages. Instead, use performance counters for Unified Messaging to obtain quantities, such as the total number of calls, the number of e-mail messages that are heard by the system, and the number of calls that are transferred by UM auto attendants.

The following are the categories for Unified Messaging performance counters:

  • General Performance Counters for Unified Messaging

  • Call Answering Performance Counters for Unified Messaging

  • Fax Answering Performance Counters for Unified Messaging

  • Subscriber Access Performance Counters for Unified Messaging

  • Unified Messaging Auto Attendant Performance Counters

  • System Resources and Availability Counters for Unified Messaging

  • Unified Messaging Performance Monitoring Counters

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging (UM) server role installed. Unified Messaging performance counters measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received.

Table 14 provides a list of the general performance counters that can be used to monitor Unified Messaging.

Table 14   General performance counters for Unified Messaging

Performance counter Performance object Description

Average Call Duration

MSExchangeUMGeneral

Average Call Duration is the average duration, in seconds, of calls since the service was started.

Average Recent Call Duration

MSExchangeUMGeneral

Average Recent Call Duration is the average duration, in seconds, of the last 50 calls.

Call Duration Exceeded

MSExchangeUMGeneral

Call Duration Exceeded is the number of calls that were disconnected because they exceeded the UM maximum call length. This number includes all types of calls, including fax calls.

Calls Disconnected by User Failure

MSExchangeUMGeneral

Calls Disconnected by User Failure is the total number of calls disconnected after too many user entry failures.

Calls Rejected

MSExchangeUMGeneral

Calls Rejected is the total number of new call invitations that have been rejected.

Calls Rejected per Second

MSExchangeUMGeneral

Calls Rejected per Second is the number of new call invitations that have been rejected in the last second.

Current Auto Attendant Calls

MSExchangeUMGeneral

Current Auto Attendant Calls is the number of auto attendant calls that are currently connected to the UM server.

Current Calls

MSExchangeUMGeneral

Current Calls is the number of calls that are currently connected to the UM server.

Current CAS Connections

MSExchangeUMGeneral

Current CAS Connections is the number of connections that are currently open between the Unified Messaging server and Client Access servers.

Current Fax Calls

MSExchangeUMGeneral

Current Fax Calls is the number of fax calls that are currently connected to the UM server. Voice calls become fax calls after a fax tone is detected.

Current Play on Phone Calls

MSExchangeUMGeneral

Current Play on Phone Calls is the number of outbound calls initiated to play back messages.

Current Prompt Editing Calls

MSExchangeUMGeneral

Current Prompt Editing Calls is the number of logged on users who are editing custom prompts.

Current Subscriber Access Calls

MSExchangeUMGeneral

Current Subscriber Access Calls is the number of logged on subscribers who are currently connected to the UM server.

Current Unauthenticated Pilot Number Calls

MSExchangeUMGeneral

Current Unauthenticated Pilot Number Calls is the number of voice calls to the pilot number that have not yet been authenticated.

Current Voice Calls

MSExchangeUMGeneral

Current Voice Calls is the number of voice calls that are currently connected to the UM server.

Delayed Calls

MSExchangeUMGeneral

Delayed Calls is the number of calls that experienced one or more delays longer than 2 seconds.

Total Calls

MSExchangeUMGeneral

Total Calls is the number of calls since the service was started.

Total Calls per Second

MSExchangeUMGeneral

Total Calls per Second is the number of new calls that arrived in the last second.

Total Play on Phone Calls

MSExchangeUMGeneral

Total Play on Phone Calls is the total number of Play on Phone calls that have been initiated since the service was started.

User Response Latency

MSExchangeUMGeneral

User Response Latency is the average response time, in milliseconds, for the system to respond to a user request. This average is calculated over the last 25 calls. This counter is limited to calls that require significant processing.

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging (UM) server role installed. Unified Messaging performance counters are used to measure quantities of information or data for Unified Messaging and are based on the number, size, duration, and rate of data that is being requested or received.

Table 15 provides a list of the call answering performance counters that can be used to monitor Unified Messaging.

Table 15   Unified Messaging call answering performance counters

Performance counter Performance object Description

Average Greeting Size

MSExchangeUMCallAnswering

Average Greeting Size is the average size, in seconds, of recorded greetings that have been retrieved by the UM server.

Average Recent Voice Message Size

MSExchangeUMCallAnswering

Average Recent Voice Message Size is the average size, in seconds, of the last 50 voice messages that have been left for subscribers.

Average Voice Message Size

MSExchangeUMCallAnswering

Average Voice Message Size is the average size, in seconds, of voice messages left for subscribers.

Call Answering Calls

MSExchangeUMCallAnswering

Call Answering Calls is the number of diverted calls that were answered on behalf of subscribers.

Call Answering Escapes

MSExchangeUMCallAnswering

Call Answering Escapes is the number of times a caller pressed the * key to connect to another user instead of leaving a message.

Call Answering Missed Calls

MSExchangeUMCallAnswering

Call Answering Missed Calls is the number of times a diverted call was dropped without a message being left.

Call Answering Voice Messages

MSExchangeUMCallAnswering

Call Answering Voice Messages is the total number of messages that were submitted because the calls were answered on behalf of subscribers.

Call Answering Voice Messages per Second

MSExchangeUMCallAnswering

Call Answering Voice Messages per Second is the number of messages that were submitted because the calls were answered on behalf of subscribers.

Call Failed Because Transport Unavailable

MSExchangeUMCallAnswering

Call Failed Because Transport Unavailable is the number of calls that failed because the transport service is not available to submit the message.

Calls Disconnected by Callers During UM Audio Hourglass

MSExchangeUMCallAnswering

Calls Disconnected by Callers During UM Audio Hourglass is the number of calls during which the caller disconnected while Unified Messaging was playing the audio hourglass tones.

Calls Disconnected by UM on Irrecoverable External Error

MSExchangeUMCallAnswering

Calls Disconnected by UM on Irrecoverable External Error is the total number of calls that have been disconnected after an irrecoverable external error occurred.

Calls Without Personal Greetings

MSExchangeUMCallAnswering

Calls Without Personal Greetings is the number of diverted calls received for subscribers that did not have recorded greeting messages.

Diverted Extension Not Provisioned

MSExchangeUMCallAnswering

Diverted Extension Not Provisioned is the number of calls received for which the diverted extension supplied with the call is not a UM subscriber extension.

Fetch Greeting Timed Out

MSExchangeUMCallAnswering

Fetch Greeting Timed Out is the number of diverted calls for which the subscriber’s personal greeting could not be retrieved within the time allowed.

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging (UM) server role installed. Unified Messaging performance counters are used to measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received.

Table 16 provides a list of the fax answering performance counters that can be used to monitor Unified Messaging.

Table 16   Unified Messaging fax answering performance counters

Performance counter Performance object Description

Average Fax Message Size

MSExchangeUMFax

Average Fax Message Size is the average size, in kilobytes, of fax messages received.

Average Recent Fax Message Size

MSExchangeUMFax

Average Recent Fax Message Size is the average size, in kilobytes, of the last 20 fax messages.

Fax Call Duration Exceeded

MSExchangeUMFax

Fax Call Duration Exceeded is the number of fax calls that were disconnected because they exceeded the UM maximum call length.

Fax Calls to Non Provisioned Mailboxes

MSExchangeUMFax

Fax Calls to Non Provisioned Mailboxes is the number of calls to extensions that resolved to mailboxes that are not enabled for fax.

Fax Incomplete

MSExchangeUMFax

Fax Incomplete is the number of fax calls that were dropped before completion.

Fax Messages

MSExchangeUMFax

Fax Messages is the total number of fax messages received.

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging (UM) server role installed. Unified Messaging performance counters are used to measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received.

Table 17 provides a list of the subscriber access performance counters that can be used to monitor Unified Messaging.

Table 17   Unified Messaging subscriber access performance counters

Performance counter Performance object Description

Average Recent Sent Voice Message Size

MSExchangeUMSubscriberAccess

Average Recent Sent Voice Message Size is the average size, in seconds, of the last 50 voice messages that were sent.

Average Recent Subscriber Call Duration

MSExchangeUMSubscriberAccess

Average Recent Subscriber Call Duration is the average length of time, in seconds, that subscribers spent logged on to the system for the last 50 subscriber calls.

Average Sent Voice Message Size

MSExchangeUMSubscriberAccess

Average Sent Voice Message Size is the average size, in seconds, of voice messages that are sent. This size does not include any attachment data.

Average Subscriber Call Duration

MSExchangeUMSubscriberAccess

Average Subscriber Call Duration is the average duration, in seconds, that subscribers spent logged on to the system. This timer starts when logon completes.

Calendar Accessed

MSExchangeUMSubscriberAccess

Calendar Accessed is the number of times subscribers accessed their calendars by using the telephone user interface.

Calendar Items Details Requested

MSExchangeUMSubscriberAccess

Calendar Items Details Requested is the number of times a subscriber requested additional details for a calendar item.

Calendar Items Heard

MSExchangeUMSubscriberAccess

Calendar Items Heard is the number of Calendar items that have been heard by authenticated subscribers.

Calendar Late Attendance

MSExchangeUMSubscriberAccess

Calendar Late Attendance is the number of messages that have been sent to inform the organizer of a meeting that the subscriber will be late.

Called Meeting Organizer

MSExchangeUMSubscriberAccess

Called Meeting Organizer is the number of times subscribers called the meeting organizer.

Calls Disconnected by Callers During UM Audio Hourglass

MSExchangeUMSubscriberAccess

Calls Disconnected by Callers During UM Audio Hourglass is the number of calls in which the caller disconnected while UM was playing the audio hourglass tones.

Calls Disconnected by UM on Irrecoverable External Error

MSExchangeUMSubscriberAccess

Calls Disconnected by UM on Irrecoverable External Error is the total number of calls that have been disconnected after an irrecoverable external error occurred.

Contacts Accessed

MSExchangeUMSubscriberAccess

Contacts Accessed is the number of times subscribers accessed the Main Menu Contacts option by using the telephone user interface.

Contact Items Heard

MSExchangeUMSubscriberAccess

Contact Items Heard is the number of times authenticated subscribers listened to directory details.

Directory Accessed

MSExchangeUMSubscriberAccess

Directory Accessed is the number of times subscribers accessed the Main Menu Directory option by using the telephone user interface.

Directory Accessed by Dial by Name

MSExchangeUMSubscriberAccess

Directory Accessed by Dial by Name is the number of directory access operations where the subscriber used the Dial by Name feature.

Directory Accessed by Extension

MSExchangeUMSubscriberAccess

Directory Accessed by Extension is the number of directory access operations in which the user supplied the extension number.

Directory Accessed by Spoken Name

MSExchangeUMSubscriberAccess

Directory Accessed by Spoken Name is the number of directory access operations in which the subscriber spoke a recipient name.

Directory Accessed Successfully by Dial by Name

MSExchangeUMSubscriberAccess

Directory Accessed Successfully by Dial by Name is the number of Dial by Name directory access operations completed successfully on behalf of users.

Directory Accessed Successfully by Spoken Name

MSExchangeUMSubscriberAccess

Directory Accessed Successfully by Spoken Name is the number of speech recognition directory access operations that completed successfully on behalf of subscribers.

Email Message Queue Accessed

MSExchangeUMSubscriberAccess

Email Message Queue Accessed is the number of times subscribers accessed their e-mail message queue by using the telephone user interface.

Email Messages Deleted

MSExchangeUMSubscriberAccess

Email Messages Deleted is the number of e-mail messages that were deleted by authenticated subscribers.

Email Messages Heard

MSExchangeUMSubscriberAccess

Email Messages Heard is the number of e-mail messages that have been heard by authenticated subscribers.

Forward Messages Sent

MSExchangeUMSubscriberAccess

Forward Messages Sent is the number of messages that have been forwarded by authenticated subscribers.

Launched Calls

MSExchangeUMSubscriberAccess

Launched Calls is the number of subscriber calls that resulted in an outbound call being placed.

Meetings Accepted

MSExchangeUMSubscriberAccess

Meetings Accepted is the number of Meeting Accepted messages sent by subscribers.

Meetings Declined

MSExchangeUMSubscriberAccess

Meetings Declined is the number of Meeting Declined messages sent by subscribers.

Replied to Organizer

MSExchangeUMSubscriberAccess

Replied to Organizer is the number of times subscribers sent reply messages to meeting organizers.

Reply Messages Sent

MSExchangeUMSubscriberAccess

Reply Messages Sent is the number of replies sent by authenticated subscribers.

Subscriber Authentication Failures

MSExchangeUMSubscriberAccess

Subscriber Authentication Failures is the number of authentication failures that have occurred since the service was started. This number is incremented once for every failed authentication. It is possible that a single phone call could generate several authentication failures.

Subscriber Logon Failures

MSExchangeUMSubscriberAccess

Subscriber Logon Failures is the number of logon failures since the service was started. This number is incremented at most once per phone call.

Subscriber Logons

MSExchangeUMSubscriberAccess

Subscriber Logons is the number of successful authentications by UM subscribers since the service was started.

Voice Message Queue Accessed

MSExchangeUMSubscriberAccess

Voice Message Queue Accessed is the number of times subscribers accessed their voice message queues by using the telephone user interface.

Voice Messages Deleted

MSExchangeUMSubscriberAccess

Voice Messages Deleted is the number of voice messages that were deleted by authenticated subscribers.

Voice Messages Heard

MSExchangeUMSubscriberAccess

Voice Messages Heard is the number of voice messages played to subscribers. This count is incremented as soon as playback starts. The subscriber does not need to listen to the entire message.

Voice Messages Sent

MSExchangeUMSubscriberAccess

Voice Messages Sent is the number of voice messages that have been sent by authenticated UM subscribers.

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging server role installed.

Unified Messaging performance counters are used to measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received. The MSExchangeUMAutoAttendant performance object can contain multiple instances. The number of instances for the performance object depends on the number of UM auto attendants that are created in the Exchange organization.

Table 18 provides a list of the UM auto attendant performance counters that can be used to monitor Unified Messaging.

Table 18   Unified Messaging auto attendant performance counters

Performance counter Performance object Description

Ambiguous Name Transfers

MSExchangeUMAutoAttendant

Ambiguous Name Transfers is the number of times that a caller was transferred to the operator because the name that they spelled or spoke was too common in the search results.

Average Call Time

MSExchangeUMAutoAttendant

Average Call Time is the average length of time that callers interacted with the auto attendant.

Average Recent Call Time

MSExchangeUMAutoAttendant

Average Recent Call Time is the average length of time, in seconds, of the last 50 auto attendant calls.

Business Hours Calls

MSExchangeUMAutoAttendant

Business Hours Calls is the number of calls processed by this auto attendant during business hours.

Calls Disconnected by UM on Irrecoverable External Error

MSExchangeUMAutoAttendant

Calls Disconnected by UM on Irrecoverable External Error is the total number of calls that were disconnected after an irrecoverable external error occurred.

Calls with Speech Input

MSExchangeUMAutoAttendant

Calls with Speech Input is the total number of calls during which the caller is determined to have spoken at least once.

Custom Menu Options

MSExchangeUMAutoAttendant

Custom Menu Options is the number of times that callers have selected custom menu options.

Directory Accessed

MSExchangeUMAutoAttendant

Directory Accessed is the number of directory access operations performed by this auto attendant.

Directory Accessed by Dial by Name

MSExchangeUMAutoAttendant

Directory Accessed by Dial by Name is the number of directory access operations in which the subscriber used the Dial by Name feature.

Directory Accessed by Extension

MSExchangeUMAutoAttendant

Directory Accessed by Extension is the number of directory access operations in which the user supplied the extension number.

Directory Accessed by Spoken Name

MSExchangeUMAutoAttendant

Directory Accessed by Spoken Name is the number of directory access operations in which the subscriber spoke a recipient name.

Directory Accessed Successfully by Dial by Name

MSExchangeUMAutoAttendant

Directory Accessed Successfully by Dial by Name is the number of successful directory access operations in which the caller used the Dial by Name feature.

Directory Accessed Successfully by Spoken Name

MSExchangeUMAutoAttendant

Directory Accessed Successfully by Spoken Name is the number of successful directory access operations in which the caller spoke a recipient name.

Disallowed Transfers

MSExchangeUMAutoAttendant

Disallowed Transfers is the number of times a caller was transferred to the operator because the user they identified was configured to accept calls only from users who are logged on.

Disconnected Without Input

MSExchangeUMAutoAttendant

Disconnected Without Input is the number of calls that were dropped without input being offered in response to the auto attendant prompts.

Menu Option 1 Used

MSExchangeUMAutoAttendant

Menu Option 1 Used is the number of times that a caller has chosen option 1 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 2 Used

MSExchangeUMAutoAttendant

Menu Option 2 Used is the number of times that a caller has chosen option 2 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 3 Used

MSExchangeUMAutoAttendant

Menu Option 3 Used is the number of times that a caller has chosen option 3 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 4 Used

MSExchangeUMAutoAttendant

Menu Option 4 Used is the number of times that a caller has chosen option 4 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 5 Used

MSExchangeUMAutoAttendant

Menu Option 5 Used is the number of times that a caller has chosen option 5 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 6 Used

MSExchangeUMAutoAttendant

Menu Option 6 Used is the number of times that a caller has chosen option 6 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 7 Used

MSExchangeUMAutoAttendant

Menu Option 7 Used is the number of times that a caller has chosen option 7 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 8 Used

MSExchangeUMAutoAttendant

Menu Option 8 Used is the number of times that a caller has chosen option 8 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option 9 Used

MSExchangeUMAutoAttendant

Menu Option 9 Used is the number of times that a caller has chosen option 9 from the custom menu.

noteNote:
This value is always zero if no menu or option is defined.

Menu Option Timed Out

MSExchangeUMAutoAttendant

Menu Option Timed Out is the number of times that the system has timed out while waiting for a caller to select an option from the custom menu.

noteNote:
This value is always zero if no menu is defined.

Operator Transfers

MSExchangeUMAutoAttendant

Operator Transfers is the number of calls that have been transferred to the operator.

Out of Hours Calls

MSExchangeUMAutoAttendant

Out of Hours Calls is the number of calls processed by this auto attendant outside business hours.

Total Calls

MSExchangeUMAutoAttendant

Total Calls is the number of calls that have been processed by this auto attendant.

Transferred Count

MSExchangeUMAutoAttendant

Transferred Count is the number of calls that were transferred by this auto attendant. This number does not include calls that were transferred by the operator.

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007.

Unified Messaging performance counters are used to measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received.

Table 19 provides a list of the Unified Messaging system availability performance counters that can be used to monitor Unified Messaging.

Table 19   Unified Messaging system availability performance counters

Performance counter Performance object Description

Call Answer Queued Messages

MSExchangeAvailability

Call Answer Queued Messages is the number of messages created and not yet submitted for delivery.

Calls Disconnected by UM on Irrecoverable External Error

MSExchangeAvailability

Calls Disconnected by UM on Irrecoverable External Error is the total number of calls disconnected after an irrecoverable external error occurred.

Calls Disconnected by UM on Irrecoverable External Error/sec

MSExchangeAvailability

Calls Disconnected by UM on Irrecoverable External Error per second is the number of calls disconnected after an irrecoverable external error occurred in the last second.

Calls Disconnected on Irrecoverable Internal Error

MSExchangeAvailability

Calls Disconnected on Irrecoverable Internal Error is the number of calls that were disconnected after an internal system error occurred.

Directory Access Failures

MSExchangeAvailability

Directory Access Failures is the number of times that attempts to access Active Directory failed.

Failed to Redirect Call

MSExchangeAvailability

Failed to Redirect Call is the number of times the Microsoft Exchange Unified Messaging service failed to redirect calls to a UM worker process.

Hub Transport Access Completed

MSExchangeAvailability

Hub Transport Access Completed is the number of times that the Hub Transport server was accessed successfully.

Hub Transport Access Failures

MSExchangeAvailability

Hub Transport Access Failures is the number of times that attempts to access a Hub Transport server failed. This number is only incremented if all Hub Transport servers were unavailable.

Incomplete Signaling Information

MSExchangeAvailability

Incomplete Signaling Information is the number of calls for which the signaling information was missing or incomplete.

Mailbox Server Access Failures

MSExchangeAvailability

Mailbox Server Access Failures is the number of times the system did not access a Mailbox server.

Maximum Calls Allowed

MSExchangeAvailability

Maximum Calls Allowed is the length of time, in seconds, that the server concurrently processed the maximum number of calls allowed.

Name TTSed

MSExchangeAvailability

Name TTSed is the number of times the system used Text-to-Speech (TTS) to create an audio version of the display name of a subscriber.

Spoken Name Accessed

MSExchangeAvailability

Spoken Name Accessed is the number of times the system retrieved the recorded name of a user.

Total Worker Process Call Count

MSExchangeAvailability

Total Worker Process Call Count is the total number of calls handled by this UM worker process.

Unhandled Exceptions/sec

MSExchangeAvailability

Calls Disconnected on Irrecoverable Internal Error Per Second is the number of calls that were disconnected after an internal system error occurred in the last second.

Note   The name of this performance counter does not match the name listed in its description.

Worker Process Recycled

MSExchangeAvailability

Worker Process Recycled is the number of times a new UM worker process has been started.

Return to top

There are many performance counters that can be used to maintain and troubleshoot a computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging (UM) server role installed. Unified Messaging performance counters are used to measure quantities of information or data for Unified Messaging based on the number, size, duration, and rate of data that is being requested or received.

Table 20 provides a list of the Unified Messaging performance monitoring counters that can be used to monitor Unified Messaging.

Table 20   Unified Messaging performance monitoring counters

Performance counter Performance object Description

Operations over Two Seconds

MSExchangeUMPerformance

Operations over Two Seconds is the number of all UM operations that took between 2 and 3 seconds to complete. This is the time during which a caller was waiting for UM to respond.

Operations over Three Seconds

MSExchangeUMPerformance

Operations over Three Seconds is the number of all UM operations that took between 3 and 4 seconds to complete. This is the time during which a caller was waiting for UM to respond.

Operations over Four Seconds

MSExchangeUMPerformance

Operations over Four Seconds is the number of all UM operations that took between 4 and 5 seconds to complete. This is the time during which a caller was waiting for UM to respond.

Operations over Five Seconds

MSExchangeUMPerformance

Operations over Five Seconds is the number of all UM operations that took between 5 and 6 seconds to complete. This is the time during which a caller was waiting for UM to respond.

Operations over Six Seconds

MSExchangeUMPerformance

Operations over Six Seconds is the number of all UM operations that took more than 6 seconds to complete. This is the time during which a caller was waiting for UM to respond.

Operations under Two Seconds

MSExchangeUMPerformance

Operations under Two Seconds is the number of all UM operations that took less than 2 seconds to complete. This is the time during which a caller was waiting for UM to respond.

Return to top

This white paper has attempted to provide you with reference information that you can use to deploy, manage, and troubleshoot Unified Messaging. It includes information about the settings that you can configure by using the Exchange Management Shell and the Exchange Management Console. It also contains information about the performance counters and Application log events that relate to Unified Messaging. Use this white paper together with the other Unified Messaging content to deploy and manage Unified Messaging.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft