licenseReport

For Nuance Recognizer and Nuance Vocalizer licensed products, you can use the license reporting tool, licenseReport, to count license usage by parsing the data in the Recognizer call logs and Vocalizer event logs. This tool cannot be used in lieu of license enforcement, but can be useful for tracking usage patterns.

You must have Perl installed to run the tool.

The tool reads all specified event log directories to generate a histogram of license usage per day.

The tool is installed in %SWISRSDK%\samples\license_report for Recognizer, and api\demos\license_report for Vocalizer.

Note: Even though the Nuance Recognizer and Nuance Vocalizer products have a script by the same name, and the Perl code is very similar, they are not the same. The Recognizer version only works on Recognizer call logs, while the Vocalizer version only works on Vocalizer event logs.

Command syntax

The syntax of the command line is:

perl licenseReport-Files.pl eventLog1|dir1 [eventLog2|dir2
   eventLogN|dirN] [-hourly] [-csv] 

Options

The tool accepts these optional arguments:

Option

Description

-hourly

The histogram reports use per hour.

-csv

The report is produced in a comma-delimited format that can be easily imported into a spreadsheet.

Otherwise, the report is produced for convenient display on a screen in text format.

Report detail

The report of license usage contains the following information:

Column

Description

Date

The day of the period.

Hour

The hour of the period. 0 to 23 are acceptable values. For report by day, use 0.

Peak

The peak license count for the period. This is the total number of licenses in use as logged in the LPORT field.

Peak_ep

The maximum number of endpointer licenses in use at any one time during the Hour, or during a single hour of that day.

This column only appears in Recognizer license usage reports.

Peak_rec

The number of recognizer licenses in use at any one time during the Hour, or during a single hour of that day.

This column only appears in Recognizer license usage reports.

Ports

Total number of ports used during that period. This will equal the number of Recognizer SWIliss events or Vocalizer NVOCliss events in the period.

Overdrafts

The total number of Recognizer SWIliss events or Vocalizer NVOCliss events in the period where LPORT > LMAX.

Minutes

The total number of minutes in the period where licenses were held. For Recognizer this is determined from the LTIME field in the SWIliss and SWIlise events; for Vocalizer this is determined based on the timestamps for the NVOCliss and NVOClise events.

Avg ports

Ports divided by the time period in hours. Limit to 2 decimal places.

Processed files The total number of files in the folder including any incomplete call logs. Does not include empty files.

Grand totals for all days appear at the bottom of the report.