Setting Up a Cisco Unified Communications Manager SCCP Integration
Introduction
This chapter provides instructions for setting up SCCP Integration between Cisco Unified Communications Manager and Cisco Unity Connection.
Note |
If you are configuring MWI relay across trunks in a distributed phone system, you must see the Cisco Unified CM documentation for requirements and instructions. Configuring MWI relay across trunks does not involve Unity Connection settings. |
Pre-requisites
Before starting the SCCP integration between Cisco Unified CM and Unity Connection, you need to understand the tasks to be done and the components required for the integration. Below Table 3-1 contains a list of pre-requisites that you must consider to ensure a successful integration.
Pre-requisites | Important Notes |
Install the applicable version of Cisco Unified CM. |
|
Install the applicable version of Unity Connection with a license that enables the applicable number of voice messaging ports. |
|
|
|
If Unity Connection uses IPv6 or dual-mode (IPv4 and IPv6) to communicate with Cisco Unified CM, do the following subtasks:
|
See the “Ethernet IPv6 Configuration Settings” section in the “Security” chapter of the Cisco Unified Communications Operating System Administration Guide for Cisco Unity Connection Release 12.x at http://www.cisco.com/c/en/us/support/unified-communications/unity-connection/products-maintenance-guides-list.html. |
Integration Tasks
The following task list describes the process for creating and changing the integration.
-
Review the system and hardware requirements to confirm that all phone system and Unity Connection server requirements have been met. See the“Pre-requisites” section on page 3-1
-
Plan and configure how the voice messaging ports are used by Unity Connection. See Planning the Voice Messaging Ports
Note
All the forwarded calls are routed to opening greeting instead of subscriber greeting when Voice mail port, Voice mail pilot, and CTI route point used for routing calls to Unity Connection are same as that of Phone DN on call manager.
-
Program Cisco Unified CM. See the Programming the Cisco Unified CallManager Phone System.
-
Create the integration. See the “Creating a New Integration with Cisco Unified CM.
Note
An additional Cisco Unified CM cluster can be added by adding a new phone system, port group, and ports. Each Cisco Unified CM cluster is a separate phone system integration.
-
Test the integration. See Testing the Integration chapter.
Note
If this is the first integration, the first phone system is automatically selected in the default user template. The users that you add after creating this phone system integration are assigned to this phone system by default. However, for each subsequent integration add the applicable new user templates for the new phone system.For details on adding new user templates, or on selecting a user template when adding a new user, see the “User Templates” section in “User Attributes” chapter of the System Administration Guide for Cisco Unity Connection, Release 12.x available at https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/connection/12x/administration/guide/b_12xcucsag.html.
Programming the Cisco Unified CallManager Phone System
Do the following procedures for programming the Cisco Unified Communications Manager phone system integration with Unity Connection:
Adding Partitions and a Calling Search Space for Voice Mail Ports
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
Step 2 |
On the Find and List Partitions page, select Add New. |
Step 3 |
On the Partition Configuration page, enter the name and description you want for the partition that contains all voice mail port directory numbers. For example, enter “VMRestrictedPT, Partition for voice mail port directory numbers.” |
Step 4 |
Select Save. |
Step 5 |
Select Add New. |
Step 6 |
Enter the name and description you want for the partition that contains the hunt pilot, which is the voice mail pilot number. For example, enter “VMPilotNumberPT, Partition for the voice mail pilot number.” |
Step 7 |
Select Save. |
Step 8 |
Expand . |
Step 9 |
On the Find and List Calling Search Spaces page, select Add New. |
Step 10 |
On the Calling Search Space Configuration page, in the Name field, enter a name for the calling search space that includes 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, select the name of the partition created in Step 2 through Step 4. For example, select “VMRestrictedPT.” |
Step 13 |
Select the down arrow below the Available Partitions list. The name of the partition appears in the Selected Partitions list. |
Step 14 |
Select Save. |
Step 15 |
In the Related Links field, select Back to Find/List and select Go. |
Step 16 |
On the Find and List Calling Search Spaces page, select Find. |
Step 17 |
Select the name of the calling search space that is used by user phones. |
Step 18 |
On the Calling Search Space Configuration page, in the Available Partitions list, select the name of the partition created in Step 5 through Step 7. For example, select “VMPilotNumberPT.” If the partition that contains the hunt pilot (which is the voice mail pilot number) is not in the calling search space that is used by user phones, the phones are not able to dial the Unity Connection server. |
Step 19 |
Select the down arrow below the Available Partition list. The name of the partition appears in the Selected Partitions list. |
Step 20 |
Select Save. |
Step 21 |
Repeat Step 17 through Step 20 for each remaining calling search space that needs to access Unity Connection. |
Adding a Device Pool for the Voice Mail Ports
Procedure
Step 1 |
In Cisco Unified CM Administration, select . |
||||||||||||||||
Step 2 |
On the Find and List Device Pools page, select Add New. |
||||||||||||||||
Step 3 |
On the Device Pool Configuration page, enter the following device pool settings.
|
||||||||||||||||
Step 4 |
Select Save. |
Adding the Voice Mail Ports on Cisco Unified CM
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||||||||
Step 2 |
On the What Would You Like to Do page, select Create a New Cisco Voice Mail Server and Add Ports to It, then select 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 need to 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 Unity Connection on the Port Group Basics page for the voice messaging ports, with -VI appended to the end of the name. For example, if the Device Name Prefix in Cisco Unified CM is CiscoUM, the voice mail server name in Unity Connection should be CiscoUM-VI. |
||||||||||||||||
Step 4 |
Select Next. |
||||||||||||||||
Step 5 |
On the Cisco Voice Mail Ports page, select the number of voice mail ports that you want to add (it should not be more voice mail ports than the Unity Connection licenses enable), then select Next. For a Unity Connection cluster, first enter the number of voice mail ports for the publisher and then for the subscriber, selecting the appropriate server for each creation process. If you integrate Unity Connection with multiple Cisco Unified CM clusters, the number you enter here cannot bring the total number of ports on all Cisco Unified CM clusters integrated with Unity Connection to more than the number of ports enabled by the Unity Connection licenses. |
||||||||||||||||
Step 6 |
On the Cisco Voice Mail Device Information page, enter the following voice mail device settings.
|
||||||||||||||||
Step 7 |
Select Next. |
||||||||||||||||
Step 8 |
On the Cisco Voice Mail Directory Numbers page, enter the following voice mail directory number settings.
|
||||||||||||||||
Step 9 |
Select Next. |
||||||||||||||||
Step 10 |
On the Do You Want to Add These Directory Numbers to a Line Group page, select No, I Add Them Later, and select 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 select Finish. If the settings are not correct, select Back and enter the correct settings. |
Adding the Answering Voice Mail Ports to a Line Group
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||||||
Step 2 |
On the Find and List Line Groups page, select Add New. This line group contain directory numbers for voice mail ports that answers calls. Directory numbers for voice mail ports that only dial out (for example, to set MWIs) must not be included in this line group. For a Unity Connection cluster, the line group contains directory numbers for voice mail ports that answer calls on all servers in the Unity Connection cluster. Directory numbers for voice mail ports that only dial out (for example, to set MWIs) on all servers in the Unity Connection cluster must not be included in this line group. |
||||||||||||||
Step 3 |
On the Line Group Configuration page, enter the following settings.
|
||||||||||||||
Step 4 |
Under Line Group Member Information, in the Partition list, select the name of the partition that you set up for all voice mail port directory numbers. For example, select “VMRestrictedPT.” |
||||||||||||||
Step 5 |
Select Find. |
||||||||||||||
Step 6 |
In the Available DN/Route Partition list, select the first directory number of a voice mail port that answer calls, and select Add to Line Group. The directory numbers in the Selected DN/Route Partition list must appear in numerical sequence with the lowest number on top. Otherwise, the integration does not function correctly. |
||||||||||||||
Step 7 |
Repeat Step 6 for all remaining directory numbers of voice mail ports that answers calls. Do not include directory numbers of voice mail ports that only dial out (for example, to set MWIs). Otherwise, the integration does not function correctly. |
||||||||||||||
Step 8 |
Select Save. |
Adding the Line Group to a Hunt List
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||||
Step 2 |
On the Find and List Hunt Lists page, select Add New. |
||||||||||||
Step 3 |
On the Hunt List Configuration page, enter the following settings for the hunt list.
|
||||||||||||
Step 4 |
Select Save. |
||||||||||||
Step 5 |
Under Hunt List Member Information page, select Add Line Group. |
||||||||||||
Step 6 |
On the Hunt List Detail Configuration page, in the Line Group list, select the line group you created for the directory numbers of voice mail ports that answers calls, then select Save. In the hunt list, do not include line groups with voice mail ports that Unity Connection use to dial out. Otherwise, the integration not function correctly. |
||||||||||||
Step 7 |
When alerted that the line group has been inserted, select OK. |
||||||||||||
Step 8 |
On the Hunt List Configuration page, select Reset. |
||||||||||||
Step 9 |
When asked to confirm resetting the hunt list, select Reset. |
||||||||||||
Step 10 |
When alerted that the hunt list has been reset, select Close. |
Adding the Hunt List to a Hunt Pilot Number
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||||||||||||
Step 2 |
On the Find and List Hunt Pilots page, select Add New. |
||||||||||||||||||||
Step 3 |
On the Hunt Pilot Configuration page, enter the following settings for the hunt pilot.
|
||||||||||||||||||||
Step 4 |
Select Save. |
Specifying the MWI Directory Numbers
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||||
Step 2 |
On the Find and List Message Waiting Numbers page, select Add New. |
||||||||||||
Step 3 |
On the Message Waiting Configuration page, enter the following settings for turning MWIs on.
|
||||||||||||
Step 4 |
Select Save. |
||||||||||||
Step 5 |
Select Add New. |
||||||||||||
Step 6 |
Enter the following settings for turning MWIs off.
|
||||||||||||
Step 7 |
Select Save. |
Add a Voice Mail Pilot Number for the Voice Mail Ports
In the following procedure, you 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.
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||
Step 2 |
On the Find and List Voice Mail Pilots page, select Add New. |
||||||||||
Step 3 |
On the Voice Mail Pilot Configuration page, enter the following voice mail pilot number settings.
|
||||||||||
Step 4 |
Select Save. |
Setting Up the Voice Mail Profile
Procedure
Step 1 |
In Cisco Unified CM Administration, expand . |
||||||||||||
Step 2 |
On the Find and List Voice Mail Profiles page, select Add New. |
||||||||||||
Step 3 |
On the Voice Mail Profile Configuration page, enter the following voice mail profile settings.
|
||||||||||||
Step 4 |
Select Save. |
Setting Up the Voice Mail Server Service Parameters
Procedure
Step 1 |
In Cisco Unified CM Administration, select . |
Step 2 |
On the Service Parameters Configuration page, in the Server field, select the name of the Cisco Unified CM server. |
Step 3 |
In the Service list, select 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, select True. When this parameter is set to True, Cisco Unified CM 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, select Save. Otherwise, skip the remaining steps in this procedure. |
Step 7 |
In the Navigation drop-down box, select Cisco Unified Serviceability and select Go. |
Step 8 |
In Cisco Unified Serviceability, on the Tools menu, select Control Center - Feature Services. |
Step 9 |
Under CM Services, select Cisco CallManager and select Restart. |
Creating a New Integration with Cisco Unified CM
After ensuring that Cisco Unified Communications Manager and Unity Connection are ready for the integration, do the following procedure to set up the integration and to enter the port settings.
Procedure
Step 1 |
In Cisco Unity Connection Administration, expand Telephony Integrations, then select Phone System. |
||||||||||||||||||||||||||
Step 2 |
On the Search Phone Systems page, under Display Name, select the name of the default phone system. |
||||||||||||||||||||||||||
Step 3 |
On the Phone System Basics page, in the Phone System Name field, enter the descriptive name that you want for the phone system. |
||||||||||||||||||||||||||
Step 4 |
If you want to use this phone system as the default for TRaP connections so that administrators and users without voicemail boxes can record and playback through the phone in Unity Connection web applications, check the Default TRAP Switch check box. If you want to use another phone system as the default for TRaP connections, uncheck this check box. |
||||||||||||||||||||||||||
Step 5 |
Select Save. |
||||||||||||||||||||||||||
Step 6 |
On the Phone System Basics page, in the Related Links drop-down box, select Add Port Group and select Go. |
||||||||||||||||||||||||||
Step 7 |
On the New Port Group page, enter the following settings and select Save.
|
||||||||||||||||||||||||||
Step 8 |
On the Port Group Basics page, in the Related Links drop-down box, select Add Ports and select Go. |
||||||||||||||||||||||||||
Step 9 |
On the New Port page, enter the following settings and select Save.
|
||||||||||||||||||||||||||
Step 10 |
On the Search Ports page, select the display name of the first voice messaging port that you created for this phone system integration.
|
||||||||||||||||||||||||||
Step 11 |
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.
|
||||||||||||||||||||||||||
Step 12 |
Select Save. |
||||||||||||||||||||||||||
Step 13 |
Select Next. |
||||||||||||||||||||||||||
Step 14 |
Repeat Step 11 through 13 for all remaining voice messaging ports for the phone system. |
||||||||||||||||||||||||||
Step 15 |
If Cisco Unity Connection does not connect to an AXL server, skip to Step 28. Otherwise, expand Telephony Integrations, then select Phone System. |
||||||||||||||||||||||||||
Step 16 |
On the Search Phone Systems page, select the display name of the phone system that you created in 3. |
||||||||||||||||||||||||||
Step 17 |
On the Phone System Basics page, in the Edit menu, select Cisco Unified Communications Manager AXL Servers. Connecting to an AXL server is needed when Cisco Unity Connection must have access to the Cisco Unified CM database for importing Cisco Unified CM users and for changing certain phone settings for users of Cisco Unity Connection personal call transfer rules.
|
||||||||||||||||||||||||||
Step 18 |
On the Edit AXL Servers page, under AXL Servers, select Add New. |
||||||||||||||||||||||||||
Step 19 |
Enter the following settings for the AXL server and select Save.
|
||||||||||||||||||||||||||
Step 20 | |||||||||||||||||||||||||||
Step 21 |
Under AXL Server Settings, enter the following settings and select Save.
|
||||||||||||||||||||||||||
Step 22 |
To add a corresponding application server to Cisco Unified CM, sign in to Cisco Unified CM Administration. |
||||||||||||||||||||||||||
Step 23 |
In Cisco Unified CM Administration, navigate to System > Application Server page. |
||||||||||||||||||||||||||
Step 24 |
On the Find and List Application Servers page, select Find to display all application servers. |
||||||||||||||||||||||||||
Step 25 |
In the Name column, select the name of the Cisco Unity Connection server. |
||||||||||||||||||||||||||
Step 26 |
On the Application Server Configuration page, in the Available Application User field, select the Cisco Unified CM application user that you used in 21 and select the down arrow to move it to the Selected Application User field. |
||||||||||||||||||||||||||
Step 27 |
Select Save. |
||||||||||||||||||||||||||
Step 28 |
In Cisco Unity Connection Administration, expand Telephony Integrations, then select Port Group. |
||||||||||||||||||||||||||
Step 29 |
On the Search Port Groups page, select the display name of the port group that you created with the phone system integration in Step 7.
|
||||||||||||||||||||||||||
Step 30 |
On the Port Group Basics page, on the Edit menu, select Servers. |
||||||||||||||||||||||||||
Step 31 |
On the Edit Servers page, do the following substeps if the Cisco Unified CM cluster has secondary servers. Otherwise, skip to 32. |
||||||||||||||||||||||||||
Step 32 |
Do the following substeps if the Cisco Unified CM cluster uses authentication or encryption for the voice messaging ports. |
||||||||||||||||||||||||||
Step 33 |
If another phone system integration exists, in Cisco Unity Connection Administration, expand Telephony Integrations, then select Trunk. Otherwise, skip to 37. |
||||||||||||||||||||||||||
Step 34 |
On the Search Phone System Trunks page, on the Phone System Trunk menu, select New Phone System Trunk. |
||||||||||||||||||||||||||
Step 35 |
On the New Phone System Trunk page, enter the following settings for the phone system trunk and select Save.
|
||||||||||||||||||||||||||
Step 36 |
Repeat 34 and 35 for all remaining phone system trunks that you want to create. |
||||||||||||||||||||||||||
Step 37 |
In the Related Links drop-down list, select Check Telephony Configuration and select 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 38 |
In the Task Execution Results window, select Close. |