Installation Guide for Cisco Unified Communications Integration for Microsoft Office Communicator Release 7.1
Configuring Servers for Cisco Unified Communications Integration for Microsoft Office Communicator
Downloads: This chapterpdf (PDF - 215.0KB) The complete bookPDF (PDF - 1.54MB) | Feedback

Configuring Servers for Cisco Unified Communications Integration for Microsoft Office Communicator

Table Of Contents

Configuring Servers for Cisco Unified Communications Integration for Microsoft Office Communicator

How to Configure Active Directory Server and OCS Server

E.164 Formatting

Phone Numbers for Active Directory Users Must Use E.164 Formatting

Enabling Users for OCS

Configuration of Telephony Options for Users

Updating OCS Address Book Manually

Verifying OCS Address Book Synchronization

Dial Plan Options for Cisco UC Integration for Microsoft Office Communicator

Dialing Rules Required for Cisco UC Integration for Microsoft Office Communicator

Application Dialing Rules

Directory Lookup Dialing Rules

How to Configure Cisco Unified Communications Manager Server

Prerequisites for Configuring Cisco Unified Communications Manager

Cisco Unified Communications Manager Client Services Framework Device Type

Enabling LDAP Synchronization

Enabling LDAP Authentication

Creating Devices and Directory Numbers for Users

Adding a User to the Standard CTI Enabled User Group

How to Make Cisco Unified Communications Manager Dialing Rules Accessible

Verifying That Dialing Rules Are Configured on Cisco Unified Communications Manager

Generating Copies of the Dialing Rules

Verifying That Copies of the Dialing Rules Were Generated

Restarting the TFTP Service

Ensuring That Cisco UC Integration for Microsoft Office Communicator Clients Are Restarted

Verifying the Configuration of Active Directory, OCS, and Cisco Unified Communications Manager Servers


Configuring Servers for Cisco Unified Communications Integration for Microsoft Office Communicator


Revised: January 29, 2010

How to Configure Active Directory Server and OCS Server

Dial Plan Options for Cisco UC Integration for Microsoft Office Communicator

How to Configure Cisco Unified Communications Manager Server

Verifying the Configuration of Active Directory, OCS, and Cisco Unified Communications Manager Servers

How to Configure Active Directory Server and OCS Server

When you configure your servers for Cisco UC Integration for Microsoft Office Communicator, you must ensure that the user IDs, devices, and directory numbers match in the following servers:

Active Directory server

Office Communications Server (OCS)

Cisco Unified Communications Manager server

You must also configure your users so that each user has the following:

A phone number that can be correctly dialed within the context of your Cisco Unified Communications Manager configuration.

All phone numbers for the user are in E.164 format.

For more information about the importance of the use of the E.164 format to the deployment of Cisco UC Integration for Microsoft Office Communicator, read the following topics:

E.164 Formatting

Phone Numbers for Active Directory Users Must Use E.164 Formatting

To configure the Active Directory server and the OCS server for Cisco UC Integration for Microsoft Office Communicator, you must perform the following tasks:

Enabling Users for OCS

Updating OCS Address Book Manually

Verifying OCS Address Book Synchronization

E.164 Formatting

The E.164 standard defines an international numbering plan for public phone systems. In the E.164 standard, each number contains a country code, an area code, and a subscriber number. Each phone user has a globally unique number. In Cisco UC Integration for Microsoft Office Communicator, phone numbers in E.164 format must begin with a plus character ("+").

Phone Numbers for Active Directory Users Must Use E.164 Formatting

You must define phone numbers in E.164 format for each user in your Active Directory. This ensures the following:

When Microsoft Office Communicator downloads the OCS address book, each user in the OCS address book is assigned a number in the correct format.

Each user has a phone number that can be correctly dialed within the context of your Cisco Unified Communications Manager configuration.

The Microsoft Office Communicator Automation API reads contacts and their associated phone numbers from Active Directory, and passes this data to the Cisco UC Integration for Microsoft Office Communicator.


Tip Define phone numbers in E.164 format for each user in your Active Directory. If you do not do this, you must configure a set of phone number normalization rules on the OCS server, so that a phone number that can be correctly dialed is available in the OCS address book. Configuring phone number normalization rules can be an error-prone task, especially for international and enterprise dial plans. If you choose not to define phone numbers in E.164 format, see Appendix A, "Normalization Rules for OCS".


What to Do Next

Enabling Users for OCS

Enabling Users for OCS

Procedure


Step 1 Start the Active Directory Users and Computers administrative tool.

Step 2 Expand the domain that contains your users.

Step 3 Open the organizational unit (OU) that contains your users.

Step 4 Check the following details for all users that you want to enable for OCS:

All users have valid email addresses.

All users are assigned to a group.

All the phone numbers for each user are in E.164 format, and can be correctly dialed within the context of your Cisco Unified Communications Manager configuration.

Step 5 Right-click the users, then select Enable users for Communications Server.

Active Directory uses the User logon name field and the domain name to form a SIP email address in the Office Communications Server Address column. This address is used to sign users in to Microsoft Office Communicator, and enables users to send instant messages.


Related Topics

Configuration of Telephony Options for Users

Phone Numbers for Active Directory Users Must Use E.164 Formatting

What to Do Next

Updating OCS Address Book Manually

Configuration of Telephony Options for Users

We strongly recommend that you do not select the following telephony options for your users:

Enable Remote call control

Enable Enterprise Voice

If you select either of these options, voice traffic is allowed from both Cisco UC Integration for Microsoft Office Communicator and Microsoft Office Communicator. This can result in the following problems:

A confusing user experience, as users can place and receive calls from a mixture of user interface elements in both applications.

Inconsistent voice traffic. That is, calls from Cisco UC Integration for Microsoft Office Communicator might give a different audio experience to Microsoft Office Communicator.

A mixed configuration is more difficult to manage, as administrators must track traffic from two sources. You might want to monitor voice usage in your network and if you use both applications, you must configure your monitoring tools to track traffic from both applications.

Related Topics

Enabling Users for OCS

Updating OCS Address Book Manually

To ensure that the OCS address book has the latest information from the Active Directory server, you must update the OCS address book manually. For information about how to perform this task, see the following URL:

http://technet.microsoft.com/en-us/library/bb936631.aspx

What to Do Next

Verifying OCS Address Book Synchronization

Verifying OCS Address Book Synchronization

You must verify that the users are enabled for OCS, that the OCS address book is synchronized with the Active Directory server, and that the OCS address book is configured and operational.

To resolve problems associated with synchronization of the OCS address book, see Troubleshooting Cisco Unified Communications Integration for Microsoft Office Communicator, page 5-1. Alternatively, see the relevant Microsoft documentation.

Procedure


Step 1 Use one of the user accounts to sign in to Microsoft Office Communicator.

This step signs the user in to OCS.

Step 2 Verify that the following message is not displayed in the notifications area in Microsoft Office Communicator after the user signs in:

Cannot Synchronize Address Book


Dial Plan Options for Cisco UC Integration for Microsoft Office Communicator

The following table summarizes the dial plan options available when you deploy Cisco UC Integration for Microsoft Office Communicator:

Option
Phone Numbers in Active Directory
Phone Numbers in Cisco Unified Communications Manager
Comments
1

E.164 number format

E.164 number format

Requires Cisco Unified Communications Manager Release 7.0 or later.

2

E.164 number format

Private numbering plan

Requires you to do the following:

Configure application dialing rules and directory lookup dialing rules on Cisco Unified Communications Manager.

3

Private numbering plan

Private numbering plan

Requires you to do the following:

Configure normalization rules on OCS.

Configure application dialing rules and directory lookup dialing rules on Cisco Unified Communications Manager.


This chapter deals with options 1 and 2. Appendix A, "Normalization Rules for OCS" deals with option 3.


Note If you choose option 3, you must configure a set of phone number normalization rules on the OCS server. Configuring OCS normalization rules can be an error-prone task, especially for international and enterprise dial plans. For more information about this topic, see Appendix A, "Normalization Rules for OCS".


Dialing Rules Required for Cisco UC Integration for Microsoft Office Communicator

If your Cisco Unified Communications Manager uses a private numbering plan, you must configure the following types of dialing rules in Cisco Unified Communications Manager:

Application Dialing Rules

Directory Lookup Dialing Rules

For detailed conceptual and task-based information on dialing rules, see the Cisco Unified Communications Manager Administration online help or the Cisco Unified Communications Manager Administration Guide and the Cisco Unified Communications Manager System Guide:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html


Note If your Cisco Unified Communications Manager uses dialing rules, you must ensure that Cisco UC Integration for Microsoft Office Communicator and Cisco Unified Client Services Framework (CSF) can access these dialing rules.


Related Topics

How to Make Cisco Unified Communications Manager Dialing Rules Accessible

Application Dialing Rules

Application dialing rules modify the dial string on outbound calls to conform to the route plan on the Cisco Unified Communications Manager. For Cisco UC Integration for Microsoft Office Communicator, application dialing rules map numbers in the OCS address book to a number format that can be correctly dialed within the context of your Cisco Unified Communications Manager configuration. That is, you must define application dialing rules to map E.164 numbers to the private numbering plan.

Example Application Dialing Rule for Contacts with North American Numbers

The following table illustrates the application dialing rule that you need to use to resolve E.164-format numbers to a Cisco Unified Communications Manager private numbering plan that uses six-digit numbers beginning with 8.

 
1
2
3
4
5
6
7
8
9
10
11
12

Number for contact in OCS address book in E.164 format

+

1

4

0

8

5

5

5

0

1

0

0

Number begins with +1408555

 

Number of digits is 12

Operations performed by application dialing rule

+

1

4

0

8

5

5

5

0

1

0

0

Number of digits to remove is 7

 

Prefix with 8

Dialed number

850100


Example of Application Dialing Rule for Contacts with Spanish Numbers

The following table illustrates the application dialing rule that you need to use to resolve E.164-format numbers to a Cisco Unified Communications Manager private numbering plan that uses nine-digit numbers beginning with 9.

 
1
2
3
4
5
6
7
8
9
10
11
12

Number for contact in OCS address book in E.164 format

+

3

4

9

8

5

5

5

0

1

9

9

Number begins with +34

 

Number of digits is 12

Operations performed by application dialing rule

+

3

4

9

8

5

5

5

0

1

9

9

Number of digits to remove is 3

 

No prefix required

Dialed number

985550199


Directory Lookup Dialing Rules

Directory lookup dialing rules transform caller identification numbers into numbers that can be looked up in the directory. For example, if the Cisco Unified Communications Manager reports a call from 85550100, that must be transformed into the E.164 format +14085550100 as stored in LDAP to identify the caller as a contact. If numbers in the LDAP are not in E.164 format, but the enterprise routable number is stored in LDAP, then the directory lookup dialing rules need to map incoming numbers to the enterprise routable numbers.

For Cisco UC Integration for Microsoft Office Communicator, directory lookup dialing rules map private numbering plan numbers to the number format used in Active Directory. That is, you must define directory lookup dialing rules to transform private numbering plan numbers to E.164-format numbers.

Example of Directory Lookup Dialing Rule for Contacts with North American Numbers

The following table illustrates the directory lookup dialing rule that you need to use to resolve a number from a Cisco Unified Communications Manager private numbering plan that uses six-digit numbers beginning with 81 to an E.164-format number.

 
1
2
3
4
5
6
7
8
9
10
11
12

Private numbering plan number from Cisco Unified Communications Manager

 

8

1

0

1

9

9

 

Number begins with 81

 

Number of digits is 6

Operations performed by directory lookup dialing rule

+

1

4

0

8

5

5

5

0

1

9

9

Prefix with +1408555

 

Digits to remove is 2

Resulting E.164-format number

+14085550199


Example of Directory Lookup Dialing Rule for Contacts with Spanish Numbers

The following table illustrates the directory lookup dialing rule that you need to use to resolve a number from a Cisco Unified Communications Manager private numbering plan that uses nine-digit numbers beginning with 98 to an E.164-format number.

 
1
2
3
4
5
6
7
8
9
10
11
12

Private numbering plan number from Cisco Unified Communications Manager

 

9

8

5

5

5

0

1

0

0

 

Number begins with 98

 

Number of digits is 9

Operations performed by directory lookup dialing rule

+

3

4

9

8

5

5

5

0

1

0

0

Prefix with +34

 

Digits to remove is 0

Resulting E.164-format number

+34985550100


How to Configure Cisco Unified Communications Manager Server

Before you configure the Cisco Unified Communications Manager server, read the following topics:

Prerequisites for Configuring Cisco Unified Communications Manager

Cisco Unified Communications Manager Client Services Framework Device Type

To configure the Cisco Unified Communications Manager server for Cisco UC Integration for Microsoft Office Communicator, you must perform the following tasks:

Enabling LDAP Synchronization

Enabling LDAP Authentication

Creating Devices and Directory Numbers for Users

How to Make Cisco Unified Communications Manager Dialing Rules Accessible

Prerequisites for Configuring Cisco Unified Communications Manager

You must have a properly working Cisco Unified Communications configuration with the following servers:

Cisco Unified Communications Manager server

For information about Cisco Unified Communications Manager servers, see the documentation at the following URL:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/tsd_products_support_general_information.html

Cisco Trivial File Transfer Protocol (TFTP) server

For information about Cisco TFTP servers, see the Cisco Unified Communications Manager System Guide.

Cisco CTIManager server

For information about Cisco CTIManager servers, see the Cisco Unified Communications Manager System Guide.

Cisco Unified Communications Manager IP Phone (CCMCIP) server

Cisco Unified Communications Manager Client Services Framework Device Type

The Cisco UC Integration for Microsoft Office Communicator requires a new Cisco Unified Communications Manager device type called Client Services Framework. Depending on which release of Cisco Unified Communications Manager is installed in your Cisco Unified Communications system, you might need to patch Cisco Unified Communications Manager with a Cisco Options Package (COP) file.

You must run the COP file if your Cisco Unified Communications Manager does not have the Client Services Framework device type. You run the COP file on the Cisco Unified Communications Manager publisher server. After you apply the COP file, you must restart the Cisco Unified Communications Manager publisher server, and all other servers.

For information about which releases of Cisco Unified Communications Manager require you to run the COP file to install the Client Services Framework device type, see the release notes at the following URL:

http://www.cisco.com/en/US/products/ps10317/prod_release_notes_list.html

What to Do Next

Enabling LDAP Synchronization

Enabling LDAP Synchronization

This allows Cisco Unified Communications Manager to integrate with Active Directory and build the Cisco Unified Communications Manager user database from the same data source where Windows users and Microsoft Office Communicator users are defined.

If you synchronize the Cisco Unified Communications Manager with Active Directory, the Cisco UC Integration for Microsoft Office Communicator user IDs will be the same as the Windows and Microsoft Office Communicator user IDs. If you synchronize the Cisco Unified Communications Manager with Active Directory, you must also enable LDAP authentication. For more information about how to enable LDAP authentication, see Enabling LDAP Authentication.

If you do not synchronize, you must manually map your Cisco Unified Communications Manager user IDs with Windows and Microsoft Office Communicator user IDs. If you choose not to synchronize, see Appendix A, "Normalization Rules for OCS".

Procedure


Step 1 Select System > LDAP > LDAP System in Cisco Unified Communications Manager Administration.

Step 2 Select Enable Synchronizing from LDAP Server.

Step 3 Select Microsoft Active Directory from the LDAP Server Type list box.

Step 4 Select the LDAP attribute that you want to use as the User ID in Cisco Unified Communications Manager from the LDAP Attribute for User ID list box.

Step 5 Select Save.

Step 6 Select System > LDAP > LDAP Directory.

Step 7 Select Add New.

Step 8 Enter data in the LDAP Directory window as required.

Step 9 Select Save.

Step 10 Select Perform Full Sync Now.

For information about how to synchronize with LDAP, see the LDAP directory integration documentation at the following URLs:

Release 7.x: http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/srnd/7x/directry.html

Release 6.x: http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/srnd/6x/directry.html


What to Do Next

Enabling LDAP Authentication

Enabling LDAP Authentication

If you enable LDAP authentication in Cisco Unified Communications Manager, the Active Directory provides authentication services to Cisco Unified Communications Manager by proxy. For example, Cisco Unified Communications Manager can forward authentication requests from the Cisco UC Integration for Microsoft Office Communicator to Active Directory, and Active Directory responds to the request.

Procedure


Step 1 Select System > LDAP > LDAP Authentication in Cisco Unified Communications Manager Administration.

Step 2 Select Use LDAP Authentication for End Users.

Step 3 Select Save.


What to Do Next

Creating Devices and Directory Numbers for Users

Creating Devices and Directory Numbers for Users

Procedure


Step 1 Select Device > Phone in Cisco Unified Communications Manager Administration.

Step 2 Select Add New.

Step 3 Select Client Services Framework from the Phone Type list box, then select Next.

Step 4 Enter information for the phone in the Phone Configuration window, as follows:

Field
Description

Device Name

Enter a name to identify the Cisco Unified Client Services Framework device. The name can contain 1 to 15 characters, including alphanumeric characters, periods, hyphens, and underscores. The device name does not need to relate to the user ID of the user.

Device Pool

Select the device pool to which you want the phone assigned. The device pool defines sets of common characteristics for devices, such as region, date/time group, softkey template, and Multilevel Precedence and Preemption (MLPP) information.

Phone Button Template

Select the appropriate phone button template. The phone button template determines the configuration of buttons on a phone and identifies which feature (line, speed dial, and so on) is used for each button.

Allow Control of Device from CTI

Select this option if you want Cisco UC Integration for Microsoft Office Communicator to be able to control the desk phone of the user with the Computer Telephony Integration (CTI) server.

Ensure that the user is added to the Standard CTI Enabled user group.

Device Security Profile

Select the security profile you require for the phone.

If you select Client Services Framework- Standard SIP Secure Profile, do the following:

a. Enter certification and authentication information in the Certification Authority Proxy Function (CAPF) Information section.

b. Select Generate String.

c. Email the contents of the Authentication String field to the user.

SIP Profile

Select the default SIP profile or a specific profile that was previously created. SIP profiles provide specific SIP information for the phone such as registration and keepalive timers, media ports, and do not disturb control.


Step 5 Enter any other required information, then select Save.

Step 6 Select Reset on the Phone Configuration window to reset the phone.

Step 7 Select the Add a new DN link in the Association Information section on the Phone Configuration window.

Step 8 Enter information for the directory number on the Directory Number Configuration window.

Step 9 Select Save.

Step 10 Select Associate End Users on the Directory Number Configuration window.

Step 11 Search for the user in the Find and List Users window, select the user, then select Add Selected.

Step 12 Select Save.

Step 13 Select User Management > End User in Cisco Unified Communications Manager Administration.

Step 14 Search for the user in the Find and List Users window, then select the user.

Step 15 Verify that the device is listed for the user in the Controlled Devices list box in the Device Associations group.


Related Topics

Adding a User to the Standard CTI Enabled User Group

Cisco Unified Communications Manager Client Services Framework Device Type

Adding a User to the Standard CTI Enabled User Group

If you want Cisco UC Integration for Microsoft Office Communicator to be able to control the desk phone of the user, you must select the Allow Control of Device from CTI option when you create the device for the user. You must also ensure that the user is added to the Standard CTI Enabled user group.

Procedure


Step 1 Select User Management > End User in Cisco Unified Communications Manager Administration.

Step 2 Select the user that you want to add.

Step 3 Select Add to User Group in the Permissions Information group in the End User Configuration window.

Step 4 Search for "Standard CTI" in the Find and List User Groups window.

Step 5 Select the Standard CTI Enabled user group.

Step 6 Select Add Selected.

Step 7 Select Save in the End User Configuration window.


How to Make Cisco Unified Communications Manager Dialing Rules Accessible

If your Cisco Unified Communications Manager uses dialing rules, you must ensure that Cisco UC Integration for Microsoft Office Communicator and CSF can access these dialing rules.

You must run a COP file to generate copies of the dialing rules in XML format, which Cisco UC Integration for Microsoft Office Communicator and CSF can access.

You must run a COP file to generate copies of the dialing rules in XML format, which Cisco UC Integration for Microsoft Office Communicator and CSF can access. You can get the COP file from the Administration Toolkit. To access the Administration Toolkit, navigate to Cisco UC Integration for Microsoft Office Communicator from the Download Software page at the following URL:

http://tools.cisco.com/support/downloads/go/Redirect.x?mdfid=278875240


NoteEvery time you update the dialing rules in your Cisco Unified Communications Manager, you must run the COP file again, to ensure that Cisco UC Integration for Microsoft Office Communicator and CSF can access the updated dialing rules.

You must run the COP file on each Cisco Unified Communications Manager that runs a TFTP server.


To make the Cisco Unified Communications Manager dialing rules accessible by Cisco UC Integration for Microsoft Office Communicator and CSF, you must perform the following tasks:

Verifying That Dialing Rules Are Configured on Cisco Unified Communications Manager

Generating Copies of the Dialing Rules

Verifying That Copies of the Dialing Rules Were Generated

Restarting the TFTP Service

Ensuring That Cisco UC Integration for Microsoft Office Communicator Clients Are Restarted

Verifying That Dialing Rules Are Configured on Cisco Unified Communications Manager

Procedure


Step 1 Select Call Routing > Dial Rules > Application Dial Rules in Cisco Unified Operating System Administration.

Step 2 Search for the dialing rules in the Find and List Application Dial Rules window.

Step 3 Verify that application dialing rules are found.

Step 4 Select Call Routing > Dial Rules > Directory Lookup Dial Rules in Cisco Unified Operating System Administration.

Step 5 Search for the dialing rules in the Directory Lookup Dial Rule Find and List window.

Step 6 Verify that directory lookup rules are found.

If there are no application dialing rules or directory lookup dialing rules on your Cisco Unified Communications Manager, you do not need to make dialing rules accessible by Cisco UC Integration for Microsoft Office Communicator.


What to Do Next

Generating Copies of the Dialing Rules

Generating Copies of the Dialing Rules

You must run a COP file to generate copies of the dialing rules in XML format. You can get the COP file from the Administration Toolkit. To access the Administration Toolkit, navigate to Cisco UC Integration for Microsoft Office Communicator from the Download Software page at the following URL:

http://tools.cisco.com/support/downloads/go/Redirect.x?mdfid=278875240

Procedure


Step 1 Select Software Upgrades > Install/Upgrade in Cisco Unified Operating System Administration.

Step 2 Specify the location of the COP file in the Software Installation/Upgrade window.

Step 3 Select Next.

Step 4 Select the appropriate file from the Available Software list box.

Step 5 Select Next.

Step 6 Select Install.


What to Do Next

Verifying That Copies of the Dialing Rules Were Generated

Verifying That Copies of the Dialing Rules Were Generated

Procedure


Step 1 Select Software Upgrades > TFTP File Management in Cisco Unified Operating System Administration.

Step 2 Search for a directory that begins with CUPC in the TFTP File Management window.

Step 3 Verify that the following files are found:

AppDialRules.xml

DirLookupDialRules.xml


What to Do Next

Restarting the TFTP Service

Restarting the TFTP Service

After you verify the generation of the copies of the dialing rules, restart the TFTP service. You must restart the TFTP service on every server on which you ran the COP file.

For information about how to restart TFTP services, see Cisco Unified Serviceability Administration Guide at the following URL:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html

What to Do Next

Ensuring That Cisco UC Integration for Microsoft Office Communicator Clients Are Restarted

Ensuring That Cisco UC Integration for Microsoft Office Communicator Clients Are Restarted

Procedure


Step 1 Select in the Microsoft Office Communicator title bar.

Step 2 Select Tools > Stop Conversation Pane.

Step 3 Start the Task Manager.

Step 4 End the cucsf.exe process.

Step 5 Select in the Microsoft Office Communicator title bar.

Step 6 Select Tools > Start Conversation Pane.

The Cisco UC Integration for Microsoft Office Communicator client and the cucsf.exe process are automatically restarted.


Verifying the Configuration of Active Directory, OCS, and Cisco Unified Communications Manager Servers

Use a user account to sign in to the User Options pages of a user. Check that the devices associated with the user are the correct devices.