Taiga 1274 (24976) Updated guided reports process
[kohadocs.git] / source / patrons.rst
1 .. include:: images.rst
2
3 .. _patrons-label:
4
5 Patrons
6 =======
7
8 Before importing and/or adding patrons be sure to set up your :ref:`patron
9 categories <patron-categories-label>`.
10
11 .. _add-a-new-patron-label:
12
13 Add a new patron
14 ------------------------------------
15
16 Patrons are added by going to the 'Patrons' module.
17
18 -  *Get there:* Patrons
19
20 Once there you can add a new patron.
21
22 -  Click 'New patron'
23
24    |image407|
25
26 -  The fields that appear on the patron add form can be controlled by
27    editing the :ref:`BorrowerUnwantedField` system
28    preference.
29
30 -  First enter the identifying information regarding your patron
31
32    |image408|
33
34    -  Required fields are defined in the
35       :ref:`BorrowerMandatoryField` system
36       preference
37
38    -  Salutation is populated by the
39       :ref:`BorrowersTitles` system preference
40
41    -  **Note**
42
43           If you'd like to prevent full names from printing on
44           :ref:`slips <notices-and-slips-label>` and you're not using the Initials or
45           Other name fields for anything else, you can use them for
46           shortened versions of the name to then be printed on the slip.
47
48           For example:
49
50           ::
51
52               Firstname: Nicole C.
53               Surname: Engard
54               Initials: NCE
55
56           Then on the slip you can have it print the
57           <<borrowers.initials>> instead of the full name (NCE).
58
59           Or you could do something like this:
60
61           ::
62
63               Firstname: Nicole
64               Surname: Engard
65               Initials: E
66
67           Then on the slip you can have it print the
68           <<borrowers.initials>>, <<borrowers.firstname>> instead of the
69           full name (E, Nicole).
70
71 -  Next enter the contact information
72
73    |image409|
74
75    -  For contact information, note that the primary phone and email
76       addresses are the ones that appear on notices and slips printed
77       during circulation (receipts, transfer slips and hold slips). The
78       primary email is also the one that overdue notices and other
79       messages go to.
80
81 -  If this patron is a child, you will be asked to attach the child
82    patron to an adult patron
83
84    |image410|
85
86    -  Click 'Set to patron' to search your system for an existing patron
87
88    -  If the Guarantor is not in the system, you can enter the first and
89       last name in the fields available
90
91    -  The relationships are set using the
92       :ref:`borrowerRelationship` system preference
93
94 -  If this patron is a professional, you will be asked to attach the
95    patron to an organizational patron
96
97    |image411|
98
99    -  Click 'Set to patron' to search your system for an existing patron
100
101 -  Each patron can have an alternate contact
102
103    |image412|
104
105    -  An alternate contact could be a parent or guardian. It can also be
106       used in academic settings to store the patron's home address.
107
108 -  The library management section includes values that are used within
109    the library
110
111    |image413|
112
113    -  The card number field is automatically calculated if you have the
114       :ref:`autoMemberNum` system preference set that way
115
116       -  **Note**
117
118              For a newly installed system this preference will start at
119              1 and increment by 1 each time after. To have it start with
120              the starting number of your barcodes, enter the first
121              barcode by hand in the patron record and save the patron.
122              After that the field will increment that number by 1.
123
124    -  If you accidentally chose the wrong patron category at the
125       beginning you can fix that here
126
127    -  Sort 1 and 2 are used for statistical purposes within your library
128
129    -  'Check for previous checkouts' is used to set the patron's personal preference
130       regarding checking their circulation history to see if they have borrowed this
131       item in the past. This overrides the setting of the :ref:`patron category
132       <adding-a-patron-category-label>` and of the :ref:`CheckPrevCheckout` system preference.
133
134 -  Next, the library set-up section includes additional library settings
135
136    |image414|
137
138    -  The registration date will automatically be filled in with today's
139       date
140
141    -  If your patron cards expire (based on your :ref:`patron category
142       settings <patron-categories-label>`) the expiry date will automatically be
143       calculated
144
145    -  The OPAC note is a note for the patron - it will appear in the
146       OPAC on the patron's record
147
148    -  The Circulation note is meant solely for your library staff and
149       will appear when the circulation staff goes to check an item out
150       to the patron
151
152       |image415|
153
154    -  The Staff/OPAC asks for the username and password to be used by
155       the patron (and/or staff member) to log into their account in the
156       OPAC and for staff to log in to the staff client.
157
158       -  Staff will only be able to use this log in info to log in to
159          the staff client if they have the :ref:`necessary
160          permissions <patron-permissions-label>`.
161
162 -  If you have set :ref:`additional patron
163    attributes <patron-attribute-types-label>` up, these will appear next
164
165    |image416|
166
167 -  Finally, if you have
168    :ref:`EnhancedMessagingPreferences` set
169    to 'allow,' you can choose the messaging preferences for this patron.
170
171    |image417|
172
173    -  These notices are:
174
175       -  Advanced notice: A notice in advance of the patron's items
176          being due (the patron can choose the number of days in advance)
177
178       -  Item checkout: A notice that lists all the of the items the
179          patron has just checked out and/or renewed, this is an
180          electronic form of the checkout receipt
181
182       -  Hold filled: A notice when you have confirmed the hold is
183          waiting for the patron
184
185       -  Item due: A notice on the day and item is due back at the
186          library
187
188       -  Item check-in: A notice that lists all the of the items the
189          patron has just checked in
190
191    -  Patrons can choose to receive their notices as a digest by
192       checking the 'Digest only?' box along with the delivery method. A
193       digest is a combination of all the messages of that type (so all
194       items due in 3 days in one email) in to one email instead of
195       multiple emails for each alert.
196
197    -  **Important**
198
199           These preferences will override any you set via the :ref:`patron
200           categories <adding-a-patron-category-label>`
201
202    -  **Important**
203
204           These preference can be altered by the patron via the OPAC
205
206 -  Once finished, click 'Save'
207
208 If the system suspects this patron is a duplicate of another it will
209 warn you.
210
211 |image418|
212
213     **Note**
214
215     A duplicate patron is detected if first and last names match and
216     there is no date of birth populated or if first name, last name and
217     date of birth fields are all populated. If two patrons have matching
218     names, but one has a date of birth and the other does not they will
219     not match as duplicates.
220
221 If you have set a minimum or upper age limit on the patron category and
222 are requiring that the birth date be filled in, Koha will warn you if
223 the patron you're adding is too old or young for the patron category you
224 have selected:
225
226 |image419|
227
228 .. _quick-add-patron-label:
229
230 Quick add a patron
231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
232
233 If your circulation desk is very busy and you want to register patron quickly,
234 you can use the 'quick add' feature. It's a shortened version of the add
235 patron form with only a couple of necessary fields to fill out.
236
237 This feature uses two system preferences: :ref:`BorrowerMandatoryField`
238 and :ref:`PatronQuickAddFields`. These are the two system preferences that
239 control which fields are in the quick add form.
240
241 To quick add a patron, go to the Patrons module
242
243 -  *Get there:* Patrons
244
245 Click on the 'Quick add new patron' button.
246
247 You will be asked to choose a patron category.
248
249 Then, you will be presented with a shortened form.
250
251 |image1346|
252
253 Once the form is filled out, click on 'Save'.
254
255 If you need to access the full form, you can click on 'Show full form'
256 above the 'Save' button.
257
258 .. _add-a-staff-patron-label:
259
260 Add a staff patron
261 ----------------------------------------
262
263 All staff members must be entered into Koha as patrons of the 'Staff'
264 type. Follow the steps in :ref:`Add a Patron <add-a-new-patron-label>` to add a
265 staff member. To give the staff member permissions to access the staff
266 client, follow the steps in :ref:`patron permissions <patron-permissions-label>`
267
268     **Important**
269
270     Remember to assign your staff secure usernames and passwords since
271     these will be used to log into the staff client.
272
273 .. _add-a-statistical-patron-label:
274
275 Add a statistical patron
276 ----------------------------------------------
277
278 One way to track use of in house items is to "check out" the materials
279 to a statistical patron. The "check out" process doesn’t check the book
280 out, but instead tracks an in house use of the item. To use this method
281 for tracking in house use you first will need a :ref:`patron
282 category <patron-categories-label>` set up for your statistical patron.
283
284 |image420|
285
286 Next, you will need to create a new patron of the statistical type.
287
288 |image421|
289
290 Next, follow the steps put forth in the ':ref:`Add a new
291 patron <add-a-new-patron-label>`' section of this manual. Since this patron is
292 not a real person, simply fill in the required fields, the correct
293 library and nothing else.
294
295 To learn about other methods of tracking in house use visit the
296 :ref:`tracking inhouse use <tracking-in-house-use-label>` section of this manual.
297
298 .. _duplicate-a-patron-label:
299
300 Duplicate a patron
301 -----------------------------------------
302
303 Sometimes when you're adding a new family to your system you don't want
304 to type the contact information over and over. Koha allows for you to
305 duplicate a patron and change only the parts you want to (or need to)
306 change.
307
308 -  Open the patron you want to use as your base (the patron you want to
309    duplicate information from)
310
311 -  Click the 'Duplicate' button at the top of their record
312
313    |image422|
314
315 -  All of the fields with the exception of first name, card number,
316    username and password have been duplicated. Fill in the missing
317    pieces and click 'Save'
318
319    |image423|
320
321    -  **Note**
322
323           Clicking in a field that is already populated with data will
324           clear that field of all information (making it easier for you
325           to type in something different)
326
327 -  You will be brought to your new patron
328
329    |image424|
330
331 .. _add-patron-images-label:
332
333 Add patron images
334 ----------------------------------------
335
336 If you would like you can add patron images to help identify patrons. To
337 enable this feature you must first set the
338 :ref:`patronimages` preference to 'Allow'.
339
340 If the preference is set to 'Allow' you will see a placeholder image
341 under the patron's name and box to upload a patron image below the basic
342 contact information.
343
344 |image425|
345
346 In the 'Upload patron image' box click 'Browse' to find the image on
347 your computer and 'Upload' to load the image on to the patron record.
348
349 |image426|
350
351     **Important**
352
353     There is a limit of 100K on the size of the picture uploaded and it
354     is recommended that the image be 200x300 pixels, but smaller images
355     will work as well.
356
357 .. _editing-patrons-label:
358
359 Editing patrons
360 ----------------------------------
361
362 Patrons in Koha can be edited using one of many edit buttons.
363
364 -  To edit the entire patron record simply click the 'Edit' button at
365    the top of the patron record.
366
367    |image427|
368
369 -  Patron passwords are not recoverable. The stars show on the patron
370    detail next to the password label are always there even if a password
371    isn't set. If a patron forgets their password the only option is to
372    reset their password. To change the patron's password, click the
373    'Change password' button.
374
375    |image428|
376
377    -  Koha cannot display existing passwords as they are encrypted in the
378       database. Leave the field blank to leave password unchanged.
379
380    -  This form can automatically generate a random password if you
381       click the link labeled "Click to fill with a randomly generated
382       suggestion. Passwords will be displayed as text."
383
384 -  To edit a specific section of the patron record (for example the
385    'Library use' section) click the 'Edit' button beside the section.
386
387    |image429|
388
389 -  A patron image can be added by browsing for the image on your machine
390    from the 'Manage patron image' section.
391
392    |image430|
393
394    -  This form will not appear if you have the
395       :ref:`patronimages` system preference to not allow
396       patron images.
397
398    -  To add patron images in bulk, use the :ref:`Upload patron
399       images <upload-patron-images-label>` tool.
400
401 -  Patrons can also be blocked from checking items out by setting Patron
402    flags
403
404    |image431|
405
406    -  If you would like your circulation staff to confirm a patron's
407       address before checking items out to the patron, you can see the
408       'Gone no address' flag
409
410       |image432|
411
412    -  If the patron reports that they have lost their card you can set
413       the 'Lost card' flag to prevent someone else from using that card
414       to check items out
415
416       |image433|
417
418    -  If you would like to bar a patron from the library you can add a
419       manual restriction
420
421       |image434|
422
423       -  **Note**
424
425              This flag can automatically be set with the :ref:`Overdue/notice
426              status triggers <overdue-notice/status-triggers-label>`
427
428    -  If you enter in a date and/or note related to the restriction you
429       will see that in the restricted message as well
430
431       |image435|
432
433 -  Children patrons do not become adults automatically in Koha unless
434    you have :ref:`Juvenile to adult cron job <cron-update-child-to-adult-patron-type-label>` running. To
435    upgrade a child patron to and adult patron category manually go to
436    the 'More' menu and choose 'Update child to adult patron'
437
438    |image436|
439
440    -  You will then be presented with a pop up window asking which one
441       of your adult patron categories this Child should be updated to
442
443       |image437|
444
445 .. _renew-patron-account-label:
446
447 Renew patron account
448 ----------------------------------
449
450 When renewing a patron account you can either edit the the expiry date
451 manually in the patron record or use the 'Renew patron' option from the
452 More menu in the toolbar at the top.
453
454 |image1393|
455
456 Using the latter the new expiry date will be calculated using the
457 enrollment period configured for the patron category of the user.
458 The system preference :ref:`BorrowerRenewalPeriodBase` determines if
459 the new expiry date will be calculated from the current date or from the
460 old expiry date.
461
462 One advantage of using the 'Renew patron' option is that it will be logged
463 as a membership renewal in the action_logs table and be visible as such
464 when using the :ref:`Log viewer <log-viewer-label>` or the
465 :ref:`Modificaton log <modification-log-label>` from the patron account.
466
467 The renewal date of the patron account will be visible on the details tab.
468
469 |image1392|
470
471 .. _managing-patron-self-edits-label:
472
473 Managing patron self edits
474 --------------------------------------------------
475
476 If you are allowing patrons to edit their accounts via the OPAC with the
477 :ref:`OPACPatronDetails` preference then you will need
478 to approve all changes via the staff client before they're applied. If
479 there are patron edits awaiting action they will appear on the staff
480 client dashboard below the modules list (along with other items awaiting
481 action).
482
483 |image438|
484
485     **Note**
486
487     Superlibrarians will see modifications for any branch, other staff
488     will only see modifications for patrons who belong to their logged
489     in branch.
490
491 When you click the 'Patrons requesting modifications' link you will be
492 brought to a list of patrons with requested changes.
493
494 |image439|
495
496 From here you can 'Approve' and apply the changes to the patron record,
497 'Delete' and remove the changes or 'Ignore' and keep the changes pending
498 to review later.
499
500 If you would like to see the entire patron record you can click the
501 'Patron details' links to the right of the buttons. This will open in a
502 new tab.
503
504 Merging patron records
505 -----------------------------------
506
507 If you accidentally end up with one patron with two cards it is possible
508 to merge their records together so that you don't lose their loan history
509 or holds.
510
511 -  In the patron list, check the boxes next to the records you want to
512    merge and click on the 'Merge selected patrons' button.
513
514 |image1326|
515
516     **Note**
517
518     It is possible to merge more than two records at a time.
519
520 -  Select the patron record you want to keep and click on the 'Merge
521    patrons' button.
522
523 |image1327|
524
525 The checkouts and statistics will be transferred to the right record and
526 the other one will be deleted.
527
528 |image1328|
529
530 .. _patron-permissions-label:
531
532 Patron permissions
533 -------------------------------------------
534
535 Patron permissions are used to allow staff members access to the staff
536 client.
537
538     **Important**
539
540     In order for a staff member to log into the staff interface they
541     must have (at the very least) 'catalogue' permissions which allow
542     them to view the staff interface.
543
544 .. _setting-patron-permissions-label:
545
546 Setting patron permissions
547 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
548
549 -  On the patron record click 'More' and choose 'Set permissions' to alter
550    patron permissions
551
552    |image440|
553
554 -  You will be presented with a list of preferences, some of which can
555    be expanded by clicking the 'Show details' link on the right
556    title.
557
558    |image441|
559
560 -  In all cases, if the parent permission is checked, the user has all the
561    child permissions. If you want to set permissions on a more granular level,
562    expand the section and only check the permissions you want that user to
563    have.
564
565
566 .. _patron-permissions-defined-label:
567
568 Patron permissions defined
569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
570
571 -  Access to all librarian functions (superlibrarian)
572
573       **Note**
574
575       With this selected there is no need to choose any other
576       permissions
577
578 -  Check out and check in items (circulate)
579
580    -  Remaining circulation permissions (circulate\_remaining\_permissions)
581
582       -  This permission grants all circulation rights except those covered by
583          permissions listed below
584
585    -  Force checkout if a limitation exists (force\_checkout)
586
587       -  With this permission a staff member will be allowed to override a
588          check out restriction in the following cases:
589
590          -  age restriction
591
592          -  the item is issued to another patron
593
594          -  the item is not for loan
595
596          -  the patron has overdue items
597
598          -  the item is lost
599
600          -  the item is a high demand item
601
602          -  the item is on hold
603
604    -  Mark checkout notes as seen\/not seen (manage\_checkout\_notes)
605
606       -  The permission to manage the checkout notes written by users
607           through the OPAC
608
609    -  Manage restrictions for accounts (manage\_restrictions)
610
611       -  Grants permission to the staff member to lift a restriction that
612          might be on the patron's record
613
614    -  Execute overdue items report (overdues\_report)
615
616       -  The permission to run the overdues reports found under Circulation
617
618    -  Override blocked renewals (override\_renewals)
619
620       -  With this permission, a staff member can override renewals if there
621          is a restriction
622
623       -  Requires that the staff member also has
624          circulate\_remaining\_permissions
625
626 -  Staff access, allows viewing the catalogue in staff client (catalogue)
627    **Required for staff login.**
628
629       **Important**
630
631       Must be given to all staff members to allow them to login
632       to the staff interface
633
634 -  Manage Koha system settings (Administration panel) (parameters)
635
636    -  Manage account debit and credit types (manage\_accounts)
637
638       -  This gives access to the :ref:`debit types section <debit-types-label>`
639
640    -  Manage additional fields for baskets or subscriptions (manage\_additional
641       \_fields)
642
643       -  This gives access to the :ref:`additional fields section <additional-
644          fields-label>`
645
646       -  **Important**
647
648          This permission requires that the staff member also have the 'Edit
649          an existing subscription' permission from the 'Manage serial
650          subscriptions' section and the 'Manage basket and order lines'
651          permission from the 'Acquisition and\/or suggestion management' section
652
653    -  Manage audio alerts (manage\_audio\_alerts)
654
655       - The ability to access the :ref:`audio alerts <audio-alerts-label>`
656         configuration in the administration module.
657
658    -  Manage authorized value categories and authorised values (manage\_auth\_
659       values)
660
661       - The ability to access the :ref:`auhorized values <authorized-values-label>`
662         configuration in the administration module.
663
664    -  Manage circulation rules (manage\_circ\_rules)
665
666       -  The ability to access the :ref:`circulation and fines rules
667          <circulation-and-fines-rules-label>` configuration in the
668          administration module.
669
670    -  Manage circulation rules form any library (manage\_circ\_rules\_from\_
671       any\_libraries)
672
673       -  If not set the logged in user can only edit circulation rules from
674          their own library
675
676       -  The staff member still has to have the 'Manage circulation rules'
677          permission above.
678
679    -  Manage cities and towns (manage\_cities)
680
681       -  The ability to access the :ref:`cities and towns <cities-and-towns-label>`
682          configuration in the administration module.
683
684    -  Manage classification sources and filing rules (manage\_classifications)
685
686       -  The ability to access the :ref:`classification sources
687          <classification-sources-label>` configuration in the administration
688          module.
689
690    -  Manage column configuration (manage\_column\_config)
691
692       -  The ability the access the :ref:`configure columns <column-settings-label>`
693          page in the administration module.
694
695    -  Manage Did you mean? configuration (manage\_didyoumean)
696
697       -  The ability to access the :ref:`Did you mean? <did-you-mean?-label>`
698          configuration in the administration module.
699
700    -  Manage item circulation alerts (manage\_item\_circ\_alerts)
701
702       -  The ability to access the :ref:`item circulation alerts <item-circulation-alerts-label>`
703          configuration in the administration module.
704
705    -  Manage item search fields (manage\_item\_search\_fields)
706
707       -  The ability to access the :ref:`item search fields <item-search-fields-label>`
708          configuration in the administration module.
709
710    -  Manage item types (manage\_itemtypes)
711
712       -  The ability to access the :ref:`item types <item-types-label>`
713          configuration in the administration module.
714
715    -  Manage keyboard shortcuts for the advanced cataloging editor (manage\_
716       keyboard\_shortcuts)
717
718       -  The ability to access the keyboard shortcuts configuration in the
719          administration module
720
721    -  Manage libraries and library groups (manage\_libraries)
722
723       -  The ability to access the :ref:`libraries <libraries-label>` and
724          :ref:`library groups <library-groups-label>` configuration pages
725          in the administration module.
726
727    -  Manage Mana KB content sharing (manage\_mana)
728
729       -  The ability to access the :ref:`share content with Mana KB
730          <share-with-mana-kb-label>` in the administration module
731
732    -  Manage MARC bibliographic and authority frameworks and test them
733       (manage\_marc\_frameworks)
734
735    -  The ability to access the
736       :ref:`MARC bibliographic framework <marc-bibliographic-frameworks-label>`,
737       :ref:`authority types <authority-types-label>`,
738       :ref:`Koha to MARC mapping <koha-to-marc-mapping-label>`, and
739       :ref:`MARC Bibliographic framework test <marc-bibliographic-framework-test-label>`
740       configuration areas in the administration module.
741
742    -  Manage record matching rules (manage\_matching\_rules)
743
744       -  The ability to access the :ref:`record matching rules <record-matching-rules-label>`
745          configuration in the administration module.
746
747    -  Manage OAI sets (manage\_oai\_sets)
748
749       -  The ability to access the :ref:`OAI sets <oai-sets-configuration-label>`
750          configuration in the administration module.
751
752    -  Manage extened patron attributes (manage\_patron\_attributes)
753
754       -  The ability to access the :ref:`patron attribute types <patron-attribute-types-label>`
755          configuration in the administration module.
756
757    -  Manage patron categories (manage\_patron\_categories)
758
759       -  The ability to access the :ref:`Patron categories <patron-categories-label>`
760          configuration in the administration module.
761
762    -  Manage search engine configuration (manage\_search\_engine\_config)
763
764       -  The ability to access the Search engine configuraton in the
765          administration module. Note: This area will only be visible when
766          the :ref:`SearchEngine` system preference is set to 'Elasticsearch'.
767
768    -  Manage Z39.50 and SRU server configuration (manage\_search\_targets)
769
770       -  The ability to access the :ref:`Z39.50/SRU servers <z39.50/sru-servers-label>`
771          configuration in the administration module.
772
773    -  Manage SMS cellular providers (manage\_sms_providers)
774
775       -  The ability to access the :ref:`SMS cellular providers
776          <sms-cellular-providers-label>` configuration in the administration
777          module. Note: This area will only be visible when the
778          :ref:`SMSSendDriver` system preference is set to 'Email'.
779
780    -  Manage global system preferences (manage\_sysprefs)
781
782       -  The ability to access the :ref:`global system preferences
783          <administration-system-preferences-label>` in the administration module.
784
785    -  Manage library transfer limits and transport cost matrix (manage\_transfers)
786
787       -  The ability to access the :ref:`library transfer limits <library-transfer-limits-label>`
788          and :ref:`transport cost matrix <transport-cost-matrix-label>`
789          configuration pages in the administration module.
790
791    -  Manage usage statistics settings (manage\_usage\_stats)
792
793       -  The ability to access the :ref:`share your usage statistics <share-anonymous-usage-statistics-label>`
794          configuration in the administration module.
795
796    -  Remaining system parameters permissions (parameters\_remaining\_permissions)
797
798       -  The ability to access all remaining areas in the administration module.
799
800 -  Add, modify and view patron information (borrowers)
801
802    -  Add, modify and view patron information (edit\_borrowers)
803
804       -  The ability to access the Patrons module to view patron files,
805          as well as adding new patrons and editing patron files
806
807    -  View patron infos from any libraries (view\_borrower\_infos\_from\_any\_libraries)
808
809    -  If not set the logged in user will only be able to access patron
810       information from their own library or group of libraries.
811
812 -  Set user permissions (permissions)
813
814    -  The ability to set permissions for other staff members
815
816 -  Place and modify holds for patrons (reserveforothers)
817
818    -  Modify holds priority (modify\_holds\_priority)
819
820       -  Allows staff members to alter the holds priority (moving patrons up
821          and down the queue)
822
823    -  Place holds for patrons (place\_holds)
824
825       -  Allows staff members to place holds in the staff interface
826
827 -  Edit catalog (Modify bibliographic/holdings data) (editcatalogue)
828
829    -  Use the advanced cataloging editor (advanced\_editor)
830
831       -  Grants the ability to use the advanced cataloging editor in the
832          cataloging module
833
834       -  **Note**
835
836          Staff members with this permission need to also have the 'Edit catalog
837          (Modify bibliographic/holdings data)' permission
838
839    -  Delete all items at once (delete\_all\_items)
840
841       -  Ability to use the 'Delete all items' option found under the
842          'Edit' menu in cataloging
843
844    -  Edit catalog (Modify bibliographic/holdings data) (edit\_catalogue)
845
846       -  Ability to access all cataloging functions via the
847          `Cataloging <#cataloging>`__ page
848
849    -  Edit items (edit\_items)
850
851       -  Ability to make :ref:`edits to item/holdings
852          records <editing-items-label>`, but not bibliographic records
853
854    -  Limit item modification to subfields defined in the
855       :ref:`SubfieldsToAllowForRestrictedEditing` system preference
856       (edit\_items\_restricted)
857
858       -  If checked, the staff member will only be able to modify some
859          item subfields
860
861       -  **Note**
862
863          Please note that the 'Edit items' permission is still required
864
865    -  Fast cataloging (fast\_cataloging)
866
867       -  The ability to catalog using only the :ref:`Fast add
868          framework <fast-add-cataloging-label>` found on the
869          `Circulation <#circulation>`__ page
870
871 -  Manage patrons fines and fees (updatecharges)
872
873    -  Payout credits to patrons (payout)
874
875       -  Grants the ability to reimburse credits to patrons
876
877    -  Remaining permissions for managing fines and fees (remaining\_permissions)
878
879       -  Grant the ability to manage fines and fees other than the actions
880          described in the other subpermissions (paying out credits and writing
881          off fees)
882
883    -  Write off fines and fees (writeoff)
884
885       -  Grants the ability to write off patron fees
886
887
888 -  Acquisition and/or suggestion management (acquisition)
889
890    **Note**
891
892    All the acquisitions sub-permissions give access to the acquisitions home
893    page. That means that staff who have one or more of the following permissions
894    will be able to view the budgets, search and view vendor information, and
895    view invoices.
896
897    -  Add and delete funds (but can't modify funds) (budget\_add\_del)
898
899       -  Grants the ability to add and delete funds within a budget
900
901       -  Note that the budget\_manage and budget\_modify permissions are
902          required for this one to work correctly
903
904    -  Manage funds (budget\_manage)
905
906       -  Grants the ability to acces the :ref:`fund administration page <funds-label>`
907
908       -  Note that this only gives viewing access to the page, you will need
909          to give your staff budget\_add\_del and budget\_modify if you want
910          them to be able to make changes to the funds
911
912    -  Manage all funds (budget\_manage\_all)
913
914       -  Grants viewing access to all funds regardless of restrictions on
915          them (owner, user or library restrictions)
916
917       -  Note that the budget\_manage permission is required
918
919    -  Modify funds (can't create lines, but can modify existing ones) (budget\_modify)
920
921       -  Grants the ability to edit fund information and amounts
922
923       -  Note that the budget\_add\_del and budget\_manage permissions are
924          required for this one to work correctly
925
926    -  Manage contracts (contracts\_manage)
927
928       -  Grants the ability to add, edit and delete contracts with vendors
929
930    -  Manage currencies and exchange rates (currencies\_manage)
931
932       -  The ability to access the :ref:`Currencies and exchange rates
933          <currencies-and-exchange-rates-label>` configuration page.
934
935    -  Manage EDIFACT transmissions (edi\_manage)
936
937       -  Grants the ability to access the :ref:`EDI account <edi-accounts-label>`
938          adminitration page, the :ref:`library EANs <library-eans-label>`
939          administration page and access sent :ref:`EDI messages <edifact-messages-label>`
940
941       -  In order to be able to send orders via EDI, your staff member also
942          needs the
943
944    -  Manage basket groups (group\_manage)
945
946       -  Grants the ability to :ref:`create, edit, close and delete basket
947          groups <create-a-basket-group-label>`
948
949    -  Manage baskets and order lines (order\_manage)
950
951       -  Grants the ability to :ref:`place orders <placing-orders-label>`,
952          including creating baskets, adding order lines, closing baskets, etc.
953
954    -  Manage all baskets and order lines, regardless of restrictions on them
955       (order\_manage\_all)
956
957       -  Grants the ability to manage all baskets and orders even if they are
958          restricted to the owner, users or library
959
960       -  Note that the order\_manage permission is required
961
962    -  Receive orders and manage shipments (order\_receive)
963
964       -  Grants the ability to create invoices, receive items and claim late
965          orders
966
967    -  Manage budgets (period\_manage)
968
969       -  Grants access to the :ref:`budget administration page <budgets-label>`
970          and the ability to create, edit and delete budgets
971
972       -  This permission does not give the ability to edit budget funds.
973
974    -  Manage budget plannings (planning\_manage)
975
976       -  Grants the ability to view :ref:`budget planning <budget-planning-label>`
977
978       -  Note that the budget\_manage and the period\_manage permissions are
979          required for this one to work
980
981    -  Manage purchase suggestions (suggestions\_manage)
982
983       -  Grants the ability to :ref:`create and manage purchase suggestions
984          <managing-purchase-suggestions-label>`, including creating new
985          suggestions and changing the suggestions' statuses
986
987    -  Manage vendors (vendors\_manage)
988
989       -  Grants the ability to :ref:`add, edit and delete vendors <vendors-label>`
990
991       -  Note that vendors are used in the acquisition and the serials module.
992
993 -  Use all tools (tools)
994
995    -  Access to the files stored on the server (access\_files)
996
997       -  Access to the :ref:`Upload tool <upload-label>`
998
999    -  Upload patron images in batch or one at a time (batch\_upload\_patron\_images)
1000
1001       -  Access to the :ref:`Image upload tool <upload-patron-images-label>`
1002
1003    -  Delete old borrowers and anonymize circulation/reading history
1004       (deletes borrower reading history) (delete\_anonymize\_patrons)
1005
1006       -  Access to the :ref:`Anonymize patron tool <patrons-anonymize-bulk-delete-label>`
1007
1008    -  Define days when the library is closed (edit\_calendar)
1009
1010       -  Access to the :ref:`Calendar/holidays tool <calendar-label>`
1011
1012    -  Write news for the OPAC and staff interfaces (edit\_news)
1013
1014       -  Access to the :ref:`News tool <news-label>`
1015
1016    -  Set notice/status triggers for overdue items (edit\_notice\_status\_triggers)
1017
1018       -  Access to the :ref:`Overdue notice status/triggers
1019          tool <overdue-notice/status-triggers-label>`
1020
1021    -  Define notices (edit\_notices)
1022
1023       -  Access to the :ref:`Notices and slips tool <notices-and-slips-label>`
1024
1025    -  Perform batch modification of patrons (edit\_patrons)
1026
1027       -  Access to the :ref:`Batch patron modification tool <batch-patron-modification-label>`
1028
1029    -  Edit quotes for the quote-of-the-day feature (edit\_quotes)
1030
1031       -  Access to the :ref:`Quote of the Day (QOTD) Editor <quote-of-the-day-(qotd)-editor-label>`
1032
1033    -  Export bibliographic and holdings data (export\_catalog)
1034
1035       -  Access to the :ref:`Export data tool <export-data-(marc-and-authorities)-label>`
1036
1037    -  Import patron data (import\_patrons)
1038
1039       -  Access to the :ref:`Import patrons tool <patron-import-label>`
1040
1041    -  Perform inventory of your catalog (inventory)
1042
1043       -  Access to the :ref:`Inventory tool <inventory-tool-label>`
1044
1045    -  Perform batch deletion of items (items\_batchdel)
1046
1047       -  Access to the :ref:`Batch item deletion tool <batch-item-deletion-label>`
1048
1049    -  Perform batch modification of items (items\_batchmod)
1050
1051       -  Access to the :ref:`Batch item modification tool <batch-item-modification-label>`
1052
1053    -  Limit batch item modification to subfields defined in the
1054       SubfieldsToAllowForRestrictedBatchmod preference (items\_batchmod\_restricted)
1055
1056       -  Restricts the :ref:`batch item modification <batch-item-modification-label>` tool
1057          to modify only the subfields defined in the
1058          :ref:`SubfieldsToAllowForRestrictedBatchmod` preference
1059
1060       -  Please note that items\_batchmod permission is still required
1061
1062    -  Create printable labels and barcodes from catalog and patron data
1063       (label\_creator)
1064
1065       -  Access to the :ref:`Patron card creator <patron-card-creator-label>`,
1066          the :ref:`Label creator <label-creator-label>` and the
1067          :ref:`Quick label creator <quick-spine-label-creator-label>` tools
1068
1069    -  Manage CSV export profiles (manage\_csv\_profiles)
1070
1071       -  Access to the :ref:`CSV profiles tool <csv-profiles-label>`
1072
1073    -  Add, edit and delete patron lists and their contents (manage\_patron\_lists)
1074
1075       -  Access to the :ref:`Patron lists tool <patron-lists-label>`
1076
1077    -  Manage staged MARC records, including completing and reversing imports
1078       (manage\_staged\_marc)
1079
1080       -  Access to the :ref:`Manage staged MARC records tool <staged-marc-record-management-label>`
1081
1082    -  Manage MARC modification templates (marc\_modification\_templates)
1083
1084       -  Access to the :ref:`MARC modification templates tool <marc-modification-templates-label>`
1085
1086    -  Moderate patron comments (moderate\_comments)
1087
1088       -  Access to the :ref:`Comments tool <comments-label>`
1089
1090    -  Moderate patron tags (moderate\_tags)
1091
1092       -  Access to the :ref:`Tags tool <tag-moderation-label>`
1093
1094    -  Perform batch deletion of records (bibliographic or authority)
1095       (records\_batchdel)
1096
1097       -  Access to the :ref:`Batch record deletion tool <batch-record-deletion-label>`
1098
1099    -  Perform batch modification of records (bibliographic or authorities)
1100       (records\_batchmod)
1101
1102       -  Access to the :ref:`Batch record modification tool <batch-record-modification-label>`
1103
1104    -  Manage rotating collections (rotating\_collections)
1105
1106       -  Access to the :ref:`Rotating collections tool <rotating-collections-label>`
1107
1108    -  Schedule tasks to run (schedule\_tasks)
1109
1110       -  Access to the :ref:`Task scheduler tool <task-scheduler-label>`
1111
1112    -  Stage MARC records into the reservoir (stage\_marc\_import)
1113
1114       -  Access to the :ref:`Stage MARC records tool <stage-marc-records-for-import-label>`
1115
1116    -  Upload any file (upload\_general\_files)
1117
1118       -  Access to upload files via the :ref:`Upload tool <upload-label>`
1119
1120    -  Upload local cover images (upload\_local\_cover\_images)
1121
1122       -  Access to the :ref:`Upload local cover image
1123          tool <upload-local-cover-image-label>` as well as permission to add and
1124          delete local cover images from the record detail page
1125
1126    -  Manage uploaded files (upload\_manage)
1127
1128       -  Access to uploaded files via the :ref:`Upload tool <upload-label>`
1129
1130       -  Note that the upload\_general\_files permission is required for this
1131          permission to work
1132
1133    -  Browse the system logs (view\_system\_logs)
1134
1135       -  Access to the :ref:`Log viewer tool <log-viewer-label>`
1136
1137 -  Edit authorities (editauthorities)
1138
1139    -  Grants the ability to create, edit and delete authority records
1140
1141    -  Note that it is possible to search authority records with only the
1142       catalogue permission
1143
1144 -  Manage serial subscriptions (serials)
1145
1146    -  Check the expiration of a serial (check\_expiration)
1147
1148    -  Gives ability to check the :ref:`expiration date of serials
1149       <check-serial-expiration-label>`
1150
1151    -  Claim missing serials (claim\_serials)
1152
1153       -  Gives the ability to :ref:`claim missing issues <claim-late-serials-label>`
1154
1155    -  Create a new subscription (create\_subscription)
1156
1157       -  Gives the ability to :ref:`add new subscriptions <add-a-subscription-label>`
1158
1159    -  Delete an existing subscription (delete\_subscription)
1160
1161       -  Gives the ability to delete serial subscriptions
1162
1163    -  Edit an existing subscription (edit\_subscription)
1164
1165       -  Gives the ability to :ref:`edit existing serial subscriptions
1166          <edit-subscription-label>`
1167
1168       -  This permission does not include the ability to delete or create a
1169          subscription
1170
1171    -  Serials receiving (receive\_serials)
1172
1173       -  Gives the ability to :ref:`receive issues <receive-issues-label>` of
1174          existing subscriptions
1175
1176    -  Renew a subscription (renew\_subscription)
1177
1178       -  Gives the ability to :ref:`renew serial subscriptions <renewing-serials-label>`
1179
1180    -  Routing (routing)
1181
1182       -  Gives the ability to manage :ref:`routing lists <create-a-routing-list-label>`
1183
1184    -  Manage subscriptions from any branch (superserials)
1185
1186       -  This permission is only useful if the :ref:`IndependentBranches`
1187          system preference is used
1188
1189 -  Allow access to the reports module (reports)
1190
1191    -  Reports found on the :ref:`Circulation page <circulation-reports-label>`
1192       are not controlled by this permission; this only controls access to the
1193       :ref:Reports module <reports-label>`
1194
1195    -  Reports in the :ref:`Statistics wizard <statistics-reports-label>` section
1196       and the other reports on the main reports page can be run with any one
1197       of the following permissions. They only affect the SQL reports.
1198
1199    -  Create SQL reports (create\_reports)
1200
1201       -  The ability to create :ref:`guided reports <guided-report-wizard-label>`
1202          or :ref:`SQL reports <report-from-sql-label>`, but not run saved ones
1203
1204    -  Delete SQL reports (delete\_reports)
1205
1206       -  The ability to delete saved :ref:`SQL reports <report-from-sql-label>`
1207
1208       -  Note that you need execute\_reports in order to be able to delete them
1209
1210    -  Execute SQL reports (execute\_reports)
1211
1212       -  The ability to :ref:`run custom SQL reports <running-custom-reports-label>,
1213          but not create or edit them
1214
1215 -  Allow staff members to modify permissions for other staff members (staffaccess)
1216
1217    -  This permission requires the borrowers permission above
1218
1219 -  Course reserves (coursereserves)
1220
1221    -  Allow access to the :ref:`course reserves module <course-reserves-label>`
1222
1223    -  Note that if the :ref:`UseCourseReserves` system preference is not enabled,
1224       these permissions will not have any effect
1225
1226    -  Add course reserves (add\_reserves)
1227
1228       -  Grants the ability to :ref:`add items to existing courses
1229          <adding-reserve-materials-label>`
1230
1231    -  Remove course reserves (delete\_reserves)
1232
1233       -  Grant the ability to remove items from existing courses
1234
1235    -  Add, edit and delete courses (manage\_courses)
1236
1237       -  Grants the ability to :ref:`create, edit and delete courses
1238          <adding-courses-label>`, but not manage the items
1239
1240 -  Koha plugins (plugins)
1241
1242    -  Note that the :ref:`UseKohaPlugins` system preference needs to be enabled
1243       otherwise, these permissions don't have any effect.
1244
1245    -  Configure plugins (configure)
1246
1247       -  Gives the ability to run the 'configure' section of a plugin if it has
1248          one
1249
1250       -  Note that the staff member needs either the report permission or the
1251          tool permission (below) in order to be able to access the plugins
1252
1253    -  Manage plugins (manage)
1254
1255       -  The ability to install or uninstall plugins
1256
1257       -  Note that the staff member needs either the report permission or the
1258          tool permission (below) in order to be able to access the plugins
1259
1260    -  Use report plugins (report)
1261
1262       -  The ability to use report plugins
1263
1264    -  Use tool plugins (tool)
1265
1266       -  The ability to use tool plugins
1267
1268 -  Lists (lists)
1269
1270       **Important**
1271
1272       All staff have permission to create and modify their own
1273       lists, this permission is only necessary if you'd like to give
1274       a staff member permission to delete public lists that they
1275       have not created.
1276
1277    -  Delete public lists (delete\_public\_lists)
1278
1279       -  The ability to delete public lists created by someone else
1280
1281 -  Patron clubs (clubs)
1282
1283    -  Create and edit clubs (edit\_clubs)
1284
1285       -  Create and edit patron clubs using the :ref:`Patron clubs tool <patron-clubs-label>`
1286
1287    -  Create and edit club templates (edit\_templates)
1288
1289       -  Create and edit club templates using the :ref:`Patron clubs tool <patron-clubs-label>`
1290
1291    -  Enroll patrons in clubs (enroll)
1292
1293       -  Enroll patrons from the patron file
1294
1295       -  The borrowers permissions is required in order to enroll patrons in
1296          clubs
1297
1298 -  Create and modify interlibrary loan requests (ill)
1299
1300    -  Gives access to the :ref:`Interlibrary loan (ILL) module <ill-requests-label>`
1301
1302 -  Self check modules (self\_check)
1303
1304    -  Log into the self check-in module (self\_checkin\_module)
1305
1306       ** Note**
1307
1308       This permission prevents the patron from using any other OPAC
1309       functionality
1310
1311 -  Perform self checkout at the OPAC (self\_checkout\_module)
1312
1313       **Note**
1314
1315       This permission should be used for the patron matching the
1316       :ref:`AutoSelfCheckID <autoselfcheck-preferences-label>`
1317       system preference
1318
1319 -  Manage :ref:`stockrotation <stock-rotation-label>` operations (stockrotation)
1320
1321    -  Add and remove items from rotas (manage_rota_items)
1322
1323       -  Staff with only this permission will be able to manage the items in the
1324          rotas, but not the rotas themselves
1325
1326    -  Create, edit and delete rotas (manage_rotas)
1327
1328       -  Staff with only this permission will be able to manage the rotas, but not
1329          the actual items
1330
1331 -  Cash management (cash_management)
1332
1333    -  Add, edit and archive cash registers (manage_cash_registers)
1334
1335       -  Staff with this permissions will be able to manage the :ref:`cash
1336          registers in the administration module <cashregisters-label>`
1337
1338    -  Access the point of sale page and take payments (takepayment)
1339
1340       -  Grants access to the point of sale module
1341
1342 .. _patron-information-label:
1343
1344 Patron information
1345 -------------------------------------------
1346
1347 When viewing a patron record you have the option to view information
1348 from one of many tabs found on the left hand side of the record.
1349
1350 -  *Get there:* Patrons > Browse or search for patron > Click patron
1351    name
1352
1353 .. _check-out-label:
1354
1355 Check out
1356 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1357
1358 For instruction on checking items out, view the :ref:`Checking
1359 out <check-out-(issuing)-label>` section of this manual.
1360
1361 Staff members can access their own check out screen by clicking their
1362 username in the top right of the staff client and choosing 'My
1363 checkouts'
1364
1365 |image1178|
1366
1367 .. _details-label:
1368
1369 Details
1370 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1371
1372      **Note**
1373
1374      Staff members can access their own account details by clicking their
1375      username in the top right of the staff client and choosing 'My account'
1376
1377      |image442|
1378
1379 All patron information will appear in the Details tab. This includes all
1380 the contact information, notes, custom patron attributes, messaging
1381 preferences, etc. entered when adding the patron.
1382
1383 |image1359|
1384
1385 In the case of patrons who are marked as 'Child' or 'Professional' and
1386 their guarantors additional information will appear on their record.
1387
1388 -  A child patron will list their guarantor
1389
1390    |image443|
1391
1392 -  On the guarantor's record, all children and/or professionals will be
1393    listed
1394
1395    |image444|
1396
1397 .. _circulation-summary-label:
1398
1399 If the age of the patron is outside the age range defined in their patron
1400 category a warning will appear on their record.
1401
1402    |image1461|
1403
1404 Circulation summary
1405 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1406
1407 Below the patron's information on the details screen is a tabbed display
1408 of the items they have checked out, overdue, and on hold.
1409
1410 Checkouts
1411 ''''''''''''''''''''''''''''''''''''''''''
1412
1413 The first tab shows the items the patron currently has checked out.
1414
1415 |image445|
1416
1417 Relatives' checkouts
1418 ''''''''''''''''''''''''''''''''''''''''''
1419
1420 If they have family at the library, staff can see what the other family
1421 members have checked out.
1422
1423 |image446|
1424
1425 Fines & charges
1426 '''''''''''''''''''''''''''''''''''''''''
1427
1428 The Fines & charges tab will show for all patrons, even those who
1429 don't owe anything.
1430
1431 If the patron does owe money to the library, the tab will show the
1432 total amount, without any details. To see the details, go to the
1433 :ref:`fines tabs <fines-label>`.
1434
1435 |image1360|
1436
1437 Holds
1438 '''''''''''''''''''''''''''''''''''''''''
1439
1440 If the patron has holds, the number of holds will appear on this tab's
1441 title and the details will appear in the tab.
1442
1443 |image490|
1444
1445      **Note**
1446
1447      The barcode and call number will only appear on item-level holds or
1448      holds that have been confirmed. Record-level holds that are not
1449      waiting to be picked up will not have barocdes or call numbers.
1450
1451 From here you can manage the patron's holds: change the pickup library,
1452 cancel or suspend holds.
1453
1454      **Note**
1455
1456      You will only be able to suspend holds if the :ref:`SuspendHoldsIntranet`
1457      system preference is set to "Allow".
1458
1459      **Note**
1460
1461      If, when suspending a hold, you want to be able to set a date at which to
1462      automatically resume the hold, set the :ref:`AutoResumeSuspendedHolds`
1463      system preference to "Allow" and make sure the :ref:`unsuspend_holds cron
1464      job <cron-unsuspend-holds-label>` is activated.
1465
1466 .. _article-requests-label:
1467
1468 Article requests
1469 '''''''''''''''''''''''''''''''''''''''''''''
1470
1471 If the :ref:`ArticleRequests` system preference is enabled, and the circulation
1472 rules allow it, the patrons will be able to request articles, either through the
1473 OPAC or in the staff interface.
1474
1475 The details of the patron's request, and its status, are visible in this
1476 tab.
1477
1478 |image1361|
1479
1480 Restrictions
1481 ''''''''''''''''''''''''''''''''''''''''''''
1482
1483 The Restrictions tab will show for all patrons. If the patron has no
1484 restrictions you will see that on the tab.
1485
1486 |image447|
1487
1488 If the patron has restrictions on their account the tab will show the
1489 number and the description.
1490
1491 There are four kinds of restrictions:
1492   - Manual
1493   - Overdues
1494   - Suspension
1495   - Discharge
1496
1497 Using the 'Add manual restriction' button you can add a restriction to
1498 the patron record from here. This can be used for any type of restriction
1499 you need to put manually on a patron record.
1500
1501 |image449|
1502
1503 |image448|
1504
1505 The overdues restrictions are automatically set when overdue notices are sent
1506 if you specified you wanted the patron restricted in the
1507 :ref:`Overdue notice/status triggers tool <overdue-notice/status-triggers-label>`.
1508
1509 This restriction will not be removed automatically when the overdue items are
1510 returned unless the :ref:`AutoRemoveOverduesRestrictions` system preference
1511 is set to 'Do'.
1512
1513 In the :ref:`circulation rules <circulation-and-fines-rules-label>`, you can choose
1514 to fine users by suspending them instead of (or in addition to) fining them money.
1515 In that case, returning an overdue document will trigger a suspension restriction.
1516
1517 Patrons may also be restricted if you have issued a :ref:`discharge <patron-discharges-label>` for them. Once the discharge is validated, the patron is automatically restricted.
1518
1519 Restrictions on a patron record will block checkouts. In fact,
1520 a message will appear in red when going to the checkout page.
1521
1522 |image1363|
1523
1524 Restrictions may also prevent renewing items if the :ref:`RestrictionBlockRenewing`
1525 system preference is set to 'block'.
1526
1527 On the OPAC, patrons will get a message saying their account is frozen. They will
1528 not be able to place holds from the OPAC.
1529
1530 If you have patrons that have more than one restriction, you can choose to
1531 cumulate their restriction periods or not through the :ref:`CumulativeRestrictionPeriods`
1532 system preference.
1533
1534      **Note**
1535
1536      If you want to restrict patrons from doing various actions if their record
1537      is not pristine, check the following system preferences:
1538
1539      - Set the :ref:`OverduesBlockCirc` system preference to 'Block' to prevent
1540        patrons who have overdue materials from checking out other materials.
1541      - Set the :ref:`OverduesBlockRenewing` system preference to 'block renewing
1542        for all the patron's items' or 'block renewing only for this item' to prevent
1543        patrons who have overdue materials from renewing their loans.
1544      - Enter values in the :ref:`noissuescharge` and :ref:`NoIssuesChargeGuarantees`
1545        system preferences in order to block checking out to patrons who have more
1546        than a certain amount in fines or to patrons whose guarantees owe more than
1547        a certain amount.
1548      - Enter a value in the :ref:`maxoutstanding` system preference to prevent
1549        patron from placing holds on the OPAC if they owe more than a certain amount.
1550      - Enter a value in the :ref:`OPACFineNoRenewals` system preference to prevent
1551        patron who owe more than a certain amount to renew their loans from the OPAC.
1552      - Set the :ref:`BlockExpiredPatronOpacActions` system preference to 'Block' if
1553        you want to prevent patron whose membership has expired to place hold or
1554        renew their loans from the OPAC.
1555
1556 Clubs
1557 '''''''''''''''''''''''''''''''''''''''''''
1558
1559 If you use :ref:`patron clubs <patron-clubs-label>`, patrons will have a tab
1560 in their record indicating which club they are enrolled in, if any.
1561
1562 |image1362|
1563
1564 .. _fines-label:
1565
1566 Fines
1567 ~~~~~~~~~~~~~~~~~~~~~~~~
1568
1569 The patron's complete accounting history will appear on the Fines tab.
1570 Contrary to its name, the Fines tab does not just show fine data, it
1571 also shows membership fees, rental fees, reserve fees and any other
1572 charge you may have for patrons.
1573
1574 |image450|
1575
1576 The Accounts tab will show you the following columns:
1577
1578 -  Date: the date the charge/payment was posted
1579
1580    -  In the case of fines this will be the last day that the fine was
1581       accrued
1582
1583 -  Description: a description of the charges including the due date for
1584    overdue items and a link to the item record where one is available
1585
1586 -  Home library: if the charge is linked to a particular item the home library
1587    is displayed
1588
1589 -  Note: any notes about this charge/payment
1590
1591    -  If you're allowing patrons to pay fines via the OPAC with PayPal
1592       (:ref:`EnablePayPalOpacPayments <enablepaypalopacpayments-and-paypalsandboxmode-label>`) you
1593       will see a Note that says 'PayPal' for items paid this way
1594
1595 -  Amount: the total amount of the payment or charge
1596
1597 -  Outstanding: the amount still due on charge
1598
1599 -  Actions column:
1600
1601    -  A link to print a receipt for that line item
1602
1603    -  A link to show further details about the charge and any payments that
1604       have been made
1605
1606    -  A link to void (delete) the payment
1607
1608 At the top of the table you can click the 'Filter paid transaction' to
1609 hide all completed transaction and above that you can use the search box
1610 to find a specific charge or payment.
1611
1612 .. _charging-fines/fees-label:
1613
1614 Charging fines/fees
1615 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616
1617 Most fees and fines will be charged automatically if the :ref:`fines cron
1618 job <cron-fines-label>` is running:
1619
1620 -  Fines will be charged based on your :ref:`circulation and fines
1621    rules <circulation-and-fines-rules-label>`
1622
1623 -  Hold fees will be charged based on the rules you set in the :ref:`Patron
1624    types and categories <patron-categories-label>` administration area
1625
1626 -  Rental fees will be charged based on the settings in your :ref:`Item
1627    iypes <item-types-label>` administration area
1628
1629 -  Marking an item 'Lost' via the cataloging module will automatically
1630    charge the patron the replacement cost for that item
1631
1632 .. _pay/reverse-fines-label:
1633
1634 Pay/Void fines
1635 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1636
1637 Each line item can be paid in full (or written off) using the 'Pay
1638 fines' tab.
1639
1640 |image451|
1641
1642 -  Each line item can be paid in full, partially paid, or written off.
1643
1644 -  Pay a fine in full
1645
1646    -  If you have a note about the payment please type that first then
1647       move on
1648
1649    -  Click "Pay" next to the fine you want to pay in full
1650
1651    -  The full amount of the fine will be populated for you in the
1652       "Collect from patron" box
1653
1654    -  If one or more values are defined under the PAYMENT\_TYPE authorized value
1655       category a dropdown selection box will be displayed to specify a custom
1656       payment type
1657
1658       |image452|
1659
1660    -  If the :ref:`UseCashRegisters` system preference is enabled, you will
1661       have a choice of cash register in which to enter the transaction
1662
1663    -  Click "Confirm"
1664
1665    -  The fine will be removed from outstanding fines, and displayed as
1666       fully paid.
1667
1668 -  Pay a partial fine
1669
1670    -  Click "Pay" next to the fine you want to partially pay
1671
1672    -  Enter the amount you are collecting from the patron in the
1673       "Collect from patron" box
1674
1675       |image453|
1676
1677    -  Click "Confirm"
1678
1679    -  The fine will be updated to show the original amount, and the
1680       current amount outstanding
1681
1682 -  Pay an amount towards all fines
1683
1684    -  Click the "Pay amount" button
1685
1686    -  Enter the amount you are collecting from the patron in "Collect
1687       from patron." The sum of all fines is shown in "Total amount
1688       outstanding"
1689
1690       |image454|
1691
1692    -  Click "Confirm"
1693
1694    -  The fine totals will be updated with the payment applied to oldest
1695       fines first.
1696
1697 -  Pay selected fines
1698
1699    -  Check the selection boxes next to the fines you wish to pay, click
1700       "Pay selected"
1701
1702       |image455|
1703
1704    -  Enter an amount to pay towards the fines.
1705
1706       |image456|
1707
1708    -  Click "Confirm"
1709
1710    -  The fine totals will be updated with the payment applied to the
1711       oldest selected fines first.
1712
1713 -  Writeoff a single fine
1714
1715    -  Click "Writeoff" next to the fine you wish to writeoff.
1716
1717    -  A confirmation box will appear to specify a total amount to writeoff.
1718       This box allows a partial writeoff of fines.
1719
1720    -  The fine will be removed from outstanding fines, and displayed as
1721       written off.
1722
1723 -  Writeoff selected fines
1724
1725     -  Check the selection boxes next to the fines you wish to pay, click "Writeoff selected".
1726
1727     -  Click "Confirm".
1728
1729     -  The fine will be removed from outstanding fines, and displayed as written off.
1730
1731 -  Writeoff all fines
1732
1733    -  Click the "Writeoff all" button
1734
1735    -  All fines will be removed from outstanding fines, and displayed as written off.
1736
1737
1738 -  If you accidentally mark and item as paid, you can reverse that line
1739    item by clicking 'Void' to the right of the line
1740
1741    |image457|
1742
1743    -  Once clicked a new line item will be added to the account showing
1744       the payment as ‘Voided’.  The payment line is added back to
1745       the Pay fines tab as an outstanding charge.
1746
1747       |image458|
1748
1749       **Note**
1750
1751       - You can enable email receipts for payment and writeoff transactions
1752         with the :ref:`UseEmailReceipts` system preference.
1753
1754 .. _creating-manual-invoices-label:
1755
1756 Creating manual invoices
1757 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1758
1759 For fees that are not automatically charged, librarians can create a
1760 manual invoice
1761
1762 |image459|
1763
1764 -  First choose the type of invoice you would like to create
1765
1766    -  To add additional values to the manual invoice type pull down
1767       menu, add them to the :ref:`debit types <add-debit-type-label>`
1768       in the Administration module.
1769
1770 -  If the fee is associated with an item you can enter its barcode so
1771    that the line item shows a link to that item
1772
1773 -  The description field is where you will enter the description of the
1774    charge
1775
1776 -  In the amount field, do not enter currency symbols, only numbers and
1777    decimals
1778
1779 .. _creating-manual-credits-label:
1780
1781 Creating manual credits
1782 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1783
1784 Manual credits can be used to pay off parts of fines, or to forgive a
1785 fine amount.
1786
1787 |image460|
1788
1789 -  First choose the type of credit you'd like to apply
1790
1791 -  If this credit is associated with an item you can enter that item's
1792    barcode so that the line item links to the right item
1793
1794 -  The description field is where you will enter the description of the
1795    credit
1796
1797 -  In the amount field, do not enter currency symbols, only numbers and
1798    decimals
1799
1800 .. _printing-invoices-label:
1801
1802 Printing invoices
1803 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1804
1805 To the right of each account line there is a print link. Clicking that
1806 link will print an invoice for the line item that includes the date and
1807 description of the line item along with the total outstanding on the
1808 account.
1809
1810 |image461|
1811
1812 .. _routing-lists-label:
1813
1814 Routing lists
1815 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1816
1817 A list of all of the serial routing lists the patron belongs to will be
1818 accessible via the 'Routing lists' tab on the patron record.
1819
1820 |image462|
1821
1822 On this tab you will be able to see and edit all of the routing lists
1823 that this patron is on.
1824
1825 |image463|
1826
1827 .. _circulation-history-label:
1828
1829 Circulation history
1830 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1831
1832 The circulation history tab will appear if you have set the
1833 :ref:`intranetreadinghistory` preference to allow
1834 it to appear. If you have the :ref:`OPACPrivacy` system
1835 preference set to 'Allow' and the patron has decided that the library
1836 cannot keep this information this tab will only show currently checked
1837 out items.
1838
1839 |image464|
1840
1841 If you would like to export a list of barcodes for the items checked in
1842 today you can find that option under the More menu on the top right of
1843 the page.
1844
1845 |image465|
1846
1847 This will generate a text file with one barcode per line.
1848
1849 .. _modification-log-label:
1850
1851 Modification log
1852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1853
1854 If you have set your :ref:`BorrowersLog` to track changes
1855 to patron records, then this tab will appear. The Modification log will
1856 show when changes were made to the patron record. If you also have
1857 turned on the :ref:`IssueLog` and :ref:`ReturnLog`
1858 you will see checkins and outs on this screen as well.
1859
1860 |image466|
1861
1862 -  The Librarian field shows the patron number for the librarian who
1863    made the changes
1864
1865 -  The module lists 'MEMBERS' for the patron module
1866
1867 -  The action will tell you what action was being logged
1868
1869 -  The Object field lists the borrowernumber that is being modified (in
1870    the example above, it was my changing my own record)
1871
1872 .. _notices-label:
1873
1874 Notices
1875 ~~~~~~~~~~~~~~~~~~~~~~~~~
1876
1877 The `patron's messaging preferences <#setpatronmessaging>`__ are set
1878 when :ref:`adding <add-a-new-patron-label>` or :ref:`editing <editing-patrons-label>` the
1879 patron. This tab will show the messages that have been sent and those
1880 that are queued to be sent:
1881
1882 |image467|
1883
1884 Clicking on the message title will expand the view to show you the full
1885 text of the message that was sent.
1886
1887 |image468|
1888
1889 If the message has a status of sent or failed you will have the option
1890 to 'resend' the message to the patron by clicking the 'resend' button
1891 found under the status.
1892
1893 |image469|
1894
1895 .. _statistics-label:
1896
1897 Statistics
1898 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1899
1900 Depending on what you set for the values of your
1901 :ref:`StatisticsFields` system preference, you can see
1902 statistics for one patron's circulation actions.
1903
1904 |image470|
1905
1906 .. _files-label:
1907
1908 Files
1909 ~~~~~~~~~~~~~~~~~~~~~~~~
1910
1911 If you set the :ref:`EnableBorrowerFiles` preference
1912 to 'Do' the Files tab will be visible on the patron information page.
1913
1914 |image471|
1915
1916 From here you can upload files to attach to the patron record.
1917
1918 |image472|
1919
1920 All files that are uploaded will appear above a form where additional
1921 files can be uploaded from.
1922
1923 |image473|
1924
1925 .. _purchase-suggestions-label:
1926
1927 Purchase suggestions
1928 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1929
1930 If the patron has made any purchase suggestions you will see a purchase
1931 suggestions tab on the patron record.
1932
1933 |image1247|
1934
1935 From here you can see all suggestions made by the patron and their
1936 status, you can also create a purchase suggestion on the patron's behalf
1937 by clicking the 'New purchase suggestion' button at the top.
1938
1939 Learn more about :ref:`managing purchase suggestions <managing-purchase-suggestions-label>` in the
1940 `Acquisitions <#acqmodule>`__ chapter of this manual.
1941
1942 .. _patron-discharges-label:
1943
1944 Patron discharges
1945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1946
1947 A discharge is a certificate that says the patron has no current
1948 checkouts, no holds and owe no money. To enable this opti`on on the
1949 patron record you need to set the :ref:`useDischarge`
1950 system preference to 'Allow'.
1951
1952     **Note**
1953
1954     In France a "quitus" ("discharge") is needed if you want to register
1955     for an account in a library or a university.
1956
1957     **Note**
1958
1959     Academic libraries often require that you have a clear record at the
1960     library before you can graduate.
1961
1962 Patrons can :ref:`request discharges via the OPAC <ask-for-a-discharge-label>`. Any
1963 pending discharges will be listed below the menu buttons on the main
1964 staff client page
1965
1966 |image1248|
1967
1968 Clicking the pending requests will open a screen where you can allow
1969 those discharges
1970
1971 |image1249|
1972
1973 To generate a discharge for a specific patron click the 'Discharge' tab
1974 on the left of the patron record
1975
1976 |image1250|
1977
1978 If the patron can have a discharge generated then it will have a button
1979 that says 'Generate discharge'
1980
1981 |image474|
1982
1983 If not then you'll see an error explaining why you can't discharge the
1984 patron.
1985
1986 |image475|
1987
1988 Once the letter is generated you will have a PDF to download
1989
1990 |image476|
1991
1992     **Note**
1993
1994     You can style the PDF using the :ref:`NoticeCSS`
1995     preference.
1996
1997 The patron will have a restriction added to their account
1998
1999 |image1251|
2000
2001 And a history of discharges will be added to the 'Discharge'
2002 tab
2003
2004 |image1252|
2005
2006 .. _housebound-patrons-label:
2007
2008 Housebound patrons
2009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2010
2011 There are three roles a patron can have in regard to housebound
2012 circulation: borrower, chooser or deliverer.
2013
2014     **Important**
2015
2016     In order to use the housebound module, the :ref:`HouseboundModule`
2017     and :ref:`ExtendedPatronAttributes` system preferences must be
2018     enabled.
2019
2020 .. _housebound-chooser-label:
2021
2022 Chooser
2023 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2024
2025 If you have enabled the housebound module, with the
2026 :ref:`HouseboundModule` system preference, you will see that
2027 patrons now have a new section in their record called 'Housebound
2028 roles'.
2029
2030 |image1349|
2031
2032 Click the 'Add' button to mark this
2033 patron as a 'Chooser'.
2034
2035 |image1350|
2036
2037 The chooser is in charge of choosing the materials for the
2038 housebound patron.
2039
2040 .. _housebound-deliverer-label:
2041
2042 Deliverer
2043 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2044
2045 In the 'Housebound roles', click the 'Add' button to mark
2046 this patron as a 'Deliverer'.
2047
2048 |image1351|
2049
2050 The deliverer is in charge of delivering the chosen materials
2051 to the housebound patron on a specific day at a specific time.
2052
2053 .. _housebound-borrower-label:
2054
2055 Housebound borrowers
2056 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2057
2058 To create a housebound profile for an housebound patron, click on
2059 the 'Housebound' tab in their record.
2060
2061 |image1347|
2062
2063 From there, you can edit their housebound profile information.
2064
2065 |image1348|
2066
2067 - Delivery day: choose which day (or 'Any') the patron prefers to
2068   receive their delivery.
2069
2070 - Frequency: choose the frequency at which they want to receive
2071   their deliveries.
2072
2073     **Note**
2074
2075     The frequencies are managed through the HSBND\_FREQ list of
2076     :ref:`authorized values <existing-values-label>`.
2077
2078 - Preferred materials: enter notes that will help the chooser
2079   choose appropriate documents for the housebound patron.
2080
2081   For example: books, dvds, magazines, etc.
2082
2083 - Subjects: if the housebound patron has a preference for
2084   particular subjects, enter it here. This will help the
2085   chooser choose interesting documents for the patron.
2086
2087   For example: romance, cookbooks, thrillers, etc.
2088
2089 - Authors: if the housebound patron has favorite authors,
2090   enter them here.
2091
2092   For example: Danielle Steel, James Patterson, etc.
2093
2094 - Referral: if the housebound patron has a referral, enter
2095   it here.
2096
2097 - Notes: enter any other notes that may help the chooser or
2098   the deliverer.
2099
2100 Click the 'Save changes' button to save the housebound profile.
2101
2102 .. _housebound-deliveries-label:
2103
2104 Coordinating deliveries
2105 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2106
2107 To plan visits, go to the housebound patron's record.
2108
2109 In their housebound tab, you will be able to create deliveries.
2110
2111 |image1352|
2112
2113 Click on 'Add a new delivery'.
2114
2115 |image1353|
2116
2117 Fill out the information :
2118
2119   - Date: Enter the date of the delivery.
2120
2121   - Time: Select a time of day for the delivery. The choices are
2122     morning, afternoon, or evening.
2123
2124   - Chooser: Select a chooser who will be in charge of selecting
2125     the materials for this housebound patron.
2126
2127   - Deliverer: Select a deliverer who will be in charge of picking
2128     up the materials and bringing them over to the housebound
2129     patron.
2130
2131 |image1354|
2132
2133 Choosers and Deliverers can be notified of planned deliveries via reports.  Example reports be found in the SQL Reports Library at https://wiki.koha-community.org/wiki/SQL_Reports_Patrons#Patron_Characteristics.
2134
2135 .. _patron-search-label:
2136
2137 Patron search
2138 ---------------------------------
2139
2140 Clicking on the link to the Patron module will bring you to a
2141 search/browse screen for patrons. From here you can search for a patron
2142 by any part of their name or their card number.
2143
2144 |image477|
2145
2146 Clicking the small plus sign [+] to the right of the search box will
2147 open up an advanced patron search with more filters including the
2148 ability to limit to a specific category and/or library.
2149
2150 |image478|
2151
2152 You can also filter your patron results using the search options on the
2153 left hand side of the page.
2154
2155 |image1253|
2156
2157 Depending on what you have chosen for the 'Search fields' you can search
2158 for patrons in various different ways.
2159
2160 |image479|
2161
2162 -  Standard:
2163
2164    -  Enter any part of their name, username, email address or barcode
2165
2166 -  Email:
2167
2168    -  Enter any part of their email address and choose 'Contains'
2169       instead of 'Starts with'
2170
2171 -  Borrower number:
2172
2173    -  Enter the Koha borrower number
2174
2175 -  Phone number:
2176
2177    -  Enter the phone number exactly as it is in the system or by using
2178       spaces between each batch of numbers.
2179
2180    -  Example: To find (212) 555-1212 you can search for it exactly as
2181       it was entered or by searching for 212 555 1212
2182
2183 -  Street address:
2184
2185    -  Enter any part of the patron's address (includes all address
2186       fields) and choose 'Contains' instead of 'Starts with' to find the
2187       string anywhere in the address
2188
2189 -  Date of birth
2190
2191    -  Birth dates should be entered using the format set forth in the
2192       :ref:`dateformat` preference.
2193
2194 -  Sort field 1
2195
2196    -  This is a custom field that libraries can use for any type of data
2197       about the patron.
2198
2199 -  Sort field 2
2200
2201    -  This is a custom field that libraries can use for any type of data
2202       about the patron.
2203
2204 You can also choose to either search for fields that start with the
2205 string you entered or contain the string. Choosing 'Contains' will work
2206 like a wildcard search.
2207
2208 |image480|
2209
2210 You can also browse through the patron records by clicking on the linked
2211 letters across the top.
2212
2213 |image481|