Table Of Contents
Setting Up a Cisco Unified Communications Manager 7.x SIP Trunk Integration with Cisco Unity Connection
Integration Tasks
Requirements
Programming the Cisco Unified CallManager Phone System for Integrating with Cisco Unity Connection
Creating a New Integration with Cisco Unified Communications Manager
Setting Up a Cisco Unified Communications Manager 7.x SIP Trunk Integration with Cisco Unity Connection
For detailed instructions for setting up a Cisco Unified Communications Manager (CM) (formerly known as Cisco Unified CallManager) 7.x SIP trunk 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 Communications Manager
This document applies only when Cisco Unity Connection is installed on a separate server from Cisco Unified CM. 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 CM.
Note If you are configuring MWI relay across trunks in a distributed phone system, you must refer to the Cisco Unified CM documentation for requirements and instructions. Configuring MWI relay across trunks does not involve Cisco Unity Connection settings.
Cisco Unified CM Music on Hold (MOH) feature is not available during supervised transfers for the Cisco Unified CM SIP trunk integration.
Integration Tasks
Before doing the following tasks to integrate Cisco Unity Connection with Cisco Unified CM through a SIP trunk, 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 CM. 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 Communications Manager" section.
Note A Cisco Unified Communications Manager cluster can be added by creating a new phone system integration through the Phone System Integration Wizard. Each Cisco Unified CM cluster is a separate phone system integration.
5. Test the integration. See Chapter 7, "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 8, "Adding New User Template for Multiple Integrations."
Requirements
The Cisco Unified CM SIP integration supports configurations of the following components:
Phone System
•Cisco Unified CM 7.x.
For details on compatible versions of Cisco Unified CM, refer to the SIP Trunk 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.
•For the Cisco Unified CM extensions, one of the following configurations:
–(Best practice) Only SIP phones that support DTMF relay as described in RFC-2833.
–Both SCCP phones and SIP phones.
Note that older SCCP phone models may require a Media Termination Point (MTP) to function correctly.
•A LAN connection in each location where you will plug the applicable phone into the network.
•For multiple Cisco Unified CM clusters, the capability for users to dial an extension on another Cisco Unified CM 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 SIP Trunk 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 CM software is installed, do the following procedures in the order given.
Note There must be a calling search space that is used by all user phones (directory numbers). Otherwise, the integration will not function correctly. For instructions on setting up a calling search space and assigning user phones to it, refer to the Cisco Unified CM Help.
To Create the SIP Trunk Security Profile
Step 1 In Cisco Unified CM Administration, on the System menu, click Security Profile > SIP Trunk Security Profile.
Step 2 On the Find and List SIP Trunk Security Profiles page, click Add New.
Step 3 On the SIP Trunk Security Profile Configuration page, under SIP Trunk Security Profile Information, enter the following settings.
Table 6-1 Settings for the SIP Trunk Security Profile Configuration Page
Field
|
Setting
|
Name
|
Enter Connection SIP Trunk Security Profile or another name.
|
Description
|
Enter SIP trunk security profile for Cisco Unity Connection or another description.
|
Device Security Mode
|
Accept the default of Non Secure.
|
Accept Out-of-Dialog REFER
|
Check this check box.
|
Accept Unsolicited Notification
|
Check this check box.
|
Accept Header Replacement
|
Check this check box.
|
Step 4 Click Save.
To Create the SIP Profile
Step 1 On the Device menu, click Device Settings > SIP Profile.
Step 2 On the Find and List SIP Profiles page, click Add New.
Step 3 On the SIP Profile Configuration page, enter the following settings.
Table 6-2 Settings for the SIP Profile Configuration Page
Field
|
Setting
|
Name
|
Enter Connection SIP Profile or another name.
|
Description
|
Enter SIP profile for Cisco Unity Connection or another description.
|
Step 4 Click Save.
To Create the SIP Trunk
Step 1 On the Device menu, click Trunk.
Step 2 On the Find and List Trunks page, click Add New.
Step 3 On the Trunk Configuration page, in the Trunk Type field, click SIP Trunk.
Step 4 In the Device Protocol field, click SIP and click Next.
Step 5 Under Device Information, enter the following settings.
Table 6-3 Settings for Device Information on the Trunk Configuration Page
Field
|
Setting
|
Device Name
|
Enter Connection_SIP_Trunk or another name.
|
Description
|
Enter SIP trunk for Cisco Unity Connection or another description.
|
Step 6 If user phones are contained in a calling search space, under Inbound Calls, enter the following settings. Otherwise, continue to Step 7.
Table 6-4 Settings for Inbound Calls on the Trunk Configuration Page
Field
|
Setting
|
Calling Search Space
|
Click the name of the calling search space that contains the user phones.
|
Redirecting Diversion Header Delivery - Inbound
|
Check this check box.
|
Step 7 Under Outbound Calls, check the Redirecting Diversion Header Delivery - Outbound check box.
Step 8 Under SIP Information, enter the following settings.
Table 6-5 Settings for SIP Information on the Trunk Configuration Page
Field
|
Setting
|
Destination Address
|
Enter the IP address of the Cisco Unity Connection SIP port to which Cisco Unified CM will connect.
|
Destination Port
|
We recommend that you accept the default of 5060.
|
SIP Trunk Security Profile
|
Click the name of the SIP trunk security profile that you created in the "To Create the SIP Trunk Security Profile" procedure. For example, click "Cisco Unity Connection SIP Trunk Security Profile."
|
Rerouting Calling Search Space
|
Click the name of the calling search space that is used by user phones.
|
Out-of-Dialog Refer Calling Search Space
|
Click the name of the calling search space that is used by user phones.
|
SIP Profile
|
Click the name of the SIP profile that you created in the "To Create the SIP Profile" procedure. For example, click "Cisco Unity Connection SIP Profile."
|
Step 9 Adjust any other settings that are needed for your site.
Step 10 Click Save.
To Create a Route Pattern
Step 1 On the Call Routing menu, click Route/Hunt > Route Pattern.
Step 2 On the File and List Route Patterns page, click Add New.
Step 3 On the Route Pattern Configuration page, enter the following settings.
Table 6-6 Settings for the Route Pattern Configuration Page
Field
|
Setting
|
Route Pattern
|
Enter the voice mail pilot number for Cisco Unity Connection.
|
Gateway/Route List
|
Click the name of the SIP trunk that you created in the "To Create the SIP Trunk" procedure. For example, click "Connection_SIP_Trunk."
|
Step 4 Click Save.
To Create the Voice Mail Pilot
Step 1 On the Voice Mail menu, click 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 6-7 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 match the route pattern that you entered in the "To Create a Route Pattern" procedure.
|
Calling Search Space
|
Click the calling search space that includes partitions containing the user phones and the partition that you set up for the voice mail pilot number.
|
Description
|
Enter 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 On the Voice Mail menu, click 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 6-8 Settings for the Voice Mail Profile Configuration Page
Field
|
Setting
|
Voice Mail Profile Name
|
Enter Connection Profile or another name to identify the voice mail profile.
|
Description
|
Enter Profile for Cisco Unity Connection or another description.
|
Voice Mail Pilot
|
Click the voice mail pilot that you defined in the "To Create the Voice Mail Pilot" procedure.
|
Voice Mail Box Mask
|
When multitenant services are not enabled on Cisco Unified CM, 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.
Do the following two procedures only if you want to set up SIP Digest authentication.
If you do not want to set up SIP digest authentication, continue to the "Creating a New Integration with Cisco Unified Communications Manager" section.
(Optional) To Set Up SIP Digest Authentication
Step 1 On the System menu, click Security Profile > SIP Trunk Security Profile.
Step 2 On the Find and List SIP Trunk Security Profiles page, click the SIP trunk security profile that you created in the ""To Create the SIP Trunk Security Profile" procedure.
Step 3 On the SIP Trunk Security Profile Configuration page, check the Enable Digest Authentication check box.
Step 4 Click Save.
(Optional) To Create the Application User
Step 1 On the User Management menu, click Application User.
Step 2 On the Find and List Application Users page, click Add New.
Step 3 On the Application User Configuration page, enter the following settings.
Table 6-9 Settings for the Application User Configuration Page
Field
|
Setting
|
User ID
|
Enter the application user identification name. Cisco Unified CM does not permit modifying the user ID after it is created. You may use the following special characters: =, +, <, >, #, ;, \, , "", and blank spaces.
|
Password
|
Enter the same password that you use for the digest credentials.
|
Confirm Password
|
Enter the password again.
|
Digest Credentials
|
Enter the name of the digest credentials.
|
Presence Group
|
Used with the Presence feature, the application user (for example, IPMASysUser) serves as the watcher because it requests status about the presence entity.
If you want the application user to receive the status of the presence entity, make sure that the Application User Presence group is allowed to view the status of the Presence group that is applied to the directory number, as indicated in the Presence Group Configuration window.
|
Accept Presence Subscription
|
Leave this check box unchecked.
|
Accept Out-of-Dialog REFER
|
Check this check box.
|
Accept Unsolicited Notification
|
Check this check box.
|
Accept Header Replacement
|
Leave this check box unchecked.
|
Available Devices
|
This list box displays the devices that are available for association with this application user.
To associate a device with this application user, select the device and click the Down arrow below this list box.
If the device that you want to associate with this application user does not appear in this pane, click one of these buttons to search for other devices:
•Find More Phones—Click this button to find more phones to associate with this application user. The Find and List Phones window appears to enable a phone search.
•Find More Route Points—Click this button to find more phones to associate with this application user. The Find and List CTI Route Points window displays to enable a CTI route point search.
|
Associated CAPF Profiles
|
In the Associated CAPF Profile pane, the Instance ID for the Application User CAPF Profile displays if you configured an Application User CAPF Profile for the user. To edit the profile, click the Instance ID; then, click Edit Profile. The Application User CAPF Profile Configuration window appears.
|
Groups
|
This list box appears after an application user has been added. The list box displays the groups to which the application user belongs.
|
Roles
|
This list box appears after an application user has been added. The list box displays the roles that are assigned to the application user.
|
Step 4 Click Save.
Creating a New Integration with Cisco Unified Communications Manager
After ensuring that Cisco Unified Communications Manager 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 SIP - Session Initiation Protocol and click Next.
Step 8 On the Set Up Port Group page, enter the following settings and click Next.
Table 6-10 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.
|
Contact Line Name
|
Enter the voice messaging line name (or pilot number) that users will use to contact Cisco Unity Connection and that Cisco Unity Connection will use to register with the Cisco Unified CM server.
|
Authenticate with SIP Proxy Server
|
Check this check box if you want Cisco Unity Connection to authenticate with the Cisco Unified CM server.
|
Authentication User Name
|
Enter the name that Cisco Unity Connection will use to authenticate with the Cisco Unified CM server.
|
Authentication Password
|
Enter the password that Cisco Unity Connection will use to authenticate with the Cisco Unified CM server.
|
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 CM 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.
Note Even though the integration is successful, the test may fail on networks where the "ping" command is disabled or ignored, or when the Cisco Unified CM server is not running.
|
Port
|
Enter the IP port of the primary Cisco Unified CM server that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
|
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 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Port Group.
Step 12 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 13 On the Port Group Basics page, on the Edit menu, click Servers.
Step 14 On the Edit Servers page, do the following substeps if the Cisco Unified CM cluster has secondary servers. Otherwise, skip to Step 15.
a. Under SIP Proxy Servers, click Add.
b. Enter the following settings for the secondary Cisco Unified CM server and click Save.
Table 6-11 Settings for the Cisco Unified Communications Manager Servers
Field
|
Setting
|
Order
|
Enter the order of priority for the Cisco Unified CM server. The lowest number is the primary Cisco Unified CM 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 CM server.
|
Port
|
Enter the IP port of the Cisco Unified CM server that you are integrating with Cisco Unity Connection. We recommend that you use the default setting.
|
Note You can click Ping to verify the IP address (or host name) of the Cisco Unified CM server.
c. Repeat Step 14a. and Step 14b. for all remaining Cisco Unified CM servers in the cluster.
Step 15 In Cisco Unity Connection Administration, expand Telephony Integrations, then click Port.
Step 16 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 17 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 6-12 Settings for the Voice Messaging Ports
Field
|
Considerations
|
Enabled
|
Check this check box.
|
Answer Calls
|
Check this check box.
Caution All voice messaging ports connecting to the Cisco Unified CM server must have the Answer Calls box checked. Otherwise, calls to Cisco Unity Connection may not be answered.
|
Perform Message Notification
|
Check this check box to designate the port for notifying users of messages.
|
Send MWI Requests
|
Check this check box to designate the port for turning MWIs on and off.
|
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.
|
Step 18 Click Save.
Step 19 Click Next.
Step 20 Repeat Step 17 through Step 19 for all remaining voice messaging ports for the phone system.
Step 21 If another phone system integration exists, in Cisco Unity Connection Administration, expand Telephony Integrations, then click Trunk. Otherwise, skip to Step 25.
Step 22 On the Search Phone System Trunks page, on the Phone System Trunk menu, click New Phone System Trunk.
Step 23 On the New Phone System Trunk page, enter the following settings for the phone system trunk and click Save.
Table 6-13 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 24 Repeat Step 22 and Step 23 for all remaining phone system trunks that you want to create.
Step 25 If prompted to restart the Connection Conversation Manager service, do the following substeps. Otherwise, continue to Step 26.
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 26 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 27 In the Task Execution Results window, click Close.
Step 28 Log off Cisco Unity Connection Administration.
Feedback
