[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
The Unity SIP Integration tooling provisions complete SIP integration between redundantly deployed Cisco Call Managers (CUCM) and Cisco Unity Connection (CUC) servers. This integration tooling can be used to define the primary only integration that the legacy Voicemail Service provides.
The integration tooling provides a repeatable process to manage the integration of CUCM and CUC, while also providing the ability to:
Important
Contact your dedicated VOSS support representative for details on how to set up and configure the Unity SIP Integration feature.
Note
If this feature is not exposed in the Admin Portal menu layout, refer to the Optional Features Appendix: Unity SIP Integration - Menu Layout Changes and Access Profile Changes.
Unity SIP Integration Scope
The Unity SIP Integration tooling provides support for:
The Unity SIP Integration feature can be used in place of your existing voicemail service. A list of menus items is available to carry out the Unity SIP Integration tasks. Unity SIP Integration provides SIP integration for both CUCM and CUC.
A typical workflow would be that one or more integration dial plan profiles are set up for use, and then a SIP Unity Integration is pushed to CUCM and CUC.
Menu Name | Description and Notes |
---|---|
Integrate Unity-CallManager | The main tool used to push integration between CUCM and CUC. |
Remove Integrate Unity- CallManager | This allows you to remove the complete integration out of the target CUCM and CUC. |
Dial Plan Profile | This allows an advanced administrator to define all of the dial plan elements that make up the CUC integration, for example device pools, route group, route list, CSSs, and so on. |
Integration Log | This log is populated with information about when the integration was pushed, as well as other details, so that it can be pulled back out again. |
Unity Tenant Management | A "tenant" is basically a small voicemail setup for a sub-company within your larger Connection server. In other words if you had companies sharing a single connection server for voicemail services, you can set each one up as a separate "tenant" in your install which effectively isolates them from one another. Note that a Unity server containing user data without tenants cannot have tenants added after the fact. |
Unity Tenant Add | This allows you to add a unity tenant to the Unity server. |
Unity Tenant Delete | This allows you to remove a unity tenant from the Unity server. |
This option allows you to create a SIP Integration between Cisco Unified Call Manager (CUCM) and Cisco Unity Connection (CUC).
Base
Note
Prior to completing this form, the Provisioning Target Call Manager, the Provisioning Target Unity, and the Voicemail Service Dial Plan Profile must be set. Based on these selections, other key values are auto populated on the form.
Complete, at minimum, the mandatory fields (red border):
UC Publisher Application Selection
Deployment Options
Voicemail Service Dial Plan Profile - Choose from the drop-down list.
Dial Plan Advanced Mode - Select this check box to unlock the fields for dial plan elements. You then have the ability to update those values 'live'.
Clear the check box to return the dial plan elements to the default voicemail dial plan profile values. This check box can be hidden from lower level administrators.
Provision CUCM-Unity in Redundant Mode - Clear this check box for the feature to function in single mode, that is to operate in a similar way to the original voicemail service (Publisher only and no Subscriber trunk).
Select this check box to provision in redundant mode. In this mode, you can configure ports on both the Publisher and Subscriber Unity nodes, as well as build a trunk to both Publisher and Subscriber.
Unity Tenant(s) Present - If the selected 'Provisioning Target Unity' server (see under UC Publisher Application Selection above) has tenants on it, this check box is automatically selected.
CUCM Global
These fields are auto populated based on the Voicemail Service Dial Plan Profile chosen under Deployment Options.
Unity Port Group
Complete, at minimum, the mandatory fields (red border):
Unity Ports
Complete, at minimum, the mandatory fields (red border):
Publisher Server
This field is auto populated based on the Provisioning Target Unity chosen under Deployment Options.
Publisher Port Count -
Subscriber Server -
Subscriber Port Count -
CUCM Voicemail Pilot
Complete, at minimum, the mandatory fields (red border):
Pilot Number - Enter a number to identify the voicemail pilot number.
Calling Search Space - Enter an appropriate calling search space. A calling search space comprises a collection of partitions that are searched for numbers that are called from this pilot number.
This field is auto populated based on the Voicemail Service Dial Plan Profile chosen under Deployment Options.
Default Voice Mail Pilot for the System - Select this check box if you want to replace the current default pilot number, and make this pilot number the default Voice Mail Pilot for the system.
CUCM Voicemail Profile
Complete the following fields as required:
CUCM Route List
Complete the following fields as required:
Name - Enter a name for this route list. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure that each route list name is unique to the route plan.
This field is auto populated based on the Voicemail Service Dial Plan Profile chosen under Deployment Options.
Run On All Active Unified CM Nodes - Select this check box to enable the active route list to run on every node.
Call Manager Group - Choose a CUCM group. The route list registers with the first CUCM in the group, which is its primary Cisco Unified CM.
This field is auto populated based on the Voicemail Service Dial Plan Profile chosen under Deployment Options.
CUCM Route Group
Complete the following fields as required:
Name - Enter a name for this route group. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure that each route group name is unique to the route plan.
This field is auto populated based on the Voicemail Service Dial Plan Profile chosen under Deployment Options.
Distribution Algorithm - Choose a distribution algorithm from the drop-down:
Default = Circular.
CUCM to CUC Publisher SIP Trunk
Complete, at minimum, the mandatory fields (red border):
CUCM to CUC Subscriber SIP Trunk
This tab is only visible if the Provision CUCM-Unity in Redundant Mode check box on the Base tab is selected.
Complete, at minimum, the mandatory fields (red border):
Unity Tenant Management assists in creating groups of objects in Unity Connection that provide a basic "tenant services" application. In short it allows you to create a tenant, which includes numerous interrelated database objects in Connection that work together to provide basic directory segmentation features to allow for isolated groups of users and handlers within your Connection server.
You can add or delete unity tenants.
Add a Unity Tenant
Note
The description, alias and SMTP Domain name must all be unique among tenants in your system.
Delete a Unity Tenant
Note
when deleting a tenant, ALL OBJECTS associated with that tenant are deleted as well. This means all users, call handlers, interviewers, schedules, COS etc. are deleted. There is NO UNDO for this. Make sure you really want to remove a tenant and all its objects before doing so.
Voicemail Integration offering redundancy
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Provisioning Target Call Manager | Provisioning Target Call Manager |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Create Custom Unity Partition and CSS | Create a unique partition/css for Unity Server Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Unity Tenant(s) Present | Compulsory check for Unity Tenants Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Provision CUCM-Unity in Redundant Mode | Provision Unity Subscriber Trunk and Ports to redundant systems Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Provisioning Target Unity | Provisioning Target Unity |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Trunk Security Profile | Add or choose existing SIP Trunk Security Profile |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Profile | Choose existing or create a new SIP profile |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Name | Primary SIP Trunk Device Name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | Primary SIP Trunk Description |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SRTP Allowed | If you will enable Cisco Unified CM authentication and encryption, check this check box Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calling Search Space |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Redirecting Diversion Header Delivery - Inbound | Redirecting Diversion Header Delivery - Inbound Tickbox Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Redirecting Diversion Header Delivery - Outbound | Redirecting Diversion Header Delivery - Outbound Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Destination IP Address | IP Address of the target unity server |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Destination Port | Port of the target unity server trunk |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Rerouting Calling Search Space | Rerouting Calling Search Space |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Trunk Device Pool | Trunk Device Pool |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Profile | Trunk Sip Profile |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Name | SIP Trunk Device Name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | SIP Trunk Description |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SRTP Allowed | If you will enable Cisco Unified CM authentication and encryption, check this check box Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calling Search Space |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Redirecting Diversion Header Delivery - Inbound | Redirecting Diversion Header Delivery - Inbound Tickbox Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Redirecting Diversion Header Delivery - Outbound | Redirecting Diversion Header Delivery - Outbound Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Destination IP Address | IP Address of the target unity server |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Destination Port | Port of the target unity server trunk |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Rerouting Calling Search Space | Rerouting Calling Search Space |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Trunk Device Pool | Trunk Device Pool choice |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Profile | Trunk Sip Profile |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Pilot Number | Unity Pilot for Route Pattern |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calling Search Space | Voicemail Pilot calling search space |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Voicemail Pilot Description | Voicemail Pilot Description |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Default Voice Mail Pilot for the System | Default Voice Mail Pilot for the System Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Unity Server Publisher | Unity server selection |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Unity Server Subscriber | Unity Server Subscriber |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone System | Unity Phone System |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Server Authentication Username | Call Manager Authentication Username |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Server Authentication Password | Call Manager Authentication Password |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Security Profile (IP Port) | SIP Security Profile Default: 5060 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SIP Transport Protocol | SIP Transport Protocol for CUCM Default: TCP |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Primary CUCM IPv4 Address or Host Name | Primary CUCM IPv4 Address or Host Name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Redundant SIP Servers |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Call Manager Server IP or Host Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Custom Unity Partition Name | Custom Unity partition name for option |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Custom Unity CSS Name | Custom Unity CSS Name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Target CUCM IP |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Target CUCM BKEY |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Target CUCM PKID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Target CUC IP |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Target CUC BKEY |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Target CUC PKID |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ports Enabled | Ports Enabled Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Publisher Server | Publisher Server |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Subscriber Server | Subscriber Server |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Answer Calls | Answer Calls Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Perform Message Notification | Perform Message Notification Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Send MWI Requests | Send MWI Requests Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Allow TRAP Connections | Allow TRAP Connections Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Publisher Port Count | Unity Port Count |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Subscriber Port Count | Unity Port Count |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Tenant | Tenant Configured in Unity Connection |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CUC Tenant List | this will only show 1 in the list but that is all we need to evaluate tenancy |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Name | Custom name of route list |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Run On All Active Unified CM Nodes | Run Route List On All Active Unified CM Nodes Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Call Manager Group | Call Manager Group Assignment for Route List |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Name | Route Group Name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Distribution Algorithm | Route Group Distribution Algorithm Default: Top Down |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Voicemail Service Dial Plan Profile | Pre-Configured dial plan framework to reduce input |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dial Plan Advanced Mode | enable editing of Dial Plan element live (Optional) Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
NOTES | Important Notes Default: Please choose the Call Manager, Unity Cluster and Dial Plan Profile before proceeding. Several fields rely on this input to set proper values. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CUC Tenant Count |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Name | Voicemail Profile Name |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | Voicemail Profile Description |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Pilot |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Voice Mail Box Mask | Voice Mail Box Mask |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Make this the default Voice Mail Profile for the System | Make this the default Voice Mail Profile for the System Default: false |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Route Pattern Partition | Route Pattern Partition |
|