Bug 20706: Fixes the links to the manual to reflect chanced chapter file names
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / help / tools / import_borrowers.tt
1 [% INCLUDE 'help-top.inc' %]
2
3 <h1>Patron import</h1>
4
5 <p>The patron import tool can be used at any time to add patrons in bulk. It is commonly used in universities and schools when a new batch of students registers.</p>
6
7 <h2>Creating Patron File</h2>
8
9 <p>Your Koha installation comes with a blank CSV file that you can use as a template for your patron records. If you would like to create the file yourself, make sure that your file has the following fields in this order as the header row:</p>
10
11 <blockquote>cardnumber, surname, firstname, title, othernames, initials, streetnumber, streettype, address, address2, city, state, zipcode, country, email, phone, mobile, fax, emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2, B_city, B_state, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress, lost, debarred, debarredcomment, contactname, contactfirstname, contacttitle, guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex, password, flags, userid, opacnote, contactnote, sort1, sort2, altcontactfirstname, altcontactsurname, altcontactaddress1, altcontactaddress2, altcontactaddress3, altcontactstate, altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber, privacy, patron_attributes </blockquote>
12
13 <p style="color: #990000;">Important: The 'password' value should be stored in plain text, and will be converted to a Bcrypt hash (which is an encrypted version of the password).</p>
14
15 <ul>
16     <li>If your passwords are already encrypted, talk to your systems administrator about options</li>
17 </ul>
18
19 <p style="color: #990000;">Important: Date formats should match your system preference, and must be zero-padded, e.g. '01/02/2008'.</p>
20
21 <p style="color: #990000;">Important: The fields 'branchcode' and 'categorycode' are required and must match valid entries in your database.</p>
22
23 <p style="background-color: #ffe599">Tip : If loading patron attributes, the 'patron_attributes' field should contain a comma-separated list of attribute types and values.</p>
24 <ul>
25         <li>The attribute type code and a colon should precede each value.
26 <ul>
27         <li>For example: "INSTID:12345,BASEBALL:Cubs"</li>
28         <li>This field must be wrapped in quotes if multiple values are defined.</li>
29         <li>Since values can contain spaces, additional doubled-quotes may be required:
30 <ul>
31         <li>"INSTID:12345,BASEBALL:Cubs,""BASEBALL:White Sox"""</li>
32 </ul>
33 </li>
34         <li>When replacing a patron record, any attributes specified in the input file replace all of the attribute values of any type that were previously assigned to the patron record.</li>
35 </ul>
36 </li>
37 </ul>
38
39 <h2>Importing Patrons</h2>
40
41 <p>Once you have created your file, you can use the Patron Import Tool to bring the data into Koha.</p>
42
43 <ul>
44         <li>Choose your CSV file and choose to match on 'Cardnumber' to prevent adding of duplicate card numbers to the system</li>
45         <li>Next you can choose default values to apply to all patrons you are importing
46 <ul>
47         <li>ex. If you're importing patrons specific to one library you can use the field on the Import form to apply the branchcode to all those you are importing.</li>
48 </ul>
49 </li>
50         <li>Finally you need to decide on what data you want to replace if there are duplicates.
51 <ul>
52         <li>A matching record is found using the field you chose for matching criteria to prevent duplication</li>
53         <li>If you included patron attributes in your file you can decide whether to add your values to existing values or erase existing values and enter only your new values.</li>
54 </ul>
55 </li>
56 </ul>
57
58 <p><strong>See the full documentation for Patron Import in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/tools.html#patron-import">manual</a> (online).</strong></p>
59
60 [% INCLUDE 'help-bottom.inc' %]