.. _license-overview: License Count ------------------------- .. _21.4-PB5|VOSS-1261: The license counting process is independent from writing the file and runs on its own schedule: - This includes overall license counts as well as which users are consuming a license in the system - Enables the license consumption to be viewed in the system via the admin portal - Runs daily at 1AM UTC- this schedule is created and activated automatically. - Can also be run manually via CLI as needed outside the schedule – can choose a hierarchy to run it for (e.g just part of the system) - see: :ref:`license-counting-process-commands`. - For full details on the license counting, see :ref:`license-audit-counts-viewing`. .. _license-audit-counts-viewing: Viewing License Audit Counts ------------------------------------------------- The total count for licenses used and an overall total of licenses consumed can be seen from the **Automate - VOSS License Overview** dashboard, available from the **About** menu. This presents a range of widgets to review the license count information to understand your current consumption, as well as user data to understand which users are consuming licenses in the system. .. raw:: html See also: Automate - VOSS License Overview .. image:: /src/images/dashb-license-overview-total-license-usage.png A user's license status may be one of the following: - Licensed - consuming a license - Unlicensed - not consuming a license - Unknown - status not yet determined yet, which typically means the user was added since the last calculation was run .. note:: * Values for **License Audit Status** display only after the first run of the license-audit-service. * For details on how the fields are calculated and what they mean, see :ref:`license-audit-report-file-details` below. - Overall License counts - **License Counts** from the **About** menu (``data/LicenseAuditCounts`` model). .. _license-audit-report: License audit report ------------------------ The process to generate the license audit report is independent from the counting of the licenses. This process simply takes the results of the counting process recorded and writes them to the appropriate files. - Runs monthly at 3AM UTC on the first day of each month - this schedule is created and activated automatically. - How the generated file(s) are handled will depend on the setup on your system - see :ref:`license-distributing-licensing-reports`. This outlines the numerous options to set up the platform to automatically send files off the system to required destination(s) or alternate ways to access the files as required. - This takes the data recorded by the license counting process above and writes it to a file - The format of the file and the contents are outlined in :ref:`license-audit-report-file-details`. - Files are retained on the system for two years and are automatically removed at the end of this period. The files generated provides 2 views of the data (different CSV files): #. Anonymous - Aggregated counts and other data required for billing. The tool does not collect any data identifying users or customers on the system. This file is typically sufficient to provide VOSS for billing purposes. #. Detailed-  As above, except that it includes identifying information about the customers instead of IDs. This same data can be viewed through the admin portal as noted above. This file may need to be shared with VOSS depending on your agreement. On the billing anniversary determined by your contract (for example, monthly or quarterly) the files required by VOSS need to be collected and provided. This can be done by the partner or via VOSS support if access is available from the partner. This is why automated delivery of the file is recommended as outlined in :ref:`license-distributing-licensing-reports`.