Create and clean up 2.0 branch.

[Evergreen-DocBook.git] / reports / report-recurring-report.xml

diff --git a/reports/report-recurring-report.xml b/reports/report-recurring-report.xml
new file mode 100644 (file)
index 0000000..307e363
--- /dev/null
+++ b/reports/report-recurring-report.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>\r
+<chapter xml:id="recurring-report" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
+\r
+<info><title>Running Recurring Reports</title></info>\r
+\r
+\r
+    <para>Recurring reports are a useful way to save time by scheduling reports that you run on\r
+        a regular basis, such as monthly circulation and monthly patron registration\r
+        statistics. When you have set up a report to run on a monthly basis you’ll get an email\r
+        informing you that the report has successfully run. You can click on a link in the\r
+        email that will take you directly to the report output. You can also access\r
+        the output through the reporter interface as described in <xref linkend="view-output"\r
+        />.</para>\r
+    \r
+    <para>To set up a monthly recurring report follow the procedure in <xref\r
+        linkend="generate-report"/> but make the changes described below.</para>\r
+    <procedure>\r
+        \r
+        <step>\r
+            \r
+                <para>Select the <guilabel>Recurring Report</guilabel> check-box and set the\r
+                    recurrence interval to 1 month.</para>\r
+        </step>\r
+        \r
+        <step>\r
+           \r
+                <para>Do not select <guilabel>Run ASAP</guilabel>. Instead schedule the report\r
+                    to run early on the first day of the next month. Enter the date in\r
+                    YYYY-MM-DD format. </para>\r
+        </step>\r
+        \r
+        <step>\r
+           <para>Ensure there is an email address to receive completion emails. You will\r
+                receive an email completion notice each month when the output is ready. </para>\r
+         \r
+        </step>\r
+        <step>\r
+            <para>Select a folder for the report’s output. </para>\r
+        </step>\r
+        \r
+        <step>\r
+                <para>Click <guibutton>Save Report</guibutton>.</para>\r
+        </step>\r
+        <step>\r
+           <para>You will get a confirmation dialogue box that the <guilabel>Action\r
+                Succeeded</guilabel>. Click <guibutton>OK</guibutton>. </para>\r
+      </step>\r
+    </procedure>\r
+    \r
+    <para> You will get an email on the 1st of each month with a link to the report\r
+        output. By clicking this link it will open the output in a web browser. It is\r
+        still possible to login to the staff client and access the output in\r
+        <guilabel>Output</guilabel> folder. </para>\r
+    \r
+    <formalpara>\r
+        <title>How to stop or make changes to an existing recurring report?</title>\r
+        <para>Sometimes you may wish to stop or make changes to a recurring report, e.g. the\r
+            recurrence interval, generation date, email address to receive completion email,\r
+            output format/folder or even filter values (such as the number of days overdue). You\r
+            will need to delete the current report from the report folder, then use the above\r
+            procedure to set up a new recurring report with the desired changes. Please note\r
+            that deleting a report also deletes all output associated with it.</para>\r
+    </formalpara>\r
+    <tip>\r
+        <para>Once you have been on Evergreen for a year, you could set up your recurring\r
+            monthly reports to show comparative data from one year ago. To do this select \r
+            relative dates of 1 month ago and 13 months ago. </para>\r
+    </tip>\r
+</chapter>\r