koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tt

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>Authorized Values</h1>
   4
   5 <p>Authorized Values can be used in several areas of Koha. One reason you would add an authorized value category would be to control the values that can be entered into MARC fields by catalogers.</p>
   6
   7 <h2>Existing Values</h2>
   8
   9 <p>Koha installs with pre-defined values that your library is likely to use, for instance, 'Lost.'</p>
  10
  11 <p>By default, this includes:</p>
  12
  13 <ul>
  14     <li>'Asort1,' for acquisitions statistical purposes.</li>
  15     <li>'Asort2,' used for acquisitions statistical purposes.</li>
  16     <li>'BOR_NOTES' is for values for custom patron notes that appear on the circulation screen and the OPAC.</li>
  17     <li>'Bsort1' is for patron statistical purposes.</li>
  18     <li>'Bsort2' is used for patron statistical purposes.</li>
  19     <li>'CART' is the shelving cart location, used by InProcessingToShelvingCart and ReturnToShelvingCart</li>
  20     <li>'CCODE' is for collection codes (appears when cataloging and working with items).</li>
  21     <li>'DAMAGED' is for descriptions of damaged items, and appears when cataloging and working with items.</li>
  22     <li>'HINGS_AS' is for General Holdings: Acquisition Status Designator, a data element that specifies the acquisition status for the unit at the time of the holdings report.</li>
  23     <li>'HINGS_C' is for General Holdings: Completeness Designator.</li>
  24     <li>'HINGS_PF' is for Physical Form Designators</li>
  25     <li>'HINGS_RD' is for General Holdings: Retention Designator, a data element that specifies the retention policy for the unit at the time of the holdings report.</li>
  26     <li>'HINGS_UT' is for General Holdings: Type of Unit Designator.</li>
  27     <li>'LOC' is for the shelving location and usually appears when adding or editing an item.</li>
  28     <li>'LOST' is for descriptions for items marked as lost. It appears when adding or editing an item. Values given to lost statuses should be numeric (not alphabetical) in order for statuses to appear properly.
  29 <ul>
  30     <li style="color: #990000;">Important: Values given to lost statuses should be numeric and not alphabetical in order for statuses to appear properly</li>
  31 </ul>
  32 </li>
  33     <li>'MANUAL_INV' includes values for manual invoicing.</li>
  34     <li>'NOT_LOAN' is used to list reasons why a title is not for loan.</li>
  35     <li>'PROC' is for the location to be used for NewItemsDefaultLocation (change description as desired), also the location expected by InProcessingToShelvingCart.</li>
  36     <li>'REPORT_GROUP' provides a way to sort and filter your reports, the default values in this category include the Koha modules (Accounts, Acquisitions, Catalog, Circulation, Patrons)</li>
  37     <li>'REPORT_SUBGROUP' can be used to further sort and filter your reports. This category is empty by default. Values here need to include the authorized value code from REPORT_GROUP in the Description (OPAC) field to link the subgroup to the appropriate group.</li>
  38     <li>'RESTRICTED' is used for the restricted status of an item</li>
  39     <li>'ROADTYPE' is used forRoad types to be used in patron addresses</li>
  40     <li>'SUGGEST' is for a list of reasons to accept or reject patron suggestions. It appears when managing suggestions.</li>
  41     <li>'WITHDRAWN' is for a description of a withdrawn item. It appears when adding or editing an item.</li>
  42     <li>'YES_NO' is a generic authorized value field that can be used anywhere you need a simple yes/no pull down menu.</li>
  43 </ul>
  44
  45 <h2>Add New Authorized Value Category</h2>
  46
  47 <p>In addition to the existing categories that come by default with Koha, librarians can add their own authorized value categories to control data that is entered into the system. To add a new category:</p>
  48
  49 <ul>
  50     <li>Click 'New Category.'</li>
  51 <ul>
  52         <li>Limit your Category to 10 characters (something short to make it clear what the category is for)
  53 <ul>
  54         <li style="color: #990000;">Important: Category cannot have spaces or special characters other than underscores and hyphens in it.</li>
  55 </ul>
  56 </li>
  57         <li>When adding a new category you're asked to create at least one authorized value
  58 <ul>
  59         <li>Enter a code for your Authorized Value into the 'Authorized value' field
  60 <ul>
  61         <li style="color: #990000;">Important:  Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it.</li>
  62 </ul>
  63 </li>
  64         <li>Use the Description field for the actual value that will be displayed. If you want something different to show in the OPAC, enter a 'Description (OPAC)'</li>
  65         <li>If you would like to limit this authorized value category to only specific libraries you can choose them from the 'Branches limitation' menu. To have it show for all libraries just choose 'All branches' at the top of the list.</li>
  66 </ul>
  67 </li>
  68         <li>Click 'Save'</li>
  69         <li>Your new category and value will appear on the list of Authorized Values</li>
  70 </ul>
  71 </ul>
  72
  73 <h2>Add New Authorized Value</h2>
  74
  75 <p>New authorized values can be added to any existing or new category. To add a value:</p>
  76
  77 <ul>
  78         <li>Click 'New authorized value for ...'</li>
  79 <ul>
  80         <li>Enter a code for your Authorized Value into the 'Authorized value' field
  81 <ul>
  82         <li style="color: #990000;">Important: Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it.</li>
  83 </ul>
  84 </li>
  85         <li>Use the Description field for the actual value that will be displayed. If you want something different to show in the OPAC, enter a 'Description (OPAC)'</li>
  86         <li>If you would like to limit this authorized value category to only specific libraries you can choose them from the 'Branches limitation' menu. To have it show for all libraries just choose 'All branches' at the top of the list.</li>
  87         <li>Click 'Save'</li>
  88         <li>The new value will appear in the list along with existing values</li>
  89 </ul>
  90 </ul>
  91
  92 <p><strong>See the full documentation for Authorized Values in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/administration.html#authorized-values">manual</a> (online).</strong></p>
  93
  94 [% INCLUDE 'help-bottom.inc' %]