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