Docs: Updated checkin modifiers
[evergreen-equinox.git] / docs / circulation / circulating_items_web_client.adoc
index a26f2b2..3699b0c 100644 (file)
@@ -39,6 +39,12 @@ image::media/precat_web_client.png[]
 [TIP]
 On check-in, Evergreen will prompt staff to re-route the item to cataloging.
 
+[NOTE]
+This screen does not respond to the enter key or carriage return provided
+by a barcode scanner when the cursor is in the ISBN field.  This behavior
+prevents pre-cataloged items from being checked out before you are done
+entering all the desired information.
+
 Due Dates
 ^^^^^^^^^
 
@@ -49,6 +55,61 @@ Before you scan the item, select the *Specific Due Date* checkbox. Enter the dat
 image::media/specify_due_date1_web_client.png[]
 
 
+Email Checkout Receipts
+^^^^^^^^^^^^^^^^^^^^^^^
+
+This feature allows patrons to receive checkout receipts through email at the circulation desk and in the Evergreen self-checkout interface.  Patrons need to opt in to receive email receipts by default and must have an email address associated with their account.  Opt in can be staff mediated at the time of account creation or in existing accounts.  Patrons can also opt in directly in their OPAC account or through patron self-registration.  This feature does not affect the behavior of checkouts from SIP2 devices.
+
+Staff Client Check Out
+++++++++++++++++++++++
+
+When a patron has opted to receive email checkout receipts by default, an envelope icon representing email will appear next to the receipt options in the Check Out screen.  A printer icon representing a physical receipt appears if the patron has not opted in to the default email receipts.
+
+image::media/ereceipts5_web_client.PNG[]
+
+Staff can click *Quick Receipt* and the default checkout receipt option will be triggered—an email will be sent or the receipt will print out.  The Quick Receipt option allows staff to stay in the patron account after completing the transaction.  Alternatively, staff can click *Done* to trigger the default checkout receipt and close out the patron account.  By clicking on the arrow next to the Quick Receipt or Done buttons, staff can select which receipt option to use, regardless of the selected default.  The email receipt option will be disabled if the patron account does not have an email address.
+
+Self Checkout
++++++++++++++
+
+In the Self Checkout interface, patrons will have the option to select a print or email checkout receipt, or no receipt.  The radio button for the patron's default receipt option will be selected automatically in the interface.  Patrons can select a different receipt option if desired.  The email receipt radio button will be disabled if there is no email address associated with the patron's account.
+
+image::media/ereceipts6_web_client.PNG[]
+
+Opt In
+++++++
+
+*Staff Mediated Opt In At Registration*
+
+Patrons can be opted in to receive email checkout receipts by default by library staff upon the creation of their library account.  Within the patron registration form, there is a new option below the Email Address field to select _Email checkout receipts by default?_.  Select this option if the patron wants email checkout receipts to be their default.  Save any changes.
+
+image::media/ereceipts1_web_client.PNG[]
+
+*Staff Mediated Opt In After Registration*
+
+Staff can also select email checkout receipts as the default option in a patron account after initial registration.  Within the patron account go to *Edit* and select _Email checkout receipts by default?_.  Make sure the patron also has an email address associated with their account.  Save any changes.
+
+image::media/ereceipts2_web_client.PNG[]
+
+*Patron Opt In – Self-Registration Form*
+
+If your library offers patrons the ability to request a library card through the patron self-registration form, they can select email checkout receipts by default in the initial self-registration form:
+
+image::media/ereceipts3_web_client.PNG[]
+
+*Patron Opt In - OPAC Account*
+
+Patrons can also opt in to receive email checkout receipts by default directly in their OPAC account.  After logging in, patrons can go to *Account Preferences->Notification Preferences* and enable _Email checkout receipts by default?_ and click *Save*.
+
+image::media/ereceipts4_web_client.PNG[]
+
+
+Email Checkout Receipt Configuration
+++++++++++++++++++++++++++++++++++++
+
+Email checkout receipts will be sent out through a Notifications/Action Trigger called Email Checkout Receipt.  The email template and action trigger can be customized by going to *Administration->Local Administration->Notifications/Action Trigger->Email Checkout Receipt*.
+
+
 Check In
 ~~~~~~~~
 
@@ -102,7 +163,7 @@ At the right bottom corner there is a *Checkin Modifiers* pop-up list. The optio
 
 -Ignore Pre-cat Items: no prompt when checking in a pre-cat item. Item will be routed to Cataloguing with Cataloguing status.
 
--Supress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status.
+-Suppress Holds and Transit: item will not be used to fill holds or sent in transit. Item has Reshelving status.
 
 -Amnesty Mode/Forgive Fines: overdue fines will be voided if already created or not be inserted if not yet created (e.g. hourly loans).
 
@@ -116,12 +177,15 @@ At the right bottom corner there is a *Checkin Modifiers* pop-up list. The optio
 
 -Capture Local Holds as Transits. With this checkin modifier, any local holds will be given an in transit status instead of on holds shelf. The intent is to stop the system from sending holds notifications before the item is ready to be placed on the holds shelf and item will have a status of in-transit until checked in again. If you wish to simply delay notification and allow time for staff to process item to holds shelf, you may wish to use the Hold Shelf Status Delay setting in Library Settings Editor instead. See Local Administration section for more information.
 
+-Manual Floating Active. Floating Groups must be configured for this modifier to function. The manual flag in Floating Groups dictates whether or not the "Manual Floating Active" checkin modifier needs to be active for a copy to float. This allows for greater control over when items float. 
+
+-Update Inventory. When this checkin modifier is selected, scanned barcodes will have the current date/time added as the inventory date while the item is checked in. 
 
 These options may be selected simultaneously. The selected option is displayed in the header area.
 
-image::media/checkin_options_web_client.png[]
+image::media/checkinmodifiers-with-inventory2.png[Web client check-in modifiers]
 
-====================================================
+===================================================
   
 Renewal and Editing the Item's Due Date
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -195,7 +259,7 @@ Lost Item Billing
 - Marking an item Lost will automatically bill the patron the replacement cost of the item as recorded in the price field in the item record, and a processing fee as determined by your local policy. If the lost item has overdue charges, the overdue charges may be voided or retained based on local policy.
 - A lost-then-returned item will disappear from the Items Out screen only when all bills linked to this particular circulation have been resolved. Bills may include replacement charges, processing fees, and manual charges added to the existing bills. 
 - The replacement fee and processing fee for lost-then-returned items may be voided if set by local policy. Overdue fines may be reinstated on lost-then-returned items if set by local policy.
-==========================
+========================
 
 Refunds for Lost Items
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -237,12 +301,12 @@ In-house Use (F6)
 ~~~~~~~~~~~~~~~~~
 1) To record in-house use, select *Circulation* -> *Record-In House Use*, click *Check Out* -> *Record In-House Use* on the circulation toolbar , or press *F6*. 
  
-image::media/record_in_house_action.png[]
+image::media/record_in_house_action_web_client.png[]
  
 2) To record in-house use for cataloged items, enter number of uses, scan 
  barcode or type barcode and click *Submit*.
  
-image::media/in_house_use.png[]
+image::media/in_house_use_web_client.png[]
  
 [NOTE]
 ====================================
@@ -341,29 +405,32 @@ The *Edit Item Attributes* function on the *Actions for Selected Items* dropdown
 5) Click *Modify Copies*, then confirm the action.
 
 
-Mark an Item Long Overdue
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Long Overdue Items
+~~~~~~~~~~~~~~~~~~
 
-*Marking an item Long Overdue*
+*Items Marked Long Overdue*
 
 Once an item has been overdue for a configurable amount of time, Evergreen will mark the item long overdue in the borrowing patron’s account.  This will be done automatically through a Notification/Action Trigger.   When the item is marked long overdue, several actions will take place:
 
 . The item will go into the status of “Long Overdue” 
 
-. The item will be moved to the “Lost, Claimed Returned, Long Overdue, Has Unpaid Billings” section of the Items Out screen in the patron’s account
-
 . The accrual of overdue fines will be stopped
 
-Optionally the patron can be billed for the item price, a long overdue processing fee, and any overdue fines can be voided from the account.  Patrons can also be sent a notification that the item was marked long overdue.
+Optionally the patron can be billed for the item price, a long overdue
+processing fee, and any overdue fines can be voided from the account.  Patrons
+can also be sent a notification that the item was marked long overdue. And
+long-overdue items can be included on the "Items Checked Out" or "Other/Special
+Circulations" tabs of the "Items Out" view of a patron's record. These are all
+controlled by <<longoverdue_library_settings,library settings>>.
  
-image::media/long_overdue1.jpg[Patron Account-Long Overdue]
+image::media/long_overdue1.png[Patron Account-Long Overdue]
 
 
 *Checking in a Long Overdue item*
 
 If an item that has been marked long overdue is checked in, an alert will appear on the screen informing the staff member that the item was long overdue.  Once checked in, the item will go into the status of “In process”.  Optionally, the item price and long overdue processing fee can be voided and overdue fines can be reinstated on the patron’s account.  If the item is checked in at a library other than its home library, a library setting controls whether the item can immediately fill a hold or circulate, or if it needs to be sent to its home library for processing.
  
-image::media/long_overdue2.jpg[Long Overdue Checkin]
+image::media/long_overdue2.png[Long Overdue Checkin]
  
 *Notification/Action Triggers*
 
@@ -375,11 +442,17 @@ Evergreen has two sample Notification/Action Triggers that are related to markin
 
 ** 6 Month Long Overdue Notice—will send patron notification that an item has been marked long overdue on their account
 
+[[longoverdue_library_settings]]
 *Library Settings* 
 
 The following Library Settings enable you to set preferences related to long overdue items:
 
-* *Circulation: Long-Overdue Check-In Interval Uses Last Activity Date* —Use the long-overdue last-activity date instead of the due_date to determine whether the item has been checked out too long to perform long-overdue check-in processing. If set, the system will first check the last payment time, followed by the last billing time, followed by the due date. See also circ.max_accept_return_of_longoverdue 
+* *Circulation: Long-Overdue Check-In Interval Uses Last Activity Date* —Use the
+  long-overdue last-activity date instead of the due_date to determine whether
+  the item has been checked out too long to perform long-overdue check-in
+  processing. If set, the system will first check the last payment time,
+  followed by the last billing time, followed by the due date. See also the
+  "Long-Overdue Max Return Interval" setting.
 
 * *Circulation: Long-Overdue Items Usable on Checkin* —Long-overdue items are usable on checkin instead of going "home" first
 
@@ -397,11 +470,17 @@ The following Library Settings enable you to set preferences related to long ove
 
 * *Finances: Void Overdue Fines When Items are Marked Long-Overdue*
 
+* *GUI: Items Out Long-Overdue display setting*
+
+[TIP]
+Learn more about these settings in the chapter about the
+Library Settings Editor.
+
 *Permissions to use this Feature*
 
 The following permissions are related to this feature:
 
-* COPY_STATUS_LONGOVERDUE.override
+* COPY_STATUS_LONG_OVERDUE.override
 
 ** Allows the user to check-in long-overdue items thus removing the long-overdue status on the item