koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/patron-attr-types.tt

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>Patron Attribute Types</h1>
   4
   5 <p>Patron attributes can be used to define custom fields to associate with your patron records. In order to enable the use of custom fields you need to set the ExtendedPatronAttributes system preference.</p>
   6
   7 <ul>
   8    <li><em>Get there:</em> More &gt; Administration &gt; Patrons &amp; Circulation &gt; Patron attribute types</li>
   9 </ul>
  10
  11 <p>A common use for this field would be for a student ID number or a Driver's license number.</p>
  12
  13 <h3>Adding Patron Attributes</h3>
  14
  15 <p>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at the top of the page</p>
  16
  17 <ul>
  18     <li>In the 'Patron attribute type code', enter a short code to identify this field
  19 <ul>
  20     <li style="color: #990000;">Important: This field is limited to 10 characters (numbers and letters only)</li>
  21     <li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
  22 </ul>
  23 </li>
  24         <li>In the 'Description' field, enter a longer (plain text) explanation of what this field will contain</li>
  25         <li>Check the box next to 'Repeatable' to let a patron record have multiple values of this attribute.
  26 <ul>
  27     <li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
  28 </ul>
  29 </li>
  30         <li>If 'Unique identifier' is checked, the attribute will be a unique identifier which means, if a value is given to a patron record, the same value cannot be given to a different record.
  31     <li>Unique attributes can be used as match points on the patron import tool</li>
  32 <ul>
  33     <li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
  34 </ul>
  35 </li>
  36         <li>Check 'Allow password' to make it possible to associate a password with this attribute.</li>
  37         <li>Check 'Display in OPAC' to display this attribute on a patron's details page in the OPAC.</li>
  38         <li>Check 'Searchable' to make this attribute searchable in the staff patron search.</li>
  39         <li>Check 'Display in check-out' to make this attribute visible in the patron's short detail display on the left of the checkout screen and other patron pages</li>
  40         <li>Authorized value category; if one is selected, the patron record input page will only allow values to be chosen from the authorized value list.
  41 <ul>
  42     <li>You will first need to add an authorized value list for it to appear in this menu
  43 <ul>
  44     <li><em>Get there: </em>More &gt; Administration &gt; Basic Parameters &gt; Authorized Values</li>
  45 </ul>
  46 </li>
  47     <li style="color: #990000;">Important: an authorized value list is not enforced during batch patron import.</li>
  48 </ul>
  49 </li>
  50     <li>If you would like this attribute to only be used by specific branches you can choose those branches from the 'Branches limitation' list. Choose 'All branches' to show it for all libraries.</li>
  51     <li>If you'd like to only show this attribute on patrons of one type choose that patron type from the 'Category' pull down</li>
  52     <li>If you have a lot of attributes it might be handy to group them so that you can easily find them for editing. If you create an Authorized Value for PA_CLASS it will show in the 'Class' pull down and you can then change your attributes page to have sections of attributes</li>
  53         <li>Click Save to save your new attribute</li>
  54 </ul>
  55
  56 <p>Once added your attribute will appear on the list of attributes and also on the patron record add/edit form</o>
  57
  58 <p>If you have set up classes for organizing attributes they will appear that way on the add/edit patron form</p>
  59
  60 <h3>Editing/Deleting Patron Attributes</h3>
  61
  62 <p>Each patron attribute has an edit and a delete link beside it on the list of attributes.</p>
  63
  64 <p>Some fields in the attribute will not be editable once created:</p>
  65
  66 <ul>
  67         <li>Patron attribute type code</li>
  68         <li>Repeatable</li>
  69         <li>Unique identifier</li>
  70 </ul>
  71
  72 <p>You will be unable to delete an attribute if it's in use.</p>
  73
  74 <p><strong>See the full documentation for Patron Attribute Types in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/administration.html#patron-attribute-types">manual</a> (online).</strong></p>
  75
  76 [% INCLUDE 'help-bottom.inc' %]