Advanced reporting options
The table below describes the advanced reporting configuration keys that are available. To edit a configuration key:
-
Click the Options tab. The General page is displayed.
-
In the Actions menu, click Config editor (advanced).
The Config EditorThe Config Editor stores information used by PaperCut to configure advanced options and functions. This information is stored in config keys, which are editable by an administrator. page is displayed.
| Config name | Description |
|---|---|
| schedule.daily-maintenence-reports |
The schedule.daily-maintenence config keyA config key stores information about a specific advanced setting in PaperCut. Config keys are editable by an administrator in the Config Editor. must have a valid value for the scheduled reports to run. The default value for this config key is 0 55 0 * * ?, which runs at 12:55 am daily. To run the reports independently of the other maintenance tasks at a different time, set the config key schedule.daily-maintenence-reports instead. Make sure that there's a significant time gap between the two (for example, schedule the maintenance at night and the reports during business hours). If both activities are scheduled too close to each other, they might run in parallel. For more information, see Change the schedule timing. |
| scheduled-reports.day-of-week | The day of the week when the weekly and fortnightly scheduled reports are run. By default, the weekly and fortnightly scheduled reports are set to run on Sunday (default value is Sun). The valid format for this value is DDD and includes Sun, Mon, Tue, Wed, Thu, Fri, Sat. |
| scheduled-reports.day-of-month | The day of the month when the monthly scheduled reports are run. By default, the monthly scheduled reports are set to run on the first day of the month (default value is 1). Valid values include 1 to 28. For example, if you change the value to 5, the monthly reports will run on the 5th of every month, and will include data from the 5th of the previous month, to the 4th of the current month. |
| scheduled-reports.quarterly-start-month | The month in the first quarter when the quarterly scheduled reports are run. By default, the quarterly scheduled reports are set to run on the first day of January, April, July, and October (default value is Jan). The valid format for this value is MMM. For example, if you change the value to Nov, the quarterly reports will run on the first day in November, February, May, and August. The November quarterly report will include data from August 1st to October 31st. |
| scheduled-reports.yearly-date | The date in a year when the yearly scheduled reports are run. By default, the yearly scheduled reports are set to run on the first day of the year (default value is Jan-01). The valid format for this value is MMM-DD or MMM-D. For example, if you change the value to Jul-01, the yearly reports will run on at 12.55am on July 1st every year, and will include data from July 1st to June 30 the following year. |
| reports.max-rows | The maximum number of rows that a report produces. Once the number of rows in a report reaches this value, the data in the report is cut short (and the report will contain a message to indicate this has happened). This is a 'sanity limit', intended to avoid producing overly large reports by accident. The default value is 10000. |
| reports.top-x-rows | The number of rows to display in 'top X' reports, such as the Largest print users report. The default value is 100. |
| reports.csv-display-comment-headers | Determines whether to display the comment headers in CSV reports (e.g. The report name and report parameters in the first few rows of the file). You might want to remove the headers if the CSV files are to be post processed or imported into a 3rd party system, such as an accounts database. To display comment headers set the value to Y, to hide set the value to N. |
For more information about how to change config keys, see Using the Advanced Config Editor