Add and clean up rel_2_1 branch.
[working/Evergreen.git] / reports / report-recurring-report.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="recurring-report" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4 \r
5 <info><title>Running Recurring Reports</title></info>\r
6 \r
7 \r
8     <para>Recurring reports are a useful way to save time by scheduling reports that you run on\r
9         a regular basis, such as monthly circulation and monthly patron registration\r
10         statistics. When you have set up a report to run on a monthly basis you’ll get an email\r
11         informing you that the report has successfully run. You can click on a link in the\r
12         email that will take you directly to the report output. You can also access\r
13         the output through the reporter interface as described in <xref linkend="view-output"\r
14         />.</para>\r
15     \r
16     <para>To set up a monthly recurring report follow the procedure in <xref\r
17         linkend="generate-report"/> but make the changes described below.</para>\r
18     <procedure>\r
19         \r
20         <step>\r
21             \r
22                 <para>Select the <guilabel>Recurring Report</guilabel> check-box and set the\r
23                     recurrence interval to 1 month.</para>\r
24         </step>\r
25         \r
26         <step>\r
27            \r
28                 <para>Do not select <guilabel>Run ASAP</guilabel>. Instead schedule the report\r
29                     to run early on the first day of the next month. Enter the date in\r
30                     YYYY-MM-DD format. </para>\r
31          </step>\r
32         \r
33         <step>\r
34            <para>Ensure there is an email address to receive completion emails. You will\r
35                 receive an email completion notice each month when the output is ready. </para>\r
36          \r
37         </step>\r
38         <step>\r
39             <para>Select a folder for the report’s output. </para>\r
40         </step>\r
41         \r
42         <step>\r
43                 <para>Click <guibutton>Save Report</guibutton>.</para>\r
44         </step>\r
45         <step>\r
46            <para>You will get a confirmation dialogue box that the <guilabel>Action\r
47                 Succeeded</guilabel>. Click <guibutton>OK</guibutton>. </para>\r
48       </step>\r
49     </procedure>\r
50     \r
51     <para> You will get an email on the 1st of each month with a link to the report\r
52         output. By clicking this link it will open the output in a web browser. It is\r
53         still possible to login to the staff client and access the output in\r
54         <guilabel>Output</guilabel> folder. </para>\r
55     \r
56     <formalpara>\r
57         <title>How to stop or make changes to an existing recurring report?</title>\r
58         <para>Sometimes you may wish to stop or make changes to a recurring report, e.g. the\r
59             recurrence interval, generation date, email address to receive completion email,\r
60             output format/folder or even filter values (such as the number of days overdue). You\r
61             will need to delete the current report from the report folder, then use the above\r
62             procedure to set up a new recurring report with the desired changes. Please note\r
63             that deleting a report also deletes all output associated with it.</para>\r
64     </formalpara>\r
65     <tip>\r
66         <para>Once you have been on Evergreen for a year, you could set up your recurring\r
67             monthly reports to show comparative data from one year ago. To do this select \r
68             relative dates of 1 month ago and 13 months ago. </para>\r
69     </tip>\r
70 </chapter>\r