[Index]

Model: view/HcsDNInventoryMgmtView

Directory Number Inventory Audit Tool

A sync of device/cucm/Line from the Unified CM can result in various line types being brought in - including lines assigned to devices, CTI devices, and so on - essentially anything that would be seen under Directory Numbers in Unified CM.

Misalignment between Unified CM and VOSS-4-UC can therefore take place, for example:

• Number management for a customer was disabled and then re-enabled (refer to "Create and Modify a Customer").
• Lines, etc. have been created directly on Unified CM.

The DN Audit tool aligns the directory number inventory with the lines information by generating and updating DNs in the correct hierarchy for any line synced into VOSS-4-UC that does not have a corresponding DN in the system.

This will create a number inventory entry for all the device/cucm/Lines that are in the system and at the site level. Any lines not at the site level will not be processed in the audit tool.

The Number Inventory audit then includes logic to then determine if a number is used or not and to set the number inventory value accordingly. That logic handles the following cases:

• If a line is assigned to at least one of: phone, device profile, or remote destination profile, then it will be marked used = true and available will be left as true.
• If a number is used as a Hunt Pilot - it will mark the number used = true and available = false.
• Any other usage of the line is not handled, for example CTI route point. So while these numbers are added to the inventory, they will not be marked used or unavailable through the audit process.

When you run the tool, it creates new DNs for lines that don't have them.

.. uml::

   @startuml
   !include style.iuml

   start
   while (Number Management enabled for customer? [default] ) is (No)
     :[[../src/user/create-customer.html Enable Number Management]];
   endwhile (Yes)
   :Choose Directory Number Inventory Creation Policy option;
   note right
     Options:
     * Customer Create
       (not available for customers with
       Site Location Code-based dial plans)
     * Site Create
     * Smart Create
   end note
   :Save;
   stop
   @enduml

You specify where you want the tool to run and create a new DN inventory:

• Customer Create
  • Always creates new DN Inventory at the customer hierarchy level.
  • This option is only available for non-SLC dial plans, for instance Type 4 or non-SLC shell dial plan.
  • The DN inventory will be created at Customer hierarchy if the line exists at the customer level or at a site. The reason is that even if the administrator moves the line to a site later, the DN inventory at the customer level still applies. If the DN inventory already exists, it will be updated.
• Site Create
  • Always creates new DN Inventory at the site hierarchy level.
  • This option applies to any type of dial plan.
  • The DN inventory is created at the first site the line is encountered. If more than one line with the same pattern but different partitions exist, the DN inventory will be created for the first line encountered with that pattern.
  • If the line exists at customer level, a warning message is logged and the DN inventory is not created. If the DN inventory already exists, it will be updated.
• Smart Create
  • Create new DN Inventory at the site hierarchy level.
  • If the line exists at a site and is not used by a phone in another site, this option creates a new DN inventory at the hierarchy where the line exists.
  • If the line exists at a site, is referenced by one or more phones in other sites, and the dial plan type is non-SLC, thats is type 4, this option creates a new DN inventory at the Customer level.
  • If the line exists at a site, is referenced by one or more phones in other sites, and the dial plan type is SLC, that is type 1-3, a new DN inventory is created at the site where the line exists.
  • If the line exists at customer level, a warning message is logged and the DN inventory is not created. If the DN inventory already exists, it will be updated.

For sites using Site Location Code-based dial plans, DN inventories can be created only at the Site hierarchy. The option to create DN inventories at the Customer hierarchy is unavailable in this case.

The DN Inventory Audit Tool will mark data/InternalNumberInventory instances as Shared across sites if a line is associated with multiple devices.

From Directory Number Inventory, you can see a list of DNs and move, delete, and export them as desired.

Log Messages provides information and warning messages generated by the Directory Number Inventory Audit Tool.

Common Errors and Caveats

• Duplicate device profiles (same profile name) in different clusters.

  Ensure device profiles are not duplicated across the sites.

• Duplicate phones (same MAC) in different clusters.

  Ensure phones are not duplicated across the clusters

• Same directory number in one or more clusters.

  Ensure directory numbers (even in different partitions) are not duplicated across clusters.

• Numbers that are in a Cooling state will not be audited.

Procedure

1. Log in to VOSS-4-UC as provider or reseller administrator.

2. Open the Directory Number Inventory Audit Tool form.

3. If prompted, choose the correct hierarchy and click OK.

   Note

   The tool can only be run from Customer hierarchies. If you run the tool from a hierarchy that is not of type Customer, the tool will automatically provide you with a valid Customer hierarchy choice.

4. From the Directory Number Inventory Creation Policy drop-down, choose an option.

   Note

   Customers with Site Location Code-based dial plans will not see the Customer Create option.

5. Click Save.

The DN inventory is updated at the hierarchy you specified and below.

Model Details