[Index]

Model: relation/HcsCgPtyXformREL

Calling Party Transformation Patterns

Full HTML Help

Overview

The parameters in the Calling Party Transformation Patterns window provide appropriate caller information using the Calling 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.

You use calling party transformation patterns with the calling party normalization feature.

Configure Calling 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 calling party transformation pattern, and click OK.

    Note

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

    If you are adding the calling party transformation pattern to a Site hierarchy node, the NDL popup will not appear. You will go right to the Calling 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 characters 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.

    Note

    Configure transformation patterns in different non-null partitions rather than dialing patterns such as route patterns and directory numbers. For transformation pattern lookups, Cisco Unified Communications Manager ignores the patterns in null partitions.

    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.
    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 Calling Party Transformations tab, modify the following fields as required.

    Option Description
    Use Calling Party's External Phone Number Mask Choose On from the drop-down list if you want the full external phone number to be used for calling line identification (CLID) on outgoing calls. Choose Off or Default if you do not want to use the full external phone number for CLID on outgoing calls. You may also configure an External Phone Number Mask on all phone devices.
    Digit Discards Choose the discard digit instructions that you want to be associated with this calling party transformation pattern.
    Calling Party Transformation Mask

    Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); and the international escape character +.

    If the Digit Discards field is blank, the Prefix Digits field is blank, the Calling Party Transformation Mask field is blank, and Use Calling Party's External Phone Number Mask is set to Off or Default, no calling party 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 (#), and the international escape character +.

    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.

    Option Description
    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 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.
    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 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 calling party transformation pattern appears in the list.

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

To delete a calling 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/CallingPartyTransformationPattern element.

Model Details: relation/HcsCgPtyXformREL

Title Description Details
Mlpp Preemption Disabled Check this check box to make the numbers in a transformation pattern nonpreemptable. Note    For MLPP Preemption Disabled check box to work, create the transformation patterns and put them into partitions, import all such partitions into a CSS (for example, NonPreemptionCSS), and select the CSS in "Non-Preemption Pattern CSS" service parameter (System > Service Parameters).
  • Field Name: mlppPreemptionDisabled
  • Type: Boolean
  • Cardinality: [0..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 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: callingPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Description Enter a description of the transformation pattern.
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
Calling Party 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 (#), and the international escape character +. 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}$
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 characters 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]
Dial Plan Name Choose a numbering plan.
  • Field Name: dialPlanName
  • Type: ["String", "Null"]
  • Target: device/cucm/DialPlan
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Route Filter Name 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"]
  • Target: device/cucm/RouteFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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"]
Calling Line Presentation Bit 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"]
Digit Discard Instruction Name
  • Field Name: digitDiscardInstructionName
  • Type: ["String", "Null"]
  • Target: device/cucm/DiscardDigitInstruction
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Use Calling Party Phone 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. Default: Default
  • Field Name: useCallingPartyPhoneMask
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Route Partition Name * If you want to use a partition to restrict access to the transformation pattern, choose the desired partition from the drop-down list box. 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    Configure transformation patterns in different non-null partitions rather than dialing patterns such as route patterns and directory numbers. For transformation pattern lookups, Cisco Unified Communications Manager ignores the patterns in null partitions. 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: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Party Transformation Mask Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); and the international escape character +. If the Discard Digit Instructions field is blank, the Prefix Digits (Outgoing Calls) field is blank, the Calling Party Transformation Mask field is blank, and the Use Calling Party's External Phone Number Mask 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}$
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024