1 Evergreen 2.9 Release Notes
2 ===========================
8 This release contains several bugfixes improving on Evergreen.
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 the 2.9.1. point release of Evergreen:
85 We also thank the following organizations whose employees contributed
88 * Berklee College of Music
89 * British Columbia Libraries Cooperative
91 * Emerald Data Networks, Inc.
92 * Equinox Software, Inc.
93 * Georgia Public Library Service
94 * Lake Agassiz Regional Library
95 * Massachusetts Library Network Cooperative
96 * Merrimack Valley Library Consortium
97 * Northwest Regional Library System
98 * Pohjois-Karjalan Tietotekniikkakeskus Oy
99 * Rodgers Memorial Library
101 We regret any omissions. If a contributor has been inadvertantly
102 missed, please open a bug at http://bugs.launchpad.net/evergreen/
108 Remove Script-Based Circulation Configuration
109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111 Evergreen no longer supports script-based circulation policies. All
112 policies must now be managed within the Local Administration ->
113 Circulation Policies, Hold Policies, and related interfaces.
116 Remove open-ils.penalty service
117 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
119 Evergreen no longer uses the 'open-ils.penalty' service. It is safe
120 (though not required) to remove the following XML chunks from
121 /openils/conf/opensrf.xml after stopping services.
124 ----------------------------------------------------------------------------
126 <!-- first element -->
129 <keepalive>3</keepalive>
130 <stateless>1</stateless>
131 <language>perl</language>
132 <implementation>OpenILS::Application::Penalty</implementation>
133 <max_requests>99</max_requests>
135 <max_requests>1000</max_requests>
136 <unix_log>open-ils.penalty_unix.log</unix_log>
137 <unix_sock>open-ils.penalty_unix.sock</unix_sock>
138 <unix_pid>open-ils.penalty_unix.pid</unix_pid>
139 <min_children>1</min_children>
140 <max_children>15</max_children>
141 <min_spare_children>1</min_spare_children>
142 <max_spare_children>5</max_spare_children>
145 <patron_penalty>penalty/patron_penalty.js</patron_penalty>
146 <script_path>LIBDIR/javascript</script_path>
147 <script_path>LOCALSTATEDIR</script_path>
148 <script_path>LOCALSTATEDIR/catalog</script_path>
152 <!-- second element -->
154 <appname>open-ils.penalty</appname>
155 ----------------------------------------------------------------------------
158 Removal of deprecated "JSPAC" interface
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
161 The deprecated Javascript OPAC interface known as "JSPAC" is no
162 longer included in Evergreen as of this release.
164 With the understanding that local sites may have made use of
165 existing parts of the old JSPAC interface -- especially images and
166 CSS -- no attempt is made at upgrade time to automatically remove
167 the existing files from disk.
169 When upgrading, you may wish to remove "index.xml" from your Apache
170 DirectoryIndex directives.
172 The following directories, xml, js, and css files were formerly part
173 of JSPAC, and you may be able to safely remove them from your system
174 after verifying that they and their contents are no longer required:
176 - web/opac/common/css/
177 - web/opac/common/js/dtree.js
178 - web/opac/common/xml/
179 - web/opac/extras/bbags.js
180 - web/opac/extras/bbags.xml
181 - web/opac/skin/default/js/
182 - web/opac/skin/default/xml/
185 The list of images removed in this change is lengthy, and not
189 Removal of legacy selfcheck interface
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192 The legacy selfcheck interface is no longer included in Evergreen as
195 This interface was formerly located at a URL ending in
196 extras/selfcheck/selfcheck.xml
198 No attempt is made at upgrade time to automatically remove this
201 It is recommended that you remove this interface and its associated
202 configuration after performing an upgrade:
204 (paths relative to Evergreen web root)
206 - opac/extras/selfcheck/selfcheck.css
207 - opac/extras/selfcheck/selfcheck.js
208 - opac/extras/selfcheck/selfcheck.xml
209 - opac/extras/selfcheck/selfcheck_print.css
211 You can also remove the related Apache configuration block starting
215 <LocationMatch .*/selfcheck.xml>
227 Improved reporting of progress during purchase order activation
228 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
229 The progress dialog that is displayed when activating a purchase
230 order now displays more information, particularly during the asset
231 creation phase. It is now also updated in a more linear fashion;
232 making it less likely for it to appear that the activation has
238 ==== "Blanket" Orders
240 "Blanket" orders allow staff to invoice an encumbered amount multiple times,
241 paying off the charge over a period of time. The work flow supported by this
242 development assumes staff does not need to track the individual contents of
243 the order, only the amounts encumbered and invoiced in bulk.
247 . Staff creates PO with a Direct Charge of "Popular Fiction 2015" and
248 a charge type of "Blanket Order".
249 . The amount entered for the charge equals the total amount expected
250 to be charged over the duration of the order.
251 . When a shipment of "Popular Fiction" items arrive, staff creates an
252 invoice from the "Popular Fiction 2015" PO page and enters the amount
253 billed/paid for the received shipment under the "Popular Fiction 2015"
254 charge in the invoice.
255 . When the final shipment arrives, staff select the 'Final invoice
256 for Blanket Order' option on the invoice screen to mark the PO as
257 'received' and drop any remaining encumbrances to $0.
258 .. Alternatively, if the PO needs to be finalized without creating
259 a final invoice, staff can use the new 'Finalize Blanket Order'
260 option on the PO page.
262 ===== New Components/Terminology/Concepts
264 * Invoice Item Types have a new flag called 'blanket', available under
265 Admin -> Server Administration -> Acq -> Invoice Item Types in the
267 * Any direct charge using a 'blanket' item type will create a long-lived
268 charge that can be invoiced multiple times.
269 * Such a charge is considered open until its purchase order is "finalized"
271 * "Finalizing" a PO changes the PO's state to 'received' (assuming there are
272 no pending lineitems on the PO) and fully dis-encumbers all blanket charges
273 on the PO by setting the fund_debit amount to $0 on the original fund_debit
275 * Invoicing a 'blanket' charge does the following under the covers:
276 .. Create an invoice_item to track the payment
277 .. Create a new fund_debit to implement the payment whose amount matches the
279 .. Subtract the invoiced amount from the fund_debit linked to the original
280 'blanket' po_item, thus reducing the amount encumbered on the charge as
281 a whole by the invoiced amount.
282 * A PO can have multiple blanket charges. E.g. you could have a blanket
283 order for "Popular Fiction 2015" and a second charge for "Pop Fiction
284 2015 Taxes" to track / pay taxes over time on a blanket charge.
285 * A PO can have a mix of lineitems, non-blanket charges, and blanket charges.
286 * A 'blanket' Invoice Item Type cannot also be a 'prorate' type, since it's
287 nonsensical. Blanket items are encumbered, whereas prorated items are
288 only paid at invoice time and never encumbered.
300 Examples in Apache configuration for "No Image"
301 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
302 There are now commented out examples for custom images to be used when
303 "no image" is present in the catalog for cover art. The included examples
304 are for small/medium/large jacket image art in the event they are not
305 found by the configured Added Content module.
310 Pre-Expiration A/T Event Definition
311 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
312 A new Action Trigger event definition ("30 Day Account Expiration Courtesy
313 Notice") for sending alerts to users before their accounts are expired has
314 been added. This is intended to give users time to renew their account before
315 they lose access to library services.
320 Improved caching of web server templates
321 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
322 Template Toolkit processors used by Apache are now cached for
323 better performance (by virtue of thereby being able to take advantage
324 of Template Toolkit's internal caching mechanism). In addition, the
325 *compiled* versions of the templates themselves can be cached to
326 provide an additional performance boost.
328 Two Apache virtualhost configuration variables are added to
329 control caching of compiled templates:
331 * `OILSWebCompiledTemplateCache` - specifies location on the
332 web server filesystem to store compiled templates.
333 * `OILSWebTemplateStatTTL` - specifies number of seconds before
334 checking to see if a newer version of a cached template is
337 As a result of the caching changes, it is now necessary for
338 Evergreen administrators to reload Apache to ensure that a change
339 to (say) TPAC templates becomes visible.
349 Display Authority Subject Heading Thesaurus Value
350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
352 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.
354 *A Library of Congress list of thesaurus values:*
357 * '' = Alternate no attempt to code
358 * a = Library of Congress Subject Headings
359 * b = LC subject headings for children's literature
360 * c = Medical Subject Headings
361 * d = National Agricultural Library subject authority file
362 * k = Canadian Subject Headings
364 * r = Art and Architecture Thesaurus
365 * s = Sears List of Subject Headings
366 * v = Repertoire de vedettes-matiere
368 * | = No attempt to code
373 Importing Statistical Categories
374 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
375 You can now retrieve statistical categories (stat cats) from the MARC
376 record and apply them to the items in Evergreen. When importing or
377 overlaying items through the Vandelay MARC batch import process, edit
378 your Holdings Import Profile to tell Evergreen which subfield contains
379 your stat cat data. That subfield in your MARC records should be
380 formatted like the following:
383 CATEGORY 1|VALUE 1||CATEGORY 2|VALUE 2
386 Notice that the pipe character '|' is used to separate each category
387 from its value, and two pipes separate each pair of category values.
389 If you are overlaying existing copies which already have stat cats
390 attached to them, the overlay process will keep those values unless the
391 incoming copies contain updated values for matching categories.
396 Remove the ‡biblios.net Z39.50 target from seed data
397 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
398 The Z39.50 target at z3950.biblios.net/bibliographic has not worked
399 for years, so its service definition is no longer provided in the
400 seed data for new installations of Evergreen.
402 Users of existing Evergreen systems should consider removing
403 the Z39.50 definition for ‡biblios.net. This can be done from
404 Admin | Server Administration | Z39.50 Servers in the staff
410 SKOS for coded values
411 ^^^^^^^^^^^^^^^^^^^^^
412 Some vocabularies used (or which could be used) for stock
413 record attributes and coded value maps in Evergreen are
414 published on the web using SKOS. The record attributes system
415 can now associate Linked Data URIs with specific attribute
416 values. In particular, seed data supplying URIs for the
417 RDA Content Type, Media Type, and Carrier Type in this release.
419 This is an experimental, "under-the-hood" feature that will be built
420 upon in subsuquent releases.
425 MARC Tag-table Service
426 ^^^^^^^^^^^^^^^^^^^^^^
427 The tag tables for the web staff client MARC editor are
428 now stored in the database rather than a separate XML
429 tooltips file as used by the XUL MARC editor. The tag-table
430 service, which is part of the web staff client sprint 2
431 preview in this release, has the following features:
433 - specifies whether (sub)fields are optional or mandatory
434 - specifies whether (sub)fields are repeatable or not
435 - a coded value map can be associated with a subfield to
436 establish a controlled vocabulary for that subfield
437 - MARC field and subfield definitions can be overridden
438 by institutions further down in the organizational unit
439 hierarchy. This allows, for example, a library to specify
440 definitions for local MARC tags.
441 - values supplied by the tag-table service are used to
442 populate values in context menus in the web staff client
445 The initial seed data for the in-database tag table is
446 derived from the current tooltips XML file.
451 Web staff client cataloging preview
452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
453 The web staff client now includes additional functionality
454 to support cataloging and item maintenance, including:
457 - the service backing the authority headings chooser now
458 has the ability to filter the browse by subject thesaurus
459 - Z39.50 search and record import
460 - improvements to copy and record bucket functionality
461 - embedding the link checker interface
462 - embedding the MARC batch import/export interface
463 - the web staff volume/copy editor
465 Nearly all of the cataloging functionality available in the XUL
466 staff client is now present in the web staff client with the
467 exception of printing spine labels. Nonetheless, the web staff
468 client remains a preview and is not recommended for production use.
478 Conditional Negative Balances
479 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
480 Evergreen sites will now have more control over whether a negative balance can
481 be applied to a user's billing record and when that negative balance can be
482 applied. Through a series of Library Settings, a site can prohibit negative
483 balances on bills or can allow those negative balances to be applied for a
484 specific period of time after a lost or overdue bill is charged to the user.
485 Sites can set a default for all types of bills or can apply distinct settings
486 for lost bills and for overdue fines. The more specific settings will override
489 Sites that opt to allow negative balances for a specific period of time must
490 1) enable the relevant "prohibit negative balances" setting(s) and 2) specify
491 the time period in the relevant Negative Balance Interval setting(s).
493 In addition to the new library settings, the system now has a new account
494 adjustment payment type. This payment type will be utilized for libraries
495 prohibiting negative balances to replace the previous voiding behavior that
496 caused the negative balances to occur. The account adjustment payment type will
497 also be used for all libraries, regardless of the state of negative balance
498 settings, in cases where overdue fines are adjusted when an overdue item is
501 An _Adjust to Zero_ option has been added to the bills interface of the patron
502 record. This option will always adjust the selected bill to a zero balance.
503 It can also be used to easily clear a negative balance from the patron's
504 record. A user must have the new ADJUST_BILLS permission to see and use this
507 This new feature also changes the behavior for the client option to void a bill
508 from the patron record. If a user does not have the VOID_BILLING permission, the
509 option to void bills will be hidden in the bills interface and in the Full
510 Details view of a specific bill.
512 To truly remove the ability to produce negative balances on a transaction,
513 administrators need to 1) enable the relevant setting in the Library Settings
514 Editor and 2) remove the VOID_BILLING permission from staff accounts since
515 manual voiding will continue to produce negative balances.
519 * Negative Balance Interval (Default) (bill.negative_balance_interval_default)
520 * Negative Balance Interval for Lost (bill.negative_balance_interval_on_lost) -
521 * Negative Balance Interval for Overdues (bill.negative_balance_interval_on_overdues
522 * Prohibit negative balance on bills (Default) (bill.prohibit_negative_balance_default)
523 * Prohibit negative balance on bills for lost materials (bill.prohibit_negative_balance_on_lost)
524 * Prohibit negative balance on bills for overdue materials (bill.prohibit_negative_balance_on_overdues)
533 Selfcheck Inactivity Warning
534 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
536 The Selfcheck interface now warns patrons when they are about to be
537 logged out due to inactivity 20 seconds prior to logging them out.
539 The inactivity timeout is also reset with each checkout to avoid timeouts
540 while checking out lots of items.
545 User Registration Includes Inactive Accounts in Dupe Search
546 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
547 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.
557 Link in catalog to clear Added Content cache
558 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
559 On the catalog's record summary page, there is now a link for staff that
560 allow them to forcibly clear the cache for the Added Content for that
561 record. This is helpful if the Added Content retrieved the wrong
562 cover jacket art, summary, etc. and caches the wrong result.
567 Disable Google Analytics in Staff Client
568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
569 In the staff client interface, Google Analytics for the web catalog is
570 now disabled by default. This was a preventive measure to reduce the
571 potential risks for leaking patron information.
576 Move Acquisitions Admin Menu
577 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
578 In the staff client interface, the Acquisitions Administration menu is
579 now directly accessible from the main "Admin" menu instead of
580 living under "Server Administration". It has also been renamed as "Acquisitions
591 Account Expiration Date in My Account
592 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
593 The Account Expiration Date has been added to the catalog's My Account display
594 on the main Account Summary page and the Account Preferences page. This should
595 help patrons with figuring out when their accounts are due to expire before
596 they actually expire.
600 Change to Available Copies Display
601 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
602 The _Show_ link in the available copies area of the record summary will now
603 display for any org unit that owns a copy of a particular title, even if all
604 those copies are unavailable. The _Show_ link will not display if a) the copy
605 display is already scoped to that org unit or b) the org unit does not own
608 The language has also been changed to read "x of y copies available at z
615 Column sorting in circulation screens
616 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
618 Sorting of selected columns is now available in the *Items Checked Out*, *Check Out History*,
621 * Clicking on the appropriate column heads now sorts the contents from
622 ``ascending'' to ``descending'' to ``no sort''. (The ``no sort'' restores the
623 original list as presented in the screen.)
625 * The sort indicator (an up or down arrow) is placed to the right
626 of the column head, as appropriate.
628 * The combined *Title/Author* column in the *Items Checked Out* screen is now separated into two
629 independently sortable columns (Title and Author).
631 * Title sorting is done with the non-filing characters (leading ``the'', ``a'',
632 ``an'', and other langugage equivalents) removed. The leading articles are rendered in
633 a smaller font, so as to keep the main entry prominent. In
634 addition to the non-filing characters removed for the sort, leading
635 non-alphanumeric characters are ignored in the sort.
640 New bib source variable for catalog customization
641 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
642 For bibliographic records, there is a "bib source" that can be
643 associated with every record. This source is now available as a
644 variable that can be used behind the scenes when customizing
645 the online catalog. The new bib source variables do not present
646 themselves in the catalog display by default.
651 New class attribute for e-resource links
652 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
653 In the catalog, links to electronic resources now have a link class
654 attribute of "uri_link" to make them easier to customize or build
655 additional services upon.
661 Removal of deprecated "JSPAC" interface
662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
664 The deprecated Javascript OPAC interface known as "JSPAC" is no
665 longer included in Evergreen as of this release.
667 With the understanding that local sites may have made use of
668 existing parts of the old JSPAC interface -- especially images and
669 CSS -- no attempt is made at upgrade time to automatically remove
670 the existing files from disk.
672 When upgrading, you may wish to remove "index.xml" from your Apache
673 DirectoryIndex directives.
675 The following directories, xml, js, and css files were formerly part
676 of JSPAC, and you may be able to safely remove them from your system
677 after verifying that they and their contents are no longer required:
679 - web/opac/common/css/
680 - web/opac/common/js/dtree.js
681 - web/opac/common/xml/
682 - web/opac/extras/bbags.js
683 - web/opac/extras/bbags.xml
684 - web/opac/skin/default/js/
685 - web/opac/skin/default/xml/
688 The list of images removed in this change is lengthy, and not
694 Removal of legacy selfcheck interface
695 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
697 The legacy selfcheck interface is no longer included in Evergreen as
700 This interface was formerly located at a URL ending in
701 extras/selfcheck/selfcheck.xml
703 No attempt is made at upgrade time to automatically remove this
706 It is recommended that you remove this interface and its associated
707 configuration after performing an upgrade:
709 (paths relative to Evergreen web root)
711 - opac/extras/selfcheck/selfcheck.css
712 - opac/extras/selfcheck/selfcheck.js
713 - opac/extras/selfcheck/selfcheck.xml
714 - opac/extras/selfcheck/selfcheck_print.css
716 You can also remove the related Apache configuration block starting
720 <LocationMatch .*/selfcheck.xml>
727 The Evergreen project would like to acknowledge the following
728 organizations who commissioned developments in this release of
731 * Georgia Public Library Service
732 * Grand Rapids Public Library
733 * Kenton County Public Library
734 * King County Library System
735 * Massachusetts Library Network Cooperative
738 * Pennsylvania Integrated Library System
740 We would also like to thank the following individuals who contributed
741 code, documentation patches and tests to this release of Evergreen:
773 We also thank the following organizations whose employees contributed
776 * Anderson County Library
777 * Berklee College of Music
779 * British Columbia Libraries Cooperative
782 * Central/Western Massachusetts Automated Resource Sharing
783 * Emerald Data Networks, Inc.
784 * Equinox Software, Inc.
785 * Georgia Public Library Service
786 * Grand Rapids Public Library
787 * Indiana State Library
788 * King County Library System
789 * Lake Agassiz Regional Library
790 * Laurentian University
791 * Linn-Benton Community College
792 * Massachusetts Library Network Cooperative
793 * Merrimack Valley Library Consortium
795 * Northwest Regional Library System
797 * Traverse Area District Library
799 We regret any omissions. If a contributor has been inadvertantly
800 missed, please open a bug at http://bugs.launchpad.net/evergreen/