Add Release Notes for Lp 1662535 & Lp 1743783
[working/Evergreen.git] / docs / reports / reporter_generating_reports.adoc
1 [[generating_reports]]
2 Generating Reports from Templates
3 ----------------------------------
4
5 indexterm:[reports, generating]
6
7 Now you are ready to run the report from the template you have created.
8
9 . In the My Folders section click the arrow next to _Templates_ to expand this 
10 folder and select _circulation_.
11 +
12 image::media/generate-report-1.png[generate-report-1]
13 +
14 . Select the box beside _Circulations by month for one library_. Select _Create a 
15 new report_ from selected template from the dropdown menu. Click _Submit_. 
16 +
17 image::media/generate-report-2.png[generate-report-2]
18 +
19 . Complete the first part of report settings. Only _Report Name_ and _Choose a 
20 folder_... are required fields.
21 +
22 image::media/generate-report-3.png[generate-report-3]
23 +
24 1)  _Template Name_, _Template Creator_, and _Template Description_ are for 
25 informational purposes only. They are hard coded when the template is created. 
26 At the report definition stage it is not possible to change them.
27 +
28 2)  _Report Name_ is required. Reports stored in the same folder must have unique 
29 names.
30 +
31 3) _Report Description_ is optional but may help distinguish among similar 
32 reports.
33 +
34 4)  _Report Columns_ lists the columns that will appear in the output. This is 
35 derived from the template and cannot be changed during report definition.
36 +
37 5)  _Pivot Label Column_ and _Pivot Data Column_ are optional. Pivot tables are a 
38 different way to view data. If you currently use pivot tables in MS Excel it is 
39 better to select an Excel output and continue using pivot tables in Excel.
40 +
41 6)  You must choose a report folder to store this report definition. Only report 
42 folders under My Folders are available. Click on the desired folder to select it.
43 +
44 . Select values for the _Circulation > Check Out Date/Time_. Use the calendar 
45 widget or manually enter the desired dates, then click Add to include the date 
46 on the list. You may add multiple dates.
47 +
48 image::media/generate-report-8.png[generate-report-8]
49 +
50 The Transform for this field is Year + Month, so even if you choose a specific 
51 date (2009-10-20) it will appear as the corresponding month only (2009-10).
52 +
53 It is possible to select *relative dates*. If you select a relative date 1 month 
54 ago you can schedule reports to automatically run each month. If you want to run 
55 monthly reports that also show comparative data from one year ago, select a 
56 relative date 1 month ago, and 13 months ago.
57 +
58 . Select a value for the _Circulating Library_.
59 . Complete the bottom portion of the report definition interface, then click 
60 _Save_.
61 +
62 image::media/generate-report-10.png[generate-report-10]
63 +
64 1) Select one or more output formats. In this example the report output will be 
65 available as an Excel spreadsheet, an HTML table (for display in the staff 
66 client or browser), and as a bar chart.
67 +
68 2) If you want the report to be recurring, check the box and select the 
69 _Recurrence Interval_ as described in <<recurring_reports,Recurring Reports>>.  
70 In this example, as this is a report that will only be run once, the _Recurring 
71 Report_ box is not checked.
72 +
73 3) Select _Run_ as soon as possible for immediate output. It is also possible to 
74 set up reports that run automatically at future intervals.
75 +
76 4) It is optional to fill out an email address where a completion notice can be 
77 sent. The email will contain a link to password-protected report output (staff 
78 login required). If you have an email address in your Local System Administrator 
79 account it will automatically appear in the email notification box.  However, 
80 you can enter a different email address or multiple addresses separated by commas.
81 +
82 . Select a folder for the report's output.
83 . You will get a confirmation dialogue box that the Action Succeeded. Click _OK_.
84 +
85 image::media/generate-report-14.png[generate-report-14]
86 +
87 Once saved, reports stay there forever unless you delete them.
88
89 Viewing and Editing Report Parameters
90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
92 New options to view or edit report parameters are available from the reports folder.
93
94 To view the parameters of a report, select the report that you want to view from the *Reports* folder, and click *View*.  This will enable you to view the report, including links to external documentation and field hints.  However, you cannot make any changes to the report.
95
96 image::media/2_7_Enhancements_to_Reports4.jpg[Reports4]
97
98
99 To edit the parameters of a report, select the report that you want to view from the *Reports* folder, and click *Edit*.  After making changes, you can *Save [the] Report* or *Save as New*.  If you *Save the Report*, any subsequent report outputs that are generated from this report will reflect the changes that you have made.
100
101 In addition, whenever there is a pending (scheduled, but not yet started) report output, the interface will warn you that the pending output will be modified.  At that point, you can either continue or choose the alternate *Save as New* option, leaving the report output untouched.
102
103
104 image::media/2_7_Enhancements_to_Reports6.jpg[Reports6]
105
106
107 If, after making changes, you select, *Save as New*, then you have created a new report by cloning and amending a previously existing report. Note that if you create a new report, you will be prompted to rename the new report. Evergreen does not allow two reports with the same name to exist. To view or edit your new report,  select the reports folder to which you saved it.
108
109 image::media/2_7_Enhancements_to_Reports5.jpg[Reports5]