koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl

   1 <!-- TMPL_INCLUDE NAME="doc-head-open.inc" -->
   2 <title>Online Help &rsaquo; Guided Reports</title>
   3 <!-- TMPL_INCLUDE NAME="doc-head-close.inc" -->
   4 </head>
   5 <body>
   6 <a name="#top"></a>
   7 <h1>Guided Reports Help</h1>
   8
   9 <ul>
  10         <li><a href="#new">Building A New Report</a></li>
  11         <li><a href="#save">Saving A Report</a></li>
  12         <li><a href="#sql">Generating A New Report From SQL</a></li>
  13         <li><a href="#scheduler">Scheduling A Report</a><li>
  14 <ul>
  15
  16 <p>For help with the Reports Dictionary - see online help within the Dictionary Pages</p>
  17
  18 <hr />
  19 <a name="#new"></a>
  20 <h2>Building A New Report</h2>
  21 <h3>Step 1 of 6: Choose a Module to Report on</h3>
  22 <p>Select one of the module areas to report on. Guided reports can only generate reports from within one module. For reports across modules, you will need to use either a compound report, or build a custom report using SQL statements.</p>
  23
  24 <h3>Step 2 of 6: Pick a Report Type</h3>
  25 <p>There are 3 types of reports that can be generated:</p>
  26 <ul>
  27         <li><strong>Tabular :</strong>Simple report of columns only.</li>
  28         <li><strong>Matrix :</strong><em>Not finished</em></li>
  29         <li><strong>Summary :</strong><em>Not finished</em></li>
  30 </ul>
  31
  32 <h3>Step 3 of 6: Select Columns for Display</h3>
  33 <p>Select the columns to draw the report data from. Click the column to add in the left hand box and then click the "Add" button. Your column will now show up in the right hand box. To remove a selected column, click the column name on the right hand side and then click the delete button. Once you are happy with the columns, select the "Choose Columns" button to proceed to the next step.</p>
  34
  35 <p><strong>Be careful selecting columns.</strong> The guided reports feature expects that you have some knowledge of the Koha database structure and what each field is used for. Be careful selecting columns as a poor choice may lead to a report that is so large that it either times out before it can be generated, or it will require a large amount of system resources to generate and slow down the operation of Koha.</p>
  36
  37 <p>There is no sanity checker in the reports engine</p>
  38
  39 <h3>Step 4 of 6: Select Criteria to Limit on </h3>
  40 <p>Criteria allow you to limit your report to display results to a given criteria.Criteria are bound to a specific reporting area.</p>
  41
  42 <ul>
  43         <li><strong>System Generated Criteria</strong> These criteria are known to the system and are drawn from your system preferences</li>
  44         <li><strong>Dictionary Criteria</strong> These are custom defined criteria defined for your Koha in the Reports Dictionary</li>
  45 </ul>
  46
  47 <h3>Step 5 of 6: Pick which columns to total</h3>
  48 <p>Now choose operations that you want to preform on each column. The operations that can be selected are:</p>
  49 <ul>
  50         <li>Count : Returns a count of each value</li>
  51         <li>Sum : Returns the sum of all values</li>
  52         <li>Average : Returns the average value</li>
  53         <li>Min : Returns the lowest value</li>
  54         <li>Max : Returns the highest value</li>
  55 </ul>.
  56
  57 <h3>Step 6 of 6: Select how you want the report ordered</h3>
  58 <p>Select how you wish to order the report. You can select multiple criteria to order against and the hierarchy that the are applied. For example order alphabetically by Surname, and then alphabetically by First Name</p>
  59
  60 <br /><a href="#top">Back To Top</a>
  61
  62 <hr />
  63
  64 <a name="#save"></a>
  65 <h2>Saving A Report</h2>
  66 <p>Once you have generated a report, you can now choose to save the report definition so that you can run it again when required, or setup the Scheduler to run the report for you.</p>
  67
  68 <br /><a href="#top">Back To Top</a>
  69
  70 <hr />
  71
  72 <a name="#sql"></a>
  73 <h2>Generating A New Report From SQL</h2>
  74 <p>A report can be generated directly using from an SQL statement. On the "Generate from SQL" page, give the report a Title and Description (using the notes field) and then paste your SQL statement into the text area.</p>
  75
  76 <br /><a href="#top">Back To Top</a>
  77 <hr />
  78
  79
  80 <a name="#scheduler"></a>
  81 <h2>Scheduling A Report</h2>
  82 <p>Reports can be scheduled to run either at a one off time, or repeatedly at a defined period using the task scheduler. The task scheduler is found under Tools > Scheduler</p>
  83 <br /><a href="#top">Back To Top</a>
  84
  85
  86
  87 <!-- TMPL_INCLUDE name="intranet-bottom.inc" -->