.. _configure-translation-patterns: Cisco UCM translation patterns -------------------------------- .. tip:: :ref:`use-action-search-to-navigate-automate` Overview .......... The Cisco Unified Communications Manager (UCM) default dial plan translation patterns are deployed as part of the default dial plan translation patterns that ship with the Automate template package. This section describes how to update these default dial plan translation patterns. For example, you may want to make your default national number translation patterns more restrictive. Or you may want to deploy additional, customer-specific translation patterns (with custom blocking plans that aren't defined in the standard country dial plan schema, for instance). .. caution:: Provider deployments. The Cisco HCS default dial plan includes most common translation patterns and route patterns, which are typically added automatically when provisioning a customer dial plan, site dial plan, and voice mail service. Ensure you have a full understanding of the Cisco HCS dial plan before using Automate to update translation patterns and route patterns. For details, see the "Provider HCS Dial Plan Management Support Guide". Configure Cisco UCM translation patterns ......................................... This procedure updates the UCM translation patterns that are provisioned by the dial plan schema and adds new translation patterns from Automate that are not part of the standard dial plan package. .. note:: For more information on UCM translation patterns, see the "Cisco Unified Communications Manager Administration Guide, Release 10.0(1)". 1. Log in as Provider, Reseller, or Customer administrator. 2. Choose the hierarchy where you want to add or edit the translation pattern. 3. Go to **Translation Patterns**. 4. Choose an option: * Add a new translation pattern? Click the Plus icon (+) to add a new record, then go to Step 5. * Edit an existing translation pattern? Click on the pattern to be updated and go to Step 6. 5. On the **Pattern Definition tab**, from the **CUCM** drop-down, choose the hostname, domain name, or IP address of the Cisco UCM to which you want to add the translation pattern. .. note:: This drop-down displays only when you're adding a translation pattern. When adding a translation pattern at a hierarchy above the site level, the drop-down displays UCMs located at the hierarchy node where you're adding the translation pattern, and all UCMs in hierarchies above this hierarchy node. When adding a translation pattern at a site, the UCM in the **CUCM** drop-down list is the UCM 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 UCM, then the drop-down list is empty and a translation pattern can't be added to the site. 6. On the **Pattern Definition tab**: * Mandatory. In the **Translation Pattern** field, fill out a unique name for the translation pattern, (or update the name if you're editing the translation pattern). .. note:: The name must be unique, and can include numbers and wildcards. Spaces aren't allowed. 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 +. * Mandatory. In the **Partition** field, fill out a unique name for the route partition (or update the name if you're editing the translation pattern). * In the **Description** field, fill out an optional description for the translation pattern and route partition. .. note:: The description can include up to 50 characters in any language, but it can't include double-quotes (\"), percentage sign (%), ampersand (&), or angle brackets (<>). 7. Fill out at least the mandatory fields on each tab/panel of the **Translations Patterns** page. .. tip:: Use the Corresponding UCM attribute information provided in the tables to manually verify in the UCM GUI that fields have been mapped correctly. * :ref:`translation-patterns-pattern-definition-fields` * :ref:`translation-patterns-calling-party-transformations-fields` * :ref:`translation-patterns-connected-party-transformations-fields` * :ref:`translation-patterns-called-party-transformations-fields` 8. Save your changes. Translation patterns settings ............................... This page adds and edits UCM translation patterns. .. tip:: :ref:`use-action-search-to-navigate-automate` You can select the following tabs on this page: * :ref:`translation-patterns-pattern-definition-fields` * :ref:`translation-patterns-calling-party-transformations-fields` * :ref:`translation-patterns-connected-party-transformations-fields` * :ref:`translation-patterns-called-party-transformations-fields` .. _translation-patterns-pattern-definition-fields: Pattern Definition Tab '''''''''''''''''''''''''' .. tabularcolumns:: |p{2.5cm}|p{13cm}| +-----------------------+------------------------------------------------+ | Option | Description | +=======================+================================================+ | | 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 | | MLPP 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 UCM attribute: MLPP | | | Precedence. | +-----------------------+------------------------------------------------+ | | 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 | | Route | routing or termination requirements. The | | Class \* | 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 UCM 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 UCM attribute: Route | | | Class. | +-----------------------+------------------------------------------------+ | | From the drop-down menu, choose the calling | | | search space for which you are adding a | | Calling Search Space | translation pattern, if necessary. | | | | | | Default: None | | | | | | Corresponding UCM attribute: Calling | | | Search Space. | +-----------------------+------------------------------------------------+ .. tabularcolumns:: |p{2.5cm}|p{13cm}| +-----------------------+------------------------------------------------+ | Option | Description | +=======================+================================================+ | | 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 | | Use Originator's | Search Space is selected depending upon the | | Calling Search Space | 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 UCM attribute: Use | | | Originator's Calling Search Space. | +-----------------------+------------------------------------------------+ | | Indicates whether you want this translation | | | pattern to be used for routing calls (such | | | 8[2-9]XX) or for blocking calls. | | Block this pattern | | | | Default: Clear (meaning translation pattern | | | is used for routing calls). | | | | | | Corresponding UCM attribute: Block this | | | pattern. | +-----------------------+------------------------------------------------+ | | 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 | | Block Reason | * Call Rejected | | | * Number Changed | | | * Invalid Number Format | | | * Precedence Level Exceeded | | | | | | Default: No Error | | | | | | Corresponding UCM attribute: . | +-----------------------+------------------------------------------------+ | | Outside dial tone indicates that UCM | | | routes the calls off the local network. Select | | Provide Outside Dial | this check box for each translation pattern | | Tone | that you consider to be off network. | | | | | | Default: Selected | | | | | | Corresponding UCM attribute: Provide | | | Outside Dial Tone. | +-----------------------+------------------------------------------------+ | | If the dial plan contains overlapping | | | patterns, UCM does not route the call | | | until the interdigit timer expires (even if it | | | is possible to dial a sequence of digits to | | Urgent Priority | choose a current match). Select this check box | | | to interrupt interdigit timing when UCM | | | must route a call immediately. | | | | | | Default: Clear | | | | | | Corresponding UCM attribute: Urgent | | | Priority. | +-----------------------+------------------------------------------------+ .. tabularcolumns:: |p{2.5cm}|p{13cm}| +-----------------------+------------------------------------------------+ | Option | Description | +=======================+================================================+ | | 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), UCM does | | | not start the interdigit timer after it | | | matches any of the subsequent patterns. | | | | | | Note: | | | | | | UCM does not start the interdigit timer | | | even if subsequent patterns are of variable | | | length or if overlapping patterns exist for | | | subsequent matches. | | Do Not Wait for | | | Interdigit Timeout on | Whenever you select the Do Not Wait For | | Subsequent Hopes | Interdigit Timeout On Subsequent Hops check | | | box that is associated with a translation | | | pattern in a translation pattern chain, | | | UCM does not start the interdigit timer | | | after it matches any of the subsequent | | | patterns. | | | | | | Note: | | | | | | UCM 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 UCM attribute: Do Not | | | Wait for Interdigit Timeout On Subsequent Hops.| +-----------------------+------------------------------------------------+ | | Select this check box to enable routing based | | | on the calling party number, which is required | | Route Next Hop By | for call screening based on caller ID | | Calling Party Number | information to work between clusters. | | | | | | Default: Clear | | | | | | Corresponding UCM attribute: Route Next | | | Hop By Calling Party Number. | +-----------------------+------------------------------------------------+ .. _translation-patterns-calling-party-transformations-fields: Calling Party Transformations Tab '''''''''''''''''''''''''''''''''''''' .. tabularcolumns:: |p{2.5cm}|p{13cm}| +----------------------+--------------------------------------------------+ | Option | Description | +======================+==================================================+ | | Select the check box if you want the full, | | Use Calling Party's | external phone number to be used for calling | | External Phone | line identification (CLID) on outgoing calls. | | Number Mask | | | | Default: Default | | | | | | Corresponding UCM attribute: Use Calling | | | Party's External Phone Number 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 | | Calling Party | international escape character \+; and blank. If | | Transform Mask | this field is blank and the preceding field is | | | cleared, no calling party transformation | | | takes place. | | | | | | Default: None | | | | | | Corresponding UCM attribute: Calling | | | Party Transform Mask. | +----------------------+--------------------------------------------------+ | | 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 \+. | | Prefix Digits | | | (Outgoing Calls) | Note: | | | | | | The appended prefix digit does not affect which | | | directory numbers route to the assigned device. | | | | | | Default: None | | | | | | Corresponding UCM attribute: Prefix | | | Digits (Outgoing Calls). | +----------------------+--------------------------------------------------+ .. tabularcolumns:: |p{2.5cm}|p{13cm}| +----------------------+--------------------------------------------------+ | Option | Description | +======================+==================================================+ | | UCM 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 | | Calling Line ID | topics related to calling party number | | Presentation \* | 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. | +----------------------+--------------------------------------------------+ .. tabularcolumns:: |p{2.5cm}|p{13cm}| +----------------------+--------------------------------------------------+ | Option | Description | +======================+==================================================+ | | 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. | | Calling Name | * Allowed - Choose if you want Unified CM to | | Presentation \* | 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. | +----------------------+--------------------------------------------------+ | | 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. | | | | | Calling Party Number | Choose one of: | | Type \* | | | | * 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 | | | user, using the shortened user name. | | | | | | Default: Cisco UCM | | | | | | Corresponding UCM attribute: Calling | | | Party Number Type. | +----------------------+--------------------------------------------------+ .. tabularcolumns:: |p{2.5cm}|p{13cm}| +----------------------+--------------------------------------------------+ | Option | Description | +======================+==================================================+ | | 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: | | | | | Calling Party | * Unified CM - Use when the Unified CM sets | | Numbering Plan \* | 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: Connected Party Transformations Tab '''''''''''''''''''''''''''''''''''''''' .. tabularcolumns:: |p{2.5cm}|p{13cm}| +-------------------+----------------------------------------------------+ | Option | Description | +===================+====================================================+ | | 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. | | Connected Line ID | * Restricted - Choose if you want Unified CM to | | Presentation \* | 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. | +-------------------+----------------------------------------------------+ | | (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 | | Connected Name | the connected name presentation. | | 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: Called Party Transformations Tab '''''''''''''''''''''''''''''''''''' .. tabularcolumns:: |p{2.5cm}|p{13cm}| +---------------------+--------------------------------------------------+ | Option | Description | +=====================+==================================================+ | | Choose the discard digits instructions that you | | | want to be associated with this translation | | | pattern. See topics related to discard digits | | Discard Digits | instructions in the Cisco Unified Communications | | | Manager System Guide for more information. | | | | | | Default: None | | | | | | Corresponding Unified CM Attribute: Discard | | | Digits. | +---------------------+--------------------------------------------------+ | | 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 | | Called Party | international escape character \+; and blank. If | | Transform Mask | 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. | +---------------------+--------------------------------------------------+ | | 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. | | Prefix Digits | | | (Outgoing Calls) | 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). | +---------------------+--------------------------------------------------+ | | 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: | | | | | Called Party Number | * Unified CM - Use when the Unified CM sets | | Type \* | 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 | | | user, using a shortened user number | | | | | | | | | Default: Cisco UCM | | | | | | Corresponding UCM attribute: Called Party | | | Number Type. | +---------------------+--------------------------------------------------+ .. tabularcolumns:: |p{2.5cm}|p{13cm}| +---------------------+--------------------------------------------------+ | Option | Description | +=====================+==================================================+ | | 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: | | | | | Called Party | * Unified CM - Use when the Unified CM sets | | Numbering Plan \* | 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. | +---------------------+--------------------------------------------------+