.. _licensing-audit-details:

Licensing Audit Details
--------------------------

The Audit Details table below provides information on vendor devices
and services that are shown in the following exports:

* :ref:`license_anonymous_customer_aggregate_data_export`
* :ref:`license_detail_customer_aggregate_data_export`


Notes on Vendor Services
........................

* Cisco

  * Phones (basically anything that is a phone in UCM) - hardphones, soft clients, mobility clients, ATAs (analog), SCCP analog ports.  Excludes other Analog gateway ports MGCP/H323 as these can't be associated to a user
  * A user's associated devices as well as a phone's ownerUserName are used to determine if a phone belongs to the user or is standalone
  * EM Profile = (device/cucm/deviceprofile associated to the UCM user)
  * VM (device/cuc/User)
  * Webex (device/webex/User) - relates to Webex Meetings
  * SNR (device/cucm/RemoteDestinationProfile)
  * Spark - Webex Teams (device/spark/User)
  * Contact Center - UCCX/UCCE
  * In the case of these services, only instances at the Site level are counted.

* Microsoft

  * O365
  * MS Teams
  * Exchange

* PexIP

  * Conferencing

* VOSS Phone Server


.. note::
 
   Refer to the detailed notes following the table below for additional information.

Audit Details Table
....................

.. raw:: html

   <p><a href="licensing-audit-details-sheet.csv">Download licensing-audit-details-sheet.csv</a></p>

.. raw:: latex

   To download this table as a CSV sheet, refer to the HTML version of this document.

.. tabularcolumns:: |\X{2}{16}|\X{6}{16}|\X{5}{16}|\X{3}{16}|


.. csv-table:: Licensing Audit Details Sheet
   :file: licensing-audit-details-sheet.csv
   :class: longtable
   :header-rows: 1
   :widths: 3 8 7 2


Notes on Audit Details Table
.............................


Microsoft columns detailed notes:

* Are only counted if the user only has Microsoft services. For
  instance: if the user has Cisco and Microsoft, then the user is
  included in the relevant Cisco column and excluded from the Microsoft
  count.

Phone detailed notes:

* Phones (anything that is a phone in UCM) - hard phones,
  soft clients, mobility clients, ATAs (analog), and SCCP gateway ports

  * CTI Ports are excluded from the counts (these do not consume a license)
  * Spark Remote Device is excluded from the user count if they have more
    than one phone (i.e. Spark Remote Device is not their only phone).  

* A phone being associated with a user for the license count is driven
  by:

  * Association to user driven by the Subscriber/UCM User setting for
    associated devices (aka controlled devices).  This is how VOSS
    associates the device with the user in the system (e.g relation
    Subscriber, self-service, etc).
  * ownerID on the Phone (in the event the association above is not set
    up).  This is to cover cases when overbuild might have been used and
    association is not set up correctly per the above.
  * If the phone does not fall into either of the above, then it is counted
    as a Standalone Phone.

  .. note::

    If the phone has an ownerID set but that UCM user is not in
    the VOSS system (i.e no device/cucm/User records for the user - e.g
    not synced in, etc) then the ownerID is ignored and it is counted as
    a standalone phone
   
Spark detailed notes:

*  UCM user at site that has a Spark user somewhere (including
   intermediate node beneath site) - then that will initiate the search
   for Spark and it will look up/down as needed and count as a premium
   user or other subscriber permutation.  E.g. UCM User at site and
   Spark user at site = appropriate Subscriber column.  UCM User at
   site, Spark user at Customer = appropriate Subscriber column
   Spark user without a UCM user at site level - then search initiated
   by Spark.  
*  If the UCM user is at the same level or lower, then it will count as
   premium.  If UCM user higher or non-existent, then counts as
   standalone Spark.  E.g. Spark User at customer level, UCM user at
   customer level = Premium.  Spark User at site, UCM user at customer =
   Standalone Spark.

Multi-vendor column notes:

* Counted if the user has more than one of:

  * ``device/cucm/User``
  * ``device/cuc/User``
  * ``device/cucm/Phone``
  * ``device/webex/User``
  * ``device/spark/User``
  * ``device/ccdm/Agent``
  * ``device/uccx/Agent``
  * ``device/msgraph/MsolUser``
  * ``device/msteamsonline/CsOnlineUser``
  * ``device/azureadonline/MsolUser``
  * ``device/pexip/Conference``

Acronyms
.........

* UCM: Unified Communications Manager
* UCCX: Unified Contact Center Express
* UCCE: Unified Contact Center Enterprise
* EM: Extension Mobility profile
* VM: Voicemail
* SNR: Single Number Reach
* Public Sector: boolean flag on Customer to indicate public sector customer. Can be set with an API call or on the GUI Customer form.
* MS O365: Microsoft Office 365
* MS Teams: Microsoft Teams