[Index]

Model: relation/HcsTransPatternREL

How to Configure Unified CM Translation Patterns

  1. Log in as provider, reseller, or customer administrator.

  2. Set the hierarchy path to the node where you want to add or edit the translation pattern.

  3. Perform one of:

  4. Perform one of:

  5. From the CUCM drop-down menu, choose the hostname, domain name, or IP address of the Cisco Unified Communications Manager to which you want to add the translation pattern.

    Note:

    The CUCM drop-down menu only appears when a translation pattern is added; it does not appear when you edit a translation pattern.

    Important:

    If you are adding or editing a translation 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 translation pattern, and all Unified CMs in hierarchies above the node where you are adding the translation pattern. If you are adding or editing a translation 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, then the drop-down list is empty and a translation pattern cannot be added to the site.

  6. In the Translation Pattern field, enter a unique name for the translation pattern, or modify the existing name of the translation pattern if desired. You can include numbers and wildcards (do not use spaces), in the Translation Pattern field. 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 +. This field is mandatory.

  7. In the Partition field, enter a unique name for the route partition, or modify the existing name of the partition if desired. This field is mandatory.

  8. In the Description field, enter a description for the translation pattern and route partition if desired. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).

  9. Complete at minimum, the mandatory fields on each tab as appropriate (see below):

    Tip

    Use the Corresponding Cisco Unified Communications Manager (Unified CM) attribute information provided in the tables to manually verify in the Unified CM GUI that fields have been mapped correctly.

  10. Click Save when complete to save the new or updated translation pattern.

Translation Patterns: Pattern Definition Fields

Option Description
MLPP Precedence *

From the drop-down menu, choose a Multilevel Precedence and Preemption (MLPP) service setting for this translation 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.
Route Class *

From the drop-down menu, choose a route class setting for this translation 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 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

Corresponding Unified CM Attribute: Route Class.
Calling Search Space

From the drop-down menu, choose the calling search space for which you are adding a translation pattern, if necessary.

Default: None

Corresponding Unified CM Attribute: Calling Search Space.
Option Description
Use Originator's Calling Search Space

To use the originator's calling search space for routing a call, select the Use Originator's Calling Search Space check box.

If the originating device is a phone, the originator's calling search space is a result of device calling search space and line calling search space.

Whenever a translation pattern chain is encountered, for subsequent lookups Calling Search Space is selected depending upon the value of this check box at current translation pattern. If you select the Use Originator's Calling Search Space check box at current translation pattern, then originator's Calling Search Space is used and not the Calling Search Space for the previous lookup. If you clear the Use Originator's Calling Search Space check box at current translation pattern, then Calling Search Space configured at current translation pattern is used.

Default: Clear

Corresponding Unified CM Attribute: Use Originator's Calling Search Space.
Block this pattern

Indicates whether you want this translation pattern to be used for routing calls (such 8[2-9]XX) or for blocking calls.

Default: Clear (meaning translation 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 translation 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>.
Provide Outside Dial Tone

Outside dial tone indicates that Unified CM routes the calls off the local network. Select this check box for each translation pattern that you consider to be off network.

Default: Selected

Corresponding Unified CM Attribute: Provide Outside Dial Tone.
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
Do Not Wait for Interdigit Timeout on Subsequent Hopes

When you select this check box along with the Urgent Priority check box and the translation pattern matches with a sequence of dialed digits (or whenever the translation pattern is the only matching pattern), Unified CM does not start the interdigit timer after it matches any of the subsequent patterns.

Note:

Unified CM does not start the interdigit timer even if subsequent patterns are of variable length or if overlapping patterns exist for subsequent matches.

Whenever you select the Do Not Wait For Interdigit Timeout On Subsequent Hops check box that is associated with a translation pattern in a translation pattern chain, Unified CM does not start the interdigit timer after it matches any of the subsequent patterns.

Note:

Unified CM does not start interdigit timer even if subsequent translation patterns in a chain have Do Not Wait For Interdigit Timeout On Subsequent Hops check box cleared.

Default: Clear

Corresponding Unified CM Attribute: Do Not Wait for Interdigit Timeout On Subsequent Hops.
Route Next Hop By Calling Party Number

Select this check box to enable routing based on the calling party number, which is required for call screening based on caller ID information to work between clusters.

Default: Clear

Corresponding Unified CM Attribute: Route Next Hop By Calling Party Number.

Translation Patterns: Calling Party Transformations Fields

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.

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 cleared, 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 translation 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.

Note:

Use this parameter and the Connected Line ID Presentation parameter, in combination with the Ignore Presentation Indicators (internal calls only) device-level parameter, to configure call display restrictions. Together, these settings allow you to selectively present or restrict calling and/or connected line display information for each call. See topics related to device profile configuration settings and phone settings for information about the Ignore Presentation Indicators (internal calls only) field, and for more information about call display restrictions, see topics related to call display restrictions in the Cisco Unified Communications Manager System Guide.

Default: Default

Corresponding Unified CM Attribute: Calling Line ID Presentation.
Option Description
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 translation 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.

Translation Patterns: Connected Party Transformations Fields

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

Translation Patterns: Called Party Transformations Fields

Option Description
Discard Digits

Choose the discard digits instructions that you want to be associated with this translation 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).
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 CMUnified 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.
Option Description
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.

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

Model Details

Title Description Details
Calling Party Prefix Digits
  • Field Name: callingPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+]{0,50}$
Prefix Digits Out
  • Field Name: prefixDigitsOut
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+]{0,50}$
Calling Party Numbering Plan Default: Cisco CallManager
  • Field Name: callingPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Connected Line Presentation Bit Default: Default
  • Field Name: connectedLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Route Partition Name *
  • Field Name: routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Search Space Name
  • Field Name: callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Block Enable
  • Field Name: blockEnable
  • Type: Boolean
  • Cardinality: [0..1]
Calling Party Number Type Default: Cisco CallManager
  • Field Name: callingPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Provide Outside Dialtone Default: True
  • Field Name: provideOutsideDialtone
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Called Party Transformation Mask
  • Field Name: calledPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Pattern *
  • Field Name: pattern
  • Type: ["Null", "String"]
  • Cardinality: [1..1]
Pattern Precedence Default: Default
  • Field Name: patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Release Clause 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"]
Calling Line Presentation Bit Default: Default
  • Field Name: callingLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Usage * For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
  • Field Name: usage
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["CallPark", "Conference", "Device", "Translation", "Call Pick Up Group", "Route", "Message Waiting", "Hunt Pilot", "Voice Mail Port", "Domain Routing", "IPAddress Routing", "Device template", "Directed Call Park", "Device Intercom", "Translation Intercom", "Translation Calling Party Number", "Mobility Handoff", "Mobility Enterprise Feature Access", "Mobility IVR", "Device Intercom Template", "Called Party Number Transformation", "Call Control Discovery Learned Pattern", "Uri Routing", "ILS Learned Enterprise Number", "ILS Learned E164 Number", "ILS Learned Enterprise Numeric Pattern", "ILS Learned E164 Numeric Pattern", "Alternate Number", "ILS Learned URI", "ILS Learned PSTN Failover Rule", "ILS Imported E164 Number", "Centralized Conference Number", "Emergency Location ID Number"]
Called Party Numbering Plan Default: Cisco CallManager
  • Field Name: calledPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Dont Wait For IDT On Subsequent Hops
  • Field Name: dontWaitForIDTOnSubsequentHops
  • Type: Boolean
  • Cardinality: [0..1]
Connected Name Presentation Bit Default: Default
  • Field Name: connectedNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Description
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
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 Bit Default: Default
  • Field Name: callingNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Dial Plan Name
  • Field Name: dialPlanName
  • Type: ["String", "Null"]
  • Target: device/cucm/DialPlan
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Route Next Hop By Cgpn
  • Field Name: routeNextHopByCgpn
  • Type: Boolean
  • Cardinality: [0..1]
Use Originator Css
  • Field Name: useOriginatorCss
  • Type: Boolean
  • Cardinality: [0..1]
Digit Discard Instruction Name
  • Field Name: digitDiscardInstructionName
  • Type: String
  • Target: device/cucm/DiscardDigitInstruction
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Resource Priority Namespace Name
  • Field Name: resourcePriorityNamespaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/ResourcePriorityNamespace
  • Target attr: namespace
  • Cardinality: [0..1]
  • Format: uri
Use Calling Party Phone Mask Default: Default
  • Field Name: useCallingPartyPhoneMask
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Party Transformation Mask
  • Field Name: callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Call Intercept Profile Name
  • Field Name: callInterceptProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/ExternalCallControlProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party Number Type Default: Cisco CallManager
  • Field Name: calledPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Route Filter Name
  • Field Name: routeFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/RouteFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Pattern Urgency
  • Field Name: patternUrgency
  • Type: Boolean
  • Cardinality: [0..1]
Is Emergency Service Number
  • Field Name: isEmergencyServiceNumber
  • 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: [" "]
API reference for relation/HcsTransPatternREL