1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.11.
9 All bug fixes refer to the web staff client unless otherwise specified.
14 * Fixes an issue that caused catalog searches to fail after a new library was added to the org tree.
15 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
16 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
17 * Fixes various misspellings and capitalization issues in the interface.
18 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
19 * Fixes an issue with checking in hourly loans.
20 * Staff can now approve pending patron addresses in the patron edit interface.
21 * Prevents patron records from being merged with themselves.
22 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
23 * Fixes issues with duplicate transit records.
24 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
25 * Improvements to the Item Attribute Editor.
26 * Staff can now set a default search box in the Z39.50 search interface.
27 * Staff can now delete copy notes.
28 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
29 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
30 * Protects backordered acquisitions items from having their catalog items deleted.
31 * Fixes problems that occur when cloning a report template created in the XUL client.
32 * Fixes bugs that caused activity metric data when performing searches.
33 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern.
34 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
38 We would like to thank the following individuals who contributed code,
39 tests and documentation patches to the 3.0.12 point release of
68 This release contains bug fixes improving on Evergreen 3.0.10.
69 All bug fixes refer to the web staff client unless otherwise specified.
74 * Several strings are now displayed in the correct translation.
75 * Right clicking in grids results in more intuitive behavior.
76 * Usernames and barcodes containging the _%_ character no longer
77 experience problems logging in.
78 * Fixes cases in which the web client stops loading after the toolbar.
79 * Fixes problems in which using the web client in multiple tabs leads
80 to data inconsistency.
81 * Fixes an issue that caused authentication session checks to spam
82 the system and needlessly fill up logs.
83 * Boolean fields within grid views now say "Yes"/"No" instead of
85 * Fixes sorting issues in the patron search.
86 * Staff can now choose to print out only a selection of items out,
87 instead of having to print them all.
88 * The patron triggered event screen now respects the
89 `circ.staff.max_visible_event_age` library setting.
90 * Fixes an issue which caused an exception to be thrown during
91 non-cataloged item checkout.
92 * Fixes permission issues related to merging users.
93 * The bibliographic record summary now displays the call number that
94 matches the library's classification system.
95 * The copy editor now makes shelving locations visible to catalogers
96 from other libraries as needed.
97 * Once a record is overlayed in the Z39.50 screen, it is no longer
99 * Several fixes to the filters on the Holdings View screen.
100 * Several fixes to how empty volumes are created and displayed.
101 * Fixes to item and call number transfers.
102 * Fixes several issues with the item status list view.
103 * When adding new copies, the circulation library now defaults to the
104 call number's owning library.
105 * Fixes display issues with the Print Item Labels page.
106 * Fixes an issue in which the staff client and the OPAC displayed
107 different counts of available items.
111 We would like to thank the following individuals who contributed code,
112 tests and documentation patches to the 3.0.11 point release of
132 This release contains bug fixes improving on Evergreen 3.0.9. Note that
133 all bug fixes refer to the web staff client unless otherwise specified.
138 * Fixes right-click issues with the Web client grids
139 * Fixes an issue with the Default SMS Carrier in the patron edit form.
140 * Fixes an issue that allowed overdue notices to be sent to a patron
141 whose long overdue item has been paid for.
142 * Checking in precat items now displays the "Route to Cataloging" alert each
143 time the item is checked in.
144 * Fixes an issue in which the Adjust to Zero feature
145 does not close a checked-in lost circ.
146 * Deleted copies that are still checked out can now be checked in.
147 * Fixes a mislabeled column in the patron checkout grid.
148 * Fixes an error with the missing pieces functionality.
149 * Courier codes now display in the transit slip receipt preview.
150 * The Item Status grid now displays OU shortnames instead of full names
151 for the "Circulation Library" column.
152 * The Volume/Copy editor now allows users to remove a value from the Age
153 Hold Protection field.
154 * Barcode completion now works in copy buckets.
155 * The Z39.50 interface now notices when another record has been marked
157 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
158 the Z39.50 interface.
159 * Fixes a performance issue for the Validate button in the MARC Editor.
160 * Fixes an incorrect close tag in the Print Item Labels toolbar.
161 * Better scoping of copy tags in search results.
162 * Electronic Resource links now open in a new tab.
163 * Fixes an issue with the fiscal year close-out operation.
164 * Improves serials item deletes.
168 We would like to thank the following individuals who contributed code,
169 tests and documentation patches to the 3.0.10 point release of
194 This release contains bug fixes improving on Evergreen 3.0.8. Note that
195 all bug fixes refer to the web staff client unless otherwise specified.
200 * Fixes specific cases in which deleted records appear in search results.
201 * Fixes a performance issue with deleting patrons.
202 * The hold shelf dialog popup now lists the patron's notification
204 * Fixes an issue that prevented editing items when a monograph part
206 * Patron information is now available for use in the bills_current
207 and bills_historical receipt templates.
208 * The browser's "This page may contain unsaved data" warning now
209 appears when users click the update
210 expire date button in a patron account and attempt to navigate away
212 * The holds tab of the patron record now includes a monograph part
214 * The barcode box in the checkout screen
215 no longer hovers above patron record tabs when
216 staff users scroll down.
217 * Fixes an issue with the date of birth in the patron edit scren.
218 * Fixes an issue with the dropdown of billing type options.
219 * The Item Status screen now includes as a floating group column.
223 We would like to thank the following individuals who contributed code,
224 tests and documentation patches to the 3.0.9 point release of
227 * BC Libraries Cooperative
233 * Blake Graham-Henderson
250 This release contains bug fixes improving on Evergreen 3.0.7. Note that
251 all bug fixes refer to the web staff client unless otherwise specified.
259 * The MARC editor now handles 008 fields better.
260 * Adds spaces between subfields when suggesting a call
261 number for a new volume.
262 * MarcXML exports from the MARC Batch Import/Export ->
263 Export Records screen now downloads the file, rather than opening
265 * The Item Status Circulation Library column now displays a
266 shortname rather than the full library name.
267 * The Item Status Remaining Renewals column now displays
269 * The Item Status now has a "Last Renewal Workstation" column
271 * Fixes the circulation counts displayed in Item Status Details.
272 * Fixes an issue where multiple copies with different values for required
273 statistical categories could not be edited and saved in batch.
274 * Add an option to remove floating in the copy editor.
275 * Fixes an issue with the floating dropdown in the copy editor.
276 * Fixes a problem in which the copy template didn't properly copy
278 * Reduces the number of API calls that the MARC Editor requires.
283 * Fixes an issue that prevented the offline patron registration
285 * Fixes an issue with searching patrons by permission group.
286 * The barcodes in the patron search are now clickable.
287 * Staff members can now manually override the patron juvenile
288 flag value, regardless of the patron's date of birth.
289 * Checkboxes on patron registration screen are now properly aligned
291 * The user permission group dropdowns in the patron registration,
292 edit, and search interfaces now have scrollbars.
293 * The date picker on the checkout screen is now hidden unless
294 circ staff activates a specific due date option.
295 * The check-in screen now includes a copy status column.
296 * The Merge Patrons interface now displays the date of birth.
297 * The user bucket screen now displays the Bucket ID.
298 * The payment button on patron bills screen is now inactive if the
299 Payment Received field is blank.
300 * The Bill History receipt now includes a Finish date and a Last
302 * When a patron summary contains an image of the patron,
303 that image tag now has a null alt attribute to remove it from
304 the flow of a screen reader.
305 * Corrects an issue that caused the transit dialog to show the
307 * Corrects an issue with printing transit lists.
308 * "Find another target" on transiting hold no longer leaves the
310 * The images now display to distinguish hold and transit slips.
311 * The Clearable Holds list printout now only shows holds that have
313 * Restores the call number prefix and suffix fields to the holds
315 * The documentation at the top of the hold shelf slip template
317 * The cursor in the in-house use screen now automatically goes
318 to the barcode field.
319 * The in-house use screen now shows a copy status column.
320 * Add support for converting change to patron credit in the patron bills
321 interface, consistent with the XUL feature.
322 * Fixes a bug that caused pickup/request library fields to be
324 * Fixes a bug in the offline org unit tree.
326 Command-line system administration
327 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
329 * The novelist entry in `eg_vhost.conf` includes two new
331 * Corrects an issue with the `--max-sleep` argument on the
332 `action_trigger_runner.pl` support script.
333 * Corrects an issue with how the `eg_pbx_allocator.pl` script
334 detects an existing lock file.
335 * The 3.0.2-3.0.3 upgrade script disables triggers before
336 recalculating bib visibility.
341 * Fixes an issue that caused records with located URIs to be
342 retrieved in Copy Location and Copy Location Group searches.
343 * Fixes an error message that appeared in the search box
344 in the public catalog while placing hold after an advanced search.
345 * Restores the display of copy information for the user's
346 preferred library in the public catalog.
347 * Fixes regression errors in the search results page.
348 * Removes redundant call numbers from the Show More Details
350 * The cast field in the catalog is now taken from the 511 field
351 when first indicator = 1, rather than the 508.
352 * Fixes a display issue caused by editing holds.
357 * Fixes an issue that prevented users from searching for
358 receivable issues using Database ID or ISSN in the Serials
359 Batch Receive interface.
364 * Adds some padding to the bottom of Web Client interfaces.
365 * Logins now honor all org unit timeout settings.
366 * Evergreen will now identify and handle invalid timezones.
367 * Fixes an issue where a column header in some interfaces were automatically
368 highlighted in green when retrieving the interface.
369 * The parts column in the Item Status screen now displays parts data.
375 We would like to thank the following individuals who contributed code,
376 tests and documentation patches to the 3.0.8 point release of
411 This release contains bug fixes improving on Evergreen 3.0.6.
413 * Fixes a performance issue with the Patron Billing History screen and
414 other screens that cause Flattener.pm to re-create joins
416 * Fixes an issue that prevented patron alerts from showing to staff at
418 * Corrects the "Holdable" attribute display on the Item Status detailed
420 * Fixes the ability to delete multiple copies from Item Status.
424 We would like to thank the following individuals who contributed code,
425 tests and documentation patches to the 3.0.7 point release of
439 This release is a security release that fixes cross-site scripting
440 (XSS) vulnerabilities in the Evergreen public catalog. This release
441 also includes several other bugfixes improving on Evergreen 3.0.5.
443 Security Issue: XSS Vulnerability in Public Catalog
444 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
445 This release fixes several cross-site scripting (XSS) vulnerabilities
446 in the public catalog. When upgrading, Evergreen administrators should
447 review whether any of the following templates have been customized
448 or overridden. If so, either the template should be replaced with the
449 stock version or the XSS fix (which entails adding the `| html` filter
450 in several places) applied to the customized version.
452 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
453 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
454 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
456 Note that exploiting the XSS vulnerabilities fixed in this release
457 would require either the ability to create maliciously-constructed
458 MARC bibliographic or holdings records or the ability to set a
459 maliciously constructed organizational unit name.
463 Evergreen 3.0.6 also includes the following changes:
465 * When using 'Selection Lists -> Edit MARC Order Record' in the web
466 staff client, now only one click is required to save the MARC
467 record rather than two.
468 * The volume/copy editor in the web staff client now better handles
469 editing multiple items that have different sets of statistical
470 category values assigned to them.
471 * The act of merging bibliographic records now updates bookbags
472 that referred to the source bibliographic record rather than
473 effectively deleting entries for that record.
474 * Additional columns were added to the Holds Pull List in the
476 * The patron registration form in the web staff client now correctly
477 manages setting user preferences.
478 * An error in a pgTAP unit test was corrected.
482 We would like to thank the following individuals who contributed code,
483 tests and documentation patches to the 3.0.6 security release of
499 This release contains bug fixes improving on Evergreen 3.0.4.
501 * The MARC Editor in the Web staff client now wraps long fields.
502 * The MARC Editor no longer allows catalogers to enter new lines
504 * Fixes an issue that prevented serials items from being deleted or
506 * The Web staff client Check In screen no longer reloads the whole
507 page multiple times each time an item is scanned.
508 * Fixes an issue that displayed the oldest -- rather than the newest
509 -- transit in the Web staff client Item Status page.
510 * Fixes an issue that prevented the reports module from being displayed
512 * Fixes an issue in the Web staff client reports module that caused
513 syntax errors in reports that use virtual fields and joins.
514 * Fixes an issue that prevented several dropdown menus in the Web staff
515 client from activating.
516 * Fixes an issue that created duplicate copy data when copies or
517 volumes with parts were transferred.
518 * Fixes the Trim List feature in the Web staff client Check In screen.
519 * The Item Status grid now displays the Circulation Modifier.
520 * Restores missing data from the Profile column in Place Hold patron
522 * Fixes an issue with the http -> https redirect on Apache 2.4.
523 * Fixes an color contrast accessibility issue in the Web staff
524 client and adds underlining to links in grid cells for added accessibility.
525 * Adds automated regression and unit tests for the Web staff client
527 * Adds a process for spell-checking the official documentation.
528 * Adds a script that simplifies the release process related to translations.
533 We would like to thank the following individuals who contributed code,
534 tests and documentation patches to the 3.0.5 point release of
539 * Blake Graham-Henderson
554 This release contains bug fixes improving on Evergreen 3.0.3:
556 * Fixes a bug that caused all searches limited by shelving location to
558 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
559 rather than the ordering agency's SAN.
560 * Fixes a bug that prevented Safari/iOS users from logging in to the
562 * Fixes a bug that prevented users from using the browse interface.
563 * Fixes a bug in the Item Status List view that caused incorrect due
565 * Approval code is now a required field in the web client's patron
566 credit card payment form.
567 * Fixes a bug with credit card payments that caused a receipt to print
568 showing that the patron paid the bill when the payment had not actually
570 * Fixes a bug that prevented the EDI translator from being installed on
572 * Fixes a bug that caused entries to show up multiple times in the
573 Items Out and Holds tabs in the patron record.
574 * Fixes a bug that caused grids on Bills and Patron Messages
575 screens to not display properly.
576 * The following fields are now available for the Checkout and Items Out
583 ** money_summary.balance_owed
584 ** money_summary.total_paid
585 ** money_summary.total_owed
590 * The following fields are now available on the Bill Payment receipt templates:
600 * Payment type is now a column in the payments tab of the patron record
601 Bill History section.
602 * The "Replace Barcode" function now makes it more difficult for staff
603 members to attempt to create blank patron barcodes.
604 * The patron bills screen now prevents staff members from double-clicking
605 on the Apply Payment button (which otherwise would apply two payments).
606 * Fixes a bug that prevented patrons attached to statistical categories
607 from displaying in the patron search-to-hold dialog.
608 * Fixes a performance issue related to uploading CSV files of barcodes
609 to the item status and patron bucket interfaces.
610 * Fixes several small bugs in the Spanish translation.
611 * Fixes a performance bug related to patrons logging in by barcode.
615 We would like to thank the following individuals who contributed code,
616 tests and documentation patches to the 3.0.4 point release of
638 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
639 update the visibility attributes of all bibs that make use of Located URIs or
640 bib sources. It may take a while to run on large datasets. If it it running
641 too long, it can be canceled and the following psql commands will create and
642 run a script that will perform the same action serially over time without
643 blocking writes to bibs:
646 \o /tmp/luri_visibility_update.sql
647 SELECT 'UPDATE biblio.record_entry SET ' ||
648 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
649 'WHERE id = ' || id || '; SELECT ' || id || ';'
650 FROM biblio.record_entry
652 SELECT DISTINCT cn.record
653 FROM asset.call_number cn
655 AND cn.label = '##URI##'
658 FROM asset.uri_call_number_map m
659 WHERE m.call_number = cn.id
662 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
667 \i /tmp/luri_visibility_update.sql
670 It will output the id of each updated bib so that the script can be killed
671 and then edited to remove completed bibs. The remainder can be run at a
674 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
675 we do NOT update the bib's visibility attributes, as doing so causes a loop
676 and an eventual trigger stack violation. This flag should ONLY be used when
677 forcing reingest of record attributes (NOT visibility attributes), search,
678 facet, and display fields, so if using this flag under normal operation,
679 proceed at your own risk and know that Located URI and bib source changes
680 will not be reflected in the visibility attributes of the record.
684 This release contains several bug fixes improving on Evergreen 3.0.1:
686 * Fixes several issues related to the display of located URIs and records with
687 bib sources in search results.
688 * Setting `opac_visible` to false for a copy location group now hides only
689 the location group itself, rather than also hiding every single copy in the
691 * Fixes a bug that prevented the copy editor from displaying the _fine level_
692 and _loan duration_ fields.
693 * The "Edit Items" grid action in the Item Status interface will now open
694 in the combined volume/copy editor in batch. This makes the behavior
695 consistent with the "Edit Selected Items" grid action in the copy
697 * Staff members are now required to choose a billing type when creating a
698 bill on a user account.
699 * The Web client now provides staff users with an alert and option to
700 override when an item with the Lost and Paid status is checked in.
701 * Fixes a bug where the Web client offline circ interface was not able
702 to set its working location.
703 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
705 * The MARC editor in the Web staff client now presents bib sources in
707 * Both circulation and grocery bills are now printed when a staff user selects
708 a patron account and clicks "Print Bills".
709 * Fixes an issue in the XUL serials interface the "Receive move/selected"
710 action from succeeding.
711 * Fixes a typo in the user password testing interface.
715 We would like to thank the following individuals who contributed code,
716 tests and documentation patches to the 3.0.3 point release of
735 This release contains several bug fixes improving on Evergreen 3.0.1:
737 * Copy templates created in XUL Holdings Maintenance will now be
738 automatically converted and displayed in the web staff client's
740 * The list of report templates now includes a column indicating whether
741 the template was originally created in the XUL staff client or the web
742 staff client; staff need to know this since report templates created in
743 one interface cannot be edited in the other.
744 * Call number prefixes and suffixes are now displayed in various grids
745 in the web staff client, including
746 ** Pending Copy Buckets
748 ** Checkin/Capture Holds
750 ** Patron Bills History
757 ** Bib Record View Holds
759 * Many patron fields have been redacted from the web staff client's patron
760 and record holds grids, leaving patron name, username, and ID.
761 * Fixes two bugs where patron records could fail to be saved upon editing.
762 * The web staff patron editor now better warns staff users about
763 duplicate names, IDs, phone numbers, and email addresses.
764 * Human readable labels are now displayed for certain fields in standing
766 * The patron summary in the web staff client now correctly displays
767 primary and secondary ID values.
768 * The web staff client's billing full details page now displays
769 information about the staff user that created a payment.
770 * The web staff client now requires staff users to explicitly set a
771 billing type when adding a manual bill.
772 * The web staff client's patron bill annotation modal now works.
773 * Patron barcode search completion in the web staff client now allows
774 the user to select from all of the matching patron records.
775 * The Hold Shelf Slip print template in the web staff client now has
776 access to the call number.
777 * The Checkout Receipt print template in the web staff client now can
778 include summary financial information, incuding current balance, total
779 paid on outstanding fines, and total owed.
780 * The web staff print templates for current and historical bills can
781 now include copy barcode and title.
782 * Fixes a bug that resulted in some catalog searches unexpectedly
784 * Fixes a bug that resulted in catalog searches that specify a location
785 limit returning incorrect results.
786 * Fixes a bug where deleted copies could make records visible in the
788 * Fixes a bug where certain queries on copies used in the public catalog
790 * Fixes a bug place a hold request in the public catalog could result
791 in "forgetting" the type and library of the user's previous search.
792 * The web staff client now respects staff user session timeouts, and
793 will log out all open tabs if a user's session has timed out.
794 * The web staff Z39.50 page will now give the staff user an alert if
795 they attempt to import a record with a duplicate TCN.
796 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
797 entries from being deleted.
798 * Fixes a bug that made using the volume/copy editor to change a copy's
800 * The administration interface for hard due dates now ensures that
801 new (or edited) ceiling dates have their time component set to end
802 of day, resolving an issue where ceiling dates would not be applied
803 during the ceiling date itself.
804 * The web staff client can now include dynamic information in browser
805 tab titles, e.g., "Smith, Jane - Checkout".
806 * The Concerto sample data set now includes data allowing for testing
807 placing holds on monographic parts.
808 * Asset merging during bibliographic record merging now correctly
809 recognizes call number prefixes and suffixes and deletes disused
811 * Fixes a bug where displaying user surveys could result in PCRUD
813 * Fixes a bug where pg_restore of an Evergreen database could fail
814 to create certain indexes on the `actor.usr` table.
818 We would like to thank the following individuals who contributed code,
819 tests and documentation patches to the 3.0.2 point release of
850 This release contains several bug fixes improving on Evergreen 3.0.0
852 * Fixes a bug in the web staff client that prevented initials from being
853 stored with copy notes.
854 * Adds billing types that may have been missed by systems that were
855 running Evergreen prior to the 1.4 release.
856 * Fixes a web staff client bug with the CSV export option available from
857 the Import Queue in the MARC Batch Import/Export interface.
858 * Adds the missing copy alert field in the web client's volume/copy
860 * Fixes a bug where the setting to require date of birth in patron
861 registration was not being honored in the web staff client.
862 * Fixes a bug in the web staff client patron registration form where the
863 password wasn't generating from the last four digits of the patron's
865 * Fixes an issue in the web staff client where the complete barcode did
866 not display in some interfaces when partial barcodes were scanned.
867 * Fixes an HTML error in the new copy tags that display on the record
869 * Fixes a web staff client bug where recording a large number of in-house
870 uses at one time doesn't display a confirmation dialog once it hits the
872 * Adds a _Print Full Grid_ action in the web staff client
873 holds pull list to allow staff to print the entire pull list as it
874 displays on the screen. This change also changes the _Export CSV_ action
875 to an _Export Full CSV_ option.
876 * Fixes an issue with the Patron Messages interface that prevented it
877 from saving column configuration changes in the web staff client.
878 * Fixes a bug in the web staff client where a billing prompt did not
879 correctly display after marking an item damaged in those systems that
880 have enabled the setting to bill for damaged items.
881 * Adds an option to the specific due date feature that allows saving
882 that due date until logout. This allows all circulations from a given
883 workstation to be due on the same date.
887 We would like to thank the following individuals who contributed code,
888 tests and documentation patches to the 3.0.1 point release of
910 The minimum version of PostgreSQL required to run Evergreen 3.0 is
911 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
913 Change to Names of Shared Libraries
914 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
915 OpenSRF 3.0 changes how the shared libraries for services written in
916 C are named. If upgrading from an earlier version of Evergreen,
917 `opensrf.xml` should be edited so that shared library file names
918 listed in the `<implementation>` tag start with "lib". For example,
921 ---------------------------------------------------------------------
923 <language>C</language>
924 <implementation>oils_cstore.so</implementation>
925 ---------------------------------------------------------------------
927 should be changed to:
930 ---------------------------------------------------------------------
932 <language>C</language>
933 <implementation>liboils_cstore.so</implementation>
934 ---------------------------------------------------------------------
936 SIP Bugfix Requires SIPServer Upgrade
937 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
939 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
940 crash" requires that you also upgrade SIPServer with the fix for
941 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
942 SIP client problems." This means that if you use SIP2 with Evergreen,
943 you must also upgrade SIPServer to the latest commit in the Git
944 repository. Conversely, if you upgrade SIPServer to the latest commit
945 in Git, you must also upgrade Evergreen or, at least, apply the patch
946 for Launchpad Bug 1542495. These two patches are complementary and
947 cannot be applied independently of one another.
949 `open-ils.auth.login`
950 ~~~~~~~~~~~~~~~~~~~~~
951 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
952 API's in the `opensrf_core.xml` file.
957 ---------------------------------------------------------------------
958 --- a/Open-ILS/examples/opensrf_core.xml.example
959 +++ b/Open-ILS/examples/opensrf_core.xml.example
960 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
962 <match_string>open-ils.auth.authenticate.verify</match_string>
963 <match_string>open-ils.auth.authenticate.complete</match_string>
964 + <match_string>open-ils.auth.login</match_string>
965 <match_string>open-ils.auth_proxy.login</match_string>
966 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
967 <match_string>open-ils.actor.user.password</match_string>
968 ---------------------------------------------------------------------
972 Administrators of Evergreen who use RTL locales and who have customized
973 `style-rtl.css.tt2` should now incorporate their customizations into
976 Multi-Time Zone Installations
977 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
979 For Evergreen consortia that span more than one time zone, the following
980 query will adjust all historical, unaged circulations so
981 that if their due date field is pushed to the end of the day, it is done
982 in the circulating library's time zone, and not the server time zone.
984 It is safe to run this after any change to library time zones.
986 Running this is not required, as no code before this change has
987 depended on the time string of '23:59:59'. It is also not necessary
988 if all of your libraries are in the same time zone, and that time zone
989 is the same as the database's configured time zone.
998 for ou_id in select id from actor.org_unit loop
999 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
1000 if new_tz is not null then
1001 update action.circulation
1002 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
1003 where circ_lib = ou_id
1004 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
1013 Deprecation of XUL staff client
1014 -------------------------------
1015 Starting with the release of 3.0.0, patches that fix XUL bugs will not
1016 be merged into master or backported unless they meet one or more of
1017 the following conditions:
1019 a. the bug is a security issue
1020 b. the bug involves the destruction of data
1021 c. the bug is a regression of functionality in the XUL staff client
1022 introduced by other work done to Evergreen
1024 Under no circumstances will XUL staff client feature enhancements be merged.
1026 This policy will continue through the 3.0.x and 3.1.x maintenance
1027 release cycles, and will become moot upon the release of 3.2.0, when
1028 the XUL staff client is slated to be entirely removed.
1037 Evergreen 3.0 features a new, modern staff client that runs in the web browser
1038 and can be used on desktop and mobile devices. All functional areas of the
1039 system, including circulation, cataloging, acquisitions, serials, reports,
1040 booking, administration, and offline circulation, are available in the new staff
1041 client. Chrome and Firefox are officially supported for use with the web client.
1043 Library staff will no longer need to download separate software to perform most
1044 actions in Evergreen. A Chrome plugin called Hatch will be available as a
1045 separate installation for workstations that require seamless, dialog-free
1046 printing to multiple printers.
1048 In addition to adding more portability and stability, the new staff client also
1049 presents a cleaner and more modern interface for users. By virtue of running in
1050 a browser, actions that users are accustomed to performing on other web sites
1051 should now be available in the Evergreen client.
1053 The old, XUL client will continue to be available to allow for a gradual
1054 transition to the browser-based client, but no new features will be added. The
1055 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
1065 New EDI Order Generator
1066 ^^^^^^^^^^^^^^^^^^^^^^^
1071 . New database tables exist for configuring vendor-specific EDI order
1075 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1077 * `acq.edi_attr_set`
1078 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1080 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1081 the stock configuration found in the JEDI template.
1082 * `acq.edi_attr_set_map`
1083 ** Link between `edi_attr`s and `edi_attr_set`s.
1085 . EDI Attribute Sets are manged via a new (browser client only) configuration
1086 interface at 'Administration -> Acquisitions Administration -> EDI
1089 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1090 is not set, default values will be used. Links between an EDI account
1091 and an attribute set are managed in the EDI Accounts configuration
1094 . Local modifications to the stock EG JEDI template are managed by modifying
1095 and/or adding additional `edi_att_set`s as needed.
1097 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1098 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1100 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1101 definition is no longer required and can be disabled.
1106 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1107 specifies whether PO's generated via the account should be built using
1108 EDI attributes or fall back to traditional JEDI A/T template generation.
1110 This allows sites to activate EDI attributes on a per-account basis, making
1111 it possible to migrate piecemeal to EDI attributes. For the initial roll
1112 out of this new feature, no accounts will be configured to use EDI
1113 attributes by default.
1119 3 Day Courtesy Notice by SMS
1120 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1121 New optional SMS text notification to be sent out 3 days prior to the due
1122 date of any circulating item for patrons who have an SMS text number and
1123 carrier stored in their accounts. This action trigger is disabled by default,
1124 but can be enabled and modified by going into 'Administration -> Local Administration ->
1125 Notifications / Action Triggers'.
1127 You may wish to make use of granularity so that these messages are batched
1128 and sent at the same time each day.
1133 Add Description Field to Circulation and Hold Configuration Entries
1134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1135 The circulation and hold policy configuration rules now each have a
1136 description field. This allows administrators to add comments to
1137 describe the purpose of each rule.
1142 Apache Internal Port Configuration Option
1143 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1144 Apache configuration now supports a new variable which allows admins to
1145 specify the port used by Apache to handle HTTP traffic. The value is
1146 used for HTTP requests routed from Perl handlers back to the same Apache
1147 instance, like added content requests. Use this when running Apache
1148 with a non-standard port, typical with a proxy setup. Defaults to "80".
1151 -------------------------------------------------------------------
1154 PerlSetVar OILSWebInternalHTTPPort "7080"
1157 -------------------------------------------------------------------
1162 Configurable Bib Record Display Fields
1163 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1165 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1166 fields: 'Display Field?' and 'Display XPath'.
1168 When 'Display Field' is set to true, data from the field will be extracted
1169 from each record and added to a new table of display data for each bib
1172 If a value is present in the 'Display XPath' field, this XPath will be
1173 applied to the extracted data *after* the base XPath (from the 'XPath'
1174 field) is applied to each field.
1176 This data acts as a replacement for the various and sundry ways bib record
1177 data is currently extracted, including inline XPath in the TPAC, reporter
1178 views, real-time 'MVR' compilation from MODS, etc. and will be available
1179 to the user interface, notification templates, etc. for rendering bib
1182 The browser client gets a new service 'egBibDisplay' which is capable
1183 of translating the display field data from various formats into
1184 data more suitable for JavaScript usage.
1186 The database gets 3 new views for representing display data in various
1189 * `metabib.flat_display_entry`
1190 ** List of all display fields linked to their configuration.
1191 * `metabib.compressed_display_entry`
1192 ** Same as `metabib.flat_display_entry` except there's one row
1193 per display field type, with 'multi' rows compressed into
1194 JSON arrays. Non-multi fields are represented as JSON
1196 * `metabib.wide_display_entry`
1197 ** Tabular view of display field data, one column per well-known
1198 field. Values are represented JSON, consistent with
1199 `metabib.flat_display_entry`. The view does *not* contain locally
1200 configured display fields, as each field must be encoded in
1201 the view and IDL definition. This is essentially a replacement
1202 for `reporter.simple_record`.
1207 After making changes to display field configuration, it's possible to
1208 reingest only display field data in the database using the following:
1211 ---------------------------------------------------------------------
1212 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1213 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1214 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1215 ---------------------------------------------------------------------
1221 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1222 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1223 The existing permission was incorrectly created with a code of
1224 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1225 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1226 update changes the permission code to match what the event requires.
1232 Hold Targeter V2 Repairs and Improvements
1233 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1234 * Make the batch targeter more resilient to a single-hold failure.
1235 * Additional batch targeter info logging.
1236 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1237 * Removes the confusingly named `--target-all` option
1238 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1239 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1241 New --next-check-interval Option
1242 ++++++++++++++++++++++++++++++++
1243 Specify how long after the current run time the targeter will retarget
1244 the currently affected holds. Applying a specific interval is useful
1245 when the retarget-interval is shorter than the time between targeter
1248 For example, if the targeter is run nightly at midnight with a
1249 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1250 since the holds won't be processed again until 48 hours later. This
1251 ensures that the org unit closed date checks are looking at the correct
1254 This setting overrides the default behavior of calculating the next
1255 retarget time from the retarget-interval.
1257 New --soft-retarget-interval Option
1258 +++++++++++++++++++++++++++++++++++
1259 This is a replacement for (and rebranding of) the `--skip-viable` option.
1260 The new option allows for time-based soft-targeting instead simple binary
1261 on/off soft-targeting.
1263 How soft-targeting works:
1265 * Update hold copy maps for all affected holds
1266 * Holds with viable targets (on the pull list) are otherwise left alone.
1267 * Holds without viable targets are retargeted in the usual manner.
1273 New marc_export --descendants Option
1274 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1276 The `marc_export` script has a new option, `--descendants`. This option
1277 takes one argument of an organizational unit shortname. It works much
1278 like the existing `--library` option except that it is aware of the
1279 org. tree and will export records with holdings at the specified
1280 organizational unit and all of its descendants. This is handy if you
1281 want to export the records for all of the branches of a system. You
1282 can do that by specifying this option and the system's shortname,
1283 instead of specifying multiple `--library` options for each branch.
1285 The `--descendants` option can be repeated, as the `--library` option can.
1286 All of the specified org. units and their descendants will be included
1287 in the output. It can also be combined with individual `--library`
1288 options when necessary.
1293 RTL and LTR Public Catalog Stylesheets Merged
1294 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1295 The RTL stylesheet for the public catalog,
1296 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1297 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1298 template will provide RTL or LTR styles based on the value of
1299 the `rtl` flag of the active locale. An `rtl` variable is also available
1300 in the template to allow the correct style to be chosen.
1305 Miscellaneous Improvements
1306 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1308 * If a filter is in effect in the Library Settings Editor,
1309 the filter will continue to be applied after a user
1310 changes the selected library.
1311 * Copy templates used for serials now correctly link to age
1312 protection rules and MARC item type values (for the
1313 "Circ as Type" field). During upgrade, the database update
1314 will set to NULL any age protection and circ as type fields
1315 in serial copy templates that do not point to defined values.
1320 Obsolete Internal Flag Removed
1321 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1323 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1324 flag was removed from the `config.internal_flags` table. It was
1325 rendered obsolete by the addition of the 3 flags to control the
1326 browse, search, and facet indexing.
1331 Tweaks to Caching/Expiry of Public Catalog Assets
1332 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1333 The default cache expiration time for static assets (e.g.,
1334 CSS, image, and JavaScript files) in the public catalog and
1335 the Kid's PAC has been increased to one year. Links to all
1336 such assets now have a cache-busting value tacked on as a
1337 query parameter. This value is refreshed when `autogen.sh` is
1338 run, but it can also be manually set by adjusting the
1339 `ctx.cache_key` Template Toolkit variable.
1344 Action/Trigger Events Data Purging
1345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1347 Action/Trigger event definitions have a new field called 'Retention
1348 Interval'. When an optional interval value is applied, events and
1349 template output data linked to the event definition will be deleted
1350 from the database once they reach the specified age.
1352 Retention Interval Restrictions for Passive Hooks
1353 +++++++++++++++++++++++++++++++++++++++++++++++++
1355 Restrictions are placed on retention interval values for event definitions
1356 using passive hooks to prevent data from being deleted while it's still
1357 needed by the system.
1359 The presence of event data is how the system knows not to send duplicate
1360 events. As long as a scenario exists where a duplicate event may be
1361 generated, the events must be retained.
1363 To apply a retention interval value to a passive-hook event definition:
1365 * The event definition must have a max_delay value.
1366 * The retention interval must be larger than the difference between
1367 the `delay` and `max_delay` values.
1369 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1370 interval must be greater than 3 days to ensure no duplicate events are
1371 created between the first event on day 7 and the end of the event validity
1377 A new `purge_at_events.sh` script is installed in the bin directory
1378 (typically `/openils/bin`) which should be added to CRON for regular
1381 NOTE: On large data sets, this script can take a long time to run and
1382 create higher than normal I/O load as it churns though the event and
1383 event_output tables. You may wish to run the script by hand the first
1384 time so it can be monitored. It can be run in psql like so:
1387 ---------------------------------------------------------------
1388 SELECT action_trigger.purge_events();
1389 ---------------------------------------------------------------
1391 NOTE: On *very* large data sets (10s to 100s of millions of event and
1392 event_output rows), it may be advisable to first repopulate the `event`
1393 and `event_output` tables with only the desired data before starting
1394 regular purges. This can be done, for example, using the copy to temp
1395 table, truncate source table, repopulate source table from temp table
1396 approach. This will be much faster than the `purge_events()` function
1397 in cases where most of the data will be purged.
1402 A number of `action_trigger.hook` entries which have always been treated
1403 as active hooks, though are configured as passive hooks, have been
1404 updated to properly reflect the non-passive-ness. This allows for
1405 simpler configuration of their retention interval values.
1411 Remove JSPAC Redirects
1412 ^^^^^^^^^^^^^^^^^^^^^^
1413 Future versions of Evergreen will no longer contain automatic redirects
1414 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1415 that the JSPAC is no longer supported. Existing sites, however, may
1416 wish to retain JSPAC redirects in their Apache configuration files since
1417 JSPAC URLs may still be used in the wild to access their catalogs.
1419 The original JSPAC URL redirects are all retained in the file
1420 `Open-ILS/examples/jspac_redirects.conf` for reference.
1430 New open-ils.auth.login API
1431 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1432 The `open-ils.auth` service has a new API for requesting an authentication
1433 token. It performs the same steps as the
1434 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1435 using the bare password. No intermediate password hashing is required.
1437 The paramaters are the same as the `.complete` call with a few modifications.
1439 1. Using the generic 'identifier' parameter in combination with the
1440 'org' parameter allows the API to reliably determine if an identifier
1441 value is a username or barcode. The caller is no longer required to
1442 make that determination up front.
1444 2. The 'nonce' parameter is no longer used.
1450 Batch Patron Contact Invalidation
1451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1452 The following methods are used to mark patron contact fields
1453 as invalid by moving the invalid value to a standing penalty:
1455 * `open-ils.actor.invalidate.email`
1456 * `open-ils.actor.invalidate.day_phone`
1457 * `open-ils.actor.invalidate.evening_phone`
1458 * `open-ils.actor.invalidate.other_phone`
1460 These methods now accept a fifth argument specifying the value
1461 of the contact field, e.g., a specific phone number or email
1462 address. If supplied, and if a specific patron ID (the first
1463 argument) is not supplied, all patrons with that specific contact
1464 value will have it marked invalid.
1474 Pure-SQL catalog searching
1475 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1476 Public and staff catalog search is now both more accurate and faster
1477 by redesigning how the visibility of records is calculated.
1487 Authority Record and Headings Browse Improvements
1488 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1489 Various improvements are made to support for authority records
1490 and headings browsing:
1492 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1493 headings from authority records. Since the MODS and MADS stylesheets
1494 extract headings in similar ways, duplicate browse entries are now
1495 much less likely to occur.
1496 * A new configuration table, `authority.heading_field`, is now used
1497 to specify how headings should be extracted from authority records.
1498 * Related headings can now be identified as narrower or broader when
1499 browsing in the public catalog.
1500 * See references are now more reliably included in the browse list.
1501 * Scope (public) notes now display only under the main heading.
1502 * There is now a global flag, Display related headings (see-also) in browse,
1503 that can be used to control whether related headings (see-alsos) are
1504 displayed in the public catalog list.
1505 * A complete set of thesauruses are now included in the seed data. Thesauruses
1506 can now be identified using short and long codes.
1507 * The labels for see and see-also references in the public catalog are
1508 a bit more patron-friendly, and can now be tweaked via TPAC template
1509 customization in the browse.tt2 file.
1515 Copy Tags and Digital Bookplates
1516 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1517 Copy tags will allow staff to apply custom, pre-defined labels or tags
1518 to copies. Copy tags are searchable in both the staff client and public
1519 catalog. This feature was designed to be used for Digital Bookplates to
1520 attach donation or memorial information to copies, but may be used for
1521 broader purposes to tag items.
1523 Each copy tag can either be publicly-visible or visible only to staff.
1524 Copy tags also have types that can be used for restricting catalog
1525 searches on copy tags to particular types.
1527 Copy tags are displayed in the copy table in the record summary page in
1528 the public catalog, and a new library setting can be used to add
1529 a "Digital Bookplate" search field. Copy tags can also be used
1530 as a search filter, e.g.,
1532 * `copy_tag(bookplate, jane smith)`: search for records that have a
1533 copy tag of type 'bookplate' whose value contains 'jane smith'.
1534 * `copy_tag(*, jane smith)`: search for records that have a
1535 copy tag of any type whose value contains 'jane smith'.
1537 All staff-side interfaces related to copy tags exist only in the web
1538 staff client. There are two new administration interfaces for managing
1539 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1540 button for applying copy tags to copies; that interface can also be
1541 used to create new copy tags on the fly. Furthermore, the copy buckets
1542 interface now has an 'Apply Tags' action for assigning tags to groups
1548 Two new permission are included:
1550 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1551 'Administration -> Server Administration -> Copy Tag Types'
1552 * `ADMIN_COPY_TAG`: required to create a new tag under
1553 'Administration -> Local Administration -> Copy Tags'
1555 The existing permission `UPDATE_COPY` controls whether or not a user
1556 can link copies to tags.
1560 A new library setting, 'Enable Digital Bookplate Search', controls
1561 whether to display a 'Digital Bookplate' field in the search index
1562 drop-downs in the catalog. A 'Digital Bookplate' search will include
1563 all records that have a copy that matches the tag specified by the user.
1564 It should be noted that this library setting does not affect the
1565 display of copy tags on the catalog record summary page.
1570 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1571 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1572 The call number prefix and suffix, when present, are now included in
1573 subfields $k and $m of the 852 field when running `marc_export` with
1574 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1575 server configured to embed item data in 852 fields, the affixes are now
1576 included in subfields $k and $m.
1586 Batch Editing of Patron Records
1587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1588 There is a now a new interface analogous to the Copy Bucket interface
1589 to select and group a set of users into a User Bucket.
1590 The addition of users to a User Bucket is possible from the Patron Search
1591 interface by the use of a new grid Action, and directly on the User Bucket
1592 interface by user barcode. It is also possible to add users to a User
1593 Bucket by uploading a text file that contains a list of user barcodes.
1595 From this interface it is possible to perform a set of specific batch update
1596 operations on user records.
1601 These fields can now be changed in batch via an action on the User Bucket
1602 grid if the staff user has the `UPDATE_USER` permission:
1605 * Primary Permission Group (group application permissions consulted)
1607 * Home Library (`UPDATE_USER` checked against both old and new value)
1608 * Privilege Expiration Date
1609 * Barred flag (`BAR_PATRON` permission consulted)
1610 * Internet Access Level
1612 Changes made in this interface can be rolled back.
1614 As a batch process, rather than a direct edit, this mechanism explicitly skips
1615 processing of Action/Trigger event definitions for user update.
1620 The batch edit mechanism also allows for the batch deletion of user. The staff
1621 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1623 Changes made in this interface can be rolled back.
1625 As a batch process, rather than a direct edit, this mechanism explicitly skips
1626 processing of Action/Trigger event definitions for user deletion.
1628 This mechanism does not use the Purge User functionality, but instead simply
1629 marks the users as deleted.
1631 Editing Statistical Category Entries
1632 ++++++++++++++++++++++++++++++++++++
1634 All users in the bucket can have their Statistical Category Entries
1635 modified. Unlike user data field updates, modification of Statistical
1636 Category Entries is permanent and cannot be rolled back.
1638 As a batch process, rather than a direct edit, this mechanism explicitly skips
1639 processing of Action/Trigger event definitions for user update.
1641 New Service Requirement
1642 +++++++++++++++++++++++
1644 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1645 unused in production. If this service has been removed from the configuration
1646 of a live Evergreen instances, it will need to be added back in order for
1647 batch user editing to succeed.
1652 Honor Timezone of the Acting Library
1653 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1658 * Display day-granular due dates in the circulating library's timezone.
1659 * Only display the date portion of the due date for day-granular circulations.
1660 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1661 * Provide infrastructure for more advanced formatting of timestamps.
1662 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1667 This is a followup to the work done for 2.12, where we added the ability
1668 for the client to specify a timezone in which timestamps should be interpreted
1669 in business logic and the database.
1671 Most specifically, this work focuses on circulation due dates and the closed
1672 date editor. Due dates, where displayed using stock templates (including
1673 receipt templates) and used for fine calculation, are now manipulated in the
1674 library's configured timezone. This is controlled by the new 'lib.timezone'
1675 setting available via the Library Settings Editor, loaded from the server when
1676 required. Additionally, closings are recorded in the library's timezone so that
1677 due date calculation is more accurate. The closed date editor is also
1678 taught how to display closings in the
1679 closed library's timezone. Closed date entries also explicitly record if they
1680 are a full day closing, or a multi-day closing. This significantly simplifies
1681 the editor, and may be useful in other contexts.
1683 To accomplish this, we use the moment.js library and the moment-timezone addon.
1684 This is necessary because the stock AngularJS date filter does not understand
1685 locale-aware timezone values, which are required to support DST. A simple
1686 mapper translates the differences in format values from AngularJS date to
1689 Of special note are a set of new filters used for formatting timestamps under
1690 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1691 filters provide the functionality, and autogrid is enhanced to make use of
1692 these where applicable. egGrid and egGridField are also taught to accept
1693 default and field-specific options for applying date filters. These filters may
1694 be useful in other or related contexts.
1696 The egDueDate filter, used for all existing displays of due date via Angular
1697 code, intentionally interprets timestamps in two different ways WRT timezone,
1698 based on the circulation duration. If the duration is day-granular (that is,
1699 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1700 of seconds) then the date is interpreted as being in the circulation library's
1701 timezone. If it is an hourly loan (any duration that does not meet the
1702 day-granular criterium) then it is instead displayed in the client's timezone,
1703 just as all other timestamps currently are, because of the previous Evergreen
1706 The public catalog is adjusted to always display the due date in the circulating
1707 library's timezone. Because the public catalog displays only the date portion of the due
1708 date field, this difference is currently considered acceptable. If this proves
1709 to be a problem in the future, a minor adjustment can be made to match the
1710 egDueDate filter logic.
1712 Now that due dates are globally stored in the configured timezone of the
1713 circulating library, the automatic adjustment to day-granular due dates needs
1714 to take those timezones into account.
1716 An optional SQL command is provided by the upgrade script to retroactively
1717 adjust existing due dates after library configuration is complete.
1723 Enhancements to Hard Due Date Functionality
1724 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1725 It will now be possible to delete Hard Due Date Values for dates that have
1726 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1727 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1728 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1733 Patron Search by Birth Date
1734 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1735 * Now you can include the patron birth year and/or birth month and/or
1736 birth day when searching for patrons using the web staff client.
1737 * Day and month values are exact matches. E.g. month "1" (or "01")
1738 matches January, "12" matches December.
1739 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1740 1915, 1599, etc. For exact matches use the full 4-digit year.
1744 Patron Search from Place Hold
1745 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1746 This feature allows staff members, when placing a
1747 hold on behalf of a patron in the web staff client, to search for
1748 patrons by names and other searchable patron information, rather than
1749 relying on barcode alone. In particular, after performing a catalog
1750 search or going to a specific bib record and clicking the 'Place Hold'
1751 button, the form now includes a 'Patron Search' button. This button
1752 will open a dialog allowing the staff member search for and select
1758 Retrieve Recent Patrons
1759 ^^^^^^^^^^^^^^^^^^^^^^^
1761 Adds a new library setting 'Number of Retrievable Recent Patrons'
1762 ('ui.staff.max_recent_patrons') that specifies the number of recently
1763 retrieved patrons that can be re-fetched from the staff client.
1765 A value of 0 means no recent patrons can be retrieved.
1766 A value greater than 1 means staff will be able to retrieve multiple
1767 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1769 The default value is 1 for backwards compatibility.
1776 Fuller title in XUL client Simplified Pull List
1777 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1778 The Simplified Pull List in the XUL client will now display subfields 245$n and
1779 $p in the title field. The addition will make it easier for staff to distinguish
1780 between different parts or seasons in a series.
1786 Transit Cancel Time and Terminology Change
1787 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1792 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1793 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1794 are preserved in the database, though still not visible to the end user in the staff client.
1795 This allows for better tracking of when transits are canceled for the purposes of knowing
1796 which staff member canceled the transit, etc.
1798 NOTE: This change may require the re-creation of transit reports to filter out canceled
1799 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1800 Is NULL' will suffice.
1802 "Canceled Transit" Terminology Change
1803 +++++++++++++++++++++++++++++++++++++
1805 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1806 For internal continuity, however, the following permission codes have not changed:
1809 * `ABORT_REMOTE_TRANSIT`
1810 * `ABORT_TRANSIT_ON_LOST`
1811 * `ABORT_TRANSIT_ON_MISSING`
1819 Offline Circulation Available in Web Staff Client
1820 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1821 Offline circulation is now available in the web staff client. In order to use the
1822 offline interface, users must first log into the web staff client, perform
1823 a patron search, select a user from the results, and open the patron editor
1824 interface to collect all the relevent configuration information for the
1825 workstation. In addition, the offline interface available from the Circulation
1826 menu provides a 'Download block list' button for users who are logged in.
1828 As is the case in the old staff client, users can check materials in and out,
1829 renew items, and create new patron accounts while offline. The patron fields
1830 available in the offline patron registration editor are the same ones that
1831 are available to staff when working online.
1835 Add Circ Modifier to Record Detail Page in Staff TPAC
1836 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1837 The circulation modifier field is added to the table of copies to make
1838 more information available to staff without having to open
1845 Date+Time Format Settings for Web Client
1846 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1848 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1849 and adds two settings for use with the webstaff client:
1851 * 'Format Dates with this pattern'
1852 * 'Format Date+Time with this pattern'
1854 These settings use format strings as documented here:
1856 https://docs.angularjs.org/api/ng/filter/date
1858 There is overlap with how the Dojo formats worked, but also some differences.
1860 The original 'Format Dates' and 'Format Times' settings worked together, but the
1861 new settings work independently. Certain field elements will use one, and
1862 certain field elements will use the other. These distinctions are hard-coded
1863 in the various UI templates, with the idea being that timestamp fields in
1864 which the date component alone is sufficient information (for example, date of birth)
1865 will use the 'Format Dates' setting. Fields where the time component is
1866 important (for example, checkout time) will use the 'Format Date+Time' setting.
1868 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1869 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1875 Global Option to Remove Sound for a Specific Event
1876 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1877 A new `nosound.wav` file has been added to the web client. The file can be used
1878 to globally disable audio alerts for a specific event on an Evergreen system.
1880 For example, to silence the alert that sounds after a successful patron search:
1884 mkdir -p /openils/var/web/audio/notifications/success/patron/
1885 cd /openils/var/web/audio/notifications/success/patron/
1886 ln -s ../../nosound.wav by_search.wav
1893 The official Evergreen manual has been split into eight new manuals, each
1894 designed for a specific audience. This new approach is designed to make
1895 the documentation more readable and usable.
1897 The specific audiences for the new manuals are:
1899 * Acquisitions staff
1902 * Public services staff who use the public catalog
1904 * System administrators who use the command line
1905 * System administrators who use the Web client
1906 * System administrators and programmers who wish to integrate Evergreen
1907 with other technologies
1909 All manuals are available at http://docs.evergreen-ils.org
1915 Improvements to ebook API
1916 ^^^^^^^^^^^^^^^^^^^^^^^^^
1918 Evergreen now supports checking out and placing holds on
1919 OverDrive and OneClickdigital ebook titles from within the public
1920 catalog. This is an experimental feature. It is not recommended for production
1921 use without careful testing.
1923 When ebook integration is enabled, a "Check Out E-Item" link will be
1924 displayed when viewing an ebook title from a supported vendor in the
1925 catalog. Clicking on the link allows the user to check out and download
1926 that title from the vendor directly within the catalog.
1928 If no copies are available for the title, a "Place Hold on E-Item" link
1929 is displayed instead, and the user may place a hold on the title. (Note
1930 that some vendors require the user's account to have an email address
1931 before permitting a hold.)
1933 My Account includes the ability to view current ebook checkouts and
1934 holds, download already-checked-out titles, and cancel holds.
1936 For API integration to work, you need to request API access from the
1937 vendor, and the vendor must have a way of authenticating your patrons.
1938 Your Evergreen system also needs to be configured for ebook API
1939 integration, following the instructions in the command line system
1940 administration manual
1943 This feature assumes that you are importing MARC records supplied by the
1944 vendor into your Evergreen system, using Vandelay or some other MARC
1945 import method. This feature does not search the vendor's online
1946 collections or automatically import vendor records into your system; it
1947 merely augments records that are already in Evergreen.
1949 Improvements to Bill Payment Pages
1950 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1951 The bill payment pages in the public catalog have been revamped
1954 * use the term "charges" instead of "fees"
1955 * include images of credit cards accepted
1956 * make the default print receipt template match other itemized receipts;
1957 note that this change is not automatically applied when upgrading.
1958 * display billing type
1959 * add button to pay only selected charges
1960 * reformat the credit card number input page
1966 Clickable Copy Locations
1967 ^^^^^^^^^^^^^^^^^^^^^^^^
1968 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1969 the associated copy location will display as a link in the public catalog summary display.
1970 This link can be useful for retrieving maps or other directions to the copy
1971 location to aid users in finding material.
1976 Download Checkout History CSV Fixed for Large Number of Circulations
1977 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1978 Downloading checkout history as a CSV from My Account has been fixed
1979 for users with a large circulation history. Previously, this would
1980 time out for patrons with more than 100 or so circulations.
1982 This feature no longer uses the action/trigger mechanism and the public catalog
1983 now generates the CSV directly. The old action/trigger code is still
1984 present in the database and should be removed at some point in the
1990 Google Books Preview Rewrite
1991 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1992 The Google Books Preview functionality in record detail pages has been
1993 rewritten to modernize its style and optimize its performance:
1995 * The Dojo JavaScript framework is no longer used, saving approximately
1996 150K of JavaScript and CSS and four network requests per page load.
1997 * The Embedded Viewer is not loaded unless a possible preview is found,
1998 saving more network and memory overhead.
1999 * The Google Books Loader is used to load the Embedded Viewer instead of the
2000 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
2002 * All variables are self-contained and do not pollute the global namespace.
2003 * Event listeners are registered to handle clicks, rather than attaching
2004 `href="javascript:function()"` to <a> elements.
2005 * Book previews are displayed in a panel sized according to the viewport
2006 of the browser, improving its appearance on both mobile and desktop
2008 * The rewritten code is now served up directly from
2009 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
2014 jQuery for the Public Catalog
2015 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2016 This release adds optional support for jQuery in the public catalog. This support
2017 is enabled by setting the `ctx.want_jquery` variable to a true value in the
2018 `config.tt2` template.
2024 New Popularity Parameters
2025 ^^^^^^^^^^^^^^^^^^^^^^^^^
2026 New popularity parameters for in-house use over time and for count of distinct
2027 organizational units that own a title are now available. Evergreen sites
2028 can use these parameters to create new statistical popularity badges for
2029 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
2031 The in-house use parameters will apply a badge to titles that have the most
2032 in-house use activity over time. The organizational unit count parameter
2033 will apply a badge to titles owned by the most number of libraries in a
2034 consortium. Ownership is determined by the copy's circulation library.
2039 Option to Suspend Holds at the Time They are Placed
2040 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2041 Users now have the option to suspend a hold at the same time they place the
2042 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
2043 who want to suspend a hold at the time it is placed. There is also an option
2044 to set the activation date at the same time. This option is also available
2045 when placing holds on a batch of titles from 'My List' and will apply to
2046 all the titles in the batch.
2057 Fix to reporter.classic_current_circ View
2058 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2059 The `reporter.classic_current_circ` view, which is part of some
2060 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
2061 has been fixed to not exclude loans for patrons who do not have a
2062 billing address set. Users of this view should rerun
2063 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
2068 New Report Source Table Allowing Report of "Last" Deleted copy
2069 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2071 This source table allows you to construct a clever aggregate report template
2072 which will report bibliographic IDs where a library or a group of libraries
2073 no longer have a copy attached but *had* a copy attached. This is especially
2074 useful when a holdings sync is required with an external vendor.
2077 Instructions for creating a report template with this source:
2079 * Create a new report template using "Library Holdings Count with Deleted" as the source
2080 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2081 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2082 * Add Circulation Library -> "Organizational Unit ID" to Base Filters, with the Raw Data transform. In the list of Base Filters, change the operator to "In list"
2083 * Add "Bib ID" to Displayed Fields
2084 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2085 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2086 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2089 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2090 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2091 specified date range. Unfortunately the user will have to manually type the date range without the date
2092 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2093 copy and more than two deleted copies."
2098 Add Provider to Provider Note Link
2099 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2100 The Provider reporting source now includes a link to the Provider Note reporting source.
2105 Link ILS User and Working Location Reporting Sources
2106 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2107 The Working Location reporting source now has labels
2108 and it is now linked to the ILS User reporting source, allowing
2109 reports to display or filter on staff working location.
2114 New Circulation Report Source "All Circulation Combined Types"
2115 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2117 This report source will allow you to create a single report template for all of the following:
2120 * In-house uses of non-cataloged items
2122 * Circulations of non-cataloged items
2124 To distinguish between these different types of library use, it's important to display these columns
2125 in your report templates:
2134 Reports Template Searching
2135 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2136 A new form appears along the top of the reports interface for searching
2137 report templates. Once found, typical template actions (e.g. create new
2138 report) are available from within the results interface.
2140 Searches may be performed across selected (visible) folders or all
2141 folders visible to the logged in user.
2143 Searches are case-insensitive, any word order, with left-anchored words.
2144 All searched words must appear in at least one of the searched fields.
2149 * Searching for 'stat cat' matches:
2151 ** statistical category
2152 ** categories, statistical
2153 ** patrons (stat cat)
2154 * Searching for 'stat cat' does not match:
2156 *** both words must be present in the searched field(s)
2158 *** location contains 'cat' but it's not left-anchored.
2163 The templates, reports, and output interfaces now support paging via
2164 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2176 Web Staff Client Serials Module
2177 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2178 The serials module has been ported over to the web staff
2179 client, implementing a unified serials interface that combines
2180 ideas from both the serial control view and alternate serials
2181 control view from the old staff client.
2183 In addition to carrying over functionality that was available
2184 in the old staff client, several new features are included:
2186 * the ability to save prediction pattern codes as templates
2187 that can be shared and reused within an Evergreen database
2188 * a more streamlined interface for managing subscriptions,
2189 distributions, and streams
2190 * it is no longer necessary to create a starting issue in
2191 order to predict a run of issues; the dialog box for
2192 generating a set of predicted issues now lets you specify
2193 the starting point directly.
2194 * the ability to more directly edit MFHDs
2196 The new serials interfaces can be accessed from the record
2197 details page via a Serials drop-down button that links to
2198 a subscription management page, a quick-receive action, and
2199 a MFHD management page. There is also a new 'Serials Administration'
2200 page where prediction pattern and serial copy templates can
2211 SIP Bugfix Changes How Encoding Is Determined in Configuration
2212 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2214 The combined fix for the above mentioned SIP bugs alters the way that
2215 SIPServer looks up the output encoding in the configuration file (typically
2216 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2219 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2220 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2221 3. The +encoding+ element that is a child of the +implementation_config+ element that is itself a child of the +institution+ element of the currently active SIP account.
2222 4. If none of the above exist, then the default encoding (ASCII) is used.
2224 Number 3 is provided to ease the transition to the new code. It is
2225 the current location of the +encoding+ element in the sample
2226 configuration file and as such, where it is likely to be found in
2227 actual files. It is recommended that you alter your configuration to
2228 move this element out of the +implementation_config+ element and into
2229 its parent +institution+ element. Ideally, SIPServer should *not* look into
2230 the implementation config, and this check may be removed at some time
2238 Web Client Acknowledgments
2239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2241 The project to develop a new browser-based web client launched four
2242 years ago at the September 2013 Evergreen developer hack-a-way when the
2243 developer community voted to move away from the XUL client and explore other
2244 platforms. The first web client preview became available in Evergreen 2.7 when
2245 circulation was available in the new platform.
2247 The browser-based client is available due to the work of many coders, testers,
2248 bug reporters, documentors, translators, project managers, spec writers, funders
2249 and other contributors over the past four years.
2251 The Evergreen project would like to acknowledge the following organizations
2252 that funded development of the Web Staff Client:
2255 * British Columbia Libraries Cooperative
2256 * Consortium of Ohio Libraries
2258 * Georgia Public Library Service
2259 * Grand Rapids Public Library
2261 * Kenton County Public Library
2262 * King County Library System
2265 * Pennsylvania Integrated Library System
2266 * Pioneer Library System
2269 The Evergreen project would also like to thank the following individuals who
2270 contributed code, translations, documentation patches, tests, bug reports,
2271 technical specifications, and project management to the Web Staff Client:
2308 * Freddy Enrique Pelayo Huapalla
2334 Evergreen 3.0 Acknowledgments
2335 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2337 The Evergreen project would like to acknowledge the following
2338 organizations that commissioned developments in this release of
2342 * British Columbia Libraries Cooperative (BC Sitka)
2344 * Georgia Public Library Service
2345 * King County Library System
2347 * Pennsylvania Integrated Library System
2348 * Pioneer Library System
2350 We would also like to thank the following individuals who contributed
2351 code, translations, documentation patches, and tests to this release of
2400 We also thank the following organizations whose employees contributed
2403 * British Columba Libraries Cooperative
2407 * Emerald Data Networks, Inc.
2408 * Equinox Open Library Initiative
2410 * Grand Rapids Public Library
2411 * Indiana State Library
2413 * King County Library System
2414 * Lake Agassiz Regional Library
2415 * Laurentian University
2416 * Linn-Benton Community College
2418 * Merrimack Valley Library Consortium
2420 * North of Boston Library Exchange
2421 * Pennsylvania Integrated Library System
2422 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2424 * Traverse Area District Library
2426 We regret any omissions. If a contributor has been inadvertently
2427 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob