[Index]

Model: data/HcsNumberManagementLogDAT

Directory Number Inventory Audit Tool

When you run the Directory Number Inventory (DNI) Audit Tool, the tool checks and updates your directory number inventory since the last data sync. A sync of device/cucm/Line from the Unified CM will 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.

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.

Note

This can result in inventory entries being created for lines that are not just user device related, for example CTI ports, CTI route points, and so on. The Audit will not remove number inventory entries if a corresponding device/cucm/Line does not exist, for example if it is removed outside of VOSS-4-UC.

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:

The tool is run from the Dial Plan Management > Number Management menu. When you run the tool, it creates new DNs for lines that don't have them.

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

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 Dial Plan Management > Number Management > Directory Number Inventory, you can see a list of DNs and move, delete, and export them as desired.

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

Note

You cannot run the Directory Number Inventory Audit Tool if number management has been disabled for the customer.

Common Errors and Caveats

Procedure

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

  2. Choose Dial Plan Management > Number Management > Directory Number Inventory Audit Tool.

  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.

Audit Number Inventory

Audit Number Inventory

Note

This feature performs an audit of the number inventory and makes sure that the Status and Usage of each number aligns to the devices or services configured with these matching numbers. See Number Status and Usage for more details about these values.

For Microsoft environments, available numbers are added (else updated if present) to the inventory, with:

For more details, see: Audit Process in Microsoft Environments

The audit will create new numbers for devices or services that don't already exist, as well as update existing number entries to make sure the Status and Usage fields reflect the correct information at the time the audit is run. Number entries will not be deleted.

To access the flowcharts, view the topic via the release documentation at: https://documentation.voss-solutions.com/automate.html

Specify where you want to run and create a new number inventory:

For sites using Site Location Code-based dial plans, number inventories can be created only at the site hierarchy, the customer hierarchy will not be available.

From the Number Inventory form (default menu Number Management > Number Inventory), you can see a list of internal numbers and move, delete, and export them as desired.

Common Errors and Caveats

Run Audit Number Inventory

Note

You can only run Audit Number Inventory from a customer hierarchy. If you try to run it from a hierarchy that is not of type Customer, you will be prompted to choose a valid customer hierarchy.

  1. Log in to VOSS Automate as provider or reseller administrator.
  2. Open the Audit Number Inventory form (default menu Number Management > Audit Number Inventory).
  3. Browse to the customer hierarchy at which you want to run Audit Number Inventory.
  4. Choose either Customer or Site from the Is Number Inventory deployed at Customer or Site Level ? drop-down.
  5. If you chose Customer, click Save to run Audit Number Inventory at all sites that are located under the selected customer.
  6. If you chose Site, choose either All from the Would you like to audit all sites or a subset of sites ? to run Audit Number Inventory at all the sites under the selected customer, or choose Specific and specify the sites on which you want to run Audit Number Inventory (200 maximum).
  7. Click Save. The number inventory is updated at the hierarchy you specified and below.

HcsNumberManagementLogDAT

Model Details: data/HcsNumberManagementLogDAT

Title Description Details
Timestamp * When the event occurred.
  • Field Name: timestamp
  • Type: String
  • MaxLength: 1024
Level * Log level.
  • Field Name: level
  • Type: String
  • MaxLength: 1024
  • Choices: ["ERROR", "WARNING", "INFO"]
Component * The name of the component.
  • Field Name: component
  • Type: String
  • MaxLength: 1024
Identifier * An identifier that can be used to link this log with other entities in the system.
  • Field Name: identifier
  • Type: String
  • MaxLength: 1024
Message * Message indicating why the log was generated.
  • Field Name: message
  • Type: String
  • MaxLength: 1024
Recommended Action(s)
  • Field Name: actions.[n]
  • Type: Array
Details
  • Field Name: details.[n]
  • Type: Array