Documentation: Migrate reports documentation from 2.1
[working/Evergreen.git] / docs / reports / reporter_generating_reports.txt
1 [[generating_reports]]\r
2 Generating Reports from Templates\r
3 ----------------------------------\r
4 \r
5 indexterm:[reports, generating]\r
6 \r
7 Now you are ready to run the report from the template you have created.\r
8 \r
9 . In the My Folders section click the arrow next to _Templates_ to expand this \r
10 folder and select _circulation_.\r
11 +\r
12 image::media/generate-report-1.png[generate-report-1]\r
13 +\r
14 . Select the box beside _Circulations by month for one library_. Select _Create a \r
15 new report_ from selected template from the dropdown menu. Click _Submit_. \r
16 +\r
17 image::media/generate-report-2.png[generate-report-2]\r
18 +\r
19 . Complete the first part of report settings. Only _Report Name_ and _Choose a \r
20 folder_... are required fields.\r
21 +\r
22 image::media/generate-report-3.png[generate-report-3]\r
23 +\r
24 1)  _Template Name_, _Template Creator_, and _Template Description_ are for \r
25 informational purposes only. They are hard coded when the template is created. \r
26 At the report definition stage it is not possible to change them.\r
27 +\r
28 2)  _Report Name_ is required. Reports stored in the same folder must have unique \r
29 names.\r
30 +\r
31 3) _Report Description_ is optional but may help distinguish among similar \r
32 reports.\r
33 +\r
34 4)  _Report Columns_ lists the columns that will appear in the output. This is \r
35 derived from the template and cannot be changed during report definition.\r
36 +\r
37 5)  _Pivot Label Column_ and _Pivot Data Column_ are optional. Pivot tables are a \r
38 different way to view data. If you currently use pivot tables in MS Excel it is \r
39 better to select an Excel output and continue using pivot tables in Excel.\r
40 +\r
41 6)  You must choose a report folder to store this report definition. Only report \r
42 folders under My Folders are available. Click on the desired folder to select it.\r
43 +\r
44 . Select values for the _Circulation > Check Out Date/Time_. Use the calendar \r
45 widget or manually enter the desired dates, then click Add to include the date \r
46 on the list. You may add multiple dates.\r
47 +\r
48 image::media/generate-report-8.png[generate-report-8]\r
49 +\r
50 The Transform for this field is Year + Month, so even if you choose a specific \r
51 date (2009-10-20) it will appear as the corresponding month only (2009-10).\r
52 +\r
53 It is possible to select *relative dates*. If you select a relative date 1 month \r
54 ago you can schedule reports to automatically run each month. If you want to run \r
55 monthly reports that also show comparative data from one year ago, select a \r
56 relative date 1 month ago, and 13 months ago.\r
57 +\r
58 . Select a value for the _Circulating Library_.\r
59 . Complete the bottom portion of the report definition interface, then click \r
60 _Save_.\r
61 +\r
62 image::media/generate-report-10.png[generate-report-10]\r
63 +\r
64 1) Select one or more output formats. In this example the report output will be \r
65 available as an Excel spreadsheet, an HTML table (for display in the staff \r
66 client or browser), and as a bar chart.\r
67 +\r
68 2) If you want the report to be recurring, check the box and select the \r
69 _Recurrence Interval_ as described in <<recurring_reports,Recurring Reports>>.  \r
70 In this example, as this is a report that will only be run once, the _Recurring \r
71 Report_ box is not checked.\r
72 +\r
73 3) Select _Run_ as soon as possible for immediate output. It is also possible to \r
74 set up reports that run automatically at future intervals.\r
75 +\r
76 4) It is optional to fill out an email address where a completion notice can be \r
77 sent. The email will contain a link to password-protected report output (staff \r
78 login required). If you have an email address in your Local System Administrator \r
79 account it will automatically appear in the email notification box.  However, \r
80 you can enter a different email address or multiple addresses separated by commas.\r
81 +\r
82 . Select a folder for the report's output.\r
83 . You will get a confirmation dialogue box that the Action Succeeded. Click _OK_.\r
84 +\r
85 image::media/generate-report-14.png[generate-report-14]\r
86 +\r
87 Once saved, reports stay there forever unless you delete them.\r