Cisco Unified Communications Manager SIP Trunk Integration Guide for Cisco Unity Connection Release 7.x
Setting Up a Cisco Unified CallManager 5.x SIP Trunk Integration with Cisco Unity Connection
Downloads: This chapterpdf (PDF - 287.0KB) The complete bookPDF (PDF - 2.27MB) | Feedback

Setting Up a Cisco Unified CallManager 5.x SIP Trunk Integration with Cisco Unity Connection

Table Of Contents

Setting Up a Cisco Unified CallManager 5.x SIP Trunk Integration with Cisco Unity Connection

Integration Tasks

Requirements

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

For Cisco Unity Connection Without a Connection Cluster

For Cisco Unity Connection with a Connection Cluster Configured

Creating a New Integration with Cisco Unified CallManager


Setting Up a Cisco Unified CallManager 5.x SIP Trunk Integration with Cisco Unity Connection


Revised July 10, 2009

For detailed instructions for setting up a Cisco Unified CallManager 5.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 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.

Cisco Unified CallManager Music on Hold (MOH) feature is not available during supervised transfers for the Cisco Unified CallManager SIP trunk integration.


Integration Tasks

Before doing the following tasks to integrate Cisco Unity Connection with Cisco Unified CallManager 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 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 adding a new phone system, port group, and ports. Each Cisco Unified CallManager cluster is a separate phone system integration.


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

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

Requirements

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

Phone System

Cisco Unified CallManager 5.x.

For details on compatible versions of Cisco Unified CallManager, 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 CallManager 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 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 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.

Centralized Voice Messaging

Cisco Unity Connection supports centralized voice messaging through the phone system, which supports various inter-phone system networking protocols including proprietary protocols such as Avaya DCS, Nortel MCDN, or Siemens CorNet, and standards-based protocols such as QSIG or DPNSS. Note that centralized voice messaging is a function of the phone system and its inter-phone system networking, not voice mail. Connection will support centralized voice messaging as long as the phone system and its inter-phone system networking are properly configured. For details, see the "Centralized Voice Messaging" section in the "Integrating Cisco Unity Connection with the Phone System" chapter of the Design Guide for Cisco Unity Connection Release 7.x at http://www.cisco.com/en/US/docs/voice_ip_comm/connection/7x/design/guide/7xcucdg.html.

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

Revised July 10, 2009

After the Cisco Unified CallManager software is installed, do the procedures in the applicable section:

Cisco Unity Connection without a Connection cluster—Do the procedures in the "For Cisco Unity Connection Without a Connection Cluster" section.

Cisco Unity Connection with a Connection cluster configured—Do the procedures in the "For Cisco Unity Connection with a Connection Cluster Configured" section.

For Cisco Unity Connection Without a Connection Cluster

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 CallManager Help.


To Create the SIP Trunk Security Profile


Step 1 In Cisco Unified CallManager 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 3-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

If you will not enable Cisco Unified CallManager authentication and encryption, accept the default of Non Secure.

If you will enable Cisco Unified CallManager authentication or encryption, click Authenticated or Encrypted. Note the following requirements for the Cisco Unified CallManager server:

A TFTP server must be configured.

The Cisco Unified CallManager server must be configured for security by using the Cisco CTL client. For details, see the "Configuring the Cisco CTL Client" section of the "Configuring the Cisco CTL Client" chapter in the Cisco Unified CallManager Security Guide at http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html.

The Device Security Mode setting on the Cisco Unified CallManager server must match the Security Mode setting on the Cisco Unity Connection server (Authenticated or Encrypted).

X.509 Subject Name

If you will not enable Cisco Unified CallManager authentication and encryption, leave this field blank.

If you will enable Cisco Unified CallManager authentication and encryption, enter Connection or another name. This name must match the Subject Name field for the SIP certificate on the Cisco Unity Connection server.

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 Find.

Step 3 To the right of the SIP profile that you want to copy, click Copy.

Step 4 On the SIP Profile Configuration page, under SIP Profile Information, enter the following settings.

Table 3-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 5 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 3-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 3-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 3-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 CallManager 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 3-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 3-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 > 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 3-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 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.


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 CallManager" 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 3-9 Settings for the Application User Configuration Page 

Field
Setting

User ID

Enter the application user identification name. Cisco Unified CallManager 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.


For Cisco Unity Connection with a Connection Cluster Configured

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 CallManager Help.


To Create the SIP Trunk Security Profile (for a Cisco Unity Connection Cluster)


Step 1 In Cisco Unified CallManager 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 3-10 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

If you will not enable Cisco Unified CallManager authentication and encryption, accept the default of Non Secure.

If you will enable Cisco Unified CallManager authentication or encryption, click Authenticated or Encrypted. Note the following requirements for the Cisco Unified CallManager server:

A TFTP server must be configured.

The Cisco Unified CallManager server must be configured for security by using the Cisco CTL client. For details, see the "Configuring the Cisco CTL Client" section of the "Configuring the Cisco CTL Client" chapter in the Cisco Unified CallManager Security Guide at http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html.

The Device Security Mode setting on the Cisco Unified CallManager server must match the Security Mode setting on the Cisco Unity Connection server (Authenticated or Encrypted).

X.509 Subject Name

If you will not enable Cisco Unified CallManager authentication and encryption, leave this field blank.

If you will enable Cisco Unified CallManager authentication and encryption, enter Connection or another name. This name must match the Subject Name field for the SIP certificate on the Cisco Unity Connection server.

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 (for a Cisco Unity Connection Cluster)


Step 1 On the Device menu, click Device Settings > SIP Profile.

Step 2 On the Find and List SIP Profiles page, click Find.

Step 3 To the right of the SIP profile that you want to copy, click Copy.

Step 4 On the SIP Profile Configuration page, enter the following settings.

Table 3-11 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 5 Under Parameters Used in Phone, in the Retry INVITE field, enter a value that is 5 or less.

Step 6 Click Save.


To Create the SIP Trunk (for a Cisco Unity Connection Cluster)


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 3-12 Settings for Device Information on the Trunk Configuration Page 

Field
Setting

Device Name

Enter Connection_SIP_Trunk_1 or another name.

Description

Enter SIP trunk 1 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 3-13 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 3-14 Settings for SIP Information on the Trunk Configuration Page 

Field
Setting

Destination Address

Enter the IP address of the publisher Cisco Unity Connection server.

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 (for a Cisco Unity Connection Cluster)" 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 (for a Cisco Unity Connection Cluster)" 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.

Step 11 Click Add New.

Step 12 On the Trunk Configuration page, in the Trunk Type field, click SIP Trunk.

Step 13 In the Device Protocol field, click SIP and click Next.

Step 14 Under Device Information, enter the following settings.

Table 3-15 Settings for Device Information on the Trunk Configuration Page 

Field
Setting

Device Name

Enter Connection_SIP_Trunk_2 or another name.

Description

Enter SIP trunk 2 for Cisco Unity Connection or another description.


Step 15 If user phones are contained in a calling search space, under Inbound Calls, enter the following settings. Otherwise, continue to Step 16.

Table 3-16 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 16 Under Outbound Calls, check the Redirecting Diversion Header Delivery - Outbound check box.

Step 17 Under SIP Information, enter the following settings.

Table 3-17 Settings for SIP Information on the Trunk Configuration Page  

Field
Setting

Destination Address

Enter the IP address of the subscriber Cisco Unity Connection server.

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 (for a Cisco Unity Connection Cluster)" 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 (for a Cisco Unity Connection Cluster)" procedure. For example, click "Cisco Unity Connection SIP Profile."


Step 18 Adjust any other settings that are needed for your site.

Step 19 Click Save.


To Create a Route Group (for a Cisco Unity Connection Cluster)


Step 1 On the Call Routing menu, click Route/Hunt > Route Group.

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

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

Table 3-18 Settings for the Route Group Configuration Page 

Field
Setting

Route Group Name

Enter SIP_Trunk_Route_Group or another name.

Distribution Algorithm

Click Top Down.


Step 4 Confirm that both SIP trunks appear in the Available Devices field. Otherwise, click Find.

Step 5 Click Add to Route Group.

Step 6 Under Current Route Group Members, confirm that the SIP trunk that connects to the subscriber Cisco Unity Connection server appears first in the list.

You can click the up or down arrows to change the order of the SIP trunks.

Step 7 Click Save.


To Create a Route List (for a Cisco Unity Connection Cluster)


Step 1 On the Call Routing menu, click Route/Hunt > Route List.

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

Step 3 On the Route List Configuration page, enter the following settings.

Table 3-19 Settings for the Route List Configuration Page 

Field
Setting

Name

Enter SIP_Trunk_Route_List or another name.

Description

Enter SIP Trunk Route List or another description.

Cisco Unified Communications Manager Group

Click Default.


Step 4 Click Save.

Step 5 Confirm that the Enable This Route List check box is checked.

Step 6 Under Route List Member Information, click Add Route Group.

Step 7 On the Route List Detail Configuration page, in the Route Group field, click the Route Group that you created in the "To Create a Route Group (for a Cisco Unity Connection Cluster)" procedure and click Save.

Step 8 When prompted that the route list settings will be saved, click OK.

Step 9 On the Route List Configuration page, click Reset.

Step 10 When prompted to confirm resetting the route list, click Reset.

Step 11 Click Close.


To Create a Route Pattern (for a Cisco Unity Connection Cluster)


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 3-20 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 route list that you created in the "To Create a Route List (for a Cisco Unity Connection Cluster)" procedure. For example, click "SIP_Trunk_Route_List."


Step 4 Click Save.


To Create the Voice Mail Pilot (for a Cisco Unity Connection Cluster)


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 3-21 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 (for a Cisco Unity Connection Cluster)" 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 (for a Cisco Unity Connection Cluster)


Step 1 On the Voice Mail menu, 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 3-22 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 (for a Cisco Unity Connection Cluster)" procedure.

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.


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 CallManager" section.

(Optional) To Set Up SIP Digest Authentication (for a Cisco Unity Connection Cluster)


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 (for a Cisco Unity Connection Cluster)" 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 (for a Cisco Unity Connection Cluster)


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 3-23 Settings for the Application User Configuration Page 

Field
Setting

User ID

Enter the application user identification name. Cisco Unified CallManager 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 CallManager

Revised July 10, 2009

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 If you will use Cisco Unified CallManager authentication and encryption, do the following substeps. Otherwise, skip to Step 3.

a. In Cisco Unity Connection Administration, expand Telephony Integrations, expand Security, then click SIP Certificate.

b. On the SIP Certificates page, click Add New.

c. On the New SIP Certificate page, enter the following settings for the SIP certificate and click Save.

Table 3-24 Settings for the New SIP Certificate Page 

Field
Setting

Display Name

Enter a display name for the SIP certificate.

Subject Name

Enter a subject name that matches the X.509 Subject Name of the SIP security profile for the SIP trunk in Cisco Unified CallManager Administration.


Caution This subject name must match the X.509 Subject Name of the SIP security profile used by Cisco Unified CallManager. Otherwise, Cisco Unified CallManager authentication and encryption will fail.

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

Step 4 On the Search Phone Systems page, under Display Name, click the name of the default phone system.

Step 5 On the Phone System Basics page, in the Phone System Name field, enter the descriptive name that you want for the phone system.

Step 6 If you want to use this phone system for TRaP connections (when users record and playback through the phone in Cisco Unity Connection web applications), check the Default TRAP Switch check box. If you want to use another phone system for TRaP connections, uncheck this check box.

Step 7 Click Save.

Step 8 On the Phone System Basics page, in the Related Links drop-down box, click Add Port Group and click Go.

Step 9 On the New Port Group page, enter the applicable settings and click Save.

Table 3-25 Settings for the New Port Group Page 

Field
Setting

Phone System

Click the name of the phone system that you entered in Step 5.

Create From

Click Port Group Template and click SIP in the drop-down box.

Display Name

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

Authenticate with SIP Server

Check this check box if you want Cisco Unity Connection to authenticate with the Cisco Unified CallManager server.

Authentication User Name

Enter the name that Cisco Unity Connection will use to authenticate with the Cisco Unified CallManager server.

Authentication Password

Enter the password that Cisco Unity Connection will use to authenticate with the Cisco Unified CallManager server.

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 CallManager server.

SIP Security Profile

Click the SIP security profile that Cisco Unity Connection will use.

SIP Certificate

(Only when a secure TLS port is used) Confirm that the applicable SIP certificate is selected.

Security Mode

(Only when a secure TLS port is used) Click the applicable security mode:

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

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 secure TLS port, and the call-signaling messages will be encrypted.

The Security Mode setting on the Cisco Unity Connection server must match the Device Security Mode setting on the Cisco Unified CallManager server.

Secure RTP

(Only when a secure TLS port is used) Check this check box so that the media stream (RTP) is encrypted. Uncheck this check box so that the media stream is not encrypted.

SIP Transport Protocol

Click the SIP transport protocol that Cisco Unity Connection will use.

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.

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.


Step 10 On the Port Group Basics page, do the following substeps if the Cisco Unified CallManager cluster has secondary servers or if you want to add a TFTP server (required for Cisco Unified CallManager authentication and encryption). Otherwise, skip to Step 11.

a. On the Edit menu, click Servers.

b. If you want to add a secondary Cisco Unified CallManager server, on the Edit Servers page, under SIP Servers, click Add. Otherwise, skip to Step 10e.

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

Table 3-26 Settings for the SIP 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 IP 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.


d. If applicable, repeat Step 10b. and Step 10c. for an additional Cisco Unified CallManager server in the Cisco Unified CallManager cluster.

e. If you want to add a TFTP server (required for Cisco Unified CallManager authentication and encryption), under TFTP Servers, click Add. Otherwise, skip to Step 10h.

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

Table 3-27 Settings for the TFTP Servers 

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.


g. If applicable, repeat Step 10e. and Step 10f. for an additional TFTP server.

h. On the Edit menu, click Port Group Basics.

i. On the Port Group Basics page, click Reset.

Step 11 On the Port Group Basics page, in the Related Links drop-down box, click Add Ports and click Go.

Step 12 On the New Port page, enter the following settings and click Save.

Table 3-28 Settings for the New Port Page 

Field
Setting

Enabled

Check this check box.

Number of Ports

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

Note For a Cisco Unity Connection cluster, you must enter the total number of voice messaging ports that will be used by all Cisco Unity Connection servers. Each port will later be assigned to a specific Cisco Unity Connection server.

Phone System

Click the name of the phone system that you entered in Step 5.

Port Group

Click the name of the port group that you added in Step 9.

Server Name

Click the name Cisco Unity Connection server.


Step 13 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 14 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 3-29 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.

Server Name

(For Cisco Unity Connection clusters only) Click the name of the Cisco Unity Connection server that you want to handle this port.

Assign an equal number of answering and dial-out voice messaging ports to the Cisco Unity Connection servers so that they equally share the voice messaging traffic.

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.


Step 15 Click Save.

Step 16 Click Next.

Step 17 Repeat Step 14 through Step 16 for all remaining voice messaging ports for the phone system.

Step 18 If you will use Cisco Unified CallManager authentication and encryption, do the following substeps. Otherwise, skip to Step 20.

a. In Cisco Unity Connection Administration, expand Telephony Integrations > Security, then click Root Certificate.

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

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

d. 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.

e. In the Download Complete dialog box, click Close.

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

a. On the Cisco Unified CallManager server, log on to Cisco Unified CallManager Platform Administration.

b. In Cisco Unified CallManager Platform Administration, on the Security menu, click Certificate Management > Upload Certificate/CTL.

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

d. In the Choose File dialog box, browse to the Cisco Unity Connection root certificate that you saved in Step 18.

e. Click Open.

f. On the Upload Certificate page, click Upload File.

g. Click Close.

h. Repeat Step 19 on all remaining Cisco Unified CallManager servers in the Cisco Unified CallManager cluster.

i. Repeat Step 19 on all Cisco Unified CallManager servers in all remaining Cisco Unified CallManager clusters.

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

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

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

Table 3-30 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 23 Repeat Step 21 and Step 22 for all remaining phone system trunks that you want to create.

Step 24 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 25 In the Task Execution Results window, click Close.