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 * Fixes an issue that caused authentication session checks to spam
22 the system and needlessly fill up logs.
23 * Boolean fields within grid views now say "Yes"/"No" instead of
25 * Fixes sorting issues in the patron search.
26 * Staff can now choose to print out only a selection of items out,
27 instead of having to print them all.
28 * The patron triggered event screen now respects the
29 `circ.staff.max_visible_event_age` library setting.
30 * Fixes an issue which caused an exception to be thrown during
31 non-cataloged item checkout.
32 * Fixes permission issues related to merging users.
33 * The bibliographic record summary now displays the call number that
34 matches the library's classification system.
35 * The copy editor now makes shelving locations visible to catalogers
36 from other libraries as needed.
37 * Once a record is overlayed in the Z39.50 screen, it is no longer
39 * Several fixes to the filters on the Holdings View screen.
40 * Several fixes to how empty volumes are created and displayed.
41 * Fixes to item and call number transfers.
42 * Fixes several issues with the item status list view.
43 * When adding new copies, the circulation library now defaults to the
44 call number's owning library.
45 * Fixes display issues with the Print Item Labels page.
46 * Fixes an issue in which the staff client and the OPAC displayed
47 different counts of available items.
51 We would like to thank the following individuals who contributed code,
52 tests and documentation patches to the 3.0.11 point release of
72 This release contains bug fixes improving on Evergreen 3.0.9. Note that
73 all bug fixes refer to the web staff client unless otherwise specified.
78 * Fixes right-click issues with the Web client grids
79 * Fixes an issue with the Default SMS Carrier in the patron edit form.
80 * Fixes an issue that allowed overdue notices to be sent to a patron
81 whose long overdue item has been paid for.
82 * Checking in precat items now displays the "Route to Cataloging" alert each
83 time the item is checked in.
84 * Fixes an issue in which the Adjust to Zero feature
85 does not close a checked-in lost circ.
86 * Deleted copies that are still checked out can now be checked in.
87 * Fixes a mislabeled column in the patron checkout grid.
88 * Fixes an error with the missing pieces functionality.
89 * Courier codes now display in the transit slip receipt preview.
90 * The Item Status grid now displays OU shortnames instead of full names
91 for the "Circulation Library" column.
92 * The Volume/Copy editor now allows users to remove a value from the Age
93 Hold Protection field.
94 * Barcode completion now works in copy buckets.
95 * The Z39.50 interface now notices when another record has been marked
97 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
99 * Fixes a performance issue for the Validate button in the MARC Editor.
100 * Fixes an incorrect close tag in the Print Item Labels toolbar.
101 * Better scoping of copy tags in search results.
102 * Electronic Resource links now open in a new tab.
103 * Fixes an issue with the fiscal year close-out operation.
104 * Improves serials item deletes.
108 We would like to thank the following individuals who contributed code,
109 tests and documentation patches to the 3.0.10 point release of
134 This release contains bug fixes improving on Evergreen 3.0.8. Note that
135 all bug fixes refer to the web staff client unless otherwise specified.
140 * Fixes specific cases in which deleted records appear in search results.
141 * Fixes a performance issue with deleting patrons.
142 * The hold shelf dialog popup now lists the patron's notification
144 * Fixes an issue that prevented editing items when a monograph part
146 * Patron information is now available for use in the bills_current
147 and bills_historical receipt templates.
148 * The browser's "This page may contain unsaved data" warning now
149 appears when users click the update
150 expire date button in a patron account and attempt to navigate away
152 * The holds tab of the patron record now includes a monograph part
154 * The barcode box in the checkout screen
155 no longer hovers above patron record tabs when
156 staff users scroll down.
157 * Fixes an issue with the date of birth in the patron edit scren.
158 * Fixes an issue with the dropdown of billing type options.
159 * The Item Status screen now includes as a floating group column.
163 We would like to thank the following individuals who contributed code,
164 tests and documentation patches to the 3.0.9 point release of
167 * BC Libraries Cooperative
173 * Blake Graham-Henderson
190 This release contains bug fixes improving on Evergreen 3.0.7. Note that
191 all bug fixes refer to the web staff client unless otherwise specified.
199 * The MARC editor now handles 008 fields better.
200 * Adds spaces between subfields when suggesting a call
201 number for a new volume.
202 * MarcXML exports from the MARC Batch Import/Export ->
203 Export Records screen now downloads the file, rather than opening
205 * The Item Status Circulation Library column now displays a
206 shortname rather than the full library name.
207 * The Item Status Remaining Renewals column now displays
209 * The Item Status now has a "Last Renewal Workstation" column
211 * Fixes the circulation counts displayed in Item Status Details.
212 * Fixes an issue where multiple copies with different values for required
213 statistical categories could not be edited and saved in batch.
214 * Add an option to remove floating in the copy editor.
215 * Fixes an issue with the floating dropdown in the copy editor.
216 * Fixes a problem in which the copy template didn't properly copy
218 * Reduces the number of API calls that the MARC Editor requires.
223 * Fixes an issue that prevented the offline patron registration
225 * Fixes an issue with searching patrons by permission group.
226 * The barcodes in the patron search are now clickable.
227 * Staff members can now manually override the patron juvenile
228 flag value, regardless of the patron's date of birth.
229 * Checkboxes on patron registration screen are now properly aligned
231 * The user permission group dropdowns in the patron registration,
232 edit, and search interfaces now have scrollbars.
233 * The date picker on the checkout screen is now hidden unless
234 circ staff activates a specific due date option.
235 * The check-in screen now includes a copy status column.
236 * The Merge Patrons interface now displays the date of birth.
237 * The user bucket screen now displays the Bucket ID.
238 * The payment button on patron bills screen is now inactive if the
239 Payment Received field is blank.
240 * The Bill History receipt now includes a Finish date and a Last
242 * When a patron summary contains an image of the patron,
243 that image tag now has a null alt attribute to remove it from
244 the flow of a screen reader.
245 * Corrects an issue that caused the transit dialog to show the
247 * Corrects an issue with printing transit lists.
248 * "Find another target" on transiting hold no longer leaves the
250 * The images now display to distinguish hold and transit slips.
251 * The Clearable Holds list printout now only shows holds that have
253 * Restores the call number prefix and suffix fields to the holds
255 * The documentation at the top of the hold shelf slip template
257 * The cursor in the in-house use screen now automatically goes
258 to the barcode field.
259 * The in-house use screen now shows a copy status column.
260 * Add support for converting change to patron credit in the patron bills
261 interface, consistent with the XUL feature.
262 * Fixes a bug that caused pickup/request library fields to be
264 * Fixes a bug in the offline org unit tree.
266 Command-line system administration
267 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
269 * The novelist entry in `eg_vhost.conf` includes two new
271 * Corrects an issue with the `--max-sleep` argument on the
272 `action_trigger_runner.pl` support script.
273 * Corrects an issue with how the `eg_pbx_allocator.pl` script
274 detects an existing lock file.
275 * The 3.0.2-3.0.3 upgrade script disables triggers before
276 recalculating bib visibility.
281 * Fixes an issue that caused records with located URIs to be
282 retrieved in Copy Location and Copy Location Group searches.
283 * Fixes an error message that appeared in the search box
284 in the public catalog while placing hold after an advanced search.
285 * Restores the display of copy information for the user's
286 preferred library in the public catalog.
287 * Fixes regression errors in the search results page.
288 * Removes redundant call numbers from the Show More Details
290 * The cast field in the catalog is now taken from the 511 field
291 when first indicator = 1, rather than the 508.
292 * Fixes a display issue caused by editing holds.
297 * Fixes an issue that prevented users from searching for
298 receivable issues using Database ID or ISSN in the Serials
299 Batch Receive interface.
304 * Adds some padding to the bottom of Web Client interfaces.
305 * Logins now honor all org unit timeout settings.
306 * Evergreen will now identify and handle invalid timezones.
307 * Fixes an issue where a column header in some interfaces were automatically
308 highlighted in green when retrieving the interface.
309 * The parts column in the Item Status screen now displays parts data.
315 We would like to thank the following individuals who contributed code,
316 tests and documentation patches to the 3.0.8 point release of
351 This release contains bug fixes improving on Evergreen 3.0.6.
353 * Fixes a performance issue with the Patron Billing History screen and
354 other screens that cause Flattener.pm to re-create joins
356 * Fixes an issue that prevented patron alerts from showing to staff at
358 * Corrects the "Holdable" attribute display on the Item Status detailed
360 * Fixes the ability to delete multiple copies from Item Status.
364 We would like to thank the following individuals who contributed code,
365 tests and documentation patches to the 3.0.7 point release of
379 This release is a security release that fixes cross-site scripting
380 (XSS) vulnerabilities in the Evergreen public catalog. This release
381 also includes several other bugfixes improving on Evergreen 3.0.5.
383 Security Issue: XSS Vulnerability in Public Catalog
384 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
385 This release fixes several cross-site scripting (XSS) vulnerabilities
386 in the public catalog. When upgrading, Evergreen administrators should
387 review whether any of the following templates have been customized
388 or overridden. If so, either the template should be replaced with the
389 stock version or the XSS fix (which entails adding the `| html` filter
390 in several places) applied to the customized version.
392 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
393 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
394 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
396 Note that exploiting the XSS vulnerabilities fixed in this release
397 would require either the ability to create maliciously-constructed
398 MARC bibliographic or holdings records or the ability to set a
399 maliciously constructed organizational unit name.
403 Evergreen 3.0.6 also includes the following changes:
405 * When using 'Selection Lists -> Edit MARC Order Record' in the web
406 staff client, now only one click is required to save the MARC
407 record rather than two.
408 * The volume/copy editor in the web staff client now better handles
409 editing multiple items that have different sets of statistical
410 category values assigned to them.
411 * The act of merging bibliographic records now updates bookbags
412 that referred to the source bibliographic record rather than
413 effectively deleting entries for that record.
414 * Additional columns were added to the Holds Pull List in the
416 * The patron registration form in the web staff client now correctly
417 manages setting user preferences.
418 * An error in a pgTAP unit test was corrected.
422 We would like to thank the following individuals who contributed code,
423 tests and documentation patches to the 3.0.6 security release of
439 This release contains bug fixes improving on Evergreen 3.0.4.
441 * The MARC Editor in the Web staff client now wraps long fields.
442 * The MARC Editor no longer allows catalogers to enter new lines
444 * Fixes an issue that prevented serials items from being deleted or
446 * The Web staff client Check In screen no longer reloads the whole
447 page multiple times each time an item is scanned.
448 * Fixes an issue that displayed the oldest -- rather than the newest
449 -- transit in the Web staff client Item Status page.
450 * Fixes an issue that prevented the reports module from being displayed
452 * Fixes an issue in the Web staff client reports module that caused
453 syntax errors in reports that use virtual fields and joins.
454 * Fixes an issue that prevented several dropdown menus in the Web staff
455 client from activating.
456 * Fixes an issue that created duplicate copy data when copies or
457 volumes with parts were transferred.
458 * Fixes the Trim List feature in the Web staff client Check In screen.
459 * The Item Status grid now displays the Circulation Modifier.
460 * Restores missing data from the Profile column in Place Hold patron
462 * Fixes an issue with the http -> https redirect on Apache 2.4.
463 * Fixes an color contrast accessibility issue in the Web staff
464 client and adds underlining to links in grid cells for added accessibility.
465 * Adds automated regression and unit tests for the Web staff client
467 * Adds a process for spell-checking the official documentation.
468 * Adds a script that simplifies the release process related to translations.
473 We would like to thank the following individuals who contributed code,
474 tests and documentation patches to the 3.0.5 point release of
479 * Blake Graham-Henderson
494 This release contains bug fixes improving on Evergreen 3.0.3:
496 * Fixes a bug that caused all searches limited by shelving location to
498 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
499 rather than the ordering agency's SAN.
500 * Fixes a bug that prevented Safari/iOS users from logging in to the
502 * Fixes a bug that prevented users from using the browse interface.
503 * Fixes a bug in the Item Status List view that caused incorrect due
505 * Approval code is now a required field in the web client's patron
506 credit card payment form.
507 * Fixes a bug with credit card payments that caused a receipt to print
508 showing that the patron paid the bill when the payment had not actually
510 * Fixes a bug that prevented the EDI translator from being installed on
512 * Fixes a bug that caused entries to show up multiple times in the
513 Items Out and Holds tabs in the patron record.
514 * Fixes a bug that caused grids on Bills and Patron Messages
515 screens to not display properly.
516 * The following fields are now available for the Checkout and Items Out
523 ** money_summary.balance_owed
524 ** money_summary.total_paid
525 ** money_summary.total_owed
530 * The following fields are now available on the Bill Payment receipt templates:
540 * Payment type is now a column in the payments tab of the patron record
541 Bill History section.
542 * The "Replace Barcode" function now makes it more difficult for staff
543 members to attempt to create blank patron barcodes.
544 * The patron bills screen now prevents staff members from double-clicking
545 on the Apply Payment button (which otherwise would apply two payments).
546 * Fixes a bug that prevented patrons attached to statistical categories
547 from displaying in the patron search-to-hold dialog.
548 * Fixes a performance issue related to uploading CSV files of barcodes
549 to the item status and patron bucket interfaces.
550 * Fixes several small bugs in the Spanish translation.
551 * Fixes a performance bug related to patrons logging in by barcode.
555 We would like to thank the following individuals who contributed code,
556 tests and documentation patches to the 3.0.4 point release of
578 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
579 update the visibility attributes of all bibs that make use of Located URIs or
580 bib sources. It may take a while to run on large datasets. If it it running
581 too long, it can be canceled and the following psql commands will create and
582 run a script that will perform the same action serially over time without
583 blocking writes to bibs:
586 \o /tmp/luri_visibility_update.sql
587 SELECT 'UPDATE biblio.record_entry SET ' ||
588 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
589 'WHERE id = ' || id || '; SELECT ' || id || ';'
590 FROM biblio.record_entry
592 SELECT DISTINCT cn.record
593 FROM asset.call_number cn
595 AND cn.label = '##URI##'
598 FROM asset.uri_call_number_map m
599 WHERE m.call_number = cn.id
602 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
607 \i /tmp/luri_visibility_update.sql
610 It will output the id of each updated bib so that the script can be killed
611 and then edited to remove completed bibs. The remainder can be run at a
614 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
615 we do NOT update the bib's visibility attributes, as doing so causes a loop
616 and an eventual trigger stack violation. This flag should ONLY be used when
617 forcing reingest of record attributes (NOT visibility attributes), search,
618 facet, and display fields, so if using this flag under normal operation,
619 proceed at your own risk and know that Located URI and bib source changes
620 will not be reflected in the visibility attributes of the record.
624 This release contains several bug fixes improving on Evergreen 3.0.1:
626 * Fixes several issues related to the display of located URIs and records with
627 bib sources in search results.
628 * Setting `opac_visible` to false for a copy location group now hides only
629 the location group itself, rather than also hiding every single copy in the
631 * Fixes a bug that prevented the copy editor from displaying the _fine level_
632 and _loan duration_ fields.
633 * The "Edit Items" grid action in the Item Status interface will now open
634 in the combined volume/copy editor in batch. This makes the behavior
635 consistent with the "Edit Selected Items" grid action in the copy
637 * Staff members are now required to choose a billing type when creating a
638 bill on a user account.
639 * The Web client now provides staff users with an alert and option to
640 override when an item with the Lost and Paid status is checked in.
641 * Fixes a bug where the Web client offline circ interface was not able
642 to set its working location.
643 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
645 * The MARC editor in the Web staff client now presents bib sources in
647 * Both circulation and grocery bills are now printed when a staff user selects
648 a patron account and clicks "Print Bills".
649 * Fixes an issue in the XUL serials interface the "Receive move/selected"
650 action from succeeding.
651 * Fixes a typo in the user password testing interface.
655 We would like to thank the following individuals who contributed code,
656 tests and documentation patches to the 3.0.3 point release of
675 This release contains several bug fixes improving on Evergreen 3.0.1:
677 * Copy templates created in XUL Holdings Maintenance will now be
678 automatically converted and displayed in the web staff client's
680 * The list of report templates now includes a column indicating whether
681 the template was originally created in the XUL staff client or the web
682 staff client; staff need to know this since report templates created in
683 one interface cannot be edited in the other.
684 * Call number prefixes and suffixes are now displayed in various grids
685 in the web staff client, including
686 ** Pending Copy Buckets
688 ** Checkin/Capture Holds
690 ** Patron Bills History
697 ** Bib Record View Holds
699 * Many patron fields have been redacted from the web staff client's patron
700 and record holds grids, leaving patron name, username, and ID.
701 * Fixes two bugs where patron records could fail to be saved upon editing.
702 * The web staff patron editor now better warns staff users about
703 duplicate names, IDs, phone numbers, and email addresses.
704 * Human readable labels are now displayed for certain fields in standing
706 * The patron summary in the web staff client now correctly displays
707 primary and secondary ID values.
708 * The web staff client's billing full details page now displays
709 information about the staff user that created a payment.
710 * The web staff client now requires staff users to explicitly set a
711 billing type when adding a manual bill.
712 * The web staff client's patron bill annotation modal now works.
713 * Patron barcode search completion in the web staff client now allows
714 the user to select from all of the matching patron records.
715 * The Hold Shelf Slip print template in the web staff client now has
716 access to the call number.
717 * The Checkout Receipt print template in the web staff client now can
718 include summary financial information, incuding current balance, total
719 paid on outstanding fines, and total owed.
720 * The web staff print templates for current and historical bills can
721 now include copy barcode and title.
722 * Fixes a bug that resulted in some catalog searches unexpectedly
724 * Fixes a bug that resulted in catalog searches that specify a location
725 limit returning incorrect results.
726 * Fixes a bug where deleted copies could make records visible in the
728 * Fixes a bug where certain queries on copies used in the public catalog
730 * Fixes a bug place a hold request in the public catalog could result
731 in "forgetting" the type and library of the user's previous search.
732 * The web staff client now respects staff user session timeouts, and
733 will log out all open tabs if a user's session has timed out.
734 * The web staff Z39.50 page will now give the staff user an alert if
735 they attempt to import a record with a duplicate TCN.
736 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
737 entries from being deleted.
738 * Fixes a bug that made using the volume/copy editor to change a copy's
740 * The administration interface for hard due dates now ensures that
741 new (or edited) ceiling dates have their time component set to end
742 of day, resolving an issue where ceiling dates would not be applied
743 during the ceiling date itself.
744 * The web staff client can now include dynamic information in browser
745 tab titles, e.g., "Smith, Jane - Checkout".
746 * The Concerto sample data set now includes data allowing for testing
747 placing holds on monographic parts.
748 * Asset merging during bibliographic record merging now correctly
749 recognizes call number prefixes and suffixes and deletes disused
751 * Fixes a bug where displaying user surveys could result in PCRUD
753 * Fixes a bug where pg_restore of an Evergreen database could fail
754 to create certain indexes on the `actor.usr` table.
758 We would like to thank the following individuals who contributed code,
759 tests and documentation patches to the 3.0.2 point release of
790 This release contains several bug fixes improving on Evergreen 3.0.0
792 * Fixes a bug in the web staff client that prevented initials from being
793 stored with copy notes.
794 * Adds billing types that may have been missed by systems that were
795 running Evergreen prior to the 1.4 release.
796 * Fixes a web staff client bug with the CSV export option available from
797 the Import Queue in the MARC Batch Import/Export interface.
798 * Adds the missing copy alert field in the web client's volume/copy
800 * Fixes a bug where the setting to require date of birth in patron
801 registration was not being honored in the web staff client.
802 * Fixes a bug in the web staff client patron registration form where the
803 password wasn't generating from the last four digits of the patron's
805 * Fixes an issue in the web staff client where the complete barcode did
806 not display in some interfaces when partial barcodes were scanned.
807 * Fixes an HTML error in the new copy tags that display on the record
809 * Fixes a web staff client bug where recording a large number of in-house
810 uses at one time doesn't display a confirmation dialog once it hits the
812 * Adds a _Print Full Grid_ action in the web staff client
813 holds pull list to allow staff to print the entire pull list as it
814 displays on the screen. This change also changes the _Export CSV_ action
815 to an _Export Full CSV_ option.
816 * Fixes an issue with the Patron Messages interface that prevented it
817 from saving column configuration changes in the web staff client.
818 * Fixes a bug in the web staff client where a billing prompt did not
819 correctly display after marking an item damaged in those systems that
820 have enabled the setting to bill for damaged items.
821 * Adds an option to the specific due date feature that allows saving
822 that due date until logout. This allows all circulations from a given
823 workstation to be due on the same date.
827 We would like to thank the following individuals who contributed code,
828 tests and documentation patches to the 3.0.1 point release of
850 The minimum version of PostgreSQL required to run Evergreen 3.0 is
851 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
853 Change to Names of Shared Libraries
854 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
855 OpenSRF 3.0 changes how the shared libraries for services written in
856 C are named. If upgrading from an earlier version of Evergreen,
857 `opensrf.xml` should be edited so that shared library file names
858 listed in the `<implementation>` tag start with "lib". For example,
861 ---------------------------------------------------------------------
863 <language>C</language>
864 <implementation>oils_cstore.so</implementation>
865 ---------------------------------------------------------------------
867 should be changed to:
870 ---------------------------------------------------------------------
872 <language>C</language>
873 <implementation>liboils_cstore.so</implementation>
874 ---------------------------------------------------------------------
876 SIP Bugfix Requires SIPServer Upgrade
877 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
879 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
880 crash" requires that you also upgrade SIPServer with the fix for
881 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
882 SIP client problems." This means that if you use SIP2 with Evergreen,
883 you must also upgrade SIPServer to the latest commit in the Git
884 repository. Conversely, if you upgrade SIPServer to the latest commit
885 in Git, you must also upgrade Evergreen or, at least, apply the patch
886 for Launchpad Bug 1542495. These two patches are complementary and
887 cannot be applied independently of one another.
889 `open-ils.auth.login`
890 ~~~~~~~~~~~~~~~~~~~~~
891 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
892 API's in the `opensrf_core.xml` file.
897 ---------------------------------------------------------------------
898 --- a/Open-ILS/examples/opensrf_core.xml.example
899 +++ b/Open-ILS/examples/opensrf_core.xml.example
900 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
902 <match_string>open-ils.auth.authenticate.verify</match_string>
903 <match_string>open-ils.auth.authenticate.complete</match_string>
904 + <match_string>open-ils.auth.login</match_string>
905 <match_string>open-ils.auth_proxy.login</match_string>
906 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
907 <match_string>open-ils.actor.user.password</match_string>
908 ---------------------------------------------------------------------
912 Administrators of Evergreen who use RTL locales and who have customized
913 `style-rtl.css.tt2` should now incorporate their customizations into
916 Multi-Time Zone Installations
917 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
919 For Evergreen consortia that span more than one time zone, the following
920 query will adjust all historical, unaged circulations so
921 that if their due date field is pushed to the end of the day, it is done
922 in the circulating library's time zone, and not the server time zone.
924 It is safe to run this after any change to library time zones.
926 Running this is not required, as no code before this change has
927 depended on the time string of '23:59:59'. It is also not necessary
928 if all of your libraries are in the same time zone, and that time zone
929 is the same as the database's configured time zone.
938 for ou_id in select id from actor.org_unit loop
939 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
940 if new_tz is not null then
941 update action.circulation
942 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
943 where circ_lib = ou_id
944 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
953 Deprecation of XUL staff client
954 -------------------------------
955 Starting with the release of 3.0.0, patches that fix XUL bugs will not
956 be merged into master or backported unless they meet one or more of
957 the following conditions:
959 a. the bug is a security issue
960 b. the bug involves the destruction of data
961 c. the bug is a regression of functionality in the XUL staff client
962 introduced by other work done to Evergreen
964 Under no circumstances will XUL staff client feature enhancements be merged.
966 This policy will continue through the 3.0.x and 3.1.x maintenance
967 release cycles, and will become moot upon the release of 3.2.0, when
968 the XUL staff client is slated to be entirely removed.
977 Evergreen 3.0 features a new, modern staff client that runs in the web browser
978 and can be used on desktop and mobile devices. All functional areas of the
979 system, including circulation, cataloging, acquisitions, serials, reports,
980 booking, administration, and offline circulation, are available in the new staff
981 client. Chrome and Firefox are officially supported for use with the web client.
983 Library staff will no longer need to download separate software to perform most
984 actions in Evergreen. A Chrome plugin called Hatch will be available as a
985 separate installation for workstations that require seamless, dialog-free
986 printing to multiple printers.
988 In addition to adding more portability and stability, the new staff client also
989 presents a cleaner and more modern interface for users. By virtue of running in
990 a browser, actions that users are accustomed to performing on other web sites
991 should now be available in the Evergreen client.
993 The old, XUL client will continue to be available to allow for a gradual
994 transition to the browser-based client, but no new features will be added. The
995 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
1005 New EDI Order Generator
1006 ^^^^^^^^^^^^^^^^^^^^^^^
1011 . New database tables exist for configuring vendor-specific EDI order
1015 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1017 * `acq.edi_attr_set`
1018 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1020 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1021 the stock configuration found in the JEDI template.
1022 * `acq.edi_attr_set_map`
1023 ** Link between `edi_attr`s and `edi_attr_set`s.
1025 . EDI Attribute Sets are manged via a new (browser client only) configuration
1026 interface at 'Administration -> Acquisitions Administration -> EDI
1029 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1030 is not set, default values will be used. Links between an EDI account
1031 and an attribute set are managed in the EDI Accounts configuration
1034 . Local modifications to the stock EG JEDI template are managed by modifying
1035 and/or adding additional `edi_att_set`s as needed.
1037 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1038 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1040 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1041 definition is no longer required and can be disabled.
1046 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1047 specifies whether PO's generated via the account should be built using
1048 EDI attributes or fall back to traditional JEDI A/T template generation.
1050 This allows sites to activate EDI attributes on a per-account basis, making
1051 it possible to migrate piecemeal to EDI attributes. For the initial roll
1052 out of this new feature, no accounts will be configured to use EDI
1053 attributes by default.
1059 3 Day Courtesy Notice by SMS
1060 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1061 New optional SMS text notification to be sent out 3 days prior to the due
1062 date of any circulating item for patrons who have an SMS text number and
1063 carrier stored in their accounts. This action trigger is disabled by default,
1064 but can be enabled and modified by going into 'Administration -> Local Administration ->
1065 Notifications / Action Triggers'.
1067 You may wish to make use of granularity so that these messages are batched
1068 and sent at the same time each day.
1073 Add Description Field to Circulation and Hold Configuration Entries
1074 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1075 The circulation and hold policy configuration rules now each have a
1076 description field. This allows administrators to add comments to
1077 describe the purpose of each rule.
1082 Apache Internal Port Configuration Option
1083 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1084 Apache configuration now supports a new variable which allows admins to
1085 specify the port used by Apache to handle HTTP traffic. The value is
1086 used for HTTP requests routed from Perl handlers back to the same Apache
1087 instance, like added content requests. Use this when running Apache
1088 with a non-standard port, typical with a proxy setup. Defaults to "80".
1091 -------------------------------------------------------------------
1094 PerlSetVar OILSWebInternalHTTPPort "7080"
1097 -------------------------------------------------------------------
1102 Configurable Bib Record Display Fields
1103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1105 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1106 fields: 'Display Field?' and 'Display XPath'.
1108 When 'Display Field' is set to true, data from the field will be extracted
1109 from each record and added to a new table of display data for each bib
1112 If a value is present in the 'Display XPath' field, this XPath will be
1113 applied to the extracted data *after* the base XPath (from the 'XPath'
1114 field) is applied to each field.
1116 This data acts as a replacement for the various and sundry ways bib record
1117 data is currently extracted, including inline XPath in the TPAC, reporter
1118 views, real-time 'MVR' compilation from MODS, etc. and will be available
1119 to the user interface, notification templates, etc. for rendering bib
1122 The browser client gets a new service 'egBibDisplay' which is capable
1123 of translating the display field data from various formats into
1124 data more suitable for JavaScript usage.
1126 The database gets 3 new views for representing display data in various
1129 * `metabib.flat_display_entry`
1130 ** List of all display fields linked to their configuration.
1131 * `metabib.compressed_display_entry`
1132 ** Same as `metabib.flat_display_entry` except there's one row
1133 per display field type, with 'multi' rows compressed into
1134 JSON arrays. Non-multi fields are represented as JSON
1136 * `metabib.wide_display_entry`
1137 ** Tabular view of display field data, one column per well-known
1138 field. Values are represented JSON, consistent with
1139 `metabib.flat_display_entry`. The view does *not* contain locally
1140 configured display fields, as each field must be encoded in
1141 the view and IDL definition. This is essentially a replacement
1142 for `reporter.simple_record`.
1147 After making changes to display field configuration, it's possible to
1148 reingest only display field data in the database using the following:
1151 ---------------------------------------------------------------------
1152 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1153 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1154 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1155 ---------------------------------------------------------------------
1161 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1162 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1163 The existing permission was incorrectly created with a code of
1164 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1165 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1166 update changes the permission code to match what the event requires.
1172 Hold Targeter V2 Repairs and Improvements
1173 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1174 * Make the batch targeter more resilient to a single-hold failure.
1175 * Additional batch targeter info logging.
1176 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1177 * Removes the confusingly named `--target-all` option
1178 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1179 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1181 New --next-check-interval Option
1182 ++++++++++++++++++++++++++++++++
1183 Specify how long after the current run time the targeter will retarget
1184 the currently affected holds. Applying a specific interval is useful
1185 when the retarget-interval is shorter than the time between targeter
1188 For example, if the targeter is run nightly at midnight with a
1189 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1190 since the holds won't be processed again until 48 hours later. This
1191 ensures that the org unit closed date checks are looking at the correct
1194 This setting overrides the default behavior of calculating the next
1195 retarget time from the retarget-interval.
1197 New --soft-retarget-interval Option
1198 +++++++++++++++++++++++++++++++++++
1199 This is a replacement for (and rebranding of) the `--skip-viable` option.
1200 The new option allows for time-based soft-targeting instead simple binary
1201 on/off soft-targeting.
1203 How soft-targeting works:
1205 * Update hold copy maps for all affected holds
1206 * Holds with viable targets (on the pull list) are otherwise left alone.
1207 * Holds without viable targets are retargeted in the usual manner.
1213 New marc_export --descendants Option
1214 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1216 The `marc_export` script has a new option, `--descendants`. This option
1217 takes one argument of an organizational unit shortname. It works much
1218 like the existing `--library` option except that it is aware of the
1219 org. tree and will export records with holdings at the specified
1220 organizational unit and all of its descendants. This is handy if you
1221 want to export the records for all of the branches of a system. You
1222 can do that by specifying this option and the system's shortname,
1223 instead of specifying multiple `--library` options for each branch.
1225 The `--descendants` option can be repeated, as the `--library` option can.
1226 All of the specified org. units and their descendants will be included
1227 in the output. It can also be combined with individual `--library`
1228 options when necessary.
1233 RTL and LTR Public Catalog Stylesheets Merged
1234 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1235 The RTL stylesheet for the public catalog,
1236 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1237 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1238 template will provide RTL or LTR styles based on the value of
1239 the `rtl` flag of the active locale. An `rtl` variable is also available
1240 in the template to allow the correct style to be chosen.
1245 Miscellaneous Improvements
1246 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1248 * If a filter is in effect in the Library Settings Editor,
1249 the filter will continue to be applied after a user
1250 changes the selected library.
1251 * Copy templates used for serials now correctly link to age
1252 protection rules and MARC item type values (for the
1253 "Circ as Type" field). During upgrade, the database update
1254 will set to NULL any age protection and circ as type fields
1255 in serial copy templates that do not point to defined values.
1260 Obsolete Internal Flag Removed
1261 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1263 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1264 flag was removed from the `config.internal_flags` table. It was
1265 rendered obsolete by the addition of the 3 flags to control the
1266 browse, search, and facet indexing.
1271 Tweaks to Caching/Expiry of Public Catalog Assets
1272 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1273 The default cache expiration time for static assets (e.g.,
1274 CSS, image, and JavaScript files) in the public catalog and
1275 the Kid's PAC has been increased to one year. Links to all
1276 such assets now have a cache-busting value tacked on as a
1277 query parameter. This value is refreshed when `autogen.sh` is
1278 run, but it can also be manually set by adjusting the
1279 `ctx.cache_key` Template Toolkit variable.
1284 Action/Trigger Events Data Purging
1285 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1287 Action/Trigger event definitions have a new field called 'Retention
1288 Interval'. When an optional interval value is applied, events and
1289 template output data linked to the event definition will be deleted
1290 from the database once they reach the specified age.
1292 Retention Interval Restrictions for Passive Hooks
1293 +++++++++++++++++++++++++++++++++++++++++++++++++
1295 Restrictions are placed on retention interval values for event definitions
1296 using passive hooks to prevent data from being deleted while it's still
1297 needed by the system.
1299 The presence of event data is how the system knows not to send duplicate
1300 events. As long as a scenario exists where a duplicate event may be
1301 generated, the events must be retained.
1303 To apply a retention interval value to a passive-hook event definition:
1305 * The event definition must have a max_delay value.
1306 * The retention interval must be larger than the difference between
1307 the `delay` and `max_delay` values.
1309 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1310 interval must be greater than 3 days to ensure no duplicate events are
1311 created between the first event on day 7 and the end of the event validity
1317 A new `purge_at_events.sh` script is installed in the bin directory
1318 (typically `/openils/bin`) which should be added to CRON for regular
1321 NOTE: On large data sets, this script can take a long time to run and
1322 create higher than normal I/O load as it churns though the event and
1323 event_output tables. You may wish to run the script by hand the first
1324 time so it can be monitored. It can be run in psql like so:
1327 ---------------------------------------------------------------
1328 SELECT action_trigger.purge_events();
1329 ---------------------------------------------------------------
1331 NOTE: On *very* large data sets (10s to 100s of millions of event and
1332 event_output rows), it may be advisable to first repopulate the `event`
1333 and `event_output` tables with only the desired data before starting
1334 regular purges. This can be done, for example, using the copy to temp
1335 table, truncate source table, repopulate source table from temp table
1336 approach. This will be much faster than the `purge_events()` function
1337 in cases where most of the data will be purged.
1342 A number of `action_trigger.hook` entries which have always been treated
1343 as active hooks, though are configured as passive hooks, have been
1344 updated to properly reflect the non-passive-ness. This allows for
1345 simpler configuration of their retention interval values.
1351 Remove JSPAC Redirects
1352 ^^^^^^^^^^^^^^^^^^^^^^
1353 Future versions of Evergreen will no longer contain automatic redirects
1354 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1355 that the JSPAC is no longer supported. Existing sites, however, may
1356 wish to retain JSPAC redirects in their Apache configuration files since
1357 JSPAC URLs may still be used in the wild to access their catalogs.
1359 The original JSPAC URL redirects are all retained in the file
1360 `Open-ILS/examples/jspac_redirects.conf` for reference.
1370 New open-ils.auth.login API
1371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1372 The `open-ils.auth` service has a new API for requesting an authentication
1373 token. It performs the same steps as the
1374 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1375 using the bare password. No intermediate password hashing is required.
1377 The paramaters are the same as the `.complete` call with a few modifications.
1379 1. Using the generic 'identifier' parameter in combination with the
1380 'org' parameter allows the API to reliably determine if an identifier
1381 value is a username or barcode. The caller is no longer required to
1382 make that determination up front.
1384 2. The 'nonce' parameter is no longer used.
1390 Batch Patron Contact Invalidation
1391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1392 The following methods are used to mark patron contact fields
1393 as invalid by moving the invalid value to a standing penalty:
1395 * `open-ils.actor.invalidate.email`
1396 * `open-ils.actor.invalidate.day_phone`
1397 * `open-ils.actor.invalidate.evening_phone`
1398 * `open-ils.actor.invalidate.other_phone`
1400 These methods now accept a fifth argument specifying the value
1401 of the contact field, e.g., a specific phone number or email
1402 address. If supplied, and if a specific patron ID (the first
1403 argument) is not supplied, all patrons with that specific contact
1404 value will have it marked invalid.
1414 Pure-SQL catalog searching
1415 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1416 Public and staff catalog search is now both more accurate and faster
1417 by redesigning how the visibility of records is calculated.
1427 Authority Record and Headings Browse Improvements
1428 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1429 Various improvements are made to support for authority records
1430 and headings browsing:
1432 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1433 headings from authority records. Since the MODS and MADS stylesheets
1434 extract headings in similar ways, duplicate browse entries are now
1435 much less likely to occur.
1436 * A new configuration table, `authority.heading_field`, is now used
1437 to specify how headings should be extracted from authority records.
1438 * Related headings can now be identified as narrower or broader when
1439 browsing in the public catalog.
1440 * See references are now more reliably included in the browse list.
1441 * Scope (public) notes now display only under the main heading.
1442 * There is now a global flag, Display related headings (see-also) in browse,
1443 that can be used to control whether related headings (see-alsos) are
1444 displayed in the public catalog list.
1445 * A complete set of thesauruses are now included in the seed data. Thesauruses
1446 can now be identified using short and long codes.
1447 * The labels for see and see-also references in the public catalog are
1448 a bit more patron-friendly, and can now be tweaked via TPAC template
1449 customization in the browse.tt2 file.
1455 Copy Tags and Digital Bookplates
1456 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1457 Copy tags will allow staff to apply custom, pre-defined labels or tags
1458 to copies. Copy tags are searchable in both the staff client and public
1459 catalog. This feature was designed to be used for Digital Bookplates to
1460 attach donation or memorial information to copies, but may be used for
1461 broader purposes to tag items.
1463 Each copy tag can either be publicly-visible or visible only to staff.
1464 Copy tags also have types that can be used for restricting catalog
1465 searches on copy tags to particular types.
1467 Copy tags are displayed in the copy table in the record summary page in
1468 the public catalog, and a new library setting can be used to add
1469 a "Digital Bookplate" search field. Copy tags can also be used
1470 as a search filter, e.g.,
1472 * `copy_tag(bookplate, jane smith)`: search for records that have a
1473 copy tag of type 'bookplate' whose value contains 'jane smith'.
1474 * `copy_tag(*, jane smith)`: search for records that have a
1475 copy tag of any type whose value contains 'jane smith'.
1477 All staff-side interfaces related to copy tags exist only in the web
1478 staff client. There are two new administration interfaces for managing
1479 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1480 button for applying copy tags to copies; that interface can also be
1481 used to create new copy tags on the fly. Furthermore, the copy buckets
1482 interface now has an 'Apply Tags' action for assigning tags to groups
1488 Two new permission are included:
1490 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1491 'Administration -> Server Administration -> Copy Tag Types'
1492 * `ADMIN_COPY_TAG`: required to create a new tag under
1493 'Administration -> Local Administration -> Copy Tags'
1495 The existing permission `UPDATE_COPY` controls whether or not a user
1496 can link copies to tags.
1500 A new library setting, 'Enable Digital Bookplate Search', controls
1501 whether to display a 'Digital Bookplate' field in the search index
1502 drop-downs in the catalog. A 'Digital Bookplate' search will include
1503 all records that have a copy that matches the tag specified by the user.
1504 It should be noted that this library setting does not affect the
1505 display of copy tags on the catalog record summary page.
1510 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1512 The call number prefix and suffix, when present, are now included in
1513 subfields $k and $m of the 852 field when running `marc_export` with
1514 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1515 server configured to embed item data in 852 fields, the affixes are now
1516 included in subfields $k and $m.
1526 Batch Editing of Patron Records
1527 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1528 There is a now a new interface analogous to the Copy Bucket interface
1529 to select and group a set of users into a User Bucket.
1530 The addition of users to a User Bucket is possible from the Patron Search
1531 interface by the use of a new grid Action, and directly on the User Bucket
1532 interface by user barcode. It is also possible to add users to a User
1533 Bucket by uploading a text file that contains a list of user barcodes.
1535 From this interface it is possible to perform a set of specific batch update
1536 operations on user records.
1541 These fields can now be changed in batch via an action on the User Bucket
1542 grid if the staff user has the `UPDATE_USER` permission:
1545 * Primary Permission Group (group application permissions consulted)
1547 * Home Library (`UPDATE_USER` checked against both old and new value)
1548 * Privilege Expiration Date
1549 * Barred flag (`BAR_PATRON` permission consulted)
1550 * Internet Access Level
1552 Changes made in this interface can be rolled back.
1554 As a batch process, rather than a direct edit, this mechanism explicitly skips
1555 processing of Action/Trigger event definitions for user update.
1560 The batch edit mechanism also allows for the batch deletion of user. The staff
1561 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1563 Changes made in this interface can be rolled back.
1565 As a batch process, rather than a direct edit, this mechanism explicitly skips
1566 processing of Action/Trigger event definitions for user deletion.
1568 This mechanism does not use the Purge User functionality, but instead simply
1569 marks the users as deleted.
1571 Editing Statistical Category Entries
1572 ++++++++++++++++++++++++++++++++++++
1574 All users in the bucket can have their Statistical Category Entries
1575 modified. Unlike user data field updates, modification of Statistical
1576 Category Entries is permanent and cannot be rolled back.
1578 As a batch process, rather than a direct edit, this mechanism explicitly skips
1579 processing of Action/Trigger event definitions for user update.
1581 New Service Requirement
1582 +++++++++++++++++++++++
1584 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1585 unused in production. If this service has been removed from the configuration
1586 of a live Evergreen instances, it will need to be added back in order for
1587 batch user editing to succeed.
1592 Honor Timezone of the Acting Library
1593 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1598 * Display day-granular due dates in the circulating library's timezone.
1599 * Only display the date portion of the due date for day-granular circulations.
1600 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1601 * Provide infrastructure for more advanced formatting of timestamps.
1602 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1607 This is a followup to the work done for 2.12, where we added the ability
1608 for the client to specify a timezone in which timestamps should be interpreted
1609 in business logic and the database.
1611 Most specifically, this work focuses on circulation due dates and the closed
1612 date editor. Due dates, where displayed using stock templates (including
1613 receipt templates) and used for fine calculation, are now manipulated in the
1614 library's configured timezone. This is controlled by the new 'lib.timezone'
1615 setting available via the Library Settings Editor, loaded from the server when
1616 required. Additionally, closings are recorded in the library's timezone so that
1617 due date calculation is more accurate. The closed date editor is also
1618 taught how to display closings in the
1619 closed library's timezone. Closed date entries also explicitly record if they
1620 are a full day closing, or a multi-day closing. This significantly simplifies
1621 the editor, and may be useful in other contexts.
1623 To accomplish this, we use the moment.js library and the moment-timezone addon.
1624 This is necessary because the stock AngularJS date filter does not understand
1625 locale-aware timezone values, which are required to support DST. A simple
1626 mapper translates the differences in format values from AngularJS date to
1629 Of special note are a set of new filters used for formatting timestamps under
1630 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1631 filters provide the functionality, and autogrid is enhanced to make use of
1632 these where applicable. egGrid and egGridField are also taught to accept
1633 default and field-specific options for applying date filters. These filters may
1634 be useful in other or related contexts.
1636 The egDueDate filter, used for all existing displays of due date via Angular
1637 code, intentionally interprets timestamps in two different ways WRT timezone,
1638 based on the circulation duration. If the duration is day-granular (that is,
1639 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1640 of seconds) then the date is interpreted as being in the circulation library's
1641 timezone. If it is an hourly loan (any duration that does not meet the
1642 day-granular criterium) then it is instead displayed in the client's timezone,
1643 just as all other timestamps currently are, because of the previous Evergreen
1646 The public catalog is adjusted to always display the due date in the circulating
1647 library's timezone. Because the public catalog displays only the date portion of the due
1648 date field, this difference is currently considered acceptable. If this proves
1649 to be a problem in the future, a minor adjustment can be made to match the
1650 egDueDate filter logic.
1652 Now that due dates are globally stored in the configured timezone of the
1653 circulating library, the automatic adjustment to day-granular due dates needs
1654 to take those timezones into account.
1656 An optional SQL command is provided by the upgrade script to retroactively
1657 adjust existing due dates after library configuration is complete.
1663 Enhancements to Hard Due Date Functionality
1664 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1665 It will now be possible to delete Hard Due Date Values for dates that have
1666 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1667 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1668 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1673 Patron Search by Birth Date
1674 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1675 * Now you can include the patron birth year and/or birth month and/or
1676 birth day when searching for patrons using the web staff client.
1677 * Day and month values are exact matches. E.g. month "1" (or "01")
1678 matches January, "12" matches December.
1679 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1680 1915, 1599, etc. For exact matches use the full 4-digit year.
1684 Patron Search from Place Hold
1685 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1686 This feature allows staff members, when placing a
1687 hold on behalf of a patron in the web staff client, to search for
1688 patrons by names and other searchable patron information, rather than
1689 relying on barcode alone. In particular, after performing a catalog
1690 search or going to a specific bib record and clicking the 'Place Hold'
1691 button, the form now includes a 'Patron Search' button. This button
1692 will open a dialog allowing the staff member search for and select
1698 Retrieve Recent Patrons
1699 ^^^^^^^^^^^^^^^^^^^^^^^
1701 Adds a new library setting 'Number of Retrievable Recent Patrons'
1702 ('ui.staff.max_recent_patrons') that specifies the number of recently
1703 retrieved patrons that can be re-fetched from the staff client.
1705 A value of 0 means no recent patrons can be retrieved.
1706 A value greater than 1 means staff will be able to retrieve multiple
1707 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1709 The default value is 1 for backwards compatibility.
1716 Fuller title in XUL client Simplified Pull List
1717 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1718 The Simplified Pull List in the XUL client will now display subfields 245$n and
1719 $p in the title field. The addition will make it easier for staff to distinguish
1720 between different parts or seasons in a series.
1726 Transit Cancel Time and Terminology Change
1727 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1732 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1733 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1734 are preserved in the database, though still not visible to the end user in the staff client.
1735 This allows for better tracking of when transits are canceled for the purposes of knowing
1736 which staff member canceled the transit, etc.
1738 NOTE: This change may require the re-creation of transit reports to filter out canceled
1739 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1740 Is NULL' will suffice.
1742 "Canceled Transit" Terminology Change
1743 +++++++++++++++++++++++++++++++++++++
1745 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1746 For internal continuity, however, the following permission codes have not changed:
1749 * `ABORT_REMOTE_TRANSIT`
1750 * `ABORT_TRANSIT_ON_LOST`
1751 * `ABORT_TRANSIT_ON_MISSING`
1759 Offline Circulation Available in Web Staff Client
1760 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1761 Offline circulation is now available in the web staff client. In order to use the
1762 offline interface, users must first log into the web staff client, perform
1763 a patron search, select a user from the results, and open the patron editor
1764 interface to collect all the relevent configuration information for the
1765 workstation. In addition, the offline interface available from the Circulation
1766 menu provides a 'Download block list' button for users who are logged in.
1768 As is the case in the old staff client, users can check materials in and out,
1769 renew items, and create new patron accounts while offline. The patron fields
1770 available in the offline patron registration editor are the same ones that
1771 are available to staff when working online.
1775 Add Circ Modifier to Record Detail Page in Staff TPAC
1776 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1777 The circulation modifier field is added to the table of copies to make
1778 more information available to staff without having to open
1785 Date+Time Format Settings for Web Client
1786 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1788 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1789 and adds two settings for use with the webstaff client:
1791 * 'Format Dates with this pattern'
1792 * 'Format Date+Time with this pattern'
1794 These settings use format strings as documented here:
1796 https://docs.angularjs.org/api/ng/filter/date
1798 There is overlap with how the Dojo formats worked, but also some differences.
1800 The original 'Format Dates' and 'Format Times' settings worked together, but the
1801 new settings work independently. Certain field elements will use one, and
1802 certain field elements will use the other. These distinctions are hard-coded
1803 in the various UI templates, with the idea being that timestamp fields in
1804 which the date component alone is sufficient information (for example, date of birth)
1805 will use the 'Format Dates' setting. Fields where the time component is
1806 important (for example, checkout time) will use the 'Format Date+Time' setting.
1808 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1809 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1815 Global Option to Remove Sound for a Specific Event
1816 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1817 A new `nosound.wav` file has been added to the web client. The file can be used
1818 to globally disable audio alerts for a specific event on an Evergreen system.
1820 For example, to silence the alert that sounds after a successful patron search:
1824 mkdir -p /openils/var/web/audio/notifications/success/patron/
1825 cd /openils/var/web/audio/notifications/success/patron/
1826 ln -s ../../nosound.wav by_search.wav
1833 The official Evergreen manual has been split into eight new manuals, each
1834 designed for a specific audience. This new approach is designed to make
1835 the documentation more readable and usable.
1837 The specific audiences for the new manuals are:
1839 * Acquisitions staff
1842 * Public services staff who use the public catalog
1844 * System administrators who use the command line
1845 * System administrators who use the Web client
1846 * System administrators and programmers who wish to integrate Evergreen
1847 with other technologies
1849 All manuals are available at http://docs.evergreen-ils.org
1855 Improvements to ebook API
1856 ^^^^^^^^^^^^^^^^^^^^^^^^^
1858 Evergreen now supports checking out and placing holds on
1859 OverDrive and OneClickdigital ebook titles from within the public
1860 catalog. This is an experimental feature. It is not recommended for production
1861 use without careful testing.
1863 When ebook integration is enabled, a "Check Out E-Item" link will be
1864 displayed when viewing an ebook title from a supported vendor in the
1865 catalog. Clicking on the link allows the user to check out and download
1866 that title from the vendor directly within the catalog.
1868 If no copies are available for the title, a "Place Hold on E-Item" link
1869 is displayed instead, and the user may place a hold on the title. (Note
1870 that some vendors require the user's account to have an email address
1871 before permitting a hold.)
1873 My Account includes the ability to view current ebook checkouts and
1874 holds, download already-checked-out titles, and cancel holds.
1876 For API integration to work, you need to request API access from the
1877 vendor, and the vendor must have a way of authenticating your patrons.
1878 Your Evergreen system also needs to be configured for ebook API
1879 integration, following the instructions in the command line system
1880 administration manual
1883 This feature assumes that you are importing MARC records supplied by the
1884 vendor into your Evergreen system, using Vandelay or some other MARC
1885 import method. This feature does not search the vendor's online
1886 collections or automatically import vendor records into your system; it
1887 merely augments records that are already in Evergreen.
1889 Improvements to Bill Payment Pages
1890 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1891 The bill payment pages in the public catalog have been revamped
1894 * use the term "charges" instead of "fees"
1895 * include images of credit cards accepted
1896 * make the default print receipt template match other itemized receipts;
1897 note that this change is not automatically applied when upgrading.
1898 * display billing type
1899 * add button to pay only selected charges
1900 * reformat the credit card number input page
1906 Clickable Copy Locations
1907 ^^^^^^^^^^^^^^^^^^^^^^^^
1908 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1909 the associated copy location will display as a link in the public catalog summary display.
1910 This link can be useful for retrieving maps or other directions to the copy
1911 location to aid users in finding material.
1916 Download Checkout History CSV Fixed for Large Number of Circulations
1917 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1918 Downloading checkout history as a CSV from My Account has been fixed
1919 for users with a large circulation history. Previously, this would
1920 time out for patrons with more than 100 or so circulations.
1922 This feature no longer uses the action/trigger mechanism and the public catalog
1923 now generates the CSV directly. The old action/trigger code is still
1924 present in the database and should be removed at some point in the
1930 Google Books Preview Rewrite
1931 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1932 The Google Books Preview functionality in record detail pages has been
1933 rewritten to modernize its style and optimize its performance:
1935 * The Dojo JavaScript framework is no longer used, saving approximately
1936 150K of JavaScript and CSS and four network requests per page load.
1937 * The Embedded Viewer is not loaded unless a possible preview is found,
1938 saving more network and memory overhead.
1939 * The Google Books Loader is used to load the Embedded Viewer instead of the
1940 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1942 * All variables are self-contained and do not pollute the global namespace.
1943 * Event listeners are registered to handle clicks, rather than attaching
1944 `href="javascript:function()"` to <a> elements.
1945 * Book previews are displayed in a panel sized according to the viewport
1946 of the browser, improving its appearance on both mobile and desktop
1948 * The rewritten code is now served up directly from
1949 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1954 jQuery for the Public Catalog
1955 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1956 This release adds optional support for jQuery in the public catalog. This support
1957 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1958 `config.tt2` template.
1964 New Popularity Parameters
1965 ^^^^^^^^^^^^^^^^^^^^^^^^^
1966 New popularity parameters for in-house use over time and for count of distinct
1967 organizational units that own a title are now available. Evergreen sites
1968 can use these parameters to create new statistical popularity badges for
1969 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1971 The in-house use parameters will apply a badge to titles that have the most
1972 in-house use activity over time. The organizational unit count parameter
1973 will apply a badge to titles owned by the most number of libraries in a
1974 consortium. Ownership is determined by the copy's circulation library.
1979 Option to Suspend Holds at the Time They are Placed
1980 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1981 Users now have the option to suspend a hold at the same time they place the
1982 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1983 who want to suspend a hold at the time it is placed. There is also an option
1984 to set the activation date at the same time. This option is also available
1985 when placing holds on a batch of titles from 'My List' and will apply to
1986 all the titles in the batch.
1997 Fix to reporter.classic_current_circ View
1998 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1999 The `reporter.classic_current_circ` view, which is part of some
2000 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
2001 has been fixed to not exclude loans for patrons who do not have a
2002 billing address set. Users of this view should rerun
2003 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
2008 New Report Source Table Allowing Report of "Last" Deleted copy
2009 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011 This source table allows you to construct a clever aggregate report template
2012 which will report bibliographic IDs where a library or a group of libraries
2013 no longer have a copy attached but *had* a copy attached. This is especially
2014 useful when a holdings sync is required with an external vendor.
2017 Instructions for creating a report template with this source:
2019 * Create a new report template using "Library Holdings Count with Deleted" as the source
2020 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2021 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2022 * 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"
2023 * Add "Bib ID" to Displayed Fields
2024 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2025 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2026 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2029 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2030 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2031 specified date range. Unfortunately the user will have to manually type the date range without the date
2032 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2033 copy and more than two deleted copies."
2038 Add Provider to Provider Note Link
2039 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2040 The Provider reporting source now includes a link to the Provider Note reporting source.
2045 Link ILS User and Working Location Reporting Sources
2046 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2047 The Working Location reporting source now has labels
2048 and it is now linked to the ILS User reporting source, allowing
2049 reports to display or filter on staff working location.
2054 New Circulation Report Source "All Circulation Combined Types"
2055 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2057 This report source will allow you to create a single report template for all of the following:
2060 * In-house uses of non-cataloged items
2062 * Circulations of non-cataloged items
2064 To distinguish between these different types of library use, it's important to display these columns
2065 in your report templates:
2074 Reports Template Searching
2075 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2076 A new form appears along the top of the reports interface for searching
2077 report templates. Once found, typical template actions (e.g. create new
2078 report) are available from within the results interface.
2080 Searches may be performed across selected (visible) folders or all
2081 folders visible to the logged in user.
2083 Searches are case-insensitive, any word order, with left-anchored words.
2084 All searched words must appear in at least one of the searched fields.
2089 * Searching for 'stat cat' matches:
2091 ** statistical category
2092 ** categories, statistical
2093 ** patrons (stat cat)
2094 * Searching for 'stat cat' does not match:
2096 *** both words must be present in the searched field(s)
2098 *** location contains 'cat' but it's not left-anchored.
2103 The templates, reports, and output interfaces now support paging via
2104 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2116 Web Staff Client Serials Module
2117 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2118 The serials module has been ported over to the web staff
2119 client, implementing a unified serials interface that combines
2120 ideas from both the serial control view and alternate serials
2121 control view from the old staff client.
2123 In addition to carrying over functionality that was available
2124 in the old staff client, several new features are included:
2126 * the ability to save prediction pattern codes as templates
2127 that can be shared and reused within an Evergreen database
2128 * a more streamlined interface for managing subscriptions,
2129 distributions, and streams
2130 * it is no longer necessary to create a starting issue in
2131 order to predict a run of issues; the dialog box for
2132 generating a set of predicted issues now lets you specify
2133 the starting point directly.
2134 * the ability to more directly edit MFHDs
2136 The new serials interfaces can be accessed from the record
2137 details page via a Serials drop-down button that links to
2138 a subscription management page, a quick-receive action, and
2139 a MFHD management page. There is also a new 'Serials Administration'
2140 page where prediction pattern and serial copy templates can
2151 SIP Bugfix Changes How Encoding Is Determined in Configuration
2152 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2154 The combined fix for the above mentioned SIP bugs alters the way that
2155 SIPServer looks up the output encoding in the configuration file (typically
2156 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2159 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2160 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2161 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.
2162 4. If none of the above exist, then the default encoding (ASCII) is used.
2164 Number 3 is provided to ease the transition to the new code. It is
2165 the current location of the +encoding+ element in the sample
2166 configuration file and as such, where it is likely to be found in
2167 actual files. It is recommended that you alter your configuration to
2168 move this element out of the +implementation_config+ element and into
2169 its parent +institution+ element. Ideally, SIPServer should *not* look into
2170 the implementation config, and this check may be removed at some time
2178 Web Client Acknowledgments
2179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2181 The project to develop a new browser-based web client launched four
2182 years ago at the September 2013 Evergreen developer hack-a-way when the
2183 developer community voted to move away from the XUL client and explore other
2184 platforms. The first web client preview became available in Evergreen 2.7 when
2185 circulation was available in the new platform.
2187 The browser-based client is available due to the work of many coders, testers,
2188 bug reporters, documentors, translators, project managers, spec writers, funders
2189 and other contributors over the past four years.
2191 The Evergreen project would like to acknowledge the following organizations
2192 that funded development of the Web Staff Client:
2195 * British Columbia Libraries Cooperative
2196 * Consortium of Ohio Libraries
2198 * Georgia Public Library Service
2199 * Grand Rapids Public Library
2201 * Kenton County Public Library
2202 * King County Library System
2205 * Pennsylvania Integrated Library System
2206 * Pioneer Library System
2209 The Evergreen project would also like to thank the following individuals who
2210 contributed code, translations, documentation patches, tests, bug reports,
2211 technical specifications, and project management to the Web Staff Client:
2248 * Freddy Enrique Pelayo Huapalla
2274 Evergreen 3.0 Acknowledgments
2275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2277 The Evergreen project would like to acknowledge the following
2278 organizations that commissioned developments in this release of
2282 * British Columbia Libraries Cooperative (BC Sitka)
2284 * Georgia Public Library Service
2285 * King County Library System
2287 * Pennsylvania Integrated Library System
2288 * Pioneer Library System
2290 We would also like to thank the following individuals who contributed
2291 code, translations, documentation patches, and tests to this release of
2340 We also thank the following organizations whose employees contributed
2343 * British Columba Libraries Cooperative
2347 * Emerald Data Networks, Inc.
2348 * Equinox Open Library Initiative
2350 * Grand Rapids Public Library
2351 * Indiana State Library
2353 * King County Library System
2354 * Lake Agassiz Regional Library
2355 * Laurentian University
2356 * Linn-Benton Community College
2358 * Merrimack Valley Library Consortium
2360 * North of Boston Library Exchange
2361 * Pennsylvania Integrated Library System
2362 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2364 * Traverse Area District Library
2366 We regret any omissions. If a contributor has been inadvertently
2367 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob