1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.10.
9 All bug fixes refer to the web staff client unless otherwise specified.
14 * Several strings are now displayed in the correct translation.
15 * Right clicking in grids results in more intuitive behavior.
16 * Usernames and barcodes containging the _%_ character no longer
17 experience problems logging in.
18 * Fixes cases in which the web client stops loading after the toolbar.
19 * Fixes problems in which using the web client in multiple tabs leads
20 to data inconsistency.
21 * The patron triggered event screen now respects the
22 `circ.staff.max_visible_event_age` library setting.
23 * Fixes an issue which caused an exception to be thrown during
24 non-cataloged item checkout.
25 * Fixes permission issues related to merging users.
26 * The bibliographic record summary now displays the call number that
27 matches the library's classification system.
28 * The copy editor now makes shelving locations visible to catalogers
29 from other libraries as needed.
30 * Once a record is overlayed in the Z39.50 screen, it is no longer
32 * Several fixes to the filters on the Holdings View screen.
33 * Several fixes to how empty volumes are created and displayed.
34 * Fixes to item and call number transfers.
35 * The Item Status "Edited By" column now displays the username of the
36 last user to edit the item, rather than their database ID.
37 * When adding new copies, the circulation library now defaults to the
38 call number's owning library.
39 * Fixes display issues with the Print Item Labels page.
40 * Fixes an issue in which the staff client and the OPAC displayed
41 different counts of available items.
45 We would like to thank the following individuals who contributed code,
46 tests and documentation patches to the 3.0.11 point release of
63 This release contains bug fixes improving on Evergreen 3.0.9. Note that
64 all bug fixes refer to the web staff client unless otherwise specified.
69 * Fixes right-click issues with the Web client grids
70 * Fixes an issue with the Default SMS Carrier in the patron edit form.
71 * Fixes an issue that allowed overdue notices to be sent to a patron
72 whose long overdue item has been paid for.
73 * Checking in precat items now displays the "Route to Cataloging" alert each
74 time the item is checked in.
75 * Fixes an issue in which the Adjust to Zero feature
76 does not close a checked-in lost circ.
77 * Deleted copies that are still checked out can now be checked in.
78 * Fixes a mislabeled column in the patron checkout grid.
79 * Fixes an error with the missing pieces functionality.
80 * Courier codes now display in the transit slip receipt preview.
81 * The Item Status grid now displays OU shortnames instead of full names
82 for the "Circulation Library" column.
83 * The Volume/Copy editor now allows users to remove a value from the Age
84 Hold Protection field.
85 * Barcode completion now works in copy buckets.
86 * The Z39.50 interface now notices when another record has been marked
88 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
90 * Fixes a performance issue for the Validate button in the MARC Editor.
91 * Fixes an incorrect close tag in the Print Item Labels toolbar.
92 * Better scoping of copy tags in search results.
93 * Electronic Resource links now open in a new tab.
94 * Fixes an issue with the fiscal year close-out operation.
95 * Improves serials item deletes.
99 We would like to thank the following individuals who contributed code,
100 tests and documentation patches to the 3.0.10 point release of
125 This release contains bug fixes improving on Evergreen 3.0.8. Note that
126 all bug fixes refer to the web staff client unless otherwise specified.
131 * Fixes specific cases in which deleted records appear in search results.
132 * Fixes a performance issue with deleting patrons.
133 * The hold shelf dialog popup now lists the patron's notification
135 * Fixes an issue that prevented editing items when a monograph part
137 * Patron information is now available for use in the bills_current
138 and bills_historical receipt templates.
139 * The browser's "This page may contain unsaved data" warning now
140 appears when users click the update
141 expire date button in a patron account and attempt to navigate away
143 * The holds tab of the patron record now includes a monograph part
145 * The barcode box in the checkout screen
146 no longer hovers above patron record tabs when
147 staff users scroll down.
148 * Fixes an issue with the date of birth in the patron edit scren.
149 * Fixes an issue with the dropdown of billing type options.
150 * The Item Status screen now includes as a floating group column.
154 We would like to thank the following individuals who contributed code,
155 tests and documentation patches to the 3.0.9 point release of
158 * BC Libraries Cooperative
164 * Blake Graham-Henderson
181 This release contains bug fixes improving on Evergreen 3.0.7. Note that
182 all bug fixes refer to the web staff client unless otherwise specified.
190 * The MARC editor now handles 008 fields better.
191 * Adds spaces between subfields when suggesting a call
192 number for a new volume.
193 * MarcXML exports from the MARC Batch Import/Export ->
194 Export Records screen now downloads the file, rather than opening
196 * The Item Status Circulation Library column now displays a
197 shortname rather than the full library name.
198 * The Item Status Remaining Renewals column now displays
200 * The Item Status now has a "Last Renewal Workstation" column
202 * Fixes the circulation counts displayed in Item Status Details.
203 * Fixes an issue where multiple copies with different values for required
204 statistical categories could not be edited and saved in batch.
205 * Add an option to remove floating in the copy editor.
206 * Fixes an issue with the floating dropdown in the copy editor.
207 * Fixes a problem in which the copy template didn't properly copy
209 * Reduces the number of API calls that the MARC Editor requires.
214 * Fixes an issue that prevented the offline patron registration
216 * Fixes an issue with searching patrons by permission group.
217 * The barcodes in the patron search are now clickable.
218 * Staff members can now manually override the patron juvenile
219 flag value, regardless of the patron's date of birth.
220 * Checkboxes on patron registration screen are now properly aligned
222 * The user permission group dropdowns in the patron registration,
223 edit, and search interfaces now have scrollbars.
224 * The date picker on the checkout screen is now hidden unless
225 circ staff activates a specific due date option.
226 * The check-in screen now includes a copy status column.
227 * The Merge Patrons interface now displays the date of birth.
228 * The user bucket screen now displays the Bucket ID.
229 * The payment button on patron bills screen is now inactive if the
230 Payment Received field is blank.
231 * The Bill History receipt now includes a Finish date and a Last
233 * When a patron summary contains an image of the patron,
234 that image tag now has a null alt attribute to remove it from
235 the flow of a screen reader.
236 * Corrects an issue that caused the transit dialog to show the
238 * Corrects an issue with printing transit lists.
239 * "Find another target" on transiting hold no longer leaves the
241 * The images now display to distinguish hold and transit slips.
242 * The Clearable Holds list printout now only shows holds that have
244 * Restores the call number prefix and suffix fields to the holds
246 * The documentation at the top of the hold shelf slip template
248 * The cursor in the in-house use screen now automatically goes
249 to the barcode field.
250 * The in-house use screen now shows a copy status column.
251 * Add support for converting change to patron credit in the patron bills
252 interface, consistent with the XUL feature.
253 * Fixes a bug that caused pickup/request library fields to be
255 * Fixes a bug in the offline org unit tree.
257 Command-line system administration
258 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
260 * The novelist entry in `eg_vhost.conf` includes two new
262 * Corrects an issue with the `--max-sleep` argument on the
263 `action_trigger_runner.pl` support script.
264 * Corrects an issue with how the `eg_pbx_allocator.pl` script
265 detects an existing lock file.
266 * The 3.0.2-3.0.3 upgrade script disables triggers before
267 recalculating bib visibility.
272 * Fixes an issue that caused records with located URIs to be
273 retrieved in Copy Location and Copy Location Group searches.
274 * Fixes an error message that appeared in the search box
275 in the public catalog while placing hold after an advanced search.
276 * Restores the display of copy information for the user's
277 preferred library in the public catalog.
278 * Fixes regression errors in the search results page.
279 * Removes redundant call numbers from the Show More Details
281 * The cast field in the catalog is now taken from the 511 field
282 when first indicator = 1, rather than the 508.
283 * Fixes a display issue caused by editing holds.
288 * Fixes an issue that prevented users from searching for
289 receivable issues using Database ID or ISSN in the Serials
290 Batch Receive interface.
295 * Adds some padding to the bottom of Web Client interfaces.
296 * Logins now honor all org unit timeout settings.
297 * Evergreen will now identify and handle invalid timezones.
298 * Fixes an issue where a column header in some interfaces were automatically
299 highlighted in green when retrieving the interface.
300 * The parts column in the Item Status screen now displays parts data.
306 We would like to thank the following individuals who contributed code,
307 tests and documentation patches to the 3.0.8 point release of
342 This release contains bug fixes improving on Evergreen 3.0.6.
344 * Fixes a performance issue with the Patron Billing History screen and
345 other screens that cause Flattener.pm to re-create joins
347 * Fixes an issue that prevented patron alerts from showing to staff at
349 * Corrects the "Holdable" attribute display on the Item Status detailed
351 * Fixes the ability to delete multiple copies from Item Status.
355 We would like to thank the following individuals who contributed code,
356 tests and documentation patches to the 3.0.7 point release of
370 This release is a security release that fixes cross-site scripting
371 (XSS) vulnerabilities in the Evergreen public catalog. This release
372 also includes several other bugfixes improving on Evergreen 3.0.5.
374 Security Issue: XSS Vulnerability in Public Catalog
375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
376 This release fixes several cross-site scripting (XSS) vulnerabilities
377 in the public catalog. When upgrading, Evergreen administrators should
378 review whether any of the following templates have been customized
379 or overridden. If so, either the template should be replaced with the
380 stock version or the XSS fix (which entails adding the `| html` filter
381 in several places) applied to the customized version.
383 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
384 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
385 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
387 Note that exploiting the XSS vulnerabilities fixed in this release
388 would require either the ability to create maliciously-constructed
389 MARC bibliographic or holdings records or the ability to set a
390 maliciously constructed organizational unit name.
394 Evergreen 3.0.6 also includes the following changes:
396 * When using 'Selection Lists -> Edit MARC Order Record' in the web
397 staff client, now only one click is required to save the MARC
398 record rather than two.
399 * The volume/copy editor in the web staff client now better handles
400 editing multiple items that have different sets of statistical
401 category values assigned to them.
402 * The act of merging bibliographic records now updates bookbags
403 that referred to the source bibliographic record rather than
404 effectively deleting entries for that record.
405 * Additional columns were added to the Holds Pull List in the
407 * The patron registration form in the web staff client now correctly
408 manages setting user preferences.
409 * An error in a pgTAP unit test was corrected.
413 We would like to thank the following individuals who contributed code,
414 tests and documentation patches to the 3.0.6 security release of
430 This release contains bug fixes improving on Evergreen 3.0.4.
432 * The MARC Editor in the Web staff client now wraps long fields.
433 * The MARC Editor no longer allows catalogers to enter new lines
435 * Fixes an issue that prevented serials items from being deleted or
437 * The Web staff client Check In screen no longer reloads the whole
438 page multiple times each time an item is scanned.
439 * Fixes an issue that displayed the oldest -- rather than the newest
440 -- transit in the Web staff client Item Status page.
441 * Fixes an issue that prevented the reports module from being displayed
443 * Fixes an issue in the Web staff client reports module that caused
444 syntax errors in reports that use virtual fields and joins.
445 * Fixes an issue that prevented several dropdown menus in the Web staff
446 client from activating.
447 * Fixes an issue that created duplicate copy data when copies or
448 volumes with parts were transferred.
449 * Fixes the Trim List feature in the Web staff client Check In screen.
450 * The Item Status grid now displays the Circulation Modifier.
451 * Restores missing data from the Profile column in Place Hold patron
453 * Fixes an issue with the http -> https redirect on Apache 2.4.
454 * Fixes an color contrast accessibility issue in the Web staff
455 client and adds underlining to links in grid cells for added accessibility.
456 * Adds automated regression and unit tests for the Web staff client
458 * Adds a process for spell-checking the official documentation.
459 * Adds a script that simplifies the release process related to translations.
464 We would like to thank the following individuals who contributed code,
465 tests and documentation patches to the 3.0.5 point release of
470 * Blake Graham-Henderson
485 This release contains bug fixes improving on Evergreen 3.0.3:
487 * Fixes a bug that caused all searches limited by shelving location to
489 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
490 rather than the ordering agency's SAN.
491 * Fixes a bug that prevented Safari/iOS users from logging in to the
493 * Fixes a bug that prevented users from using the browse interface.
494 * Fixes a bug in the Item Status List view that caused incorrect due
496 * Approval code is now a required field in the web client's patron
497 credit card payment form.
498 * Fixes a bug with credit card payments that caused a receipt to print
499 showing that the patron paid the bill when the payment had not actually
501 * Fixes a bug that prevented the EDI translator from being installed on
503 * Fixes a bug that caused entries to show up multiple times in the
504 Items Out and Holds tabs in the patron record.
505 * Fixes a bug that caused grids on Bills and Patron Messages
506 screens to not display properly.
507 * The following fields are now available for the Checkout and Items Out
514 ** money_summary.balance_owed
515 ** money_summary.total_paid
516 ** money_summary.total_owed
521 * The following fields are now available on the Bill Payment receipt templates:
531 * Payment type is now a column in the payments tab of the patron record
532 Bill History section.
533 * The "Replace Barcode" function now makes it more difficult for staff
534 members to attempt to create blank patron barcodes.
535 * The patron bills screen now prevents staff members from double-clicking
536 on the Apply Payment button (which otherwise would apply two payments).
537 * Fixes a bug that prevented patrons attached to statistical categories
538 from displaying in the patron search-to-hold dialog.
539 * Fixes a performance issue related to uploading CSV files of barcodes
540 to the item status and patron bucket interfaces.
541 * Fixes several small bugs in the Spanish translation.
542 * Fixes a performance bug related to patrons logging in by barcode.
546 We would like to thank the following individuals who contributed code,
547 tests and documentation patches to the 3.0.4 point release of
569 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
570 update the visibility attributes of all bibs that make use of Located URIs or
571 bib sources. It may take a while to run on large datasets. If it it running
572 too long, it can be canceled and the following psql commands will create and
573 run a script that will perform the same action serially over time without
574 blocking writes to bibs:
577 \o /tmp/luri_visibility_update.sql
578 SELECT 'UPDATE biblio.record_entry SET ' ||
579 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
580 'WHERE id = ' || id || '; SELECT ' || id || ';'
581 FROM biblio.record_entry
583 SELECT DISTINCT cn.record
584 FROM asset.call_number cn
586 AND cn.label = '##URI##'
589 FROM asset.uri_call_number_map m
590 WHERE m.call_number = cn.id
593 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
598 \i /tmp/luri_visibility_update.sql
601 It will output the id of each updated bib so that the script can be killed
602 and then edited to remove completed bibs. The remainder can be run at a
605 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
606 we do NOT update the bib's visibility attributes, as doing so causes a loop
607 and an eventual trigger stack violation. This flag should ONLY be used when
608 forcing reingest of record attributes (NOT visibility attributes), search,
609 facet, and display fields, so if using this flag under normal operation,
610 proceed at your own risk and know that Located URI and bib source changes
611 will not be reflected in the visibility attributes of the record.
615 This release contains several bug fixes improving on Evergreen 3.0.1:
617 * Fixes several issues related to the display of located URIs and records with
618 bib sources in search results.
619 * Setting `opac_visible` to false for a copy location group now hides only
620 the location group itself, rather than also hiding every single copy in the
622 * Fixes a bug that prevented the copy editor from displaying the _fine level_
623 and _loan duration_ fields.
624 * The "Edit Items" grid action in the Item Status interface will now open
625 in the combined volume/copy editor in batch. This makes the behavior
626 consistent with the "Edit Selected Items" grid action in the copy
628 * Staff members are now required to choose a billing type when creating a
629 bill on a user account.
630 * The Web client now provides staff users with an alert and option to
631 override when an item with the Lost and Paid status is checked in.
632 * Fixes a bug where the Web client offline circ interface was not able
633 to set its working location.
634 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
636 * The MARC editor in the Web staff client now presents bib sources in
638 * Both circulation and grocery bills are now printed when a staff user selects
639 a patron account and clicks "Print Bills".
640 * Fixes an issue in the XUL serials interface the "Receive move/selected"
641 action from succeeding.
642 * Fixes a typo in the user password testing interface.
646 We would like to thank the following individuals who contributed code,
647 tests and documentation patches to the 3.0.3 point release of
666 This release contains several bug fixes improving on Evergreen 3.0.1:
668 * Copy templates created in XUL Holdings Maintenance will now be
669 automatically converted and displayed in the web staff client's
671 * The list of report templates now includes a column indicating whether
672 the template was originally created in the XUL staff client or the web
673 staff client; staff need to know this since report templates created in
674 one interface cannot be edited in the other.
675 * Call number prefixes and suffixes are now displayed in various grids
676 in the web staff client, including
677 ** Pending Copy Buckets
679 ** Checkin/Capture Holds
681 ** Patron Bills History
688 ** Bib Record View Holds
690 * Many patron fields have been redacted from the web staff client's patron
691 and record holds grids, leaving patron name, username, and ID.
692 * Fixes two bugs where patron records could fail to be saved upon editing.
693 * The web staff patron editor now better warns staff users about
694 duplicate names, IDs, phone numbers, and email addresses.
695 * Human readable labels are now displayed for certain fields in standing
697 * The patron summary in the web staff client now correctly displays
698 primary and secondary ID values.
699 * The web staff client's billing full details page now displays
700 information about the staff user that created a payment.
701 * The web staff client now requires staff users to explicitly set a
702 billing type when adding a manual bill.
703 * The web staff client's patron bill annotation modal now works.
704 * Patron barcode search completion in the web staff client now allows
705 the user to select from all of the matching patron records.
706 * The Hold Shelf Slip print template in the web staff client now has
707 access to the call number.
708 * The Checkout Receipt print template in the web staff client now can
709 include summary financial information, incuding current balance, total
710 paid on outstanding fines, and total owed.
711 * The web staff print templates for current and historical bills can
712 now include copy barcode and title.
713 * Fixes a bug that resulted in some catalog searches unexpectedly
715 * Fixes a bug that resulted in catalog searches that specify a location
716 limit returning incorrect results.
717 * Fixes a bug where deleted copies could make records visible in the
719 * Fixes a bug where certain queries on copies used in the public catalog
721 * Fixes a bug place a hold request in the public catalog could result
722 in "forgetting" the type and library of the user's previous search.
723 * The web staff client now respects staff user session timeouts, and
724 will log out all open tabs if a user's session has timed out.
725 * The web staff Z39.50 page will now give the staff user an alert if
726 they attempt to import a record with a duplicate TCN.
727 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
728 entries from being deleted.
729 * Fixes a bug that made using the volume/copy editor to change a copy's
731 * The administration interface for hard due dates now ensures that
732 new (or edited) ceiling dates have their time component set to end
733 of day, resolving an issue where ceiling dates would not be applied
734 during the ceiling date itself.
735 * The web staff client can now include dynamic information in browser
736 tab titles, e.g., "Smith, Jane - Checkout".
737 * The Concerto sample data set now includes data allowing for testing
738 placing holds on monographic parts.
739 * Asset merging during bibliographic record merging now correctly
740 recognizes call number prefixes and suffixes and deletes disused
742 * Fixes a bug where displaying user surveys could result in PCRUD
744 * Fixes a bug where pg_restore of an Evergreen database could fail
745 to create certain indexes on the `actor.usr` table.
749 We would like to thank the following individuals who contributed code,
750 tests and documentation patches to the 3.0.2 point release of
781 This release contains several bug fixes improving on Evergreen 3.0.0
783 * Fixes a bug in the web staff client that prevented initials from being
784 stored with copy notes.
785 * Adds billing types that may have been missed by systems that were
786 running Evergreen prior to the 1.4 release.
787 * Fixes a web staff client bug with the CSV export option available from
788 the Import Queue in the MARC Batch Import/Export interface.
789 * Adds the missing copy alert field in the web client's volume/copy
791 * Fixes a bug where the setting to require date of birth in patron
792 registration was not being honored in the web staff client.
793 * Fixes a bug in the web staff client patron registration form where the
794 password wasn't generating from the last four digits of the patron's
796 * Fixes an issue in the web staff client where the complete barcode did
797 not display in some interfaces when partial barcodes were scanned.
798 * Fixes an HTML error in the new copy tags that display on the record
800 * Fixes a web staff client bug where recording a large number of in-house
801 uses at one time doesn't display a confirmation dialog once it hits the
803 * Adds a _Print Full Grid_ action in the web staff client
804 holds pull list to allow staff to print the entire pull list as it
805 displays on the screen. This change also changes the _Export CSV_ action
806 to an _Export Full CSV_ option.
807 * Fixes an issue with the Patron Messages interface that prevented it
808 from saving column configuration changes in the web staff client.
809 * Fixes a bug in the web staff client where a billing prompt did not
810 correctly display after marking an item damaged in those systems that
811 have enabled the setting to bill for damaged items.
812 * Adds an option to the specific due date feature that allows saving
813 that due date until logout. This allows all circulations from a given
814 workstation to be due on the same date.
818 We would like to thank the following individuals who contributed code,
819 tests and documentation patches to the 3.0.1 point release of
841 The minimum version of PostgreSQL required to run Evergreen 3.0 is
842 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
844 Change to Names of Shared Libraries
845 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
846 OpenSRF 3.0 changes how the shared libraries for services written in
847 C are named. If upgrading from an earlier version of Evergreen,
848 `opensrf.xml` should be edited so that shared library file names
849 listed in the `<implementation>` tag start with "lib". For example,
852 ---------------------------------------------------------------------
854 <language>C</language>
855 <implementation>oils_cstore.so</implementation>
856 ---------------------------------------------------------------------
858 should be changed to:
861 ---------------------------------------------------------------------
863 <language>C</language>
864 <implementation>liboils_cstore.so</implementation>
865 ---------------------------------------------------------------------
867 SIP Bugfix Requires SIPServer Upgrade
868 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
870 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
871 crash" requires that you also upgrade SIPServer with the fix for
872 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
873 SIP client problems." This means that if you use SIP2 with Evergreen,
874 you must also upgrade SIPServer to the latest commit in the Git
875 repository. Conversely, if you upgrade SIPServer to the latest commit
876 in Git, you must also upgrade Evergreen or, at least, apply the patch
877 for Launchpad Bug 1542495. These two patches are complementary and
878 cannot be applied independently of one another.
880 `open-ils.auth.login`
881 ~~~~~~~~~~~~~~~~~~~~~
882 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
883 API's in the `opensrf_core.xml` file.
888 ---------------------------------------------------------------------
889 --- a/Open-ILS/examples/opensrf_core.xml.example
890 +++ b/Open-ILS/examples/opensrf_core.xml.example
891 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
893 <match_string>open-ils.auth.authenticate.verify</match_string>
894 <match_string>open-ils.auth.authenticate.complete</match_string>
895 + <match_string>open-ils.auth.login</match_string>
896 <match_string>open-ils.auth_proxy.login</match_string>
897 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
898 <match_string>open-ils.actor.user.password</match_string>
899 ---------------------------------------------------------------------
903 Administrators of Evergreen who use RTL locales and who have customized
904 `style-rtl.css.tt2` should now incorporate their customizations into
907 Multi-Time Zone Installations
908 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
910 For Evergreen consortia that span more than one time zone, the following
911 query will adjust all historical, unaged circulations so
912 that if their due date field is pushed to the end of the day, it is done
913 in the circulating library's time zone, and not the server time zone.
915 It is safe to run this after any change to library time zones.
917 Running this is not required, as no code before this change has
918 depended on the time string of '23:59:59'. It is also not necessary
919 if all of your libraries are in the same time zone, and that time zone
920 is the same as the database's configured time zone.
929 for ou_id in select id from actor.org_unit loop
930 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
931 if new_tz is not null then
932 update action.circulation
933 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
934 where circ_lib = ou_id
935 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
944 Deprecation of XUL staff client
945 -------------------------------
946 Starting with the release of 3.0.0, patches that fix XUL bugs will not
947 be merged into master or backported unless they meet one or more of
948 the following conditions:
950 a. the bug is a security issue
951 b. the bug involves the destruction of data
952 c. the bug is a regression of functionality in the XUL staff client
953 introduced by other work done to Evergreen
955 Under no circumstances will XUL staff client feature enhancements be merged.
957 This policy will continue through the 3.0.x and 3.1.x maintenance
958 release cycles, and will become moot upon the release of 3.2.0, when
959 the XUL staff client is slated to be entirely removed.
968 Evergreen 3.0 features a new, modern staff client that runs in the web browser
969 and can be used on desktop and mobile devices. All functional areas of the
970 system, including circulation, cataloging, acquisitions, serials, reports,
971 booking, administration, and offline circulation, are available in the new staff
972 client. Chrome and Firefox are officially supported for use with the web client.
974 Library staff will no longer need to download separate software to perform most
975 actions in Evergreen. A Chrome plugin called Hatch will be available as a
976 separate installation for workstations that require seamless, dialog-free
977 printing to multiple printers.
979 In addition to adding more portability and stability, the new staff client also
980 presents a cleaner and more modern interface for users. By virtue of running in
981 a browser, actions that users are accustomed to performing on other web sites
982 should now be available in the Evergreen client.
984 The old, XUL client will continue to be available to allow for a gradual
985 transition to the browser-based client, but no new features will be added. The
986 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
996 New EDI Order Generator
997 ^^^^^^^^^^^^^^^^^^^^^^^
1002 . New database tables exist for configuring vendor-specific EDI order
1006 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1008 * `acq.edi_attr_set`
1009 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1011 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1012 the stock configuration found in the JEDI template.
1013 * `acq.edi_attr_set_map`
1014 ** Link between `edi_attr`s and `edi_attr_set`s.
1016 . EDI Attribute Sets are manged via a new (browser client only) configuration
1017 interface at 'Administration -> Acquisitions Administration -> EDI
1020 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1021 is not set, default values will be used. Links between an EDI account
1022 and an attribute set are managed in the EDI Accounts configuration
1025 . Local modifications to the stock EG JEDI template are managed by modifying
1026 and/or adding additional `edi_att_set`s as needed.
1028 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1029 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1031 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1032 definition is no longer required and can be disabled.
1037 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1038 specifies whether PO's generated via the account should be built using
1039 EDI attributes or fall back to traditional JEDI A/T template generation.
1041 This allows sites to activate EDI attributes on a per-account basis, making
1042 it possible to migrate piecemeal to EDI attributes. For the initial roll
1043 out of this new feature, no accounts will be configured to use EDI
1044 attributes by default.
1050 3 Day Courtesy Notice by SMS
1051 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1052 New optional SMS text notification to be sent out 3 days prior to the due
1053 date of any circulating item for patrons who have an SMS text number and
1054 carrier stored in their accounts. This action trigger is disabled by default,
1055 but can be enabled and modified by going into 'Administration -> Local Administration ->
1056 Notifications / Action Triggers'.
1058 You may wish to make use of granularity so that these messages are batched
1059 and sent at the same time each day.
1064 Add Description Field to Circulation and Hold Configuration Entries
1065 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1066 The circulation and hold policy configuration rules now each have a
1067 description field. This allows administrators to add comments to
1068 describe the purpose of each rule.
1073 Apache Internal Port Configuration Option
1074 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1075 Apache configuration now supports a new variable which allows admins to
1076 specify the port used by Apache to handle HTTP traffic. The value is
1077 used for HTTP requests routed from Perl handlers back to the same Apache
1078 instance, like added content requests. Use this when running Apache
1079 with a non-standard port, typical with a proxy setup. Defaults to "80".
1082 -------------------------------------------------------------------
1085 PerlSetVar OILSWebInternalHTTPPort "7080"
1088 -------------------------------------------------------------------
1093 Configurable Bib Record Display Fields
1094 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1096 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1097 fields: 'Display Field?' and 'Display XPath'.
1099 When 'Display Field' is set to true, data from the field will be extracted
1100 from each record and added to a new table of display data for each bib
1103 If a value is present in the 'Display XPath' field, this XPath will be
1104 applied to the extracted data *after* the base XPath (from the 'XPath'
1105 field) is applied to each field.
1107 This data acts as a replacement for the various and sundry ways bib record
1108 data is currently extracted, including inline XPath in the TPAC, reporter
1109 views, real-time 'MVR' compilation from MODS, etc. and will be available
1110 to the user interface, notification templates, etc. for rendering bib
1113 The browser client gets a new service 'egBibDisplay' which is capable
1114 of translating the display field data from various formats into
1115 data more suitable for JavaScript usage.
1117 The database gets 3 new views for representing display data in various
1120 * `metabib.flat_display_entry`
1121 ** List of all display fields linked to their configuration.
1122 * `metabib.compressed_display_entry`
1123 ** Same as `metabib.flat_display_entry` except there's one row
1124 per display field type, with 'multi' rows compressed into
1125 JSON arrays. Non-multi fields are represented as JSON
1127 * `metabib.wide_display_entry`
1128 ** Tabular view of display field data, one column per well-known
1129 field. Values are represented JSON, consistent with
1130 `metabib.flat_display_entry`. The view does *not* contain locally
1131 configured display fields, as each field must be encoded in
1132 the view and IDL definition. This is essentially a replacement
1133 for `reporter.simple_record`.
1138 After making changes to display field configuration, it's possible to
1139 reingest only display field data in the database using the following:
1142 ---------------------------------------------------------------------
1143 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1144 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1145 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1146 ---------------------------------------------------------------------
1152 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1153 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1154 The existing permission was incorrectly created with a code of
1155 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1156 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1157 update changes the permission code to match what the event requires.
1163 Hold Targeter V2 Repairs and Improvements
1164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1165 * Make the batch targeter more resilient to a single-hold failure.
1166 * Additional batch targeter info logging.
1167 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1168 * Removes the confusingly named `--target-all` option
1169 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1170 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1172 New --next-check-interval Option
1173 ++++++++++++++++++++++++++++++++
1174 Specify how long after the current run time the targeter will retarget
1175 the currently affected holds. Applying a specific interval is useful
1176 when the retarget-interval is shorter than the time between targeter
1179 For example, if the targeter is run nightly at midnight with a
1180 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1181 since the holds won't be processed again until 48 hours later. This
1182 ensures that the org unit closed date checks are looking at the correct
1185 This setting overrides the default behavior of calculating the next
1186 retarget time from the retarget-interval.
1188 New --soft-retarget-interval Option
1189 +++++++++++++++++++++++++++++++++++
1190 This is a replacement for (and rebranding of) the `--skip-viable` option.
1191 The new option allows for time-based soft-targeting instead simple binary
1192 on/off soft-targeting.
1194 How soft-targeting works:
1196 * Update hold copy maps for all affected holds
1197 * Holds with viable targets (on the pull list) are otherwise left alone.
1198 * Holds without viable targets are retargeted in the usual manner.
1204 New marc_export --descendants Option
1205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1207 The `marc_export` script has a new option, `--descendants`. This option
1208 takes one argument of an organizational unit shortname. It works much
1209 like the existing `--library` option except that it is aware of the
1210 org. tree and will export records with holdings at the specified
1211 organizational unit and all of its descendants. This is handy if you
1212 want to export the records for all of the branches of a system. You
1213 can do that by specifying this option and the system's shortname,
1214 instead of specifying multiple `--library` options for each branch.
1216 The `--descendants` option can be repeated, as the `--library` option can.
1217 All of the specified org. units and their descendants will be included
1218 in the output. It can also be combined with individual `--library`
1219 options when necessary.
1224 RTL and LTR Public Catalog Stylesheets Merged
1225 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1226 The RTL stylesheet for the public catalog,
1227 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1228 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1229 template will provide RTL or LTR styles based on the value of
1230 the `rtl` flag of the active locale. An `rtl` variable is also available
1231 in the template to allow the correct style to be chosen.
1236 Miscellaneous Improvements
1237 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1239 * If a filter is in effect in the Library Settings Editor,
1240 the filter will continue to be applied after a user
1241 changes the selected library.
1242 * Copy templates used for serials now correctly link to age
1243 protection rules and MARC item type values (for the
1244 "Circ as Type" field). During upgrade, the database update
1245 will set to NULL any age protection and circ as type fields
1246 in serial copy templates that do not point to defined values.
1251 Obsolete Internal Flag Removed
1252 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1254 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1255 flag was removed from the `config.internal_flags` table. It was
1256 rendered obsolete by the addition of the 3 flags to control the
1257 browse, search, and facet indexing.
1262 Tweaks to Caching/Expiry of Public Catalog Assets
1263 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1264 The default cache expiration time for static assets (e.g.,
1265 CSS, image, and JavaScript files) in the public catalog and
1266 the Kid's PAC has been increased to one year. Links to all
1267 such assets now have a cache-busting value tacked on as a
1268 query parameter. This value is refreshed when `autogen.sh` is
1269 run, but it can also be manually set by adjusting the
1270 `ctx.cache_key` Template Toolkit variable.
1275 Action/Trigger Events Data Purging
1276 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1278 Action/Trigger event definitions have a new field called 'Retention
1279 Interval'. When an optional interval value is applied, events and
1280 template output data linked to the event definition will be deleted
1281 from the database once they reach the specified age.
1283 Retention Interval Restrictions for Passive Hooks
1284 +++++++++++++++++++++++++++++++++++++++++++++++++
1286 Restrictions are placed on retention interval values for event definitions
1287 using passive hooks to prevent data from being deleted while it's still
1288 needed by the system.
1290 The presence of event data is how the system knows not to send duplicate
1291 events. As long as a scenario exists where a duplicate event may be
1292 generated, the events must be retained.
1294 To apply a retention interval value to a passive-hook event definition:
1296 * The event definition must have a max_delay value.
1297 * The retention interval must be larger than the difference between
1298 the `delay` and `max_delay` values.
1300 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1301 interval must be greater than 3 days to ensure no duplicate events are
1302 created between the first event on day 7 and the end of the event validity
1308 A new `purge_at_events.sh` script is installed in the bin directory
1309 (typically `/openils/bin`) which should be added to CRON for regular
1312 NOTE: On large data sets, this script can take a long time to run and
1313 create higher than normal I/O load as it churns though the event and
1314 event_output tables. You may wish to run the script by hand the first
1315 time so it can be monitored. It can be run in psql like so:
1318 ---------------------------------------------------------------
1319 SELECT action_trigger.purge_events();
1320 ---------------------------------------------------------------
1322 NOTE: On *very* large data sets (10s to 100s of millions of event and
1323 event_output rows), it may be advisable to first repopulate the `event`
1324 and `event_output` tables with only the desired data before starting
1325 regular purges. This can be done, for example, using the copy to temp
1326 table, truncate source table, repopulate source table from temp table
1327 approach. This will be much faster than the `purge_events()` function
1328 in cases where most of the data will be purged.
1333 A number of `action_trigger.hook` entries which have always been treated
1334 as active hooks, though are configured as passive hooks, have been
1335 updated to properly reflect the non-passive-ness. This allows for
1336 simpler configuration of their retention interval values.
1342 Remove JSPAC Redirects
1343 ^^^^^^^^^^^^^^^^^^^^^^
1344 Future versions of Evergreen will no longer contain automatic redirects
1345 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1346 that the JSPAC is no longer supported. Existing sites, however, may
1347 wish to retain JSPAC redirects in their Apache configuration files since
1348 JSPAC URLs may still be used in the wild to access their catalogs.
1350 The original JSPAC URL redirects are all retained in the file
1351 `Open-ILS/examples/jspac_redirects.conf` for reference.
1361 New open-ils.auth.login API
1362 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1363 The `open-ils.auth` service has a new API for requesting an authentication
1364 token. It performs the same steps as the
1365 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1366 using the bare password. No intermediate password hashing is required.
1368 The paramaters are the same as the `.complete` call with a few modifications.
1370 1. Using the generic 'identifier' parameter in combination with the
1371 'org' parameter allows the API to reliably determine if an identifier
1372 value is a username or barcode. The caller is no longer required to
1373 make that determination up front.
1375 2. The 'nonce' parameter is no longer used.
1381 Batch Patron Contact Invalidation
1382 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1383 The following methods are used to mark patron contact fields
1384 as invalid by moving the invalid value to a standing penalty:
1386 * `open-ils.actor.invalidate.email`
1387 * `open-ils.actor.invalidate.day_phone`
1388 * `open-ils.actor.invalidate.evening_phone`
1389 * `open-ils.actor.invalidate.other_phone`
1391 These methods now accept a fifth argument specifying the value
1392 of the contact field, e.g., a specific phone number or email
1393 address. If supplied, and if a specific patron ID (the first
1394 argument) is not supplied, all patrons with that specific contact
1395 value will have it marked invalid.
1405 Pure-SQL catalog searching
1406 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1407 Public and staff catalog search is now both more accurate and faster
1408 by redesigning how the visibility of records is calculated.
1418 Authority Record and Headings Browse Improvements
1419 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1420 Various improvements are made to support for authority records
1421 and headings browsing:
1423 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1424 headings from authority records. Since the MODS and MADS stylesheets
1425 extract headings in similar ways, duplicate browse entries are now
1426 much less likely to occur.
1427 * A new configuration table, `authority.heading_field`, is now used
1428 to specify how headings should be extracted from authority records.
1429 * Related headings can now be identified as narrower or broader when
1430 browsing in the public catalog.
1431 * See references are now more reliably included in the browse list.
1432 * Scope (public) notes now display only under the main heading.
1433 * There is now a global flag, Display related headings (see-also) in browse,
1434 that can be used to control whether related headings (see-alsos) are
1435 displayed in the public catalog list.
1436 * A complete set of thesauruses are now included in the seed data. Thesauruses
1437 can now be identified using short and long codes.
1438 * The labels for see and see-also references in the public catalog are
1439 a bit more patron-friendly, and can now be tweaked via TPAC template
1440 customization in the browse.tt2 file.
1446 Copy Tags and Digital Bookplates
1447 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1448 Copy tags will allow staff to apply custom, pre-defined labels or tags
1449 to copies. Copy tags are searchable in both the staff client and public
1450 catalog. This feature was designed to be used for Digital Bookplates to
1451 attach donation or memorial information to copies, but may be used for
1452 broader purposes to tag items.
1454 Each copy tag can either be publicly-visible or visible only to staff.
1455 Copy tags also have types that can be used for restricting catalog
1456 searches on copy tags to particular types.
1458 Copy tags are displayed in the copy table in the record summary page in
1459 the public catalog, and a new library setting can be used to add
1460 a "Digital Bookplate" search field. Copy tags can also be used
1461 as a search filter, e.g.,
1463 * `copy_tag(bookplate, jane smith)`: search for records that have a
1464 copy tag of type 'bookplate' whose value contains 'jane smith'.
1465 * `copy_tag(*, jane smith)`: search for records that have a
1466 copy tag of any type whose value contains 'jane smith'.
1468 All staff-side interfaces related to copy tags exist only in the web
1469 staff client. There are two new administration interfaces for managing
1470 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1471 button for applying copy tags to copies; that interface can also be
1472 used to create new copy tags on the fly. Furthermore, the copy buckets
1473 interface now has an 'Apply Tags' action for assigning tags to groups
1479 Two new permission are included:
1481 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1482 'Administration -> Server Administration -> Copy Tag Types'
1483 * `ADMIN_COPY_TAG`: required to create a new tag under
1484 'Administration -> Local Administration -> Copy Tags'
1486 The existing permission `UPDATE_COPY` controls whether or not a user
1487 can link copies to tags.
1491 A new library setting, 'Enable Digital Bookplate Search', controls
1492 whether to display a 'Digital Bookplate' field in the search index
1493 drop-downs in the catalog. A 'Digital Bookplate' search will include
1494 all records that have a copy that matches the tag specified by the user.
1495 It should be noted that this library setting does not affect the
1496 display of copy tags on the catalog record summary page.
1501 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1502 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1503 The call number prefix and suffix, when present, are now included in
1504 subfields $k and $m of the 852 field when running `marc_export` with
1505 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1506 server configured to embed item data in 852 fields, the affixes are now
1507 included in subfields $k and $m.
1517 Batch Editing of Patron Records
1518 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1519 There is a now a new interface analogous to the Copy Bucket interface
1520 to select and group a set of users into a User Bucket.
1521 The addition of users to a User Bucket is possible from the Patron Search
1522 interface by the use of a new grid Action, and directly on the User Bucket
1523 interface by user barcode. It is also possible to add users to a User
1524 Bucket by uploading a text file that contains a list of user barcodes.
1526 From this interface it is possible to perform a set of specific batch update
1527 operations on user records.
1532 These fields can now be changed in batch via an action on the User Bucket
1533 grid if the staff user has the `UPDATE_USER` permission:
1536 * Primary Permission Group (group application permissions consulted)
1538 * Home Library (`UPDATE_USER` checked against both old and new value)
1539 * Privilege Expiration Date
1540 * Barred flag (`BAR_PATRON` permission consulted)
1541 * Internet Access Level
1543 Changes made in this interface can be rolled back.
1545 As a batch process, rather than a direct edit, this mechanism explicitly skips
1546 processing of Action/Trigger event definitions for user update.
1551 The batch edit mechanism also allows for the batch deletion of user. The staff
1552 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1554 Changes made in this interface can be rolled back.
1556 As a batch process, rather than a direct edit, this mechanism explicitly skips
1557 processing of Action/Trigger event definitions for user deletion.
1559 This mechanism does not use the Purge User functionality, but instead simply
1560 marks the users as deleted.
1562 Editing Statistical Category Entries
1563 ++++++++++++++++++++++++++++++++++++
1565 All users in the bucket can have their Statistical Category Entries
1566 modified. Unlike user data field updates, modification of Statistical
1567 Category Entries is permanent and cannot be rolled back.
1569 As a batch process, rather than a direct edit, this mechanism explicitly skips
1570 processing of Action/Trigger event definitions for user update.
1572 New Service Requirement
1573 +++++++++++++++++++++++
1575 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1576 unused in production. If this service has been removed from the configuration
1577 of a live Evergreen instances, it will need to be added back in order for
1578 batch user editing to succeed.
1583 Honor Timezone of the Acting Library
1584 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1589 * Display day-granular due dates in the circulating library's timezone.
1590 * Only display the date portion of the due date for day-granular circulations.
1591 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1592 * Provide infrastructure for more advanced formatting of timestamps.
1593 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1598 This is a followup to the work done for 2.12, where we added the ability
1599 for the client to specify a timezone in which timestamps should be interpreted
1600 in business logic and the database.
1602 Most specifically, this work focuses on circulation due dates and the closed
1603 date editor. Due dates, where displayed using stock templates (including
1604 receipt templates) and used for fine calculation, are now manipulated in the
1605 library's configured timezone. This is controlled by the new 'lib.timezone'
1606 setting available via the Library Settings Editor, loaded from the server when
1607 required. Additionally, closings are recorded in the library's timezone so that
1608 due date calculation is more accurate. The closed date editor is also
1609 taught how to display closings in the
1610 closed library's timezone. Closed date entries also explicitly record if they
1611 are a full day closing, or a multi-day closing. This significantly simplifies
1612 the editor, and may be useful in other contexts.
1614 To accomplish this, we use the moment.js library and the moment-timezone addon.
1615 This is necessary because the stock AngularJS date filter does not understand
1616 locale-aware timezone values, which are required to support DST. A simple
1617 mapper translates the differences in format values from AngularJS date to
1620 Of special note are a set of new filters used for formatting timestamps under
1621 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1622 filters provide the functionality, and autogrid is enhanced to make use of
1623 these where applicable. egGrid and egGridField are also taught to accept
1624 default and field-specific options for applying date filters. These filters may
1625 be useful in other or related contexts.
1627 The egDueDate filter, used for all existing displays of due date via Angular
1628 code, intentionally interprets timestamps in two different ways WRT timezone,
1629 based on the circulation duration. If the duration is day-granular (that is,
1630 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1631 of seconds) then the date is interpreted as being in the circulation library's
1632 timezone. If it is an hourly loan (any duration that does not meet the
1633 day-granular criterium) then it is instead displayed in the client's timezone,
1634 just as all other timestamps currently are, because of the previous Evergreen
1637 The public catalog is adjusted to always display the due date in the circulating
1638 library's timezone. Because the public catalog displays only the date portion of the due
1639 date field, this difference is currently considered acceptable. If this proves
1640 to be a problem in the future, a minor adjustment can be made to match the
1641 egDueDate filter logic.
1643 Now that due dates are globally stored in the configured timezone of the
1644 circulating library, the automatic adjustment to day-granular due dates needs
1645 to take those timezones into account.
1647 An optional SQL command is provided by the upgrade script to retroactively
1648 adjust existing due dates after library configuration is complete.
1654 Enhancements to Hard Due Date Functionality
1655 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1656 It will now be possible to delete Hard Due Date Values for dates that have
1657 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1658 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1659 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1664 Patron Search by Birth Date
1665 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1666 * Now you can include the patron birth year and/or birth month and/or
1667 birth day when searching for patrons using the web staff client.
1668 * Day and month values are exact matches. E.g. month "1" (or "01")
1669 matches January, "12" matches December.
1670 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1671 1915, 1599, etc. For exact matches use the full 4-digit year.
1675 Patron Search from Place Hold
1676 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1677 This feature allows staff members, when placing a
1678 hold on behalf of a patron in the web staff client, to search for
1679 patrons by names and other searchable patron information, rather than
1680 relying on barcode alone. In particular, after performing a catalog
1681 search or going to a specific bib record and clicking the 'Place Hold'
1682 button, the form now includes a 'Patron Search' button. This button
1683 will open a dialog allowing the staff member search for and select
1689 Retrieve Recent Patrons
1690 ^^^^^^^^^^^^^^^^^^^^^^^
1692 Adds a new library setting 'Number of Retrievable Recent Patrons'
1693 ('ui.staff.max_recent_patrons') that specifies the number of recently
1694 retrieved patrons that can be re-fetched from the staff client.
1696 A value of 0 means no recent patrons can be retrieved.
1697 A value greater than 1 means staff will be able to retrieve multiple
1698 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1700 The default value is 1 for backwards compatibility.
1707 Fuller title in XUL client Simplified Pull List
1708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1709 The Simplified Pull List in the XUL client will now display subfields 245$n and
1710 $p in the title field. The addition will make it easier for staff to distinguish
1711 between different parts or seasons in a series.
1717 Transit Cancel Time and Terminology Change
1718 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1723 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1724 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1725 are preserved in the database, though still not visible to the end user in the staff client.
1726 This allows for better tracking of when transits are canceled for the purposes of knowing
1727 which staff member canceled the transit, etc.
1729 NOTE: This change may require the re-creation of transit reports to filter out canceled
1730 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1731 Is NULL' will suffice.
1733 "Canceled Transit" Terminology Change
1734 +++++++++++++++++++++++++++++++++++++
1736 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1737 For internal continuity, however, the following permission codes have not changed:
1740 * `ABORT_REMOTE_TRANSIT`
1741 * `ABORT_TRANSIT_ON_LOST`
1742 * `ABORT_TRANSIT_ON_MISSING`
1750 Offline Circulation Available in Web Staff Client
1751 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1752 Offline circulation is now available in the web staff client. In order to use the
1753 offline interface, users must first log into the web staff client, perform
1754 a patron search, select a user from the results, and open the patron editor
1755 interface to collect all the relevent configuration information for the
1756 workstation. In addition, the offline interface available from the Circulation
1757 menu provides a 'Download block list' button for users who are logged in.
1759 As is the case in the old staff client, users can check materials in and out,
1760 renew items, and create new patron accounts while offline. The patron fields
1761 available in the offline patron registration editor are the same ones that
1762 are available to staff when working online.
1766 Add Circ Modifier to Record Detail Page in Staff TPAC
1767 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1768 The circulation modifier field is added to the table of copies to make
1769 more information available to staff without having to open
1776 Date+Time Format Settings for Web Client
1777 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1779 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1780 and adds two settings for use with the webstaff client:
1782 * 'Format Dates with this pattern'
1783 * 'Format Date+Time with this pattern'
1785 These settings use format strings as documented here:
1787 https://docs.angularjs.org/api/ng/filter/date
1789 There is overlap with how the Dojo formats worked, but also some differences.
1791 The original 'Format Dates' and 'Format Times' settings worked together, but the
1792 new settings work independently. Certain field elements will use one, and
1793 certain field elements will use the other. These distinctions are hard-coded
1794 in the various UI templates, with the idea being that timestamp fields in
1795 which the date component alone is sufficient information (for example, date of birth)
1796 will use the 'Format Dates' setting. Fields where the time component is
1797 important (for example, checkout time) will use the 'Format Date+Time' setting.
1799 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1800 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1806 Global Option to Remove Sound for a Specific Event
1807 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1808 A new `nosound.wav` file has been added to the web client. The file can be used
1809 to globally disable audio alerts for a specific event on an Evergreen system.
1811 For example, to silence the alert that sounds after a successful patron search:
1815 mkdir -p /openils/var/web/audio/notifications/success/patron/
1816 cd /openils/var/web/audio/notifications/success/patron/
1817 ln -s ../../nosound.wav by_search.wav
1824 The official Evergreen manual has been split into eight new manuals, each
1825 designed for a specific audience. This new approach is designed to make
1826 the documentation more readable and usable.
1828 The specific audiences for the new manuals are:
1830 * Acquisitions staff
1833 * Public services staff who use the public catalog
1835 * System administrators who use the command line
1836 * System administrators who use the Web client
1837 * System administrators and programmers who wish to integrate Evergreen
1838 with other technologies
1840 All manuals are available at http://docs.evergreen-ils.org
1846 Improvements to ebook API
1847 ^^^^^^^^^^^^^^^^^^^^^^^^^
1849 Evergreen now supports checking out and placing holds on
1850 OverDrive and OneClickdigital ebook titles from within the public
1851 catalog. This is an experimental feature. It is not recommended for production
1852 use without careful testing.
1854 When ebook integration is enabled, a "Check Out E-Item" link will be
1855 displayed when viewing an ebook title from a supported vendor in the
1856 catalog. Clicking on the link allows the user to check out and download
1857 that title from the vendor directly within the catalog.
1859 If no copies are available for the title, a "Place Hold on E-Item" link
1860 is displayed instead, and the user may place a hold on the title. (Note
1861 that some vendors require the user's account to have an email address
1862 before permitting a hold.)
1864 My Account includes the ability to view current ebook checkouts and
1865 holds, download already-checked-out titles, and cancel holds.
1867 For API integration to work, you need to request API access from the
1868 vendor, and the vendor must have a way of authenticating your patrons.
1869 Your Evergreen system also needs to be configured for ebook API
1870 integration, following the instructions in the command line system
1871 administration manual
1874 This feature assumes that you are importing MARC records supplied by the
1875 vendor into your Evergreen system, using Vandelay or some other MARC
1876 import method. This feature does not search the vendor's online
1877 collections or automatically import vendor records into your system; it
1878 merely augments records that are already in Evergreen.
1880 Improvements to Bill Payment Pages
1881 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1882 The bill payment pages in the public catalog have been revamped
1885 * use the term "charges" instead of "fees"
1886 * include images of credit cards accepted
1887 * make the default print receipt template match other itemized receipts;
1888 note that this change is not automatically applied when upgrading.
1889 * display billing type
1890 * add button to pay only selected charges
1891 * reformat the credit card number input page
1897 Clickable Copy Locations
1898 ^^^^^^^^^^^^^^^^^^^^^^^^
1899 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1900 the associated copy location will display as a link in the public catalog summary display.
1901 This link can be useful for retrieving maps or other directions to the copy
1902 location to aid users in finding material.
1907 Download Checkout History CSV Fixed for Large Number of Circulations
1908 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1909 Downloading checkout history as a CSV from My Account has been fixed
1910 for users with a large circulation history. Previously, this would
1911 time out for patrons with more than 100 or so circulations.
1913 This feature no longer uses the action/trigger mechanism and the public catalog
1914 now generates the CSV directly. The old action/trigger code is still
1915 present in the database and should be removed at some point in the
1921 Google Books Preview Rewrite
1922 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1923 The Google Books Preview functionality in record detail pages has been
1924 rewritten to modernize its style and optimize its performance:
1926 * The Dojo JavaScript framework is no longer used, saving approximately
1927 150K of JavaScript and CSS and four network requests per page load.
1928 * The Embedded Viewer is not loaded unless a possible preview is found,
1929 saving more network and memory overhead.
1930 * The Google Books Loader is used to load the Embedded Viewer instead of the
1931 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1933 * All variables are self-contained and do not pollute the global namespace.
1934 * Event listeners are registered to handle clicks, rather than attaching
1935 `href="javascript:function()"` to <a> elements.
1936 * Book previews are displayed in a panel sized according to the viewport
1937 of the browser, improving its appearance on both mobile and desktop
1939 * The rewritten code is now served up directly from
1940 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1945 jQuery for the Public Catalog
1946 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1947 This release adds optional support for jQuery in the public catalog. This support
1948 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1949 `config.tt2` template.
1955 New Popularity Parameters
1956 ^^^^^^^^^^^^^^^^^^^^^^^^^
1957 New popularity parameters for in-house use over time and for count of distinct
1958 organizational units that own a title are now available. Evergreen sites
1959 can use these parameters to create new statistical popularity badges for
1960 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1962 The in-house use parameters will apply a badge to titles that have the most
1963 in-house use activity over time. The organizational unit count parameter
1964 will apply a badge to titles owned by the most number of libraries in a
1965 consortium. Ownership is determined by the copy's circulation library.
1970 Option to Suspend Holds at the Time They are Placed
1971 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1972 Users now have the option to suspend a hold at the same time they place the
1973 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1974 who want to suspend a hold at the time it is placed. There is also an option
1975 to set the activation date at the same time. This option is also available
1976 when placing holds on a batch of titles from 'My List' and will apply to
1977 all the titles in the batch.
1988 Fix to reporter.classic_current_circ View
1989 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1990 The `reporter.classic_current_circ` view, which is part of some
1991 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1992 has been fixed to not exclude loans for patrons who do not have a
1993 billing address set. Users of this view should rerun
1994 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1999 New Report Source Table Allowing Report of "Last" Deleted copy
2000 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2002 This source table allows you to construct a clever aggregate report template
2003 which will report bibliographic IDs where a library or a group of libraries
2004 no longer have a copy attached but *had* a copy attached. This is especially
2005 useful when a holdings sync is required with an external vendor.
2008 Instructions for creating a report template with this source:
2010 * Create a new report template using "Library Holdings Count with Deleted" as the source
2011 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2012 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2013 * 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"
2014 * Add "Bib ID" to Displayed Fields
2015 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2016 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2017 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2020 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2021 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2022 specified date range. Unfortunately the user will have to manually type the date range without the date
2023 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2024 copy and more than two deleted copies."
2029 Add Provider to Provider Note Link
2030 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2031 The Provider reporting source now includes a link to the Provider Note reporting source.
2036 Link ILS User and Working Location Reporting Sources
2037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2038 The Working Location reporting source now has labels
2039 and it is now linked to the ILS User reporting source, allowing
2040 reports to display or filter on staff working location.
2045 New Circulation Report Source "All Circulation Combined Types"
2046 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2048 This report source will allow you to create a single report template for all of the following:
2051 * In-house uses of non-cataloged items
2053 * Circulations of non-cataloged items
2055 To distinguish between these different types of library use, it's important to display these columns
2056 in your report templates:
2065 Reports Template Searching
2066 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2067 A new form appears along the top of the reports interface for searching
2068 report templates. Once found, typical template actions (e.g. create new
2069 report) are available from within the results interface.
2071 Searches may be performed across selected (visible) folders or all
2072 folders visible to the logged in user.
2074 Searches are case-insensitive, any word order, with left-anchored words.
2075 All searched words must appear in at least one of the searched fields.
2080 * Searching for 'stat cat' matches:
2082 ** statistical category
2083 ** categories, statistical
2084 ** patrons (stat cat)
2085 * Searching for 'stat cat' does not match:
2087 *** both words must be present in the searched field(s)
2089 *** location contains 'cat' but it's not left-anchored.
2094 The templates, reports, and output interfaces now support paging via
2095 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2107 Web Staff Client Serials Module
2108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2109 The serials module has been ported over to the web staff
2110 client, implementing a unified serials interface that combines
2111 ideas from both the serial control view and alternate serials
2112 control view from the old staff client.
2114 In addition to carrying over functionality that was available
2115 in the old staff client, several new features are included:
2117 * the ability to save prediction pattern codes as templates
2118 that can be shared and reused within an Evergreen database
2119 * a more streamlined interface for managing subscriptions,
2120 distributions, and streams
2121 * it is no longer necessary to create a starting issue in
2122 order to predict a run of issues; the dialog box for
2123 generating a set of predicted issues now lets you specify
2124 the starting point directly.
2125 * the ability to more directly edit MFHDs
2127 The new serials interfaces can be accessed from the record
2128 details page via a Serials drop-down button that links to
2129 a subscription management page, a quick-receive action, and
2130 a MFHD management page. There is also a new 'Serials Administration'
2131 page where prediction pattern and serial copy templates can
2142 SIP Bugfix Changes How Encoding Is Determined in Configuration
2143 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2145 The combined fix for the above mentioned SIP bugs alters the way that
2146 SIPServer looks up the output encoding in the configuration file (typically
2147 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2150 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2151 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2152 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.
2153 4. If none of the above exist, then the default encoding (ASCII) is used.
2155 Number 3 is provided to ease the transition to the new code. It is
2156 the current location of the +encoding+ element in the sample
2157 configuration file and as such, where it is likely to be found in
2158 actual files. It is recommended that you alter your configuration to
2159 move this element out of the +implementation_config+ element and into
2160 its parent +institution+ element. Ideally, SIPServer should *not* look into
2161 the implementation config, and this check may be removed at some time
2169 Web Client Acknowledgments
2170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2172 The project to develop a new browser-based web client launched four
2173 years ago at the September 2013 Evergreen developer hack-a-way when the
2174 developer community voted to move away from the XUL client and explore other
2175 platforms. The first web client preview became available in Evergreen 2.7 when
2176 circulation was available in the new platform.
2178 The browser-based client is available due to the work of many coders, testers,
2179 bug reporters, documentors, translators, project managers, spec writers, funders
2180 and other contributors over the past four years.
2182 The Evergreen project would like to acknowledge the following organizations
2183 that funded development of the Web Staff Client:
2186 * British Columbia Libraries Cooperative
2187 * Consortium of Ohio Libraries
2189 * Georgia Public Library Service
2190 * Grand Rapids Public Library
2192 * Kenton County Public Library
2193 * King County Library System
2196 * Pennsylvania Integrated Library System
2197 * Pioneer Library System
2200 The Evergreen project would also like to thank the following individuals who
2201 contributed code, translations, documentation patches, tests, bug reports,
2202 technical specifications, and project management to the Web Staff Client:
2239 * Freddy Enrique Pelayo Huapalla
2265 Evergreen 3.0 Acknowledgments
2266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2268 The Evergreen project would like to acknowledge the following
2269 organizations that commissioned developments in this release of
2273 * British Columbia Libraries Cooperative (BC Sitka)
2275 * Georgia Public Library Service
2276 * King County Library System
2278 * Pennsylvania Integrated Library System
2279 * Pioneer Library System
2281 We would also like to thank the following individuals who contributed
2282 code, translations, documentation patches, and tests to this release of
2331 We also thank the following organizations whose employees contributed
2334 * British Columba Libraries Cooperative
2338 * Emerald Data Networks, Inc.
2339 * Equinox Open Library Initiative
2341 * Grand Rapids Public Library
2342 * Indiana State Library
2344 * King County Library System
2345 * Lake Agassiz Regional Library
2346 * Laurentian University
2347 * Linn-Benton Community College
2349 * Merrimack Valley Library Consortium
2351 * North of Boston Library Exchange
2352 * Pennsylvania Integrated Library System
2353 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2355 * Traverse Area District Library
2357 We regret any omissions. If a contributor has been inadvertently
2358 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob