[Index]

Model: relation/HcsDNE164AssociateREL

E164 Associations ( N to N DN )

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Use this procedure to associate a range of E.164 numbers with a range of directory numbers (DN) at a customer or site. These associations create Direct Dial Inward (DDI) associations so that incoming PSTN numbers are routed to directory numbers.

If you create the association at a site, you can mix customer-level DNs and E.164 numbers with site-level DNs and E.164 numbers.

Note

Procedure

  1. Choose Dial Plan Management > Number Management > E164 Associations (N to N DN).

    You can change the hierarchy if required.

  2. Click Add.

  3. Provide the following information:

Field Description
Range

Select one of these ranges:

Note:

The range values you select map to the mask value when the association translation pattern is created. For example, when 10 is selected, all E.164 numbers and directory numbers that end in 0 are listed. The mask affects all digits 0 to 9, so you can't start the mask on a nonzero number. Likewise, when 100 is selected, the E.164 number and DN end in two zeros. This pattern results in a mask of XX.

  • 1 - To list all E.164 numbers and DNs
  • 10 - To list all E.164 numbers and DNs that end in one zero (0)
  • 100 - To list all E.164 numbers and DNs that end in two zeros (00)
  • 1000 - To list all E.164 numbers and DNs that end in three zeros (000)

This field is mandatory and affects what appears in the fields that follow.
E164 Number Choose the starting number of the range of E.164 numbers from the drop-down menu. For a customer-level association, only customer-level E.164 numbers are available. For a site-level configuration, both customer-level and site-level E.164 numbers are available. This field is mandatory.
DN Number

Choose the starting extension number from the drop-down menu. This field is mandatory.

Note:

You cannot associate extension numbers that begin with the prefix '*' (asterisk) or '#" (hash).
  1. Click Save.

E164 Associations ( N to N DN )

Full HTML Help

Overview

This topic describes managing a range of internal numbers (Directory Numbers, or DNs) associated with a range of E164 numbers.

View E164 Associations (N to N DN)

To view the ranges of E164 numbers that are associated with a range of internal numbers (Directory Numbers, or DNs):

  1. In the Admin Portal, go to (default menus) Number Management > E164 Associations (N to N DN) to open the E164 Associations ( N to N DN ) list view.

  2. View E164 associations (N to N DN) in the list.

    Note

    You can filter the list and change the hierarchy by selecting a link in the Located At column.

    The table describes column data in the E164 Associations ( N to N DN ) list view:

    Column Description
    E164 Number The starting E164 number in the range.
    DN Number The starting internal number in the range.
    Range

    One of the following:

    • 1 - To indicate that one E164 number and internal number are associated.
    • 10 - To indicate that a range of ten numbers including the starting E164 and starting internal number are associated.
    • 100 - To indicate that a range of 100 numbers including the starting E164 and starting internal number are associated.
    • 1000 - To indicate that a range of 1000 numbers including the starting E164 and starting internal number are associated.
    Located At Indicates the hierarchy of the site where the E164 number range and internal number range association was created.

Add an E164 Association (N to N DN)

THis procedure associates a range of E164 numbers to a range of internal numbers, at a site.

Note

  1. In the Admin Portal, go to (default menus) Number Management > E164 Associations (N to N DN) to open the list view.

  2. Choose the site (if required).

  3. In the E164 Associations ( N to N DN ) list view, click the Plus icon (+) to add a new record.

  4. Configure E164 Association ( N to N DN ). The table describes configuration options:

    Field Description
    Range

    Mandatory. Choose the range before choosing other settings on this page.

    Defines the range value for the E164 to DN association. Options are: 1, 10, 100, or 1000

    The range value you select maps to the mask value when the association translation pattern is created. For example, when 10 is selected, all E164 numbers and directory numbers that end in 0 are listed. The mask affects all digits 0 to 9, so you can't start the mask on a non zero number. Likewise, when 100 is selected, the E.164 number and DN end in two zeros. This pattern results in a mask of XX.

    • 1 - To list all E164 numbers and internal numbers
    • 10 - To list all E164 numbers and internal numbers that end in one zero (0)
    • 100 - To list all E164 numbers and internal numbers that end in two zeros (00)
    • 1000 - To list all E164 numbers and internal numbers that end in three zeros (000)
    E164 Number

    Mandatory. Choose the starting number of the range of E164 numbers.

    • If the association is performed at customer level, the drop-down only shows E164 numbers that were added at customer level.
    • If the association is performed at site level, the drop-down contains E164 numbers that were added at either customer or site level provided the country matches the site's country.
    DN Number

    Mandatory. Choose the starting internal number.

    • If the association is performed at customer level, the drop-down only shows internal numbers that were added at customer level.
    • If the association is performed at site level, the drop-down shows internal numbers that were added at either customer or site level.
    • You cannot associate internal numbers that begin with the prefix '*' (asterisk) or '#" (hash).
    Dial Plan Model Selection

    This field displays only when the Enforce HCS Dialplan Rules setting in the Global Settings is set to False

    Defines the translation pattern template configured in the dial plan modeling tool. The values for the pattern, transform mask, and associated range masking are hard coded in the workflow. +1555 111 5555 (Range 10) = +1555 111 555X

    Other values, such as partition and CSS) come from this template.

    The translation pattern must have its description set to display in this drop-down.

  1. Save your changes.

    Note

    • When listing the Number Inventory and displaying an internal number, the E164 Number format is as listed in E164 Column Description.
    • A translation pattern (which is the mapping between the E164 range and internal number range) is created on the CUCM. This translation pattern is used to route inbound PSTN calls to their associated internal numbers.
    • If the association is performed at a Site, the translation pattern is only added to the CUCM referenced by the site's network device list (NDL).
    • If the association is performed at Customer level, the translation pattern is added to all the customer's CUCMs.
    • If the Site has one or more SIP Local Gateways associated with it, the HcsSipLocalGwAddE164AssociationEVT event is generated. If enabled, the IOS Command Builder generates the default IOS commands associated with the event for each SIP Local Gateway.

Delete an E164 Association (N to N DN)

This procedure deletes one or more E164 (N to N DN) associations to disassociate a range of E164 numbers from a range of internal numbers.

Note

In VOSS Automate, the HcsSipLocalGwDelE164AssociationEVT event related to SIP Local Gateway is generated as a result.

  1. Go to (default menu) Number Management > E164 Associations (N to N DN) to open the E164 Associations ( N to N DN ) list.

  2. Change your hierarchy, if required.

  3. View E164 Associations (N to N DN) in the list, which displays the following information:

    Column Description
    E164 Number The starting E164 number in the range.
    DN Number The starting DN number in the range.
    Range
    • 1 - Indicates that one E164 number and internal number are associated
    • 10 - Indicates that a range of ten numbers including the starting E164 and starting internal number are associated
    • 100 - Indicates that a range of 100 numbers including the starting E164 and starting internal number are associated
    • 1000 - Indicates that a range of 1000 numbers including the starting E164 and starting internal numbers are associated
    Located At Indicates the hierarchy of the site where the E164 number range and internal number range association was created.

  1. Choose an option:

  2. Click Delete, then click Yes to confirm the disassociation.

    Note

    • The translation pattern mapping between the E164 range and internal number range is deleted from CUCM.

      The E164 number association with the internal number is removed on the Number Inventory list view display and in any Lines drop-down list and Lines displays.

    • If the site has one or more SIP Local Gateways associated with it, the HcsSipLocalGwDelE164AssociationEVT event is generated. If enabled, the IOS Command Builder generates the default IOS commands associated with the event for each SIP Local Gateway.

Model Details: relation/HcsDNE164AssociateREL

Title Description Details
E164 Number * The E164 Number.
  • Field Name: e164_number
  • Type: String
  • MaxLength: 17
DN Number * The Directory Number.
  • Field Name: dn_number
  • Type: String
  • MaxLength: 50
Range Indicates range value for the E164 to DN association.
  • Field Name: e164_range
  • Type: String
  • MaxLength: 1024
Evaluate HCS DP Enforcement Default: false
  • Field Name: hcsdpeval
  • Type: String
  • Default: false
Dial Plan Model Selection Select the required Translation Pattern Dial Plan Model. Translation Pattern must have the Description field set to be displayed in this dropdown.
  • Field Name: dpModelSelect
  • Type: String
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024