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 * The patron triggered event screen now respects the
27 `circ.staff.max_visible_event_age` library setting.
28 * Fixes an issue which caused an exception to be thrown during
29 non-cataloged item checkout.
30 * Fixes permission issues related to merging users.
31 * The bibliographic record summary now displays the call number that
32 matches the library's classification system.
33 * The copy editor now makes shelving locations visible to catalogers
34 from other libraries as needed.
35 * Once a record is overlayed in the Z39.50 screen, it is no longer
37 * Several fixes to the filters on the Holdings View screen.
38 * Several fixes to how empty volumes are created and displayed.
39 * Fixes to item and call number transfers.
40 * Fixes several issues with the item status list view.
41 * When adding new copies, the circulation library now defaults to the
42 call number's owning library.
43 * Fixes display issues with the Print Item Labels page.
44 * Fixes an issue in which the staff client and the OPAC displayed
45 different counts of available items.
49 We would like to thank the following individuals who contributed code,
50 tests and documentation patches to the 3.0.11 point release of
70 This release contains bug fixes improving on Evergreen 3.0.9. Note that
71 all bug fixes refer to the web staff client unless otherwise specified.
76 * Fixes right-click issues with the Web client grids
77 * Fixes an issue with the Default SMS Carrier in the patron edit form.
78 * Fixes an issue that allowed overdue notices to be sent to a patron
79 whose long overdue item has been paid for.
80 * Checking in precat items now displays the "Route to Cataloging" alert each
81 time the item is checked in.
82 * Fixes an issue in which the Adjust to Zero feature
83 does not close a checked-in lost circ.
84 * Deleted copies that are still checked out can now be checked in.
85 * Fixes a mislabeled column in the patron checkout grid.
86 * Fixes an error with the missing pieces functionality.
87 * Courier codes now display in the transit slip receipt preview.
88 * The Item Status grid now displays OU shortnames instead of full names
89 for the "Circulation Library" column.
90 * The Volume/Copy editor now allows users to remove a value from the Age
91 Hold Protection field.
92 * Barcode completion now works in copy buckets.
93 * The Z39.50 interface now notices when another record has been marked
95 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
97 * Fixes a performance issue for the Validate button in the MARC Editor.
98 * Fixes an incorrect close tag in the Print Item Labels toolbar.
99 * Better scoping of copy tags in search results.
100 * Electronic Resource links now open in a new tab.
101 * Fixes an issue with the fiscal year close-out operation.
102 * Improves serials item deletes.
106 We would like to thank the following individuals who contributed code,
107 tests and documentation patches to the 3.0.10 point release of
132 This release contains bug fixes improving on Evergreen 3.0.8. Note that
133 all bug fixes refer to the web staff client unless otherwise specified.
138 * Fixes specific cases in which deleted records appear in search results.
139 * Fixes a performance issue with deleting patrons.
140 * The hold shelf dialog popup now lists the patron's notification
142 * Fixes an issue that prevented editing items when a monograph part
144 * Patron information is now available for use in the bills_current
145 and bills_historical receipt templates.
146 * The browser's "This page may contain unsaved data" warning now
147 appears when users click the update
148 expire date button in a patron account and attempt to navigate away
150 * The holds tab of the patron record now includes a monograph part
152 * The barcode box in the checkout screen
153 no longer hovers above patron record tabs when
154 staff users scroll down.
155 * Fixes an issue with the date of birth in the patron edit scren.
156 * Fixes an issue with the dropdown of billing type options.
157 * The Item Status screen now includes as a floating group column.
161 We would like to thank the following individuals who contributed code,
162 tests and documentation patches to the 3.0.9 point release of
165 * BC Libraries Cooperative
171 * Blake Graham-Henderson
188 This release contains bug fixes improving on Evergreen 3.0.7. Note that
189 all bug fixes refer to the web staff client unless otherwise specified.
197 * The MARC editor now handles 008 fields better.
198 * Adds spaces between subfields when suggesting a call
199 number for a new volume.
200 * MarcXML exports from the MARC Batch Import/Export ->
201 Export Records screen now downloads the file, rather than opening
203 * The Item Status Circulation Library column now displays a
204 shortname rather than the full library name.
205 * The Item Status Remaining Renewals column now displays
207 * The Item Status now has a "Last Renewal Workstation" column
209 * Fixes the circulation counts displayed in Item Status Details.
210 * Fixes an issue where multiple copies with different values for required
211 statistical categories could not be edited and saved in batch.
212 * Add an option to remove floating in the copy editor.
213 * Fixes an issue with the floating dropdown in the copy editor.
214 * Fixes a problem in which the copy template didn't properly copy
216 * Reduces the number of API calls that the MARC Editor requires.
221 * Fixes an issue that prevented the offline patron registration
223 * Fixes an issue with searching patrons by permission group.
224 * The barcodes in the patron search are now clickable.
225 * Staff members can now manually override the patron juvenile
226 flag value, regardless of the patron's date of birth.
227 * Checkboxes on patron registration screen are now properly aligned
229 * The user permission group dropdowns in the patron registration,
230 edit, and search interfaces now have scrollbars.
231 * The date picker on the checkout screen is now hidden unless
232 circ staff activates a specific due date option.
233 * The check-in screen now includes a copy status column.
234 * The Merge Patrons interface now displays the date of birth.
235 * The user bucket screen now displays the Bucket ID.
236 * The payment button on patron bills screen is now inactive if the
237 Payment Received field is blank.
238 * The Bill History receipt now includes a Finish date and a Last
240 * When a patron summary contains an image of the patron,
241 that image tag now has a null alt attribute to remove it from
242 the flow of a screen reader.
243 * Corrects an issue that caused the transit dialog to show the
245 * Corrects an issue with printing transit lists.
246 * "Find another target" on transiting hold no longer leaves the
248 * The images now display to distinguish hold and transit slips.
249 * The Clearable Holds list printout now only shows holds that have
251 * Restores the call number prefix and suffix fields to the holds
253 * The documentation at the top of the hold shelf slip template
255 * The cursor in the in-house use screen now automatically goes
256 to the barcode field.
257 * The in-house use screen now shows a copy status column.
258 * Add support for converting change to patron credit in the patron bills
259 interface, consistent with the XUL feature.
260 * Fixes a bug that caused pickup/request library fields to be
262 * Fixes a bug in the offline org unit tree.
264 Command-line system administration
265 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
267 * The novelist entry in `eg_vhost.conf` includes two new
269 * Corrects an issue with the `--max-sleep` argument on the
270 `action_trigger_runner.pl` support script.
271 * Corrects an issue with how the `eg_pbx_allocator.pl` script
272 detects an existing lock file.
273 * The 3.0.2-3.0.3 upgrade script disables triggers before
274 recalculating bib visibility.
279 * Fixes an issue that caused records with located URIs to be
280 retrieved in Copy Location and Copy Location Group searches.
281 * Fixes an error message that appeared in the search box
282 in the public catalog while placing hold after an advanced search.
283 * Restores the display of copy information for the user's
284 preferred library in the public catalog.
285 * Fixes regression errors in the search results page.
286 * Removes redundant call numbers from the Show More Details
288 * The cast field in the catalog is now taken from the 511 field
289 when first indicator = 1, rather than the 508.
290 * Fixes a display issue caused by editing holds.
295 * Fixes an issue that prevented users from searching for
296 receivable issues using Database ID or ISSN in the Serials
297 Batch Receive interface.
302 * Adds some padding to the bottom of Web Client interfaces.
303 * Logins now honor all org unit timeout settings.
304 * Evergreen will now identify and handle invalid timezones.
305 * Fixes an issue where a column header in some interfaces were automatically
306 highlighted in green when retrieving the interface.
307 * The parts column in the Item Status screen now displays parts data.
313 We would like to thank the following individuals who contributed code,
314 tests and documentation patches to the 3.0.8 point release of
349 This release contains bug fixes improving on Evergreen 3.0.6.
351 * Fixes a performance issue with the Patron Billing History screen and
352 other screens that cause Flattener.pm to re-create joins
354 * Fixes an issue that prevented patron alerts from showing to staff at
356 * Corrects the "Holdable" attribute display on the Item Status detailed
358 * Fixes the ability to delete multiple copies from Item Status.
362 We would like to thank the following individuals who contributed code,
363 tests and documentation patches to the 3.0.7 point release of
377 This release is a security release that fixes cross-site scripting
378 (XSS) vulnerabilities in the Evergreen public catalog. This release
379 also includes several other bugfixes improving on Evergreen 3.0.5.
381 Security Issue: XSS Vulnerability in Public Catalog
382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
383 This release fixes several cross-site scripting (XSS) vulnerabilities
384 in the public catalog. When upgrading, Evergreen administrators should
385 review whether any of the following templates have been customized
386 or overridden. If so, either the template should be replaced with the
387 stock version or the XSS fix (which entails adding the `| html` filter
388 in several places) applied to the customized version.
390 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
391 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
392 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
394 Note that exploiting the XSS vulnerabilities fixed in this release
395 would require either the ability to create maliciously-constructed
396 MARC bibliographic or holdings records or the ability to set a
397 maliciously constructed organizational unit name.
401 Evergreen 3.0.6 also includes the following changes:
403 * When using 'Selection Lists -> Edit MARC Order Record' in the web
404 staff client, now only one click is required to save the MARC
405 record rather than two.
406 * The volume/copy editor in the web staff client now better handles
407 editing multiple items that have different sets of statistical
408 category values assigned to them.
409 * The act of merging bibliographic records now updates bookbags
410 that referred to the source bibliographic record rather than
411 effectively deleting entries for that record.
412 * Additional columns were added to the Holds Pull List in the
414 * The patron registration form in the web staff client now correctly
415 manages setting user preferences.
416 * An error in a pgTAP unit test was corrected.
420 We would like to thank the following individuals who contributed code,
421 tests and documentation patches to the 3.0.6 security release of
437 This release contains bug fixes improving on Evergreen 3.0.4.
439 * The MARC Editor in the Web staff client now wraps long fields.
440 * The MARC Editor no longer allows catalogers to enter new lines
442 * Fixes an issue that prevented serials items from being deleted or
444 * The Web staff client Check In screen no longer reloads the whole
445 page multiple times each time an item is scanned.
446 * Fixes an issue that displayed the oldest -- rather than the newest
447 -- transit in the Web staff client Item Status page.
448 * Fixes an issue that prevented the reports module from being displayed
450 * Fixes an issue in the Web staff client reports module that caused
451 syntax errors in reports that use virtual fields and joins.
452 * Fixes an issue that prevented several dropdown menus in the Web staff
453 client from activating.
454 * Fixes an issue that created duplicate copy data when copies or
455 volumes with parts were transferred.
456 * Fixes the Trim List feature in the Web staff client Check In screen.
457 * The Item Status grid now displays the Circulation Modifier.
458 * Restores missing data from the Profile column in Place Hold patron
460 * Fixes an issue with the http -> https redirect on Apache 2.4.
461 * Fixes an color contrast accessibility issue in the Web staff
462 client and adds underlining to links in grid cells for added accessibility.
463 * Adds automated regression and unit tests for the Web staff client
465 * Adds a process for spell-checking the official documentation.
466 * Adds a script that simplifies the release process related to translations.
471 We would like to thank the following individuals who contributed code,
472 tests and documentation patches to the 3.0.5 point release of
477 * Blake Graham-Henderson
492 This release contains bug fixes improving on Evergreen 3.0.3:
494 * Fixes a bug that caused all searches limited by shelving location to
496 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
497 rather than the ordering agency's SAN.
498 * Fixes a bug that prevented Safari/iOS users from logging in to the
500 * Fixes a bug that prevented users from using the browse interface.
501 * Fixes a bug in the Item Status List view that caused incorrect due
503 * Approval code is now a required field in the web client's patron
504 credit card payment form.
505 * Fixes a bug with credit card payments that caused a receipt to print
506 showing that the patron paid the bill when the payment had not actually
508 * Fixes a bug that prevented the EDI translator from being installed on
510 * Fixes a bug that caused entries to show up multiple times in the
511 Items Out and Holds tabs in the patron record.
512 * Fixes a bug that caused grids on Bills and Patron Messages
513 screens to not display properly.
514 * The following fields are now available for the Checkout and Items Out
521 ** money_summary.balance_owed
522 ** money_summary.total_paid
523 ** money_summary.total_owed
528 * The following fields are now available on the Bill Payment receipt templates:
538 * Payment type is now a column in the payments tab of the patron record
539 Bill History section.
540 * The "Replace Barcode" function now makes it more difficult for staff
541 members to attempt to create blank patron barcodes.
542 * The patron bills screen now prevents staff members from double-clicking
543 on the Apply Payment button (which otherwise would apply two payments).
544 * Fixes a bug that prevented patrons attached to statistical categories
545 from displaying in the patron search-to-hold dialog.
546 * Fixes a performance issue related to uploading CSV files of barcodes
547 to the item status and patron bucket interfaces.
548 * Fixes several small bugs in the Spanish translation.
549 * Fixes a performance bug related to patrons logging in by barcode.
553 We would like to thank the following individuals who contributed code,
554 tests and documentation patches to the 3.0.4 point release of
576 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
577 update the visibility attributes of all bibs that make use of Located URIs or
578 bib sources. It may take a while to run on large datasets. If it it running
579 too long, it can be canceled and the following psql commands will create and
580 run a script that will perform the same action serially over time without
581 blocking writes to bibs:
584 \o /tmp/luri_visibility_update.sql
585 SELECT 'UPDATE biblio.record_entry SET ' ||
586 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
587 'WHERE id = ' || id || '; SELECT ' || id || ';'
588 FROM biblio.record_entry
590 SELECT DISTINCT cn.record
591 FROM asset.call_number cn
593 AND cn.label = '##URI##'
596 FROM asset.uri_call_number_map m
597 WHERE m.call_number = cn.id
600 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
605 \i /tmp/luri_visibility_update.sql
608 It will output the id of each updated bib so that the script can be killed
609 and then edited to remove completed bibs. The remainder can be run at a
612 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
613 we do NOT update the bib's visibility attributes, as doing so causes a loop
614 and an eventual trigger stack violation. This flag should ONLY be used when
615 forcing reingest of record attributes (NOT visibility attributes), search,
616 facet, and display fields, so if using this flag under normal operation,
617 proceed at your own risk and know that Located URI and bib source changes
618 will not be reflected in the visibility attributes of the record.
622 This release contains several bug fixes improving on Evergreen 3.0.1:
624 * Fixes several issues related to the display of located URIs and records with
625 bib sources in search results.
626 * Setting `opac_visible` to false for a copy location group now hides only
627 the location group itself, rather than also hiding every single copy in the
629 * Fixes a bug that prevented the copy editor from displaying the _fine level_
630 and _loan duration_ fields.
631 * The "Edit Items" grid action in the Item Status interface will now open
632 in the combined volume/copy editor in batch. This makes the behavior
633 consistent with the "Edit Selected Items" grid action in the copy
635 * Staff members are now required to choose a billing type when creating a
636 bill on a user account.
637 * The Web client now provides staff users with an alert and option to
638 override when an item with the Lost and Paid status is checked in.
639 * Fixes a bug where the Web client offline circ interface was not able
640 to set its working location.
641 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
643 * The MARC editor in the Web staff client now presents bib sources in
645 * Both circulation and grocery bills are now printed when a staff user selects
646 a patron account and clicks "Print Bills".
647 * Fixes an issue in the XUL serials interface the "Receive move/selected"
648 action from succeeding.
649 * Fixes a typo in the user password testing interface.
653 We would like to thank the following individuals who contributed code,
654 tests and documentation patches to the 3.0.3 point release of
673 This release contains several bug fixes improving on Evergreen 3.0.1:
675 * Copy templates created in XUL Holdings Maintenance will now be
676 automatically converted and displayed in the web staff client's
678 * The list of report templates now includes a column indicating whether
679 the template was originally created in the XUL staff client or the web
680 staff client; staff need to know this since report templates created in
681 one interface cannot be edited in the other.
682 * Call number prefixes and suffixes are now displayed in various grids
683 in the web staff client, including
684 ** Pending Copy Buckets
686 ** Checkin/Capture Holds
688 ** Patron Bills History
695 ** Bib Record View Holds
697 * Many patron fields have been redacted from the web staff client's patron
698 and record holds grids, leaving patron name, username, and ID.
699 * Fixes two bugs where patron records could fail to be saved upon editing.
700 * The web staff patron editor now better warns staff users about
701 duplicate names, IDs, phone numbers, and email addresses.
702 * Human readable labels are now displayed for certain fields in standing
704 * The patron summary in the web staff client now correctly displays
705 primary and secondary ID values.
706 * The web staff client's billing full details page now displays
707 information about the staff user that created a payment.
708 * The web staff client now requires staff users to explicitly set a
709 billing type when adding a manual bill.
710 * The web staff client's patron bill annotation modal now works.
711 * Patron barcode search completion in the web staff client now allows
712 the user to select from all of the matching patron records.
713 * The Hold Shelf Slip print template in the web staff client now has
714 access to the call number.
715 * The Checkout Receipt print template in the web staff client now can
716 include summary financial information, incuding current balance, total
717 paid on outstanding fines, and total owed.
718 * The web staff print templates for current and historical bills can
719 now include copy barcode and title.
720 * Fixes a bug that resulted in some catalog searches unexpectedly
722 * Fixes a bug that resulted in catalog searches that specify a location
723 limit returning incorrect results.
724 * Fixes a bug where deleted copies could make records visible in the
726 * Fixes a bug where certain queries on copies used in the public catalog
728 * Fixes a bug place a hold request in the public catalog could result
729 in "forgetting" the type and library of the user's previous search.
730 * The web staff client now respects staff user session timeouts, and
731 will log out all open tabs if a user's session has timed out.
732 * The web staff Z39.50 page will now give the staff user an alert if
733 they attempt to import a record with a duplicate TCN.
734 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
735 entries from being deleted.
736 * Fixes a bug that made using the volume/copy editor to change a copy's
738 * The administration interface for hard due dates now ensures that
739 new (or edited) ceiling dates have their time component set to end
740 of day, resolving an issue where ceiling dates would not be applied
741 during the ceiling date itself.
742 * The web staff client can now include dynamic information in browser
743 tab titles, e.g., "Smith, Jane - Checkout".
744 * The Concerto sample data set now includes data allowing for testing
745 placing holds on monographic parts.
746 * Asset merging during bibliographic record merging now correctly
747 recognizes call number prefixes and suffixes and deletes disused
749 * Fixes a bug where displaying user surveys could result in PCRUD
751 * Fixes a bug where pg_restore of an Evergreen database could fail
752 to create certain indexes on the `actor.usr` table.
756 We would like to thank the following individuals who contributed code,
757 tests and documentation patches to the 3.0.2 point release of
788 This release contains several bug fixes improving on Evergreen 3.0.0
790 * Fixes a bug in the web staff client that prevented initials from being
791 stored with copy notes.
792 * Adds billing types that may have been missed by systems that were
793 running Evergreen prior to the 1.4 release.
794 * Fixes a web staff client bug with the CSV export option available from
795 the Import Queue in the MARC Batch Import/Export interface.
796 * Adds the missing copy alert field in the web client's volume/copy
798 * Fixes a bug where the setting to require date of birth in patron
799 registration was not being honored in the web staff client.
800 * Fixes a bug in the web staff client patron registration form where the
801 password wasn't generating from the last four digits of the patron's
803 * Fixes an issue in the web staff client where the complete barcode did
804 not display in some interfaces when partial barcodes were scanned.
805 * Fixes an HTML error in the new copy tags that display on the record
807 * Fixes a web staff client bug where recording a large number of in-house
808 uses at one time doesn't display a confirmation dialog once it hits the
810 * Adds a _Print Full Grid_ action in the web staff client
811 holds pull list to allow staff to print the entire pull list as it
812 displays on the screen. This change also changes the _Export CSV_ action
813 to an _Export Full CSV_ option.
814 * Fixes an issue with the Patron Messages interface that prevented it
815 from saving column configuration changes in the web staff client.
816 * Fixes a bug in the web staff client where a billing prompt did not
817 correctly display after marking an item damaged in those systems that
818 have enabled the setting to bill for damaged items.
819 * Adds an option to the specific due date feature that allows saving
820 that due date until logout. This allows all circulations from a given
821 workstation to be due on the same date.
825 We would like to thank the following individuals who contributed code,
826 tests and documentation patches to the 3.0.1 point release of
848 The minimum version of PostgreSQL required to run Evergreen 3.0 is
849 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
851 Change to Names of Shared Libraries
852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
853 OpenSRF 3.0 changes how the shared libraries for services written in
854 C are named. If upgrading from an earlier version of Evergreen,
855 `opensrf.xml` should be edited so that shared library file names
856 listed in the `<implementation>` tag start with "lib". For example,
859 ---------------------------------------------------------------------
861 <language>C</language>
862 <implementation>oils_cstore.so</implementation>
863 ---------------------------------------------------------------------
865 should be changed to:
868 ---------------------------------------------------------------------
870 <language>C</language>
871 <implementation>liboils_cstore.so</implementation>
872 ---------------------------------------------------------------------
874 SIP Bugfix Requires SIPServer Upgrade
875 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
877 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
878 crash" requires that you also upgrade SIPServer with the fix for
879 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
880 SIP client problems." This means that if you use SIP2 with Evergreen,
881 you must also upgrade SIPServer to the latest commit in the Git
882 repository. Conversely, if you upgrade SIPServer to the latest commit
883 in Git, you must also upgrade Evergreen or, at least, apply the patch
884 for Launchpad Bug 1542495. These two patches are complementary and
885 cannot be applied independently of one another.
887 `open-ils.auth.login`
888 ~~~~~~~~~~~~~~~~~~~~~
889 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
890 API's in the `opensrf_core.xml` file.
895 ---------------------------------------------------------------------
896 --- a/Open-ILS/examples/opensrf_core.xml.example
897 +++ b/Open-ILS/examples/opensrf_core.xml.example
898 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
900 <match_string>open-ils.auth.authenticate.verify</match_string>
901 <match_string>open-ils.auth.authenticate.complete</match_string>
902 + <match_string>open-ils.auth.login</match_string>
903 <match_string>open-ils.auth_proxy.login</match_string>
904 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
905 <match_string>open-ils.actor.user.password</match_string>
906 ---------------------------------------------------------------------
910 Administrators of Evergreen who use RTL locales and who have customized
911 `style-rtl.css.tt2` should now incorporate their customizations into
914 Multi-Time Zone Installations
915 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
917 For Evergreen consortia that span more than one time zone, the following
918 query will adjust all historical, unaged circulations so
919 that if their due date field is pushed to the end of the day, it is done
920 in the circulating library's time zone, and not the server time zone.
922 It is safe to run this after any change to library time zones.
924 Running this is not required, as no code before this change has
925 depended on the time string of '23:59:59'. It is also not necessary
926 if all of your libraries are in the same time zone, and that time zone
927 is the same as the database's configured time zone.
936 for ou_id in select id from actor.org_unit loop
937 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
938 if new_tz is not null then
939 update action.circulation
940 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
941 where circ_lib = ou_id
942 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
951 Deprecation of XUL staff client
952 -------------------------------
953 Starting with the release of 3.0.0, patches that fix XUL bugs will not
954 be merged into master or backported unless they meet one or more of
955 the following conditions:
957 a. the bug is a security issue
958 b. the bug involves the destruction of data
959 c. the bug is a regression of functionality in the XUL staff client
960 introduced by other work done to Evergreen
962 Under no circumstances will XUL staff client feature enhancements be merged.
964 This policy will continue through the 3.0.x and 3.1.x maintenance
965 release cycles, and will become moot upon the release of 3.2.0, when
966 the XUL staff client is slated to be entirely removed.
975 Evergreen 3.0 features a new, modern staff client that runs in the web browser
976 and can be used on desktop and mobile devices. All functional areas of the
977 system, including circulation, cataloging, acquisitions, serials, reports,
978 booking, administration, and offline circulation, are available in the new staff
979 client. Chrome and Firefox are officially supported for use with the web client.
981 Library staff will no longer need to download separate software to perform most
982 actions in Evergreen. A Chrome plugin called Hatch will be available as a
983 separate installation for workstations that require seamless, dialog-free
984 printing to multiple printers.
986 In addition to adding more portability and stability, the new staff client also
987 presents a cleaner and more modern interface for users. By virtue of running in
988 a browser, actions that users are accustomed to performing on other web sites
989 should now be available in the Evergreen client.
991 The old, XUL client will continue to be available to allow for a gradual
992 transition to the browser-based client, but no new features will be added. The
993 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
1003 New EDI Order Generator
1004 ^^^^^^^^^^^^^^^^^^^^^^^
1009 . New database tables exist for configuring vendor-specific EDI order
1013 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
1015 * `acq.edi_attr_set`
1016 ** Collection of `edi_attr`s. Each edi_account may be linked to one
1018 ** One `edi_attr_set` per known vendor is added to the stock data, matching
1019 the stock configuration found in the JEDI template.
1020 * `acq.edi_attr_set_map`
1021 ** Link between `edi_attr`s and `edi_attr_set`s.
1023 . EDI Attribute Sets are manged via a new (browser client only) configuration
1024 interface at 'Administration -> Acquisitions Administration -> EDI
1027 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
1028 is not set, default values will be used. Links between an EDI account
1029 and an attribute set are managed in the EDI Accounts configuration
1032 . Local modifications to the stock EG JEDI template are managed by modifying
1033 and/or adding additional `edi_att_set`s as needed.
1035 . A new `edi_order_pusher.pl` script is added which replaces the functionality
1036 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
1038 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
1039 definition is no longer required and can be disabled.
1044 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
1045 specifies whether PO's generated via the account should be built using
1046 EDI attributes or fall back to traditional JEDI A/T template generation.
1048 This allows sites to activate EDI attributes on a per-account basis, making
1049 it possible to migrate piecemeal to EDI attributes. For the initial roll
1050 out of this new feature, no accounts will be configured to use EDI
1051 attributes by default.
1057 3 Day Courtesy Notice by SMS
1058 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1059 New optional SMS text notification to be sent out 3 days prior to the due
1060 date of any circulating item for patrons who have an SMS text number and
1061 carrier stored in their accounts. This action trigger is disabled by default,
1062 but can be enabled and modified by going into 'Administration -> Local Administration ->
1063 Notifications / Action Triggers'.
1065 You may wish to make use of granularity so that these messages are batched
1066 and sent at the same time each day.
1071 Add Description Field to Circulation and Hold Configuration Entries
1072 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1073 The circulation and hold policy configuration rules now each have a
1074 description field. This allows administrators to add comments to
1075 describe the purpose of each rule.
1080 Apache Internal Port Configuration Option
1081 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1082 Apache configuration now supports a new variable which allows admins to
1083 specify the port used by Apache to handle HTTP traffic. The value is
1084 used for HTTP requests routed from Perl handlers back to the same Apache
1085 instance, like added content requests. Use this when running Apache
1086 with a non-standard port, typical with a proxy setup. Defaults to "80".
1089 -------------------------------------------------------------------
1092 PerlSetVar OILSWebInternalHTTPPort "7080"
1095 -------------------------------------------------------------------
1100 Configurable Bib Record Display Fields
1101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1103 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
1104 fields: 'Display Field?' and 'Display XPath'.
1106 When 'Display Field' is set to true, data from the field will be extracted
1107 from each record and added to a new table of display data for each bib
1110 If a value is present in the 'Display XPath' field, this XPath will be
1111 applied to the extracted data *after* the base XPath (from the 'XPath'
1112 field) is applied to each field.
1114 This data acts as a replacement for the various and sundry ways bib record
1115 data is currently extracted, including inline XPath in the TPAC, reporter
1116 views, real-time 'MVR' compilation from MODS, etc. and will be available
1117 to the user interface, notification templates, etc. for rendering bib
1120 The browser client gets a new service 'egBibDisplay' which is capable
1121 of translating the display field data from various formats into
1122 data more suitable for JavaScript usage.
1124 The database gets 3 new views for representing display data in various
1127 * `metabib.flat_display_entry`
1128 ** List of all display fields linked to their configuration.
1129 * `metabib.compressed_display_entry`
1130 ** Same as `metabib.flat_display_entry` except there's one row
1131 per display field type, with 'multi' rows compressed into
1132 JSON arrays. Non-multi fields are represented as JSON
1134 * `metabib.wide_display_entry`
1135 ** Tabular view of display field data, one column per well-known
1136 field. Values are represented JSON, consistent with
1137 `metabib.flat_display_entry`. The view does *not* contain locally
1138 configured display fields, as each field must be encoded in
1139 the view and IDL definition. This is essentially a replacement
1140 for `reporter.simple_record`.
1145 After making changes to display field configuration, it's possible to
1146 reingest only display field data in the database using the following:
1149 ---------------------------------------------------------------------
1150 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
1151 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1152 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1153 ---------------------------------------------------------------------
1159 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1160 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1161 The existing permission was incorrectly created with a code of
1162 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1163 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
1164 update changes the permission code to match what the event requires.
1170 Hold Targeter V2 Repairs and Improvements
1171 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1172 * Make the batch targeter more resilient to a single-hold failure.
1173 * Additional batch targeter info logging.
1174 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1175 * Removes the confusingly named `--target-all` option
1176 ** The same behavior can be achieved by using `--retarget-interval "0s"`
1177 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1179 New --next-check-interval Option
1180 ++++++++++++++++++++++++++++++++
1181 Specify how long after the current run time the targeter will retarget
1182 the currently affected holds. Applying a specific interval is useful
1183 when the retarget-interval is shorter than the time between targeter
1186 For example, if the targeter is run nightly at midnight with a
1187 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1188 since the holds won't be processed again until 48 hours later. This
1189 ensures that the org unit closed date checks are looking at the correct
1192 This setting overrides the default behavior of calculating the next
1193 retarget time from the retarget-interval.
1195 New --soft-retarget-interval Option
1196 +++++++++++++++++++++++++++++++++++
1197 This is a replacement for (and rebranding of) the `--skip-viable` option.
1198 The new option allows for time-based soft-targeting instead simple binary
1199 on/off soft-targeting.
1201 How soft-targeting works:
1203 * Update hold copy maps for all affected holds
1204 * Holds with viable targets (on the pull list) are otherwise left alone.
1205 * Holds without viable targets are retargeted in the usual manner.
1211 New marc_export --descendants Option
1212 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1214 The `marc_export` script has a new option, `--descendants`. This option
1215 takes one argument of an organizational unit shortname. It works much
1216 like the existing `--library` option except that it is aware of the
1217 org. tree and will export records with holdings at the specified
1218 organizational unit and all of its descendants. This is handy if you
1219 want to export the records for all of the branches of a system. You
1220 can do that by specifying this option and the system's shortname,
1221 instead of specifying multiple `--library` options for each branch.
1223 The `--descendants` option can be repeated, as the `--library` option can.
1224 All of the specified org. units and their descendants will be included
1225 in the output. It can also be combined with individual `--library`
1226 options when necessary.
1231 RTL and LTR Public Catalog Stylesheets Merged
1232 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1233 The RTL stylesheet for the public catalog,
1234 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1235 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1236 template will provide RTL or LTR styles based on the value of
1237 the `rtl` flag of the active locale. An `rtl` variable is also available
1238 in the template to allow the correct style to be chosen.
1243 Miscellaneous Improvements
1244 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1246 * If a filter is in effect in the Library Settings Editor,
1247 the filter will continue to be applied after a user
1248 changes the selected library.
1249 * Copy templates used for serials now correctly link to age
1250 protection rules and MARC item type values (for the
1251 "Circ as Type" field). During upgrade, the database update
1252 will set to NULL any age protection and circ as type fields
1253 in serial copy templates that do not point to defined values.
1258 Obsolete Internal Flag Removed
1259 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1261 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1262 flag was removed from the `config.internal_flags` table. It was
1263 rendered obsolete by the addition of the 3 flags to control the
1264 browse, search, and facet indexing.
1269 Tweaks to Caching/Expiry of Public Catalog Assets
1270 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1271 The default cache expiration time for static assets (e.g.,
1272 CSS, image, and JavaScript files) in the public catalog and
1273 the Kid's PAC has been increased to one year. Links to all
1274 such assets now have a cache-busting value tacked on as a
1275 query parameter. This value is refreshed when `autogen.sh` is
1276 run, but it can also be manually set by adjusting the
1277 `ctx.cache_key` Template Toolkit variable.
1282 Action/Trigger Events Data Purging
1283 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1285 Action/Trigger event definitions have a new field called 'Retention
1286 Interval'. When an optional interval value is applied, events and
1287 template output data linked to the event definition will be deleted
1288 from the database once they reach the specified age.
1290 Retention Interval Restrictions for Passive Hooks
1291 +++++++++++++++++++++++++++++++++++++++++++++++++
1293 Restrictions are placed on retention interval values for event definitions
1294 using passive hooks to prevent data from being deleted while it's still
1295 needed by the system.
1297 The presence of event data is how the system knows not to send duplicate
1298 events. As long as a scenario exists where a duplicate event may be
1299 generated, the events must be retained.
1301 To apply a retention interval value to a passive-hook event definition:
1303 * The event definition must have a max_delay value.
1304 * The retention interval must be larger than the difference between
1305 the `delay` and `max_delay` values.
1307 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1308 interval must be greater than 3 days to ensure no duplicate events are
1309 created between the first event on day 7 and the end of the event validity
1315 A new `purge_at_events.sh` script is installed in the bin directory
1316 (typically `/openils/bin`) which should be added to CRON for regular
1319 NOTE: On large data sets, this script can take a long time to run and
1320 create higher than normal I/O load as it churns though the event and
1321 event_output tables. You may wish to run the script by hand the first
1322 time so it can be monitored. It can be run in psql like so:
1325 ---------------------------------------------------------------
1326 SELECT action_trigger.purge_events();
1327 ---------------------------------------------------------------
1329 NOTE: On *very* large data sets (10s to 100s of millions of event and
1330 event_output rows), it may be advisable to first repopulate the `event`
1331 and `event_output` tables with only the desired data before starting
1332 regular purges. This can be done, for example, using the copy to temp
1333 table, truncate source table, repopulate source table from temp table
1334 approach. This will be much faster than the `purge_events()` function
1335 in cases where most of the data will be purged.
1340 A number of `action_trigger.hook` entries which have always been treated
1341 as active hooks, though are configured as passive hooks, have been
1342 updated to properly reflect the non-passive-ness. This allows for
1343 simpler configuration of their retention interval values.
1349 Remove JSPAC Redirects
1350 ^^^^^^^^^^^^^^^^^^^^^^
1351 Future versions of Evergreen will no longer contain automatic redirects
1352 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1353 that the JSPAC is no longer supported. Existing sites, however, may
1354 wish to retain JSPAC redirects in their Apache configuration files since
1355 JSPAC URLs may still be used in the wild to access their catalogs.
1357 The original JSPAC URL redirects are all retained in the file
1358 `Open-ILS/examples/jspac_redirects.conf` for reference.
1368 New open-ils.auth.login API
1369 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1370 The `open-ils.auth` service has a new API for requesting an authentication
1371 token. It performs the same steps as the
1372 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1373 using the bare password. No intermediate password hashing is required.
1375 The paramaters are the same as the `.complete` call with a few modifications.
1377 1. Using the generic 'identifier' parameter in combination with the
1378 'org' parameter allows the API to reliably determine if an identifier
1379 value is a username or barcode. The caller is no longer required to
1380 make that determination up front.
1382 2. The 'nonce' parameter is no longer used.
1388 Batch Patron Contact Invalidation
1389 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1390 The following methods are used to mark patron contact fields
1391 as invalid by moving the invalid value to a standing penalty:
1393 * `open-ils.actor.invalidate.email`
1394 * `open-ils.actor.invalidate.day_phone`
1395 * `open-ils.actor.invalidate.evening_phone`
1396 * `open-ils.actor.invalidate.other_phone`
1398 These methods now accept a fifth argument specifying the value
1399 of the contact field, e.g., a specific phone number or email
1400 address. If supplied, and if a specific patron ID (the first
1401 argument) is not supplied, all patrons with that specific contact
1402 value will have it marked invalid.
1412 Pure-SQL catalog searching
1413 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1414 Public and staff catalog search is now both more accurate and faster
1415 by redesigning how the visibility of records is calculated.
1425 Authority Record and Headings Browse Improvements
1426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1427 Various improvements are made to support for authority records
1428 and headings browsing:
1430 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1431 headings from authority records. Since the MODS and MADS stylesheets
1432 extract headings in similar ways, duplicate browse entries are now
1433 much less likely to occur.
1434 * A new configuration table, `authority.heading_field`, is now used
1435 to specify how headings should be extracted from authority records.
1436 * Related headings can now be identified as narrower or broader when
1437 browsing in the public catalog.
1438 * See references are now more reliably included in the browse list.
1439 * Scope (public) notes now display only under the main heading.
1440 * There is now a global flag, Display related headings (see-also) in browse,
1441 that can be used to control whether related headings (see-alsos) are
1442 displayed in the public catalog list.
1443 * A complete set of thesauruses are now included in the seed data. Thesauruses
1444 can now be identified using short and long codes.
1445 * The labels for see and see-also references in the public catalog are
1446 a bit more patron-friendly, and can now be tweaked via TPAC template
1447 customization in the browse.tt2 file.
1453 Copy Tags and Digital Bookplates
1454 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1455 Copy tags will allow staff to apply custom, pre-defined labels or tags
1456 to copies. Copy tags are searchable in both the staff client and public
1457 catalog. This feature was designed to be used for Digital Bookplates to
1458 attach donation or memorial information to copies, but may be used for
1459 broader purposes to tag items.
1461 Each copy tag can either be publicly-visible or visible only to staff.
1462 Copy tags also have types that can be used for restricting catalog
1463 searches on copy tags to particular types.
1465 Copy tags are displayed in the copy table in the record summary page in
1466 the public catalog, and a new library setting can be used to add
1467 a "Digital Bookplate" search field. Copy tags can also be used
1468 as a search filter, e.g.,
1470 * `copy_tag(bookplate, jane smith)`: search for records that have a
1471 copy tag of type 'bookplate' whose value contains 'jane smith'.
1472 * `copy_tag(*, jane smith)`: search for records that have a
1473 copy tag of any type whose value contains 'jane smith'.
1475 All staff-side interfaces related to copy tags exist only in the web
1476 staff client. There are two new administration interfaces for managing
1477 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1478 button for applying copy tags to copies; that interface can also be
1479 used to create new copy tags on the fly. Furthermore, the copy buckets
1480 interface now has an 'Apply Tags' action for assigning tags to groups
1486 Two new permission are included:
1488 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1489 'Administration -> Server Administration -> Copy Tag Types'
1490 * `ADMIN_COPY_TAG`: required to create a new tag under
1491 'Administration -> Local Administration -> Copy Tags'
1493 The existing permission `UPDATE_COPY` controls whether or not a user
1494 can link copies to tags.
1498 A new library setting, 'Enable Digital Bookplate Search', controls
1499 whether to display a 'Digital Bookplate' field in the search index
1500 drop-downs in the catalog. A 'Digital Bookplate' search will include
1501 all records that have a copy that matches the tag specified by the user.
1502 It should be noted that this library setting does not affect the
1503 display of copy tags on the catalog record summary page.
1508 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1509 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1510 The call number prefix and suffix, when present, are now included in
1511 subfields $k and $m of the 852 field when running `marc_export` with
1512 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1513 server configured to embed item data in 852 fields, the affixes are now
1514 included in subfields $k and $m.
1524 Batch Editing of Patron Records
1525 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1526 There is a now a new interface analogous to the Copy Bucket interface
1527 to select and group a set of users into a User Bucket.
1528 The addition of users to a User Bucket is possible from the Patron Search
1529 interface by the use of a new grid Action, and directly on the User Bucket
1530 interface by user barcode. It is also possible to add users to a User
1531 Bucket by uploading a text file that contains a list of user barcodes.
1533 From this interface it is possible to perform a set of specific batch update
1534 operations on user records.
1539 These fields can now be changed in batch via an action on the User Bucket
1540 grid if the staff user has the `UPDATE_USER` permission:
1543 * Primary Permission Group (group application permissions consulted)
1545 * Home Library (`UPDATE_USER` checked against both old and new value)
1546 * Privilege Expiration Date
1547 * Barred flag (`BAR_PATRON` permission consulted)
1548 * Internet Access Level
1550 Changes made in this interface can be rolled back.
1552 As a batch process, rather than a direct edit, this mechanism explicitly skips
1553 processing of Action/Trigger event definitions for user update.
1558 The batch edit mechanism also allows for the batch deletion of user. The staff
1559 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1561 Changes made in this interface can be rolled back.
1563 As a batch process, rather than a direct edit, this mechanism explicitly skips
1564 processing of Action/Trigger event definitions for user deletion.
1566 This mechanism does not use the Purge User functionality, but instead simply
1567 marks the users as deleted.
1569 Editing Statistical Category Entries
1570 ++++++++++++++++++++++++++++++++++++
1572 All users in the bucket can have their Statistical Category Entries
1573 modified. Unlike user data field updates, modification of Statistical
1574 Category Entries is permanent and cannot be rolled back.
1576 As a batch process, rather than a direct edit, this mechanism explicitly skips
1577 processing of Action/Trigger event definitions for user update.
1579 New Service Requirement
1580 +++++++++++++++++++++++
1582 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1583 unused in production. If this service has been removed from the configuration
1584 of a live Evergreen instances, it will need to be added back in order for
1585 batch user editing to succeed.
1590 Honor Timezone of the Acting Library
1591 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1596 * Display day-granular due dates in the circulating library's timezone.
1597 * Only display the date portion of the due date for day-granular circulations.
1598 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1599 * Provide infrastructure for more advanced formatting of timestamps.
1600 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1605 This is a followup to the work done for 2.12, where we added the ability
1606 for the client to specify a timezone in which timestamps should be interpreted
1607 in business logic and the database.
1609 Most specifically, this work focuses on circulation due dates and the closed
1610 date editor. Due dates, where displayed using stock templates (including
1611 receipt templates) and used for fine calculation, are now manipulated in the
1612 library's configured timezone. This is controlled by the new 'lib.timezone'
1613 setting available via the Library Settings Editor, loaded from the server when
1614 required. Additionally, closings are recorded in the library's timezone so that
1615 due date calculation is more accurate. The closed date editor is also
1616 taught how to display closings in the
1617 closed library's timezone. Closed date entries also explicitly record if they
1618 are a full day closing, or a multi-day closing. This significantly simplifies
1619 the editor, and may be useful in other contexts.
1621 To accomplish this, we use the moment.js library and the moment-timezone addon.
1622 This is necessary because the stock AngularJS date filter does not understand
1623 locale-aware timezone values, which are required to support DST. A simple
1624 mapper translates the differences in format values from AngularJS date to
1627 Of special note are a set of new filters used for formatting timestamps under
1628 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1629 filters provide the functionality, and autogrid is enhanced to make use of
1630 these where applicable. egGrid and egGridField are also taught to accept
1631 default and field-specific options for applying date filters. These filters may
1632 be useful in other or related contexts.
1634 The egDueDate filter, used for all existing displays of due date via Angular
1635 code, intentionally interprets timestamps in two different ways WRT timezone,
1636 based on the circulation duration. If the duration is day-granular (that is,
1637 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1638 of seconds) then the date is interpreted as being in the circulation library's
1639 timezone. If it is an hourly loan (any duration that does not meet the
1640 day-granular criterium) then it is instead displayed in the client's timezone,
1641 just as all other timestamps currently are, because of the previous Evergreen
1644 The public catalog is adjusted to always display the due date in the circulating
1645 library's timezone. Because the public catalog displays only the date portion of the due
1646 date field, this difference is currently considered acceptable. If this proves
1647 to be a problem in the future, a minor adjustment can be made to match the
1648 egDueDate filter logic.
1650 Now that due dates are globally stored in the configured timezone of the
1651 circulating library, the automatic adjustment to day-granular due dates needs
1652 to take those timezones into account.
1654 An optional SQL command is provided by the upgrade script to retroactively
1655 adjust existing due dates after library configuration is complete.
1661 Enhancements to Hard Due Date Functionality
1662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1663 It will now be possible to delete Hard Due Date Values for dates that have
1664 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1665 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1666 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1671 Patron Search by Birth Date
1672 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1673 * Now you can include the patron birth year and/or birth month and/or
1674 birth day when searching for patrons using the web staff client.
1675 * Day and month values are exact matches. E.g. month "1" (or "01")
1676 matches January, "12" matches December.
1677 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1678 1915, 1599, etc. For exact matches use the full 4-digit year.
1682 Patron Search from Place Hold
1683 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1684 This feature allows staff members, when placing a
1685 hold on behalf of a patron in the web staff client, to search for
1686 patrons by names and other searchable patron information, rather than
1687 relying on barcode alone. In particular, after performing a catalog
1688 search or going to a specific bib record and clicking the 'Place Hold'
1689 button, the form now includes a 'Patron Search' button. This button
1690 will open a dialog allowing the staff member search for and select
1696 Retrieve Recent Patrons
1697 ^^^^^^^^^^^^^^^^^^^^^^^
1699 Adds a new library setting 'Number of Retrievable Recent Patrons'
1700 ('ui.staff.max_recent_patrons') that specifies the number of recently
1701 retrieved patrons that can be re-fetched from the staff client.
1703 A value of 0 means no recent patrons can be retrieved.
1704 A value greater than 1 means staff will be able to retrieve multiple
1705 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1707 The default value is 1 for backwards compatibility.
1714 Fuller title in XUL client Simplified Pull List
1715 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1716 The Simplified Pull List in the XUL client will now display subfields 245$n and
1717 $p in the title field. The addition will make it easier for staff to distinguish
1718 between different parts or seasons in a series.
1724 Transit Cancel Time and Terminology Change
1725 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1730 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1731 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1732 are preserved in the database, though still not visible to the end user in the staff client.
1733 This allows for better tracking of when transits are canceled for the purposes of knowing
1734 which staff member canceled the transit, etc.
1736 NOTE: This change may require the re-creation of transit reports to filter out canceled
1737 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1738 Is NULL' will suffice.
1740 "Canceled Transit" Terminology Change
1741 +++++++++++++++++++++++++++++++++++++
1743 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1744 For internal continuity, however, the following permission codes have not changed:
1747 * `ABORT_REMOTE_TRANSIT`
1748 * `ABORT_TRANSIT_ON_LOST`
1749 * `ABORT_TRANSIT_ON_MISSING`
1757 Offline Circulation Available in Web Staff Client
1758 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1759 Offline circulation is now available in the web staff client. In order to use the
1760 offline interface, users must first log into the web staff client, perform
1761 a patron search, select a user from the results, and open the patron editor
1762 interface to collect all the relevent configuration information for the
1763 workstation. In addition, the offline interface available from the Circulation
1764 menu provides a 'Download block list' button for users who are logged in.
1766 As is the case in the old staff client, users can check materials in and out,
1767 renew items, and create new patron accounts while offline. The patron fields
1768 available in the offline patron registration editor are the same ones that
1769 are available to staff when working online.
1773 Add Circ Modifier to Record Detail Page in Staff TPAC
1774 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1775 The circulation modifier field is added to the table of copies to make
1776 more information available to staff without having to open
1783 Date+Time Format Settings for Web Client
1784 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1786 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1787 and adds two settings for use with the webstaff client:
1789 * 'Format Dates with this pattern'
1790 * 'Format Date+Time with this pattern'
1792 These settings use format strings as documented here:
1794 https://docs.angularjs.org/api/ng/filter/date
1796 There is overlap with how the Dojo formats worked, but also some differences.
1798 The original 'Format Dates' and 'Format Times' settings worked together, but the
1799 new settings work independently. Certain field elements will use one, and
1800 certain field elements will use the other. These distinctions are hard-coded
1801 in the various UI templates, with the idea being that timestamp fields in
1802 which the date component alone is sufficient information (for example, date of birth)
1803 will use the 'Format Dates' setting. Fields where the time component is
1804 important (for example, checkout time) will use the 'Format Date+Time' setting.
1806 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1807 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1813 Global Option to Remove Sound for a Specific Event
1814 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1815 A new `nosound.wav` file has been added to the web client. The file can be used
1816 to globally disable audio alerts for a specific event on an Evergreen system.
1818 For example, to silence the alert that sounds after a successful patron search:
1822 mkdir -p /openils/var/web/audio/notifications/success/patron/
1823 cd /openils/var/web/audio/notifications/success/patron/
1824 ln -s ../../nosound.wav by_search.wav
1831 The official Evergreen manual has been split into eight new manuals, each
1832 designed for a specific audience. This new approach is designed to make
1833 the documentation more readable and usable.
1835 The specific audiences for the new manuals are:
1837 * Acquisitions staff
1840 * Public services staff who use the public catalog
1842 * System administrators who use the command line
1843 * System administrators who use the Web client
1844 * System administrators and programmers who wish to integrate Evergreen
1845 with other technologies
1847 All manuals are available at http://docs.evergreen-ils.org
1853 Improvements to ebook API
1854 ^^^^^^^^^^^^^^^^^^^^^^^^^
1856 Evergreen now supports checking out and placing holds on
1857 OverDrive and OneClickdigital ebook titles from within the public
1858 catalog. This is an experimental feature. It is not recommended for production
1859 use without careful testing.
1861 When ebook integration is enabled, a "Check Out E-Item" link will be
1862 displayed when viewing an ebook title from a supported vendor in the
1863 catalog. Clicking on the link allows the user to check out and download
1864 that title from the vendor directly within the catalog.
1866 If no copies are available for the title, a "Place Hold on E-Item" link
1867 is displayed instead, and the user may place a hold on the title. (Note
1868 that some vendors require the user's account to have an email address
1869 before permitting a hold.)
1871 My Account includes the ability to view current ebook checkouts and
1872 holds, download already-checked-out titles, and cancel holds.
1874 For API integration to work, you need to request API access from the
1875 vendor, and the vendor must have a way of authenticating your patrons.
1876 Your Evergreen system also needs to be configured for ebook API
1877 integration, following the instructions in the command line system
1878 administration manual
1881 This feature assumes that you are importing MARC records supplied by the
1882 vendor into your Evergreen system, using Vandelay or some other MARC
1883 import method. This feature does not search the vendor's online
1884 collections or automatically import vendor records into your system; it
1885 merely augments records that are already in Evergreen.
1887 Improvements to Bill Payment Pages
1888 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1889 The bill payment pages in the public catalog have been revamped
1892 * use the term "charges" instead of "fees"
1893 * include images of credit cards accepted
1894 * make the default print receipt template match other itemized receipts;
1895 note that this change is not automatically applied when upgrading.
1896 * display billing type
1897 * add button to pay only selected charges
1898 * reformat the credit card number input page
1904 Clickable Copy Locations
1905 ^^^^^^^^^^^^^^^^^^^^^^^^
1906 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1907 the associated copy location will display as a link in the public catalog summary display.
1908 This link can be useful for retrieving maps or other directions to the copy
1909 location to aid users in finding material.
1914 Download Checkout History CSV Fixed for Large Number of Circulations
1915 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1916 Downloading checkout history as a CSV from My Account has been fixed
1917 for users with a large circulation history. Previously, this would
1918 time out for patrons with more than 100 or so circulations.
1920 This feature no longer uses the action/trigger mechanism and the public catalog
1921 now generates the CSV directly. The old action/trigger code is still
1922 present in the database and should be removed at some point in the
1928 Google Books Preview Rewrite
1929 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1930 The Google Books Preview functionality in record detail pages has been
1931 rewritten to modernize its style and optimize its performance:
1933 * The Dojo JavaScript framework is no longer used, saving approximately
1934 150K of JavaScript and CSS and four network requests per page load.
1935 * The Embedded Viewer is not loaded unless a possible preview is found,
1936 saving more network and memory overhead.
1937 * The Google Books Loader is used to load the Embedded Viewer instead of the
1938 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1940 * All variables are self-contained and do not pollute the global namespace.
1941 * Event listeners are registered to handle clicks, rather than attaching
1942 `href="javascript:function()"` to <a> elements.
1943 * Book previews are displayed in a panel sized according to the viewport
1944 of the browser, improving its appearance on both mobile and desktop
1946 * The rewritten code is now served up directly from
1947 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1952 jQuery for the Public Catalog
1953 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1954 This release adds optional support for jQuery in the public catalog. This support
1955 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1956 `config.tt2` template.
1962 New Popularity Parameters
1963 ^^^^^^^^^^^^^^^^^^^^^^^^^
1964 New popularity parameters for in-house use over time and for count of distinct
1965 organizational units that own a title are now available. Evergreen sites
1966 can use these parameters to create new statistical popularity badges for
1967 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1969 The in-house use parameters will apply a badge to titles that have the most
1970 in-house use activity over time. The organizational unit count parameter
1971 will apply a badge to titles owned by the most number of libraries in a
1972 consortium. Ownership is determined by the copy's circulation library.
1977 Option to Suspend Holds at the Time They are Placed
1978 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1979 Users now have the option to suspend a hold at the same time they place the
1980 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1981 who want to suspend a hold at the time it is placed. There is also an option
1982 to set the activation date at the same time. This option is also available
1983 when placing holds on a batch of titles from 'My List' and will apply to
1984 all the titles in the batch.
1995 Fix to reporter.classic_current_circ View
1996 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1997 The `reporter.classic_current_circ` view, which is part of some
1998 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1999 has been fixed to not exclude loans for patrons who do not have a
2000 billing address set. Users of this view should rerun
2001 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
2006 New Report Source Table Allowing Report of "Last" Deleted copy
2007 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2009 This source table allows you to construct a clever aggregate report template
2010 which will report bibliographic IDs where a library or a group of libraries
2011 no longer have a copy attached but *had* a copy attached. This is especially
2012 useful when a holdings sync is required with an external vendor.
2015 Instructions for creating a report template with this source:
2017 * Create a new report template using "Library Holdings Count with Deleted" as the source
2018 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
2019 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
2020 * 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"
2021 * Add "Bib ID" to Displayed Fields
2022 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
2023 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
2024 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
2027 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
2028 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
2029 specified date range. Unfortunately the user will have to manually type the date range without the date
2030 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
2031 copy and more than two deleted copies."
2036 Add Provider to Provider Note Link
2037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2038 The Provider reporting source now includes a link to the Provider Note reporting source.
2043 Link ILS User and Working Location Reporting Sources
2044 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2045 The Working Location reporting source now has labels
2046 and it is now linked to the ILS User reporting source, allowing
2047 reports to display or filter on staff working location.
2052 New Circulation Report Source "All Circulation Combined Types"
2053 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2055 This report source will allow you to create a single report template for all of the following:
2058 * In-house uses of non-cataloged items
2060 * Circulations of non-cataloged items
2062 To distinguish between these different types of library use, it's important to display these columns
2063 in your report templates:
2072 Reports Template Searching
2073 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2074 A new form appears along the top of the reports interface for searching
2075 report templates. Once found, typical template actions (e.g. create new
2076 report) are available from within the results interface.
2078 Searches may be performed across selected (visible) folders or all
2079 folders visible to the logged in user.
2081 Searches are case-insensitive, any word order, with left-anchored words.
2082 All searched words must appear in at least one of the searched fields.
2087 * Searching for 'stat cat' matches:
2089 ** statistical category
2090 ** categories, statistical
2091 ** patrons (stat cat)
2092 * Searching for 'stat cat' does not match:
2094 *** both words must be present in the searched field(s)
2096 *** location contains 'cat' but it's not left-anchored.
2101 The templates, reports, and output interfaces now support paging via
2102 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2114 Web Staff Client Serials Module
2115 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2116 The serials module has been ported over to the web staff
2117 client, implementing a unified serials interface that combines
2118 ideas from both the serial control view and alternate serials
2119 control view from the old staff client.
2121 In addition to carrying over functionality that was available
2122 in the old staff client, several new features are included:
2124 * the ability to save prediction pattern codes as templates
2125 that can be shared and reused within an Evergreen database
2126 * a more streamlined interface for managing subscriptions,
2127 distributions, and streams
2128 * it is no longer necessary to create a starting issue in
2129 order to predict a run of issues; the dialog box for
2130 generating a set of predicted issues now lets you specify
2131 the starting point directly.
2132 * the ability to more directly edit MFHDs
2134 The new serials interfaces can be accessed from the record
2135 details page via a Serials drop-down button that links to
2136 a subscription management page, a quick-receive action, and
2137 a MFHD management page. There is also a new 'Serials Administration'
2138 page where prediction pattern and serial copy templates can
2149 SIP Bugfix Changes How Encoding Is Determined in Configuration
2150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2152 The combined fix for the above mentioned SIP bugs alters the way that
2153 SIPServer looks up the output encoding in the configuration file (typically
2154 `oils_sip.xml`). SIPServer now looks for the encoding in the following
2157 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2158 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2159 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.
2160 4. If none of the above exist, then the default encoding (ASCII) is used.
2162 Number 3 is provided to ease the transition to the new code. It is
2163 the current location of the +encoding+ element in the sample
2164 configuration file and as such, where it is likely to be found in
2165 actual files. It is recommended that you alter your configuration to
2166 move this element out of the +implementation_config+ element and into
2167 its parent +institution+ element. Ideally, SIPServer should *not* look into
2168 the implementation config, and this check may be removed at some time
2176 Web Client Acknowledgments
2177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2179 The project to develop a new browser-based web client launched four
2180 years ago at the September 2013 Evergreen developer hack-a-way when the
2181 developer community voted to move away from the XUL client and explore other
2182 platforms. The first web client preview became available in Evergreen 2.7 when
2183 circulation was available in the new platform.
2185 The browser-based client is available due to the work of many coders, testers,
2186 bug reporters, documentors, translators, project managers, spec writers, funders
2187 and other contributors over the past four years.
2189 The Evergreen project would like to acknowledge the following organizations
2190 that funded development of the Web Staff Client:
2193 * British Columbia Libraries Cooperative
2194 * Consortium of Ohio Libraries
2196 * Georgia Public Library Service
2197 * Grand Rapids Public Library
2199 * Kenton County Public Library
2200 * King County Library System
2203 * Pennsylvania Integrated Library System
2204 * Pioneer Library System
2207 The Evergreen project would also like to thank the following individuals who
2208 contributed code, translations, documentation patches, tests, bug reports,
2209 technical specifications, and project management to the Web Staff Client:
2246 * Freddy Enrique Pelayo Huapalla
2272 Evergreen 3.0 Acknowledgments
2273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2275 The Evergreen project would like to acknowledge the following
2276 organizations that commissioned developments in this release of
2280 * British Columbia Libraries Cooperative (BC Sitka)
2282 * Georgia Public Library Service
2283 * King County Library System
2285 * Pennsylvania Integrated Library System
2286 * Pioneer Library System
2288 We would also like to thank the following individuals who contributed
2289 code, translations, documentation patches, and tests to this release of
2338 We also thank the following organizations whose employees contributed
2341 * British Columba Libraries Cooperative
2345 * Emerald Data Networks, Inc.
2346 * Equinox Open Library Initiative
2348 * Grand Rapids Public Library
2349 * Indiana State Library
2351 * King County Library System
2352 * Lake Agassiz Regional Library
2353 * Laurentian University
2354 * Linn-Benton Community College
2356 * Merrimack Valley Library Consortium
2358 * North of Boston Library Exchange
2359 * Pennsylvania Integrated Library System
2360 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2362 * Traverse Area District Library
2364 We regret any omissions. If a contributor has been inadvertently
2365 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob