Merge remote branch 'kc/master'
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / help / admin / patron-attr-types.tmpl
1 <!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
3 <h1>Patron attribute types</h1>A patron attribute (or extended patron attribute) is an additional piece of information associated with a patron record.  Each attribute has a type that specifies whether the attribute is repeatable, can serve as a unique identifier, can take a password, and whether it can be used to search for patron records in the staff interface.
4 The list of attribute types is controlled by staff with 'superlibrarian' permissions.<br/>
5         <ul>
6                 <li>Get there: Patrons &gt; Patron Record &gt; More &gt; Set Permissions</li>
7         </ul>Once an attribute type is defined, values for that attribute can be added to the patron record via the staff interface or the batch patron import.
8 Two uses of extended attributes are:
9
10         <ul>
11                 <li>defining additional unique identifiers, such as a campus student ID number, a library staff HR number, and so on.  These IDs can be used for searching or matching and overlaying records during a batch import.</li>
12                 <li>additional statistical categories.  For example, a library could define an attribute type for tracking the academic major of a student patron. Any number of attributes of this sort could be defined.</li>
13         </ul>The extended attributes feature is completely optional.  If the 'ExtendPatronAttributes' system preference is OFF, customizable patron attributes will not be usable.
14 <h2>Add Patron Attribute</h2>
15         <ul>
16                 <li>Click 'Patron attribute types'</li>
17                 <li>       
18            IMPORTANT: You will need to have ExtendedPatronAttributes turned on
19                 <ul>
20                         <li>Get there: More &gt; Administration &gt; General system preferences &gt; Patrons &gt; ExtendedPatronAttributes</li>
21                 </ul></li>
22                 <li>To add a new Patron Attribute, click 'New Patron Attribute Type'</li>
23                 <li>The 'Patron attribute type code' should be unique and is the only required field
24                 <ul>
25                         <li>TIP: This field is not editable once it is set</li>
26                 </ul></li>
27                 <li>Fill in all of the fields you need for your attribute
28                 <ul>
29                         <li>TIP: The repeatibility and unique_id settings of an attribute type cannot be changed after creation - this is to avoid having to deal with changing constraints if an attribute type is already in use by patron records</li>
30                 </ul></li>
31                 <li>Click 'Save'</li>
32                 <li>TIP: An attribute type cannot be deleted if it is used by any patron records</li>
33         </ul><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->