[Index]

Model: view/HcsDNMgmtVIEW

Add Directory Number Inventory

Add Directory Number Inventory

Note

You must deploy a customer and site dial plan before performing this procedure.

Use this procedure to add a single directory number (DN) or range of DNs for your customer. The DNs (extensions) you specify are validated against the Dial Plan type (Type 1 to 4). The extension length assigned to the site is enforced for site location code (SLC)-based dial plans. The maximum number of directory numbers you can add at a time is 1,000. For more information on Type 1 to Type 4 dial plans, see Directory Numbers Classification.

  1. Choose Dial Plan Management > Number Management > Add Directory Number Inventory (default).

    You can change your hierarchy if needed.

  2. From the Site drop-down menu, choose the site for which you are adding directory numbers. Leave this field empty to add customer level directory numbers.

    Note

    Customer level directory numbers can only be created for dial plans that do not use site location codes (flat dial plans). Attempting to create customer level directory numbers for site location code-based dial plans result in an error instructing you to specify a site when adding new DN inventory.

  3. Using the Extension Length, Site Location Code, and ISP read-only fields as a guide for the site, enter the first number for the DN range in the Starting Extension field.

    Note:

    For a Type 4 dial plan (no SLCs), the Starting and Ending Extension fields must contain no more than 16 digits each, including the + sign before the DN number, if used. For Types 1 to 3 dial plans, the Starting and Ending Extension fields must be less than or equal to the site Extension Length. If the Starting or Ending Extension field length is less than the site Extension Length, the DN number is padded with zeroes until its length equals that of the site Extension Length.

    For a Type 4 dial plan (no SLCs), the Starting and Ending Extension fields may contain a * prefix (asterisk) before the 15-digit directory number. The * prefix denotes DNs that are used with hunt groups, assistant lines, Contact Center lines, and so on. This type of directory number cannot be reached from an outside line and cannot be associated with E.164 numbers. Typically, a DN with the * prefix is not called from another line (user), but is tied to a service feature such as call pickup, hunt groups, or contact center.

    Example: If the Extension Length field shows four digits for a Type 3 Dial Plan, ensure that you enter a number containing four digits or less in the Starting Extension field. For example, DN 1234. If you enter DN 123, the extension number is created as DN 0123.

  4. (Optional). Using the Extension Length, Site Location Code, and ISP read-only fields as a guide for the site, enter the last number for the DN range in the Ending Extension field. If you are adding a single DN, the ending number is the same as the starting number.

    Note:

    The maximum number of directory numbers you can add is 1,000 at a time. If you need more than 1,000 directory numbers, repeat this procedure as required to add ranges.

  5. Enter a Tag name for the entered range to allow for tag filtering of the inventory list available from Dial Plan management > Number Management > Directory Number Inventory (default).

  6. Use the following fields to input additional information (free text) for: Description, Extra1 to Extra3.

    The E164Number field is disabled for manual input (but can be bulk loaded). It is automatically populated when E164 numbers are associated with Directory Numbers from Dial Plan Management > Number Management > E164 Associations (N to N DN) (default), or Dial Plan Management > Number Management > E164 Associations (N to 1 DN) (default).

    The E164Number value on an instance form displays as in the examples below for E164 Associations (N to 1 DN), depending on the number of E164's being associated and whether a primary E164 is set or not.

    Note that the first example display is also the display for E164 Associations (N to N DN):

  7. Click Save to save the single DN or DN range.

Note

You can verify that the directory number or numbers were added correctly by navigating to Dial Plan Management > Number Management > Directory Number Inventory (default).

Columns for the Tag, E164Number and other additional information fields are also shown.

Number Inventory

Full HTML Help

Overview

Number inventory allows you to view and manage the numbers for use by users, devices, and services for the given hierarchy level. The inventory includes a combination of data that is automatically managed by the system (like usage) and other fields that are configurable and available to store any additional useful information you choose about the numbers (examples include ranges, billing IDs, circuit IDs) to complete your inventory view.

The inventory supports a range of capabilities outside the basic loading and tracking of inventory status. These include:

More details on these features are provided in the sections below.

Note

Typically numbers are pushed to the UC applications when they are allocated/assigned to users/devices/services. While some available numbers may be in the UC apps for various reasons, the platform is not trying to maintain the available numbers in the underlying UC applications as it is only important when assigning the numbers to be used.

Hierarchy Considerations

The number inventory can exist at the same or higher hierarchy level to the users, services, and devices that consume them. This means you can define number inventory at the appropriate level to suit various needs:

Users, devices, and services that will consume numbers are typically at the site level in the system, so numbers they need should be at the same level (site) or above the site they reside in (Intermediate, Customer). The approaches can also be mixed as needed if some numbers are site specific while others are shared pools. When adding the number(s) into the inventory, you choose which hierarchy level to add the numbers to and this will determine their visibility in the system so should be considered when loading.

Number Uniqueness Considerations

Numbers in the inventory should be unique within a hierarchy structure (in other words, looking up the hierarchy). The inventory is not aware of dial plan elements or other mechanisms that can allow the same number to coexist multiple times - for instance partitions in UCM. This can lead to unpredictable results if the numbers tracked are not unique. For instance, in the Cisco Communications Manager world, having the same number in multiple partitions or even in multiple clusters while the inventory sits at the Customer level - it will be treated as a single number in the inventory. This is where allocating numbers to a site can help as long as the different UC app instances are in different VOSS Automate sites.

Partition and Cluster

Number inventory is not partition or cluster aware. If the same numbers are used multiple times but in different partitions, then these all map to the same number. This should be taken into account when thinking about the hierarchy level at which the number inventory exists.

Also, not being cluster aware, if the same number exists on different clusters, this again will map back to the same inventory value unless numbers are assigned to the site level.

Reservation

Numbers can be reserved for future use. For example, for users who will soon be joining the company. When a number is reserved, it is unavailable and cannot be allocated to a subscriber, phone, device, etc.

Number Cooling

Numbers can be placed into a cooling period, either manually or automatically. When automated number cooling is enabled, numbers are placed into cooling for a predefined period when the subscriber or phone associated with the number is deleted.

Note

Automated number cooling is enabled and disabled in the Global Settings. The default is disabled.

While the number is in its cooling period, it is unavailable and cannot be allocated, for example, to a subscriber, phone, or device.

A number is released from cooling and is available for use when:

Number Inventory entries - End-user Provisioning Tasks

The number inventory is integrated into various features in the system to:

  1. Display options of numbers for selecting/assignment across the system. The numbers presented for selection follow rules specific to the feature in many cases, for instance can lines be shared or not, etc.
  2. Manage the state of the numbers in the inventory via the workflows - marking the number used, available, and updating other managed fields depending on the MACD being performed. This includes any specific logic setup for the unmanaged fields - See the section on flexibility for options to control the update that occurs.

Related Topics

Model Details: view/HcsDNMgmtVIEW

Title Description Details
Site Please choose Site to Provision DNs. If site not specified, inventory will be added to the current hierarhcy node if allowed.
  • Field Name: site_hn
  • Type: String
  • Choices: [" "]
Starting Extension * Starting Number for the DN Mgmt Range
  • Field Name: startNum
  • Type: String
  • Pattern: ^(\*|\+)?[0-9]*$
Ending Extension Ending Number for the DN Mgmt Range
  • Field Name: endNum
  • Type: String
  • Pattern: ^(\*|\+)?[0-9]*$
Extension Length Extension Length for the Site
  • Field Name: extLen
  • Type: String
Site Location Code Site Location Code for the Site
  • Field Name: slc
  • Type: String
ISP ISP for the Customer
  • Field Name: isp
  • Type: String
Site-Location Code (SLC) based Site Location Code Based true or false Default: {{ data.DpCustomer.slcBased }}
  • Field Name: slcBased
  • Type: Boolean
  • Default: {{ data.DpCustomer.slcBased }}
Tag Tag used for filtering INI numbers. This can be any free text to identify or comment a range of internal numbers.
  • Field Name: tag
  • Type: String
Description Description field
  • Field Name: description
  • Type: String
E164Number Number in E164 format
  • Field Name: e164number
  • Type: String
  • Pattern: ^\+?[1-9]\d{1,14}$
Extra 1 Extra Field 1
  • Field Name: extra1
  • Type: String
Extra 2 Extra field 2
  • Field Name: extra2
  • Type: String
Extra 3 Extra field 3
  • Field Name: extra3
  • Type: String
Extra 4 Extra field 4
  • Field Name: extra4
  • Type: String
Extra 5 Extra field 5
  • Field Name: extra5
  • Type: String
Extra 6 Extra field 6
  • Field Name: extra6
  • Type: String
Extra 7 Extra field 7
  • Field Name: extra7
  • Type: String
Extra 8 Extra field 8
  • Field Name: extra8
  • Type: String
Extra 9 Extra field 9
  • Field Name: extra9
  • Type: String