Sometimes it may be necessary to update the default dial plan route patterns that are deployed as part of the default dial plan schemas that are delivered with the VOSS-4-UC template package.

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-4-UC, you must have a full understanding of the Cisco HCS dial plan. Refer to the VOSS-4-UC Dial Plan Management Guide.

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.

This relation wraps the default CUCM Route Pattern element to allow for targeted network device addition.

Model Details: relation/HcsRoutePatternREL

Option	Description
MLPP Precedence *	From the drop-down menu, choose a Multilevel Precedence and Preemption (MLPP) service setting for this route pattern: 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 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: 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 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: No Error Unallocated Number Call Rejected Number Changed Invalid Number Format Precedence Level Exceeded 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>.

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: Default - Choose if you do not want to change calling line ID presentation. Allowed - Choose if you want Unified CM to allow the display of the calling number. Restricted - Choose if you want Unified CM to block the display of the calling number. 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: Default - Choose if you do not want to change calling name presentation. Allowed - Choose if you want Unified CM to allow the display of the calling name information. Restricted - Choose if you want Unified CM to block the display of the calling name information. 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: Unified CM - the Unified CM sets the directory number type. Unknown - 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 the shortened subscriber name. 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: Unified CM - Use when the Unified CM 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. Default: Unified CM Corresponding Unified CM Attribute: Calling Party Numbering Plan.

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: Default - Choose if you do not want to change the connected line ID presentation. Allowed - Choose if you want to display the connected party phone number. Restricted - Choose if you want Unified CM to block the display of the connected party phone number. 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: Default - Choose if you do not want to change the connected name presentation. Allowed - Choose if you want to display the connected party name. Restricted - Choose if you want Unified CM 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. Default: Default Corresponding Unified CM Attribute: Connected Name Presentation.

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: Unified CM - Use when the Unified CM 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. 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: Unified CM - Use when the Unified CM 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. Default: Unified CM Corresponding Unified CM Attribute: Called Party Numbering Plan.

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title		Description	Details
Destination			Field Name: destination Type: Object Cardinality: [1..1]
	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.	Field Name: destination.routeListName Type: String Target: device/cucm/RouteList Target attr: name Cardinality: [0..1] Format: uri
	Gateway Name		Field Name: destination.gatewayName Type: String Target: device/cucm/Gateway Target attr: domainName Cardinality: [0..1] Format: uri
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.	Field Name: clientCodeRequired Type: Boolean Cardinality: [0..1]
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.	Field Name: callingPartyPrefixDigits Type: ["String", "Null"] Cardinality: [0..1] MaxLength: 50 Pattern: ^[0-9*#+]{0,50}$
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.	Field Name: prefixDigitsOut Type: ["String", "Null"] Cardinality: [1..1] MaxLength: 50 Pattern: ^[0-9*#+]{0,50}$
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. Default: Cisco CallManager	Field Name: callingPartyNumberingPlan Type: String Cardinality: [0..1] Default: Cisco CallManager Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
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. Default: Default	Field Name: connectedLinePresentationBit Type: String Cardinality: [0..1] Default: Default Choices: ["Default", "Allowed", "Restricted"]
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.	Field Name: routePartitionName Type: ["String", "Null"] Target: device/cucm/RoutePartition Target attr: name Cardinality: [1..1] Format: uri
Block this pattern		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 Default: No Error	Field Name: releaseClause Type: String Cardinality: [0..1] Default: No Error Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Block Enable			Field Name: blockEnable Type: Boolean Cardinality: [1..1]
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. Default: Cisco CallManager	Field Name: callingPartyNumberType Type: String Cardinality: [0..1] Default: Cisco CallManager Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
External Call Control		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. From the drop-down list box, choose the external call profile that you want to assign to the route pattern.	Field Name: externalCallControl Type: ["String", "Null"] Target: device/cucm/ExternalCallControlProfile Target attr: name Cardinality: [0..1] Format: uri
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. Default: True	Field Name: provideOutsideDialtone Type: Boolean Cardinality: [0..1] Default: True
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.	Field Name: calledPartyTransformationMask Type: ["String", "Null"] Cardinality: [0..1] MaxLength: 50 Pattern: ^[0-9*#+X]{0,50}$
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.	Field Name: pattern Type: String Cardinality: [1..1]
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 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. Default: Default	Field Name: patternPrecedence Type: String Cardinality: [0..1] Default: Default Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Blocked Call Percentage		This tag is only valid when value of enabledccenforcement is true	Field Name: blockedCallPercentage Type: ["String", "Null"] Cardinality: [0..1]
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. Default: Default	Field Name: callingLinePresentationBit Type: String Cardinality: [0..1] Default: Default Choices: ["Default", "Allowed", "Restricted"]
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. Default: Cisco CallManager	Field Name: calledPartyNumberingPlan Type: String Cardinality: [0..1] Default: Cisco CallManager Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
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. Default: Default	Field Name: connectedNamePresentationBit Type: String Cardinality: [0..1] Default: Default Choices: ["Default", "Allowed", "Restricted"]
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 (<>).	Field Name: description Type: String Cardinality: [0..1] MaxLength: 50
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. Default: Default	Field Name: routeClass Type: String Cardinality: [0..1] Default: Default Choices: ["Default", "Voice", "Data", "Satellite Avoidance", "Hotline Voice", "Hotline Data"]
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. Default: Default	Field Name: callingNamePresentationBit Type: String Cardinality: [0..1] Default: Default Choices: ["Default", "Allowed", "Restricted"]
Numbering Plan *		Choose a numbering plan.	Field Name: dialPlanName Type: ["String", "Null"] Target: device/cucm/DialPlan Target attr: name Cardinality: [1..1] Format: uri
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.	Field Name: authorizationLevelRequired Type: Integer Cardinality: [0..1]
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. 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.	Field Name: digitDiscardInstructionName Type: ["String", "Null"] Cardinality: [1..1]
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.	Field Name: resourcePriorityNamespaceName Type: ["String", "Null"] Target: device/cucm/ResourcePriorityNamespace Target attr: namespace Cardinality: [0..1] Format: uri
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.	Field Name: enableDccEnforcement Type: Boolean Cardinality: [0..1]
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. Default: Default	Field Name: useCallingPartyPhoneMask Type: String Cardinality: [1..1] Default: Default Choices: ["Off", "On", "Default"]
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.	Field Name: callingPartyTransformationMask Type: ["String", "Null"] Cardinality: [0..1] MaxLength: 50 Pattern: ^[0-9*#+X]{0,50}$
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. Default: Cisco CallManager	Field Name: calledPartyNumberType Type: String Cardinality: [0..1] Default: Cisco CallManager Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
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.	Field Name: authorizationCodeRequired Type: Boolean Cardinality: [0..1]
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.	Field Name: routeFilterName Type: ["String", "Null"] Cardinality: [1..1]
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.	Field Name: patternUrgency Type: Boolean Cardinality: [0..1]
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.	Field Name: allowDeviceOverride Type: Boolean Cardinality: [0..1]
Is Emergency Service Number		Enable this route pattern to be used for Emergency Call handling. Emergency Call Handler helps you to manage emergency calls in your telephony network while following local ordinances and regulations. Note This setting applies only to the Emergency Call Handler feature, and not to other external emergency calling solutions such as Cisco Emergency Responder.	Field Name: isEmergencyServiceNumber Type: Boolean Cardinality: [0..1]
Call Classification *		Default: OnNet	Field Name: networkLocation Type: String Cardinality: [1..1] Default: OnNet Choices: ["OnNet", "OffNet", "Use System Default"]
Isdn Nsf Info Element			Field Name: isdnNsfInfoElement Type: ["Object", "Null"] Cardinality: [0..1]
	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.	Field Name: isdnNsfInfoElement.cic Type: String Cardinality: [0..1]
	Network Service Protocol *	From the Network Service Protocol drop-down list box, choose the PRI protocol that matches the protocol of the terminating gateway.	Field Name: isdnNsfInfoElement.networkServiceProtocol Type: String Cardinality: [1..1] Choices: ["PRI 4ESS", "PRI 5E8", "PRI 5E8 TELEOS", "PRI 5E8 INTECOME", "PRI 5E9", "PRI DMS-100", "PRI DMS-250", "PRI EURO", "PRI NI2", "PRI AUSTRALIAN", "PRI 5E8 CUSTOM", "PRI ETSI SC", "PRI NTT", "PRI ISO QSIG T1", "PRI ISO QSIG E1"]
	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.	Field Name: isdnNsfInfoElement.paramValue Type: String Cardinality: [0..1]
	Network Service	From the Network Service Protocol drop-down list box, choose the PRI protocol that matches the protocol of the terminating gateway.	Field Name: isdnNsfInfoElement.networkService Type: String Cardinality: [0..1] Choices: ["ACCUNET Switched Digital Service", "Billing Number Only", "Billing Number Preferred", "Calling Party Number Only", "Calling Party Number Preferred", "Foreign Exchange", "Foreign Exchange Selection", "International Long Distance Service", "InterLATAOUTWATS", "IntraLATAOUTWATS", "Long Distance Service", "MEGACOM Telecom Service", "National ISDN Banded OUTWATS", "National ISDN Unbanded OUTWATS", "OUTWATS Selection", "Private", "Private Selection", "Software Defined Network", "Tie Trunk (Cut-through)", "Tie Trunk (Senderized)", "Tie Trunk Selection (Cut-through)", "Tie Trunk Selection (Senderized)", "WATS Band Selection", "WATS Maximal Subscribed Band"]
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.	Field Name: supportOverlapSending Type: Boolean Cardinality: [0..1]
Network Device			Field Name: networkDevice Type: Object
	Network Device	Select the network device for which you would like to add this element.	Field Name: networkDevice.nd Type: String Choices: [" "]

Model: relation/HcsRoutePatternREL

Route Patterns

Model Details: relation/HcsRoutePatternREL