Docs 2.9: Remove JSPAC references and screenshots

[Evergreen.git] / docs / circulation / holds.txt

Holds Management
----------------

Placing Holds
~~~~~~~~~~~~~

Holds can be placed by staff in the _Staff Client_ and by patrons in the OPAC. In this chapter we demonstrate placing holds in the _Staff Client_.

Holds Levels
~~~~~~~~~~~~

Evergreen has different levels of holds. Library staff can place holds at all levels, while patrons can only place title-level holds, and parts-level holds. The chart below summarizes the levels of holds.

|==============================
|*Hold level* |*Abbreviation* |*When to use*        |*How to use*   |*Who can use*    |*Hold tied to*
|Title        |T              |Patron wants first available copy of a title  | Staff or patron click on _Place Hold_ next to title. | Patron or staff | Holdings attached to a single MARC (title) record
|Parts        |P              |Patron wants a particular part of title (e.g. volume or disk number)    | Staff or patron selects part on the create/edit hold screen when setting holds notification options.   |Patron or staff  |Holdings with identical parts attached to a single MARC (title) record.
|Volume       |V              |Patron or staff want any title associated with a particular call number | In the staff client, click on _Volume Hold_ under _Holdable?_ |Staff only |Holdings attached to a single call number (volume)
|Copy         |C              |Patron or staff want a specific copy of an item |In the staff client, click on _Copy Hold_ under _Holdable?_ |Staff only |A specific copy (barcode)
|===============================


Title Level Hold
~~~~~~~~~~~~~~~~

[TIP]
====================
A default hold expiration date will be displayed if the library has set up a default holds expiration period in their library settings. Uncaptured holds will not be targeted after the expiration date.

If you select the _Suspend this Hold_ checkbox, the hold will be suspended and not be captured until you activate it.
====================

. To place a title level hold, retrieve the title record on the catalog and click the _Place Hold_ link beside the title on the search results list, or click the _Place Hold_ link on the title summary screen.
+
image::media/holds_title_searchresults.png[Search Results with Place Hold link]
+
. Scan or type patron's barcode into the _Place hold for patron by
barcode_ box, or choose _Place this hold for me_.
. If this title contains multiple parts, you can specify which part to
request. If you do not select a part, the hold will target any of the
other copies on this record, that is, those with no parts attached.
Those copies are usually the complete set, containing all the parts.
. Edit patron hold notification and expiration date fields as required.
Be sure to choose a valid _Pickup location_.
. Click _Submit_.
+
image::media/holds_title_options.png[Place Holds screen with Basic Options]
+
. A confirmation screen appears with the message "Hold was successfully placed".
+
image::media/holds_title_success.png[Place Holds confirmation screen]

*Advanced Hold Options*

Clicking the *Advanced Hold Options* link will take you into the
metarecord level hold feature, where you can select multiple formats
and/or languages, if available.

Selecting multiple formats will not place all of these formats on hold.
For example, selecting CD Audiobook and Book implies that either the CD
format or the book format is the acceptable format to fill the hold. If
no format is selected, then any of the available formats may be used to
fill the hold. The same holds true for selecting multiple languages.

image::media/holds_title_options_adv.png[Place Hold screen with Advanced Options]

See also the section on placing <<_tpac_metarecord_search_and_metarecord_level_holds,
Metarecord Holds>>.

Parts Level Hold
~~~~~~~~~~~~~~~~

. To place a parts level hold, retrieve a record with parts-level items
attached to the title, such as a multi-disc DVD, an annual travel guide,
or a multi-volume book set.
. Place the hold as you would for a title-level hold, including patron
barcode, notification details, and a valid pickup location.
. Select the applicable part from the _Select a Part_ dropdown menu.
. Click _Submit_.
+
image::media/holds_title_options.png[Place Holds screen with Basic Options]
+
[TIP]
===============
Requested formats are listed in the _Holdable Part_ column in hold records. Use the _Column Picker_ to display it when the hold record is displayed.
===============

Placing Holds in Patron Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

. Holds can be placed from patron records too. In the patron record on the _Holds_ screen, click the _Place Hold_ button on the left top corner.

. The catalog is displayed in the _Holds_ screen to search for the title on which you want to place a hold.

. Search for the title and click the _Place Hold_ link.

. The patron’s account information is retrieved automatically. Set up the notification and expiration date fields. Click _Place Hold_ and confirm your action in the pop-up window.

. You may continue to search for more titles. Once you are done, click the _Holds_ button on the top to go back to the _Holds_ screen. Click the _Refresh_ button to display your newly placed holds.


Managing Holds
~~~~~~~~~~~~~~

Holds can be cancelled at any time by staff or patrons. Before holds are captured, staff or patrons can suspend them or set them as inactive for a period of time without losing the hold queue position, activate suspended holds, change
notification method, phone number, pick-up location (for multi-branch libraries only), expiration date, activation date for inactive holds, etc. Once a hold is captured, staff can change the pickup location and extend the hold shelf
time if required.

Staff can edit holds in either patron’s records or the title records. Patrons can edit their holds in their account on the OPAC.

[TIP]
==============
If you use the column picker to change the holds display from one area of the staff client (e.g. the patron record), it will change the display for all parts of the staff client that deal with holds, including the title record holds
display, the holds shelf display, and the pull list display.
==============


Actions for Selected Holds
^^^^^^^^^^^^^^^^^^^^^^^^^^

. Retrieve the patron record and go to the _Holds_ screen.
. Highlight the hold record, then select _Actions for Selected Holds_.
+
image::media/holds-managing-1.png[holds-managing-1]
+
. Manage the hold by choosing an action on the list.
.. If you want to cancel the hold, click _Cancel Hold_ from the menu. You are prompted to select a reason and put in a note if required. To finish, click _Apply_.
+
image::media/holds-managing-2.png[holds-managing-2]
+
[NOTE]
=============
A captured hold with a status of _On Hold Shelf_ can be cancelled by either staff or patrons. But the status of the item will not change until staff check it in.
=============
.. If you want to suspend a hold or activate a suspended hold, click the appropriate action on the list. You will be prompted to confirm your action. Suspended holds have a _No_ value in the _Active?_ column.
+
[NOTE]
===============
Suspended holds will not be filled but its hold position will be kept. They will automatically become active on the activation date if there is an activation date in the record. Without an activation date, the holds will remain inactive until staff or a patron activates them manually.
===============

.. You may edit the _Activation Date_ and _Expiration Date_ by using the corresponding action on the _Action for Selected Holds_ dropdown menu. You will be prompted to enter the new date. Use the calendar widget to choose a date, then click _Apply_. Use the _Remove_ button to unset the date.
+
image::media/holds-managing-4.png[holds-managing-4]
+

.. Hold shelf expire time is automatically recorded in the hold record when a hold is filled. You may edit this time by using the _Edit Shelf Expire Time_ on the _Action for Selected Holds_ dropdown menu. You will be prompted to enter the new date. Use the calendar widget to choose a date, then click _Apply_.

.. If you want to enable or disable phone notification or change the phone number, click _Edit Phone Notification_. You will be prompted to enter the new phone number. Make sure you enter a valid and complete phone number. The phone number is used for this hold only and can be different from the one in the patron account. It has no impact on the patron account. If you leave it blank, no phone number will be printed on the hold slip.
+
image::media/holds-managing-5.png[holds-managing-5]
+

.. If you want to enable or disable email notification for the hold, click _Set Email Notification_. Click _Email_ or _No Email_ on the prompt screen.
+
image::media/holds-managing-6.png[holds-managing-6]
+

.. Pickup location can be changed by clicking _Edit Pickup Library_. Click the dropdown list of all libraries and choose the new pickup location. Click _Done_.
+
image::media/holds-managing-7.png[holds-managing-7]
+
[NOTE]
==============
Staff can change the pickup location for holds with in-transit status. Item will be sent in transit to the new destination. Staff cannot change the pickup location once an item is on the holds shelf.
==============

.. The item’s physical condition is recorded in the copy record as _Good_ or _Mediocre_ in the _Quality_ field. You may request that your holds be filled with copies of good quality only. Click _Set Desired Copy Quality_ on the
_Actions for Selected Holds_ list. Make your choice in the pop-up window.
+
image::media/holds-managing-8.png[holds-managing-8]


Transferring Holds
^^^^^^^^^^^^^^^^^^

. Holds on one title can be transferred to another with the hold request time preserved. To do so, you need to find the destination title and click _Actions for this Record_ -> _Mark as Title Hold Transfer Destination_.
+
image::media/holds-managing-9.png[holds-managing-9]
+
. Select the hold you want to transfer. Click _Actions for Selected Holds_ -> _Transfer to Marked Title_.
+
image::media/holds-managing-10.png[holds-managing-10]

Cancelled Holds
^^^^^^^^^^^^^^^

. Cancelled holds can be displayed. Click the _Show Cancelled Holds_ button on the _Holds_ screen.
+
image::media/holds-managing-11.png[holds-managing-11]
+
. You can un-cancel holds.
+
image::media/holds-managing-12.png[holds-managing-12]
+
Based on your library’s setting, hold request time can be reset when a hold is un-cancelled.


Viewing Details & Adding Notes to Holds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

. You can view details of a hold by selecting a hold then clicking the _Detail View_ button on the _Holds_ screen.
+
image::media/holds-managing-13.png[holds-managing-13]
+
. You may add a note to a hold in the _Detail View_.
+
image::media/holds-managing-14.png[holds-managing-14]
+
. Notes can be printed on the hold slip if the _Print on slip?_ checkbox is selected. Key in the message then click _Add Note_.
+
image::media/holds-managing-15.png[holds-managing-15]


Displaying Queue Position
^^^^^^^^^^^^^^^^^^^^^^^^^

Using the Column Picker, you can display _Queue Position_ and _Total number of Holds_.

image::media/holds-managing-16.png[holds-managing-16]


Managing Holds in Title Records
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

. Retrieve and display the title record in the catalog.
. Click _Actions for this Record_ -> _View Holds_.
+
image::media/holds-managing-17.png[holds-managing-17]
+
. All holds on this title to be picked up at your library are displayed. Use the _Filter_ checkbox and _Pickup Library_ to view holds to be picked up at other libraries.
+
image::media/holds-managing-18.png[holds-managing-18]
+
. Highlight the hold you want to edit. Choose an action from the _Actions for Selected Holds_ menu. For more information see the <<_actions_for_selected_holds,Actions for Selected Holds>> section.
+
image::media/holds-managing-19.png[holds-managing-19]
+
. You can retrieve the hold requestor’s account by selecting _Retrieve Patron_ on the above dropdown menu.


Retargeting Holds
^^^^^^^^^^^^^^^^^

Holds need to be retargeted whenever a new item is added to a record, or after some types of item status changes, for instance when an item is changed from _On Order_ to _In Process_. The system does not automatically recognize the newly added items as available to fill holds.

. View the holds for the item.

. Highlight all the holds for the record, which have a status of _Waiting for Copy_. If there are a lot of holds, it may be helpful to sort the holds by _Status_.

. Click on the head of the status column.

. Under _Actions for Selected Holds_ (Alt+S), select _Find Another Target_ (Alt+T)

. A window will open asking if you are sure you would like to reset the holds for these items.

. Click _Yes_ (Alt+Y). Nothing may appear to happen, or if you are retargeting a lot of holds at once, your screen may go blank or seem to freeze for a moment while the holds are retargeted.

. When the screen refreshes, the holds will be retargeted. The system will now recognize the new items as available for holds.


Pulling & Capturing Holds
^^^^^^^^^^^^^^^^^^^^^^^^^

Holds Pull List
+++++++++++++++

There are usually four statuses a hold may have: _Waiting for Copy_, _Waiting for Capture_, _In Transit_ and _Ready for Pickup_.

. *Waiting-for-copy*: all holdable copies are checked out or not available.

. *Waiting-for-capture*: an available copy is assigned to the hold. The item shows up on the _Holds Pull List_ waiting for staff to search the shelf and capture the hold.

. *In Transit*: holds are captured at a non-pickup branch and on the way to the pick-up location.

. *Ready-for-pick-up*: holds are captured and items are on the _Hold Shelf_ waiting for patrons to pick up. Besides capturing holds when checking in items, Evergreen matches holds with available items in your library at regular
intervals. Once a matching copy is found, the item’s barcode number is assigned to the hold and the item is put on the _Holds Pull List_. Staff can print the _Holds Pull List_ and search for the items on shelves.

. To retrieve your _Holds Pull List_, select _Circulation_ -> _Pull List for Hold Requests_.
+
image::media/holds-pull-1.png[holds-pull-1]
+
. The _Holds Pull List_ is displayed. You may re-sort it by clicking the column labels, e.g. _Title_. You can also add fields to the display by using the column picker.
+
image::media/holds-pull-2.png[holds-pull-2]
+
[NOTE]
===========
Column adjustments will only affect the screen display and the CSV download for the holds pull list. It will not affect the printable holds pull list.
===========

. The maximum number of holds initially displayed on the pull list is about 100. Use _Fetch More Holds_ to retrieve more records. You may have to click _Reload_ for those records to appear in the display.
+
image::media/holds-pull-3.png[holds-pull-3]
+
. The following options are available for printing the pull list:

* _Print Full Pull List_ prints _Title_, _Author_, _Shelving Location_, _Call Number_ and _Item Barcode_. This method uses less paper than the alternate strategy.

* _Print Full Pull List (Alternate Strategy)_ prints the same fields as the above option but also includes a patron barcode. This list will also first sort by copy location, as ordered under _Admin_ -> _Local Administration_ -> _Copy Location Order_.

* _Save List CSV to File_ – This option is available from the _List Actions_ button and saves all fields in the screen display to a CSV file. This file can then be opened in Excel or another spreadsheet program. This option provides more flexibility in identifying fields that should be printed.
+
image::media/holds-pull-4.png[holds-pull-4]
+
With the CSV option, if you are including barcodes in the holds pull list, you will need to take the following steps to make the barcode display properly: in Excel, select the entire barcode column, right-click and select _Format Cells_, click _Number_ as the category and then reduce the number of decimal places to 0.

. You may perform hold management tasks by using the _Actions for Selected Holds_ dropdown list.

The _Holds Pull List_ is updated constantly. Once an item on the list is no longer available or a hold on the list is captured, the items will disappear from the list. The _Holds Pull List_ should be printed at least once a day.

Capturing Holds
+++++++++++++++

Holds can be captured when a checked-out item is returned (checked in) or an item on the _Holds Pull List_ is retrieved and captured. When a hold is captured, the hold slip will be printed and if the patron has chosen to be notified by email, the email notification will be sent out. The item should be put on the hold shelf.

. To capture a hold, select _Circulation_ -> _Capture Holds_; click _Check In_ -> _Capture Holds_ on the circulation toolbar; or hit _Shift-F2_.
+
image::media/holds-pull-5.png[holds-pull-5]
+
image::media/holds-pull-5a.png[holds-pull-5a]
+
. Scan or type barcode and click _Submit_.
+
image::media/holds-pull-6.png[holds-pull-6]
+
. The following hold slip is automatically printed. (This slip will not display on the _Capture Holds_ screen, but will display on a _Check In_ screen not set to automatically print slips.)
+
image::media/holds-pull-7.png[holds-pull-7]
+
. If the item should be sent to another location, a hold transit slip will be printed. (This slip will not display on the _Capture Holds_ screen, but may display on a _Check In_ screen that is not set to automatically print slips.)
+
image::media/holds-pull-8.png[holds-pull-8]
+
[TIP]
===============
If a patron has an _OPAC/Staff Client Holds Alias_ in his/her account, it will be used on the hold slip instead of the patron’s name. Holds can also be captured on the _Circulation_ -> _Check In Items_ screen where you have more control over automatic slip printing.
===============


Handling Missing and Damaged Item
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If an item on the holds pull list is missing or damaged, you can change its status directly from the holds pull list.

. From the _Holds Pull List_, right-click on the item and either select _Mark Item Missing_ or _Mark Item Damaged_.
+
image::media/holds-pull-9.png[holds-pull-9]
+
. Evergreen will update the status of the item and will immediately retarget the hold.


Holds Notification Methods
^^^^^^^^^^^^^^^^^^^^^^^^^^

. In Evergreen, patrons can set up their default holds notification method in the _Account Preferences_ area of _My Account_. Staff cannot set these preferences for patrons; the patrons must do it when they are logged into the public catalog.
+
image::media/holds-notifications-1.png[holds-notifications-1]
+
The ``Default Phone Number'' option is the default for those users who have not yet set a preference.

. Patrons with a default notification preference for phone will see their phone number at the time they place a hold. The checkboxes for email and phone notification will also automatically be checked.
+
image::media/holds-notifications-2.png[holds-notifications-2]
+
. The patron can remove these checkmarks at the time they place the hold or they can enter a different phone number if they prefer to be contacted at a different number. The patron cannot change their e-mail address at this time.
+
image::media/holds-notifications-3.png[holds-notifications-3]
+

. When the hold becomes available, the holds slip will display the patron’s e-mail address only if the patron selected the _Notify by Email by default when a hold is ready for pickup?_ checkbox. It will display a phone number only if the patron selected the _Notify by Phone by default when a hold is ready for pickup?_ checkbox.

[NOTE]
If the patron changes their contact telephone number when placing the hold, this phone number will display on the holds slip. It will not necessarily be the same phone number contained in the patron’s record.


Clearing Shelf-Expired Holds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

. Items with _Ready-for-Pickup_ status are on the _Holds Shelf List_. The _Holds Shelf List_ can help you manage items on the holds shelf. To see the holds shelf list, select _Circulation_ -> _Browse Holds Shelf_.
+
image::media/holds-clearing-1.png[holds-clearing-1]
+
. The _Holds Shelf List_ is displayed. Note the _Actions for Selected Holds_ are available, as in the patron record.
+
You can cancel stale holds here.
+
image::media/holds-clearing-2.png[holds-clearing-2]
+
. Use the column picker to add and remove fields from this display. Two fields you may want to display are _Shelf Expire Time_ and _Shelf Time_.
+
image::media/holds-clearing-3.png[holds-clearing-3]
+
. Check the _View Clearable Holds_ checkbox to list expired holds, wrong-shelf holds and canceled holds only. Expired holds are holds that expired before today's date.

. Click the _Print_ button if you need a printed list. To format the printout customize the *Holds_shelf* receipt template. This can be done in _Admin_ -> _Workstation Administration_ -> _Receipt Template Editor_.

. The _Clear These Holds_ button is lit up. Click it and the expired holds will be canceled.
+
image::media/holds-clearing-4.png[holds-clearing-4]
+
. Bring items down from the hold shelf and check them in.

[IMPORTANT]
=============
If you cancel a ready-for-pickup hold, you must check in the item to make it available for circulation or trigger the next hold in line.
=============

Hold shelf expire time is inserted when a hold achieves on-hold-shelf status. It is calculated based on the interval entered in _Local Admin_ -> _Library Settings_ -> _Default hold shelf expire interval_.

[NOTE]
===========
The clear-hold-shelf function cancels shelf-expired holds only. It does not include holds canceled by patron. Staff needs to trace these items manually according to the hold slip date.
===========


Alternate Hold Pick up Location
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Abstract*

This feature enables libraries to configure an alternate hold pick up location.  The alternate pick up location will appear in the staff client to inform library staff that a patron has a hold waiting at that location.  In the stock Evergreen code, the default alternate location is called "Behind Desk".  This label can be changed to accommodate a library's specific hold pick up location.  For example, if a library has a drive thru window for hold pick up, the alternate location can be changed to display as "Drive Thru".  

*Configuration*

The alternate pick up location is disabled in Evergreen by default.  It can be enabled by setting *Holds: Behind Desk Pickup Supported* to 'True' in the Library Settings Editor.  Server side changes to configuration files are required to enable this feature and edit the alternate pick up location label.  The following files and labels need to be changed:

* Open-ILS/src/templates/opac/myopac/prefs_settings.tt2
+
`<td><label for='[% setting %]'>[% l('Pickup holds from the drive-thru when possible?') %]</label></td>`

*  Open-ILS/web/opac/locale/en-US/lang.dtd
+
`<!ENTITY staff.patron_display.holds_available_behind_desk.label 'Drive-Thru:'>`

* Open-ILS/xul/staff_client/server/locale/en-US/circ.properties
+
`staff.circ.utils.hold.behind_desk=Drive-Thru`

* Open-ILS/xul/staff_client/server/locale/en-US/patron.properties
+
`staff.patron.summary.hold_counts_behind_desk=Available / Total (Drive-Thru)`

Libraries can also choose to give patrons the ability to opt-in to pick up holds at the alternate location through their OPAC account.  To add this option, set the *OPAC/Patron Visible* field in the User Setting Type *Hold is behind Circ Desk* to 'True'.  The User Setting Types can be found under *Admin -> Server Administration -> User Setting Types*.

*Display*

When enabled, the alternate pick up location will appear in several places in the staff client.  The alternate pick up location and the number of items that are ready for pick up at that location will be displayed in the Patron Account Summary and under the Holds button in the patron account.  Staff will also see the general number of holds available and holds placed by the patron.

image::media/custom_hold_pickup_location1.jpg[Custom Hold Pickup Location]


If configured, patrons will see the option to opt-in to the alternate location in the _Account Preferences_ section of their OPAC Account.

image::media/custom_hold_pickup_location2.jpg[OPAC Account]


Display Hold Types on Pull Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This feature ensures that the hold type can be displayed on all hold interfaces.

You will find the following changes to the hold type indicator:

. The hold type indicator will display by default on all XUL-based hold
interfaces. XUL-based hold interfaces are those that number the items on the
interface.  This can be overridden by saving column configurations that remove
the _Type_ column.
. The hold type indicator will display by default on the HTML-based pull list.
To access, click _Circulation_ -> _Pull List for Hold Requests_ -> _Print Full
Pull List (Alternate Strategy)_.
. The hold type indicator can be added to the Simplified Pull List.  To access,
click _Circulation_ -> _Pull List for Hold Requests_ -> _Simplified Pull List
Interface_.

To add the hold type indicator to the simplified pull list, click _Simplified
Pull List Interface_, and right click on any of the column headers.  The Column
Picker appears in a pop up window.  Click the box adjacent to _Hold Type_, and
Click _Save_. The _Simplified Pull List Interface_ will now include the hold
type each time that you log into the staff client.

image::media/Display_Hold_Types_on_Pull_Lists1.jpg[Display_Hold_Types_on_Pull_Lists1]