Update links and headers
[kohadocs.git] / en / source / 12_opac.rst
1 .. include:: images.rst
2
3 OPAC
4 ====
5
6 This chapter assumes that you have the following preferences set as
7 follows:
8
9 -  :ref:`opacthemes` = bootstrap
10
11 -  :ref:`OPACXSLTResultsDisplay` = default
12
13 -  :ref:`OPACXSLTDetailsDisplay` = default
14
15 -  :ref:`DisplayOPACiconsXSLT` = show
16
17 -  :ref:`TagsEnabled` = Allow
18
19 -  :ref:`TagsInputOnDetail` =Allow
20
21 -  :ref:`TagsInputOnList` = Allow
22
23 -  :ref:`reviewson` = Allow
24
25 -  :ref:`ShowReviewer` = Allow
26
27 -  :ref:`ShowReviewerPhoto` =Allow
28
29 -  :ref:`OPACFRBRizeEditions` = Show
30
31 -  :ref:`OPACAmazonCoverImages` = Show
32
33 -  :ref:`XISBN` = Use
34
35 -  :ref:`OPACSearchForTitleIn` = Default set of
36    links
37
38 -  :ref:`OPACShowCheckoutName` = Don't show
39
40 -  :ref:`RequestOnOpac` = Allow
41
42 -  :ref:`AutoResumeSuspendedHolds` = Allow
43
44 -  :ref:`OpacBrowseResults` = Enable
45
46 -  :ref:`SuspendHoldsOpac` = Allow
47
48 -  :ref:`OPACShowBarcode` = Don't show
49
50 -  :ref:`OpacSeparateHoldings <opacseparateholdings-&-opacseparateholdingsbranch-label>` = Don't separate
51
52 -  :ref:`OpacSeparateHoldingsBranch <opacseparateholdings-&-opacseparateholdingsbranch-label>` = home library
53
54 -  :ref:`DisplayLibraryFacets` = holding library
55
56 If your system preferences are set differently your displays may differ.
57
58 .. _search-results-label:
59
60 Search Results
61 ---------------------------------------
62
63 To search the OPAC you can either choose to enter your search words in
64 the box at the top of the OPAC or click on the 'Advanced Search' link to
65 perform a more detailed search.
66
67 OPAC Search Box
68 |image937|
69
70 For more on searching check the '`Searching <#searching>`__' chapter in
71 this manual.
72
73 .. _results-overview-label:
74
75 Results Overview
76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77
78 After performing a search the number of results found for your search
79 will appear above the results
80
81 Total Results
82 |image938|
83
84 By default your search results will be sorted based on your
85 :ref:`OPACdefaultSortField and OPACdefaultSortOrder`
86 system preference values. To change this you can choose another sorting
87 method from the pull down on the right.
88
89 Results Sorting Options
90 |image939|
91
92 Under each title on your results list a series of values from your
93 leader will appear. It is important to note that this has nothing to do
94 with the item types or collection codes you have applied to your
95 records, this data is all pulled from your fixed fields. This can be
96 turned on or off with the
97 :ref:`DisplayOPACiconsXSLT` system preference.
98
99 Leader Visualization
100 |image940|
101
102 Below each title you will see the availability for the items attached to
103 the record.
104
105     **Note**
106
107     Even if you filtered on one library location all locations that hold
108     the item will appear on the search results.
109
110     **Important**
111
112     An item's hold status doesn't not affect whether or not the item is
113     'available' until the item is in 'waiting' status. Items with
114     on-shelf holds will show as available until a librarian has pulled
115     them from the shelf and checked the item in make it show 'waiting'.
116
117 Holdings Information
118 |image941|
119
120 If you have turned on :ref:`Enhanced Content`
121 preferences you may have book jackets on your search results.
122
123 Book Jacket on Results
124 |image942|
125
126 If you have set your :ref:`Did you mean? <did-you-mean?-label>` options you will
127 see a yellow bar across the top of your results will other related
128 searches.
129
130 Did you mean?
131 |image943|
132
133 If you performed an advanced search you see an option to go back and
134 edit your advanced search blow the list of results pages.Return to the
135 last advanced search
136
137 .. _filters-label:
138
139 Filters
140 ~~~~~~~~~~~~~~~~~~~~~~~~~
141
142 To filter your results click on the links below the 'Refine Your Search'
143 menu on the left of your screen
144
145 Refine Your Results
146 |image944|
147
148 Depending on your setting for the
149 :ref:`DisplayLibraryFacets` system preference you
150 will see filters for your home, holding or both libraries.Library Facet
151
152 After clicking a facet you can remove that filter from your results by
153 clicking the small 'x' that appears to the right of the facet.Remove
154 library facet
155
156 .. _search-rss-feeds-label:
157
158 Search RSS Feeds
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160
161 You will be able to subscribe to your search results as an RSS feed by
162 clicking the RSS icon in your address bar or next to the number of
163 results. To learn more about what RSS feeds are check out `this tutorial
164 video <http://www.youtube.com/watch?v=0klgLsSxGsU>`__.
165
166 RSS Feed Icon
167 |image945|
168
169 Subscribing to search results as RSS feeds will allow you to see when a
170 new item is added to the catalog in your area of interest.
171
172 .. _bibliographic-record-label:
173
174 Bibliographic Record
175 --------------------------------------
176
177 When you click on a title from the search results, you're brought to the
178 bibliographic detail of the record. This page is broken down in several
179 different areas.
180
181 At the top of your screen will be the title and the GMD:
182
183 Title
184 |image946|
185
186 Below the title the authors will be listed. These come from your 1xx and
187 7xx fields. Clicking the author will run a search for other titles with
188 that author.
189
190 Author Display
191 |image947|
192
193 If you have an authority file you will see a magnifying glass to the
194 right of author (and other) authorities. Clicking that magnifying glass
195 will take you directly to the authority record.
196
197 Authority link
198 |image948|
199
200 If you have your :ref:`DisplayOPACiconsXSLT`
201 preference set to 'show' you will see a material type that is determined
202 by values in your fixed fields (learn more in the `XSLT Item
203 Types <#XSLTiTypes>`__ Appendix).
204
205 XSLT Item Type
206 |image949|
207
208 Next you'll see the description of the record you're viewing:
209
210 Basic Details
211 |image950|
212
213 Following that information you'll find the subject headings which can be
214 clicked to search for other titles on similar topics
215
216 Bibliographic Subjects
217 |image951|
218
219 If your record has a table of contents or summary it will appear next to
220 the 'Summary' or 'Table of Contents' label
221
222 Summary
223 |image952|
224
225 If your record has data in the 856 fields you'll see the links to the
226 right of the 'Online Resources' label
227
228 Online Resources
229 |image953|
230
231 If the title you're viewing is in a public list then you'll see a list
232 of those to the right of the 'List(s) this item appears in' label and if
233 it has tags they will appear below the 'Tags from this library' label
234
235 Tags
236 |image954|
237
238 In the tabs below the details you will find your holdings data
239
240 |image955|
241
242 Any notes (5xx fields) that have been cataloged will appear under 'Title
243 Notes'
244
245 Title notes
246 |image956|
247
248 If you're allowing comments they will appear in the next tab
249
250 Comments
251 |image957|
252
253 And finally if you have enabled FRBR and you have other editions of the
254 title in your collection you will see the 'Editions' tab.
255
256 Editions
257 |image958|
258
259 To the right of the details you'll find a series of boxes. The first box
260 is a list of buttons to help navigate the search results. From there you
261 can see the next or previous result from your search or return to the
262 results.
263
264 Search Options
265 |image959|
266
267 Clicking Browse Results at the top of the right column will open up your
268 search results on the detail page
269
270 Search Results
271 |image960|
272
273 Below the search buttons you'll find the links to place a hold, print
274 the record, save the record to your lists, or add it to your cart
275
276 More options
277 |image961|
278
279 Clicking 'More Searches' will show the list of libraries you entered in
280 your :ref:`OPACSearchForTitleIn` preference
281
282 More Searches
283 |image962|
284
285 Under the 'Save Record' label you will find a series of file formats you
286 can save the record as. This list can be customized by altering the
287 :ref:`OpacExportOptions` system preference.
288
289 Save Record
290 |image963|
291
292 If at any time you want to change the view from the 'Normal' view to see
293 the Marc or the ISBD you can click the tabs across the top of the record
294
295 Record Views
296 |image964|
297
298 .. _lists-&-cart-label:
299
300 Lists & Cart
301 ---------------------------------
302
303 A cart is a temporary holding place for records you're interested in
304 finding during this session. That means that once you log out of the
305 OPAC or close the browser you lose the items in your cart. A list is a
306 more permanent location for saving items. To learn more about lists,
307 check the `Lists in the Staff Client <#stafflists>`__ chapter of this
308 manual.
309
310 .. _lists-label:
311
312 Lists
313 ~~~~~~~~~~~~~~~~~~~~~~
314
315 Patrons can manage their own private lists by visiting the 'my lists'
316 section of their account.
317
318 Lists Management
319 |image965|
320
321 .. _creating-lists-label:
322
323 Creating Lists
324 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
325
326 Lists can also be created by choosing the 'New List' option in the 'Add
327 to' menu on the search results
328
329 Add to New List
330 |image966|
331
332 To create a list the patron simply needs to click the 'New List' link
333 and populate the form that appears
334
335 Create a new list
336 |image967|
337
338 The only field required is the 'List Name,' but the patron can also
339 choose how they want the list sorted and if the list is public or
340 private.
341
342 -  A Private List is managed by you and can be seen only by you
343    (depending on your permissions settings below)
344
345 -  A Public List can be seen by everybody, but managed only by you
346    (depending on your permissions settings below)
347
348     **Important**
349
350     If you aren't allowing patrons to create public lists with the
351     :ref:`OpacAllowPublicListCreation`
352     preference then patrons will only be able to create private lists.
353
354     Create a new private list
355     |image968|
356
357 -  Finally decide what your permissions will be on the list. You can all
358    or disallow:
359
360    -  anyone else to add entries
361
362    -  anyone to remove his own contributed entries
363
364       -  **Note**
365
366              The owner of a list is always allowed to add entries, but
367              needs permission to remove.
368
369    -  anyone to remove other contributed entries Â  Â 
370
371 .. _adding-titles-to-lists-label:
372
373 Adding titles to Lists
374 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
375
376 Titles can be added to lists from the search results and/or from the
377 bibliographic record. On the search results options to add items to the
378 list appear below each result and across the top of the results page
379
380 Add to Lists from Results
381 |image969|
382
383 To add a single title to a list, click the 'Save to Lists' option and
384 then choose the list you'd like to add the title to. To add multiple
385 titles to a list check the boxes on the left of the titles you want to
386 add and then choose the list you want to add the titles to from the 'Add
387 too' pull down at the top of the screen.
388
389 .. _viewing-lists-contents-label:
390
391 Viewing Lists Contents
392 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
393
394 To view the contents of a list, click on the list name under the Lists
395 button.
396
397 Lists
398 |image970|
399
400 The contents of the list will look similar to your search results pages
401 except that there will be different menu options across the top of the
402 list.
403
404 List View
405 |image971|
406
407 To the right of the list title there is an RSS icon that will allow you
408 to subscribe to updates to the list.
409
410 Using the menu options above the list you can place multiple items on
411 hold, download the list contents, email the list or print the list out.
412
413 -  To place a hold on one or more list items check the box to the left
414    of the item and click the 'Place Hold' link at the top
415
416 -  To download the list contents click the 'Download List' link and
417    choose the format you'd like to download the list in
418
419 -  To email the list contents to someone, click the 'Send List' link and
420    enter in your email details in the form that pops up (:ref:`view a sample
421    Lists email <example-email-from-list-label>`)
422
423    Email List Contents
424    |image972|
425
426 -  To print the contents of your list out click the 'Print List' link
427
428 .. _managing-lists-label:
429
430 Managing Lists
431 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
432
433 Once the list is saved patrons can begin adding items to it. From the
434 'my lists' tab on the patron record the patron can edit and delete the
435 lists they have created by clicking the appropriate link to the right of
436 the list name.
437
438 My Lists
439 |image973|
440
441 To edit the list's title or sorting patrons click the 'Edit' link to the
442 right of the list description.
443
444 Editing List
445 |image974|
446
447 When clicking 'Delete' next to a list you will be asked to confirm that
448 you want to delete the list.
449
450 Delete list confirmation
451 |image975|
452
453 The list will not be deleted until the 'Confirm' button is clicked to
454 the right of the list you'd like to delete.
455
456 If the library is allowing you to share private lists with the
457 :ref:`OpacAllowSharingPrivateLists`
458 preference then you will see the 'Share' link on your list of lists and
459 the 'Share list' link at the top of each individual list. Clicking this
460 will ask you to enter the email address of a patron.Share list
461
462 Once the email address is entered Koha will present you with a
463 confirmation message
464
465 Share list confirmation
466 |image976|
467
468 and will send a message to that patron.
469
470 .. _cart-label:
471
472 Cart
473 ~~~~~~~~~~~~~~~~~~~~
474
475 .. _adding-titles-to-the-cart-label:
476
477 Adding titles to the Cart
478 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
479
480 Titles can be added to the cart from the search results and/or from the
481 bibliographic record. On the search results options to add items to the
482 cart appear below each result and across the top of the results page
483
484 Add to Cart on Search Results
485 |image977|
486
487 Clicking the 'Add to Cart' button will add the one title to your cart.
488 To add multiple titles at once, check the box to the left of each result
489 and then choose 'Cart' from the 'Add to' pull down at the top of the
490 screen. Once titles are added to the cart you will be presented with a
491 confirmation
492
493 Items added to Cart
494 |image978|
495
496 From the results you will see which items are in your cart and will be
497 able to remove those items by clicking '(remove)'.Item in your cart
498
499 .. _managing-the-cart-label:
500
501 Managing the Cart
502 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
503
504 Once you have titles in your cart you can manage the contents by
505 clicking on the 'Cart' button usually found at the top of the screen.
506 Your cart will open in a new window.
507
508 Contents of your cart
509 |image979|
510
511 From this window you are presented with several options. Across the top
512 of the cart are several buttons.
513
514 First is the 'More details' button. Clicking this will show you
515 additional information about the titles in your cart (ISBNs, Subjects,
516 Publisher Info, Notes and more).More details in the cart
517
518 Next is the option to send the contents of your cart to an email
519 address. This is handy if you want to send the resources you found at
520 the library to your home email account to refer to later or to send to a
521 patron researching a specific topic. Clicking this link will open up a
522 new window that asks for the email address and message to send. :ref:`View a
523 sample Cart email <example-email-from-cart-label>`.
524
525 Email Cart
526 |image980|
527
528     **Important**
529
530     The cart can only be emailed by logged in users. This will prevent
531     your cart email function from being used for spamming.
532
533 In addition to sending your cart you can download the contents of your
534 cart in several pre-defined formats or using a :ref:`CSV
535 Profile <csv-profiles-label>` that you defined in the Tools module.
536
537 Download Cart
538 |image981|
539
540 Finally you can print out the contents of your cart by choosing the
541 'Print' link.
542
543 In addition to the various different ways to save the contents of your
544 cart, there are ways to add value to the data in your cart. By selecting
545 one or more titles from the cart you can add them to a list (click 'Add
546 to a List'), place hold(s) (click 'Place hold'), or tag them (click
547 'Tag'). All of these operations follow the same procedure as they do
548 when performing them in the OPAC.
549
550 .. _placing-holds-label:
551
552 Placing Holds
553 ----------------------------------
554
555 Patrons can place holds on items via the OPAC if they're logged in and
556 you have the :ref:`RequestOnOpac` preference set to
557 'Allow'. If the item can be placed on hold the option to place it on
558 hold will appear in several different places.
559
560 -  When viewing a list or search results page you'll see the option to
561    place hold on multiple items by checking the boxes to the left of the
562    results and clicking 'Place Hold' at the top
563
564    Place Hold from Results
565    |image982|
566
567 -  When viewing a list or search results page you'll see the option to
568    place the item on hold below the basic information about the title
569
570    Place Hold
571    |image983|
572
573 -  When viewing an individual title you'll see the option to place a
574    hold in the box on the right side of the screen
575
576    Place Hold
577    |image984|
578
579 No matter which of the above links you click to place your hold you'll
580 be brought to the same hold screen.
581
582 Place Hold Form
583 |image985|
584
585 -  Check the box to the left of the items you'd like to place on hold
586
587 -  The title includes a link back to the detail page for the record
588
589 -  The priority shows where in the holds queue this hold will fall
590
591 -  If allowed by your
592    :ref:`OPACAllowUserToChooseBranch`
593    preference the patron can choose where they'd like to pick up their
594    hold
595
596 -  If you would like to see more options you can click 'Show more
597    options'
598
599    Place Hold Form with More Options
600
601    -  If you have the
602       :ref:`AllowHoldItemTypeSelection`
603       preference set to 'Allow' and the record had more than one item
604       type attached you will see an option to choose to limit the hold
605       to a specific item typeAllowHoldItemTypeSelection
606
607 -  If allowed by your
608    :ref:`OPACAllowHoldDateInFuture`
609    preference, the 'Hold Starts on Date' column will show. This field
610    allows the patron to have their hold start on a future date.
611
612 -  By default holds placed in the system remain until canceled, but if
613    the patron fills in a 'Hold Not Needed After' date then the hold has
614    an expiration date.
615
616    -  **Important**
617
618           Expired holds are removed by the :ref:`Expired Holds Cron
619           Job <expired-holds-label>`, this is not an automatic process
620           and must be set up by your system administrator
621
622 -  If allowed by the :ref:`OpacHoldNotes` preference then
623    patrons can leave notes about their holds for the library by clicking
624    the 'Edit notes' button
625
626    Hold notes
627    |image986|
628
629 -  Depending on the rules you set regarding item specific holds in your
630    :ref:`circulation and fines rules <circulation-and-fine-rules-label>` the patron will be
631    allowed to choose whether to place the hold on the next available
632    copy and/or a specific copy
633
634    Specific Copy Hold
635    |image987|
636
637 After clicking the Place Hold button the patron will be brought to their
638 account page where they'll see all of the items they have on hold.
639
640 .. _enhanced-content-label:
641
642 Enhanced Content
643 -------------------------------------------
644
645 .. _tagging-label:
646
647 Tagging
648 ~~~~~~~~~~~~~~~~~~~~~~~~~~
649
650 Depending on your settings for the :ref:`TagsEnabled`,
651 :ref:`TagsInputOnList` and
652 :ref:`TagsInputOnDetail` preferences you may be able
653 to add tags to bibliographic records from the search results and/or
654 bibliographic records. If you are allowing patrons to add tags from the
655 search results screen you will see an input box below each result and a
656 'Tag' option at the top of the screen.
657
658 Tagging Options on Results
659 |image988|
660
661 To add a tag to one item, type the tabs (separated by commas) in the
662 'New tag' box and click 'Add'. You will be presented with a confirmation
663 of your tags being added.
664
665 Tags Added on Results
666 |image989|
667
668 From the results you can also tag items in bulk by clicking the
669 checkboxes on the left and then clicking the 'Tag' button at the top.
670 After clicking the button it will change into an input box for you to
671 add tags to all of the items you have selected.
672
673 Add Tags to Multiple Items
674 |image990|
675
676 .. _comments-label:
677
678 Comments
679 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
680
681 Patrons can leave comments in the OPAC if you have the
682 :ref:`reviewson` preference set to allow this. Each
683 bibliographic record has a comments tab below the bibliographic
684 information.
685
686 Comments Tab
687 |image991|
688
689 If the patron is logged in they will see a link to add a comment to the
690 item. Clicking this link will open a pop up window with a box for their
691 comments.
692
693 Add a Comment
694 |image992|
695
696 Once the comment has been typed and the 'Submit' button clicked, the
697 patron will see their comment as pending and other patrons will simply
698 see that there are no comments on the item.
699
700 Pending Comment
701 |image993|
702
703 Once the comment is approved the patron will see the number of comments
704 on the 'Comments' tab and their comment labeled amongst the other
705 comments. If you have set your
706 :ref:`ShowReviewerPhoto` preference to 'Show' then
707 you'll see the patron's photo pulled from the
708 `Libravatar <https://www.libravatar.org>`__ library.
709
710 Your Comments
711 |image994|
712
713 Other patrons will see the comment with the name of the patron who left
714 the comment (unless you have set the :ref:`ShowReviewer`
715 preference to not show patron names).
716
717 Comment by other patron
718 |image995|
719
720 If you have your :ref:`OpacShowRecentComments`
721 set to show then you'll see the approved comments on that page.
722
723 Recent Comments List
724 |image996|
725
726 From this page patrons can subscribe to the recent comments using RSS if
727 they would like.
728
729 .. _zotero-label:
730
731 Zotero
732 ~~~~~~~~~~~~~~~~~~~~
733
734 Zotero is a Firefox add on that allows for the saving and generating of
735 a bibliography. Learn more about and download Zotero at
736 http://zotero.org.
737
738 When on the search results in the Koha OPAC, if you have Zotero
739 installed, you will see a folder icon in the address bar to the right of
740 the URL. Clicking that folder will open up a list of titles on the page
741 for you to pick from to add to Zotero.
742
743 Zotero pop up
744 |image997|
745
746 Select the titles you want to add to Zotero and then click the 'OK'
747 button. This will add the title to Zotero. You can see the title by
748 opening your Zotero library.
749
750 Title in the Zotero Library
751 |image998|
752
753 .. _custom-rss-feeds-label:
754
755 Custom RSS Feeds
756 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
757
758 Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for any SQL
759 query (for example a new acquisitions RSS feed). rss.pl is run on the
760 command line to produce an RSS XML document.
761
762 The output should be placed in a directory accessible to the OPAC (or
763 staff) web interface so that users can download the RSS feed.
764
765 An example of usage can be found at: misc/cronjobs/rss.pl
766 lastAcquired.conf
767
768 Normally rss.pl should be run periodically (e.g., daily) to keep the
769 feed up-to-date.
770
771 The configuration file (e.g., lastAcquired.conf) lists
772
773 -  name of the template file to use
774
775 -  path of output file
776
777 -  SQL query
778
779 rss.pl runs the SQL query, then feeds the output of the query through
780 the template to produce the output file.
781
782     **Important**
783
784     To use custom RSS feeds you need to turn on the rss.pl cron job.
785
786 .. _opac-self-registration-label:
787
788 OPAC Self Registration
789 ----------------------------------------------
790
791 If you allow it, patrons can register for their own accounts via the
792 OPAC. If you have the
793 :ref:`PatronSelfRegistration` preference set to
794 'Allow' then patrons will see a link to register below the log in box on
795 the right of the main OPAC page.
796
797 Registration link in OPAC
798 |image999|
799
800 When the patron clicks the 'Register here' link they will be brough to a
801 registration page. The options on the registration page can be conrolled
802 by editing the
803 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
804 and the
805 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
806 preferences.
807
808 Registration form
809 |image1000|
810
811 Once the patron has confirmed submitted their registration they will
812 either be sent an email to confirm their account (if you have the
813 :ref:`PatronSelfRegistrationVerifyByEmail`
814 preference to require this) or presented with their new username and
815 password.
816
817 New account confirmation
818 |image1001|
819
820 Patrons registered in this way will not have a cardnumber until assigned
821 one by the library, but will have access to all OPAC functionality
822 immediately. For this reason it is recommended that you:
823
824 -  set up a provisional :ref:`patron category <adding-a-patron-category-label>` for self
825    registered patrons (such as 'Self Registered) instead of using an
826    existing patron category and set that value in the
827    :ref:`PatronSelfRegistrationDefaultCategory`
828    preference
829
830 -  give this patron category minimal circulation privileges in the
831    :ref:`Circulation and Fine Rules` (such as allowing a
832    couple holds, but no check outs)
833
834 That way patrons will either have to come in to the library to verify
835 their identity before given a cardnumber and the ability to check items
836 out or the library will have to come up with internal policy on
837 generating cardnumbers before providing them to self registered patrons.
838 Once this is done the library can change the category to one that is
839 more appropriate (be it an adult, resident, non resident, student, etc)
840 and add a cardnumber/barcode.
841
842 .. _my-account-label:
843
844 My Account
845 -------------------------------
846
847 From the OPAC patrons can log in and access their account if you have
848 set the :ref:`opacuserlogin` preference to 'Allow'. Once
849 logged in patrons are brought to their account summary. If you would
850 like to get to your account in the OPAC, you can click on your name in
851 the top right of any page in the OPAC.
852
853 .. _resetting-your-password-label:
854
855 Resetting your password
856 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
857
858 If you have the :ref:`OpacResetPassword` set to allow
859 patrons to reset their password they can click 'Forgot your password?'
860 link found under the log in box to reset their passwords.
861
862 'Forgot your password?' link
863 |image1002|
864
865 Once clicked they will be presented with a form asking for their
866 username and their email address (patrons must have an email address on
867 file to reset their password).Recover password
868
869 The system will then email the patron instructions for resetting their
870 password.Reset password confirmation
871
872 .. _my-summary-label:
873
874 My Summary
875 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
876
877 My Summary
878 |image1003|
879
880 From the 'my summary' tab, patrons will see all of the items they have
881 checked out with the overdue items highlighted in red. If you have
882 :ref:`OpacRenewalAllowed` set to 'Allow' then your
883 patrons will be able to renew their books right from the OPAC. If you
884 have HTML entered in the :ref:`OPACMySummaryHTML`
885 preference then you will see that to the right of the 'Fines' column.
886
887 Checked out tab with OPACMySummaryHTML set
888 |image1004|
889
890 If your patrons would like to see the items barcodes on their list of
891 checked out items you can set up a :ref:`patron
892 attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
893 :ref:`authorized value <authorized-values-label>` of YES\_NO.
894
895 Add SHOW\_BCODE patron attribute
896 |image1005|
897
898 Then on the :ref:`patron's record set the value <editing-patrons-label>` for
899 SHOW\_BCODE to yes.
900
901 Setting value for SHOW\_BCODE on patron record
902 |image1006|
903
904 This will add a column to the check out summary in the OPAC that shows
905 the patrons the barcodes of the items they have checked out.
906
907 Barcode number on checkout list in OPAC
908 |image1007|
909
910 If their guarantee has allowed it via :ref:`their
911 privacy <my-privacy-label>`, when the guarantor logs in they will see a
912 tab labeled "Relatives' checkouts" on their summary tab.Relatives'
913 checkouts
914
915 Clicking on the 'Overdue' tab will show only the items that are overdue.
916
917 Overdue Items
918 |image1008|
919
920 The 'Fines' tab will show just a total of what the patron owes. Clicking
921 on the total will take them to the 'my fines' tab where they will see a
922 complete breakdown of their fines and bills. If you don't charge fines
923 at your library you can turn the display of these tabs off by setting
924 the :ref:`OPACFinesTab` preference to 'Don't Allow.'
925
926 Patron Fines
927 |image1009|
928
929 Finally, clicking on the 'Holds' tab will show the patron the status of
930 all of the items they have on hold.
931
932 Patron holds status
933 |image1010|
934
935 Patrons can cancel or suspend (depending on the value of your
936 :ref:`SuspendHoldsOpac` system preference) their own
937 holds if they are not in transit or already waiting for them. When they
938 click 'Suspend' they will be presented with the option to choose a date
939 for their hold to resume.Suspend until
940
941 They can also suspend all of their holds indefinitely or until a
942 specific date if they choose by filling in the suspend options at the
943 bottom of the page.
944
945     **Note**
946
947     If you have your
948     :ref:`AutoResumeSuspendedHolds` preference
949     set to "Don't allow" then you will not have the option to put an end
950     date on the hold suspension
951
952 .. _patron-flags-label:
953
954 Patron Flags
955 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
956
957 If you have `flagged your patron's account <#patronflags>`__ they may
958 see one of the following error messages at the top of their account.
959
960 -  Card marked as lost
961
962    Library card lost
963    |image1011|
964
965 -  Patron address in question
966
967    Patron address in question
968    |image1012|
969
970    -  **Note**
971
972           this error message will not include a link to the update form
973           if you have :ref:`OPACPatronDetails` set to
974           'Don't allow'
975
976 -  Patron marked restricted
977
978    Patron restricted
979    |image1013|
980
981 .. _my-fines-label:
982
983 My Fines
984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
985
986 If your library charges fines the next tab on the left is 'my fines.'
987 Opening this tab will show the patron an entire history of their
988 accounting at the library.
989
990 Library Fines & Charges
991 |image1014|
992
993 If you are allowing patrons to pay their fines using PayPal with the
994 :ref:`EnablePayPalOpacPayments <enablepaypalopacpayments-&-paypalsandboxmode-label>` preference
995 there will be checkboxes to the left of each fine with an outstanding
996 amount.Fines with checkboxes
997
998 At the bottom the patron will see the option to pay with PayPal for the
999 items they have checked.
1000
1001 PayPal Payment
1002 |image1015|
1003
1004 After paying they will be presented with a confirmationPayPal
1005 Confirmation
1006
1007 And you will see that the fine was paid using PayPal on the staff
1008 side.Staff side fines
1009
1010 .. _my-details-label:
1011
1012 My Details
1013 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1014
1015 If you have your :ref:`OPACPatronDetails` preference
1016 set to 'Allow', your patrons will see a form filled in with their
1017 contacting information by clicking on the 'my personal details' tab. You
1018 can control what fields patrons see and can modify via the OPAC by
1019 setting the
1020 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
1021 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
1022 preferences.
1023
1024 Patron's personal details
1025 |image1016|
1026
1027 Patrons can edit their details in this form and click 'Submit Changes'
1028 to have their edits sent to the library for review before their record
1029 is updated. Staff will see all patrons requesting modification to their
1030 record listed below the modules on the main dashboard along with
1031 anything else awaiting library attention.
1032
1033 Patron requests waiting review
1034 |image1017|
1035
1036 If the :ref:`OPACPatronDetails` preference is set to
1037 'Don't allow' then patrons will simply see their details and a message
1038 stating that they should contact the library for changes.
1039
1040 Patron's personal details with no edits
1041 |image1018|
1042
1043 .. _my-tags-label:
1044
1045 My Tags
1046 ~~~~~~~~~~~~~~~~~~~~~~~~~
1047
1048 If your library has :ref:`TagsEnabled` set to 'Allowed' then
1049 the next tab on the left will be 'my tags.' This tab will show patrons
1050 all of the tags in the system as a cloud and then all of the tags they
1051 have applied in a list format. From here patrons have the ability to
1052 remove tags that they have added if they want.
1053
1054 Patron's tags
1055 |image1019|
1056
1057 .. _change-my-password-label:
1058
1059 Change My Password
1060 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1061
1062 Next, if you have :ref:`OpacPasswordChange` set to
1063 'Allow' the next tab will be 'change my password,' where patrons can
1064 change their password for logging into the OPAC. Patrons will be
1065 presented with a standard form asking them to enter their old password
1066 and then their new password twice.
1067
1068 Change my password
1069 |image1020|
1070
1071 .. _my-search-history-label:
1072
1073 My Search History
1074 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1075
1076 If you have your :ref:`EnableOpacSearchHistory`
1077 preference set to 'Allow' then your patrons can access their search
1078 history via the 'my search history' tab.
1079
1080 my search history tab
1081 |image1021|
1082
1083 The search history is a record of all searches run by the patron.
1084 Clicking on any of the search phrases will re-run the search for the
1085 patron. The search history can be deleted by the patron at any time by
1086 clicking the 'Delete your search history' link found at the top of this
1087 tab or by clicking the little red 'x' next to the 'Search history' link
1088 at the top right of the OPAC.
1089
1090 Search history link at the top right of the OPAC
1091 |image1022|
1092
1093 .. _my-reading-history-label:
1094
1095 My Reading History
1096 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1097
1098 Depending on your library's setting for
1099 :ref:`opacreadinghistory` your patrons may see the
1100 'my reading history' tab next. This will show the patron their entire
1101 reading history unless they have asked the library to not keep that
1102 information via the 'my privacy' tab which will appear if you have the
1103 :ref:`OPACPrivacy` preference set to 'Allow.'
1104
1105 Patron reading history
1106 |image1023|
1107
1108 If you have HTML entered in the
1109 :ref:`OPACMySummaryHTML` preference then you will see
1110 that to the right of the 'Date' column.
1111
1112 .. _my-privacy-label:
1113
1114 My Privacy
1115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1116
1117 The 'my privacy' tab will appear if you have both the
1118 :ref:`opacreadinghistory` and the
1119 :ref:`OPACPrivacy` preferences set to 'Allow.' This tab will
1120 allow the patrons to decide how the library keeps their circulation
1121 history data.
1122
1123 my privacy tab
1124 |image1024|
1125
1126 The patron can choose from three options:
1127
1128 -  Forever: keep my reading history without limit. This is the option
1129    for users who want to keep track of what they are reading.
1130
1131 -  Default: keep my reading history according to local laws. This is the
1132    default option : the library will keep your reading history for the
1133    duration permitted by local laws.
1134
1135 -  Never: Delete my reading history immediately. This will delete all
1136    record of the item that was checked-out upon check-in.
1137
1138 Depending on the patron's suggestions the contents of the ':ref:`my reading
1139 history <my-reading-history-label>`' tab and the ':ref:`Circulation
1140 History <circulation-history-label>`' tab in the staff client may change.
1141
1142 Regardless of the patron's choice they can delete their reading history
1143 in bulk at any time by clicking the 'Immediate deletion' button.
1144
1145 Delete Circulation History
1146 |image1025|
1147
1148 Clicking this button will not delete items that are currently checked
1149 out, but will clear the patron's past reading history.
1150
1151     **Important**
1152
1153     In order for the patron to be able to delete their reading history
1154     you must have the :ref:`AnonymousPatron` preference
1155     set.
1156
1157 If you're allowing guarantees to grand permission to their guarantors to
1158 view their current checkouts with the
1159 :ref:`AllowPatronToSetCheckoutsVisibilityForGuarantor`
1160 preference they will see that option on this
1161 screen.AllowPatronToSetCheckoutsVisibilityForGuarantor
1162
1163 When the guarantor logs in they will see a tab labeled "Relatives'
1164 checkouts" on their summary tab.Relatives' checkouts
1165
1166 .. _my-purchase-suggestions-label:
1167
1168 My Purchase Suggestions
1169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1170
1171 If your library allows patrons to make purchase suggestions the next tab
1172 will show all suggestions that the patron made to the library and their
1173 statuses. To disable this tab and the suggestion functionality set the
1174 :ref:`suggestion` preference to 'Don't allow.'
1175
1176 Patron purchase suggestions
1177 |image1026|
1178
1179 If you have :ref:`OPACViewOthersSuggestions`
1180 set to 'Show' then patrons will be able to search suggestions from the
1181 top of this list.
1182
1183 .. _my-messaging-label:
1184
1185 My Messaging
1186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1187
1188 If your library has the
1189 :ref:`EnhancedMessagingPreferences` and the
1190 :ref:`EnhancedMessagingPreferencesOPAC`
1191 preferences set to 'Allow' then your patrons will be able to choose
1192 which messages they receive from the library (with the exception of
1193 overdue notices which the library controls).
1194
1195 Patron messaging preferences
1196 |image1027|
1197
1198 If you use an outside driver for sending text messages set with the
1199 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
1200 additional column to receive these messages as SMS (or text messages)
1201 and a field for a cell (or SMS) number.
1202
1203 SMSSendDriver in the OPAC
1204 |image1028|
1205
1206 If you are using the Email protocol for sending text messages set with
1207 the :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
1208 additional column to receive these messages as SMS (or text messages), a
1209 field for a cell (or SMS) number, and a pull down listing :ref:`cellular
1210 providers entered in administration <sms-cellular-providers-label>`.
1211
1212 SMSSendDriver in the OPAC
1213 |image1029|
1214
1215 If you are using the :ref:`Itiva Talking
1216 Tech <talkingtechitivaphonenotification-label>` service you will see an
1217 additional column to receive these messages via Phone.Phone messaging
1218 preferences in the OPAC
1219
1220 -  These notices are:
1221
1222    -  Advanced notice : A notice in advance of the patron's items being
1223       due (The patron can choose the number of days in advance)
1224
1225    -  Item checkout : A notice that lists all the of the items the
1226       patron has just checked out and/or renewed, this is an electronic
1227       form of the checkout receipt
1228
1229    -  Hold filled : A notice when you have confirmed the hold is waiting
1230       for the patron
1231
1232    -  Item due : A notice on the day and item is due back at the library
1233
1234    -  Item check-in : A notice that lists all the of the items the
1235       patron has just checked in
1236
1237 Patrons can choose to receive their notices as a digest by checking the
1238 'Digest only?' box along with the delivery method. A digest is a
1239 combination of all the messages of that type (so all items due in 3 days
1240 in one email) in to one email instead of multiple emails for each alert.
1241
1242     **Important**
1243
1244     You must choose a delivery method (SMS or Email or Phone) along with
1245     'Digest only?' if you would like to receive a digest of the
1246     messages.
1247
1248 .. _my-lists-label:
1249
1250 My Lists
1251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1252
1253 Finally, if your library has the :ref:`virtualshelves`
1254 set to 'Allow' then the last tab will by 'my lists.' From here your
1255 patrons can review public lists and create or edit their own private
1256 lists.
1257
1258 Patron lists
1259 |image1030|
1260
1261 .. _ask-for-a-discharge-label:
1262
1263 Ask for a Discharge
1264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1265
1266 If you have enabled the :ref:`useDischarge` preference then
1267 patrons will be able to request a discharge via the OPAC.Discharge tab
1268
1269 From here patrons can request a discharge
1270
1271 Request discharge
1272 |image1031|
1273
1274 And will receive confirmation of their request.
1275
1276 Discharge confirmation
1277 |image1032|
1278
1279 .. _purchase-suggestions-label:
1280
1281 Purchase Suggestions
1282 -------------------------------------------
1283
1284 If your library has the :ref:`suggestion` preference set
1285 to 'Allow' then patrons will have the option to make purchase
1286 suggestions in several areas in the OPAC.
1287
1288 If you are allowing everyone to see the purchase suggestions made by
1289 others with the
1290 :ref:`OPACViewOthersSuggestions` preference,
1291 then there will be a link at the top of your OPAC under the search box.
1292
1293 Purchase Suggestions Link on Search Box
1294 |image1033|
1295
1296 There will be a link when the patron finds nothing for their search.
1297
1298 Purchase Suggestion Link from Search Results
1299 |image1034|
1300
1301 And there will be a link on the patron's :ref:`My Purchase
1302 Suggestions <my-purchase-suggestions-label>` tab.
1303
1304 Purchase Suggestion from My Purchase Suggestions Tab
1305 |image1035|
1306
1307 Clicking any one of these links will open the purchase suggestion form.
1308
1309 New Purchase Suggestion
1310 |image1036|
1311
1312 -  From the form on the 'Title' is required by the library.
1313
1314 -  The Item type list can be edited by editing the SUGGEST\_FORMAT
1315    :ref:`authorized value <authorized-values-label>`.
1316
1317 -  If you would like the 'Reason for suggestion' menu shown in the
1318    screenshot above to appear on your suggestions list you need to add
1319    an :ref:`authorized value <authorized-values-label>` category titled
1320    'OPAC\_SUG' and include reasons as values in that list.
1321
1322 -  If you would like the patron to be able to choose which branch they
1323    are making a suggestion for you need to set the
1324    :ref:`AllowPurchaseSuggestionBranchChoice`
1325    preference to 'Allow'
1326
1327 Once the form is submitted the data will be saved to the
1328 :ref:`Acquisitions <managing-suggestions-label>` module for the librarians to manage.