koha-tt/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>Reports Dictionary Help</h1>
   4
   5 The dictionary provides a way that you can define custom criteria for reporting by combining existing criteria.
   6
   7 <h2>Adding A New Definition</h2>
   8
   9 <p><strong>Step 1: Name</strong></p>
  10
  11 <p>At this step you will need to fill out the following details:</p>
  12
  13 <ul>
  14 <li>Definition Name: Short name that is used for display and selection</li>
  15 <li>Definition Description: Used within the dictionary only to provide further detail about the definition</li>
  16 </ul>
  17
  18 <p><strong>Step 2: Area</strong></p>
  19
  20 <p>Now you will need to select the area that you are binding the definition to. </p>
  21
  22 <p style="color: #990000">IMPORTANT: Definitions can only be bound to one area.</p>
  23
  24 <p style="background-color: #ffe599">TIP: If you wish to use a similar definition in say, Circulation and Patrons, you will need to create two definitions - one for each area</p>
  25
  26 <p><strong>Step 3: Columns</strong></p>
  27
  28 <p>Now select the criteria that you wish to use to build your definition. </p>
  29
  30 <ul>
  31 <li>Click on the database column name and then press the 'add' button.</li>
  32 <li>Once you have selected all your desired columns, press Next.</li>
  33 </ul>
  34
  35 <p style="background-color: #ffe599">TIP: Definitions can be deleted easily, and if you are still learning the structure of the Koha data, it may take a little while to sort out which fields you require. Some trial and error may be required</p>
  36
  37 <p><strong>Step 4: Values</strong></p>
  38
  39 <p>Now you need to select the values for each column that will make up your new criteria. There are different ways to define the values, based on the type of data in the column you have selected</p>
  40
  41 <ul>
  42 <li>Search String Matches For free text fields in that database, enter a string/phrase for the criteria to match on</li>
  43 <li>Date For date fields you can either select:</li>
  44 <ol><li>Date Range: enter values in both date fields</li>
  45      <li>All Data Before A Given Date: enter a value in the XXX field only</li>
  46      <li>All Data After A Given Date: enter a value in the XXX field only</li>
  47 </ol>
  48 <li>Select From Database Value For data that is given an authorized value in the Koha database, you the drop down list to select one value</li>
  49 </ul>
  50
  51 <p><strong>Step 5: Confirmation</strong></p>
  52
  53 <p>You will be presented with a confirmation once you have finished step 4</p>
  54
  55 <p>Click 'Save'</p>
  56
  57 <h2>Using A Definition</h2>
  58
  59 <p>Once you have created your new definition and it shows on in the Dictionary, you can use the definition for reporting.</p>
  60
  61 <ul>
  62 <li>When you go to create a new report, the criteria for the area you are reporting on will automatically show as limits in the Guided Reports wizard</li>
  63 </ul>
  64 [% INCLUDE 'help-bottom.inc' %]