Cisco Unified Communications Manager SCCP Integration Guide for Cisco Unity Connection Release 2.0
Setting Up a Cisco Unified CallManager 5.0 SCCP Integration with Cisco Unity Connection

Table Of Contents

Setting Up a Cisco Unified CallManager 5.0 SCCP Integration with Cisco Unity Connection

Integration Tasks

Task List to Create the Integration by SCCP

Task List to Change the Number of Voice Messaging Ports

Task List to Add a Cisco Unified CallManager Express Server to a Cisco Unified CallManager Cluster

Requirements

Programming the Cisco Unified CallManager Phone System for Integrating with Cisco Unity Connection

Creating a New Integration with Cisco Unified CallManager

Setting Up Cisco Unified CallManager Authentication and Encryption with Cisco Unity Connection


Setting Up a Cisco Unified CallManager 5.0 SCCP Integration with Cisco Unity Connection


For detailed instructions for setting up a Cisco Unified CallManager 5.0 SCCP integration with Cisco Unity Connection, see the following sections in this chapter:

Integration Tasks

Requirements

Programming the Cisco Unified CallManager Phone System for Integrating with Cisco Unity Connection

Creating a New Integration with Cisco Unified CallManager

This document applies only when Cisco Unity Connection is installed on a separate server from Cisco Unified CallManager. This document does not apply to the configuration in which Cisco Unity Connection is installed as Cisco Unified Communications Manager Business Edition (CMBE)—on the same server with Cisco Unified CallManager.


Note If you are configuring MWI relay across trunks in a distributed phone system, you must refer to the Cisco Unified CallManager documentation for requirements and instructions. Configuring MWI relay across trunks does not involve Cisco Unity Connection settings.


Integration Tasks

The following task lists describe the process for creating and changing the integration.

Task List to Create the Integration by SCCP

Before doing the following tasks to integrate Cisco Unity Connection with Cisco Unified CallManager by Skinny Call Control Protocol (SCCP), confirm that the Cisco Unity Connection server is ready for the integration by completing the applicable tasks in the Installation Guide for Cisco Unity Connection.

1. Review the system and equipment requirements to confirm that all phone system and Cisco Unity Connection server requirements have been met. See the "Requirements" section.

2. Plan how the voice messaging ports will be used by Cisco Unity Connection. See Chapter 2, "Planning How the Voice Messaging Ports Will Be Used by Cisco Unity Connection."

3. Program Cisco Unified CallManager. See the "Programming the Cisco Unified CallManager Phone System for Integrating with Cisco Unity Connection" section.

4. Create the integration. See the "Creating a New Integration with Cisco Unified CallManager" section.


Note An additional Cisco Unified CallManager cluster can be added by creating a new phone system integration through the Phone System Integration Wizard. Each Cisco Unified CallManager cluster is a separate phone system integration.


5. Test the integration. See Chapter 8, "Testing the Integration."

6. If this integration is a second or subsequent integration, add the applicable new use templates for the new phone system. See Chapter 9, "Adding New User Template for Multiple Integrations."

Task List to Change the Number of Voice Messaging Ports

Use the following task list to change the number of voice messaging ports for an integration after it has been created.

1. Change the number of voice messaging ports in Cisco Unified CallManager Administration and in Cisco Unity Connection Administration. See Chapter 10, "Changing the Number of Voice Messaging Ports."

Task List to Add a Cisco Unified CallManager Express Server to a Cisco Unified CallManager Cluster

Use the following task list to add a Cisco Unified CallManager Express server to a Cisco Unified CallManager cluster.

1. Confirm that the Cisco Unified CallManager Express server meets the requirements for integrating with Cisco Unity Connection. Refer to the applicable Cisco Unified CallManager Express integration guide at http://www.cisco.com/en/US/products/ps6509/products_installation_and_configuration_guides_list.html.

2. Add the Cisco Unified CallManager Express server to the port group for the Cisco Unified CallManager phone system integration. See Appendix B, "Adding Cisco Unified Communications Manager Express to a Cisco Unified Communications Manager Integration."

3. If needed, add voice messaging ports. See Chapter 10, "Changing the Number of Voice Messaging Ports."

Requirements

The Cisco Unified CallManager SCCP integration supports configurations of the following components:

Phone System

Cisco Unified CallManager 5.0(x).

For details on compatible versions of Cisco Unified CallManager, refer to the SCCP Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.

The following phones or combinations of phones for the Cisco Unified CallManager extensions:

Only IP phones for the Cisco Unified CallManager extensions.

Both IP phones and SIP phones for the Cisco Unified CallManager extensions without a media termination point (MTP) on the Cisco Unified CallManager server.

Both IP phones and SIP phones for the Cisco Unified CallManager extensions with a media termination point (MTP) on the Cisco Unified CallManager server.

A LAN connection in each location where you will plug the applicable phone into the network.

For multiple Cisco Unified CallManager clusters, the capability for users to dial an extension on another Cisco Unified CallManager cluster without having to dial a trunk access code or prefix.

Cisco Unity Connection Server

The applicable version of Cisco Unity Connection. For details on compatible versions of Cisco Unity Connection, refer to the SCCP Compatibility Matrix: Cisco Unity Connection, Cisco Unified Communications Manager, and Cisco Unified Communications Manager Express at http://www.cisco.com/en/US/products/ps6509/products_device_support_tables_list.html.

Cisco Unity Connection installed and ready for the integration, as described in the Installation Guide for Cisco Unity Connection at http://www.cisco.com/en/US/products/ps6509/prod_installation_guides_list.html.

A license that enables the applicable number of voice messaging ports.

Programming the Cisco Unified CallManager Phone System for Integrating with Cisco Unity Connection

After the Cisco Unified CallManager software is installed, do the following procedures in the order given.

To Add Partitions and a Calling Search Space to Contain the Voice Mail Ports


Step 1 In Cisco Unified CallManager Administration, click Call Routing > Class of Control > Partition.

Step 2 On the Find and List Partitions page, click Add New.

Step 3 On the Partition Configuration page, enter the name and description you want for the partition that will contain all voice mail port directory numbers. For example, enter "VMRestrictedPT, Partition for voice mail port directory numbers."

Step 4 Click Save.

Step 5 Click Add New.

Step 6 Enter the name and description you want for the partition that will contain the hunt pilot, which will be the voice mail pilot number. For example, enter "VMPilotNumberPT, Partition for the voice mail pilot number."

Step 7 Click Save.

Step 8 Click Call Routing > Class of Control > Calling Search Space.

Step 9 On the Find and List Calling Search Spaces page, click Add New.

Step 10 On the Calling Search Space Configuration page, in the Name field, enter a name for the calling search space that will include the partition created in Step 2 through Step 4. For example, enter "VMRestrictedCSS."

Step 11 Optionally, in the Description field, enter a description of the calling search space. For example, enter "Voice mail port directory numbers."

Step 12 In the Available Partitions list, click the name of the partition created in Step 2 through Step 4. For example, click "VMRestrictedPT."

Step 13 Click the down arrow below the Available Partitions list.

The name of the partition appears in the Selected Partitions list.

Step 14 Click Save.

Step 15 On the Find and List Calling Search Spaces page, click Find.

Step 16 Click the name of the calling search space that is used by user phones.

Step 17 On the Calling Search Space Configuration page, in the Available Partitions list, click the name of the partition created in Step 5 through Step 7. For example, click "VMPilotNumberPT."


Caution If the partition that contains the hunt pilot (which will be the voice mail pilot number) is not in the calling search space that is used by user phones, the phones will not be able to dial the Cisco Unity Connection server.

Step 18 Click the down arrow below the Available Partition list.

The name of the partition appears in the Selected Partitions list.

Step 19 Click Save.

Step 20 Repeat Step 16 through Step 19 for each remaining calling search space that needs to access Cisco Unity Connection.


To Add a Device Pool for the Voice Mail Ports


Step 1 In Cisco Unified CallManager Administration, click System > Device Pool.

Step 2 On the Find and List Device Pools page, click Add New.

Step 3 On the Device Pool Configuration page, enter the following device pool settings.

Table 4-1 Settings for the Device Pool Configuration Page 

Field
Setting

Device Pool Name

Enter Cisco Unity Connectionn Voice Mail Ports or other description for this device pool.

Cisco Unified CallManager Group

Click the Cisco Unified Communications Manager group to assign to the voice mail ports in this device pool.

Date/Time Group

Click the date/time group to assign to the voice mail ports in this device pool.

Region

Click the Cisco Unified CallManager region to assign to the voice mail ports in this device pool.

Softkey Template

Click the softkey template to assign to the voice mail ports in this device pool.

SRST Reference

If applicable, click the survivable remote site telephony (SRST) reference to assign to the voice mail ports in this device pool.

Network Hold MOH Source

Click None.

User Hold MOH Audio Source

Click None.


Step 4 Click Save.


In the following procedure, add a voice mail port to Cisco Unified CallManager for each voice mail port that you will connect to Cisco Unity Connection.

To Add Voice Mail Ports to Cisco Unified CallManager


Step 1 In Cisco Unified CallManager Administration, click Voice Mail > Cisco Voice Mail Port Wizard.

Step 2 On the What Would You Like to Do page, click Create a New Cisco Voice Mail Server and Add Ports to It, and click Next.

Step 3 On the Cisco Voice Mail Server page, the name of the voice mail server appears. We recommend that you accept the default name for the voice mail server. If you must use a different name, however, the name must have no more than nine characters.

The voice mail server name must match the Device Name Prefix field in Cisco Unity Connection on the Port Group Basics page for the voice messaging ports.

Step 4 Click Next.

Step 5 On the Cisco Voice Mail Ports page, click the number of voice mail ports that you want to add (which must not be more voice mail ports than the Cisco Unity Connection license enables), then click Next.

If you will integrate Cisco Unity Connection with multiple clusters of Cisco Unified CallManager, the number you enter here cannot bring the total number of ports on all clusters integrated with Cisco Unity Connection to more than the number of ports enabled by the Cisco Unity Connection license.

Step 6 On the Cisco Voice Mail Device Information page, enter the following voice mail device settings.

Table 4-2 Settings for the Voice Mail Device Information Page 

Field
Setting

Description

Enter Cisco Voice Mail Port or another description for the voice mail device.

Device Pool

Click the name of the device pool you created for the voice mail ports. For example, click Cisco Unity Connection Voice Mail Ports.

Calling Search Space

Click the name of a calling search space that allows calls to the user phones and any required network devices.

This calling search space must include partitions that contain all devices Cisco Unity Connection needs to access (for example, during call transfers, message notifications, and MWI activations).

AAR Calling Search Space

Accept the default of None.

Location

Accept the default of None.


Step 7 Click Next.

Step 8 On the Cisco Voice Mail Directory Numbers page, enter the following voice mail directory number settings.

Table 4-3 Settings for the Voice Mail Directory Numbers Page 

Field
Setting

Beginning Directory Number

Enter the extension number of the first voice mail port.

Partition

Click the name of the partition that you set up for all voice mail port directory numbers. For example, click "VMRestrictedPT."

Calling Search Space

Click the name of a calling search space that you set up to contain the partition with all voice mail port directory numbers, as set in Step 9 of the "To Add Partitions and a Calling Search Space to Contain the Voice Mail Ports" procedure. For example, click "VMRestrictedCSS."

Because this calling search space is not used by user phones, users are not able to dial the voice mail ports. However, users can dial the voice mail pilot number.

AAR Group

Click the automated alternate routing (AAR) group for the voice mail ports. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. If you click None, no rerouting of blocked calls will be attempted.

Internal Caller ID Display

Accept the default of Voicemail.

This text appears on the phone when the pilot number is dialed.

Internal Caller ID Display (ASCII Format)

Accept the default of Voicemail.

This text appears on the phone when the pilot number is dialed.

External Number Mask

Leave this field blank, or specify the mask used to format caller ID information for external (outbound) calls. The mask can contain up to 50 characters. Enter the literal digits that you want to appear in the caller ID information, and enter X for each digit in the directory number of the device.

Device Security Mode

Click the security mode that you want to use for the voice mail ports. For details on the settings for Cisco Unified CallManager authentication and encryption of the voice mail ports, see Appendix A, "Cisco Unified Communications Manager Authentication and Encryption of Cisco Unity Connection Voice Messaging Ports."


Step 9 Click Next.

Step 10 On the Do You Want to Add These Directory Numbers to a Line Group page, click No, I Will Add Them Later, and click Next.

Step 11 On the Ready to Add Cisco Voice Mail Ports page, confirm that the settings for the voice mail ports are correct, and click Finish.

If the settings are not correct, click Back and enter the correct settings.


To Add Voice Mail Ports to Line Groups


Step 1 In Cisco Unified CallManager Administration, click Call Routing > Route/Hunt > Line Group.

Step 2 On the Find and List Line Groups page, click Add New.

This line group will contain directory numbers for voice mail ports that will answer calls. Directory numbers for voice mail ports that will only dial out (for example, to set MWIs) must not be included in this line group.

Step 3 On the Line Group Configuration page, enter the following settings.

Table 4-4 Settings for the Line Group Configuration Page for Answering Ports 

Field
Setting

Line Group Name

Enter Cisco Unity Connection Answering Ports or another unique name for line groups.

RNA Reversion Timeout

Accept the default of 10.

Distribution Algorithm

Accept the default of Top Down.

No Answer

Accept the default of Try Next Member; Then, Try Next Group in Hunt List.

Busy

Accept the default of Try Next Member; Then, Try Next Group in Hunt List.

Not Available

Accept the default of Try Next Member; Then, Try Next Group in Hunt List.


Step 4 Under Line Group Member Information, in the Partition list, click the name of the partition that you set up for all voice mail port directory numbers. For example, click "VMRestrictedPT."

Step 5 Click Find.

Step 6 In the Available DN/Route Partition list, click the first directory number of a voice mail port that will answer calls, and click Add to Line Group.


Caution The directory numbers in the Selected DN/Route Partition list must appear in numerical sequence with the lowest number on top. Otherwise, the integration will not function correctly.

Step 7 Repeat Step 6 for all remaining directory numbers of voice mail ports that will answer calls.


Caution Do not include directory numbers of voice mail ports that will only dial out (for example, to set MWIs). Otherwise, the integration will not function correctly.

Step 8 Click Save.

Step 9 If you will have voice mail ports that will only dial out (will not answer calls), do Step 10 through Step 16.

Otherwise, skip the remaining steps in this procedure and continue on to the "To Add the Line Group to a Hunt List" procedure.

Step 10 Click Add New.

This line group will contain directory numbers for voice mail ports that will only dial out. Directory numbers for voice mail ports that answer calls must not be included in this line group.

Step 11 On the Line Group Configuration page, enter the following settings.

Table 4-5 Settings for the Line Group Configuration Page for Dial-Out Ports 

Field
Setting

Line Group Name

Enter Cisco Unity Connection Dial-Out Ports or another unique name.

RNA Reversion Timeout

Accept the default of 10.

Distribution Algorithm

Accept the default of Top Down.

No Answer

Click Stop Hunting.

Busy

Click Stop Hunting.

Not Available

Click Stop Hunting.


Step 12 Under Line Group Member Information, in the Partition list, click the name of the partition that you set up for all voice mail port directory numbers. For example, click "VMRestrictedPT."

Step 13 Click Find.

Step 14 In the Available DN/Route Partition list, click the first directory number of a voice mail port that will only dial out, and click Add to Line Group.


Caution The directory numbers in the Selected DN/Route Partition list must appear in numerical sequence with the lowest number on top. Otherwise, the integration will not function correctly.

Step 15 Repeat Step 14 for all remaining voice mail ports that will only dial out.


Caution Do not include directory numbers of voice mail ports that will answer calls. Otherwise, the integration will not function correctly.

Step 16 Click Save.


To Add the Line Group to a Hunt List


Step 1 In Cisco Unified CallManager Administration, click Call Routing > Route/Hunt > Hunt List.

Step 2 On the Find and List Hunt Lists page, click Add New.

Step 3 On the Hunt List Configuration page, enter the following settings for the hunt list.

Table 4-6 Settings for the Hunt List Configuration Page for Answering Ports 

Field
Setting

Name

Enter Cisco Unity Connection Answering Ports or another unique name for the hunt list.

Description

Enter Cisco Unity Connection ports that answer calls or another description.

Cisco Unified CallManager Group

Click Default or the name of the Cisco Unified CallManager group that you are using.


Step 4 Click Save.

Step 5 Under Hunt List Member Information, click Add Line Group.

Step 6 On the Hunt List Detail Configuration page, in the Line Group list, click the line group you created for the directory numbers of voice mail ports that will answer calls, then click Save.


Caution In the hunt list, do not include line groups with voice mail ports that Cisco Unity Connection will use to dial out. Otherwise, the integration will not function correctly.

Step 7 When alerted that the line group has been inserted, click OK.

Step 8 On the Hunt List Configuration page, click Reset.

Step 9 When asked to confirm resetting the hunt list, click OK.

Step 10 When alerted that the hunt list has been reset, click OK.


To Add the Hunt List to a Hunt Pilot Number


Step 1 In Cisco Unified CallManager Administration, click Call Routing > Route/Hunt > Hunt Pilot.

Step 2 On the Find and List Hunt Pilots page, click Add New.

Step 3 On the Hunt Pilot Configuration page, enter the following settings for the hunt pilot.

Table 4-7 Settings for Hunt Pilot Configuration Page 

Field
Setting

Hunt Pilot

Enter the hunt pilot number for the voice mail ports. The hunt pilot number must be different from the extension numbers of the voice mail ports.

The hunt pilot number is the extension number that users enter to listen to their voice messages.

Partition

Click the name of the partition that you set up for the voice mail pilot number. For example, click "VMPilotNumberPT."

Description

Enter Connection Hunt Pilot or another description.

Numbering Plan

Accept the default setting, or click the numbering plan that you have set up for your system.

Route Filter

Click None, or click the name of the route filter that you set up for your system.

MLPP Precedence

Accept the default setting, or click another setting.

Hunt List

Click the hunt list of voice mail ports that answer calls, which you set up in the "To Add the Line Group to a Hunt List" procedure.

Route Option

Click Route This Pattern.

Provide Outside Dial Tone

Uncheck the check box.


Step 4 Click Save.


To Specify MWI Directory Numbers


Step 1 In Cisco Unified CallManager Administration, click Voice Mail > Message Waiting.

Step 2 On the Find and List Message Waiting Numbers page, click Add New.

Step 3 On the Message Waiting Configuration page, enter the following settings for turning MWIs on.

Table 4-8 Settings for Turning MWIs On 

Field
Setting

Message Waiting Number

Enter the unique extension that turns MWIs on.

Partition

Click the name of the partition that you set up for the voice mail pilot number. For example, click "VMPilotNumberPT."

Description

Enter DN to turn MWIs on or another description.

Message Waiting Indicator

Click On.

Calling Search Space

Click a calling search space that is used by user phones.


Step 4 Click Save.

Step 5 Click Add New.

Step 6 Enter the following settings for turning MWIs off.

Table 4-9 Settings for Turning MWIs Off 

Field
Setting

Message Waiting Number

Enter the unique extension that turns MWIs off.

Partition

Click the name of the partition that you set up for the voice mail pilot number. For example, click "VMPilotNumberPT."

Description

Enter DN to turn MWIs off or another description.

Message Waiting Indicator

Click Off.

Calling Search Space

Click a calling search space that is used by user phones.


Step 7 Click Save.


In the following procedure, you will add the voice mail pilot number, which is the extension that you dial to listen to your voice messages. Your Cisco IP phone automatically dials the voice mail pilot number when you press the Messages button.

To Add a Voice Mail Pilot Number for the Voice Mail Ports


Step 1 In Cisco Unified CallManager Administration, click Voice Mail > Voice Mail Pilot.

Step 2 On the Find and List Voice Mail Pilots page, click Add New.

Step 3 On the Voice Mail Pilot Configuration page, enter the following voice mail pilot number settings.

Table 4-10 Settings for the Voice Mail Pilot Configuration Page 

Field
Setting

Voice Mail Pilot Number

Enter the voice mail pilot number that users will dial to listen to their voice messages. This number must be the same as the hunt pilot number that you entered when adding voice mail ports earlier.

Calling Search Space

Click the calling search space that includes partitions containing the user phones and the partition you set up for the voice mail pilot number.

Description

Enter Cisco Unity Connection Pilot or another description.

Make This the Default Voice Mail Pilot for the System

Check this check box. When this check box is checked, this voice mail pilot number replaces the current default pilot number.


Step 4 Click Save.


To Set Up the Voice Mail Profile


Step 1 In Cisco Unified CallManager Administration, click Voice Mail > Voice Mail Profile.

Step 2 On the Find and List Voice Mail Profiles page, click Add New.

Step 3 On the Voice Mail Profile Configuration page, enter the following voice mail profile settings.

Table 4-11 Settings for the Voice Mail Profile Configuration Page 

Field
Setting

Voice Mail Profile Name

Enter a name to identify the voice mail profile.

Description

Enter Cisco Unity Connection Profile or another description.

Voice Mail Pilot

Click one of the following:

The applicable voice mail pilot number that you defined on the Voice Mail Pilot Configuration page

Use Default

Voice Mail Box Mask

When multitenant services are not enabled on Cisco Unified CallManager, leave this field blank.

When multitenant services are enabled, each tenant uses its own voice mail profile and must create a mask to identify the extensions (directory numbers) in each partition that is shared with other tenants. For example, one tenant can use a mask 972813XXXX, while another tenant can use the mask 214333XXXX. Each tenant also uses its own translation patterns for MWIs.

Make This the Default Voice Mail Profile for the System

Check this check box to make this voice mail profile the default.

When this check box is checked, this voice mail profile replaces the current default voice mail profile.


Step 4 Click Save.


To Set Up the Voice Mail Server Service Parameters


Step 1 In Cisco Unified CallManager Administration, click System > Service Parameters.

Step 2 On the Service Parameters Configuration page, in the Server field, click the name of the Cisco Unified CallManager server.

Step 3 In the Service list, click Cisco CallManager. The list of parameters appears.

Step 4 Under Clusterwide Parameters (Feature - General), locate the Multiple Tenant MWI Modes parameter.

Step 5 If you use multiple tenant MWI notification, click True.

When this parameter is set to True, Cisco Unified CallManager uses any configured translation patterns to convert voice mail extensions into directory numbers when turning on or off an MWI.

Step 6 If you changed any settings, click Save. Then shut down and restart the Cisco Unified CallManager server.


Creating a New Integration with Cisco Unified CallManager

After ensuring that Cisco Unified CallManager and Cisco Unity Connection are ready for the integration, do the following procedure to set up the integration and to enter the port settings.

To Create an Integration


Step 1 Log on to Cisco Unity Connection Administration.

Step 2 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Phone System.

Step 3 On the Search Phone Systems page, on the Phone System menu, click New Phone System. The Phone System Integration Wizard appears.

Step 4 On the Select Phone System Manufacturer page, in the Manufacturer field, click Cisco Systems and click Next.

Step 5 On the Select Phone System Model page, in the Model field, click Cisco Unified Communications Manager and click Next.

Step 6 On the Set Up Phone System page, in the Phone System Name field, accept the default name or enter the descriptive name that you want, and click Next.

Step 7 On the Select Port Group Template page, in the Port Group Template field, click SCCP - Skinny Call Control Protocol and click Next.

Step 8 On the Set Up Port Group page, enter the following settings and click Next.

Table 4-12 Settings for the Set Up Port Group Page 

Field
Setting

Port Group Name

Enter a descriptive name for the port group. You can accept the default name or enter the name that you want.

Device Name Prefix

Enter the prefix that Cisco Unified CallManager adds to the device name for voice ports. This prefix must match the prefix used by Cisco Unified CallManager.

MWI On Extension

Enter the extension that you specified in Cisco Unified CallManager Administration for turning MWIs on.

MWI Off Extension

Enter the extension that you specified in Cisco Unified CallManager Administration for turning MWIs off.

Security Mode

Click the Cisco Unified CallManager security mode that you want to use for the voice messaging ports in this port group.

Number of Ports

Enter the number of voice messaging ports that you want to create in this port group.

IP Address or Host Name

Enter the IP address (or host name) of the primary Cisco Unified CallManager server that you are integrating with Cisco Unity Connection.

Test Address

Click this button to test the IP address that you entered. The results of the test appear in the field to the right of the button.

Port

Enter the TCP port of the primary Cisco Unified CallManager server that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.

TLS Port

Enter the TLS port of the primary Cisco Unified CallManager server that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.

Server Type

Enter Cisco Unified Communications Manager.


Step 9 On the Confirm Phone System Settings page, confirm the settings that you have entered and click Finish.

Step 10 On the Phone System Creation Summary page, click Close.

Step 11 If Cisco Unity Connection does not connect to an AXL server, skip to Step 23. Otherwise, on the Search Phone Systems page, click the display name of the phone system that you created in Step 9.

Step 12 On the Phone System Basics page, in the Edit menu, click Cisco Unified Communications Manager AXL Servers.

Connecting to an AXL server is needed when Cisco Unity Connection must have access to the Cisco Unified CallManager database for importing Cisco Unified CallManager users and for changing certain phone settings for users of Cisco Unity Connection personal call transfer rules.


Caution If you plan to import Cisco Unified CallManager users, confirm that the Primary Extension field on the End User Configuration page for each user is filled in. Otherwise, the search will not find any users to select for importing.

Step 13 Under AXL Servers, click Add New.

Step 14 Enter the following settings for the AXL server and click Save.

Table 4-13 Settings for the AXL Servers 

Field
Setting

Order

Enter the order of priority for the AXL server. The lowest number is the primary AXL server, the higher numbers are the secondary servers.

IP Address

Enter the IP address of the AXL server.

Port

Enter the AXL server port that Cisco Unity Connection connects to. This setting must match the port that the AXL server will use.

The port number is typically 8443.


Step 15 Repeat Step 13 and Step 14 for all remaining AXL servers.

Step 16 Under AXL Server Settings, enter the following settings and click Save.

Table 4-14 Settings for the AXL Server Settings 

Field
Setting

User Name

Enter the user name that Cisco Unity Connection will use to log on to the AXL server.

Note This user must match the username of a Cisco Unified CallManager user who is assigned to the "Standard AXL API Access" role.

Password

Enter the password for the user that Cisco Unity Connection will use to log on to the AXL server.

Note This password must match the password of the Cisco Unified CallManager application user entered in the User Name field.

Cisco Unified Communications Manager Version

5.0 or Greater (SSL)

The AXL port must be an SSL-enabled port (typically port 8443).



Note After the changes to this page are saved, you can click Test (next to the AXL server port number) to verify the connection to the AXL server.


Step 17 To add a corresponding application server to Cisco Unified CallManager, log on to Cisco Unified CallManager Administration.

Step 18 In Cisco Unified CallManager Administration, go to the System > Application Server page.

Step 19 On the Find and List Application Servers page, click Find to display all application servers.

Step 20 In the Name column, click the name of the Cisco Unity Connection server.

Step 21 On the Application Server Configuration page, in the Available Application User field, select the Cisco Unified CallManager application user that you used in Step 16 and click the down arrow to move it to the Selected Application User field.

Step 22 Click Save.

Step 23 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Port Group.

Step 24 On the Search Port Groups page, click the display name of the port group that you created with the phone system integration in Step 9.


Note By default, the display name for a port group is composed of the phone system display name followed by an incrementing number.


Step 25 On the Port Group Basics page, on the Edit menu, click Servers.

Step 26 On the Edit Servers page, do the following substeps if the Cisco Unified CallManager cluster has secondary servers. Otherwise, skip to Step 27.

a. Under Cisco Unified Communications Manager Servers, click Add.

b. Enter the following settings for the secondary Cisco Unified CallManager server and click Save.

Table 4-15 Settings for the Cisco Unified Communications Manager Servers 

Field
Setting

Order

Enter the order of priority for the Cisco Unified CallManager server. The lowest number is the primary Cisco Unified CallManager server, the higher numbers are the secondary servers.

IP Address or Host Name

Enter the IP address (or host name) of the secondary Cisco Unified CallManager server.

Port

Enter the TCP port of the Cisco Unified CallManager server that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.

TLS Port

Enter the TLS port of the Cisco Unified CallManager server that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.

Server Type

Click Cisco Unified Communications Manager.



Note You can click Ping to verify the IP address (or host name) of the Cisco Unified CallManager server.


c. Repeat Step 26a. and Step 26b. for all remaining Cisco Unified CallManager servers in the cluster.

Step 27 Do the following substeps if the Cisco Unified CallManager cluster uses authentication or encryption for the voice messaging ports. Otherwise, skip to Step 28.

a. Under TFTP Servers, click Add.

b. Enter the following settings for the TFTP server and click Save.

Table 4-16 Settings for the TFTP Server 

Field
Setting

Order

Enter the order of priority for the TFTP server. The lowest number is the primary TFTP server, the higher numbers are the secondary servers.

IP Address or Host Name

Enter the IP address (or host name) of the TFTP server.



Note You can click Ping to verify the IP address (or host name) of the TFTP server.


c. Repeat Step Step 27a. and Step 27b. for all remaining TFTP servers in the cluster.

Step 28 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Port.

Step 29 On the Search Ports page, click the display name of the first voice messaging port that you created for this phone system integration.


Note By default, the display names for the voice messaging ports are composed of the port group display name followed by incrementing numbers.


Step 30 On the Port Basics page, set the voice messaging port settings as applicable. The fields in the following table are the ones that you can change.

Table 4-17 Settings for the Voice Messaging Ports 

Field
Considerations

Enabled

Check this check box to enable the port. The port is enabled during normal operation.

Uncheck this check box to disable the port. When the port is disabled, calls to the port get a ringing tone but are not answered. Typically, the port is disabled only by the installer during testing.

Extension

Enter the extension for the port as assigned on the phone system.

Answer Calls

Check this check box to designate the port for answering calls. These calls can be incoming calls from unidentified callers or from users.

Perform Message Notification

Check this check box to designate the port for notifying users of messages. Assign Perform Message Notification to the least busy ports.

Send MWI Requests

Check this check box to designate the port for turning MWIs on and off. Assign Send MWI Requests to the least busy ports.

Allow TRAP Connections

Check this check box so that users can use the port for recording and playback through the phone in Cisco Unity Connection web applications. Assign Allow TRAP Connections to the least busy ports.

Outgoing Hunt Order

Enter the priority order in which Cisco Unity Connection will use the ports when dialing out (for example, if the Perform Message Notification, Send MWI Requests, or Allow TRAP Connections check box is checked). The highest numbers are used first. However, when multiple ports have the same Outgoing Hunt Order number, Cisco Unity Connection will use the port that has been idle the longest.

Security Mode

Click the applicable security mode:

Non-secure—The integrity and privacy of call-signaling messages will not be ensured because call-signaling messages will be sent as clear (unencrypted) text and will be connected to Cisco Unified CallManager through a non-authenticated port rather than an authenticated TLS port. In addition, the media stream will not be encrypted.

Authenticated—The integrity of call-signaling messages will be ensured because they will be connected to Cisco Unified CallManager through an authenticated TLS port. However, the privacy of call-signaling messages will not be ensured because they will be sent as clear (unencrypted) text. In addition, the media stream will not be encrypted.

Encrypted—The integrity and privacy of call-signaling messages will be ensured on this port because they will be connected to Cisco Unified CallManager through an authenticated TLS port, and the call-signaling messages will be encrypted. In addition, the media stream will be encrypted.


Step 31 Click Save.

Step 32 Click Next.

Step 33 Repeat Step 30 through Step 32 for all remaining voice messaging ports for the phone system.

Step 34 If another phone system integration exists, in Cisco Unity Connection Administration, expand Telephony Integrations, then click Trunk. Otherwise, skip to Step 38.

Step 35 On the Search Phone System Trunks page, on the Phone System Trunk menu, click New Phone System Trunk.

Step 36 On the New Phone System Trunk page, enter the following settings for the phone system trunk and click Save.

Table 4-18 Settings for the Phone System Trunk 

Field
Setting

From Phone System

Click the display name of the phone system that you are creating a trunk for.

To Phone System

Click the display name of the previously existing phone system that the trunk will connect to.

Trunk Access Code

Enter the extra digits that Cisco Unity Connection must dial to transfer calls through the gateway to extensions on the previously existing phone system.


Step 37 Repeat Step 35 and Step 36 for all remaining phone system trunks that you want to create.

Step 38 If prompted to restart the Connection Conversation Manager service, do the following substeps. Otherwise, continue to Step 39.

a. In the Navigation drop-down list, click Cisco Unity Connection Serviceability and click Go.

b. On the Cisco Unity Connection Serviceability page, on the Tools menu, click Control Center - Feature Services.

c. On the Control Center - Feature Services page, in the Server drop-down list, click the name of the Cisco Unity Connection server and click Go.

d. Under Cisco Unity Connection Services, click Connection Conversation Manager.

e. At the top of the page, click Restart.

f. When prompted to confirm restarting the service, click Yes.

g. In the Navigation drop-down list, click Cisco Unity Connection Administration and click Go.

h. In Cisco Unity Connection Administration, expand Telephony Integrations, then click Phone System.

Step 39 In the Related Links drop-down list, click Check Telephony Configuration and click Go to confirm the phone system integration settings.

If the test is not successful, the Task Execution Results displays one or more messages with troubleshooting steps. After correcting the problems, test the connection again.

Step 40 In the Task Execution Results window, click Close.

Step 41 If you do not want to set up for Cisco Unified CallManager authentication and encryption, log off Cisco Unity Connection Administration, skip the remaining procedures in this chapter, and continue on to Chapter 8, "Testing the Integration."

If you want to set up for Cisco Unified CallManager authentication and encryption, continue with the "Setting Up Cisco Unified CallManager Authentication and Encryption with Cisco Unity Connection" section below.


Setting Up Cisco Unified CallManager Authentication and Encryption with Cisco Unity Connection

If you are not setting up Cisco Unified CallManager authentication and encryption, skip to Chapter 8, "Testing the Integration."

If you are setting up Cisco Unified CallManager authentication and encryption, do the following procedure.

For additional information about authentication and encryption with Cisco Unified CallManager and Cisco Unity Connection, see Appendix A, "Cisco Unified Communications Manager Authentication and Encryption of Cisco Unity Connection Voice Messaging Ports."


Caution The Cisco Unity Connection system clock must be synchronized with the Cisco Unified CallManager system clock for Cisco Unified CallManager authentication to function immediately. Otherwise, Cisco Unified CallManager will reject the Cisco Unity Connection voice messaging ports until the Cisco Unified CallManager system clock has passed the time stamp in the Cisco Unity Connection device certificates.

To Enable Cisco Unified CallManager Authentication and Encryption for Cisco Unity Connection Voice Messaging Ports


Step 1 If Cisco Unity Connection Administration is not already open, log on to Cisco Unity Connection Administration.

Step 2 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Port.

Step 3 On the Search Ports page, click the display name of the first voice messaging port for the Cisco Unified CallManager phone system integration.


Note By default, the display names for the voice messaging ports are composed of the port group display name followed by incrementing numbers.


Step 4 On the Port Basics page, confirm that the Security Mode field is set to the applicable setting.


Caution The Security Mode setting for Cisco Unity Connection voice messaging ports must match the security mode setting for the Cisco Unified CallManager ports. Otherwise, Cisco Unified CallManager authentication and encryption will fail.

Table 4-19 Security Mode Settings 

Setting
Effect

Non-secure

The integrity and privacy of call-signaling messages will not be ensured because call-signaling messages will be sent as clear (unencrypted) text and will be connected to Cisco Unified CallManager through a non-authenticated port rather than an authenticated TLS port.

In addition, the media stream will not be encrypted.

Authenticated

The integrity of call-signaling messages will be ensured because they will be connected to Cisco Unified CallManager through an authenticated TLS port. However, the privacy of call-signaling messages will not be ensured because they will be sent as clear (unencrypted) text.

In addition, the media stream will not be encrypted.

Encrypted

The integrity and privacy of call-signaling messages will be ensured because they will be connected to Cisco Unified CallManager through an authenticated TLS port, and the call-signaling messages will be encrypted.

In addition, the media stream can be encrypted.


Step 5 If you changed the setting, click Save and click Next.

Step 6 Repeat Step 4 and Step 5 for all remaining voice messaging ports for the Cisco Unified CallManager phone system integration.

Step 7 If prompted to restart the Connection Conversation Manager service, do the following substeps. Otherwise, continue to Step 8.

a. In the Navigation drop-down list, click Cisco Unity Connection Serviceability and click Go.

b. On the Cisco Unity Connection Serviceability page, on the Tools menu, click Control Center - Feature Services.

c. On the Control Center - Feature Services page, in the Server drop-down list, click the name of the Cisco Unity Connection server and click Go.

d. Under Cisco Unity Connection Services, click Connection Conversation Manager.

e. At the top of the page, click Restart.

f. When prompted to confirm restarting the service, click Yes.

Cisco Unity Connection generates the voice messaging port device certificates and the Cisco Unity Connection root certificate.

g. In the Navigation drop-down list, click Cisco Unity Connection Administration and click Go.

Step 8 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Phone System.

Step 9 On the Search Phone Systems page, click the name of the Cisco Unified CallManager phone system for which you want to enable authentication and encryption of the Cisco Unity Connection voice messaging ports.

Step 10 On the Phone System Basics page, on the Edit menu, click Root Certificate.

Step 11 On the View Root Certificate page, right-click the Right-click to Save the Certificate as a File link, and click Save Target As.

Step 12 In the Save As dialog box, browse to the location where you want to save the Cisco Unity Connection root certificate as a file.

Step 13 In the File Name field, confirm that the extension is .pem (rather than .htm), and click Save.


Caution The certificate must be saved as a file with the extension .pem (rather than .htm) or Cisco Unified CallManager will not recognize the certificate.

When Cisco Unity Connection is integrated with both Cisco Unified CallManager 4.x and Cisco Unified CallManager 5.x and later servers, you must copy the .pem file to the Cisco Unified CallManager 5.x and later servers and the .0 file to the Cisco Unified CallManager 4.x server. Otherwise, authentication and encryption will not function correctly.

Step 14 In the Download Complete dialog box, click Close.

Step 15 Copy the Cisco Unity Connection root certificate to all Cisco Unified CallManager servers in this Cisco Unified CallManager phone system integration by doing the following substeps.


Caution The Cisco Unity Connection system clock must be synchronized with the Cisco Unified CallManager system clock for Cisco Unified CallManager authentication to function immediately. Otherwise, Cisco Unified CallManager will not let the Cisco Unity Connection voice messaging ports register until the Cisco Unified CallManager system clock has passed the time stamp in the Cisco Unity Connection device certificates.

a. On the Cisco Unified CallManager server, in Cisco Unified CallManager Platform Administration, on the Security menu, click Certificate Management > Upload Certificate/CTL.

b. On the Cisco IPT Platform Administration page, click Upload Trust Certificate and CallManager - Trust, then click OK.

c. Browse to the Cisco Unity Connection root certificate that you saved in Step 13.

d. Follow the on-screen instructions.

e. Repeat Step 15a. through Step 15d. on all remaining Cisco Unified CallManager servers in the cluster.

Step 16 In Cisco Unity Connection Administration, in the Related Links drop-down list, click Check Telephony Configuration and click Go to confirm the connection to the Cisco Unified CallManager servers.

If the test is not successful, the Task Results list displays one or more messages with troubleshooting steps. After correcting the problems, test the connection again.

Step 17 In the Task Results window, click Close.

Step 18 If prompted to restart the Connection Conversation Manager service, do the following substeps. Otherwise, continue to Step 19.

a. In the Navigation drop-down list, click Cisco Unity Connection Serviceability and click Go.

b. On the Cisco Unity Connection Serviceability page, on the Tools menu, click Control Center - Feature Services.

c. On the Control Center - Feature Services page, in the Server drop-down list, click the name of the Cisco Unity Connection server and click Go.

d. Under Cisco Unity Connection Services, click Connection Conversation Manager.

e. At the top of the page, click Restart.

f. When prompted to confirm restarting the service, click Yes.

Step 19 Log off Cisco Unity Connection Administration.