Change all docs filenames to .adoc
[working/Evergreen.git] / docs / RELEASE_NOTES_2_5.adoc
1 Evergreen 2.5 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Upgrade Notes
7 -------------
8
9 Circulation
10 ~~~~~~~~~~~
11
12 Long Overdue Circulations Management
13 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14 If you are using a custom version of the 
15 '/openils/conf/action_trigger_filters.json.example' file, you will need to 
16 merge the changes made by this feature into your file.  The change in 
17 question alters the 'checkout.due' hook such that LONGOVERDUE circulations 
18 are no longer treated as regular overdue items.
19
20 OPAC
21 ~~~~
22
23 Web-Based Patron Self-Registration
24 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25   * If a value is set for the _Patron Self-Reg Expire Interval_
26     (opac.pending_user_expire_interval) for any org units, the new
27     /openils/bin/purge_pending_users.srfsh script should also be added to the
28     opensrf user's crontab.  Running the script once per day should suffice.
29
30
31 Miscellaneous
32 ~~~~~~~~~~~~~
33
34 Log Redaction Config Change
35 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
36 The previous log protect redaction instructions missed a method used
37 by the patron initiated password reset system.  In order to fill this
38 gap, you need to find the <log_protect> portion of your
39 opensrf_core.xml file and add the following line:
40
41       <match_string>open-ils.actor.patron.password_reset.commit</match_string>
42
43 You should see a number of similar lines already there in between
44 <log_protect> and </log_protect>.
45
46 Server Add-ons
47 ^^^^^^^^^^^^^^
48 This adds a "Server Add-ons" menu entry under Admin -> Workstation
49 Administration in the staff client.  Choosing this allows you to edit or set a
50 list of identifiers that correspond to JSAN-style modules found in
51 /server/addons/, and is meant mainly for activating 3rd party modules within the
52 staff client on a per-workstation basis.  You need the
53 ADMIN_SERVER_ADDON_FOR_WORKSTATION permission to use it.
54
55 Configuration options for activated add-ons may also show up in this interface.
56
57
58
59
60 New Features
61 ------------
62
63
64 Acquisitions
65 ~~~~~~~~~~~~
66
67
68
69 Support PO activation without requiring items
70 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
71
72 A new _Activate PO Without Loading Items_ option in the PO allows staff to
73 activate the PO without loading copies into the catalog.
74
75
76
77
78 Differentiate between cancelled and "delayed" lineitems
79 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
80 In the ACQ user interface, it is now more clear to users when a lineitem has
81 been fully cancelled or if it has been cancelled temporarily (e.g.
82 back-ordered).  
83
84 When a lineitem is cancelled, but "keep_debits" is true on the cancel reason,
85 the lineitem is in effect delayed instead of truly cancelled.  This is now
86 more obvious in the interface with different row styling for cancelled vs
87 delayed lineitems.  We also always show the lineitem cancel reason (label) 
88 next to the non-title attributes in the lineitem list display.
89
90
91
92
93 Opportunistic Acquisitions In-Process Copy Overlay
94 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95
96 Improves existing acquisitions copy overlay code (which matches and overlays
97 using specified IDs) by adding broader matching criteria. By selecting the new
98 option, _Auto Overlay In-process Acquisitions Copies_, the system will
99 potentially overlay copies which:
100
101 * have associated lineitem details (that is, they were created by the 
102 acquisitions process),
103 * that lineitem detail has the same owning_lib as the incoming copy's
104 owning_lib, and
105 * the current copy associated with that lineitem detail is _In process_.
106
107
108
109
110
111
112 Printing PO Names on Purchase Orders
113 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
114
115 The _Print Purchase Order_ option now prints the PO Name in addition to the PO
116 ID.
117
118
119
120
121 Administration
122 ~~~~~~~~~~~~~~
123
124
125
126 Default filter option for configuration screens
127 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
128
129 By default, most admin configuration screens in the staff client will now
130 include filters allowing staff to display just those items matching a certain
131 criteria.
132
133
134
135
136 Upgrade Notes : IDL2js Locale Support
137 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138
139 The following Apache configuration changes are required to support the 
140 locale-aware IDL2js module.  
141
142 // note: there's no Apache conf highlighting.  'bash' works well enough.
143 [source, bash]
144 -----------------------------------------------------------------
145 # file: eg_vhost.conf
146
147 # this is the new part
148 # capture locale CGI param for /reports/fm_IDL.xml
149 RewriteCond %{REQUEST_URI} ^/reports/fm_IDL.xml
150 RewriteCond %{QUERY_STRING} locale=([^&;]*)
151 RewriteRule . - [E=locale:%1]
152
153 # it should be placed just above this existing config section
154 <LocationMatch /reports/fm_IDL.xml>
155     IDLChunkStripPI "yes"
156     IDLChunkEscapeScript "no"
157     IDLChunkStripComments "yes"
158     IDLChunkStripDoctype "yes"
159     IDLChunkContentType "application/xml; charset=utf-8"
160     AddOutputFilter INCLUDES;IDLCHUNK .xml
161 </LocationMatch>
162 -----------------------------------------------------------------
163
164 Inter-authority linking script
165 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166
167 Adds a script called authority_authority_linker.pl in support-scripts that,
168 when run, will link authority reference headings to authority records that 
169 contain the same main entry using a subfield 0. This causes triggers to fill
170 up the authority-authority linking table and allows more information to appear
171 in the bib/authority browse when a displayed heading comes from an authority
172 record that has linked _See Also_ references.
173
174
175
176
177 New Updates Tools
178 ^^^^^^^^^^^^^^^^^
179
180 Source code for tools to generate the staff clients updates tools were
181 added to Open-ILS/xul/staff_client/external/libmar.  These tools
182 replace the downloadable tools from Mozilla.org that were previously
183 used to generate the staff client updates files.
184
185 They come with their own configuration script and are configured
186 automatically as a subpackage when you configure Evergreen for
187 installation.  They are also built and ready for use when you make
188 Evergreen during the installation or upgrade process.
189
190 The make_updates.sh script that is run when you tell Evergreen to make
191 the staff client updates has been modified to use the new tools.
192
193 These tools introduce a dependency on libbz2.  This is often only
194 available when installing the libbz2-dev or libbz2-devel packages.
195 Thus this branch introduces a new dependency on the development packages
196 for libbz2 in Evergreen.
197
198 Nothing in the user facing behavior of building updates changes with
199 these tools.  They are drop-in replacements for the previous tools and
200 other than the new dependency on libbz2, you don't even need to know
201 that they are there.
202
203 These tools were added to Evergreen to be an aid in portability to
204 operating systems other than Linux.  They also remove a dependency on
205 a third-party tool, that is typically downloaded as a binary.
206
207
208
209 Phonelist.pm Module
210 ^^^^^^^^^^^^^^^^^^^
211
212 PhoneList.pm is a mod_perl module for Apache that works with Evergreen
213 to generate callings lists for patron holds. It outputs a csv file
214 that can be fed into an auto-dialer script to call patrons with little
215 or no staff intervention.  It is accessed and configured via a special
216 URL and passing any parameters as a ``Query String'' on the URL.  The
217 parameters are listed in the table below.
218
219 .Parameters for the phonelist program:
220 |=====================================
221 | user |  Your Evergreen login. Typically your library's circ account. If you leave this off, you will be prompted to login.
222 | passwd | The password for your Evergreen login. If you leave this off you will be prompted to login.
223 | ws_ou | The ID of the system or branch you want to generate the list for (optional). If your account does not have the appropriate permissions for the location whose ID number you have entered, you will get an error.
224 | skipemail | If present, skip patrons with email notification (optional).
225 | addcount | Add a count of items on hold (optional). Only makes sense for holds.
226 | overdue | Makes a list of patrons with overdues instead of holds. If an additional, numeric parameter is supplied, it will be used as the number of days overdue. If no such extra parameter is supplied, then the default of 14 days is used.
227 |=====================================
228
229 The URL is
230
231 `https://your.evergreen-server.tld/phonelist`
232
233 A couple of examples follow:
234
235 `https://your.evergreen-server.tld/phonelist?user=circuser&passwd=password&skipemail`
236
237 The above example would sign in as user circuser with password of
238 ``password'' and get a list of patrons with holds to call who do not
239 have email notification turned on. It would run at whatever branch is
240 normally associated with circuser.
241
242 `https://your.evergreen-server.tld/phonelist?skipemail`
243
244 The above example would do more or less the same, but you would be
245 prompted by your browser for the user name and password.
246
247 If your browser or download script support it, you may also use
248 conventional HTTP authentication parameters.
249
250 `https://user:password@your.evergreen-server.tld/phonelist?overdue&ws_ou=2`
251
252 The above logs in as ``user'' with ``password'' and runs overdues for location ID 2.
253
254
255
256
257 "Purge Holds"
258 ^^^^^^^^^^^^^
259 Similar to purging circulations one may wish to purge old (filled or canceled) hold information. This feature adds a database function and settings for doing so.
260
261 Purged holds are moved to the action.aged_hold_request table with patron identifying information scrubbed, much like circulations are moved to action.aged_circulation.
262
263 The settings allow for a default retention age as well as distinct retention 
264 ages for holds filled, holds canceled, and holds canceled by specific cancel
265 causes. The most specific one wins unless a patron is retaining their hold history. In the latter case the patron's holds are retained either way.
266
267 Note that the function still needs to be called, which could be set up as a cron job or done more manually, say after statistics collection. A new script, purge_holds.srfsh, is added that can be used to purge holds from cron.
268
269
270
271
272 Action Trigger Event Repeatability
273 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
274
275 Action Trigger Event Definitions have a new field, "Event Repeatability
276 Delay". This feature allows events to be repeated after the designated
277 delay interval. An example of this is sending a notification email when a
278 patron's library card expires. If the library extends the expiration date
279 on that card, we then need a way to send another notification email when
280 that same card expires again. Before, the Action Trigger processor only
281 created a new event if the event definition for that target had never
282 been run before. But now it allows repeating of the event after the delay
283 interval, if present.
284
285
286
287
288 Cataloging
289 ~~~~~~~~~~
290
291
292 Vandelay Item Import Defaults
293 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
294
295 Via the Library Settings Editor (Org Unit Settings), support auto-generation of
296 call numbers and barcodes for items imported via the staff client's MARC Batch
297 Import interface (a.k.a. Vandelay).  Support settings for applying a local
298 prefix string to auto-generated call numbers and barcodes.  For both, the
299 prefix defaults to "VAN".
300
301 Similarly, support default copy location and circ modifiers.
302
303 New Library Settings
304 +++++++++++++++++++++
305
306  * Vandelay Generate Default Barcodes (vandelay.item.barcode.auto)
307  * Vandelay Default Barcode Prefix (vandelay.item.barcode.prefix)
308  * Vandelay General Default Call Numbers (vandelay.item.call_number.auto)
309  * Vandelay Default Call Number Prefix (vandelay.item.call_number.prefix)
310  * Vandelay Default Copy Location (vandelay.item.copy_location.default)
311  * Vandelay Default Circulation Modifier (vandelay.item.circ_modifier.default)
312
313 Z39.50 Batch Search and Queue
314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
315
316 Staff Work Flow
317 +++++++++++++++
318
319  * Staff add records to bib record buckets
320  * Staff select the new "Locate Z39.50 Matches" action for a selected bucket.
321  * Staff choose which Z39.50 sources and indexes to search and the destination 
322    queue.
323  * Submitting the search fires a series of parallel Z39.50 searches across
324    all selected Z39.50 sources.
325  * Matches are added to the selected (Vandelay) queue.
326  * Matched records may be manually or automatically overlaid to existing 
327    catalog records using the existing Vandelay import/merge/overlay features.
328
329 Vandelay Limit to Bucket
330 ++++++++++++++++++++++++
331
332 As a side effect of this feature, Vandelay now has a new option in the 
333 interface which allows staff to limit which catalog records to which an 
334 inbound record matches to bib records within a record bucket.  When a record
335 bucket and match set are chosen, only the records in the bucket can act as
336 merge/overlay targets for the inbound Vandelay records.
337
338 Server Admin Settings
339 +++++++++++++++++++++
340
341 _Z39.50 Index Field Maps_ can be used to map bib record
342 indexes (Metabib Fields and Record Attributes) to Z39.50
343 search attributes.  The purpose of the mapping is to allow the server to
344 determine which values to use for the automated Z39.50 searches.  For example,
345 if the Z39.50 "title" attribute is mapped to the "Uniform Title" Metabib Field,
346 the extracted value for "Uniform Title" for each record in the bucket will be
347 used as the "title" value in the Z39.50 search.
348
349 Mappings can be applied to specific Z39.50 attributes, which define an attribute
350 type and a Z39.50 source, or to generic attribute types (e.g. "title").  When
351 a specific attribute is used, the mapping will only be applied to searches 
352 directed at the Z39.50 source linked to the attribute.
353
354 The management interface can be found in the staff client under 
355
356 Admin => Server Administration => Z39.50 Index Field Maps
357
358 Metabib Field Additions
359 +++++++++++++++++++++++
360
361 Stock config.metabib_field entries for author include additional author-
362 related data, like dates.  For example, a value for Personal Author might 
363 look like this:
364
365 'girdlestone cuthbert morton 1895 1975 creator'
366
367 In the context of searching Z39.50 servers, the extraneous data can be 
368 detrimental.  Creating a separate field definition without the extra data
369 is recommended.
370
371 [source,sql]
372 --------------------------------------------
373 INSERT INTO config.metabib_field 
374     (field_class, name, label, format, xpath, search_field)
375     VALUES (
376         'author', 
377         'personal - trimmed', 
378         'Personal Author (trimmed)', 
379         'mods32',
380         '//mods32:mods/mods32:name[@type=''personal'' and mods32:role/mods32:roleTerm[text()=''creator'']]/mods32:namePart[not (@type)]',
381         FALSE
382     );
383
384 -- FULL BIB (OR INDEX-TARGETED) RE-INGEST REQUIRED
385 --------------------------------------------
386
387
388 Library Settings
389 +++++++++++++++++
390
391  * Maximum Parallel Z39.50 Batch Searches (cat.z3950.batch.max_parallel)
392   ** The maximum number of Z39.50 searches that can be in-flight at any given 
393      time when performing batch Z39.50 searches
394  * Maximum Z39.50 Batch Search Results (cat.z3950.batch.max_results)
395   ** The maximum number of search results to retrieve and queue for each 
396      record + Z39 source during batch Z39.50 searches
397
398
399
400 Circulation
401 ~~~~~~~~~~~
402
403 Patron barcode regex for patron registration
404 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
405 A new library setting is available to set a barcode regex to be checked during
406 patron registration. 
407
408 Setting for Desk Renewal to use original circulating library
409 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
410
411 A new global flag option has been added to allow the circulating library of 
412 a desk renewal (a.k.a. a renewal using the staff client) to reuse the original 
413 circulation library for circ rule behaviors rather than using the workstation.
414 This new setting is similar to existing options to use the originating 
415 circulation library in OPAC renewals.
416
417 Library Setting to Disable Patron Credit
418 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
419 A new library setting is available to disable patron credit payments in the
420 billing interface. When enabled, the setting will:
421
422 * Disallow patron_credit payments in the payment API.
423 * Hide all of the patron credit payment actions in the staff client patron
424 payment interface.
425
426 Option to Disallow Use of a Branch as a Pickup Library for Holds
427 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
428 A new library setting is available to remove a branch from consideration as a
429 hold pickup library. This setting only affects the OPAC pickup library selector
430 and does not otherwise affect the display of the branch in the OPAC. It also
431 has no effect on hold targeting / capturing.
432
433
434
435 Floating Groups
436 ^^^^^^^^^^^^^^^
437
438 In previous versions of Evergreen, floating group copies could float or not. If they floated, then they floated everywhere with no restrictions.
439
440 This enhancement provides an interface to define where a copy will float by assigning it to a floating group.
441
442 Long Overdue Circulations Management
443 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
444
445 This is a two-part feature, which covers marking circulations as long
446 overdue via automated processing and check-in of long overdue circulations.
447
448 Marking Circulations Long Overdue
449 +++++++++++++++++++++++++++++++++
450
451 A new Action/Trigger reactor (MarkItemLongOverdue) and sample event 
452 definition (6 Month Overdue Mark Long-Overdue) are included for 
453 marking circulations and their associated copies as long overdue.  New Library
454 Settings (Org Unit Settings) determine whether the item price and/or a
455 processing fee is applied.  
456
457 A secondary Action/Trigger hook (longoverdue.auto) and sample event 
458 definition (6 Month Long Overdue Notice) are added so that (email, etc.) 
459 notifications can be sent when a circulation is marked long overdue via
460 this new automated process.
461
462 Also included is a new Action/Trigger validator PatronNotInCollections, which
463 can be used to prevent long overdue processing (or any circ-based event 
464 definition) for patrons that are in collections processing at (or above) the 
465 circulating library.
466
467 Check-in of Long Overdue Circulations
468 +++++++++++++++++++++++++++++++++++++
469
470 Check-in of long overdue items may result in any of the following actions,
471 depending on configuration.
472
473  * Void the copy price billing
474  * Void the long-overdue processing fee billing
475  * Reinstate voided overdue fines
476
477 The process is practically identical to Lost processing.  However, one
478 difference between Lost and Long Overdue check-in is that the window
479 of time during which a long overdue item may be returned may be based on the
480 due date (like Lost) or the last billing activity date (last payment, last
481 billing).  This is controlled with the "Long-Overdue Check-In Interval Uses
482 Last Activity Date" Library Setting.
483
484 New Library Settings
485 ++++++++++++++++++++
486
487  * Long-Overdue Materials Processing Fee
488  * Void Overdue Fines When Items are Marked Long-Overdue
489  * Leave transaction open when long overdue balance equals zero
490  * Long-Overdue Items Usable on Checkin
491  * Long-Overdue Max Return Interval
492  * Restore Overdues on Long-Overdue Item Return
493  * Void Long-Overdue Item Billing When Returned
494  * Void Processing Fee on Long-Overdue Item Return
495  * Long-Overdue Check-In Interval Uses Last Activity Date
496
497 A combination of 'Charge lost on zero' and 'Default Item Price' are used to
498 determine the amount to charge for the item price when a circulation is 
499 marked as long overdue.
500
501 New Billing Types
502 +++++++++++++++++
503
504  * Long-Overdue Materials
505  * Long-Overdue Materials Processing Fee
506
507 New Permissions
508 +++++++++++++++
509
510  * SET_CIRC_LONG_OVERDUE
511  * COPY_STATUS_LONGOVERDUE.override
512
513 New Copy Status
514 +++++++++++++++
515
516  * Long Overdue
517
518
519
520
521 Patron blocking by lost items and include lost as items out
522 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
523
524 This feature has two main parts, both of which are to improve the staff's
525 ability to assist patrons in regards to lost items.
526
527 * Patron blocking by lost items.  This will add a group penalty threshold
528 that will alert staff when a patron has too many lost items.  This
529 setting is modified through the Group Penalty Thresholds page.
530
531 * Include lost items as items out.  Through a new Library Setting,
532 'Include Lost circulations in lump sum tallies in Patron Display',
533 the staff have the ability to determine if lost items will be included
534 in items out.
535
536
537 Long-Overdue Patron Standing Penalty
538 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
539
540 This is the long-overdue version of the existing PATRON_EXCEEDS_LOST_COUNT
541 standing penalty.  When a patron exceeds the configured threshold for open
542 long-overdue (i.e. non-zero balance) circulations, the penalty is applied.
543 When the number once again goes below the threshold, the penalty is removed.
544
545 The penalty name is PATRON_EXCEEDS_LONGOVERDUE_COUNT / "Patron Exceeds Max
546 Long-Overdue Threshold"
547
548
549 Per-Hold Behind Desk Setting
550 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
551
552 The value for behind-the-desk pickup is now stored directly on each
553 hold request.  This allows the system to better track the true location 
554 of captured hold items in cases where the patron setting has changed since
555 hold capture.
556
557 For these features to be accessible, the "Behind Desk Pickup Supported" 
558 (circ.holds.behind_desk_pickup_supported) Library Setting must be set 
559 to true.
560
561 Staff Client
562 ++++++++++++
563
564 In addition to the counts of ready for pickup and available holds, the
565 staff client now also displays the number of behind-the-desk-holds ready 
566 for pickup at the staff's working location.  If no items are held behind
567 the desk, this information does not display, in particular, because this 
568 information is useless if behind the desk holds are not supported at the 
569 staff's working location.
570
571 TPAC Changes
572 ++++++++++++
573
574 The system also allows patrons to set their own behind-the-desk 
575 pickup preferences in the TPAC settings interface.  To activate this
576 feature, admins need to set the Opac Visible flag to "true" for the 
577 "Hold is behind Circ Desk" (circ.holds_behind_desk) user setting and
578 "Behind Desk Pickup Supported" must be set to true for the patron's
579 home library.
580
581 Print Single Item Receipt
582 ^^^^^^^^^^^^^^^^^^^^^^^^^
583
584 This feature adds the ability to print a receipt for just a single selected
585 item from the patron interface for Items Out or Lost, Claims Returned, Long
586 Overdue, Has Unpaid Billings. This can be used via right-click or using the
587 'Actions for Selected Items' button.
588
589 More User Name Fields Available for Simplified Hold Pull List
590 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
591 More User Name fields are available for display in the simplified hold pull
592 list interface including:
593
594 * First Given Name
595 * Second Given Name
596 * Family Name
597 * Prefix
598 * Suffix
599 * User Alias or First Given Name
600 * User Alias or Display Name
601 * User Alias
602
603
604
605
606 Changes to Self-Check Interface
607 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
608 The following improvements were made to the self-check interface:
609
610 * Convert action links to buttons for increased clarity
611 * Convert dashed fieldsets to gradient backed bubbles for depth
612 * Color line-item table headers to distinguish from actual line-items
613 * Color logo background for increased contrast
614 * Larger input box
615 * Background on prompts to distinguish from logo background
616
617
618
619
620 Different Styles for Long Overdue Lost Items in Billing Interface
621 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
622 Lost or Long Overdue circulations that have not yet been returned will appear
623 in the patron's list of billed transactions styled differently from other
624 not-yet-returned items.
625
626 The interface will also display a helpful message to staff indicating what 
627 colors map to what types of circulations.
628
629 The default colors are maroon for Lost items and orange for Long Overdue items.
630
631 To change the colors, modify circ.css. To change the language for the hint,
632 modify lang.dtd.
633
634 Checkout: Trim whitespace from beginning and end of barcode
635 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
636
637 In checkout, when pasting a barcode into the lookup field, one may accidentally
638 include spaces or tabs in the beginning or end of the barcode string. Trim 
639 those away to avoid potential mis-scans.
640
641 Wrong-Shelf Holds in Clearable Shelf-Expired Holds List
642 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
643
644 The following changes were made to the _Browse Holds Shelf_ interface:
645
646 . Change the staff client _View Shelf-Expired Holds_ action label to _View 
647 Clearable Holds_.
648 . When _View Clearable Holds_ is selected, show wrong-shelf holds in addition
649 to shelf-expired and canceled holds.
650
651 Client
652 ~~~~~~
653
654
655 Customize Items Out Display for Lost, etc.
656 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
657
658 Items which are LOST, LONGOVERDUE, or CLAIMSRETURNED may now be displayed 
659 in the top/main list of circulations instead of the bottom list in the
660 staff client patron Items Out interface.  Similarly, such items can be 
661 removed from the display once the items are checked in even if the 
662 transaction is still open (fines are owed, etc.).
663
664 Apart from organization, this has two additional effects:
665
666  * If all 3 types are hidden once checked in, the interface becomes a true
667    items out interface, instead of a combination of items out and 
668    special circumstance checked-in circs.
669  * If, in addition, all types are configured to be displayed in the top
670    list, the bottom list is hidden from the UI (since nothing would display
671    there), which creates more screen space for the main items out list.
672
673 New Library Settings
674 +++++++++++++++++++++
675
676  * Items Out Long-Overdue display setting (ui.circ.items_out.longoverdue)
677  * Items Out Lost display setting (ui.circ.items_out.lost)
678  * Items Out Claims Returned display setting (ui.circ.items_out.claimsreturned)
679
680 The value for each is a numeric code, describing which list the circulation
681 should appear while checked out and whether the circulation should continue 
682 to appear in the bottom list, when checked in, regardless of the state of
683 the transaction.
684
685  * 1 = top list, then bottom list 
686  * 2 = bottom list, then bottom list
687  * 5 = top list, then do not display
688  * 6 = bottom list, then do not display
689
690 Hint: to hide the bottom list entirely, set the value for all three settings 
691 to '5'.
692
693
694
695 Adjustable font size in the staff client catalog
696 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
697 When using the staff client, the font size in the catalog can now be
698 increased/decreased by using the CTRL key with + (to increase), with - (to
699 decrease), and with 0 (to restore default font size). Font sizes can persist
700 via a setting in user preferences.
701
702 Standalone Mode Shortcut
703 ^^^^^^^^^^^^^^^^^^^^^^^^
704
705 The Evergreen installer now includes a shortcut that launches the staff client 
706 directly into standalone (offline) mode.
707
708
709
710
711 User Setting Defaults
712 ^^^^^^^^^^^^^^^^^^^^^
713
714 For use during Patron Registration, we can now supply default values for User
715 Settings, under _Admin_ -> _Server Administration_ -> _User Setting Types_.
716
717 OPAC
718 ~~~~
719
720 Added Content by Record ID
721 ^^^^^^^^^^^^^^^^^^^^^^^^^^
722 Traditionally, Evergreen has supported Added Content lookups by ISBN
723 only, or (more recently) by one of ISBN or UPC.
724
725 This enhancement adds support for Added Content lookups by record
726 ID, while still supporting the previous URL format for lookups by
727 ISBN.
728
729 The JSPAC and TPAC skins, as well as the web-based Self Checkout
730 interface templates are updated to use jacket images / cover art by
731 record ID by default.
732
733 By using record identifiers, the Added Content handler has the
734 opportunity to examine additional identifiers in the bib record.
735 Currently, these include:
736
737  * ISBN
738  * UPC
739  * ISSN
740
741 Currently, only the OpenILS::WWW::AddedContent::Syndetic provider
742 makes use of the new identifiers.
743
744
745 Local Content Overrides
746 +++++++++++++++++++++++
747 Just as with ISBN lookups, there is support for local overrides in
748 the form of a file created on disk which short-circuits any external
749 Added Content lookup.
750
751
752 Apache Configuration
753 ++++++++++++++++++++
754
755 The example Apache configs have been updated to support serving
756 blank.png when added content jacket URLs return a 404. This prevents
757 "broken image" placeholders in browsers, without requiring a
758 Javascript onerror handler on each img tag.
759
760 The changes are as follows:
761
762 In the eg.conf VirtualHost declaration for SSL, add:
763
764 [source,conf]
765 SSLProxyEngine on # required for ErrorDocument 404 on SSL connections
766
767 In the eg_vhost.conf file, add:
768
769 [source,conf]
770 <Location /opac/extras/ac/jacket>
771         ErrorDocument 404 /opac/images/blank.png
772 </Location>
773
774
775 Bib record browser with linked authorities
776 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
777
778 This feature provides a patron-oriented OPAC interface for browsing
779 bibliographic records.
780
781 Users choose to browse by Author, Title, Subject, or Series. They then
782 enter a browse term, and the nearest match from a left-anchored search
783 on the headings extracted for browse purposes will be displayed in a
784 typical backwards/forwards paging display. Headings link to search
785 results pages showing the related records. If the browse heading is
786 linked to any authority records, and if any *other* authority records
787 point to those with "See also" or other non-main entry headings, those
788 alternative headings are displayed linked to a search results page
789 showing related bib records related to the alternate heading.
790
791 The counts of holdings displayed next to headings from bibliographic
792 records are subject to the same visibility tests as search. This means
793 that the org unit (and copy location group) dropdown on the browse
794 interface affects counts, and it further means that whether or not
795 you're looking at the browse interface through the staff client makes a
796 difference.
797
798 Configuration considerations for site administrators
799 ++++++++++++++++++++++++++++++++++++++++++++++++++++
800 There are two off-by-default features that site administrators may wish
801 to enable.
802
803   * Quick paging links: By adding a value for the Library Setting
804     _Paging shortcut links for OPAC Browse_ (opac.browse.pager_shortcuts), you
805     can make shortcut browsing links such as ''0-9 A B C D ...'' appear
806     between the Back and Next buttons on the browse page. The set of shortcuts
807     should be chosen based on the languages in use at your site, but a
808     reasonable value for English might be the string
809     "*0-9*ABCDEFGHIJKLMNOPQRSTUVWXYZ", which will yield a link for 0-9 and one
810     for each letter A-Z.  The use of asterisks in the string group a shortcut
811     whose label is more than a single letter in length.  Such longer shortcuts
812     have the multi-character string for the shortcut label, and the link just
813     goes to the first heading matching the first character of the label.  The
814     letters not enclosed in asterisks just lead to individual letter shortcuts.
815
816   * There is a global flag by the name _Map of search classes to regular
817     expressions to warn user about leading articles_
818     (opac.browse.warnable_regexp_per_class) to control what leading
819     articles in users' entered browse terms trigger a warning about how
820     it might be better to search for "Rolling Stones" instead of "The
821     Rolling Stones" (or whatever). This is off by default, but can be
822     enabled if it suits your catalog, and can even be customized per
823     search class (author, title, series, subject).
824
825    * Also, by default, authors are indexed for browse in such a way that
826      relator roles like "creator" are dropped off the end of their headings.
827      This was an aesthetic choice. If a site wanted to display those kinds
828      of terms, they would update the 'config.metabib_field' table in
829      the database, setting 'browse_xpath' to NULL where 'field_class' =
830      ''author'' and 'browse_field' is true.
831
832
833 Authority-enhanced bibliographic browse
834 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
835
836 The Evergreen OPAC includes functionality for browsing by bibliographic terms,
837 and, where those terms are controlled by authority records, for linking directly
838 to the records that use other authority controlled terms that are appropriately
839 linked to the browse-exposed term.  In this way, one can browse authors for
840 "King, Stephen" and, when appropriate and correct cataloging has been performed,
841 be presented with a browse link within the author browse list to that brings the
842 user to a "Bachman, Richard" entry, assuming visible bibliographic records are
843 indeed attached to both records. Likewise, when browsing for "Bachman,
844 Richard", users will be presented with a browse link leading to the "King,
845 Stephen" browse location.
846
847 Additionally, any unused but inter-authority-linked terms will appear in the
848 browse list if the linked heading is in use by bibliographic records.  In this
849 way, browsing for "Bachman, Richard" will lead the user to "King, Stephen" even
850 if no bibliographic records make use of the "Bachman, Richard" heading.
851
852 Linked authority records will not be exposed if neither is in use by visible
853 bibliographic records.  This means that the feature will not lead to dead-end
854 searches, but also means that this is not a complete authority browsing tool
855 acceptable for use as such by a cataloger.  See the Manage Authorities interface
856 exposed through the Staff Client for that functionality.
857
858
859 Support for Conjoined Items
860 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
861
862 The catalog now supports the display of conjoined items. The "joined" titles
863 will display a copy record with a link in the copy table back to the "master"
864 bib. The master bib will display a set of links to individual titles.
865
866
867 Shelving Location Filter
868 ^^^^^^^^^^^^^^^^^^^^^^^^
869
870 Filtering by shelving location is now available from the Advanced Search screen.
871
872 Linked library names in copy details
873 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
874
875 A patron may find one or more available copies of an item that they want to
876 retrieve, but may not be familiar with the location, hours of operation, or
877 contact information for each branch of their local library system. To enable
878 the patron to quickly access information about a given library branch, the TPAC
879 and KPAC can link the name of the branch in the copy details display to a URL
880 associated with that branch.
881
882 To set the URL for a given branch, use the *Local Administration -> Library
883 Settings Editor* and edit the *Library Information URL* setting for that
884 branch. Any branches that do not have a library information URL setting display
885 as normal text.
886
887 Ability to set search context by shortname
888 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
889
890 When searching in the catalog, sites are able to set the search location by
891 embedding a locg parameter in the URL. With this new features, sites will be
892 able to use a branch's shortname to set the search locations whereas
893 previously, sites could only use an org unit id. This parameter is case
894 insensitive.
895
896 OPAC Maintenance Message
897 ^^^^^^^^^^^^^^^^^^^^^^^^
898
899 Sites can now set a maintenance message to display in the catalog by setting
900 the ctx.maintenance_message variable in config.tt2.
901
902 My List Enhancements
903 ^^^^^^^^^^^^^^^^^^^^
904
905 The _My Lists_ feature has the following enhancements:
906
907 * Improvement on current navigation for _My Lists_ by displaying a page number
908 and allowing for navigation by page number;
909 * Addition of pagination for items in a list;
910 * Addition of _My Lists Preferences_ tab in _Account Preferences_ where users
911 can identify the number of lists and the number of list items that should 
912 display in each page;
913 * A prompt now displays when users select the _Delete List_ button confirming
914 that they really want to delete the list.
915
916
917
918 Web-Based Patron Self-Registration
919 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
920
921 Feature Summary
922 +++++++++++++++
923
924 Patrons may now fill out a web-based form from within the TPAC to create 
925 pending user accounts.  The goal is to make the registration process more 
926 efficient by allowing the patron to provide much of the registration 
927 details in advance of registering with staff.  
928
929 Pending user accounts have no privileges.  
930
931 The form supports hiding fields, requiring fields, applying format
932 validation, and displaying example text for selected fields by inspecting the 
933 relevant patron registration Library Settings.
934
935 The "Request Library Card" link appears as the second default "bottom link"
936 in the TPAC.  
937
938 If a user is logged in when clicking the register link, the logged-in
939 user will be tracked as the requesting user for the pending account.
940 Additionally, the home org unit and some address fields will be pre-populated
941 for convenience (with the assumption that these will likely be the same for
942 the pending user -- they can, of course, be changed).  When a requesting user
943 is present on the pending user, a link to the requesting user will be 
944 displayed within the patron registration form in the staff client.
945
946 Pending patron accounts which sit unattended in the database for too long
947 are purged via a regularly running (CRON) script.
948
949 Technical Details
950 +++++++++++++++++
951
952   * To activate the web form and allow pending patrons to be created, set
953     the _Allow Patron Self-Registration_ (opac.allow_pending_user) Library
954     Setting to true where appropriate.
955   * To purge old pending user accounts, set an interval value for the new
956     _Patron Self_Reg Expire Interval_ (opac.pending_user_expire_interval)
957     Library Setting.
958   * The Library Settings to indicate show/require/regex/example for patron
959     registration are loaded dynamically, so any Library Settings added in the
960     future will also be honored.  Any setting matching the following format is
961     used:
962     ** ui.patron.edit.[au|aua].*.show
963     ** ui.patron.edit.[au|aua].*.require
964     ** ui.patron.edit.[au|aua].*.regex
965     ** ui.patron.edit.[au|aua].*.example
966
967
968
969 Responsive catalog
970 ^^^^^^^^^^^^^^^^^^
971
972 The design of the web catalog is more responsive, optimizing its display for 
973 mobile devices. Users will see the following changes to the catalog's display
974 when viewing it on a device with a small screen:
975
976 - Elements on the basic search page were resized to fit better on the screen. 
977
978 - Results display cleanly on the search results page. Facets do not display by
979 default, but a _Refine these results_ button is available to retrieve facets.
980 Links to _Place hold_ or _Add to my list_ display prominently beneath holdings
981 information.
982
983 - Search boxes and filters wrap neatly on the advanced search page.
984
985 - The search bar was removed from the login and My Account pages to free up
986 real estate for more relevant information.
987
988 - Navigational tabs were replaced with dropdown menus in several My Account
989 screens.
990
991
992
993
994
995
996
997 RSS Links to Full Catalog Record
998 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
999
1000 Links in RSS feeds now point directly to the catalog record instead of the 
1001 htmlholdings-full format of the record.
1002
1003
1004
1005
1006 Serials
1007 ~~~~~~~
1008
1009
1010
1011 Serial Alerts At Receive Time
1012 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1013 In the Serial Control View, you can now flag a note as an "alert" to
1014 make it more visible on the receiving interface. This flag is available
1015 on subscription, distribution and item notes. The new "Alerts" button
1016 on the Items tab displays the number of alert notes that are available
1017 for the selected items, and clicking this button opens a window which
1018 displays all applicable alert notes, sorted by type. Notes can also be
1019 edited or deleted from this window.
1020
1021
1022
1023
1024 Support Reader Address Information in Routing Slip Template
1025 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1026 The serials routing slip template can now render user addresses if users with
1027 addresses appear on a routing list. This feature is particularly useful for
1028 working with homebound patrons. 
1029
1030 Sites that don't want to see a mailing or billing address can adjust the
1031 default template. Sites that already use a customized template will not be 
1032 affected.
1033
1034
1035
1036
1037 SIP
1038 ~~~
1039
1040
1041
1042 Support SIP Hold Cancellation
1043 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1044
1045 Evergreen now supports a subset of the SIP 15/16 Holds message pair for holds
1046 cancellation.
1047
1048 1. New oils_sip.xml configuration option "msg64_hold_datatype".  This
1049 is similar to msg64_summary_datatype, but affects holds instead of
1050 circulations.  When set to 'barcode', holds information will be
1051 delivered as a set of copy barcodes instead of title strings for patron
1052 info requests.  With barcodes, SIP clients can both find the title
1053 strings for display (via item info requests) and make subsequent
1054 hold-related action requests, like holds cancellation.
1055 +
1056 ----
1057 Copies are not an ideal identifier for holds, but SIP has a limited
1058 vocabulary.  With copies we can (99% of the time) work to and from hold
1059 requests to find a reasonable data set to work on.  If a patron has
1060 multiple holds for the same item and wants to cancel a specific one of
1061 those holds, the user should use the catalog instead of SIP.
1062 ----
1063
1064 2. When receiving a message 15 of with a cancellation action, find the
1065 newest open hold that matches the provided copy barcode and cancel the
1066 hold.
1067
1068
1069
1070
1071
1072 Return Hold ID to SIP
1073 ^^^^^^^^^^^^^^^^^^^^^
1074
1075 If there is a hold on a copy, Evergreen will now return to SIP a hold id to 
1076 indicate that the copy has been captured for a hold. One possible use case for
1077 this feature is a scenario where a delivery vendor may be sorting copies needed
1078 for holds into a different bin from copies returning to their home library. The
1079 presence of the hold ID indicates that the copy has been captured for a hold.
1080 It also could use for an Automated Materials Handling (AMH) System to indicate
1081 that the copy is needed to fill a hold.
1082
1083
1084
1085
1086
1087 Support for SIP "Renew All" messages
1088 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1089
1090 Evergreen now supports SIP "Renew All" functionality, AKA SIP message pair
1091 65/66. When a 65 message is received, the SIP code collects all open 
1092 transactions for the user and renews them all. The set of successful and
1093 failed renewals is returned to the caller via the SIP BM and BN fields.
1094
1095
1096
1097 Miscellaneous
1098 ~~~~~~~~~~~~~
1099
1100
1101 P.V. SUPA GoodStuff Integration
1102 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1103 There is now a "Server Add-ons" module for integrating P.V. Supa's RFID product
1104 known as GoodStuff with the Evergreen staff client.
1105
1106 To activate it, you should add the identifier "pv_supa_goodstuff" (without the
1107 quotes) to the list managed by the Admin->Workstation Administration->Server
1108 Add-ons menu action within the staff client.  You will need the
1109 ADMIN_SERVER_ADDON_FOR_WORKSTATION permission to do this.
1110
1111 After doing this and clicking the Update Active Add-Ons button, the interface
1112 will refresh and show a GoodStuff tab in the Add-on Preferences section.  Within
1113 this tab you will have the option of specifying the hostname and port for the
1114 Goodstuff hardware. There is also an "Enabled" setting that needs to be checked.
1115
1116 Currently three interfaces have been integrated:
1117
1118   * Circulation -> Check In Items
1119   * Circulation -> Check Out Items (where you scan the patron barcode)
1120   * Circulation -> Check Out Items (where you scan the item barcodes)
1121
1122 Each interface gets an RFID checkbox if the "Enabled" preference has been set
1123 that can activate/deactivate the functionality on a per interface basis.  The
1124 checkbox states persist (i.e. are sticky).
1125
1126