.. _number-range-management:

Number Range Management
-----------------------

.. index:: Quick Add Subscriber (Feature);Feature Number Management


.. _20.1.1|VOSS-651:

Number Ranges Overview
......................

The Number Range management feature allows you to create a range of internal numbers
at a customer or site level.

When a range is added that includes existing numbers, these can not be modified. 
The new unused numbers will be added only to complete the range. In other words, 
the range will show up as complete, with unused numbers in between numbers imported
from |Unified CM|.

Number ranges can also be deleted. Numbers in the range that have a status of
**Used**, **Used-Utility**, **Reserved** or **Cooling** will be ignored and can
not be deleted. If these numbers are modified to the **Available** status, and not
in use, they can then be deleted. The **Available** and **Reserved** status of
numbers can also be modified manually once they are added.

.. note::

   * Using bulk loader sheet or API, you can create the number inventory at the
     customer hierarchy only. The **Details** column of sub-transactions shows
     whether the number already exists or if it is creating a new number. If any
     numbers exist in the range, the sub-transaction fails and the parent transaction
     shows the status Success with Async Failures.


.. _add_delete_and_modify_internal_number_inventory_range:

Add, Modify or Delete a Number or Number Range
..............................................

Numbers can be added or deleted. When *modifying* a number, you can only edit the
free text fields. The usage and availability property for each number is associated
with a line or taken into use by a service.

Since the number inventory is not partition aware, if the same directory number
is used on a cluster but in different partitions, then VOSS Automate workflows will
update the inventory when *any* of those instances are changed. For instance, if
there is a number 1111 in the Cluster X partition and a number 1111 in the 
Cluster Y partition, then the number is marked as **Used**.

If one of those instances are deleted, we check to see if there are other instances
of that line based on the number only (not partition), before clearing the **Used**
flag. In this case, the other instance will be found and the inventory will stay
marked as **Used**.

1. Browse to the hierarchy at which you want manage the number range.
#. Open the **Number Range Management** form (default menu **Number Management >
   Number Range Management**) and choose the target site from the **Target Site**
   drop-down (only applicable to Customers using an SLC-based dial plan). 
#. From the **Operation** drop-down, choose **Add**, **Modify** or **Delete**.
   
   .. note::
   
      * When adding or modifying a number range, the **Status** of the numbers is
        **Available** by default. However you can change this to **Reserved** from
        the **Status** drop-down. If set to **Reserved**, you can also enter the
        **Reservation duration (days)** value, e.g. 30, after which period the
        number/s will return to the **Available** status. If this value is left
        blank, the number/s will be reserved indefinitely. See also :ref:`number-reservation`.
      * When deleting a number range, lines cannot be marked as **Available** or
        **Reserved**, and the check boxes are hidden.
#. Enter the **Starting Extension** and **Ending Extension**. The maximum allowed
   range is 1000 for a single action. The starting extension should always be
   smaller than the ending extension. 
   
   If you are adding or deleting a single number, the starting and ending extension
   number will be the same. If numbers in the range already exist, they will not
   be affected - only non-existing numbers will be added.
#. Edit free text fields, for example **Tag**, **Description**, **Reservation notes**
   **E164Number** (if applicable), and **Extra1** to **Extra6**.
#. Click **Save** to save the single or range of numbers that you added, modified
   or deleted. If a number in a deleted range was set as **Used**, it will not be
   deleted.

The numbers at a specific hierarchy can be viewed on the **Number Inventory**
list view (default menu **Number Management > Number Inventory**).
See :ref:`number-inventory-list-view`.

When a line is added and selected from the drop-down list of available numbers,
it has a status of **Used**. If the line is used by a device or service that does not
allow a shared line (for example, a Hunt Pilot), it has a status of **Used-Utility**.
See :ref:`concepts-number-status-usage`.

If number cooling is enabled, deleted numbers are automatically placed into a
cooling period as specified in :ref:`global-settings`. During this period the number
cannot be used. 

Internal numbers are available when adding subscribers.


Modify an individual number
............................

You can also modify an individual number from the list view (:ref:`number-inventory-list-view`)
by selecting it.

1. Click **Reserve Number** on the button bar of the number instance form to
   reserve it.
#. Edit free text fields, for example: **Tag**, **Description**, **Reservation notes**, 
   **E164Number** (if applicable), and **Extra1** to **Extra6**.
#. Click **Save**.



.. |UCS| replace:: UCS
.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM