[Index]

Model: relation/HcsCdPtyXformREL

Called Party Transformation Patterns

Full HTML Help

Overview

The parameters in the Called Party Transformation Patterns window provide appropriate caller information by using the Called Party Transformation calling search space on the destination device. Be aware that calls through transformation patterns are not routable. When this pattern is matched, the call does not route to any device.

Configure Called Party Transformation Patterns

  1. Log in as the Provider, Reseller, or Customer Administrator.

  2. Perform one of the following:

  3. Make sure that the hierarchy path is set to the correct level.

  4. Perform one of the following:

  5. In the popup, select from the drop-down the network device list (NDL) to which you are adding the called party transformation pattern, and click OK.

    Note

    The NDL popup will only appear when you are adding a new called party transformation pattern. If you are updating an existing pattern, go to Step 6.

    If you are adding the called party transformation pattern to a Site hierarchy node, the NDL popup will not appear. You will go right to the Called Party Transformation Pattern add tabs using the NDL associated to the site.

  6. From the Pattern Definition tab, modify the following fields as required.

    Option Description
    Pattern (Mandatory)

    Enter the transformation 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 letters A, B, C, and D and +, which represents the international escape character +.

    Note

    Ensure that the pattern is unique. Check the transformation pattern, 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.

    Default value: None

    Partition

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

    Note

    Transformation patterns should be configured in different non- NULL partitions than dialing patterns such as route patterns and directory numbers. For transformation pattern lookups, the patterns in NULL partitions get ignored.

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

    Description Enter a description of the transformation 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 transformation 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.

    MLPP Preemption Disabled Check this box to make the numbers in a transformation pattern non-preemptable.
  7. From the Called Party Transformations tab, modify the following fields as required.

    Option Description
    Digit Discards Choose the discard digit instructions that you want to be associated with this called party transformation pattern.
    Called Party Transformation Mask Enter a transformation mask value. Valid entries 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 transformation takes place.
    Prefix Digits

    Enter prefix digits in the field. Valid entries 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 CallManager - 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.
    Option Description
    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 CallManager - 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.
  8. Click Save. The called party transformation pattern appears in the list.

To modify any of these characteristics, click the item in the list, make your changes, and click Save.

To delete a called party transformation pattern, check the box to the left of the Name column in the group list, and click Delete.

This relation wraps the device/cucm/CalledPartyTransformationPattern element.

Model Details: relation/HcsCdPtyXformREL

Title Description Details
Mlpp Preemption Disabled
  • Field Name: mlppPreemptionDisabled
  • Type: Boolean
  • Cardinality: [0..1]
Called Party Number Type Choose the format for the number type in called party directory numbers. Cisco Unified Communications Manager sets the called party 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"]
Description Enter a description of the transformation 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]
Called Party Transformation Mask Enter a transformation mask value. Valid entries 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 transformation takes place.
  • Field Name: calledPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pattern * Enter the transformation 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 letters A, B, C, and D and \+, which represents the international escape character +. Note    Ensure that the pattern is unique. Check the transformation pattern, 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]
Numbering Plan Choose a numbering plan.
  • Field Name: dialPlanName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24vyo6bDg9Wdt8VMrt%24Qj33157TQGCmI2Oixdr9H2sA0gSR0NkjrHeFyOqoCr8MDsEv/opxdFawXDoVOQLedG59NEgH/ePzjM9IXFgf11IV//TAjclPtXiJSNMTcbRxCwjaS9J0PBsD28eRpxdR%2BygKVsVQ4qZZuWBGjR8n2oKHdlMaG9SWamyhFaiEUHgDnw/WRC331J8YdzXPCWDCDOJAmb4nHH7CViFflUZRPI36laLG1PXJTGckx6jZ5yuwhB9NYFhDX/PlvAZWSRuA%2B1nv4rTaKqIN9UoTtc5s1dXszc2ag2e/QlwDC1k1ZcqRcrDcCB8chg5mbXYbOVkXeZzcd80p6gyFG9Ql6NQr1E4eWvQ59fnLKSPaWwdwupR7A/lwDHnwJvDKOylR%2BFLEF1xA%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/DialPlan
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Route Filter If your transformation 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: [0..1]
Digit Discard Instruction Name
  • Field Name: digitDiscardInstructionName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Prefix Digits Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries 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 get routed to the assigned device.
  • Field Name: calledPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Partition * If you want to use a partition to restrict access to the transformation pattern, choose the desired partition from the drop-down list box. If you do not want to restrict access to the transformation 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    Transformation patterns should be configured in different non- NULL partitions than dialing patterns such as route patterns and directory numbers. For transformation pattern lookups, the patterns in NULL partitions get ignored. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters. Note    Make sure that the combination of pattern, route filter, and partition is unique within the Cisco Unified Communications Manager cluster.
  • Field Name: routePartitionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24lB2HEJGETzJRvqY0%24iRKLi7aez/h0XpqVclQLDwVaqz0Btrj/cc/fkEEdJeIKxcyZ6mftiKw3LO51J5SMPJpJVSYwPOWKr8p/l2yUy0EbnVVEtVcTgFzf0ASA1W1dzDqA/RPL8FkDeavlogc8Xp8ONymBQqYNIPY3sQErTkF/%2BCn2GROeXvGpwj4wDwXqT56frvolk1eSRCj34OXqCxqme4eZyxmKQP7ANeFqeO9LWbB72dd93zWR5L%2B30jFtxMWz5%2BTbjJUGqenFqzKA8IH0UVshQQrVoPPBjJR1SwEDD7m0jc68rN3nC2yMPR4UFkgoBQC4l7lNtejpJfBCLH0M7AhnCvqX0iyXZmqO2j/iXo/ahLom7LDKGkduu8ugwRDHM1kw8TS9oYpZyiNO0OxBuzkMDp5m%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
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"]
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024