Command line

Click to Display Table of Contents

Navigation:  Operation > Tools > Report Generator >

Command line

Report Generator supports command line to allow automatically creating the reports. It can be called using the run scheduler command.

 

Command line format

ReportViewer.exe --create=Filename|Format|DateFrom|DateTo|Type|Fields

 

Parameters

Filename - report file name with no extension

Format - CSV or PDF

DateFrom - starting report date in ISO format (YYYY-MM-DD, e.g. 2023-12-30)

DateTo - end report date in ISO format

Type - List or Playcount

Fields (optional) - list of fields to include in the report (a list of numbers, comma separated); if not included, default field set it used

 

Fields

0 - Title

1 - Artist

2 - Album

3 - Year

4 - Genre

5 - Comment

6 - Playcount

7 - Length

8 - Start date/time

9 - Start date

10 - Start time

11 - Listeners

12 - Filename

13 - Total length

14 - Language

15 - Publisher

16 - Album artist

17 - Composer

18 - Copyright

 

End of the month (for DateTo parameter)

Specify 00 (two zeroes) as the day to specify end of the month, for instance: 2023-01-00 will convert to 2023-01-31. This is useful when the month is not known in advance, e.g. when using file name templates (see examples below).

 

Example command line

C:\Program Files\RadioBOSS\ReportViewer.exe --create=C:\report|PDF|2023-01-01|2023-01-31|List

 

Example command line specifying fields (title, artist, playcount)

C:\Program Files\RadioBOSS\ReportViewer.exe --create=C:\report|PDF|2023-01-01|2023-01-31|List|0,1,6

 

Example using the "run" scheduler command (no need to specify full path to .exe file in this case)

run ReportViewer.exe --create=C:\report|PDF|2023-01-01|2023-01-31|List

 

Example using the "run" scheduler command with file name templates to create monthly reports automatically

run ReportViewer.exe --create=C:\report-?yyyy-?mm|PDF|?yyyy-?mm-01|?yyyy-?mm-00|List