.. _license-audit-report-file-details:

License Audit Report File Details
=================================

.. _21.4-PB5|VOSS-1261:
.. _25.1|VOSS-1496:   
.. _25.1|EKB-24490:   
.. _25.1|EKB-24679:   

The License Audit Report process will generate the following ZIP file types
as output:

-  license_detailed

   Specifically contains:

   -  detailed - CSV file - anonymous version of the license audit report file - details below


-  license

   Specifically contains:

   -  anonymous - CSV file - anonymous version of the license audit report file - details below


Both ZIP files contain:   

   -  anonymous ``_breakdown`` - csv file - anonymous file containing a few
      key statistics from the platform - used for support purposes
   -  patch - JSON file - list of patches applied to the system as shown
      **About > Extended Version** - used for support purposes
   -  ``adaptation_log`` - JSON file - list of adaptations applied on the
      system as shown in **About > Adaptation Status** - used for support
      purposes.
   -  ``.hash`` for each included file - to validate the file


All filenames are of the format:

``vlf_<provider_name>_<host_name>_<file_type>_<YYYY-MM-DD_HHMM>``

E.g.  ``vlf_CS-P_VOSS_detailed_2024-03-05_1958``


See also: :ref:`license-distributing-licensing-reports`.


Licensing Audit Field Details
..............................

The table below provides details of the fields shown in license reports and CSV files,
in particular, fields used for the calculation of users, devices, as well as count totals.

.. note::

   The descriptions here are based on the standard VOSS license definition and may be different based on your contracted terms.
   Information only fields are not included in license usage calculation. All other fields are counted at license usage and
   included in the **Total License Usage** column.



.. raw:: html

   <p><a href="license-audit-fields.csv">Download license-audit-fields.csv</a></p>


.. raw:: latex

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

.. tabularcolumns:: |\X{5}{17}|\X{12}{17}|


.. csv-table:: Licensing Audit Field Details Sheet
   :file: license-audit-fields.csv
   :class: longtable
   :header-rows: 1
   :widths: 5 12




Detailed and Anonymous License Audit Report file format
.............................................................

Detailed
''''''''''

The detailed version is a CSV file containing the hierarchy names for
ease of understanding the data.

The header of the file contains metadata about the platform the file was
generated on such as platform IDs, licensing info, version, and other
similar data.

The main content of the file is an export of the Overall License count
data as available via the admin portal. For details of the counting for
each column, see :ref:`license-audit-counts-viewing`.

An example of the file:

::

   #OrgID=
   #Platform ID=67d0bba368c7ef880c8571d1
   #hostname=python
   #Provider Name=CS-P
   #Software Version=pre-release.25.1.build-198
   #Platform Version=25.1.0-1741721622
   #Deployment Mode=Provider
   #License Token=<license-token-not-found>
   #License Expiry=<license-expiry-not-found>
   #Date Time=2025-03-18 13:08
   #Audit Version=5.2.0
   Provider,Reseller,Customer,Provider PKID,Customer PKID,User Licenses,Contact Center Express,Cisco and MS Integrated Services,Contact Center User Webex,Standalone Devices,Meeting Rooms,Voss Phone Servers,Sites
   CS-P,,,67d0d83e39e7e759c8a78048,,0,0,0,0,0,0,0,0
   CS-P,CS-NB,AAAGlobal,67d0d83e39e7e759c8a78048,67d0d8c739e7e759c8a78b32,144,0,0,0,103,0,0,11
   CS-P,CS-NB,NBIcorp,67d0d83e39e7e759c8a78048,67d0e20a39e7e759c8a8b337,0,0,0,0,0,0,0,4
   CS-P,CS-NB,Overton,67d0d83e39e7e759c8a78048,67d11bc239e7e759c8ae8f2a,13,0,0,0,13,0,0,6
   CS-P,,GeoLogic,67d0d83e39e7e759c8a78048,67d0d91d39e7e759c8a78d66,0,0,0,0,0,0,0,5
   




.. note:: For licensing:

   * ``OrgID`` is the account id from the Customer Portal: **Company Information**.

Anonymous
''''''''''

Filename format: 

``vlf_<provider_name>_<host_name>_anonymous_<YYYY-MM-DD_HHMM>.csv``

The anonymous version of the file contains a slightly modified version
of the detailed file removing the hierarchy names and replacing it with
a customer pkid. The rest of the file content is the same as the
detailed version outlined above. For more details on the hierarchy
differences - see :ref:`license-audit-counts-viewing`. Here is an example
of the anonymous file:

::

   #OrgID=
   #Platform ID=67d0bba368c7ef880c8571d1
   #hostname=python
   #Provider Name=CS-P
   #Software Version=pre-release.25.1.build-198
   #Platform Version=25.1.0-1741721622
   #Deployment Mode=Provider
   #License Token=<license-token-not-found>
   #License Expiry=<license-expiry-not-found>
   #Date Time=2025-03-18 13:08
   #Audit Version=5.2.0
   Provider PKID,Customer PKID,User Licenses,Contact Center Express,Cisco and MS Integrated Services,Contact Center User Webex,Standalone Devices,Meeting Rooms,Voss Phone Servers,Sites
   67d0d83e39e7e759c8a78048,,0,0,0,0,0,0,0,0
   67d0d83e39e7e759c8a78048,67d0d8c739e7e759c8a78b32,144,0,0,0,103,0,0,11
   67d0d83e39e7e759c8a78048,67d0e20a39e7e759c8a8b337,0,0,0,0,0,0,0,4
   67d0d83e39e7e759c8a78048,67d11bc239e7e759c8ae8f2a,13,0,0,0,13,0,0,6
   67d0d83e39e7e759c8a78048,67d0d91d39e7e759c8a78d66,0,0,0,0,0,0,0,5


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


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

