Completed the section on article requests
[kohadocs.git] / source / circulation.rst
1 .. include:: images.rst
2
3 Circulation
4 ===========
5
6 Circulation functions can be accessed in several different ways. On the
7 main page of the staff client there are some quick links in the center
8 of the page to check items out, in or transfer them. For a complete
9 listing of Circulation functions you can visit the Circulation page
10 which is linked from the top left of every page or from the center of
11 the main page.
12
13 Before circulating your collection you will want to set your :ref:`Global
14 System Preferences <global-system-preferences-label>`, :ref:`Basic
15 Parameters <basic-parameters-label>` and :ref:`Patrons & Circulation
16 Rules <patrons-&-circulation-label>`.
17
18 While in Circulation you can jump between the tabs on the quick search
19 box at the top of the screen by using the following hot keys:
20
21 -  jump to the catalog search with Alt+Q
22
23 -  jump to the checkout with Alt+U
24
25    -  this will not work for Mac users
26
27 -  jump to the checkin with Alt+R
28
29     **Note**
30
31     Mac users use the OPTION button in place of ALT
32
33 .. _check-out-(issuing)-label:
34
35 Check out (issuing)
36 --------------------------------------
37
38 To begin the checkout process you must enter the patron barcode or part
39 of their name. The checkout option appears in three main places:
40
41 -  Check out option on the top of the main staff client
42
43    |image482|
44
45 -  Check out option on the patron record
46
47    |image483|
48
49 -  If you have enabled :ref:`batch checkouts <batch-checkout-label>` then
50    click the batch check out option on the patron record
51
52    |image1254|
53
54 -  Check out option on the quick search bar on the circulation page
55
56    |image484|
57
58 .. _checking-items-out-label:
59
60 Checking items out
61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62
63 To check an item out to a patron, first search for that patron using one
64 of the many options listed above. You will then be presented with the
65 checkout screen.
66
67 |image485|
68
69 If you have chosen to 'Always show checkouts immediately' then you will
70 see the list of checkouts below the check out box.
71
72 |image486|
73
74 At the top of the Check out screen is a box for you to type or scan the
75 item's barcode into.
76
77 -  **Important**
78
79        Many modern barcode scanners will send a 'return' to the browser,
80        making it so that the 'Check out' button is automatically clicked
81
82 -  If the barcode is not found you will be prompted to use fast
83    cataloging to add the item. Learn more about :ref:`fast
84    cataloging <fast-add-cataloging-label>` later in this manual.
85
86 -  If you have
87    :ref:`itemBarcodeFallbackSearch` set to
88    'Enable' then you can enter a keyword search in this box instead of
89    just a barcode (this will make it possible to check out using title
90    and/or call number).
91
92 -  If you have :ref:`AutoSwitchPatron <autoswitchpatron-label>` set to 'Enable',
93    scanning a patron barcode here will take you to that patron's file.
94
95 To see more checkout options click the 'Checkout settings' link to
96 expand the checkout area.
97
98 |image1255|
99
100 Below the box for the barcode there may be options for you to override
101 the default due date for the item.
102
103 -  This option will only appear if you have set the
104    :ref:`SpecifyDueDate` system preference to allow staff
105    to override the due date
106
107 Below the box for the barcode you will see a checkbox for 'Automatic
108 renewal'. This will allow this item to automatically renew if the
109 :ref:`appropriate cron job <automatic-renewal-label>` is running and there are no
110 holds on the item.
111
112 Next is an option to no decrease the loan length based on holds. This
113 overrides the :ref:`decreaseLoanHighHolds <decreaseloanhighholds,-decreaseloanhighholdsduration,-decreaseloanhighholdsvalue,-decreaseloanhighholdscontrol,-and-decreaseloanhighholdsignorestatuses-label>`
114 preference.
115
116 If you're allowing the :ref:`checkout of items on site <onsitecheckouts-label>`
117 to patrons (these are usually items that are not for loan that you would
118 like to check for in library use) then you will see the 'On-site
119 checkout' checkbox after clicking the 'Checkout settings' link to expand
120 your circulation options.
121
122 |image1256|
123
124 At the bottom of the page there is a summary of the patron's current
125 checked out items along with the due date (and time if the item is an
126 hourly loan), items checked out today will appear at the top.
127
128     **Note**
129
130     Items that are hourly loan items will include the time with the due
131     date.
132
133 |image487|
134
135 If you checked out an item for on site use you will see that highlighted
136 in red in the checkout summary.
137
138 |image488|
139
140 If you have set your `ExportWithCsvProfile <#ExportWithCsvProfile>`__
141 preference, you will also see the option to export the patron's current
142 checkout information using a CSV profile or ISO2709 (MARC21) format.
143
144 |image489|
145
146 Also at the bottom of the page is the list of items the patron has on
147 hold
148
149 |image490|
150
151 From the holds list you can suspend or resume patrons holds using the
152 options at the bottom of the list if you have the
153 :ref:`SuspendHoldsIntranet` preference set to
154 'allow.'
155
156     **Note**
157
158     If you have your
159     :ref:`AutoResumeSuspendedHolds` preference
160     set to "Don't allow" then you will not have the option to put an end
161     date on the hold suspension
162
163 If there are notes on the patron record these will appear to the right
164 of the checkout box
165
166 |image491|
167
168 If the patron has a hold waiting at the library that too will appear to
169 the right of the check out box making it easy for the circulation
170 librarian to see that there is another item to give the patron
171
172 |image492|
173
174 The details of the checkouts will appear on the bib detail page in the
175 staff client as well.
176
177 |image493|
178
179 .. _printing-receipts-label:
180
181 Printing receipts
182 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
183
184 Once you have checked out all of the items for the patron you can print
185 them a receipt by choosing one of two methods.
186
187 If you have the :ref:`CircAutoPrintQuickSlip`
188 preference set to 'open a print quick slip window' you can simply hit
189 enter on your keyboard or scan a blank piece of paper with your barcode
190 scanner. The idea being that you're "checking out" a blank barcode which
191 triggers Koha to print the 'Quick slip.'
192
193 You can also click the Print button at the top of the screen and choose
194 'Print slip' or 'Print quick slip'.
195
196 |image494|
197
198 If you choose 'Print slip' it will print all of the items the patron has
199 checked out, including those they checked out at an earlier date.
200 Choosing 'Print quick slip' will print only the items that were checked
201 out today.
202
203 'Print summary' will generate a full page summary for the patron's
204 circulation information and 'Print overdues' will print out a slip that
205 lists all items that are overdue.
206
207 What prints on the slips can be customized by altering the slip
208 templates under the :ref:`Notices & Slips` tool.
209
210 .. _clear-patron-information-label:
211
212 Clear patron information
213 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
214
215 When you're done checking an item out if you have the
216 :ref:`DisplayClearScreenButton` preference set
217 to 'Show' you can clear the current patron by clicking the X in the top
218 right of the patron's info to remove the current patron from the screen
219 and start over.
220
221 |image495|
222
223 If you have the :ref:`CircAutoPrintQuickSlip`
224 preference set to 'clear the screen' then you simply need to hit enter
225 or scan a blank barcode and the screen will be cleared of the current
226 patron.
227
228 .. _batch-checkouts-label:
229
230 Batch checkouts
231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
232
233 If you would like to perform a batch check out you can do so by turning
234 on the :ref:`BatchCheckouts` system preference and
235 assigning the proper patron categories via the
236 :ref:`BatchCheckoutsValidCategories`
237 preference. This will allow you to use an RFID pad that reads multiple
238 barcodes or perform a batch check out for training internal use.
239
240 |image1257|
241
242 From this screen you can scan several barcodes or load a file of
243 barcodes. If those items cannot be checked out they will provide a
244 warning on the following screen
245
246 |image496|
247
248 If you are using a statistical patron type then you'll see that local
249 use was recorded for each item you scanned.
250
251 |image497|
252
253 .. _check-out-messages-label:
254
255 Check out messages
256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
257
258 If you check out an item that has multiple pieces and you have cataloged
259 that information in subfield 3 of the item record (in MARC21) a message
260 will pop up when you check out that item telling you how many pieces
261 should be there.
262
263 |image498|
264
265 There are times when Koha will prevent the librarian from being able to
266 check out items to a patron. When this happens a warning will appear
267 notifying the librarian of why the patron cannot check items out.
268
269 -  Patron owes too much in fines
270
271    |image499|
272
273    -  You can set the amount at which patron checkouts are blocked with
274       the :ref:`noissuescharge` system preference
275
276 -  Patron has a restriction on their account
277
278    |image500|
279
280    -  This can be set by the librarian editing a patron record and
281       adding a `restriction <#patronflags>`__ or by the :ref:`Overdue/Notice
282       Status Triggers <overdue-notice/status-triggers-label>`
283
284    -  If the staff member has the right permission they can override the
285       restriction temporarily
286
287       |image501|
288
289 -  Patron needs to confirm their address
290
291    |image502|
292
293    -  This can be set by the librarian editing a patron record and
294       adding a `flag <#patronflags>`__
295
296 -  Patrons has lost their library card
297
298    |image503|
299
300    -  This can be set by the librarian editing a patron record and
301       adding a `flag <#patronflags>`__
302
303 .. _check-out-warnings-label:
304
305 Check out warnings
306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307
308 Sometimes checkouts will trigger warning messages that will appear in a
309 yellow box above the check out field. These warnings need to be
310 acknowledged before you will be able to continue checking items out.
311
312 -  Patron has outstanding fines
313
314    |image504|
315
316 -  Item on hold for someone else
317
318    |image505|
319
320 -  Item should be on the hold shelf waiting for someone else
321
322    |image506|
323
324 -  Item already checked out to this patron
325
326    |image507|
327
328 -  Item checked out to another patron
329
330    |image508|
331
332    -  This warning will allow you to place a hold on the item for the
333       patron you're trying to check it out to.
334
335 -  Item not for loan
336
337    |image509|
338
339 -  Patron has too many things checked out and
340    :ref:`AllowTooManyOverride` is set to 'Allow'
341
342    |image510|
343
344 -  Patron has too many things checked out and
345    :ref:`AllowTooManyOverride` is set to "Don't
346    allow"
347
348    |image511|
349
350 -  Item cannot be renewed
351
352    |image512|
353
354    -  This can be overridden with the
355       :ref:`AllowRenewalLimitOverride` system
356       preference
357
358 -  Barcode not found
359
360    |image513|
361
362    -  Learn more about :ref:`fast cataloging <fast-add-cataloging-label>` later in this
363       manual.
364
365 -  Item being checked out is marked as 'lost'
366
367    -  Depending on the value in your :ref:`IssueLostItem`
368       preference, you may just see a warning
369
370       |image514|
371
372       or a confirmation box
373
374       |image515|
375
376 -  Item being checked out is not recommended for a patron of this age
377
378    |image516|
379
380 -  Item being checked out meets the
381    :ref:`decreaseLoanHighHolds <decreaseloanhighholds,-decreaseloanhighholdsduration,-decreaseloanhighholdsvalue,-decreaseloanhighholdscontrol,-and-decreaseloanhighholdsignorestatuses-label>` system preference
382    criteria
383
384    |image517|
385
386 .. _renewing-label:
387
388 Renewing
389 -------------------------
390
391 Checked out items can be renewed (checked out for another period of
392 time) based on your :ref:`circulation rules <circulation-and-fine-rules-label>` and :ref:`renewal
393 preferences <renewalperiodbase-label>`.
394
395 If :ref:`you allow it <opacrenewalallowed-label>`, patrons can renew their own
396 items via the OPAC, but sometimes you'll need to help them by renewing
397 their items via the staff client.
398
399 To renew items checked out to a patron, you can do one of two things.
400
401 The first is to visit their details page or checkout page and review
402 their checkout summary at the bottom.
403
404 |image518|
405
406 In the Renew column you will see how many times each item has been
407 renewed and a checkbox to renew the item for the patron. Check the boxed
408 of the items you would like to renew and click the 'Renew or return
409 checked items' button, or to renew all items checked out to the patron
410 simply click the 'Renew all' button.
411
412 |image519|
413
414 Sometimes renewals will be blocked based on your circulation rules, to
415 override this block you must have your
416 :ref:`AllowRenewalLimitOverride` preference
417 set to 'Allow'. If you allow renewal limit overrides, you will see a
418 checkbox at the bottom left of the circulation summary. Check that box
419 and then choose the items you would like to renew.
420
421 |image520|
422
423 Checking that box will add checkboxes in the renew column above where
424 before the item was not renewable.
425
426 The second option is to visit the 'Renew' page found under the
427 Circulation menu.
428
429 |image521|
430
431 And scan the barcodes of the items you would like to renew.
432
433 |image522|
434
435 If the item is renewed you will receive a confirmation message.
436
437 |image523|
438
439 If the barcode is not found you will be presented with an error.
440
441 |image524|
442
443 If the item is not actually checked out you will also receive an error.
444
445 |image525|
446
447 .. _check-in-(returning)-label:
448
449 Check in (returning)
450 --------------------------------------
451
452 Checking in items can be performed from various different locations
453
454 -  The check in box on the top of the main staff client
455
456    |image526|
457
458 -  The check in option on the quick search bar on the Circulation page
459
460    |image527|
461
462 -  The check in link on the patron's checkout summary (and on the
463    checkout summary page)
464
465    |image528|
466
467 -  The Check in page under the Circulation menu
468
469    |image529|
470
471 .. _checking-items-in-label:
472
473 Checking items in
474 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
475
476 To check an item in scan the barcode for the item into the box provided.
477 A summary of all items checked in will appear below the checkin box
478
479 |image530|
480
481 If you are checking items in that were put in the book drop while the
482 library was closed you can check the 'Book drop mode' box before
483 scanning items. This will effectively roll back the returned date to the
484 last date the library was open.
485
486 -  This requires that you have your closings added to the :ref:`Holidays &
487    calendar tool <calendar-label>`
488
489 You can also choose to forgive all overdue charges for items you are
490 checking in by checking the 'Forgive overdue charges' box before
491 scanning items.
492
493 If you have the :ref:`SpecifyReturnDate` preference
494 set to 'Allow' you will be able to arbitrarily set the return date from
495 below the check in box.
496
497 |image1258|
498
499 .. _check-in-messages-label:
500
501 Check in messages
502 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
503
504 There are several messages that can appear when checking items in:
505
506 -  If you are checking an item in at a library other than the home
507    branch, a message will appear asking you to transfer the book to the
508    home library
509
510    |image531|
511
512    -  After this item is checked in the status of the item will be
513       changed in the catalog to 'in transit'
514
515       |image532|
516
517    -  To mark an item as back at the home branch, check the item in at
518       the home branch
519
520       |image533|
521
522       -  A message will appear tell you that the item is not checked
523          out, but the status will now say available in the catalog. This
524          step is necessary to mark items as received by the home branch.
525
526 -  If you are checking in an item that should have multiple parts or
527    pieces a message will appear warning you about the number of pieces
528    you should have in your hand
529
530    |image534|
531
532 -  If you're checking an item in that has a hold on it, you will be
533    prompted to confirm the hold
534
535    |image535|
536
537    -  Clicking the Confirm hold button will mark the item as waiting for
538       pickup from the library
539
540       |image536|
541
542    -  Clicking the 'Print slip and confirm' button will mark the item as
543       waiting for pickup at the library and present the library with a
544       receipt to print and place on the book with the patron's
545       information
546
547    -  Ignoring the hold will leave the item on hold, but leave its
548       status as Available (it will not cancel the hold)
549
550 -  If you're checking in an item that has a hold on it at another branch
551    you will be prompted to confirm and transfer the item
552
553    |image537|
554
555    -  Clicking the 'Confirm hold and transfer' button will mark the item
556       as in transit to the library where the hold was placed
557
558       |image538|
559
560    -  Clicking the 'Print slip, transfer and confirm' button will mark the
561       item as in transit to the library where the hold was placed and
562       present the library with a receipt to print and place on the book
563       with the patron's information
564
565    -  Ignoring the hold will leave the item on hold, but leave its
566       status as Available (it will not cancel the hold)
567
568 -  If you have the system showing you fines at the time of checkin
569    (:ref:`FineNotifyAtCheckin`) you will see a
570    message telling you about the fine and providing you a link to the
571    payment page for that patron
572
573    |image539|
574
575 .. _circulation-messages-label:
576
577 Circulation messages
578 ----------------------------------------
579
580 Circulation messages are short messages that librarians can leave for
581 their patrons or their colleagues that will appear at the time of
582 circulation.
583
584 .. _setting-up-messages-label:
585
586 Setting up messages
587 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
588
589 Circulation messages are set up as :ref:`authorized
590 values <authorized-values-label>`. To add or edit circulation messages you
591 want to work with the `BOR\_NOTES <#bornotes>`__ value.
592
593 |image540|
594
595 The 'Description' field can hold a canned message that you would like to
596 appear on the patron's record.
597
598     **Important**
599
600     The 'Description' field is limited to 80 characters, but the patron
601     message field can hold more than that. Enter 80 characters in the
602     'Description' field and then type the rest on the patron record.
603
604 .. _adding-a-message-label:
605
606 Adding a message
607 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
608
609 When on the patron's check out tab you will see a link to 'Add a new
610 message' to the right of the check out box and a button at the top to
611 'Add message'.
612
613 |image541|
614
615 When you click either of these options you will be asked to choose if
616 the message is for the librarians or the patron and the message you
617 would like to leave.
618
619 |image542|
620
621     **Note**
622
623     A message for the patron will also show to the library staff.
624
625 .. _viewing-messages-label:
626
627 Viewing messages
628 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
629
630 Circulation messages meant for the staff and/or the patron will appear
631 on the patron's checkout screen to the right of the checkout box.
632 Messages in bold and red are meant for the library staff only, whereas
633 messages in regular italics font are meant for the patron and the
634 librarian.
635
636 |image543|
637
638 Circulation messages meant for the patron will also appear when they log
639 into the OPAC.
640
641 |image544|
642
643 .. _holds-label:
644
645 Holds
646 ------------------
647
648 Koha allows patrons to put things on hold. A 'Hold' is a way to reserve
649 an item. Depending on your :ref:`circulation and fine
650 rules <circulation-and-fine-rules-label>` and :ref:`hold preference <holds-policy-label>`
651 settings patrons will be able to place items on hold for pickup at the
652 library at a later date/time.
653
654 .. _placing-holds-in-staff-client-label:
655
656 Placing holds in staff client
657 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
658
659 There are several ways to place holds from the staff client. The most
660 obvious is using the 'Place hold' button at the top of any bibliographic
661 record.
662
663 |image545|
664
665 You can also click the smaller 'Place hold' link found at the top of
666 your catalog search results, or the 'Holds' link found below each
667 result.
668
669 |image546|
670
671 You will be asked to search for a patron by barcode or any part of their
672 name to start the hold process.
673
674 |image547|
675
676 If you'd like to search for the patron first and then the bib record for
677 the hold, you can open the patron record and click on the 'Search to
678 Hold' button at the top of the patron record.
679
680 |image548|
681
682 After clicking the button you will be brought to the catalog search page
683 where you can find the book(s) you want to place a hold on. Under each
684 title on the results you'll see an option to 'Hold for Patron Name.'
685
686 |image549|
687
688 If you want to place a hold on multiple items, simply check the boxes to
689 the left of them and click the arrow to the right of the 'Place Hold'
690 button.
691
692 |image550|
693
694 Depending on how many items you choose to place a hold on at once you
695 will see a different place hold form. If you are placing a hold on one
696 bibliographic record you will see a list of all of the items you can
697 place a hold on.
698
699 |image551|
700
701 -  Enter any notes that might apply to this hold
702
703 -  Choose the library where the patron will pick up the item
704
705 -  If you have the
706    :ref:`AllowHoldItemTypeSelection`
707    preference set to 'Allow' and the record had more than one item type
708    attached you will see an option to choose to limit the hold to a
709    specific item type
710
711    |image1259|
712
713 -  If the patron wants the hold to start on a date other than today,
714    enter that in the 'Hold starts on date' field
715
716    -  This option will only appear if the
717       :ref:`AllowHoldDateInFuture` system
718       preference is set to 'Allow'
719
720 -  If the patron has specified that they don't want the item after a
721    certain date, or if you have limits on hold lengths, you can enter an
722    expiration date for the hold in the 'Hold expires on date'
723
724    -  To have expired holds cancelled automatically you will need to have
725       the :ref:`Expired holds` cron job set to run on a
726       regular basis.
727
728 -  Next choose if you want to place a hold on the next available item or
729    a specific item by clicking the radio button next to an individual
730    item.
731
732 If you're placing a hold on multiple items you will be presented with
733 the next available option for all titles. If no items are available for
734 hold it will say so on the confirmation screen.
735
736 |image552|
737
738 Once your hold is placed, if you'd like to have Koha forget that you
739 used the 'Search to hold' function, you can choose to have Koha 'forget'
740 the patron's name by clicking the arrow to the right of the 'Place hold'
741 button on the search results and choosing the 'Forget' option.
742
743 |image553|
744
745 .. _managing-holds-label:
746
747 Managing holds
748 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
749
750 Holds can be altered and cancelled from the holds tab found on the left
751 of the bibliographic record.
752
753 |image554|
754
755 From the list of holds you can change the order of the holds, the pickup
756 location, suspend and/or cancel the hold.
757
758 |image555|
759
760     **Note**
761
762     If you have your
763     :ref:`AutoResumeSuspendedHolds` preference
764     set to "Don't allow" then you will not have the option to put an end
765     date on the hold suspension
766
767     **Note**
768
769     Depending on how you have your :ref:`HidePatronName`
770     system preference set the list may show card numbers instead of
771     names in the patron column like in the image above.
772
773 To rearrange or delete holds, simply make a selection from the
774 'Priority' pull down or click the arrows to the right of the priority
775 pull down.
776
777 |image556|
778
779 If you use the priority pull down to rearrange or delete holds you will
780 need to click the 'Update hold(s)' button to save your changes.
781
782 Clicking the down arrow to the right of the hold will stick the hold at
783 the bottom of the list even if more requests are made.
784
785 For example, your library has home-bound patrons that are allowed to
786 keep books out for months at a time. It would not be fair to other
787 patrons if a home-bound patron were able to check out a brand new book
788 and keep it for months. For this reason, the home-bound patron's hold
789 request would stay at the bottom of the queue until everyone else who
790 wanted to read that book has already done so.
791
792 |image557|
793
794 If a patron asks to have their hold suspended and you have the
795 :ref:`SuspendHoldsIntranet` system preference set
796 to 'allow' you can do so by clicking the 'Suspend' button to far right. If
797 the patron gives you a date for the items to become unsuspended you can
798 enter that in the date box and click the 'Update hold(s)' button to save
799 your changes.
800
801 |image558|
802
803 To delete or cancel a hold click the red 'X' to the right of the hold
804 line. To delete/cancel a bunch of holds you can choose 'del' from pull
805 down to the left of each line and then click 'Update hold(s)' at the
806 bottom of the list.
807
808 |image559|
809
810 .. _receiving-holds-label:
811
812 Receiving holds
813 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
814
815 When items that are on hold are :ref:`checked in <check-in-(returning)-label>` or
816 :ref:`out <check-out-(issuing)-label>` the system will remind the circulation librarian
817 that the item is on hold and offer them options for managing the hold.
818
819 When you check in an item that has a hold on it the system will ask you
820 to either confirm and transfer the item
821
822 |image560|
823
824 or just confirm the hold
825
826 |image561|
827
828 Clicking the 'Confirm' button will mark the item as on hold for the
829 patron. If the item needs to be transferred the item will also be marked
830 as in transit to the proper branch. Clicking 'Ignore' will retain the
831 hold, but allow you to check the item out to another patron. Choosing to
832 confirm and print will present you with a printable page that you can
833 slip inside the book with the necessary hold and/or transfer
834 information.
835
836 Once confirmed the hold will show on the patron record and on the
837 checkout screen under the 'Hold' tab.
838
839 |image490|
840
841 From here if the patron would like you suspend their holds you can do so
842 one by one or in bulk.
843
844 The item record will also show that the item is on hold.
845
846 |image563|
847
848 In some cases a patron may come in to pick up a hold for their partner
849 (or someone else in their household). In this case you want to make sure
850 that the hold is cancelled when you check the item out to someone else.
851 When trying to check out an item that is already waiting for someone
852 else you will be presented with a warning message.
853
854 |image564|
855
856 From here you can check the item out to the patron at the desk and
857 cancel the hold for the patron.
858
859 .. _transfers-label:
860
861 Transfers
862 --------------------------
863
864 If you work in a multi-branch system you can transfer items from one
865 library to another by using the Transfer tool.
866
867 -  *Get there*: Circulation > Transfer
868
869 To transfer an item
870
871 -  Click 'Transfer' on the Circulation page
872
873    |image565|
874
875    -  Enter the library you would like to transfer the item to
876
877    -  Scan or type the barcode on the item you would like to transfer
878
879 -  Click 'Submit'
880
881    |image566|
882
883 -  The item will now say that it is in transit
884
885    |image567|
886
887 -  When the item arrives at the other branch the librarian must check
888    the item in to acknowledge that it is no longer in transit
889
890 -  The item will not be permanently moved to the new library
891
892    |image568|
893
894    -  The item shows the same 'Home library' but has updated the
895       'Current location' to note where it resides at this time
896
897 .. _set-library-label:
898
899 Set library
900 -----------------------------
901
902 By default you will enter the staff client as if you are at your home
903 library. This library will appear in the top right of the staff client.
904
905 |image569|
906
907 This is the library that all circulation transactions will take place
908 at. If you are at another library (or on a bookmobile) you will want to
909 set your library before you start circulating items. To do this you can
910 click 'Set' at the top right or on the Circulation page.
911
912 |image570|
913
914 Once you have saved your changes you new library will appear in the top
915 right.
916
917 .. _fast-add-cataloging-label:
918
919 Fast add cataloging
920 -------------------------------------
921
922 Sometimes circulation librarians need to quickly add a record to the
923 system for an item they are about to check out. This is called 'Fast
924 add'. To allow circulation librarians access to the Fast add cataloging
925 tool, simply make sure they have the
926 `fast\_cataloging <#fastaddpermissions>`__ permissions. There are two
927 ways to add titles via fast add. If you know that you're about to check
928 out an item that isn't in you catalog you can go to the Circulation
929 module and click 'Fast cataloging.'
930
931 |image571|
932
933 The cataloging interface will open up with the short cataloging record:
934
935 |image572|
936
937 After adding your cataloging data you will be asked to enter item data.
938 Enter the items barcode, collection code, etc and save the item before
939 checking it out.
940
941 The other way to fast catalog is from the checkout screen. When you
942 enter a barcode at checkout that Koha can't find, it will prompt you to
943 use fast cataloging to add the item to Koha and check it out.
944
945 |image573|
946
947 Clicking 'Fast cataloging' will bring you to the fast cataloging form
948 where you can enter the title information
949
950 |image574|
951
952 After clicking 'Save' you will be brought to the item record where the
953 barcode will already be filled in with the barcode you're trying to
954 check out.
955
956 |image575|
957
958 After clicking the 'Add item' button the item will automatically be
959 checked out the patron you were trying to check the book out to
960 originally.
961
962 |image576|
963
964 .. _circulation-reports-label:
965
966 Circulation reports
967 --------------------------------------
968
969 Most reports can be found via the Reports module, but some of the more
970 common circulation reports are available right from the Circulation
971 module.
972
973 -  *Get there*: Circulation > Circulation reports
974
975 .. _holds-queue-label:
976
977 Holds queue
978 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
979
980 This report will show you all of the holds at your library.
981
982 |image577|
983
984 To generate this report, you must have the :ref:`Build holds queue cron
985 job <holds-queue-label>` running. This cron job is a script that should
986 be run periodically if your library system allows borrowers to place
987 on-shelf holds. This script decides which library should be responsible
988 for fulfilling a given hold request.
989
990 It's behavior is controlled by the system preferences
991 :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>` and
992 :ref:`RandomizeHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
993
994 If you do not want all of your libraries to participate in the on-shelf
995 holds fulfillment process, you should list the libraries that \*do\*
996 participate in the process here by inputting all the participating
997 library's branchcodes, separated by commas ( e.g. "MPL,CPL,SPL,BML" etc.
998 ).
999
1000 By default, the holds queue will be generated such that the system will
1001 first attempt to hold fulfillment using items already at the pickup
1002 library if possible. If there are no items available at the pickup
1003 library to fill a hold, build\_holds\_queue.pl will then use the list of
1004 libraries defined in StaticHoldsQueueWeight. If
1005 RandomizeHoldsQueueWeight is disabled (which it is by default), the
1006 script will assign fulfillment requests in the order the branches are
1007 placed in the StaticHoldsQueueWeight system preference.
1008
1009 For example, if your system has three libraries, of varying sizes (
1010 small, medium and large) and you want the burden of holds fulfillment
1011 to be on larger libraries before smaller libraries, you would want
1012 StaticHoldsQueueWeight to look something like "LRG,MED,SML".
1013
1014 If you want the burden of holds fulfillment to be spread out equally
1015 throughout your library system, simply enable RandomizeHoldsQueueWeight.
1016 When this system preference is enabled, the order in which libraries
1017 will be requested to fulfill an on-shelf hold will be randomized each
1018 time the list is regenerated.
1019
1020 Leaving StaticHoldsQueueWeight empty is contraindicated at this time.
1021 Doing so will cause the build\_holds\_queue script to ignore
1022 RandomizeHoldsQueueWeight, causing the script to request hold
1023 fulfillment not randomly, but by alphabetical order.
1024
1025 .. _holds-to-pull-label:
1026
1027 Holds to pull
1028 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1029
1030 This report will show you all of the items that have holds on them that
1031 are available at the library for pulling. If the items are available at
1032 multiple branches then all branches with that item available will see
1033 the hold to pull until one library triggers the hold.
1034
1035 If enabled, clicking the *Mark item as lost* button will mark item as lost and notify
1036 the requesting patron depending on the value of the :ref:`CanMarkHoldsAwaitingPickupAsLost`
1037 system preference.
1038
1039 |image578|
1040
1041 You can limit the results you see by using the Refine box on the left
1042 side of the page:
1043
1044 |image579|
1045
1046 .. _holds-awaiting-pickup-label:
1047
1048 Holds awaiting pickup
1049 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1050
1051 This report will show all of the holds that are waiting for patrons to
1052 pick them up.
1053
1054 |image580|
1055
1056 Items that have been on the hold shelf longer than you normally allow
1057 (based on the :ref:`ReservesMaxPickUpDelay`
1058 preference value) will appear on the 'Holds over' tab, they will not
1059 automatically be cancelled unless you have set the :ref:`cron
1060 job <expired-holds-label>` to do that for you, but you can cancel all
1061 holds using the button at the top of the list.
1062
1063 |image581|
1064
1065 .. _hold-ratios-label:
1066
1067 Hold ratios
1068 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1069
1070 Hold ratios help with collection development. Using this report you will
1071 be able to see how many of your patrons have holds on items and whether
1072 you should buy more. By default it will be set to the library needing 3
1073 items per hold that has been placed. The report will tell you how many
1074 additional items need to be purchased to meet this quota.
1075
1076 |image582|
1077
1078 .. _transfers-to-receive-label:
1079
1080 Transfers to receive
1081 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1082
1083 This report will list all of the items that Koha thinks are in transit
1084 to your library.
1085
1086 |image583|
1087
1088 If your transfers are late in arriving at your library you will see a
1089 message stating how late your items are.
1090
1091 |image584|
1092
1093     **Important**
1094
1095     An item is considered late based on the number of days you have
1096     entered in the
1097     :ref:`TransfersMaxDaysWarning` system
1098     preference.
1099     
1100 .. _article-requests-label:
1101
1102 Article requests
1103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1104
1105 Article requests are somewhat similar to holds, but are not requests 
1106 for an item to check out. Instead, article requests are requests for a 
1107 photocopy of a particular section of a book or an article from a serial 
1108 issue. This is very common in academic libraries where researchers may 
1109 request a copy of a single article found in a journal.
1110
1111 .. _setting-up-article-requests-label:
1112
1113 Setting up article requests
1114 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1115
1116 First, enable your system preference for :ref:`ArticleRequests`. 
1117
1118 Set to 'Enable' patrons to place article requests.
1119
1120 Next you will need to decide how your patrons will make requests, 
1121 either record only, item only, or both record and item level.
1122
1123 You can set 3 different system preferences for mandatory fields to be filled 
1124 in depending on how your records are requested.
1125
1126   - :ref:`ArticleRequestsMandatoryFields`: make the following fields
1127     mandatory for records that are record level or item level requestable
1128
1129   - :ref:`ArticleRequestsMandatoryFieldsItemOnly` make the following
1130     fields mandatory for records that are only item level requestable
1131
1132   - :ref:`ArticleRequestsMandatoryFieldsRecordOnly` make the
1133     following fields mandatory for records that are only record level
1134     requestable
1135
1136 Next you will want to go into your :ref:`circulation and fine rules 
1137 matrix<circulation-and-fine-rules-label>` and select each rule for which  
1138 you want to allow requests.
1139
1140 You can allow requests to be made at the record level, item level, 
1141 yes (which means both) and no (which means no article requests may 
1142 be placed).
1143
1144 .. _placing-article-requests-label:
1145
1146 Placing article requests
1147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1148
1149 Now you can place requests on both the staff client and OPAC.
1150
1151 In the staff client, on the record details page, you will see a 
1152 'Request article' button at the top and an 'Article requests' tab 
1153 to the left. The two options lead to the same page.
1154
1155 |image1394|
1156
1157 Just like a hold, you will be prompted to enter the patron's card 
1158 number or name.
1159
1160 |image1395|
1161
1162 Fill in the form.
1163
1164 |image1396|
1165
1166        **Note**
1167
1168        Remember, the mandatory fields are set through the three system 
1169        preferences :ref:`ArticleRequestsMandatoryFields`, 
1170        :ref:`ArticleRequestsMandatoryFieldsItemOnly`, and 
1171        :ref:`ArticleRequestsMandatoryFieldsRecordOnly`.
1172
1173 If allowed, choose the specific item to request.
1174
1175 Then, click on 'Place request'.
1176
1177 From the OPAC, patrons can place requests themselves either from the 
1178 results list 
1179
1180 |image1397|
1181
1182 or by going to the detailed record.
1183
1184 |image1398|
1185
1186 As with a hold, if the patron is not logged in, they will be 
1187 asked to do so.
1188
1189 The form is the same as the one in the staff interface.
1190
1191 |image1399|
1192
1193 If allowed, the patron chan choose the specific item to request.
1194
1195 From their acocunt, the patron will be able to follow the progress 
1196 of their request from 'pending'
1197
1198 |image1400|
1199
1200 to 'processing'.
1201
1202 |image1401|
1203
1204 The patron will also receive an email notification when the status of 
1205 the request changes.
1206
1207 Once the request is completed the patron will receive an email notification 
1208 and the article request will no longer appear in their account.
1209
1210 Managing article requests
1211 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1212
1213 Once the article request has been placed, staff will see new requests at 
1214 the bottom of the home page on the staff client. (In the same location 
1215 as tags, comments and modifications).
1216
1217 |image1402|
1218
1219 From there staff will be able to select requests to process.
1220
1221 |image1403|
1222
1223 The first step would be for a staff member to process the request, that moves 
1224 the request to the processing tab and alerts other staff members that the 
1225 request is in process. In the actions column, click on the dropdown menu and 
1226 select 'Process request'. This will move the request to the processing tab.
1227
1228 |image1404|
1229
1230 Next staff will go to the shelf and make a copy of the requested article.
1231
1232 Once that is complete, staff can print the article request slip (this can be 
1233 customized in :ref:`notices and slips<notices-&-slips-label>` under AR\_SLIP) 
1234 and staple or paper clip it to the article. In the actions column, you can 
1235 select the dropdown and select print slip.
1236
1237 Finally, staff will select the complete article request from the actions 
1238 dropdown menu which will send a notice to the patron who made the request 
1239 letting them know the request is ready for pickup.
1240
1241 This removes the article request from the processing tab.
1242
1243 .. _overdues-label:
1244
1245 Overdues
1246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1247
1248     **Important**
1249
1250     For libraries with a large patron base, this report may take a
1251     significant amount of time to run.
1252
1253     **Note**
1254
1255     Large libraries can choose to filter the report before it runs by
1256     setting the
1257     :ref:`FilterBeforeOverdueReport` system
1258     preference to 'Require'.
1259
1260 This report will list all items that are overdue at your library.
1261
1262 |image585|
1263
1264 The report can be filtered using the menu options found on the left of
1265 the report.
1266
1267     **Note**
1268
1269     The 'Show any items currently checked out' checkbox basically
1270     switches this from a report of overdues to a report of checkouts. It
1271     will show all titles checked out regardless of due date.
1272
1273 .. _overdues-with-fines-label:
1274
1275 Overdues with fines
1276 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1277
1278 This report will show you any overdues at your library that have accrued
1279 fines on them.
1280
1281 |image586|
1282
1283 If you would like to limit the report you can use the pull down menu at
1284 the top to limit to a specific shelving location at your branch. To see
1285 overdues with fines at other branches you will have to :ref:`change your
1286 branch <set-library-label>` or log in at that branch.
1287
1288     **Important**
1289
1290     If you do not charge fines and/or don't have the :ref:`fines cron
1291     job <fines-label>` running you will see no data on this report.
1292
1293 .. _pending-on-site-checkouts-label:
1294
1295 Pending on-site checkouts
1296 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1297
1298 If you are using the on site checkouts functionality
1299 (:ref:`OnSiteCheckouts`) then you'll have a report to
1300 view all items that are currently checked out on site.
1301
1302 |image1260|
1303
1304 This will list the due date (overdues in red), who has the item, item
1305 information and what library the item is at.
1306
1307 .. _tracking-in-house-use-label:
1308
1309 Tracking in-house use
1310 -----------------------------------------
1311
1312 Many libraries track the use of items within the library.
1313
1314     **Note**
1315
1316     This is different from tracking on-site usage. In-house use is the
1317     use of items in the library by patrons without them having to check
1318     them out. On-site use is the use of items on site that must first be
1319     checked out. To learn more about on site usage please review the
1320     :ref:`OnSiteCheckouts` preference.
1321
1322 Tracking the use of items in the library without checking them out can
1323 be done in Koha one of two ways. The first is to create one or more
1324 :ref:`Statistical Patrons <add-a-statistical-patron-label>`. When collecting items that
1325 have been used within the library, you will want to check them out to
1326 your statistical patron:
1327
1328 |image587|
1329
1330 Instead of marking the item as 'checked out' the system will record that
1331 the item was used in house:
1332
1333 |image588|
1334
1335 Repeat these steps for all items that have been used within the library
1336 to keep accurate statistics for item use.
1337
1338 The other way to record local use of items is to set your
1339 :ref:`RecordLocalUseOnReturn` preference to
1340 'Record.' Then whenever you check an item in that is not checked out and
1341 not on hold a local use will be recorded.
1342
1343 |image589|
1344
1345     **Note**
1346
1347     If you have :ref:`RecordLocalUseOnReturn` set
1348     to 'Record' you can still use your statistical patrons to record
1349     local use as well.
1350
1351 .. _in-processing-/-book-cart-locations-label:
1352
1353 In processing / book cart locations
1354 --------------------------------------------------------------
1355
1356 Koha allows for handling temporary locations like the processing center
1357 and/or book carts throughout the library. For this feature to work you
1358 must first make sure you have :ref:`authorized values <authorized-values-label>`
1359 set in the `LOC <#shelvelocvals>`__ category for PROC (processing
1360 center) and CART (book cart).
1361
1362 |image590|
1363
1364 Next you need to set the
1365 :ref:`NewItemsDefaultLocation` system preference
1366 to PROC. This will set the new items to the processing center as their
1367 default location.
1368
1369 When creating items you enter in their desired final shelving location
1370 and Koha will temporarily change that to PROC. If
1371 :ref:`InProcessingToShelvingCart` is set to
1372 "Don't move" then when an item with a location of PROC is checked in it
1373 will either automatically update the item to use the permanent location.
1374 If :ref:`InProcessingToShelvingCart` is set
1375 to "Move" then when an item is checked in the location is changed from
1376 PROC to CART.
1377
1378 A :ref:`cron job <in-processing/book-cart-label>` is then set to run at specified intervals
1379 to age items from CART to the permanent shelving location. (For example,
1380 an hourly cron entry of cart\_to\_shelf.pl --hours 3 where --hours is
1381 the amount of time an item should spend on the cart before aging to its
1382 permanent location.)
1383
1384 -  **Note**
1385
1386        If the :ref:`ReturnToShelvingCart` system
1387        preference is set to "Move", any newly checked-in item is also
1388        automatically put into the shelving cart, to be covered by the
1389        same script run.
1390
1391 -  **Important**
1392
1393        Checkins with confirmed holds will not go into the shelving cart.
1394        If items on the shelving cart are checked out, the cart location
1395        will be cleared.
1396
1397 .. _self-checkout-label:
1398
1399 Self checkout
1400 ---------------------------------
1401
1402 Koha comes with a very basic self checkout module. To enable this module
1403 you need to set the :ref:`WebBasedSelfCheck <webbasedselfcheck-label>` system
1404 preference to 'Enable.' To use this module you have to log in as a
1405 :ref:`staff member <add-a-staff-patron-label>` with :ref:`self\_check 
1406 permissions <patron-permissions-label>`.
1407
1408     **Note**
1409
1410     Create a :ref:`staff patron <add-a-staff-patron-label>` specifically for this
1411     action so that you don't leave a real staff client logged into a
1412     computer all day
1413
1414 There is no link to the Self checkout module, but a simple addition to
1415 the :ref:`OPACUserJS` system preference can add one.
1416
1417 ::
1418
1419     $(document).ready(function(){ 
1420         $("#login .btn").parent().after("<p><a href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\" target=\"_blank\">Self-Checkout</a></p>");
1421     });
1422
1423     **Important**
1424
1425     The code above has line breaks added to make it more readable,
1426     please be sure to enter the above as one line in when putting it in
1427     the system preference.
1428
1429 The link will then appear at the bottom of the log in page:
1430
1431 |image591|
1432
1433 You can also access this module by going to:
1434 http://YOUR\_KOHA\_OPAC\_URL/cgi-bin/koha/sco/sco-main.pl
1435
1436 When on the self checkout page depending on your value in the
1437 :ref:`SelfCheckoutByLogin <selfcheckoutbylogin-label>` system preference 
1438 you will be asked to enter you cardnumber
1439
1440 |image592|
1441
1442 or your username and password
1443
1444 |image593|
1445
1446 Once you're logged in to the self check module you will be asked to scan
1447 the items you are checking out
1448
1449 |image594|
1450
1451 As you scan items they will appear below the barcode box
1452
1453 |image595|
1454
1455 When you are finished scanning items it is important to click the
1456 'Finish' button. This will prompt you to print a receipt and log you out
1457 of the self check module.
1458
1459 |image596|
1460
1461 When attempting to check items out there are some instances where error
1462 messages will appear and the patron will be directed to the librarian.
1463 This will happen even if you are allowing overrides on circulation
1464 functions. Only a librarian can override a circulation block and so
1465 patrons must go to the librarian for help in these situations.
1466
1467 |image597|
1468
1469 .. _self-checkin-label:
1470
1471 Self check-in
1472 ------------------------------------------------
1473
1474 In order to use the self check-in module, you must first set the :ref:
1475 `SelfCheckInModule <selfscheckinmodule-label>` system preference to
1476 'Enable'.
1477
1478 Then, you will have to :ref:`create a patron <add-a-staff-patron-label>` 
1479 with the :ref:`self\_checkin\_module permission
1480 <granular-self-check-permissions-label>`.
1481
1482     **Note**
1483
1484     Create a :ref:`staff patron <add-a-staff-patron-label>` specifically for this
1485     action so that you don't leave a real staff client logged into a
1486     computer all day. You can give this patron only the aforementionned 
1487     permission so it cannot be used for anything else.
1488
1489 Once this is done, you can head over to the self check-in page:
1490 http://YOUR\_KOHA\_OPAC\_URL/cgi-bin/koha/sci/sci-main.pl
1491
1492 Log in with your staff patron with self check-in permissions
1493
1494 Once the computer or kiosk is set and the self check-in user logged in,
1495 patrons will be able to check-in their items themselves.
1496
1497 |image1331|
1498
1499 The patron will either scan the item's barcode, if the computer is 
1500 attached to a barcode scanner, or type in their item's barcode in the box
1501 and click 'Add' or press enter.
1502
1503     **Note**
1504
1505     Most barcode scanners will automatically hit return after scanning.
1506
1507 Once they have scanned or entered all their items' barcodes, they can 
1508 click on the 'Check-in' button to return all the items at once.
1509
1510     **Important**
1511
1512     If the patron doesn't click the 'Check-in' button, the items will not
1513     be returned and will stay in their account.
1514
1515     **Important**
1516
1517     The self check-in module will not warn user if the item is late, if 
1518     they have fines, if the item is on hold for someone else, or if they 
1519     have messages in their account.
1520
1521 |image1332|
1522
1523 They can then click 'Finish' to return to the main self check-in page.
1524
1525 |image1333|
1526
1527     **Note**
1528
1529     If the patron doesn't click 'Finish', the screen will refresh after the
1530     timeout period specified in the :ref:`SelfCheckInTimeout
1531     <selfcheckintimeout-label>` system preference.
1532
1533     **Note**
1534
1535     Even if the patron doesn't click 'Finish' the item will still be checked 
1536     in from their account.
1537
1538 You can cutomize the look of your self check-in screens by using the 
1539 :ref:`SelfCheckInUserCSS <selfcheckinusercss-label>` system preference or
1540 the :ref:`SelfCheckInUserJS <selfcheckinuserjs-label>` system preference.
1541
1542 You can add content, like instructions on how to use the self check-in system
1543 for example, by using the :ref:`SelfCheckInMainUserBlock
1544 <selfcheckinmainuserblock-label>` system preference.
1545
1546 Statistics about the transactions made through the self check-in module
1547 are logged into the action\_logs table in the Koha database. You can therefore
1548 :ref:`build a custom report <custom-reports-label>` to get the statistics you
1549 need.
1550
1551 .. _offline-circulation-utilities-label:
1552
1553 Offline circulation utilities
1554 ------------------------------------------------
1555
1556 Koha allows for you to continue circulation actions while offline by
1557 using any one of three utilities.
1558
1559 .. _offline-circulation-in-koha-label:
1560
1561 Offline circulation in Koha
1562 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1563
1564 If the :ref:`AllowOfflineCirculation` preference
1565 is set to 'Enable' the library staff can continue to perform circulation
1566 actions within Koha when the system is offline. You will want to visit
1567 http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least
1568 once while online and bookmark that page. That is the page you will go
1569 to when you are offline.
1570
1571     **Important**
1572
1573     The offline interface uses HTML LocalStorage, which depending on the
1574     browser and user setting, is limited to 2.5MB or 5MB per domain.
1575     This means that larger systems will not be able to synchronize their
1576     data and are recommended to use either the
1577     :ref:`Firefox <firefox-plugin-label>` or
1578     :ref:`Windows <offline-circ-tool-for-windows-label>` application for offline
1579     circulation.
1580
1581 .. _setup-label:
1582
1583 Setup
1584 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1585
1586 Before the first time the system goes offline go to Circulation and
1587 choose 'Built-in offline circulation interface'
1588
1589 |image598|
1590
1591 And synchronize your data on every circulation computer by clicking the
1592 'Synchronize' link on the right of the screen.
1593
1594 |image599|
1595
1596     **Important**
1597
1598     The offline interface uses HTML LocalStorage, which depending on the
1599     browser and user setting, is limited to 2.5MB or 5MB per domain.
1600     This means that larger systems will not be able to synchronize their
1601     data and are recommended to use either the
1602     :ref:`Firefox <firefox-plugin-label>` or
1603     :ref:`Windows <offline-circ-tool-for-windows-label>` application for offline
1604     circulation.
1605
1606 This will allow you download a local copy of your patrons and
1607 circulation data. Click the 'Download records' link at the top of the
1608 page to synchronize your data.
1609
1610 |image600|
1611
1612 Once your data is downloaded you will see the dates your data was last
1613 synced to the right of each data set.
1614
1615 |image1261|
1616
1617 This should be done regularly in preparation for any unexpected connection losses.
1618
1619 .. _circulating-label:
1620
1621 Circulating
1622 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1623
1624 When your system goes offline visit the Offline Circulation page
1625 (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha
1626 and click 'Check out' or 'Check in' to perform offline actions.
1627
1628 Checking out is done by searching for the patron by barcode or name at
1629 the top of the 'Check out' screen. After selecting a patron you will be
1630 presented with the synced patron info, including fines and check outs.
1631
1632 |image601|
1633
1634 Scan the barcode of the item you would like to check out and enter a due
1635 date. If you don't enter a due date Koha will prompt you for one.
1636
1637 |image602|
1638
1639 Once the item is checked out it will appear below the patron's info.
1640
1641 |image603|
1642
1643 .. _koha-offline-uploading-label:
1644
1645 Koha offline uploading
1646 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1647
1648 Once the system is back online visit the 'Synchronize' page on the Offline
1649 circulation module and click 'Upload transactions'
1650
1651 |image604|
1652
1653 After the files are uploaded you can click 'View pending offline
1654 circulation actions' on the right.
1655
1656 |image605|
1657
1658 After clicking 'View pending offline circulation actions' you will be
1659 brought to a summary of all of the actions you loaded in to Koha in your
1660 \*.koc file.
1661
1662 |image606|
1663
1664 -  Once all of the logs from all of the circulation computers are loaded
1665    you will be able to check them all or select just those you want to
1666    process into Koha.
1667
1668 -  Click on the 'Process' button and Koha will record every stored
1669    transaction one by one. For each transaction, the status will change
1670    to:
1671
1672    -  "Success." if the transaction was processed correctly
1673
1674    -  "Borrower not found." if the borrower card number is incorrect
1675
1676    -  "Item not found." if the item barcode is wrong
1677
1678    -  "Item not issued." if you checked in an available item
1679
1680 Once finished you will have a summary of all of your transactions
1681
1682 |image607|
1683
1684 .. _firefox-plugin-label:
1685
1686 Firefox plugin
1687 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1688
1689 There is an offline circulation tool that you can add to your Firefox
1690 browser as an addon. To do so, just go to
1691 https://addons.mozilla.org/en/firefox/addon/koct/ page and click on the
1692 "install now" button. You may have to confirm the installation, just
1693 click on "install now" and then restart Firefox to complete the
1694 installation.
1695
1696 Once you have installed the plugins and restarted Firefox, you will see
1697 the Koha logo in the download bar at the bottom right of Firefox.
1698
1699 |image608|
1700
1701 A click on the logo will open the tool in its own window.
1702
1703 |image609|
1704
1705 The plugin consists of four tabs:
1706
1707 -  The 'Check out' tab is where you check out items
1708
1709 -  The 'Check in' tab is where you check in items
1710
1711 -  The 'Log' tab keeps track of every transaction done while in offline
1712    mode
1713
1714    -  The log will keep information until you empty it. Each time you
1715       open the plugin and it contains data in the log it will warn you
1716
1717       |image610|
1718
1719       If you'd like to clear the log, check the 'I want to delete rows'
1720       box before hitting the 'OK' button. Otherwise clicking 'OK' will
1721       keep the items in the log and let you continue working with the
1722       tool.
1723
1724 -  The 'Param' tab is to set up the plugin
1725
1726 The first thing you want to do then is to set up the plugin. Go to the
1727 'Param' tab to set up the plugin
1728
1729 |image611|
1730
1731 Answer the 4 questions presented:
1732
1733 -  Server = the URL of the librarian interface
1734
1735 -  Branch code = the code for the branch where you are located
1736
1737 -  Username = your staff account login
1738
1739 -  Password = your staff account password
1740
1741     **Important**
1742
1743     To save the settings, you will have to close the plugin window and
1744     re-open it by clicking again on the Koha logo in the add-on bar.
1745
1746     **Note**
1747
1748     You can create a staff account dedicated to the offline circulation.
1749     So that, no matter who is at the circulation desk, they can all use
1750     the same login. Along those lines, you can use a group login that
1751     you already have in place for circulation as well.
1752
1753 Once you have everything set up you can start checking items in and out.
1754
1755 Checking out:
1756
1757 |image612|
1758
1759 -  Go to the 'Check out' tab
1760
1761 -  Scan the patron barcode
1762
1763 -  Scan the item barcode
1764
1765 -  Click 'Save'
1766
1767 Checking in:
1768
1769 |image613|
1770
1771 -  Go to the 'Check in' tab
1772
1773 -  Scan the item barcode
1774
1775 -  Click 'Save'
1776
1777 Each time, you check out or check in an item, a new transaction is
1778 recorded in the local plugin database and you will see, at the bottom of
1779 the plugin how many transactions has been made during the offline
1780 circulation. For example, "10 row(s) added" means you did 10
1781 transactions.
1782
1783 |image614|
1784
1785 Then, if you want an overview of every transaction, go to the Log tab.
1786 This tab will show you the transactions in the plugin database
1787
1788 |image615|
1789
1790     **Note**
1791
1792     The status will be "Local." as long as you are offline and don't
1793     process the transactions into Koha.
1794
1795 When your Internet connection comes back up you will want to get these
1796 transactions in to Koha. Before processing these transactions you should
1797 be aware of a few issues.
1798
1799 Because you are not connected to your Koha database when using this
1800 plugin holds will need additional processing. If an item you check in
1801 while offline has a hold, the hold is kept on the item. Since, you can't
1802 confirm holds found during the processing of every check in, the holds
1803 stay on the item and will need to be managed later. If you only checked
1804 in a few items you can just keep a record of them all. If you checked in
1805 a lot of items you can use the Holds queue once it rebuilds to see what
1806 holds made it to the shelf erroneously.
1807
1808 Similarly, if an patron card was expired, the offline circulation tool
1809 won't know about it, so the checkout will be recorded regardless of the
1810 patron's account being blocked normally.
1811
1812 You have two options for adding this data to Koha
1813
1814 -  Commit to Koha
1815
1816    -  If you checked in/out on more than one computer at the same time,
1817       what you want is to process every transaction consistently. Let's
1818       say for instance that one patron checked a book out on one
1819       computer and then checked the same book in on another computer. To
1820       be consistent, you need to record the check out first and then the
1821       check in. Not the opposite! To do so, you need to group every
1822       transaction in one place, sort them all and then, process
1823       everything. So, you need to use the "Commit to Koha" option from
1824       every plugin/computer you worked with. This way, the log will go
1825       to Koha and be accessible from the Offline Circulation page.
1826
1827       |image616|
1828
1829    -  *Get there:* Circulation > Pending offline circulation actions
1830
1831       |image617|
1832
1833    -  Once all of the logs from all of the circulation computers are
1834       loaded you will be able to check them all or select just those you
1835       want to process into Koha.
1836
1837    -  Click on the Process button and Koha will record every stored
1838       transaction one by one. For each transaction, the status will
1839       change to:
1840
1841       -  "Success." if the transaction was processed correctly
1842
1843       -  "Borrower not found." if the borrower card number is incorrect
1844
1845       -  "Item not found." if the item barcode is wrong
1846
1847       -  "Item not issued." if you checked in an available item
1848
1849    -  Once finished you will have a summary of all of your transactions
1850
1851       |image618|
1852
1853 -  Apply directly
1854
1855    -  If you performed all of the circulation actions on one computer
1856       then everything is sorted already so you can choose to "Apply
1857       directly"
1858
1859    -  The status column will be updated to let you know if the
1860       transactions were applied
1861
1862       -  "Success." if the transaction was processed correctly
1863
1864       -  "Borrower not found." if the borrower card number is incorrect
1865
1866       -  "Item not found." if the item barcode is wrong
1867
1868       -  "Item not issued." if you checked in an available item
1869
1870    -  Once you're finished you can review all of the items right in the
1871       Log tab
1872
1873       |image619|
1874
1875 Once you are done you can clear the log by clicking Clear. If you don't
1876 you will be warned the next time you open the Offline circulation tool.
1877
1878 |image620|
1879
1880 .. _offline-circ-tool-for-windows-label:
1881
1882 Offline circ tool for Windows
1883 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1884
1885 The Offline circulation utility can be downloaded at:
1886 https://github.com/bywatersolutions/koha-offline-circulation/releases
1887
1888 To generate a borrowers.db file for loading in to the Windows tool you
1889 will need to run the :ref:`file generator via a cron
1890 job <generate-patron-file-for-offline-circulation-label>`.
1891
1892 .. _upload-offline-circ-file-label:
1893
1894 Upload offline circ file
1895 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1896
1897 The :ref:`offline circulation tool for Windows <offline-circ-tool-for-windows-label>` will
1898 generate a KOC file that you can upload into Koha once your system comes
1899 back up.
1900
1901 On the Circulation menu click 'Upload offline circulation file (.koc)'
1902
1903 |image621|
1904
1905 Browse your computer for the \*.koc file
1906
1907 |image622|
1908
1909 Once the file is uploaded, click the process the file
1910
1911 |image623|
1912
1913 When this is complete you'll be able to upload another file or tend to
1914 pending offline circulation actions.
1915
1916 |image624|
1917
1918 After clicking 'View pending offline circulation actions' you will be
1919 brought to a summary of all of the actions you loaded in to Koha in your
1920 \*.koc file.
1921
1922 |image625|
1923
1924 -  Once all of the logs from all of the circulation computers are loaded
1925    you will be able to check them all or select just those you want to
1926    process into Koha.
1927
1928 -  Click on the Process button and Koha will record every stored
1929    transaction one by one. For each transaction, the status will change
1930    to:
1931
1932    -  "Success." if the transaction was processed correctly
1933
1934    -  "Borrower not found." if the borrower card number is incorrect
1935
1936    -  "Item not found." if the item barcode is wrong
1937
1938    -  "Item not issued." if you checked in an available item
1939
1940 Once finished you will have a summary of all of your transactions
1941
1942 |image626|