Installation and Administration Guide for Cisco Unified Mobility Advantage, Release 7.0
Page References: Enterprise Adapter Settings in Cisco Unified Mobility Advantage
Downloads: This chapterpdf (PDF - 178.0KB) The complete bookPDF (PDF - 4.1MB) | Feedback

Page References: Enterprise Adapter Settings in Cisco Unified Mobility Advantage

Table Of Contents

Page References: Enterprise Adapter Settings in Cisco Unified Mobility Advantage

About Active Directory Enterprise Adapter Settings

Basic Settings

Advanced Settings

Exchange Lookup

About Cisco Unified Communications Manager Enterprise Adapter Settings

Server Settings

Directory Lookup Settings

About Cisco Unified Presence Enterprise Adapter Settings

Basic Settings

Advanced Settings

About Microsoft Exchange Enterprise Adapter Settings

Basic Settings

Connection Pooling

About Cisco Unity or Cisco Unity Connection Enterprise Adapter Settings

Basic Settings

Voicemail Settings Tab


Page References: Enterprise Adapter Settings in Cisco Unified Mobility Advantage


Revised: May 6, 2009

You must configure an enterprise adapter for each enterprise server with which Cisco Unified Mobility Advantage connects. The values in the following tables are required for these configurations.

You should enter your values into these tables before you begin the installation or the upgrade from Release 3.x.

About Active Directory Enterprise Adapter Settings

About Cisco Unified Communications Manager Enterprise Adapter Settings

About Cisco Unified Presence Enterprise Adapter Settings

About Microsoft Exchange Enterprise Adapter Settings

About Cisco Unity or Cisco Unity Connection Enterprise Adapter Settings

About Active Directory Enterprise Adapter Settings

Cisco Unified Mobility Advantage uses Active Directory for:

User authentication for access to the User Portal and Cisco Unified Mobile Communicator.

Directory search for contacts from Cisco Unified Mobile Communicator

Number-to-name resolution for caller identification in the call logs in Cisco Unified Mobile Communicator.

Locating user information in Microsoft Exchange

Restrictions

At least one Active Directory server is required. Cisco Unified Mobility Advantage can connect to multiple Active Directory servers and to multiple OUs on the same Active Directory server, for example if you need to include users in different OUs. Create an adapter for each server or OU.

Cisco Unified Mobility Advantage and Cisco Unified Personal Communicator must point to the same Active Directory server.

All users sign in to Cisco Unified Mobile Communicator with their Active Directory passwords. These passwords cannot be longer 14 characters.

The Active Directory adapter includes the following settings:

Basic Settings

Advanced Settings

Exchange Lookup

Basic Settings

These settings allow Cisco Unified Mobility Advantage to connect to Active Directory.

Setting
Description
Your Value

Host Name/ IP address

Hostname or IP address of the corporate directory server.

 

Port

LDAP port of the corporate directory server. Cisco Unified Mobility Advantage uses this port to connect to the corporate directory for adding users to Cisco Unified Mobility Advantage and for user directory listing and searches.

Default is 389.

 

Admin DN

The distinguished name of the account that Cisco Unified Mobility Advantage uses to read data from your corporate directory server.

For example:

CN=CUMA Read Only User,CN=Users,DC=department,DC=example,DC=com

This account must have at least read-only permissions in your corporate directory server. It must also have a valid Exchange mailbox.

Enter the DN in the long format including the container name. Do not use the short form (domain name/User ID).

 

Password

The password for the Admin DN account.

 

Authentication Type

Simple.

 

Connection Type

Type of connection to use between Cisco Unified Mobility Advantage and the corporate directory server.

Use SSL for secure connections.

Use Plain for nonsecure connections.

This should match the connection type that Active Directory requires.

 

Security Context

This setting appears only if you choose SSL for Connection Type.

Select a Security Context for connections between Cisco Unified Mobility Advantage and Active Directory.

If you choose a security context that has the Trust Policy set to Trusted Certificates, you must validate the identity of the Active Directory server, for example by importing a self-signed certificate from Active Directory into the security context.

 

Polling Period (days)

Frequency (in days) with which Cisco Unified Mobility Advantage checks the corporate directory server for updates.

The default is 1 day.

 

Phone Number Format

The format you enter here must match the format of the following phone numbers:

For Cisco Unified Communications Manager Release 4.x: Phone numbers in Active Directory in the attribute you specify for the Work Phone field in the Advanced Settings described in the table below.

For other releases of Cisco Unified Communications Manager: The primary directory number for each person in Cisco Unified Communications Manager.

Be careful not to include any extra spaces, especially at the beginning or end of your number format.

This information is required in order to identify callers by name.

By default, Cisco Unified Mobility Advantage formats numbers using the North American Numbering Plan, (###) ###-####, where each # represents a digit. Up to ten digits will be formatted according to this pattern, starting from the right. Therefore:

If a number has 5 digits (for example, 12345), Cisco Unified Mobility Advantage searches Active Directory for the number in the format 1-2345.

If a number has 6 digits (for example, 123456), Cisco Unified Mobility Advantage searches Active Directory for the number in the format 12-3456.

If you do not use any punctuation at all, the number format for the same number of digits as the default would be ##########.

If you need to change this value after Cisco Unified Mobility Advantage is running, restart Cisco Unified Mobility Advantage after you make this change.

 

Related Topics

Chapter 9, "Managing Server Security in Cisco Unified Mobility Advantage."

Advanced Settings

Do not change Attribute Name values from the default unless you are certain that a different value is the correct value.

Setting
Description
Attribute Names

Distinguished Name

Attribute name in Active Directory that represents the distinguished name of a user. For example:

distinguishedName

First Name

Attribute name in Active Directory that represents the first name of a user. For example:

givenName

Last Name

Attribute name in Active Directory that represents the last name of a user. For example:

sn

User ID

Attribute name in Active Directory that represents the corporate name of a user. For example:

sAMAccountName

Key

Attribute name in Active Directory that uniquely identifies a user. For example:

distinguishedName

Home Phone

Attribute name in Active Directory that represents the home phone number of a user. For example:

homePhone

Work Phone

Attribute name in Active Directory that represents the unique office phone number of a user. For example:

telephoneNumber

If you use Cisco Unified Communications Manager Release 4.x, Cisco Unified Mobility Advantage uses this attribute to identify calls for user call logs.

Mobile

Attribute name in Active Directory that represents the mobile phone number of a user. For example:

mobile

Email

Attribute name in Active Directory that represents the email address of a user. For example:

mail

Search Settings

Filter criteria

Criteria that distinguish employees from other resources in Active Directory, such as conference rooms that can be "invited" to meetings.

Do not change the default value unless you have a specific reason to do so.

Search Base

This setting does not appear in the Configuration Wizard.

This is the Distinguished Name (DN) of the node in the directory below which Cisco Unified Mobility Advantage will search for users to be activated, and for which contacts can be searched for users.

Microsoft retrieves up to 1000 results per search.

Use the lowest node that includes the necessary names. Using a higher node will create a larger search base and thus reduce performance.

Follow Referral

Determines if Cisco Unified Mobility Advantage follows referrals from the authoritative Active Directory server to cascaded Active Directory servers, for example for subdomains, when searching.

The default value is True.


Exchange Lookup

These settings allow Cisco Unified Mobility Advantage to determine which Microsoft Exchange server at your company holds the user information for each user.

Cisco Unified Mobility Advantage generally detects these values automatically. If you need to change these values, contact your Active Directory administrator.

Setting
Description
Your Value

Contact Adapter

The name of the attribute within the corporate directory that identifies the logical Exchange server resource name for a user.

For example:

msExchHomeServerName

 

DNS Host Name

The name of the attribute within the corporate directory that identifies the DNS host name of a server machine.

For example:

dNSHostName

 

Contact Adapter DN Mask

The mask for the Contact Adapter DN value. The format of the DN Mask is:

??,CN=Computer,DC=department,DC=example,DC=com

Cisco Unified Mobility Advantage will use the value of the Contact Adapter setting (entered above) in combination with this DN Mask to search for the DNS hostname of a user's Exchange Server.

?? is substituted with the CN=<hostname of the Exchange server>. The following part is used to complete the DN. This complete string is then used to retrieve details about the user's Exchange host.

The hostname is retrieved from Active Directory using the Contact Adapter attribute of the user entry. Contact Adapter (msExchHomeServerName).

For example, if in Active Directory for user test1, the msExchHomeServerName is "myExchange" and the DN Mask is configured as ??, CN=Computer, DC=myDivision, DC=somecompany, DC=com, then the Cisco Unified Mobility Advantage Enterprise server will lookup the following entry in Active Directory to get details about the Exchange server and use it to store personal contacts of the test1 user:

CN=myExchange, CN=Computer, DC=myDivision, DC=somecompany, DC=com

 

Contact Adapter Search Base

The Distinguished Name of the root node that contains your Exchange Server's information in your corporate directory. For example:

CN=Computers,DC=department,DC=example,DC=com

Cisco Unified Mobility Advantage searches the Exchange Server from this root node.

Use the lowest node that includes the necessary names. Using a higher node will create a larger search base and thus reduce performance if the directory is very large.

Microsoft retrieves up to 1000 results per search.

 

About Cisco Unified Communications Manager Enterprise Adapter Settings

Server Settings

Directory Lookup Settings

Server Settings

These settings allow Cisco Unified Mobility Advantage to connect to Cisco Unified Communications Manager in order to:

Retrieve unified call log information to display in Cisco Unified Mobile Communicator.

This allows Cisco Unified Mobile Communicator users to view lists of calls to and from their main office phone number.

Support the unified calling features, Dial-via-Office and Mobile Connect (formerly Single Number Reach)


Note Scroll down in the Admin Portal window to see all required settings.


Setting
Description
Your Value
Address Information
 

Primary Host Name

The hostname or IP address of the primary Cisco Unified Communications Manager server that is running the CTI "super user" account or accounts that you created.

 

Primary Server Port

The port used to communicate with the primary Cisco Unified Communications Manager server.

The default is 5060.

 

Backup Host Name

(Optional) The backup server host name or IP address.

 

Backup Server Port

The port used to communicate with the backup Cisco Unified Communications Manager server.

 
CTI User Credentials
 

User Name

Enter the "super user" or "super users" you configured in Cisco Unified Communications Manager for call log monitoring or Dial via Office.

You can add up to four CTI User accounts.

 

Password

Enter the password or passwords associated with the user name or names above.

 
SIP Information
 

Transport Type

Select TLS for secure connections.

Select TCP for normal connections.

Select UDP for connections without error correction.

The default transport type is TCP.

This must match the setting in the "CUMA Server Security Profile" on the Cisco Unified Communications Manager server.

 

Communications Manager Version

If Cisco Unified Mobility Advantage is running, stop it before you change this value.

 
For Release 7.0(1): SOAP Information
For Release 7.0(2): Web Services Information
 

Https Port

The SIP port number of the Cisco Unified Communications Manager server. This is often the same secure port that runs the Cisco Unified Communications Manager Administration page.

Cisco Unified Communications Manager runs the AXL interface on this port.

The default is 8443.

 

User Name

The Cisco Unified Communications Manager Application User Name to which you assigned standard AXL API access.

 

Password

The Password for the user in the row above.

 
Additional Information
 

Security Context

This option is available only with Cisco Unified Communications Manager Release 7.0.

Select a security context for the Cisco Unified Communications Manager server.

For the simplest configuration, choose a Security Context that has the Trust Policy set to All Certificates.

If you choose a security context that has the Trust Policy set to Trusted Certificates, you must deploy necessary certificates.

 

Related Topics

Configuring Standard AXL API Access to Retrieve User Information, page 3-5

Device Pool Requirements, page 3-12

Chapter 9, "Managing Server Security in Cisco Unified Mobility Advantage."

Importing Self-Signed Certificates from Trusted Servers, page 9-10

Deploying Self-Signed Certificates for Internal Servers: Example, page 9-5

Directory Lookup Settings

If you have Cisco Unified Communications Manager Release 5.x through 7.0, you configure these settings in Cisco Unified Communications Manager. If you have Cisco Unified Communications Manager Release 4.x, this tab appears in Cisco Unified Mobility Advantage.

This table describes the settings and values required for both situations.

Setting
Purpose
Description

Rule Name

This setting identifies the rule in the list.

Enter a descriptive name for this rule.

The name can contain up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_).

If you are performing this configuration in Cisco Unified Communications Manager:

For rules to be applied to incoming calls, the Rule Name MUST begin with indir. For example, indir_international.

For rules to be applied to outgoing calls, the Rule Name MUST begin with outdir. For example, outdir_internal.

You do not need the "indir " and "outdir" prefixes if you are configuring lookup rules in Cisco Unified Mobility Advantage.

Rule Description

(Configurations in Cisco Unified Communications Manager only)

This setting describes the rule.

Enter a description of the rule.

Rule Type

(Configurations in Cisco Unified Mobility Advantage only.)

These settings identify the phone numbers to which this rule will apply.

To apply this rule to calls to the primary desk phone number, choose Incoming.

To apply this rule to calls dialed from the desk phone or (for Cisco Unified Communications Manager 7.0 only) from the mobile phone using Dial-via-Office, choose Outgoing.

Number Begins With

Enter the digits at the beginning of the phone number to which this rule will apply.

Valid values include numeric digits (0 through 9), plus (+), asterisk (*), and pound (#).

Omit formatting such as spaces, dashes, or parentheses.

Number of Digits

Number of digits in phone numbers to which this rule will apply.

Total Digits To Be Removed

These settings specify the transformation required for the dialed or received phone number to match the number for the correct person in the directory.

You must enter a value in at least one of these settings.

Enter the number of digits to strip from the beginning of the phone number.

You can also leave this setting blank to leave the number as it is.

Prefix With Pattern

Enter the digits to prepend to the number, whether or not digits are removed.

Valid values include digits (0 through 9), plus (+), asterisk (*), and pound (#), or no value.


Related Topics

Recommended Directory Lookup Settings, page 3-7

About Cisco Unified Presence Enterprise Adapter Settings

Cisco Unified Presence provides the ability for users to share their availability status. You entered values into these tables while preparing to install or to upgrade from Release 3.x.

Basic Settings

Advanced Settings

Basic Settings

Setting
Description
Your Value

Host Name/IP Address

Hostname or IP address of the Cisco Unified Presence server to which all Cisco Unified Mobility Advantage users are assigned.

 

Port

Port on which Cisco Unified Mobility Advantage will communicate with Cisco Unified Presence.

(The port of the SOAP Web Service interface that Cisco Unified Presence listens on to accept user sign-in requests.)

The default is 8443.

 

Backup Host Name/ IP Address

(Optional) Hostname or IP address of the backup Cisco Unified Presence Server, if you have one.

 

Application User Name

The user ID of the Application User you created in Cisco Unified Presence.

 

Application Password

Password for this Application User.

 

Security Context

Select a security context for the Cisco Unified Presence server.

For the simplest configuration, choose a Security Context that has the Trust Policy set to All Certificates.

If you choose a security context that has the Trust Policy set to Trusted Certificates, you must deploy necessary certificates.

 

Related Topics

Chapter 9, "Managing Server Security in Cisco Unified Mobility Advantage."

Importing Self-Signed Certificates from Trusted Servers, page 9-10

Deploying Self-Signed Certificates for Internal Servers: Example, page 9-5

Advanced Settings

Do not change these values from the defaults unless you have specific reason to do so.

Setting
Description
Your Value
SIP Settings
 

Default Subscription Interval

Default is 3600.

 

Transport Type

Default is TCP.

If you configured Cisco Unified Presence to require a TLS connection, you must select TLS here.

 

Listen Port

Default is 5060.

 

Min Connections

Default is 5.

 

Max Connections

Default is 20.

 

Max Load Per Connection

Default is 200.

 

About Microsoft Exchange Enterprise Adapter Settings

Cisco Unified Mobility Advantage uses Exchange for:

Directory Lookup for personal contacts of users

Caller identification of people who are in the personal contact of users

Triggering meeting notifications in Outlook

Triggering availability status changes to In a Meeting based on meetings that appear in the Exchange calendar of each user

Meeting notifications and availability status changes are triggered only for Cisco Unified MeetingPlace or Cisco Unified MeetingPlace Express meetings that users schedule using the Outlook Plug-In for their respective conferencing product.

At least one Exchange server is required. Cisco Unified Mobility Advantage can connect to multiple Exchange servers. Create an adapter for each.

You entered values into these tables while preparing to install or to upgrade from Release 3.x.

Basic Settings

Connection Pooling

Basic Settings

Setting
Description
Your Value

Hostname/IP Address

The hostname or IP address of the Exchange server.

If Microsoft Exchange is clustered, use the hostname associated with the Outlook Web Access (OWA) bridgehead.

 

Transport Type

TLS is the secure transport type. Select TLS if Exchange is running SSL.

TCP is the nonsecure transport type. Select TCP if Exchange is not running SSL.

 

Port

The port used to connect the Cisco Unified Mobility Advantage Server to the Exchange server. This is the Outlook Web Access (OWA) port of the Exchange server.

The default port for SSL connections is 443.

The default port for non-SSL connections is 80.

 

Exchange Domain

The domain for this instance of the Exchange server. For example, CORP.

This is the domain that users use when logging into their Windows desktops.

 

User Name Suffix

The suffix that is appended to usernames to complete their corporate email address.

Leave this setting blank unless you have a specific reason to change it, for example if you have email addresses with subdomains such as sales.yourcompany.com that resolve to a single domain such as yourcompany.com.

If email addresses cannot be determined from Active Directory, obtain this value from your Exchange administrator.

This suffix must be a fully qualified DNS domain name. It is often, but not always, yourcompany.com. Do not include the @ character.

 

Polling Period (sec)

This setting does not appear in the Configuration Wizard.

Determines how frequently to poll the Exchange server for contact and unified voicemail updates.

Default setting is recommended. A short polling period can adversely affect the performance of the Exchange and Cisco Unified Mobility Advantage servers.

 

Connection Pooling

Cisco Unified Mobility Advantage maintains a pool of connections to Exchange for use as needed, in order to minimize the need to continually reconnect to and disconnect from Exchange. This pool of connections is configured by settings in this tab.

You should not need to change these settings from the default.

These settings do not appear in the Configuration Wizard.

Connection Pooling
Description
Your Value

Max Connections

Maximum number of concurrent connections between Cisco Unified Mobility Advantage and the Exchange server.

 

When Exhausted

When the maximum number of connections is allocated, this determines whether the demand for more connections will grow the pool, or have the requests queued up.

Block—the requests queue up

Grow—the connection pool grows

 

Max Wait Time (sec)

Maximum allowable "wait" time (in seconds) before timeout, if "Block" is selected in the "When Exhausted" setting.

 

Max Idle Connections

Maximum number of connections that can remain idle at any given time. If the number goes above this, the server starts closing the connections.

 

About Cisco Unity or Cisco Unity Connection Enterprise Adapter Settings

Cisco Unity and Cisco Unity Connection provide voicemail services to Cisco Unified Mobility Advantage.

If you have users on more than one Exchange or voicemail server, create a separate voicemail adapter for each Exchange server or voicemail store.

You entered values into these tables while preparing to install or to upgrade from Release 3.x.

Basic Settings

Voicemail Settings Tab

Basic Settings

Setting
Description
Your Value
IMAP Information

Unity Exchange Hostname/IP Address

For Cisco Unity: Hostname of the Exchange server.

If you have users on more than one Exchange server, create a separate Cisco Unity adapter for each Exchange server.

For Cisco Unity Connection: IP address of the Cisco Unity Connection server.

If you have users on more than one Cisco Unity Connection server, create a separate adapter for each Cisco Unity Connection server.

 

Port

If Transport Type is TCP:

For Cisco Unity: Default is 143.

For Cisco Unity Connection: Default is 7993

If Transport Type is TLS:

For Cisco Unity: Default is 993

For Cisco Unity Connection: Default is 7993

 

Polling Period (sec)

The frequency with which Cisco Unified Mobility Advantage checks for new voice messages.

The default is every 600 seconds.

Very frequent polling may impact performance.

 

Transport Type

The connection type for connections to the Exchange server (for Cisco Unity) or to the Cisco Unity Connection server.

This setting must match the setting on the Exchange or Cisco Unity Connection server.

Select TLS for secure connections (SSL on Exchange or TLS on Cisco Unity Connection).

Select TCP for nonsecure connections.

 

Security Context

Select a security context if you chose TLS as the Transport Type.

For the simplest configuration, choose a Security Context that has the Trust Policy set to All Certificates.

If you choose a security context that has the Trust Policy set to Trusted Certificates, you must deploy certificates.

 

Are the Voicemail credentials for the user the same as the corporate credentials?

Select Yes if the user ID and password for user account on the voicemail system is the same as in Active Directory.

Select No otherwise.

 

Unity Version

If you are using Cisco Unity Release 7.x, enter the following SOAP information.

 
SOAP Information
Information in this section applies only to Cisco Unity Release 7.x.

Unity Host Name/ IP Address

The host name or IP address of the Cisco Unity server.

This may or may not be the same as the Unity Exchange Host Name/IP Address which hosts the voice messages that are retrieved by IMAP, which you entered above.

 

Transport Type

Select TLS for SSL connections.

Select TCP for nonsecure connections.

This must match the connection type you specify in Cisco Unity.

 

Port

The SOAP port. The default port for TLS is 443, and the default for TCP is 80.

 

Unity Backup Host Name/ IP Address

The host name or IP address of a back up Cisco Unity server if you have one.

 

Application User Name

The Cisco Unity Application user ID. This is the same user ID that you use to sign in to the Cisco Unity Administration page.

 

Application Password

The Password for the Unity Application User.

 

Domain

The Microsoft Exchange or NT domain of the Cisco Unity inbox.

Note This is not the Fully Qualified Domain Name domain.

 
Additional Information

Security Context

Select a security context for the voicemail server.

For the simplest configuration, choose a Security Context that has the Trust Policy set to All Certificates.

If you choose a security context that has the Trust Policy set to Trusted Certificates, you must deploy necessary certificates.

 

Related Topics

Chapter 9, "Managing Server Security in Cisco Unified Mobility Advantage."

Importing Self-Signed Certificates from Trusted Servers, page 9-10

Deploying Self-Signed Certificates for Internal Servers: Example, page 9-5

Voicemail Settings Tab


Caution We recommend that you keep the default Unity voicemail settings. Do not change these settings unless recommended to do so by Cisco support.

Setting
Description
Your Value

Phone number search field name

Field to search the phone number of a caller.

Default is Subject.

We recommend that you do not change the default value.

 

Phone number search pattern

Regular expression for the search pattern that should be used in the Phone Number Search Field Name field.

This information is used to identify callers by matching information from Cisco Unity and Cisco Unified Communications Manager with existing contact information in Exchange and Active Directory.

Default is the regular expression [0-9]{4,}

We recommend that you do not change the default value.