]> git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/reports/reporter_running_recurring_reports.txt
LP1288938 - stamping upgrade script
[working/Evergreen.git] / docs / reports / reporter_running_recurring_reports.txt
1 [[recurring_reports]]
2 Running Recurring Reports
3 -------------------------
4
5 indexterm:[reports, recurring]
6
7 Recurring reports are a useful way to save time by scheduling reports that you 
8 run on a regular basis, such as monthly circulation and monthly patron 
9 registration statistics. When you have set up a report to run on a monthly basis 
10 you’ll get an email informing you that the report has successfully run. You can 
11 click on a link in the email that will take you directly to the report output. 
12 You can also access the output through the reporter interface as described in 
13 <<viewing_report_output,Viewing Report Output>>.
14
15 To set up a monthly recurring report follow the procedure in <<generating_reports,
16 Generating Reports from Templates>>  but make the changes described below.
17
18 . Select the Recurring Report check-box and set the recurrence interval to 1 month.
19 . Do not select Run ASAP. Instead schedule the report to run early on the first 
20 day of the next month. Enter the date in _YYYY-MM-DD_ format.
21 . Ensure there is an email address to receive completion emails. You will 
22 receive an email completion notice each month when the output is ready.
23 . Select a folder for the report’s output.
24 . Click Save Report.
25 . You will get a confirmation dialogue box that the Action Succeeded. Click OK.
26
27 You will get an email on the 1st of each month with a link to the report output. 
28 By clicking this link it will open the output in a web browser. It is still 
29 possible to login to the staff client and access the output in Output folder.
30
31 *How to stop or make changes to an existing recurring report?*  Sometimes you may 
32 wish to stop or make changes to a recurring report, e.g. the recurrence interval, 
33 generation date, email address to receive completion email, output format/folder 
34 or even filter values (such as the number of days overdue). You will need to 
35 delete the current report from the report folder, then use the above procedure 
36 to set up a new recurring report with the desired changes. Please note that 
37 deleting a report also deletes all output associated with it.
38
39 TIP: Once you have been on Evergreen for a year, you could set up your recurring 
40 monthly reports to show comparative data from one year ago. To do this select 
41 relative dates of 1 month ago and 13 months ago.
42