Scheduling and Emailing Reports

The one-click reports in the PaperCut NG web interface are good for finding important data fast, however sometimes it is more convenient to have important data 'pushed' to interested parties. This can be achieved through the use of scheduled reports.

PaperCut NG can schedule reports to run periodically and have them automatically sent out via email. Scheduling reports can be used for a variety of purposes, for example:

Usage

The scheduled reports page can be found at ReportsScheduled Reports.

Important

Before scheduled reports can be sent via email, PaperCut NG needs to know where to find the SMTP server (outgoing email server). For information about how to configure email sending, see the section called “Configuring Email Notifications”.

The Scheduled Reports page

Figure 9.5.  The Scheduled Reports page

To create a scheduled report, choose the desired report options and press Add. The process is best described by way of example:

Example 1: Faculty based reporting in education

Joe is head of the science faculty at a university. Faculty staff have the ability to charge printing back to the faculty. Joe would like to see, on a regular basis, how much printing each user charges to the faculty.

To do this:

  1. Navigate to the Scheduled Reports page.

  2. Click Schedule a new report... if the panel is not already displayed.

  3. Choose the report Type of Shared account printing - user summary.

  4. Under Optional parametersAccount name, enter Joe's faculty shared account name, Science.

  5. Change the report title to "Science Faculty Account Printing".

  6. Leave the report Format as PDF.

  7. Make the report deliverable every week by setting Send report to Weekly.

  8. Enter Joe's email address under Recipients.

  9. Press Add.

The report is now scheduled to run every week, and should now be shown in the table below. Joe will receive an email every Sunday showing the previous week's printing in his faculty. To find out exactly when the report will be sent, see the section called “Details”. To see an example of what the report will look like, press [show example] next to the report. To manually run the report (generate it and email to Joe now), press [run now]. The

The [run now] operation also provides a convenient way to resend the previous period's report if the original delivery failed or if the email was accidentally deleted.

Example 2: Division based reporting in business

Mary is head of marketing division at a company. She would like to see which printers her staff use most, to make decisions about printer redistribution and purchasing. Also of interest are the sizes of paper being used, and how much color printing is being performed.

To do this:

  1. Navigate to the Scheduled Reports page.

  2. Click Schedule a new report... if the panel is not already displayed.

  3. Choose the report Type of Group printing - printer summary.

  4. Under Optional parametersGroup name, enter Mary's division group name, Marketing.

  5. Leave the report Format as PDF.

  6. Make the report deliverable every fortnight by setting Send report to Fortnightly.

  7. Enter Mary's email under Recipients.

  8. Press Add.

The report is now scheduled to run every fortnight, and should now be shown in the table below. Mary will receive an email every second Sunday showing the previous fortnight's printer usage by her division.

Details

Each report Period determines when the report will run. When the report includes date based usage information (such as printing usage), the period also determines the date range of the data to include.

PeriodReport Run TimeReport Date Range

Daily

Early every morning, about 01:15.

The previous day.

Weekly

Every Sunday in the early morning, about 01:15.

The previous week, from Sunday to Saturday

Fortnightly

Every second Sunday in the early morning, about 01:15. Fortnightly reports are run on even weeks, i.e. the second week of the year, the fourth week of the year, etc.

The previous fortnight, from two Sundays ago to Saturday.

Monthly

Early morning on the first day of every month, about 01:15.

The previous month.

Table 9.2. Scheduled reports delivery times

Tip

If a user has their email address set in PaperCut NG, their username can be entered in the Recipients instead. For example, instead of entering [email protected], entering just joe will work.