[Index]

Model: data/InternalNumberInventory

Number Inventory

Full HTML Help

Important

From release 21.4-PB4 onwards, the number format in the VOSS Automate Internal Number Inventory (INI) is with prefix: \+, including a leading slash \ when the INI is in E164 format.

Verify that entries in the Internal Number column of the Number Inventory - also Webex Calling numbers - follow this format.

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 numbers in the inventory should be assigned to the appropriate hierarchy in Automate based on where you need the numbers to be used. The number inventory can exist at the same or higher hierarchy level to the users, services, and devices that will be assigned the numbers. So the hierarchy that the numbers are assigned to in the inventory will determine where they are visible for various MACD tasks, such as user on-boarding.

Here are some points to consider and potentially where to load the inventory numbers for different scenarios:

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, choose which hierarchy level to add the numbers to and this will determine their visibility in the system. This should be considered when loading. It is important to consider how the inventory should be allocated when designing a hierarchy setup and ultimately how to build out the inventory.

Vendor Specific Guidance and Notes

Some behaviors and guidance are specific to UC vendors and how their numbers work. We shall cover that in this section.

Cisco UCM/Dedicated Instance

There are a few considerations specific to the number inventory when used in a Cisco UCM/Webex Dedicated instance environment.

Vendor and Internal Number Type fields in the inventory:

Partition and Cluster

The 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.

Cisco-Microsoft Hybrid Number Inventory

If utilizing the Automate Cisco-Microsoft Hybrid feature for integrated services, then the following notes apply.

A Cisco-Microsoft hybrid setup is an integration of Cisco and Microsoft capability where we route Microsoft calls via Cisco Unified CM.

In a hybrid setup, the Internal Number Inventory (INI) can be set up in 2 ways:

The table below sums up the Number Inventory data for these cases.

Note that Extra2 and Extra4 hold the service type and E164 number (includes generated) respectively.

Scenario Status Vendor E164 Number [7] Usage Extra2 Extra4
Cisco-MS-Hybrid Used Cisco, Microsoft Exists Device, User Cisco-MS-Hybrid <blank>
Cisco-MS-Hybrid [8] Used Cisco, Microsoft <blank> Device, User Cisco-MS-Hybrid +88800<INI>
Cisco-No-Services Avail <blank> <blank> <blank> <blank> <blank>
Cisco-Only Used <blank> Exists Device <blank> <blank>
MS-Only-Entvoice Used Microsoft Exists User MS-Only-Entvoice <blank>
MS-Only-Entvoice Used Microsoft <blank> User MS-Only-Entvoice +88800<INI>
MS-Only-Hybrid Used Microsoft Exists User MS-Only-Hybrid <blank>
MS-Only-Hybrid Used Microsoft <blank> User MS-Only-Hybrid +88800<INI>
MS-Only-No-Entvoice Avail <blank> <blank> <blank> <blank> <blank>
No-Hybrid-Service Avail <blank> <blank> <blank> <blank> <blank>

For details on the service type scenarios, see Multi Vendor Service Definitions in the Core Feature Guide.

Footnote

[7]If assigned (and associated with Extra4 - prefix e.g. +88800)
[8]Generated TelURI will start with prefix e.g. +88800

Details and Usage

Selecting a specific number from the Number Inventory list view, opens the details view for that number.

The Number Details tab shows read only details for the number, for example Internal Number, Status, Usage, as well as editable fields such as Tag, Description, Reservation Notes, etc. In the case of Cisco-Microsoft hybrid entries, the vendor added would be "Cisco, Microsoft".

The Usage tab provides links to all instances where the number is used.

Note

Related Topics

Webex App in the Core Feature Guide.

Microsoft Teams Deployments

The use of the inventory and how it is maintained or managed can differ depending on the types of numbers in your environment. The following is some guidance and best practices to consider for the different number types. If you have a mix of number types, then consider the notes for different number types.

Vendor and Internal Number Type fields in the inventory:

General Notes

The hierarchy consideration is a key section in this chapter to read in planning for numbers in the inventory. Often the numbers are meant to be used in specific sites or regions only due to agreements or emergency services requirements. This is the business context which the Automate number inventory can provide when the numbers are loaded into the inventory at the appropriate hierarchy level. In fact, we often find after adding Automate to an existing environment, that we identify various numbers that have been incorrectly assigned previously and enable them to be corrected. Any numbers that were added to the Automate inventory through the sync/audit process will likely require moving to the correct hierarchy level. More details on this in related to the specific numbers types are below.

This section covers specific logic related to creating and managing the inventory in relation to specific number types in the Microsoft environment. In Automate you can mix and match the types for different needs, so one or more of the sections may apply.

Direct Routing

In this type of setup, you are getting ranges of numbers outside the Microsoft framework from one or more providers. For these number types, the Microsoft tenant only knows about the numbers that you have assigned to users/services. The tenant has no knowledge of the ranges or available/unused numbers.

So the VOSS number inventory capability can only auto-populate the inventory from a sync/audit with those used numbers discovered from the tenant. In this scenario, you will need to load the available numbers into the VOSS Automate number inventory to be managed and available for administrators to assign going forward.

Here are a few guidelines in doing this setup:

Operator Connect and Calling Plan numbers

In this type of setup, you are getting ranges facilitated by the Microsoft Teams framework. For these types of numbers, the Microsoft tenant is fully aware of the ranges of numbers available as they are populated into the system by Microsoft (Calling Plans) or the selected Provider (Operator Connect). So it is important to note the numbers can only actually be used (e.g assigned to a user) when the numbers are available in the Microsoft Tenant post ordering – from Microsoft (Calling Plan) or the selected Provider (Operator Connect). If you add them to the Automate inventory and try to allocate them before they are present in the tenant, you will get an error message about the numbers not existing in the tenant.

At this point in time, the data we receive from the MIcrosoft tenant about the numbers does not provide any information regarding how the numbers are to be used - e.g site specific, etc.

The hierarchy recommendations earlier in this chapter should be referenced and numbers should be loaded according to how the numbers are ordered and registered with Microsoft or the Provider (e.g site specific, global, etc).

The best practice recommendation to streamline the inventory management of these number types is:

The Automate system can generate inventory entries for numbers of these types; however there are some considerations and for this reason it is recommended above to preload the numbers for improved accuracy and ease of use. The following are considerations of the generated inventory and potential actions if the sync/audit was run before you loaded your inventory:

You can look at the number data provided by Microsoft for these number types by reviewing the device/msteamsonline/Number device model. Note - these model instances will always be at the same level as the tenant - they do not get moved around and are completely independent of the inventory entries for the numbers.

Webex Calling

This section covers the specifics related to number inventory handling in a Webex Calling environment. Some key considerations in a Webex Calling environment include:

From the Number Range Management menu at a site:

See the Webex App chapter in the Core Feature Guide.

  1. The available macro WebexCallingNumberMgmtEnabledSite has not been cloned to the site and set to value False. (If required, this task can be carried out if Webex Calling number management should be disabled for a site.)

The options are:

Number extensions are added to the INI when a user is assigned a number and an extension is then added.

Since the numbers are known in the Webex environment, as well as the Locations for use, the VOSS Automate system will generate the inventory based on the data from Webex. This includes:

See the Webex Location Node Mapping topic in the Core Feature Guide for more details on Site to Location mapping for Webex for more details on how they are aligned.

AudioCodes Device Number Integration

Number Inventory. Once such devices are configured in VOSS Automate and data is synced, the Number Inventory displays these numbers as Status is Used, with the Vendor field set as AudioCodes. These numbers are therefore then not available to assign to subscribers during number management.

Workflows and data syncs are in place to ensure these numbers in the Number Inventory remain aligned with any changes in these devices.

Configure AudioCodes Devices

Administrators with the required permissions to the relation/AudioCodesConnection and data/AudioCodes models can add entries to menu layouts to expose these models and allow for the configuration of the device.

Connection Details

If the relation/AudioCodesConnection model is available from the menu, the Connection Details input form allows for the configuration of the AudioCodes device in VOSS Automate.

  1. Add a descriptive Name for the connection.
  2. Add connection details and credentials:
    • Audio Codes Routing Manager: IP address or a hostname
    • Username and Password: credentials for the routing manager host
    • Authentication Method: select the type of authentication to use with the host
  3. Select AudioCodes Connection sync on Create/Update if an immediate data sync from the device is required.

Data Syncs and Schedules

When the connection details for the device is added, two default Data Sync instances and a Schedule also become available to be modified and enabled as required:

The data sync workflows would then update internal number inventory entries for the Vendor field set as AudioCodes in accordance with updates to changes (add, delete, update) to AudioCodes RegisteredUsers (device/audiocodes/RegisteredUsers).

AudioCodes and Number Cooling

In the case of the removal (or delete) of a AudioCodes RegisteredUsers instance, the internal number is placed into a configurable cooling period, with Status as Cooling.

Important

For AudioCodes internal numbers, the cooling period (days) is configured by means of a named macro called: audiocodes_cooling_duration (default setting is 2 days) and not by the Number Inventory Cooling Duration (Days) value in Global Settings (Global Settings).

A high level administrator with access to the named macro instances can carry out this configuration if needed.

The reason for the alternative cooling setting is that AudioCodes devices can become offline but are not deleted. The default maximum offline duration is here set to 2 days.

In addition, if the device does then come back online within the days set in the macro, the internal number will be set back to:

When the line is in Cooling, the following internal number inventory fields are set:

See: Number Inventory List View.

When the Release Date has been reached, the INI is put back into the Available pool of INI's, as with standard cooling - see: Number Cooling.

AudioCodes and Audit Number Inventory

When the Audit Number Inventory is run, the Status and Usage of internal number inventory items that have the Vendor field set as AudioCodes are checked and verified to be:

See:

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

View Directory Number Inventory

Full HTML Help

Use this procedure to view the range of directory numbers that have been defined for a site.

Note

In VOSS Automate, an * can appear before a directory number in a Type 4 dial plan.

Procedure

  1. Choose Number Management > Directory Number Inventory (default).

    The list of all directory numbers (DNs) configured at or below the hierarchy appears. Here you can view the list of DN numbers or delete a DN number. You can change your hierarchy if needed.

    Filter the list of directory numbers as needed or select a link in the the Located At column to filter by the selected hierarchy.

    When a DN is first added to the inventory, the Usage column is blank.

    Refer to Number Status and Usage for the Status and Usage columns values.

    The E164Number column and 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):

    Directory numbers that begin with a * (asterisk), denote 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. 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.

    Note

    Adding a new DN to inventory on VOSS Automate does not add a directory number on Cisco Unified Communications Manager until it is associated to a line on VOSS Automate.

    The Directory Number Inventory entries appear in other end-user provisioning tasks in VOSS Automate as described in the table that follows. For more information on provisioning each of these tasks, refer to the VOSS Automate Core Feature Guide.

    Task VOSS Automate + Location Notes
    Lines Subscriber Management > Lines

    When lines are added through phones and subscriber, line details can be modified.

    The DN for the line cannot be modified; if you attempt to change the DN assigned to the line, the operation fails.

    Phones Subscriber Management > Phones > Lines tab > Dirn > Pattern

    The Dirn > Pattern contains a list of available directory numbers.

    DNs that are used are marked as "true" in the Directory Number Inventory.

    Only available DNs are listed.

    Subscribers Subscriber Management > Subscribers > Phones > Lines > Dirn

    The Dirn > Pattern contains a list of available directory numbers.

    DNs that are used are marked as "true" in the Directory Number Inventory.

    Only available DNs are listed.

      Subscriber Management > Subscribers > Voicemail The "Voicemail Line" list contains DNs provisioned to lines.
    Quick Add Subscribers Subscriber Management > Quick Add Subscriber > Lines > Directory Number

    The Directory Number list contains available directory numbers.

    DNs that are used are marked as "true" in the Directory Number Inventory.

    Only available DNs are listed.

    PLAR (Hotdial) Subscriber Management > PLAR (Hotdial) DNs provisioned to lines are displayed in the Hotdial Destination Pattern list
    Hunt Groups Subscriber Management > Hunt Groups > Members> Directory Number DNs provisioned to lines are displayed in the Pattern list
    Call Pickup Groups Subscriber Management > Call Pickup Groups > Call Pickup Group > Line DNs provisioned to member lines are displayed in the Pattern list

The DataModel that VOSS Automate uses to manage INI items.

Model Details: data/InternalNumberInventory

Title Description Details
Base Group Assigned by FDP
  • Field Name: Base
  • Type: Object
Internal Number *
  • Field Name: Base.internal_number
  • Type: String
Status *
  • Field Name: Base.status
  • Type: String
  • Choices: ["Available", "Used", "Used-Utility", "Reserved", "Cooling"]
Usage
  • Field Name: Base.usage
  • Type: String
E164Number
  • Field Name: Base.e164number
  • Type: String
Release Date A value indicates that the number is in temporary 'cooldown' isolation (and therefore also temporarily unavailable until the cooling duration expires, refer to global settings).
  • Field Name: Base.release_date
  • Type: String
Internal Number Type
  • Field Name: Base.internal_number_type
  • Type: String
  • Choices: ["Direct Routing", "Calling Plan", "Operator Connect"]
Tag
  • Field Name: Base.tag
  • Type: String
Description
  • Field Name: Base.description
  • Type: String
Reservation notes
  • Field Name: Base.reservation_notes
  • Type: String
Vendor
  • Field Name: Base.vendor
  • Type: String
Extra1
  • Field Name: Base.extra1
  • Type: String
Extra2
  • Field Name: Base.extra2
  • Type: String
Extra3
  • Field Name: Base.extra3
  • Type: String
Extra4
  • Field Name: Base.extra4
  • Type: String
Extra5
  • Field Name: Base.extra5
  • Type: String
Extra6
  • Field Name: Base.extra6
  • Type: String
Extra7
  • Field Name: Base.extra7
  • Type: String
Extra8
  • Field Name: Base.extra8
  • Type: String
Extra9
  • Field Name: Base.extra9
  • Type: String