Add reports and media to master.
[working/Evergreen.git] / reports / report-generate-report.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="generate-report" xreflabel="Generating Reports from Templates"\r
3     xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
4     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
5 \r
6     <info>\r
7 \r
8         <title>Generating Reports from Templates</title>\r
9     </info>\r
10 \r
11     <para>Now you are ready to run the report from the template you have created. </para>\r
12 \r
13    \r
14         <procedure>\r
15 \r
16             <step>\r
17                 <informalfigure>\r
18                     <para>In the <guilabel>My Folders</guilabel> section click the arrow next to\r
19                             <guimenu>Templates </guimenu>to expand this folder and select\r
20                             <guimenuitem>circulation</guimenuitem>.</para>\r
21 \r
22                     <para><mediaobject>\r
23                         <imageobject>\r
24                             <imagedata scalefit="0" fileref="../media/generate-report-1.png"/>\r
25                         </imageobject>\r
26 \r
27                     </mediaobject></para>\r
28                 </informalfigure>\r
29             </step>\r
30 \r
31             <step>\r
32                 <informalfigure><para>Select the box beside <guilabel>Circulations by month for one\r
33                         library</guilabel>. Select <guimenuitem>Create a new report from selected\r
34                         template </guimenuitem>from the dropdown menu. Click\r
35                         <guibutton>Submit</guibutton>. </para>\r
36 \r
37 \r
38 \r
39                <para> <mediaobject>\r
40                     <imageobject>\r
41                         <imagedata scalefit="0" fileref="../media/generate-report-2.png"/>\r
42                     </imageobject>\r
43 \r
44                 </mediaobject></para></informalfigure>\r
45             </step>\r
46             <step>\r
47                 <informalfigure>\r
48                     <para>Complete the first part of report settings. Only <guilabel>Report\r
49                         Name</guilabel> <inlinemediaobject>\r
50                             <imageobject>\r
51                                 <imagedata scalefit="0" fileref="../../media/1.png"/>\r
52                             </imageobject>\r
53                         </inlinemediaobject> and <guilabel>Choose a folder...</guilabel> <inlinemediaobject>\r
54                             <imageobject>\r
55                                 <imagedata scalefit="0" fileref="../../media/6.png"/>\r
56                             </imageobject>\r
57                         </inlinemediaobject> are required\r
58                         fields.</para>\r
59 \r
60                     <para><mediaobject>\r
61                         <imageobject>\r
62                             <imagedata scalefit="0" fileref="../media/generate-report-3.png"/>\r
63                         </imageobject>\r
64                     </mediaobject></para>\r
65                 </informalfigure>\r
66 \r
67                 <para>\r
68                     <inlinemediaobject>\r
69                         <imageobject>\r
70                             <imagedata scalefit="0" fileref="../../media/1.png"/>\r
71                         </imageobject>\r
72                     </inlinemediaobject>\r
73                     <guilabel>Template Name, Template Creator</guilabel>, and <guilabel>Template\r
74                         Description</guilabel> are for informational purposes only. They are hard\r
75                     coded when the template is created. At the report definition stage it is not\r
76                     possible to change them.</para>\r
77 \r
78 \r
79                 <para>\r
80                     <inlinemediaobject>\r
81                         <imageobject>\r
82                             <imagedata scalefit="0" fileref="../../media/2.png"/>\r
83                         </imageobject>\r
84                     </inlinemediaobject>\r
85                     <guilabel>Report Name</guilabel> is required. Reports stored in the same folder\r
86                     must have unique names.</para>\r
87 \r
88 \r
89                 <para>\r
90                     <inlinemediaobject>\r
91                         <imageobject>\r
92                             <imagedata scalefit="0" fileref="../../media/3.png"/>\r
93                         </imageobject>\r
94                     </inlinemediaobject>\r
95                     <guilabel>Report Description</guilabel> is optional but may help distinguish\r
96                     among similar reports. </para>\r
97 \r
98                 <para>\r
99                     <inlinemediaobject>\r
100                         <imageobject>\r
101                             <imagedata scalefit="0" fileref="../../media/4.png"/>\r
102                         </imageobject>\r
103                     </inlinemediaobject>\r
104                     <guilabel>Report Columns</guilabel> lists the columns that will appear in the\r
105                     output. This is derived from the template and cannot be changed during report\r
106                     definition.</para>\r
107 \r
108                 <para>\r
109                     <inlinemediaobject>\r
110                         <imageobject>\r
111                             <imagedata scalefit="0" fileref="../../media/5.png"/>\r
112                         </imageobject>\r
113                     </inlinemediaobject>\r
114                     <guilabel>Pivot Label Column</guilabel> and <guilabel>Pivot Data\r
115                         Column</guilabel> are optional. Pivot tables are a different way to view\r
116                     data. If you currently use pivot tables in <application>MS Excel</application>\r
117                     it is better to select an <application>Excel</application> output and continue\r
118                     using pivot tables in <application> Excel</application>.</para>\r
119 \r
120                 <para>\r
121                     <inlinemediaobject>\r
122                         <imageobject>\r
123                             <imagedata scalefit="0" fileref="../../media/6.png"/>\r
124                         </imageobject>\r
125                     </inlinemediaobject> You must choose a report folder to store this report\r
126                     definition. Only report folders under <guilabel>My Folders</guilabel> are\r
127                     available. Click on the desired folder to select it.</para>\r
128 \r
129             </step>\r
130            \r
131 \r
132             <step>\r
133                 <informalfigure>\r
134                     <para>Select values for the <guilabel>Circulation > Check Out\r
135                             Date/Time</guilabel>. Use the calendar widget or manually enter the\r
136                         desired dates, then click <guibutton>Add</guibutton> to include the date on\r
137                         the list. You may add multiple dates.</para>\r
138                     <para>\r
139                         <mediaobject>\r
140                             <imageobject>\r
141                                 <imagedata scalefit="0" fileref="../media/generate-report-8.png"/>\r
142 \r
143                             </imageobject>\r
144                         </mediaobject>\r
145                     </para>\r
146                 </informalfigure>\r
147                 <para>The <guilabel>Transform</guilabel> for this field is <guilabel>Year +\r
148                         Month</guilabel>, so even if you choose a specific date (2009-10-20) it will\r
149                     appear as the corresponding month only (2009-10).</para>\r
150 \r
151                 <para>It is possible to select <emphasis role="bold">relative dates</emphasis>. If\r
152                     you select a relative date <emphasis>1 month ago</emphasis> you can schedule\r
153                     reports to automatically run each month. If you want to run monthly reports that\r
154                     also show comparative data from one year ago, select a relative date <emphasis>1\r
155                         month ago</emphasis>, and <emphasis>13 months ago</emphasis>. </para>\r
156 \r
157             </step>\r
158 \r
159 \r
160 \r
161             <step>\r
162                     <para>Select a value for the <guilabel>Circulating Library</guilabel>.</para>\r
163                 </step>\r
164 \r
165             <step>\r
166                 <informalfigure>\r
167                     <para>Complete the bottom portion of the report definition interface, then click\r
168                             <guibutton>Save</guibutton>.</para>\r
169 \r
170                     <para>\r
171                         <mediaobject>\r
172                             <imageobject>\r
173                                 <imagedata scalefit="0" fileref="../media/generate-report-10.png"/>\r
174                             </imageobject>\r
175                         </mediaobject>\r
176                     </para>\r
177                 </informalfigure>\r
178 \r
179                 <para>\r
180                     <inlinemediaobject>\r
181                         <imageobject>\r
182                             <imagedata scalefit="0" fileref="../../media/1.png"/>\r
183                         </imageobject>\r
184                     </inlinemediaobject> Select one or more output formats. In this example the\r
185                     report output will be available as an <application>Excel</application>\r
186                     spreadsheet, an HTML table (for display in the staff client or browser), and as\r
187                     a bar chart.</para>\r
188 \r
189 \r
190                 <para>\r
191                     <inlinemediaobject>\r
192                         <imageobject>\r
193                             <imagedata scalefit="0" fileref="../../media/2.png"/>\r
194                         </imageobject>\r
195                     </inlinemediaobject> If you want the report to be recurring, check the box and\r
196                     select the <guilabel>Recurrence Interval</guilabel> as described in <link\r
197                         linkend="recurring-report">Recurring Reports</link>. ¬†In this\r
198                     example, as this is a report that will only be run once, the <guilabel>Recurring\r
199                         Report</guilabel> box is not checked. </para>\r
200 \r
201 \r
202                 <para>\r
203                     <inlinemediaobject>\r
204                         <imageobject>\r
205                             <imagedata scalefit="0" fileref="../../media/3.png"/>\r
206                         </imageobject>\r
207                     </inlinemediaobject> Select <guilabel>Run as soon as possible</guilabel> for\r
208                     immediate output. It is also possible to set up reports that run automatically\r
209                     at future intervals. </para>\r
210 \r
211                 <para>\r
212                     <inlinemediaobject>\r
213                         <imageobject>\r
214                             <imagedata scalefit="0" fileref="../../media/4.png"/>\r
215                         </imageobject>\r
216                     </inlinemediaobject> It is optional to fill out an email address where a\r
217                     completion notice can be sent. The email will contain a link to\r
218                     password-protected report output (staff login required). If you have an email\r
219                     address in your Local System Administrator account it will automatically appear\r
220                     in the email notification box. ¬†However, you can enter a different email address\r
221                     or multiple addresses separated by commas.</para>\r
222 \r
223                 <para>\r
224                     <inlinemediaobject>\r
225                         <imageobject>\r
226                             <imagedata scalefit="0" fileref="../../media/5.png"/>\r
227                         </imageobject>\r
228                     </inlinemediaobject> Select a folder for the report's output.</para>\r
229 \r
230             </step>\r
231 \r
232 \r
233 \r
234 \r
235 \r
236 \r
237             <step>\r
238                 <informalfigure>\r
239                     <para>You will get a confirmation dialogue box that the <guilabel>Action\r
240                             Succeeded</guilabel>. Click <guibutton>OK</guibutton>. </para>\r
241 \r
242                     <para>\r
243                         <mediaobject>\r
244                             <imageobject>\r
245                                 <imagedata scalefit="0" fileref="../media/generate-report-14.png"/>\r
246                             </imageobject>\r
247 \r
248                         </mediaobject>\r
249                     </para>\r
250                 </informalfigure>\r
251             </step>\r
252         </procedure>\r
253 \r
254         <para>Once saved, reports stay there forever unless you delete them.</para>\r
255 \r
256 \r
257   \r
258 \r
259 \r
260    \r
261 \r
262 \r
263 \r
264 \r
265 \r
266 </chapter>\r