1 Evergreen 2.9 Release Notes
2 ===========================
8 This release contains several bugfixes improving on Evergreen 2.9.0.
12 * Protects the stock acquisitions cancel reasons from deletion since they
13 are required to properly handle EDI order responses.
14 * Changes the copy location dropdown so that users can view and select copy
15 locations owned outside the workstation branch if they have permission to do so.
16 This fix also adds the copy location's owning org unit to the display.
20 * Allows use of more special characters, including - and +, when
21 entering a library's main email address in the Organizational Units
23 * Fixes an issue where marc_export attempts to call a non-existent field
24 on MARC::Record if an error occurs while exporting authority records.
28 * Fixes the mapping between copies and the target part when using "Merge
29 Selected" in the Monographic Parts interface.
30 * Fixes an issue with the horizontal scrollbar bar in the MARC import
31 queue inspector so the focus no longer jumps to the top of the screen
32 when attempting to use the scrollbar.
33 * Hides the staff-client saved searches header from screen readers when
34 using the public catalog in non-staff mode.
38 * When placing a hold via the staff client and clicking Advanced Hold
39 Options, fixes an issue where the barcode field populated with the
40 staff member's barcode.
41 * Fixes an issue where some holds with a higher proximity were
42 preferred over holds with a lower proximity because the list of
43 proximities of elgible copies was sorting ASCIIbetically instead of
45 * Adds a delete flag for monographic parts, fixes staff client errors that
46 were previously caused by deleted parts, and cancels any holds attached to
48 * Fixes an internal error that appeared when trying to renew an item on the
49 booking resource list through the public catalog. Users will now get a message
50 saying they do not have permission to renew the item.
55 * Fixes an issue where unclosed phrase searches returned zero results and
56 tied up the open-ils.storage process.
57 * Fixes an issue where phrase searches were ignoring modifiers used in relevance
58 ranking, leading to poorly-ranked results.
59 * Fixes an issue where parameters weren't properly maintained when
60 searching by copy location group.
64 * Adds support for UTF-8 in the Reports interface.
68 We would like to thank the following individuals who contributed
69 code and documentation patches to the 2.9.1. point release of Evergreen:
88 We also thank the following organizations whose employees contributed
91 * Berklee College of Music
93 * British Columbia Libraries Cooperative
95 * Emerald Data Networks, Inc.
96 * Equinox Software, Inc.
97 * Georgia Public Library Service
98 * Lake Agassiz Regional Library
99 * Laurentian University
100 * Massachusetts Library Network Cooperative
101 * Merrimack Valley Library Consortium
103 * Northwest Regional Library System
104 * Pohjois-Karjalan Tietotekniikkakeskus Oy
105 * Rodgers Memorial Library
107 We regret any omissions. If a contributor has been inadvertantly
108 missed, please open a bug at http://bugs.launchpad.net/evergreen/
114 Remove Script-Based Circulation Configuration
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117 Evergreen no longer supports script-based circulation policies. All
118 policies must now be managed within the Local Administration ->
119 Circulation Policies, Hold Policies, and related interfaces.
122 Remove open-ils.penalty service
123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125 Evergreen no longer uses the 'open-ils.penalty' service. It is safe
126 (though not required) to remove the following XML chunks from
127 /openils/conf/opensrf.xml after stopping services.
130 ----------------------------------------------------------------------------
132 <!-- first element -->
135 <keepalive>3</keepalive>
136 <stateless>1</stateless>
137 <language>perl</language>
138 <implementation>OpenILS::Application::Penalty</implementation>
139 <max_requests>99</max_requests>
141 <max_requests>1000</max_requests>
142 <unix_log>open-ils.penalty_unix.log</unix_log>
143 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
144 <unix_pid>open-ils.penalty_unix.pid</unix_pid>
145 <min_children>1</min_children>
146 <max_children>15</max_children>
147 <min_spare_children>1</min_spare_children>
148 <max_spare_children>5</max_spare_children>
151 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
152 <script_path>LIBDIR/javascript</script_path>
153 <script_path>LOCALSTATEDIR</script_path>
154 <script_path>LOCALSTATEDIR/catalog</script_path>
158 <!-- second element -->
160 <appname>open-ils.penalty</appname>
161 ----------------------------------------------------------------------------
164 Removal of deprecated "JSPAC" interface
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167 The deprecated Javascript OPAC interface known as "JSPAC" is no
168 longer included in Evergreen as of this release.
170 With the understanding that local sites may have made use of
171 existing parts of the old JSPAC interface -- especially images and
172 CSS -- no attempt is made at upgrade time to automatically remove
173 the existing files from disk.
175 When upgrading, you may wish to remove "index.xml" from your Apache
176 DirectoryIndex directives.
178 The following directories, xml, js, and css files were formerly part
179 of JSPAC, and you may be able to safely remove them from your system
180 after verifying that they and their contents are no longer required:
182 - web/opac/common/css/
183 - web/opac/common/js/dtree.js
184 - web/opac/common/xml/
185 - web/opac/extras/bbags.js
186 - web/opac/extras/bbags.xml
187 - web/opac/skin/default/js/
188 - web/opac/skin/default/xml/
191 The list of images removed in this change is lengthy, and not
195 Removal of legacy selfcheck interface
196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 The legacy selfcheck interface is no longer included in Evergreen as
201 This interface was formerly located at a URL ending in
202 extras/selfcheck/selfcheck.xml
204 No attempt is made at upgrade time to automatically remove this
207 It is recommended that you remove this interface and its associated
208 configuration after performing an upgrade:
210 (paths relative to Evergreen web root)
212 - opac/extras/selfcheck/selfcheck.css
213 - opac/extras/selfcheck/selfcheck.js
214 - opac/extras/selfcheck/selfcheck.xml
215 - opac/extras/selfcheck/selfcheck_print.css
217 You can also remove the related Apache configuration block starting
221 <LocationMatch .*/selfcheck.xml>
233 Improved reporting of progress during purchase order activation
234 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
235 The progress dialog that is displayed when activating a purchase
236 order now displays more information, particularly during the asset
237 creation phase. It is now also updated in a more linear fashion;
238 making it less likely for it to appear that the activation has
244 ==== "Blanket" Orders
246 "Blanket" orders allow staff to invoice an encumbered amount multiple times,
247 paying off the charge over a period of time. The work flow supported by this
248 development assumes staff does not need to track the individual contents of
249 the order, only the amounts encumbered and invoiced in bulk.
253 . Staff creates PO with a Direct Charge of "Popular Fiction 2015" and
254 a charge type of "Blanket Order".
255 . The amount entered for the charge equals the total amount expected
256 to be charged over the duration of the order.
257 . When a shipment of "Popular Fiction" items arrive, staff creates an
258 invoice from the "Popular Fiction 2015" PO page and enters the amount
259 billed/paid for the received shipment under the "Popular Fiction 2015"
260 charge in the invoice.
261 . When the final shipment arrives, staff select the 'Final invoice
262 for Blanket Order' option on the invoice screen to mark the PO as
263 'received' and drop any remaining encumbrances to $0.
264 .. Alternatively, if the PO needs to be finalized without creating
265 a final invoice, staff can use the new 'Finalize Blanket Order'
266 option on the PO page.
268 ===== New Components/Terminology/Concepts
270 * Invoice Item Types have a new flag called 'blanket', available under
271 Admin -> Server Administration -> Acq -> Invoice Item Types in the
273 * Any direct charge using a 'blanket' item type will create a long-lived
274 charge that can be invoiced multiple times.
275 * Such a charge is considered open until its purchase order is "finalized"
277 * "Finalizing" a PO changes the PO's state to 'received' (assuming there are
278 no pending lineitems on the PO) and fully dis-encumbers all blanket charges
279 on the PO by setting the fund_debit amount to $0 on the original fund_debit
281 * Invoicing a 'blanket' charge does the following under the covers:
282 .. Create an invoice_item to track the payment
283 .. Create a new fund_debit to implement the payment whose amount matches the
285 .. Subtract the invoiced amount from the fund_debit linked to the original
286 'blanket' po_item, thus reducing the amount encumbered on the charge as
287 a whole by the invoiced amount.
288 * A PO can have multiple blanket charges. E.g. you could have a blanket
289 order for "Popular Fiction 2015" and a second charge for "Pop Fiction
290 2015 Taxes" to track / pay taxes over time on a blanket charge.
291 * A PO can have a mix of lineitems, non-blanket charges, and blanket charges.
292 * A 'blanket' Invoice Item Type cannot also be a 'prorate' type, since it's
293 nonsensical. Blanket items are encumbered, whereas prorated items are
294 only paid at invoice time and never encumbered.
306 Examples in Apache configuration for "No Image"
307 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
308 There are now commented out examples for custom images to be used when
309 "no image" is present in the catalog for cover art. The included examples
310 are for small/medium/large jacket image art in the event they are not
311 found by the configured Added Content module.
316 Pre-Expiration A/T Event Definition
317 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
318 A new Action Trigger event definition ("30 Day Account Expiration Courtesy
319 Notice") for sending alerts to users before their accounts are expired has
320 been added. This is intended to give users time to renew their account before
321 they lose access to library services.
326 Improved caching of web server templates
327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
328 Template Toolkit processors used by Apache are now cached for
329 better performance (by virtue of thereby being able to take advantage
330 of Template Toolkit's internal caching mechanism). In addition, the
331 *compiled* versions of the templates themselves can be cached to
332 provide an additional performance boost.
334 Two Apache virtualhost configuration variables are added to
335 control caching of compiled templates:
337 * `OILSWebCompiledTemplateCache` - specifies location on the
338 web server filesystem to store compiled templates.
339 * `OILSWebTemplateStatTTL` - specifies number of seconds before
340 checking to see if a newer version of a cached template is
343 As a result of the caching changes, it is now necessary for
344 Evergreen administrators to reload Apache to ensure that a change
345 to (say) TPAC templates becomes visible.
355 Display Authority Subject Heading Thesaurus Value
356 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
358 There is now a new column in the *Manage Authorities* search results. Each result row now displays each authority's thesaurus value with a "Thes: " prefix. In the authority MARC editor interface the thesaurus value corresponds to the "Subject Heading Thesaurus" fixed field (http://www.loc.gov/marc/authority/ad008.html) labeled “Subj”. For example, a value of "Thes: a" means that the authority is a Library of Congress Subject Heading, and a value of "Thes: k" means the authority is a Canadian Subject Heading.
360 *A Library of Congress list of thesaurus values:*
363 * '' = Alternate no attempt to code
364 * a = Library of Congress Subject Headings
365 * b = LC subject headings for children's literature
366 * c = Medical Subject Headings
367 * d = National Agricultural Library subject authority file
368 * k = Canadian Subject Headings
370 * r = Art and Architecture Thesaurus
371 * s = Sears List of Subject Headings
372 * v = Repertoire de vedettes-matiere
374 * | = No attempt to code
379 Importing Statistical Categories
380 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
381 You can now retrieve statistical categories (stat cats) from the MARC
382 record and apply them to the items in Evergreen. When importing or
383 overlaying items through the Vandelay MARC batch import process, edit
384 your Holdings Import Profile to tell Evergreen which subfield contains
385 your stat cat data. That subfield in your MARC records should be
386 formatted like the following:
389 CATEGORY 1|VALUE 1||CATEGORY 2|VALUE 2
392 Notice that the pipe character '|' is used to separate each category
393 from its value, and two pipes separate each pair of category values.
395 If you are overlaying existing copies which already have stat cats
396 attached to them, the overlay process will keep those values unless the
397 incoming copies contain updated values for matching categories.
402 Remove the ‡biblios.net Z39.50 target from seed data
403 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
404 The Z39.50 target at z3950.biblios.net/bibliographic has not worked
405 for years, so its service definition is no longer provided in the
406 seed data for new installations of Evergreen.
408 Users of existing Evergreen systems should consider removing
409 the Z39.50 definition for ‡biblios.net. This can be done from
410 Admin | Server Administration | Z39.50 Servers in the staff
416 SKOS for coded values
417 ^^^^^^^^^^^^^^^^^^^^^
418 Some vocabularies used (or which could be used) for stock
419 record attributes and coded value maps in Evergreen are
420 published on the web using SKOS. The record attributes system
421 can now associate Linked Data URIs with specific attribute
422 values. In particular, seed data supplying URIs for the
423 RDA Content Type, Media Type, and Carrier Type in this release.
425 This is an experimental, "under-the-hood" feature that will be built
426 upon in subsuquent releases.
431 MARC Tag-table Service
432 ^^^^^^^^^^^^^^^^^^^^^^
433 The tag tables for the web staff client MARC editor are
434 now stored in the database rather than a separate XML
435 tooltips file as used by the XUL MARC editor. The tag-table
436 service, which is part of the web staff client sprint 2
437 preview in this release, has the following features:
439 - specifies whether (sub)fields are optional or mandatory
440 - specifies whether (sub)fields are repeatable or not
441 - a coded value map can be associated with a subfield to
442 establish a controlled vocabulary for that subfield
443 - MARC field and subfield definitions can be overridden
444 by institutions further down in the organizational unit
445 hierarchy. This allows, for example, a library to specify
446 definitions for local MARC tags.
447 - values supplied by the tag-table service are used to
448 populate values in context menus in the web staff client
451 The initial seed data for the in-database tag table is
452 derived from the current tooltips XML file.
457 Web staff client cataloging preview
458 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
459 The web staff client now includes additional functionality
460 to support cataloging and item maintenance, including:
463 - the service backing the authority headings chooser now
464 has the ability to filter the browse by subject thesaurus
465 - Z39.50 search and record import
466 - improvements to copy and record bucket functionality
467 - embedding the link checker interface
468 - embedding the MARC batch import/export interface
469 - the web staff volume/copy editor
471 Nearly all of the cataloging functionality available in the XUL
472 staff client is now present in the web staff client with the
473 exception of printing spine labels. Nonetheless, the web staff
474 client remains a preview and is not recommended for production use.
484 Conditional Negative Balances
485 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
486 Evergreen sites will now have more control over whether a negative balance can
487 be applied to a user's billing record and when that negative balance can be
488 applied. Through a series of Library Settings, a site can prohibit negative
489 balances on bills or can allow those negative balances to be applied for a
490 specific period of time after a lost or overdue bill is charged to the user.
491 Sites can set a default for all types of bills or can apply distinct settings
492 for lost bills and for overdue fines. The more specific settings will override
495 Sites that opt to allow negative balances for a specific period of time must
496 1) enable the relevant "prohibit negative balances" setting(s) and 2) specify
497 the time period in the relevant Negative Balance Interval setting(s).
499 In addition to the new library settings, the system now has a new account
500 adjustment payment type. This payment type will be utilized for libraries
501 prohibiting negative balances to replace the previous voiding behavior that
502 caused the negative balances to occur. The account adjustment payment type will
503 also be used for all libraries, regardless of the state of negative balance
504 settings, in cases where overdue fines are adjusted when an overdue item is
507 An _Adjust to Zero_ option has been added to the bills interface of the patron
508 record. This option will always adjust the selected bill to a zero balance.
509 It can also be used to easily clear a negative balance from the patron's
510 record. A user must have the new ADJUST_BILLS permission to see and use this
513 This new feature also changes the behavior for the client option to void a bill
514 from the patron record. If a user does not have the VOID_BILLING permission, the
515 option to void bills will be hidden in the bills interface and in the Full
516 Details view of a specific bill.
518 To truly remove the ability to produce negative balances on a transaction,
519 administrators need to 1) enable the relevant setting in the Library Settings
520 Editor and 2) remove the VOID_BILLING permission from staff accounts since
521 manual voiding will continue to produce negative balances.
525 * Negative Balance Interval (Default) (bill.negative_balance_interval_default)
526 * Negative Balance Interval for Lost (bill.negative_balance_interval_on_lost) -
527 * Negative Balance Interval for Overdues (bill.negative_balance_interval_on_overdues
528 * Prohibit negative balance on bills (Default) (bill.prohibit_negative_balance_default)
529 * Prohibit negative balance on bills for lost materials (bill.prohibit_negative_balance_on_lost)
530 * Prohibit negative balance on bills for overdue materials (bill.prohibit_negative_balance_on_overdues)
539 Selfcheck Inactivity Warning
540 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
542 The Selfcheck interface now warns patrons when they are about to be
543 logged out due to inactivity 20 seconds prior to logging them out.
545 The inactivity timeout is also reset with each checkout to avoid timeouts
546 while checking out lots of items.
551 User Registration Includes Inactive Accounts in Dupe Search
552 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
553 When registering a user, the system checks to see if there are already exiting users with the same name, address, email, etc. Now this duplicate user search includes inactive users so that matches can be re-activated if desired, rather than creating duplicate accounts.
563 Link in catalog to clear Added Content cache
564 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
565 On the catalog's record summary page, there is now a link for staff that
566 allow them to forcibly clear the cache for the Added Content for that
567 record. This is helpful if the Added Content retrieved the wrong
568 cover jacket art, summary, etc. and caches the wrong result.
573 Disable Google Analytics in Staff Client
574 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
575 In the staff client interface, Google Analytics for the web catalog is
576 now disabled by default. This was a preventive measure to reduce the
577 potential risks for leaking patron information.
582 Move Acquisitions Admin Menu
583 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
584 In the staff client interface, the Acquisitions Administration menu is
585 now directly accessible from the main "Admin" menu instead of
586 living under "Server Administration". It has also been renamed as "Acquisitions
597 Account Expiration Date in My Account
598 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
599 The Account Expiration Date has been added to the catalog's My Account display
600 on the main Account Summary page and the Account Preferences page. This should
601 help patrons with figuring out when their accounts are due to expire before
602 they actually expire.
606 Change to Available Copies Display
607 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
608 The _Show_ link in the available copies area of the record summary will now
609 display for any org unit that owns a copy of a particular title, even if all
610 those copies are unavailable. The _Show_ link will not display if a) the copy
611 display is already scoped to that org unit or b) the org unit does not own
614 The language has also been changed to read "x of y copies available at z
621 Column sorting in circulation screens
622 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
624 Sorting of selected columns is now available in the *Items Checked Out*, *Check Out History*,
627 * Clicking on the appropriate column heads now sorts the contents from
628 ``ascending'' to ``descending'' to ``no sort''. (The ``no sort'' restores the
629 original list as presented in the screen.)
631 * The sort indicator (an up or down arrow) is placed to the right
632 of the column head, as appropriate.
634 * The combined *Title/Author* column in the *Items Checked Out* screen is now separated into two
635 independently sortable columns (Title and Author).
637 * Title sorting is done with the non-filing characters (leading ``the'', ``a'',
638 ``an'', and other langugage equivalents) removed. The leading articles are rendered in
639 a smaller font, so as to keep the main entry prominent. In
640 addition to the non-filing characters removed for the sort, leading
641 non-alphanumeric characters are ignored in the sort.
646 New bib source variable for catalog customization
647 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
648 For bibliographic records, there is a "bib source" that can be
649 associated with every record. This source is now available as a
650 variable that can be used behind the scenes when customizing
651 the online catalog. The new bib source variables do not present
652 themselves in the catalog display by default.
657 New class attribute for e-resource links
658 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
659 In the catalog, links to electronic resources now have a link class
660 attribute of "uri_link" to make them easier to customize or build
661 additional services upon.
667 Removal of deprecated "JSPAC" interface
668 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
670 The deprecated Javascript OPAC interface known as "JSPAC" is no
671 longer included in Evergreen as of this release.
673 With the understanding that local sites may have made use of
674 existing parts of the old JSPAC interface -- especially images and
675 CSS -- no attempt is made at upgrade time to automatically remove
676 the existing files from disk.
678 When upgrading, you may wish to remove "index.xml" from your Apache
679 DirectoryIndex directives.
681 The following directories, xml, js, and css files were formerly part
682 of JSPAC, and you may be able to safely remove them from your system
683 after verifying that they and their contents are no longer required:
685 - web/opac/common/css/
686 - web/opac/common/js/dtree.js
687 - web/opac/common/xml/
688 - web/opac/extras/bbags.js
689 - web/opac/extras/bbags.xml
690 - web/opac/skin/default/js/
691 - web/opac/skin/default/xml/
694 The list of images removed in this change is lengthy, and not
700 Removal of legacy selfcheck interface
701 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
703 The legacy selfcheck interface is no longer included in Evergreen as
706 This interface was formerly located at a URL ending in
707 extras/selfcheck/selfcheck.xml
709 No attempt is made at upgrade time to automatically remove this
712 It is recommended that you remove this interface and its associated
713 configuration after performing an upgrade:
715 (paths relative to Evergreen web root)
717 - opac/extras/selfcheck/selfcheck.css
718 - opac/extras/selfcheck/selfcheck.js
719 - opac/extras/selfcheck/selfcheck.xml
720 - opac/extras/selfcheck/selfcheck_print.css
722 You can also remove the related Apache configuration block starting
726 <LocationMatch .*/selfcheck.xml>
733 The Evergreen project would like to acknowledge the following
734 organizations who commissioned developments in this release of
737 * Georgia Public Library Service
738 * Grand Rapids Public Library
739 * Kenton County Public Library
740 * King County Library System
741 * Massachusetts Library Network Cooperative
744 * Pennsylvania Integrated Library System
746 We would also like to thank the following individuals who contributed
747 code, documentation patches and tests to this release of Evergreen:
779 We also thank the following organizations whose employees contributed
782 * Anderson County Library
783 * Berklee College of Music
785 * British Columbia Libraries Cooperative
788 * Central/Western Massachusetts Automated Resource Sharing
789 * Emerald Data Networks, Inc.
790 * Equinox Software, Inc.
791 * Georgia Public Library Service
792 * Grand Rapids Public Library
793 * Indiana State Library
794 * King County Library System
795 * Lake Agassiz Regional Library
796 * Laurentian University
797 * Linn-Benton Community College
798 * Massachusetts Library Network Cooperative
799 * Merrimack Valley Library Consortium
801 * Northwest Regional Library System
803 * Traverse Area District Library
805 We regret any omissions. If a contributor has been inadvertantly
806 missed, please open a bug at http://bugs.launchpad.net/evergreen/