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