.. _concepts-audiocodes-device-number-integration:

AudioCodes Device Number Integration
--------------------------------------

.. _21.4-PB2|VOSS-1234:

:bdg-primary:`Microsoft`

VOSS Automate  in a MS Teams environment supports the integration of numbers used by AudioCodes devices into the 
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:

* **SyncAudioCodes__<connection-name>**
* **PurgeAudioCodes__<connection-name>**
* **ScheduleAudioCodes__<connection-name>**  

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 (:ref:`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:
  
   * Status: ``Used``
   * Usage: ``Device``
   * Vendor: ``AudioCodes``


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

* **Tag**: an information message of the number of days 
  when the INI will reach the release date:

  ::

     Registered user is either offline or deleted, 
     release date {{ fn.now_in_utc %Y-%m-%d }} 
     + {{ macro.audiocodes_cooling_duration }} days

* **Release Date**

See: :ref:`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: :ref:`number-management-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: 

* **Status**: ``Used``
* **Usage**: ``Device``  

See: 

* :ref:`number-audit-process-ms`
* :ref:`run-dni-audit-tool`