Docs reorg: adding a circulation manual
[working/Evergreen.git] / docs / circulation / advanced_holds.adoc
1 Parts Level Hold
2 ~~~~~~~~~~~~~~~~
3
4 . To place a parts level hold, retrieve a record with parts-level items
5 attached to the title, such as a multi-disc DVD, an annual travel guide,
6 or a multi-volume book set.
7 . Place the hold as you would for a title-level hold, including patron
8 barcode, notification details, and a valid pickup location.
9 . Select the applicable part from the _Select a Part_ dropdown menu.
10 . Click _Submit_.
11 +
12 image::media/holds_title_options.png[Place Holds screen with Basic Options]
13 +
14 [TIP]
15 ===============
16 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.
17 ===============
18
19 Placing Holds in Patron Records
20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21
22 . 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.
23
24 . The catalog is displayed in the _Holds_ screen to search for the title on which you want to place a hold.
25
26 . Search for the title and click the _Place Hold_ link.
27
28 . 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.
29
30 . 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.
31
32 Placing Multiple Holds on Same Title
33 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
34
35 After a successful hold placement, staff have the option to place another hold on the same title by clicking the link _Place another hold for this title_.  This returns to the hold screen, where a different patron's information can be entered.
36
37 image::media/place-another-hold-1.png[place-another-hold-1]
38
39 This feature can be useful for book groups or new items where a list of waiting patrons needs to be transferred into the system.
40
41
42 Managing Holds
43 ~~~~~~~~~~~~~~
44
45 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
46 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
47 time if required.
48
49 Staff can edit holds in either patron’s records or the title records. Patrons can edit their holds in their account on the OPAC.
50
51 [TIP]
52 ==============
53 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
54 display, the holds shelf display, and the pull list display.
55 ==============
56
57
58 Actions for Selected Holds
59 ^^^^^^^^^^^^^^^^^^^^^^^^^^
60
61 . Retrieve the patron record and go to the _Holds_ screen.
62 . Highlight the hold record, then select _Actions for Selected Holds_.
63 +
64 image::media/holds-managing-1.png[holds-managing-1]
65 +
66 . Manage the hold by choosing an action on the list.
67 .. 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_.
68 +
69 image::media/holds-managing-2.png[holds-managing-2]
70 +
71 [NOTE]
72 =============
73 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.
74 =============
75 .. 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.
76 +
77 [NOTE]
78 ===============
79 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.
80 ===============
81
82 .. 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.
83 +
84 image::media/holds-managing-4.png[holds-managing-4]
85 +
86
87 .. 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_.
88
89 .. 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.
90 +
91 image::media/holds-managing-5.png[holds-managing-5]
92 +
93
94 .. 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.
95 +
96 image::media/holds-managing-6.png[holds-managing-6]
97 +
98
99 .. 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_.
100 +
101 image::media/holds-managing-7.png[holds-managing-7]
102 +
103 [NOTE]
104 ==============
105 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.
106 ==============
107
108 .. 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
109 _Actions for Selected Holds_ list. Make your choice in the pop-up window.
110 +
111 image::media/holds-managing-8.png[holds-managing-8]
112
113
114 Transferring Holds
115 ^^^^^^^^^^^^^^^^^^
116
117 . 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_.
118 +
119 image::media/holds-managing-9.png[holds-managing-9]
120 +
121 . Select the hold you want to transfer. Click _Actions for Selected Holds_ -> _Transfer to Marked Title_.
122 +
123 image::media/holds-managing-10.png[holds-managing-10]
124
125 Cancelled Holds
126 ^^^^^^^^^^^^^^^
127
128 . Cancelled holds can be displayed. Click the _Show Cancelled Holds_ button on the _Holds_ screen.
129 +
130 image::media/holds-managing-11.png[holds-managing-11]
131 +
132 . You can un-cancel holds.
133 +
134 image::media/holds-managing-12.png[holds-managing-12]
135 +
136 Based on your library’s setting, hold request time can be reset when a hold is un-cancelled.
137
138
139 Viewing Details & Adding Notes to Holds
140 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141
142 . You can view details of a hold by selecting a hold then clicking the _Detail View_ button on the _Holds_ screen.
143 +
144 image::media/holds-managing-13.png[holds-managing-13]
145 +
146 . You may add a note to a hold in the _Detail View_.
147 +
148 image::media/holds-managing-14.png[holds-managing-14]
149 +
150 . Notes can be printed on the hold slip if the _Print on slip?_ checkbox is selected. Key in the message then click _Add Note_.
151 +
152 image::media/holds-managing-15.png[holds-managing-15]
153
154
155 Displaying Queue Position
156 ^^^^^^^^^^^^^^^^^^^^^^^^^
157
158 Using the Column Picker, you can display _Queue Position_ and _Total number of Holds_.
159
160 image::media/holds-managing-16.png[holds-managing-16]
161
162
163 Managing Holds in Title Records
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
165
166 . Retrieve and display the title record in the catalog.
167 . Click _Actions for this Record_ -> _View Holds_.
168 +
169 image::media/holds-managing-17.png[holds-managing-17]
170 +
171 . 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.
172 +
173 image::media/holds-managing-18.png[holds-managing-18]
174 +
175 . 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.
176 +
177 image::media/holds-managing-19.png[holds-managing-19]
178 +
179 . You can retrieve the hold requestor’s account by selecting _Retrieve Patron_ on the above dropdown menu.
180
181
182 Retargeting Holds
183 ^^^^^^^^^^^^^^^^^
184
185 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.
186
187 . View the holds for the item.
188
189 . 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_.
190
191 . Click on the head of the status column.
192
193 . Under _Actions for Selected Holds_ (Alt+S), select _Find Another Target_ (Alt+T)
194
195 . A window will open asking if you are sure you would like to reset the holds for these items.
196
197 . 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.
198
199 . When the screen refreshes, the holds will be retargeted. The system will now recognize the new items as available for holds.
200
201
202 Pulling & Capturing Holds
203 ^^^^^^^^^^^^^^^^^^^^^^^^^
204
205 Holds Pull List
206 +++++++++++++++
207
208 There are usually four statuses a hold may have: _Waiting for Copy_, _Waiting for Capture_, _In Transit_ and _Ready for Pickup_.
209
210 . *Waiting-for-copy*: all holdable copies are checked out or not available.
211
212 . *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.
213
214 . *In Transit*: holds are captured at a non-pickup branch and on the way to the pick-up location.
215
216 . *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
217 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.
218
219 . To retrieve your _Holds Pull List_, select _Circulation_ -> _Pull List for Hold Requests_.
220 +
221 image::media/holds-pull-1.png[holds-pull-1]
222 +
223 . 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.
224 +
225 image::media/holds-pull-2.png[holds-pull-2]
226 +
227 [NOTE]
228 ===========
229 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.
230 ===========
231
232 . 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.
233 +
234 image::media/holds-pull-3.png[holds-pull-3]
235 +
236 . The following options are available for printing the pull list:
237
238 * _Print Full Pull List_ prints _Title_, _Author_, _Shelving Location_, _Call Number_ and _Item Barcode_. This method uses less paper than the alternate strategy.
239
240 * _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_.
241
242 * _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.
243 +
244 image::media/holds-pull-4.png[holds-pull-4]
245 +
246 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.
247
248 . You may perform hold management tasks by using the _Actions for Selected Holds_ dropdown list.
249
250 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.
251
252 Capturing Holds
253 +++++++++++++++
254
255 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.
256
257 . To capture a hold, select _Circulation_ -> _Capture Holds_; click _Check In_ -> _Capture Holds_ on the circulation toolbar; or hit _Shift-F2_.
258 +
259 image::media/holds-pull-5.png[holds-pull-5]
260 +
261 image::media/holds-pull-5a.png[holds-pull-5a]
262 +
263 . Scan or type barcode and click _Submit_.
264 +
265 image::media/holds-pull-6.png[holds-pull-6]
266 +
267 . 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.)
268 +
269 image::media/holds-pull-7.png[holds-pull-7]
270 +
271 . 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.)
272 +
273 image::media/holds-pull-8.png[holds-pull-8]
274 +
275 [TIP]
276 ===============
277 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.
278 ===============
279
280
281 Handling Missing and Damaged Item
282 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
283
284 If an item on the holds pull list is missing or damaged, you can change its status directly from the holds pull list.
285
286 . From the _Holds Pull List_, right-click on the item and either select _Mark Item Missing_ or _Mark Item Damaged_.
287 +
288 image::media/holds-pull-9.png[holds-pull-9]
289 +
290 . Evergreen will update the status of the item and will immediately retarget the hold.
291
292
293 Holds Notification Methods
294 ^^^^^^^^^^^^^^^^^^^^^^^^^^
295
296 . 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.
297 +
298 image::media/holds-notifications-1.png[holds-notifications-1]
299 +
300 The ``Default Phone Number'' option is the default for those users who have not yet set a preference.
301
302 . 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.
303 +
304 image::media/holds-notifications-2.png[holds-notifications-2]
305 +
306 . 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.
307 +
308 image::media/holds-notifications-3.png[holds-notifications-3]
309 +
310
311 . 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.
312
313 [NOTE]
314 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.
315
316
317 Clearing Shelf-Expired Holds
318 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
319
320 . 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_.
321 +
322 image::media/holds-clearing-1.png[holds-clearing-1]
323 +
324 . The _Holds Shelf List_ is displayed. Note the _Actions for Selected Holds_ are available, as in the patron record.
325 +
326 You can cancel stale holds here.
327 +
328 image::media/holds-clearing-2.png[holds-clearing-2]
329 +
330 . 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_.
331 +
332 image::media/holds-clearing-3.png[holds-clearing-3]
333 +
334 . 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.
335
336 . 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_.
337
338 . The _Clear These Holds_ button is lit up. Click it and the expired holds will be canceled.
339 +
340 image::media/holds-clearing-4.png[holds-clearing-4]
341 +
342 . Bring items down from the hold shelf and check them in.
343
344 [IMPORTANT]
345 =============
346 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.
347 =============
348
349 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_.
350
351 [NOTE]
352 ===========
353 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.
354 ===========
355
356
357 Alternate Hold Pick up Location
358 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
359
360 *Abstract*
361
362 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".  
363
364 *Configuration*
365
366 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:
367
368 * Open-ILS/src/templates/opac/myopac/prefs_settings.tt2
369 +
370 `<td><label for='[% setting %]'>[% l('Pickup holds from the drive-thru when possible?') %]</label></td>`
371
372 *  Open-ILS/web/opac/locale/en-US/lang.dtd
373 +
374 `<!ENTITY staff.patron_display.holds_available_behind_desk.label 'Drive-Thru:'>`
375
376 * Open-ILS/xul/staff_client/server/locale/en-US/circ.properties
377 +
378 `staff.circ.utils.hold.behind_desk=Drive-Thru`
379
380 * Open-ILS/xul/staff_client/server/locale/en-US/patron.properties
381 +
382 `staff.patron.summary.hold_counts_behind_desk=Available / Total (Drive-Thru)`
383
384 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*.
385
386 *Display*
387
388 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.
389
390 image::media/custom_hold_pickup_location1.jpg[Custom Hold Pickup Location]
391
392
393 If configured, patrons will see the option to opt-in to the alternate location in the _Account Preferences_ section of their OPAC Account.
394
395 image::media/custom_hold_pickup_location2.jpg[OPAC Account]
396
397
398 Display Hold Types on Pull Lists
399 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
400
401 This feature ensures that the hold type can be displayed on all hold interfaces.
402
403 You will find the following changes to the hold type indicator:
404
405 . The hold type indicator will display by default on all XUL-based hold
406 interfaces. XUL-based hold interfaces are those that number the items on the
407 interface.  This can be overridden by saving column configurations that remove
408 the _Type_ column.
409 . The hold type indicator will display by default on the HTML-based pull list.
410 To access, click _Circulation_ -> _Pull List for Hold Requests_ -> _Print Full
411 Pull List (Alternate Strategy)_.
412 . The hold type indicator can be added to the Simplified Pull List.  To access,
413 click _Circulation_ -> _Pull List for Hold Requests_ -> _Simplified Pull List
414 Interface_.
415
416 To add the hold type indicator to the simplified pull list, click _Simplified
417 Pull List Interface_, and right click on any of the column headers.  The Column
418 Picker appears in a pop up window.  Click the box adjacent to _Hold Type_, and
419 Click _Save_. The _Simplified Pull List Interface_ will now include the hold
420 type each time that you log into the staff client.
421
422 image::media/Display_Hold_Types_on_Pull_Lists1.jpg[Display_Hold_Types_on_Pull_Lists1]