Add reports and media to master.
[working/Evergreen.git] / reports / report-create-template.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="create-template" 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>\r
6         <title>Creating Templates</title>\r
7     </info>\r
8 \r
9     <para>Once you have created a folder, the next step in building a report is to create or clone a\r
10         template. Templates allow you to run a report more than once without building it anew every\r
11         time, by changing definitions to suit current requirements. For example, you can create a\r
12         shared template that reports on circulation at a given library. Then, other libraries can\r
13         use your template and simply select their own library when they run the report.</para>\r
14 \r
15     <para>It may take several tries to refine a report to give the output that you want. It can be\r
16         useful to plan out your report on paper before getting started with the reporting tool.\r
17         Group together related fields and try to identify the key fields that will help you select\r
18         the correct <emphasis>source</emphasis>. </para>\r
19 \r
20     <para>It may be useful to create complex queries in several steps. For example, first add all\r
21         fields from the table at the highest source level. Run a report and check to see that you\r
22         get results that seem reasonable. Then clone the report, add any filters on fields at that\r
23         level and run another report. Then drill down to the next table and add any required fields.\r
24         Run another report. Add any filters at that level. Run another report. Continue until you’ve\r
25         drilled down to all the fields you need and added all the filters. This might seem time\r
26         consuming and you will end up cloning your initial report several times. However, it will\r
27         help you to check the correctness of your results, and will help to debug if you run into\r
28         problems because you will know exactly what changes caused the problem. Also consider adding\r
29         extra fields in the intermediate steps to help you check your results for correctness. </para>\r
30 \r
31     <para>This example illustrates creating a template for circulation statistics. This is an\r
32         example of the most basic template that you can create. The steps required to create a\r
33         template are the same every time, but the tables chosen, how the data is transformed and\r
34         displayed, and the filters used will vary depending on your needs. </para>\r
35 \r
36     <section xml:id="create-template-choosing">\r
37         <info>\r
38             <title>Choosing Report Fields</title>\r
39         </info>\r
40 \r
41 \r
42         <procedure>\r
43             <step>\r
44 \r
45 \r
46                 <informalfigure>\r
47                     <para>Click on the <guilabel>My Folder</guilabel> template folder where you want\r
48                         the template to be saved.</para>\r
49                     <para>\r
50                         <mediaobject>\r
51                             <alt>Screenshot of staff client report interface</alt>\r
52                             <imageobject>\r
53                                 <imagedata scalefit="0" fileref="../media/create-template-1.png"/>\r
54                             </imageobject>\r
55 \r
56                         </mediaobject>\r
57                     </para>\r
58                 </informalfigure>\r
59             </step>\r
60 \r
61             <step>\r
62 \r
63                 <informalfigure>\r
64                     <para>Click on <guilabel>Create a new Template for this\r
65                         folder</guilabel>.</para>\r
66                    <para> <mediaobject>\r
67                         <alt>Screenshot of staff client report interface</alt>\r
68                         <imageobject>\r
69                             <imagedata scalefit="0" fileref="../media/create-template-2.png"/>\r
70                         </imageobject>\r
71 \r
72                     </mediaobject></para>\r
73                 </informalfigure>\r
74             </step>\r
75 \r
76             <step>\r
77 \r
78                 <informalfigure>\r
79                     <para>You can now see the template creating interface. The upper half of the\r
80                         screen is the <guilabel>Database Source Browser</guilabel>. The top left\r
81                         hand pane contains the database <guilabel>Sources</guilabel> drop-down list.\r
82                         This is the list of tables available as a starting point for your report.\r
83                         Commonly used sources are <guimenuitem>Circulation</guimenuitem> (for circ\r
84                         stats and overdue reports), <guimenuitem>ILS User</guimenuitem> (for patron\r
85                         reports), and <guimenuitem>Item</guimenuitem> (for reports on a library's\r
86                         holdings).</para>\r
87                     <para>\r
88                         <mediaobject>\r
89                             <alt>Screenshot of staff client report interface</alt>\r
90                             <imageobject>\r
91                                 <imagedata width="100%" scalefit="1"\r
92                                     fileref="../media/create-template-3.png"/>\r
93                             </imageobject>\r
94                         </mediaobject>\r
95                     </para>\r
96                 </informalfigure>\r
97                 <para>The <guilabel>Enable source nullability</guilabel> checkbox below the sources\r
98                     list is for advanced reporting and should be left unchecked by default.</para>\r
99 \r
100             </step>\r
101 \r
102 \r
103             <step>\r
104 \r
105                 <informalfigure>\r
106                     <para>Select <guimenuitem>Circulation</guimenuitem> in the <guimenu>Sources\r
107                         </guimenu> dropdown menu. Note that the <guimenuitem>Core\r
108                             Sources</guimenuitem> for reporting are listed first, however it is\r
109                         possible to access all available sources at the bottom of this dropdown\r
110                         menu. You may only specify one source per template.</para>\r
111                     <para>\r
112                         <mediaobject>\r
113                             <alt>Screenshot of staff client report interface</alt>\r
114                             <imageobject>\r
115                                 <imagedata scalefit="0" fileref="../media/create-template-4.png"/>\r
116                             </imageobject>\r
117 \r
118                         </mediaobject>\r
119                     </para>\r
120                 </informalfigure>\r
121             </step>\r
122 \r
123             <step>\r
124 \r
125 \r
126                 <informalfigure>\r
127                     <para>Click on <guilabel>Circulation</guilabel> to retrieve all the field names\r
128                         in the <guilabel>Field Name</guilabel> pane. Note that the <guilabel>Source\r
129                             Specifier</guilabel> (above the middle and right panes) shows the path\r
130                         that you took to get to the specific field. </para>\r
131                    <para> <mediaobject>\r
132                         <alt>Screenshot of staff client report interface</alt>\r
133                         <imageobject>\r
134                             <imagedata width="100%" scalefit="1"\r
135                                 fileref="../media/create-template-5.png"/>\r
136                         </imageobject>\r
137 \r
138                     </mediaobject></para>\r
139                 </informalfigure>\r
140 \r
141 \r
142 \r
143             </step>\r
144 \r
145             <step>\r
146                 <informalfigure>\r
147                     <para>Select <guimenuitem>Circ ID</guimenuitem> in the middle <guilabel>Field\r
148                             Name</guilabel> pane, and <guimenuitem>Count Distinct</guimenuitem> from\r
149                         the right <guilabel>Field Transform</guilabel> pane. The <guilabel>Field\r
150                             Transform</guilabel> pane is where you choose how to manipulate the data\r
151                         from the selected fields. You are counting the number of\r
152                         circulations.</para>\r
153                     <para><mediaobject>\r
154                         <alt>Screenshot of staff client report interface</alt>\r
155                         <imageobject>\r
156                             <imagedata width="100%" scalefit="1"\r
157                                 fileref="../media/create-template-6.png"/>\r
158                         </imageobject>\r
159 \r
160                     </mediaobject></para>\r
161 \r
162                 </informalfigure>\r
163                 <para><guilabel>Field Transforms</guilabel> have either an\r
164                         <guilabel>Aggregate</guilabel> or <guilabel>Non-Aggregate</guilabel> output\r
165                     type. See <xref linkend="create-template-transforms"/> for more about\r
166                         <guilabel>Count, Count Distinct,</guilabel> and other transform\r
167                     options.</para>\r
168 \r
169             </step>\r
170 \r
171             <step>\r
172                 <informalfigure>\r
173                     <para>Click <guibutton>Add Selected Fields</guibutton> underneath the\r
174                             <guilabel>Field Transform</guilabel> pane to add this field to your\r
175                         report output. Note that <guimenuitem>Circ ID</guimenuitem> now shows up in\r
176                         the bottom left hand pane under the <guilabel>Displayed Fields</guilabel>\r
177                         tab. </para>\r
178                     <para><mediaobject>\r
179                         <alt>Screenshot of staff client report interface</alt>\r
180                         <imageobject>\r
181                             <imagedata width="100%" scalefit="1"\r
182                                 fileref="../media/create-template-7.png"/>\r
183                         </imageobject>\r
184 \r
185                     </mediaobject></para>\r
186                 </informalfigure>\r
187 \r
188 \r
189             </step>\r
190             <step xml:id="create-template-step8" xreflabel="Create Templates Step 8">\r
191 \r
192                 <informalfigure>\r
193                     <para><guimenuitem>Circ ID</guimenuitem> will be the column header in the report\r
194                         output. You can rename default display names to something more meaningful.\r
195                         To do so in this example, select the <guimenuitem>Circ ID</guimenuitem> row\r
196                         and click <guibutton>Alter Display Header</guibutton>. </para>\r
197                     <para><mediaobject>\r
198                         <alt>Screenshot of staff client report interface</alt>\r
199                         <imageobject>\r
200                             <imagedata scalefit="0" fileref="../media/create-template-8.png"/>\r
201                         </imageobject>\r
202 \r
203                     </mediaobject></para>\r
204 \r
205                 </informalfigure>\r
206 \r
207 \r
208                 <para>Double-clicking on the displayed field name is a shortcut to altering the\r
209                     display header.</para>\r
210             </step>\r
211             <step>\r
212 \r
213                 <informalfigure>\r
214                     <para>Type in the new column header name, for example <emphasis>Circ\r
215                             count</emphasis> and click <guibutton>OK</guibutton>. </para>\r
216                     <para><mediaobject>\r
217                         <alt>Screenshot of staff client report interface</alt>\r
218                         <imageobject>\r
219                             <imagedata scalefit="0" fileref="../media/create-template-9.png"/>\r
220                         </imageobject>\r
221 \r
222                     </mediaobject></para>\r
223 \r
224                 </informalfigure>\r
225 \r
226 \r
227             </step>\r
228             <step xml:id="create-template-add-field" xreflabel="Step">\r
229                 <para> Add other data to your report by going back to the\r
230                         <guilabel>Sources</guilabel> pane and selecting the desired fields. In this\r
231                     example, we are going to add <menuchoice>\r
232                         <guimenu>Circulating Item</guimenu>\r
233                         <guimenuitem>Shelving Location</guimenuitem>\r
234                     </menuchoice> to further refine the circulation report. </para>\r
235                 <informalfigure>\r
236                     <para>In the top left hand <guilabel>Sources</guilabel> pane, expand\r
237                             <guimenuitem>Circulation</guimenuitem>. Depending on your computer you\r
238                         will either click on the + sign or on an arrow to expand the tree. </para>\r
239                     <para><mediaobject>\r
240                         <alt>Screenshot of staff client report interface</alt>\r
241                         <imageobject>\r
242                             <imagedata scalefit="0" fileref="../media/create-template-10.png"/>\r
243                         </imageobject>\r
244 \r
245                     </mediaobject></para>\r
246 \r
247                 </informalfigure>\r
248 \r
249             </step>\r
250             <step>\r
251 \r
252                 <informalfigure>\r
253                     <para>Click on the + or arrow to expand <guimenuitem>Circulating\r
254                             Item</guimenuitem>. Select <guimenuitem>Shelving Location</guimenuitem>. </para>\r
255                    <para> <mediaobject>\r
256                         <alt>Screenshot of staff client report interface</alt>\r
257                         <imageobject>\r
258                             <imagedata scalefit="0" fileref="../media/create-template-11.png"/>\r
259                         </imageobject>\r
260 \r
261                     </mediaobject></para>\r
262 \r
263                 </informalfigure>\r
264                 <para>When you are creating a template take the shortest path to the field you need\r
265                     in the left hand <guilabel>Sources</guilabel> pane. Sometimes it is possible to\r
266                     find the same field name further in the file structure, but the shortest path is\r
267                     the most efficient. </para>\r
268 \r
269             </step>\r
270 \r
271             <step>\r
272 \r
273                 <informalfigure>\r
274                     <para> In the <guilabel>Field Name</guilabel> pane select\r
275                             <guimenuitem>Name</guimenuitem>. </para>\r
276                    <para> <mediaobject>\r
277                         <alt>Screenshot of staff client report interface</alt>\r
278                         <imageobject>\r
279                             <imagedata width="100%" scalefit="1"\r
280                                 fileref="../media/create-template-12.png"/>\r
281                         </imageobject>\r
282 \r
283                     </mediaobject></para>\r
284 \r
285                 </informalfigure>\r
286 \r
287             </step>\r
288             <step>\r
289                 <informalfigure>\r
290                     <para>In the upper right <guilabel>Field Transform</guilabel> pane, select\r
291                             <guimenuitem>Raw Data</guimenuitem> and click <guibutton>Add Selected\r
292                             Fields</guibutton>. Use <guilabel>Raw Data</guilabel> when you do not\r
293                         wish to transform field data in any manner. </para>\r
294                     <para><mediaobject>\r
295                         <alt>Screenshot of staff client report interface</alt>\r
296                         <imageobject>\r
297                             <imagedata width="100%" scalefit="1"\r
298                                 fileref="../media/create-template-13.png"/>\r
299                         </imageobject>\r
300 \r
301                     </mediaobject></para>\r
302 \r
303                 </informalfigure>\r
304             </step>\r
305 \r
306 \r
307             <step xml:id="create-template-step15" xreflabel="Create Templates Step 15">\r
308                 <informalfigure>\r
309                     <para>\r
310                         <guilabel>Name</guilabel> will appear in the bottom left pane. Select the\r
311                             <guilabel>Name</guilabel> row and click <guibutton>Alter Display\r
312                             Header</guibutton>. </para>\r
313                    <para> <mediaobject>\r
314                         <alt>Screenshot of staff client report interface</alt>\r
315                         <imageobject>\r
316                             <imagedata scalefit="0" fileref="../media/create-template-15.png"/>\r
317                         </imageobject>\r
318 \r
319                     </mediaobject></para>\r
320 \r
321                 </informalfigure>\r
322             </step>\r
323             <step>\r
324                 <informalfigure>\r
325                     <para> Enter a new, more descriptive column header, for example,\r
326                             <emphasis>Shelving location</emphasis>. Click <guibutton>OK</guibutton>. </para>\r
327                     <para><mediaobject>\r
328                         <alt>Screenshot of staff client report interface</alt>\r
329                         <imageobject>\r
330                             <imagedata scalefit="0" fileref="../media/create-template-16.png"/>\r
331                         </imageobject>\r
332 \r
333                     </mediaobject></para>\r
334 \r
335                 </informalfigure>\r
336             </step>\r
337             <step>\r
338                 <informalfigure>\r
339                     <para> Note that the order of rows (top to bottom) will correspond to the order\r
340                         of columns (left to right) on the final report. Select <guimenuitem>Shelving\r
341                             location</guimenuitem> and click on <guibutton>Move Up</guibutton> to\r
342                         move <guimenuitem>Shelving location</guimenuitem> before <guimenuitem>Circ\r
343                             count</guimenuitem>.</para>\r
344                     <para><mediaobject>\r
345                         <alt>Screenshot of staff client report interface</alt>\r
346                         <imageobject>\r
347                             <imagedata scalefit="0" fileref="../media/create-template-17.png"/>\r
348                         </imageobject>\r
349 \r
350                     </mediaobject></para>\r
351 \r
352                 </informalfigure>\r
353             </step>\r
354 \r
355             <step>\r
356                 <informalfigure>\r
357                     <para>Return to the <guilabel>Sources</guilabel> pane to add more fields to your\r
358                         template. Under <guilabel>Sources</guilabel> click\r
359                             <guilabel>Circulation</guilabel>, then select <guilabel>Check Out\r
360                             Date/Time</guilabel> from the middle <guilabel>Field Name</guilabel>\r
361                         pane.</para>\r
362                    <para> <mediaobject>\r
363                         <alt>Screenshot of staff client report interface</alt>\r
364                         <imageobject>\r
365                             <imagedata width="100%" scalefit="1" fileref="../media/create-template-19.png"/>\r
366                         </imageobject>\r
367                     </mediaobject>\r
368 </para>\r
369 \r
370                 </informalfigure>\r
371             </step>\r
372 \r
373             <step>\r
374                 <informalfigure>\r
375                     <para>Select <guimenuitem>Year + Month</guimenuitem> in the right hand\r
376                             <guilabel>Field Transform</guilabel> pane and click <guibutton>Add\r
377                             Selected Fields</guibutton></para>\r
378                    <para> <mediaobject>\r
379                         <alt>Screenshot of staff client report interface</alt>\r
380                         <imageobject>\r
381                             <imagedata width="100%" scalefit="1"\r
382                                 fileref="../media/create-template-20.png"/>\r
383                         </imageobject>\r
384 \r
385                     </mediaobject></para>\r
386 \r
387 \r
388                 </informalfigure>\r
389 \r
390             </step>\r
391             <step>\r
392                 <informalfigure>\r
393                     <para>\r
394                         <guimenuitem>Check Out Date/Time</guimenuitem> will appear in the\r
395                             <guilabel>Displayed Fields</guilabel> pane. In the report it will appear\r
396                         as a year and month (YYYY-MM) corresponding to the selected tranform.</para>\r
397                     <para><mediaobject>\r
398                         <imageobject>\r
399                             <imagedata scalefit="0" fileref="../media/create-template-21.png"/>\r
400                         </imageobject>\r
401                     </mediaobject></para>\r
402                 </informalfigure>\r
403             </step>\r
404 \r
405             <step xml:id="create-template-step22" xreflabel="Create Templates Step 22">\r
406                 <informalfigure>\r
407                     <para>Select the <guimenuitem>Check Out Date/Time</guimenuitem> row. Click\r
408                             <guibutton>Alter Display Header</guibutton> and change the column header\r
409                         to <emphasis>Check out month</emphasis>.</para>\r
410                    <para> <mediaobject>\r
411                         <alt>Screenshot of staff client report interface</alt>\r
412                         <imageobject>\r
413                             <imagedata scalefit="0" fileref="../media/create-template-22.png"/>\r
414                         </imageobject>\r
415 \r
416                     </mediaobject></para>\r
417 \r
418                 </informalfigure>\r
419             </step>\r
420 \r
421             <step>\r
422                 <informalfigure>\r
423                     <para>Move <guimenuitem>Check out month</guimenuitem> to the top of the list\r
424                         using the <guibutton>Move Up</guibutton> button, so that it will be the\r
425                         first column in an MS Excel spreadsheet or in a chart. Report output will\r
426                         sort by the first column.</para>\r
427                     <para><mediaobject>\r
428                         <alt>Screenshot of staff client report interface</alt>\r
429                         <imageobject>\r
430                             <imagedata scalefit="0" fileref="../media/create-template-23.png"/>\r
431                         </imageobject>\r
432 \r
433                     </mediaobject></para>\r
434                 </informalfigure>\r
435             </step>\r
436 \r
437         </procedure>\r
438         <tip>\r
439 \r
440             <informalfigure>\r
441 \r
442                 <para> Note the <guibutton>Change Transform</guibutton> button in the bottom left\r
443                     hand pane. It has the same function as the upper right <guilabel>Field\r
444                         Transform</guilabel> pane for fields that have already been added. </para>\r
445 \r
446 \r
447 \r
448                <para> <mediaobject>\r
449                     <alt>Screenshot of staff client report interface</alt>\r
450                     <imageobject>\r
451                         <imagedata scalefit="0" fileref="../media/create-template-24.png"/>\r
452                     </imageobject>\r
453 \r
454                 </mediaobject></para>\r
455             </informalfigure>\r
456 \r
457 \r
458 \r
459         </tip>\r
460     </section>\r
461 \r
462     <section xml:id="create-template-filters">\r
463         <info>\r
464             <title>Applying Filters</title>\r
465         </info>\r
466 \r
467         <para>Evergreen reports access the entire database, so to limit report output to a single\r
468             library or library system you need to apply filters. </para>\r
469 \r
470         <para>After following the steps in the previous section you will see\r
471             three fields in the bottom left hand <guilabel>Template Configuration</guilabel> pane.\r
472             There are three tabs in this pane: <guilabel>Displayed Fields</guilabel> (covered in the\r
473             previous section), <guilabel>Base Filters</guilabel> and <guilabel>Aggregate\r
474                 Filters</guilabel>. A filter allows you to return only the results that meet the\r
475             criteria you set. </para>\r
476 \r
477         <para><guilabel>Base Filters</guilabel> apply to non-aggregate output types, while \r
478                 <guilabel>Aggregate Filters</guilabel> are used for aggregate types.  In most reports you will be using the\r
479                 <guilabel>Base Filters</guilabel> tab. For more information on\r
480                 aggregate and non-aggregate types see\r
481                 <xref linkend="create-template-transforms"/>. </para>\r
482 \r
483 \r
484         \r
485                \r
486         <para>There are many available <guilabel>operators</guilabel> when using filters. Some\r
487             examples are <emphasis>Equals</emphasis>, <emphasis>In list</emphasis>, <emphasis>is\r
488                 NULL</emphasis>, <emphasis>Betwee</emphasis>, <emphasis>Greater than or equal\r
489                 to</emphasis>, and so on. <emphasis>In list</emphasis> is the most flexible\r
490             operator, and in this case will allow you flexibility when running a report from this\r
491             template. For example, it would be possible to run a report on a list of timestamps (in\r
492             this case will be trimmed to year and month only), run a report on a single month, or\r
493             run a report comparing two months. It is also possible to set up recurring reports to\r
494             run at the end of each month.</para>\r
495         <para>In this example we are going to use a <emphasis>Base Filter</emphasis> to filter out\r
496             one library’s circulations for a specified time frame. The time frame in the template\r
497             will be configured so that you can change it each time you run the report.</para>\r
498 \r
499         <procedure>\r
500             <info>\r
501                 <title>Using Base Filters</title>\r
502             </info>\r
503 \r
504             <step>\r
505                 <para>Select the <guilabel>Base Filters</guilabel> tab in the bottom\r
506                         <guilabel>Template Configuration</guilabel> pane. </para>\r
507             </step>\r
508 \r
509             <step>\r
510                 <informalfigure>\r
511                     <para> For this circulation statistics example, select <menuchoice>\r
512                             <guimenu>Circulation </guimenu>\r
513                             <guisubmenu>Check Out Date/Time</guisubmenu>\r
514                             <guimenuitem>Year + Month</guimenuitem>\r
515                         </menuchoice> and click on <guibutton>Add Selected Fields</guibutton>. You\r
516                         are going to filter on the time period. </para>\r
517                     <para><mediaobject>\r
518                         <alt>Screenshot of staff client report interface</alt>\r
519                         <imageobject>\r
520                             <imagedata width="100%" scalefit="1" fileref="../media/create-template-25.png"/>\r
521                         </imageobject>\r
522 \r
523                     </mediaobject></para>\r
524                 </informalfigure>\r
525             </step>\r
526             <step>\r
527                 <informalfigure>\r
528                     <para>Select <guimenuitem>Check Out Date/Time</guimenuitem>. Click on\r
529                             <guibutton>Change Operator</guibutton> and select <guimenuitem>In\r
530                             list</guimenuitem> from the dropdown menu. </para>\r
531                    <para> <mediaobject>\r
532                         <alt>Screenshot of staff client report interface</alt>\r
533                         <imageobject>\r
534                             <imagedata scalefit="0" fileref="../media/create-template-26.png"/>\r
535                         </imageobject>\r
536 \r
537                     </mediaobject></para>\r
538 \r
539                 </informalfigure>\r
540             </step>\r
541             <step xml:id="create-template-filter-step" xreflabel="above">\r
542                 <informalfigure>\r
543                     <para>To filter on the location of the circulation select <menuchoice>\r
544                             <guisubmenu>Circulation</guisubmenu>\r
545                             <guisubmenu> Circulating library</guisubmenu>\r
546                             <guimenuitem> Raw Data</guimenuitem>\r
547                         </menuchoice> and click on <guibutton>Add Selected Fields</guibutton>. </para>\r
548                  <para>   <mediaobject>\r
549                         <alt>Screenshot of staff client report interface</alt>\r
550                         <imageobject>\r
551                             <imagedata width="100%" scalefit="1" fileref="../media/create-template-27.png"/>\r
552                         </imageobject>\r
553 \r
554                     </mediaobject></para>\r
555                 </informalfigure>\r
556             </step>\r
557             <step>\r
558                 <informalfigure>\r
559                     <para>Select <guilabel>Circulating Library</guilabel> and click on\r
560                             <guibutton>Change Operator</guibutton> and select\r
561                             <guimenuitem>Equals</guimenuitem>. Note that this is a template, so the\r
562                         value for <emphasis>Equals</emphasis> will be filled out when you run the\r
563                         report </para>\r
564                     <para><mediaobject>\r
565                         <alt>Screenshot of staff client report interface</alt>\r
566                         <imageobject>\r
567                             <imagedata  scalefit="0" fileref="../media/create-template-28.png"/>\r
568                         </imageobject>\r
569 \r
570                     </mediaobject></para>\r
571 \r
572                 </informalfigure>\r
573                 <para> For multi-branch libraries, you would select <emphasis>Circulating\r
574                         Library</emphasis> with <emphasis>In list</emphasis> as the operator, so you\r
575                     could specify the branch(es) when you run the report. This leaves the template\r
576                     configurable to current requirements. In comparison, sometimes you will want to\r
577                     hardcode true/false values into a template. For example, deleted bibliographic\r
578                     records remain in the database, so perhaps you want to hardcode deleted=false,\r
579                     so that deleted records don’t show up in the results. You might want to use\r
580                     deleted=true, for a template for a report on deleted items in the last month.\r
581                 </para>\r
582             </step>\r
583 \r
584             <step>\r
585                 <informalfigure>\r
586                     <para>Once you have configured your template, you must name and save it. Name\r
587                         this template <emphasis>Circulations by month for one library</emphasis>.\r
588                         You can also add a description. In this example, the title is descriptive\r
589                         enough, so a description is not necessary. Click\r
590                         <guibutton>Save</guibutton>. </para>\r
591                     <para><mediaobject>\r
592                         <alt>Screenshot of staff client report interface</alt>\r
593                         <imageobject>\r
594                             <imagedata scalefit="0" fileref="../media/create-template-29.png"/>\r
595                         </imageobject>\r
596 \r
597                     </mediaobject></para>\r
598 \r
599                 </informalfigure>\r
600             </step>\r
601             <step>\r
602                 <informalfigure>\r
603                     <para> Click <guibutton>OK</guibutton>. </para>\r
604                     <para><mediaobject>\r
605                         <alt>Screenshot of staff client report interface</alt>\r
606                         <imageobject>\r
607                             <imagedata scalefit="0" fileref="../media/create-template-30.png"/>\r
608                         </imageobject>\r
609 \r
610                     </mediaobject></para>\r
611 \r
612                 </informalfigure>\r
613             </step>\r
614             <step>\r
615                 <informalfigure>\r
616                     <para> You will get a confirmation dialogue box that the template was\r
617                         successfully saved. Click <guibutton>OK</guibutton>. </para>\r
618                     <para><mediaobject>\r
619                         <alt>Screenshot of staff client report interface</alt>\r
620                         <imageobject>\r
621                             <imagedata scalefit="0" fileref="../media/create-template-31.png"/>\r
622                         </imageobject>\r
623 \r
624                     </mediaobject></para>\r
625 \r
626                 </informalfigure>\r
627             </step>\r
628         </procedure>\r
629 \r
630         <para> After saving it is not possible to edit a template. To make changes you will need to\r
631             clone it and edit the clone</para>\r
632         <tip>\r
633 \r
634 \r
635 \r
636             <informalfigure>\r
637                 <para> The bottom right hand pane is also a source specifier. By selecting one of\r
638                     these rows you will limit the fields that are visible to the sources you have\r
639                     specified. This may be helpful when reviewing templates with many fields. Use <keycombo>\r
640                         <keycap>Ctrl</keycap>\r
641                         <mousebutton>Click</mousebutton>\r
642                     </keycombo> to select or deselect items. </para>\r
643 \r
644                <para> <mediaobject>\r
645                     <imageobject>\r
646                         <imagedata scalefit="0" fileref="../media/create-template-32.png"/>\r
647                     </imageobject>\r
648 \r
649                 </mediaobject></para>\r
650             </informalfigure>\r
651 \r
652 \r
653         </tip>\r
654     </section>\r
655 \r
656    \r
657 \r
658 </chapter>\r