CUCM Route Patterns¶
Overview¶
Default Cisco Unified Communications Manager (CUCM) dial plan route patterns are deployed as part of the default dial plan schemas that ship with the VOSS Automate template package.
This section describes how you can update these default CUCM dial plan route patterns.
Caution
The Cisco HCS default dial plan includes most common translation and route patterns and in most cases, should be added automatically when a customer dial plan, site dial plan, and voice mail service is provisioned. If you wish to update translation and route patterns using VOSS Automate, you must have a full understanding of the Cisco HCS dial plan. Refer to the VOSS Automate Dial Plan Management Guide.
Configure CUCM Route Patterns¶
This procedure updates the CUCM route patterns that are provisioned by the dial plan schema, and adds new new route patterns from VOSS Automate that are not part of the standard dial plan package.
Note
For more information on the latest CUCM route patterns, refer to http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-maintenance-guides-list.html.
Perform these steps
Log in as a Provider, Reseller, or Customer administrator.
Set the hierarchy path to the node where you want to add or edit the route pattern.
Choose an option, depending on your login:
Provider or Reseller administrator? Go to (default menus) Apps Management > CUCM > Route Patterns.
Customer administrator? Go to (default menus) Apps Management > Advanced > Route Patterns.
Choose an option:
To add a new route pattern, click Add, then go to Step 5.
To edit an existing route pattern, click on the route pattern to be updated and go to Step 6.
From the CUCM drop-down menu, select the hostname, domain name, or IP address of the Unified CM to which you want to add the route pattern.
Note
The CUCM drop-down menu only appears when adding a route pattern, and not when editing an existing route pattern.
Important
If you are adding or editing a route pattern at any hierarchy node above a site level, the only Unified CMs that appear in the CUCM drop-down list are Unified CMs that are located at the node where you are adding the route pattern, and all Unified CMs in hierarchies above the node where you are adding the route pattern. If you are adding or editing a route pattern at a site level, the Unified CM that appears in the CUCM drop-down list is the Unified CM in the site’s Network Device List (NDL). If the site does not have an NDL, or the NDL at the site does not have a Unified CM, the drop-down list is empty and a route pattern can not be added to the site.
Mandatory. In the Route Pattern field, enter the route pattern, or modify the existing route pattern, as required.
Note
Enter the route pattern, including numbers and wildcards (do not use spaces); for example, enter 8XXX for a typical private network numbering plan. Valid characters include the uppercase characters A, B, C, and D and \+, which represents the international escape character +.
If you want to use a partition to restrict access to the route pattern, choose the relevant partition from the Route Partition drop-down. If you do not want to restrict access to the route pattern, choose <None> for the partition.
Note
Ensure that the combination of route pattern, route filter, and partition is unique within the CUCM cluster.
In the Description field, enter a description for the route pattern and route partition if desired.
Note
Description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).
Complete at minimum, the mandatory fields on each tab as appropriate (see below):
Click Save.
Pattern Definition Tab¶
Tip:
Use the Corresponding Cisco Unified Communications Manager (Unified CM) Attribute information provided in the table to manually verify in the Unified CM GUI that fields have been mapped correctly.
Option |
Description |
|---|---|
MLPP Precedence * |
From the drop-down menu, choose a Multilevel Precedence and Preemption (MLPP) service setting for this route pattern:
Default: Default Corresponding Unified CM Attribute: MLPP Precedence. |
Apply Call Blocking Percentage |
Select this check box to enable the Destination Code Control (DCC) feature. By enabling DCC, all calls other than flash and higher precedence calls made to destination are filtered and allowed or disallowed based on the Call Blocking Percentage quota set for the destination. Flash and higher precedence calls are allowed at all times. DCC is disabled by default. Note: The Apply Call Blocking Percentage field gets enabled only if the MLPP level is immediate, priority, routine, or default. Default: Clear Corresponding Unified CM Attribute: Apply Call Blocking Percentage. |
Option |
Description |
|---|---|
Call Blocking Percentage |
Enter the percentage of calls to be blocked for this destination in numerals. This value specifies the percentage of lower precedence calls made to this destination that get blocked by the route pattern. This percentage limits the lower precedence calls only; the flash and higher precedence calls made to this destination are allowed at all times. Values between 0 and 99 are allowed. Note: Unified CM calculates the maximum number of low priority calls to be allowed through this route pattern based on the call blocking percentage that you set for this destination. Note: The Call Blocking Percentage field gets enabled only if the Apply Call Blocking Percentage check box is selected. Default: None Corresponding Unified CM Attribute: <Entry box next to Apply Call Blocking Percentage>. |
Route Class * |
From the drop-down menu, choose a route class setting for this route pattern:
The route class is a DSN code that identifies the class of traffic for a call. The route class informs downstream devices about special routing or termination requirements. The Default setting uses the existing route class of the incoming call. You can use non-default route class settings to translate an inbound T1 CAS route class digit into a Unified CM route class value (and strip off the digit). You should not need to assign a non-default route class setting to any other inbound calls that use pattern configuration. If the route pattern points to a SIP trunk supporting G.Clear, then specify Data or Hotline as the Route Class. Default: Default Corresponding Unified CM Attribute: Route Class. |
Route List (Mandatory if gateway or trunk is not specified) |
Choose the route list for which you are adding a route pattern. Default: None Corresponding Unified CM Attribute: Gateway/Route List. |
Gateway/Trunk (Mandatory if route list is not specified) |
Choose the gateway or trunk list for which you are adding a route pattern. Note: If the gateway is included in a Route Group, this drop-down menu does not display the gateway. When a gateway is chosen in the drop-down menu, Unified CM uses all the ports in the gateway to route or block this route pattern. This action does not apply for MGCP gateways. Default: Clear Corresponding Unified CM Attribute: Gateway/Route List. |
Option |
Description |
|---|---|
Block this pattern |
Indicates whether you want this route pattern to be used for routing calls (such 8[2-9]XX) or for blocking calls. Default: Clear (meaning route pattern is used for routing calls). Corresponding Unified CM Attribute: Block this pattern. |
Block Reason |
If you click Block this pattern radio button above, you must choose the reason that you want this route pattern to block calls. From the drop-down menu, choose one of:
Default: No Error Corresponding Unified CM Attribute: <entry box next to Block this pattern>. |
Call Classification * |
Call Classification indicates whether the call that is routed through this route pattern is considered either off (OffNet) or on (OnNet) the local network. When adding a route pattern, if you clear the Provide Outside Dial Tone check box, you set Call Classification as OnNet. Default: OnNet Corresponding Unified CM Attribute: Call Classification. |
Allow Device Override |
When the check box is selected, the system uses the Call Classification setting that is configured on the associated gateway or trunk to consider the outgoing call as OffNet or OnNet. Default: Clear Corresponding Unified CM Attribute: Allow Device Override |
Provide Outside Dial Tone |
Leave this check box selected to provide outside dial tone. To route the call in the network, clear the check box. Default: Clear Corresponding Unified CM Attribute: Provide Outside Dial Tone. |
Allow Overlap Sending |
With overlap sending enabled, when Unified CM passes a call to the PSTN, it relies on overlap sending in the PSTN to determine how many digits to collect and where to route the call. Select this check box for each route pattern that you consider to be assigned to a gateway or route list that routes the calls to a PSTN that supports overlap sending. The Client Matter Code (CMC) and Forced Authorization Code (FAC) features do not support overlap sending because the Unified CM cannot determine when to prompt the user for the code. If you select the Require Forced Authorization Code or the Require Client Matter Code check box, the system clears the Allow Overlap Sending check box. Default: Clear Corresponding Unified CM Attribute: Allow Overlap Sending |
Urgent Priority |
If the dial plan contains overlapping patterns, Unified CM does not route the call until the interdigit timer expires (even if it is possible to dial a sequence of digits to choose a current match). Select this check box to interrupt interdigit timing when Unified CM must route a call immediately. Default: Clear Corresponding Unified CM Attribute: Urgent Priority. |
Option |
Description |
|---|---|
Require Forced Authorization Code |
If you want to use forced authorization codes with this route pattern, select the check box. The FAC feature does not support overlap sending because the Unified CM cannot determine when to prompt the user for the code. If you select the Allow Overlap Sending check box, you should clear the Require Forced Authorization Code check box. Default: Clear Corresponding Unified CM Attribute: Require Forced Authorization Code. |
Authorization Level * |
Enter the authorization level for the route pattern. The number that you specify in this field determines the minimum authorization level that is needed to successfully route a call through this route pattern. Range is 0 to 255. Default: 0 Corresponding Unified CM Attribute: Authorization Level |
Require Client Matter Code |
If you want to use client matter codes with this route pattern, select this check box. The CMC feature does not support overlap sending because the Unified CM cannot determine when to prompt the user for the code. If you select the Allow Overlap Sending check box, you should clear the Require Client Matter Code check box. Default: Clear Corresponding Unified CM Attribute: <Entry box next to Authorization Level>. |
Calling Party Transformations Tab¶
Option |
Description |
|---|---|
Use Calling Party’s External Phone Number Mask |
Select the check box if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. Note: The calling party transformation settings that are assigned to the route groups in a route list override any calling party transformation settings that are assigned to a route pattern that is associated with that route list. Default: Default Corresponding Unified CM Attribute: Use Calling Party’s External Phone Number Mask |
Calling Party Transform Mask |
Enter a transformation mask value. Valid entries for the National Numbering Plan include the digits 0 through 9, and the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. If this field is blank and the preceding field is clear, no calling party transformation takes place. Default: None Corresponding Unified CM Attribute: Calling Party Transform Mask |
Prefix Digits (Outgoing Calls) |
Enter prefix digits. Valid entries for the National Numbering Plan include the digits 0 through 9, and the wildcard characters asterisk (*) and octothorpe (#); the international escape character +. Note: The appended prefix digit does not affect which directory numbers route to the assigned device. Default: None Corresponding Unified CM Attribute: Prefix Digits (Outgoing Calls). |
Option |
Description |
|---|---|
Calling Line ID Presentation * |
Unified CM uses calling line ID presentation/restriction (CLIP/CLIR) as a supplementary service to allow or restrict the originating caller phone number on a call-by-call basis. Choose whether you want the Unified CM to allow or restrict the display of the calling party phone number on the called party phone display for this route pattern. Choose one of:
For more information about this field, see topics related to calling party number transformations settings in the Cisco Unified Communications Manager System Guide. Default: Default Corresponding Unified CM Attribute: Calling Line ID Presentation. |
Calling Name Presentation * |
Unified CM uses calling name presentation (CNIP/CNIR) as a supplementary service to allow or restrict the originating caller name on a call-by-call basis. Choose whether you want the Unified CM to allow or restrict the display of the calling party name on the called party phone display for this route pattern. Choose one of:
For more information about this field, see calling party number transformations settings in the Cisco Unified Communications Manager System Guide. Default: Default Corresponding Unified CM Attribute: Calling Name Presentation. |
Calling Party Number Type * |
Choose the format for the number type in calling party directory numbers. Unified CM sets the calling directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because Unified CM does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the calling directory number to be encoded to a non-national numbering plan type. Choose one of:
Default: Unified CM Corresponding Unified CM Attribute: Calling Party Number Type. |
Option |
Description |
|---|---|
Calling Party Numbering Plan * |
Choose the format for the numbering plan in calling party directory numbers. Unified CM sets the calling DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because Unified CM does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non-national type number. Choose one of:
Default: Unified CM Corresponding Unified CM Attribute: Calling Party Numbering Plan. |
Connected Party Transformations Tab¶
Option |
Description |
|---|---|
Connected Line ID Presentation * |
Unified CM uses connected line ID presentation (COLP/COLR) as a supplementary service to allow or restrict the called party phone number on a call-by-call basis. Choose whether you want Unified CM to allow or restrict the display of the connected party phone number on the calling party phone display for this route pattern. Choose one of:
If a call that originates from an IP phone on Unified CM encounters a device, such as a trunk, gateway, or route pattern, that has the Connected Line ID Presentation set to Default, the presentation value is automatically set to Allowed. For more information about this field, see topics related to connected party presentation and restriction settings in the Cisco Unified Communications Manager System Guide. Default: Default Corresponding Unified CM Attribute: Connected Line ID Presentation. |
Option |
Description |
|---|---|
Connected Name Presentation * |
Unified CM uses connected name presentation (CONP/CONR) as a supplementary service to allow or restrict the called party name on a call-by-call basis. Choose whether you want Unified CM to allow or restrict the display of the connected party name on the calling party phone display for this route pattern. Choose one of:
For more information about this field, see topics related to connected party presentation and restriction settings in the Cisco Unified Communications Manager System Guide. Default: Default Corresponding Unified CM Attribute: Connected Name Presentation. |
Called Party Transformations Tab¶
Option |
Description |
|---|---|
Discard Digits |
Choose the discard digits instructions that you want to be associated with this route pattern. See topics related to discard digits instructions in the Cisco Unified Communications Manager System Guide for more information. Default: None Corresponding Unified CM Attribute: Discard Digits. |
Called Party Transform Mask |
Enter a transformation mask value. Valid entries for the National Numbering Plan include the digits 0 through 9, and the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. If the field is blank, no transformation takes place. The dialed digits get sent exactly as dialed. Default: None Corresponding Unified CM Attribute: Called Party Transform Mask. |
Prefix Digits (Outgoing Calls) |
Enter prefix digits. Valid entries for the National Numbering Plan include the digits 0 through 9, and the wildcard characters asterisk (*) and octothorpe (#);the international escape character +; and blank. Note: The appended prefix digit does not affect which directory numbers route to the assigned device. Default: None Corresponding Unified CM Attribute: Prefix Digits (Outgoing Calls). |
Option |
Description |
|---|---|
Called Party Number Type * |
Choose the format for the number type in called party directory numbers. Unified CM sets the called directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because Unified CM does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the called directory number to be encoded to a non-national type numbering plan. Choose one of:
Default: Unified CM Corresponding Unified CM Attribute: Called Party Number Type. |
Called Party Numbering Plan * |
Choose the format for the numbering plan in called party directory numbers. Unified CM sets the called DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because Unified CM does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non-national type number. Choose one of:
Default: Unified CM Corresponding Unified CM Attribute: Called Party Numbering Plan. |