Cisco Unified Communications Manager Administration Guide, Release 9.1(1)
Route pattern setup
Downloads: This chapterpdf (PDF - 1.19MB) The complete bookPDF (PDF - 9.6MB) | Feedback

Route pattern setup

Route pattern setup

This chapter provides information to find, add, update, copy, or delete a route pattern.

For additional information, see topics related to wildcards and special characters in route patterns and hunt pilots in the Cisco Unified Communications Manager System Guide, as well as topics related to route plans and route filter configuration.

For additional information about local route groups, see the Cisco Unified Communications Manager Features and Services Guide.

Related References

About route pattern setup

In Cisco Unified Communications Manager Administration, use the Call Routing > Route/Hunt > Route Pattern menu path to configure route patterns.

A route pattern comprises a string of digits (an address) and a set of associated digit manipulations that route calls to a route list or a gateway. Route patterns provide flexibility in network design. They work in conjunction with route filters and route lists to direct calls to specific devices and to include, exclude, or modify specific digit patterns.

See topics related to understanding route plans in the Cisco Unified Communications Manager System Guide for more detailed route pattern information.


Note


See topics related to local route groups in the Cisco Unified Communications Manager Features and Services Guide for a discussion of route patterns and their use and configuration when the Local Route Group feature is configured.


Route pattern configuration tips

Before you begin, ensure that the following items are configured in Cisco Unified Communications Manager:

  • Gateway
  • Route list
  • Partition (unless you are using <None>)
  • Route filter (unless you are using <None>)

    Timesaver


    Assigning 8XXX to a gateway routes all directory numbers 8000 to 8999 out the gateway. Similarly, 82XX routes directory numbers 8200 to 8299. See topics related to special characters and settings in the Cisco Unified Communications Manager System Guide for more information about wildcards.



Note


If you change the gateway or route list, you must click Save prior to choosing the Edit link. Otherwise, you get linked to the previous gateway or route list.



Note


The (Edit) link next to the Gateway or Route List field takes you to the Gateway Configuration or Route List Configuration window for reference, depending on whether the Gateway or Route List field contains a gateway or a route list. The Gateway Configuration window displays devices that are associated with the specified gateway. The Route List Configuration window displays the route groups that are associated with the specified route list.


Route pattern settings

The following table describes the available fields in the Route Pattern Configuration window.

Table 1 Route pattern settings

Field

Description

Pattern Definition

Route Pattern

Enter the route pattern, including numbers and wildcards (do not use spaces); for example, for NANP, enter 9.@ for typical local access or 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 +.

Note   

Ensure that the directory route pattern, which uses the chosen partition, route filter, and numbering plan combination, is unique. Check the route pattern, translation pattern, directory number, call park number, call pickup number, message waiting on/off, or meet me number if you receive an error that indicates duplicate entries. You can also check the route plan report.

See topics related to wildcards and special characters in route patterns and hunt pilots in the Cisco Unified Communications Manager System Guide for more information about wildcards.

Route Partition

If you want to use a partition to restrict access to the route pattern, choose the desired partition from the drop-down list box. If you do not want to restrict access to the route pattern, choose <None> for the partition.

You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Partitions window, then find and choose a partition name.

Note   

To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters.

Note   

Make sure that the combination of route pattern, route filter, and partition is unique within the Cisco Unified Communications Manager cluster.

Description

Enter a description of the route pattern. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).

Numbering Plan

Choose a numbering plan.

Route Filter

If your route pattern includes the @ wildcard, you may choose a route filter. The optional act of choosing a route filter restricts certain number patterns.

The route filters that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box.

You can configure the number of items that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more route filters exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Route Filters window, then find and choose a route filter name.

Note   

To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters.

MLPP Precedence

Choose an MLPP precedence setting for this route pattern from the drop-down list box:

  • Executive Override—Highest precedence setting for MLPP calls.
  • Flash Override—Second highest precedence setting for MLPP calls.
  • Flash—Third highest precedence setting for MLPP calls.
  • Immediate—Fourth highest precedence setting for MLPP calls.
  • Priority—Fifth highest precedence setting for MLPP calls.
  • Routine—Lowest precedence setting for MLPP calls.
  • Default—Does not override the incoming precedence level but rather lets it pass unchanged.
Note   

See topics related to multilevel precedence and preemption in the Cisco Unified Communications Manager Features and Services Guide for more information.

Note   

You cannot configure the Multilevel Precedence Preemption (MLPP) level on the Route Pattern page to flash, flash override, or executive override levels if you want to enable the DCC feature. You must set the MLPP level to these levels at the translation pattern instead.

Apply Call Blocking Percentage

Check 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 the 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.

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.

Note   

Cisco Unified Communications Manager 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 checked.

Resource Priority Namespace Network Domain

Choose a Resource Priority Namespace Network Domain from the drop-down list box. To configure the Resource Priority Namespace Network Domains, choose System > MLPP > Namespace > Resource Priority Namespace Network Domain. See the Cisco Unified Communications Manager Features and Services Guide for more information.

External Call Control Profile

In Cisco Unified Communications Manager, you enable external call control by assigning an external call control profile to a route pattern. If the route pattern has an external call control profile assigned to it, when a call occurs that matches the route pattern, Cisco Unified Communications Manager immediately sends a call-routing query to an adjunct route server, and the adjunct route server directs Cisco Unified Communications Manager on how to handle the call. For more information on external call control, see topics related to external call control in the Cisco Unified Communications Manager Features and Services Guide.

From the drop-down list box, choose the external call profile that you want to assign to the route pattern.

Route Class

Choose a route class setting for this translation pattern from the drop-down list box:

  • Default
  • Voice
  • Data
  • Satellite Avoidance
  • Hotline voice
  • Hotline data

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 Cisco Unified Communications Manager 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.

Gateway/Route List

Choose the gateway or route list for which you are adding a route pattern.

Note   

If the gateway is included in a Route Group, this drop-down list box does not display the gateway. When a gateway is chosen in the drop-down list box, Cisco Unified Communications Manager uses all the ports in the gateway to route/block this route pattern. This action does not apply for MGCP gateways.

Route Option

The Route Option designation indicates whether you want this route pattern to be used for routing calls (such as 9.@ or 8[2-9]XX) or for blocking calls. Choose the Route this pattern or Block this pattern radio button.

If you choose the Block this pattern radio button, you must choose the reason for which you want this route pattern to block calls. Choose a value from the drop-down list box:

  • No Error
  • Unallocated Number
  • Call Rejected
  • Number Changed
  • Invalid Number Format
  • Precedence Level Exceeded

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. The default value specifies OffNet. When adding a route pattern, if you uncheck the Provide Outside Dial Tone check box, you set Call Classification as OnNet.

Allow Device Override

This check box remains unchecked by default. When the check box is checked, 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.

Provide Outside Dial Tone

Check this check box to provide outside dial tone. To route the call in the network, leave the check box unchecked.

Allow Overlap Sending

With overlap sending enabled, when Cisco Unified Communications Manager 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. Check 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 CMC and FAC features do not support overlap sending because the Cisco Unified Communications Manager cannot determine when to prompt the user for the code. If you check the Require Forced Authorization Code or the Require Client Matter Code check box, the system disables the Allow Overlap Sending check box.

Urgent Priority

If the dial plan contains overlapping route patterns, Cisco Unified Communications Manager does not route the call until the interdigit timer expires (even if dialing a sequence of digits to choose a current match is possible). Check this check box to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately.

Require Forced Authorization Code

If you want to use forced authorization codes with this route pattern, check this check box.

The FAC feature does not support overlap sending because the Cisco Unified Communications Manager cannot determine when to prompt the user for the code. If you check the Allow Overlap Sending check box, the system disables the Require Forced Authorization Code check box.

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.

Tip    To activate the authorization code, you must check the Require Forced Authorization Code. If you do not check the check box, a message displays when you insert the route pattern that indicates that the authorization code cannot be activated. To activate the code, click Cancel, check the Require Forced Authorization Code check box, and click Insert. To activate the code at a later time, click OK.

Require Client Matter Code

If you want to use client matter codes with this route pattern, check this check box.

The CMC feature does not support overlap sending because the Cisco Unified Communications Manager cannot determine when to prompt the user for the code. If you check the Allow Overlap Sending check box, the Require Client Matter Code check box become disabled.

Calling Party Transformations

Use Calling Party's External Phone Number Mask

Check the check box if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. You may also configure an External Phone Number Mask on all phone devices.

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.

Calling Party Transform Mask

Enter a transformation mask value. Valid entries for the National Numbering Plan include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If this field is blank and the preceding field is not checked, no calling party transformation takes place. See topics related to calling party number transformation settings in the Cisco Unified Communications Manager System Guide for more information.

Prefix Digits (Outgoing Calls)

Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries for the National Numbering Plan include the digits 0 through 9, 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.

Calling Line ID Presentation

Cisco Unified Communications Manager uses calling line ID presentation (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 Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number on the called party phone display for this route pattern.

Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want Cisco Unified Communications Manager to allow the display of the calling number. Choose Restricted if you want Cisco Unified Communications Manager to block the display of the calling number.

Calling Name Presentation

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager to allow or restrict the display of the calling party name on the called party phone display for this route pattern.

Choose Default if you do not want to change calling name presentation. Choose Allowed if you want Cisco Unified Communications Manager to display the calling name information. Choose Restricted if you want Cisco Unified Communications Manager to block the display of the calling name information.

Calling Party Number Type

Choose the format for the number type in calling party directory numbers.

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager 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 the following options:

  • Cisco Unified Communications Manager—The Cisco Unified Communications Manager sets the directory number type.
  • Unknown—Use when the dialing plan is unknown.
  • National—Use when you are dialing within the dialing plan for your country.
  • International—Use when you are dialing outside the dialing plan for your country.
  • Subscriber—Use when you are dialing a subscriber by using a shortened subscriber number.

Calling Party Numbering Plan

Choose the format for the numbering plan in calling party directory numbers.

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager 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 the following options:

  • Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager sets the Numbering Plan in the directory number.
  • ISDN—Use when you are dialing outside the dialing plan for your country.
  • National Standard—Use when you are dialing within the dialing plan for your country.
  • Private—Use when you are dialing within a private network.
  • Unknown—Use when the dialing plan is unknown.

Connected Party Transformations

Connected Line ID Presentation

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager to allow or restrict the display of the connected party phone number on the calling party phone display for this route pattern.

Choose Default if you do not want to change the connected line ID presentation. Choose Allowed if you want to display the connected party phone number. Choose Restricted if you want Cisco Unified Communications Manager to block the display of the connected party phone number.

If a call that originates from an IP phone on Cisco Unified Communications Manager 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.

Connected Name Presentation

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager to allow or restrict the display of the connected party name on the calling party phone display for this route pattern.

Choose Default if you do not want to change the connected name presentation. Choose Allowed if you want to display the connected party name. Choose Restricted if you want Cisco Unified Communications Manager to block the display of the connected party name.

For more information about this field, see topics related to connected party presentation and restriction settings in the Cisco Unified Communications Manager System Guide.

Called Party Transformations

Discard Digits

From the Discard Digits drop-down list box, choose the discard digits instructions that you want to associate with this route pattern. The discard digits that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box. See topics related to discard digits instructions in the Cisco Unified Communications Manager System Guide for more information on discard instructions for the North American Numbering Plan.

Note   

The called party transformation settings that are assigned to the route groups in a route list override any called party transformation settings that are assigned to a route pattern that is associated with that route list.

Called Party Transform Mask

Enter a transformation mask value. Valid entries for the National Numbering Plan include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If the field is blank, no transformation takes place. Cisco Unified Communications Manager sends the dialed digits exactly as dialed.

Prefix Digits (Outgoing Calls)

Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries for the National Numbering Plan include the digits 0 through 9; 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.

Called Party Number Type

Choose the format for the number type in called party directory numbers.

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager 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 the following options:

  • Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager sets the directory number type.
  • Unknown—Use when the dialing plan is unknown.
  • National—Use when you are dialing within the dialing plan for your country.
  • International—Use when you are dialing outside the dialing plan for your country.
  • Subscriber—Use when you are dialing a subscriber by using a shortened subscriber number.

Called Party Numbering Plan

Choose the format for the numbering plan in called party directory numbers.

Cisco Unified Communications Manager 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 Cisco Unified Communications Manager 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 the following options:

  • Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager sets the Numbering Plan in the directory number.
  • ISDN—Use when you are dialing outside the dialing plan for your country.
  • National Standard—Use when you are dialing within the dialing plan for your country.
  • Private—Use when you are dialing within a private network.
  • Unknown—Use when the dialing plan is unknown.

ISDN Network-Specific Facilities Information Element

Network Service Protocol

From the Network Service Protocol drop-down list box, choose the PRI protocol that matches the protocol of the terminating gateway.

Carrier Identification Code

Enter the appropriate carrier identification code (0, 3, or 4 digits) in the Carrier Identification Code field. Carrier identification codes allow customers to reach the services of interexchange carriers.

The following list shows examples of commonly used carrier identification codes:

  • ATT—0288
  • Sprint—0333
  • WorldCom/MCI—0222

For a complete list of NANP carrier identification codes, visit the NANPA website.

Network Service

Choose the appropriate network service. The values vary depending on the network service protocol that you choose from the Network Service Protocol field.

Service Parameter Name

This field displays the service parameter name that is associated with the chosen network service. If no service parameter exists for the network service, the field displays <Not Exist>.

Service Parameter Value

Enter the appropriate service parameter value. Valid entries include the digits 0 through 9. If a service parameter does not exist for the network service, Cisco Unified Communications Manager Administration disables this field.

Related References
Related Information