1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.7. Note that
9 all bug fixes refer to the web staff client unless otherwise specified.
17 * The MARC editor now handles 008 fields better.
18 * Adds spaces between subfields when suggesting a call
19 number for a new volume.
20 * MarcXML exports from the MARC Batch Import/Export ->
21 Export Records screen now downloads the file, rather than opening
23 * The Item Status Circulation Library column now displays a
24 shortname rather than the full library name.
25 * The Item Status Remaining Renewals column now displays
27 * The Item Status now has a "Last Renewal Workstation" column
29 * Fixes the circulation counts displayed in Item Status Details.
30 * Fixes an issue where multiple copies with different values for required
31 statistical categories could not be edited and saved in batch.
32 * Add an option to remove floating in the copy editor.
33 * Fixes an issue with the floating dropdown in the copy editor.
34 * Fixes a problem in which the copy template didn't properly copy
36 * Reduces the number of API calls that the MARC Editor requires.
41 * Fixes an issue that prevented the offline patron registration
43 * Fixes an issue with searching patrons by permission group.
44 * The barcodes in the patron search are now clickable.
45 * Staff members can now manually override the patron juvenile
46 flag value, regardless of the patron's date of birth.
47 * Checkboxes on patron registration screen are now properly aligned
49 * The user permission group dropdowns in the patron registration,
50 edit, and search interfaces now have scrollbars.
51 * The date picker on the checkout screen is now hidden unless
52 circ staff activates a specific due date option.
53 * The check-in screen now includes a copy status column.
54 * The Merge Patrons interface now displays the date of birth.
55 * The user bucket screen now displays the Bucket ID.
56 * The payment button on patron bills screen is now inactive if the
57 Payment Received field is blank.
58 * The Bill History receipt now includes a Finish date and a Last
60 * When a patron summary contains an image of the patron,
61 that image tag now has a null alt attribute to remove it from
62 the flow of a screen reader.
63 * Corrects an issue that caused the transit dialog to show the
65 * Corrects an issue with printing transit lists.
66 * "Find another target" on transiting hold no longer leaves the
68 * The images now display to distinguish hold and transit slips.
69 * The Clearable Holds list printout now only shows holds that have
71 * Restores the call number prefix and suffix fields to the holds
73 * The documentation at the top of the hold shelf slip template
75 * The cursor in the in-house use screen now automatically goes
77 * The in-house use screen now shows a copy status column.
78 * Add support for converting change to patron credit in the patron bills
79 interface, consistent with the XUL feature.
80 * Fixes a bug that caused pickup/request library fields to be
82 * Fixes a bug in the offline org unit tree.
84 Command-line system administration
85 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
87 * The novelist entry in `eg_vhost.conf` includes two new
89 * Corrects an issue with the `--max-sleep` argument on the
90 `action_trigger_runner.pl` support script.
91 * Corrects an issue with how the `eg_pbx_allocator.pl` script
92 detects an existing lock file.
93 * The 3.0.2-3.0.3 upgrade script disables triggers before
94 recalculating bib visibility.
99 * Fixes an issue that caused records with located URIs to be
100 retrieved in Copy Location and Copy Location Group searches.
101 * Fixes an error message that appeared in the search box
102 in the public catalog while placing hold after an advanced search.
103 * Restores the display of copy information for the user's
104 preferred library in the public catalog.
105 * Fixes regression errors in the search results page.
106 * Removes redundant call numbers from the Show More Details
108 * The cast field in the catalog is now taken from the 511 field
109 when first indicator = 1, rather than the 508.
110 * Fixes a display issue caused by editing holds.
115 * Fixes an issue that prevented users from searching for
116 receivable issues using Database ID or ISSN in the Serials
117 Batch Receive interface.
122 * Adds some padding to the bottom of Web Client interfaces.
123 * Logins now honor all org unit timeout settings.
124 * Evergreen will now identify and handle invalid timezones.
130 We would like to thank the following individuals who contributed code,
131 tests and documentation patches to the 3.0.8 point release of
166 This release contains bug fixes improving on Evergreen 3.0.6.
168 * Fixes a performance issue with the Patron Billing History screen and
169 other screens that cause Flattener.pm to re-create joins
171 * Fixes an issue that prevented patron alerts from showing to staff at
173 * Corrects the "Holdable" attribute display on the Item Status detailed
175 * Fixes the ability to delete multiple copies from Item Status.
179 We would like to thank the following individuals who contributed code,
180 tests and documentation patches to the 3.0.7 point release of
194 This release is a security release that fixes cross-site scripting
195 (XSS) vulnerabilities in the Evergreen public catalog. This release
196 also includes several other bugfixes improving on Evergreen 3.0.5.
198 Security Issue: XSS Vulnerability in Public Catalog
199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 This release fixes several cross-site scripting (XSS) vulnerabilities
201 in the public catalog. When upgrading, Evergreen administrators should
202 review whether any of the following templates have been customized
203 or overridden. If so, either the template should be replaced with the
204 stock version or the XSS fix (which entails adding the `| html` filter
205 in several places) applied to the customized version.
207 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
208 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
209 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
211 Note that exploiting the XSS vulnerabilities fixed in this release
212 would require either the ability to create maliciously-constructed
213 MARC bibliographic or holdings records or the ability to set a
214 maliciously constructed organizational unit name.
218 Evergreen 3.0.6 also includes the following changes:
220 * When using 'Selection Lists -> Edit MARC Order Record' in the web
221 staff client, now only one click is required to save the MARC
222 record rather than two.
223 * The volume/copy editor in the web staff client now better handles
224 editing multiple items that have different sets of statistical
225 category values assigned to them.
226 * The act of merging bibliographic records now updates bookbags
227 that referred to the source bibliographic record rather than
228 effectively deleting entries for that record.
229 * Additional columns were added to the Holds Pull List in the
231 * The patron registration form in the web staff client now correctly
232 manages setting user preferences.
233 * An error in a pgTAP unit test was corrected.
237 We would like to thank the following individuals who contributed code,
238 tests and documentation patches to the 3.0.6 security release of
254 This release contains bug fixes improving on Evergreen 3.0.4.
256 * The MARC Editor in the Web staff client now wraps long fields.
257 * The MARC Editor no longer allows catalogers to enter new lines
259 * Fixes an issue that prevented serials items from being deleted or
261 * The Web staff client Check In screen no longer reloads the whole
262 page multiple times each time an item is scanned.
263 * Fixes an issue that displayed the oldest -- rather than the newest
264 -- transit in the Web staff client Item Status page.
265 * Fixes an issue that prevented the reports module from being displayed
267 * Fixes an issue in the Web staff client reports module that caused
268 syntax errors in reports that use virtual fields and joins.
269 * Fixes an issue that prevented several dropdown menus in the Web staff
270 client from activating.
271 * Fixes an issue that created duplicate copy data when copies or
272 volumes with parts were transferred.
273 * Fixes the Trim List feature in the Web staff client Check In screen.
274 * The Item Status grid now displays the Circulation Modifier.
275 * Restores missing data from the Profile column in Place Hold patron
277 * Fixes an issue with the http -> https redirect on Apache 2.4.
278 * Fixes an color contrast accessibility issue in the Web staff
279 client and adds underlining to links in grid cells for added accessibility.
280 * Adds automated regression and unit tests for the Web staff client
282 * Adds a process for spell-checking the official documentation.
283 * Adds a script that simplifies the release process related to translations.
288 We would like to thank the following individuals who contributed code,
289 tests and documentation patches to the 3.0.5 point release of
294 * Blake Graham-Henderson
309 This release contains bug fixes improving on Evergreen 3.0.3:
311 * Fixes a bug that caused all searches limited by shelving location to
313 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
314 rather than the ordering agency's SAN.
315 * Fixes a bug that prevented Safari/iOS users from logging in to the
317 * Fixes a bug that prevented users from using the browse interface.
318 * Fixes a bug in the Item Status List view that caused incorrect due
320 * Approval code is now a required field in the web client's patron
321 credit card payment form.
322 * Fixes a bug with credit card payments that caused a receipt to print
323 showing that the patron paid the bill when the payment had not actually
325 * Fixes a bug that prevented the EDI translator from being installed on
327 * Fixes a bug that caused entries to show up multiple times in the
328 Items Out and Holds tabs in the patron record.
329 * Fixes a bug that caused grids on Bills and Patron Messages
330 screens to not display properly.
331 * The following fields are now available for the Checkout and Items Out
338 ** money_summary.balance_owed
339 ** money_summary.total_paid
340 ** money_summary.total_owed
345 * The following fields are now available on the Bill Payment receipt templates:
355 * Payment type is now a column in the payments tab of the patron record
356 Bill History section.
357 * The "Replace Barcode" function now makes it more difficult for staff
358 members to attempt to create blank patron barcodes.
359 * The patron bills screen now prevents staff members from double-clicking
360 on the Apply Payment button (which otherwise would apply two payments).
361 * Fixes a bug that prevented patrons attached to statistical categories
362 from displaying in the patron search-to-hold dialog.
363 * Fixes a performance issue related to uploading CSV files of barcodes
364 to the item status and patron bucket interfaces.
365 * Fixes several small bugs in the Spanish translation.
366 * Fixes a performance bug related to patrons logging in by barcode.
370 We would like to thank the following individuals who contributed code,
371 tests and documentation patches to the 3.0.4 point release of
393 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
394 update the visibility attributes of all bibs that make use of Located URIs or
395 bib sources. It may take a while to run on large datasets. If it it running
396 too long, it can be canceled and the following psql commands will create and
397 run a script that will perform the same action serially over time without
398 blocking writes to bibs:
401 \o /tmp/luri_visibility_update.sql
402 SELECT 'UPDATE biblio.record_entry SET ' ||
403 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
404 'WHERE id = ' || id || '; SELECT ' || id || ';'
405 FROM biblio.record_entry
407 SELECT DISTINCT cn.record
408 FROM asset.call_number cn
410 AND cn.label = '##URI##'
413 FROM asset.uri_call_number_map m
414 WHERE m.call_number = cn.id
417 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
422 \i /tmp/luri_visibility_update.sql
425 It will output the id of each updated bib so that the script can be killed
426 and then edited to remove completed bibs. The remainder can be run at a
429 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
430 we do NOT update the bib's visibility attributes, as doing so causes a loop
431 and an eventual trigger stack violation. This flag should ONLY be used when
432 forcing reingest of record attributes (NOT visibility attributes), search,
433 facet, and display fields, so if using this flag under normal operation,
434 proceed at your own risk and know that Located URI and bib source changes
435 will not be reflected in the visibility attributes of the record.
439 This release contains several bug fixes improving on Evergreen 3.0.1:
441 * Fixes several issues related to the display of located URIs and records with
442 bib sources in search results.
443 * Setting `opac_visible` to false for a copy location group now hides only
444 the location group itself, rather than also hiding every single copy in the
446 * Fixes a bug that prevented the copy editor from displaying the _fine level_
447 and _loan duration_ fields.
448 * The "Edit Items" grid action in the Item Status interface will now open
449 in the combined volume/copy editor in batch. This makes the behavior
450 consistent with the "Edit Selected Items" grid action in the copy
452 * Staff members are now required to choose a billing type when creating a
453 bill on a user account.
454 * The Web client now provides staff users with an alert and option to
455 override when an item with the Lost and Paid status is checked in.
456 * Fixes a bug where the Web client offline circ interface was not able
457 to set its working location.
458 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
460 * The MARC editor in the Web staff client now presents bib sources in
462 * Both circulation and grocery bills are now printed when a staff user selects
463 a patron account and clicks "Print Bills".
464 * Fixes an issue in the XUL serials interface the "Receive move/selected"
465 action from succeeding.
466 * Fixes a typo in the user password testing interface.
470 We would like to thank the following individuals who contributed code,
471 tests and documentation patches to the 3.0.3 point release of
490 This release contains several bug fixes improving on Evergreen 3.0.1:
492 * Copy templates created in XUL Holdings Maintenance will now be
493 automatically converted and displayed in the web staff client's
495 * The list of report templates now includes a column indicating whether
496 the template was originally created in the XUL staff client or the web
497 staff client; staff need to know this since report templates created in
498 one interface cannot be edited in the other.
499 * Call number prefixes and suffixes are now displayed in various grids
500 in the web staff client, including
501 ** Pending Copy Buckets
503 ** Checkin/Capture Holds
505 ** Patron Bills History
512 ** Bib Record View Holds
514 * Many patron fields have been redacted from the web staff client's patron
515 and record holds grids, leaving patron name, username, and ID.
516 * Fixes two bugs where patron records could fail to be saved upon editing.
517 * The web staff patron editor now better warns staff users about
518 duplicate names, IDs, phone numbers, and email addresses.
519 * Human readable labels are now displayed for certain fields in standing
521 * The patron summary in the web staff client now correctly displays
522 primary and secondary ID values.
523 * The web staff client's billing full details page now displays
524 information about the staff user that created a payment.
525 * The web staff client now requires staff users to explicitly set a
526 billing type when adding a manual bill.
527 * The web staff client's patron bill annotation modal now works.
528 * Patron barcode search completion in the web staff client now allows
529 the user to select from all of the matching patron records.
530 * The Hold Shelf Slip print template in the web staff client now has
531 access to the call number.
532 * The Checkout Receipt print template in the web staff client now can
533 include summary financial information, incuding current balance, total
534 paid on outstanding fines, and total owed.
535 * The web staff print templates for current and historical bills can
536 now include copy barcode and title.
537 * Fixes a bug that resulted in some catalog searches unexpectedly
539 * Fixes a bug that resulted in catalog searches that specify a location
540 limit returning incorrect results.
541 * Fixes a bug where deleted copies could make records visible in the
543 * Fixes a bug where certain queries on copies used in the public catalog
545 * Fixes a bug place a hold request in the public catalog could result
546 in "forgetting" the type and library of the user's previous search.
547 * The web staff client now respects staff user session timeouts, and
548 will log out all open tabs if a user's session has timed out.
549 * The web staff Z39.50 page will now give the staff user an alert if
550 they attempt to import a record with a duplicate TCN.
551 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
552 entries from being deleted.
553 * Fixes a bug that made using the volume/copy editor to change a copy's
555 * The administration interface for hard due dates now ensures that
556 new (or edited) ceiling dates have their time component set to end
557 of day, resolving an issue where ceiling dates would not be applied
558 during the ceiling date itself.
559 * The web staff client can now include dynamic information in browser
560 tab titles, e.g., "Smith, Jane - Checkout".
561 * The Concerto sample data set now includes data allowing for testing
562 placing holds on monographic parts.
563 * Asset merging during bibliographic record merging now correctly
564 recognizes call number prefixes and suffixes and deletes disused
566 * Fixes a bug where displaying user surveys could result in PCRUD
568 * Fixes a bug where pg_restore of an Evergreen database could fail
569 to create certain indexes on the `actor.usr` table.
573 We would like to thank the following individuals who contributed code,
574 tests and documentation patches to the 3.0.2 point release of
605 This release contains several bug fixes improving on Evergreen 3.0.0
607 * Fixes a bug in the web staff client that prevented initials from being
608 stored with copy notes.
609 * Adds billing types that may have been missed by systems that were
610 running Evergreen prior to the 1.4 release.
611 * Fixes a web staff client bug with the CSV export option available from
612 the Import Queue in the MARC Batch Import/Export interface.
613 * Adds the missing copy alert field in the web client's volume/copy
615 * Fixes a bug where the setting to require date of birth in patron
616 registration was not being honored in the web staff client.
617 * Fixes a bug in the web staff client patron registration form where the
618 password wasn't generating from the last four digits of the patron's
620 * Fixes an issue in the web staff client where the complete barcode did
621 not display in some interfaces when partial barcodes were scanned.
622 * Fixes an HTML error in the new copy tags that display on the record
624 * Fixes a web staff client bug where recording a large number of in-house
625 uses at one time doesn't display a confirmation dialog once it hits the
627 * Adds a _Print Full Grid_ action in the web staff client
628 holds pull list to allow staff to print the entire pull list as it
629 displays on the screen. This change also changes the _Export CSV_ action
630 to an _Export Full CSV_ option.
631 * Fixes an issue with the Patron Messages interface that prevented it
632 from saving column configuration changes in the web staff client.
633 * Fixes a bug in the web staff client where a billing prompt did not
634 correctly display after marking an item damaged in those systems that
635 have enabled the setting to bill for damaged items.
636 * Adds an option to the specific due date feature that allows saving
637 that due date until logout. This allows all circulations from a given
638 workstation to be due on the same date.
642 We would like to thank the following individuals who contributed code,
643 tests and documentation patches to the 3.0.1 point release of
665 The minimum version of PostgreSQL required to run Evergreen 3.0 is
666 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
668 Change to Names of Shared Libraries
669 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
670 OpenSRF 3.0 changes how the shared libraries for services written in
671 C are named. If upgrading from an earlier version of Evergreen,
672 `opensrf.xml` should be edited so that shared library file names
673 listed in the `<implementation>` tag start with "lib". For example,
676 ---------------------------------------------------------------------
678 <language>C</language>
679 <implementation>oils_cstore.so</implementation>
680 ---------------------------------------------------------------------
682 should be changed to:
685 ---------------------------------------------------------------------
687 <language>C</language>
688 <implementation>liboils_cstore.so</implementation>
689 ---------------------------------------------------------------------
691 SIP Bugfix Requires SIPServer Upgrade
692 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
694 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
695 crash" requires that you also upgrade SIPServer with the fix for
696 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
697 SIP client problems." This means that if you use SIP2 with Evergreen,
698 you must also upgrade SIPServer to the latest commit in the Git
699 repository. Conversely, if you upgrade SIPServer to the latest commit
700 in Git, you must also upgrade Evergreen or, at least, apply the patch
701 for Launchpad Bug 1542495. These two patches are complementary and
702 cannot be applied independently of one another.
704 `open-ils.auth.login`
705 ~~~~~~~~~~~~~~~~~~~~~
706 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
707 API's in the `opensrf_core.xml` file.
712 ---------------------------------------------------------------------
713 --- a/Open-ILS/examples/opensrf_core.xml.example
714 +++ b/Open-ILS/examples/opensrf_core.xml.example
715 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
717 <match_string>open-ils.auth.authenticate.verify</match_string>
718 <match_string>open-ils.auth.authenticate.complete</match_string>
719 + <match_string>open-ils.auth.login</match_string>
720 <match_string>open-ils.auth_proxy.login</match_string>
721 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
722 <match_string>open-ils.actor.user.password</match_string>
723 ---------------------------------------------------------------------
727 Administrators of Evergreen who use RTL locales and who have customized
728 `style-rtl.css.tt2` should now incorporate their customizations into
731 Multi-Time Zone Installations
732 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
734 For Evergreen consortia that span more than one time zone, the following
735 query will adjust all historical, unaged circulations so
736 that if their due date field is pushed to the end of the day, it is done
737 in the circulating library's time zone, and not the server time zone.
739 It is safe to run this after any change to library time zones.
741 Running this is not required, as no code before this change has
742 depended on the time string of '23:59:59'. It is also not necessary
743 if all of your libraries are in the same time zone, and that time zone
744 is the same as the database's configured time zone.
753 for ou_id in select id from actor.org_unit loop
754 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
755 if new_tz is not null then
756 update action.circulation
757 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
758 where circ_lib = ou_id
759 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
768 Deprecation of XUL staff client
769 -------------------------------
770 Starting with the release of 3.0.0, patches that fix XUL bugs will not
771 be merged into master or backported unless they meet one or more of
772 the following conditions:
774 a. the bug is a security issue
775 b. the bug involves the destruction of data
776 c. the bug is a regression of functionality in the XUL staff client
777 introduced by other work done to Evergreen
779 Under no circumstances will XUL staff client feature enhancements be merged.
781 This policy will continue through the 3.0.x and 3.1.x maintenance
782 release cycles, and will become moot upon the release of 3.2.0, when
783 the XUL staff client is slated to be entirely removed.
792 Evergreen 3.0 features a new, modern staff client that runs in the web browser
793 and can be used on desktop and mobile devices. All functional areas of the
794 system, including circulation, cataloging, acquisitions, serials, reports,
795 booking, administration, and offline circulation, are available in the new staff
796 client. Chrome and Firefox are officially supported for use with the web client.
798 Library staff will no longer need to download separate software to perform most
799 actions in Evergreen. A Chrome plugin called Hatch will be available as a
800 separate installation for workstations that require seamless, dialog-free
801 printing to multiple printers.
803 In addition to adding more portability and stability, the new staff client also
804 presents a cleaner and more modern interface for users. By virtue of running in
805 a browser, actions that users are accustomed to performing on other web sites
806 should now be available in the Evergreen client.
808 The old, XUL client will continue to be available to allow for a gradual
809 transition to the browser-based client, but no new features will be added. The
810 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
820 New EDI Order Generator
821 ^^^^^^^^^^^^^^^^^^^^^^^
826 . New database tables exist for configuring vendor-specific EDI order
830 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
833 ** Collection of `edi_attr`s. Each edi_account may be linked to one
835 ** One `edi_attr_set` per known vendor is added to the stock data, matching
836 the stock configuration found in the JEDI template.
837 * `acq.edi_attr_set_map`
838 ** Link between `edi_attr`s and `edi_attr_set`s.
840 . EDI Attribute Sets are manged via a new (browser client only) configuration
841 interface at 'Administration -> Acquisitions Administration -> EDI
844 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
845 is not set, default values will be used. Links between an EDI account
846 and an attribute set are managed in the EDI Accounts configuration
849 . Local modifications to the stock EG JEDI template are managed by modifying
850 and/or adding additional `edi_att_set`s as needed.
852 . A new `edi_order_pusher.pl` script is added which replaces the functionality
853 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
855 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
856 definition is no longer required and can be disabled.
861 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
862 specifies whether PO's generated via the account should be built using
863 EDI attributes or fall back to traditional JEDI A/T template generation.
865 This allows sites to activate EDI attributes on a per-account basis, making
866 it possible to migrate piecemeal to EDI attributes. For the initial roll
867 out of this new feature, no accounts will be configured to use EDI
868 attributes by default.
874 3 Day Courtesy Notice by SMS
875 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
876 New optional SMS text notification to be sent out 3 days prior to the due
877 date of any circulating item for patrons who have an SMS text number and
878 carrier stored in their accounts. This action trigger is disabled by default,
879 but can be enabled and modified by going into 'Administration -> Local Administration ->
880 Notifications / Action Triggers'.
882 You may wish to make use of granularity so that these messages are batched
883 and sent at the same time each day.
888 Add Description Field to Circulation and Hold Configuration Entries
889 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
890 The circulation and hold policy configuration rules now each have a
891 description field. This allows administrators to add comments to
892 describe the purpose of each rule.
897 Apache Internal Port Configuration Option
898 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
899 Apache configuration now supports a new variable which allows admins to
900 specify the port used by Apache to handle HTTP traffic. The value is
901 used for HTTP requests routed from Perl handlers back to the same Apache
902 instance, like added content requests. Use this when running Apache
903 with a non-standard port, typical with a proxy setup. Defaults to "80".
906 -------------------------------------------------------------------
909 PerlSetVar OILSWebInternalHTTPPort "7080"
912 -------------------------------------------------------------------
917 Configurable Bib Record Display Fields
918 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
920 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
921 fields: 'Display Field?' and 'Display XPath'.
923 When 'Display Field' is set to true, data from the field will be extracted
924 from each record and added to a new table of display data for each bib
927 If a value is present in the 'Display XPath' field, this XPath will be
928 applied to the extracted data *after* the base XPath (from the 'XPath'
929 field) is applied to each field.
931 This data acts as a replacement for the various and sundry ways bib record
932 data is currently extracted, including inline XPath in the TPAC, reporter
933 views, real-time 'MVR' compilation from MODS, etc. and will be available
934 to the user interface, notification templates, etc. for rendering bib
937 The browser client gets a new service 'egBibDisplay' which is capable
938 of translating the display field data from various formats into
939 data more suitable for JavaScript usage.
941 The database gets 3 new views for representing display data in various
944 * `metabib.flat_display_entry`
945 ** List of all display fields linked to their configuration.
946 * `metabib.compressed_display_entry`
947 ** Same as `metabib.flat_display_entry` except there's one row
948 per display field type, with 'multi' rows compressed into
949 JSON arrays. Non-multi fields are represented as JSON
951 * `metabib.wide_display_entry`
952 ** Tabular view of display field data, one column per well-known
953 field. Values are represented JSON, consistent with
954 `metabib.flat_display_entry`. The view does *not* contain locally
955 configured display fields, as each field must be encoded in
956 the view and IDL definition. This is essentially a replacement
957 for `reporter.simple_record`.
962 After making changes to display field configuration, it's possible to
963 reingest only display field data in the database using the following:
966 ---------------------------------------------------------------------
967 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
968 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
969 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
970 ---------------------------------------------------------------------
976 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
977 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
978 The existing permission was incorrectly created with a code of
979 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
980 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
981 update changes the permission code to match what the event requires.
987 Hold Targeter V2 Repairs and Improvements
988 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
989 * Make the batch targeter more resilient to a single-hold failure.
990 * Additional batch targeter info logging.
991 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
992 * Removes the confusingly named `--target-all` option
993 ** The same behavior can be achieved by using `--retarget-interval "0s"`
994 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
996 New --next-check-interval Option
997 ++++++++++++++++++++++++++++++++
998 Specify how long after the current run time the targeter will retarget
999 the currently affected holds. Applying a specific interval is useful
1000 when the retarget-interval is shorter than the time between targeter
1003 For example, if the targeter is run nightly at midnight with a
1004 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1005 since the holds won't be processed again until 48 hours later. This
1006 ensures that the org unit closed date checks are looking at the correct
1009 This setting overrides the default behavior of calculating the next
1010 retarget time from the retarget-interval.
1012 New --soft-retarget-interval Option
1013 +++++++++++++++++++++++++++++++++++
1014 This is a replacement for (and rebranding of) the `--skip-viable` option.
1015 The new option allows for time-based soft-targeting instead simple binary
1016 on/off soft-targeting.
1018 How soft-targeting works:
1020 * Update hold copy maps for all affected holds
1021 * Holds with viable targets (on the pull list) are otherwise left alone.
1022 * Holds without viable targets are retargeted in the usual manner.
1028 New marc_export --descendants Option
1029 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1031 The `marc_export` script has a new option, `--descendants`. This option
1032 takes one argument of an organizational unit shortname. It works much
1033 like the existing `--library` option except that it is aware of the
1034 org. tree and will export records with holdings at the specified
1035 organizational unit and all of its descendants. This is handy if you
1036 want to export the records for all of the branches of a system. You
1037 can do that by specifying this option and the system's shortname,
1038 instead of specifying multiple `--library` options for each branch.
1040 The `--descendants` option can be repeated, as the `--library` option can.
1041 All of the specified org. units and their descendants will be included
1042 in the output. It can also be combined with individual `--library`
1043 options when necessary.
1048 RTL and LTR Public Catalog Stylesheets Merged
1049 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1050 The RTL stylesheet for the public catalog,
1051 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1052 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1053 template will provide RTL or LTR styles based on the value of
1054 the `rtl` flag of the active locale. An `rtl` variable is also available
1055 in the template to allow the correct style to be chosen.
1060 Miscellaneous Improvements
1061 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1063 * If a filter is in effect in the Library Settings Editor,
1064 the filter will continue to be applied after a user
1065 changes the selected library.
1066 * Copy templates used for serials now correctly link to age
1067 protection rules and MARC item type values (for the
1068 "Circ as Type" field). During upgrade, the database update
1069 will set to NULL any age protection and circ as type fields
1070 in serial copy templates that do not point to defined values.
1075 Obsolete Internal Flag Removed
1076 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1078 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1079 flag was removed from the `config.internal_flags` table. It was
1080 rendered obsolete by the addition of the 3 flags to control the
1081 browse, search, and facet indexing.
1086 Tweaks to Caching/Expiry of Public Catalog Assets
1087 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1088 The default cache expiration time for static assets (e.g.,
1089 CSS, image, and JavaScript files) in the public catalog and
1090 the Kid's PAC has been increased to one year. Links to all
1091 such assets now have a cache-busting value tacked on as a
1092 query parameter. This value is refreshed when `autogen.sh` is
1093 run, but it can also be manually set by adjusting the
1094 `ctx.cache_key` Template Toolkit variable.
1099 Action/Trigger Events Data Purging
1100 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1102 Action/Trigger event definitions have a new field called 'Retention
1103 Interval'. When an optional interval value is applied, events and
1104 template output data linked to the event definition will be deleted
1105 from the database once they reach the specified age.
1107 Retention Interval Restrictions for Passive Hooks
1108 +++++++++++++++++++++++++++++++++++++++++++++++++
1110 Restrictions are placed on retention interval values for event definitions
1111 using passive hooks to prevent data from being deleted while it's still
1112 needed by the system.
1114 The presence of event data is how the system knows not to send duplicate
1115 events. As long as a scenario exists where a duplicate event may be
1116 generated, the events must be retained.
1118 To apply a retention interval value to a passive-hook event definition:
1120 * The event definition must have a max_delay value.
1121 * The retention interval must be larger than the difference between
1122 the `delay` and `max_delay` values.
1124 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1125 interval must be greater than 3 days to ensure no duplicate events are
1126 created between the first event on day 7 and the end of the event validity
1132 A new `purge_at_events.sh` script is installed in the bin directory
1133 (typically `/openils/bin`) which should be added to CRON for regular
1136 NOTE: On large data sets, this script can take a long time to run and
1137 create higher than normal I/O load as it churns though the event and
1138 event_output tables. You may wish to run the script by hand the first
1139 time so it can be monitored. It can be run in psql like so:
1142 ---------------------------------------------------------------
1143 SELECT action_trigger.purge_events();
1144 ---------------------------------------------------------------
1146 NOTE: On *very* large data sets (10s to 100s of millions of event and
1147 event_output rows), it may be advisable to first repopulate the `event`
1148 and `event_output` tables with only the desired data before starting
1149 regular purges. This can be done, for example, using the copy to temp
1150 table, truncate source table, repopulate source table from temp table
1151 approach. This will be much faster than the `purge_events()` function
1152 in cases where most of the data will be purged.
1157 A number of `action_trigger.hook` entries which have always been treated
1158 as active hooks, though are configured as passive hooks, have been
1159 updated to properly reflect the non-passive-ness. This allows for
1160 simpler configuration of their retention interval values.
1166 Remove JSPAC Redirects
1167 ^^^^^^^^^^^^^^^^^^^^^^
1168 Future versions of Evergreen will no longer contain automatic redirects
1169 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1170 that the JSPAC is no longer supported. Existing sites, however, may
1171 wish to retain JSPAC redirects in their Apache configuration files since
1172 JSPAC URLs may still be used in the wild to access their catalogs.
1174 The original JSPAC URL redirects are all retained in the file
1175 `Open-ILS/examples/jspac_redirects.conf` for reference.
1185 New open-ils.auth.login API
1186 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1187 The `open-ils.auth` service has a new API for requesting an authentication
1188 token. It performs the same steps as the
1189 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1190 using the bare password. No intermediate password hashing is required.
1192 The paramaters are the same as the `.complete` call with a few modifications.
1194 1. Using the generic 'identifier' parameter in combination with the
1195 'org' parameter allows the API to reliably determine if an identifier
1196 value is a username or barcode. The caller is no longer required to
1197 make that determination up front.
1199 2. The 'nonce' parameter is no longer used.
1205 Batch Patron Contact Invalidation
1206 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1207 The following methods are used to mark patron contact fields
1208 as invalid by moving the invalid value to a standing penalty:
1210 * `open-ils.actor.invalidate.email`
1211 * `open-ils.actor.invalidate.day_phone`
1212 * `open-ils.actor.invalidate.evening_phone`
1213 * `open-ils.actor.invalidate.other_phone`
1215 These methods now accept a fifth argument specifying the value
1216 of the contact field, e.g., a specific phone number or email
1217 address. If supplied, and if a specific patron ID (the first
1218 argument) is not supplied, all patrons with that specific contact
1219 value will have it marked invalid.
1229 Pure-SQL catalog searching
1230 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1231 Public and staff catalog search is now both more accurate and faster
1232 by redesigning how the visibility of records is calculated.
1242 Authority Record and Headings Browse Improvements
1243 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1244 Various improvements are made to support for authority records
1245 and headings browsing:
1247 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1248 headings from authority records. Since the MODS and MADS stylesheets
1249 extract headings in similar ways, duplicate browse entries are now
1250 much less likely to occur.
1251 * A new configuration table, `authority.heading_field`, is now used
1252 to specify how headings should be extracted from authority records.
1253 * Related headings can now be identified as narrower or broader when
1254 browsing in the public catalog.
1255 * See references are now more reliably included in the browse list.
1256 * Scope (public) notes now display only under the main heading.
1257 * There is now a global flag, Display related headings (see-also) in browse,
1258 that can be used to control whether related headings (see-alsos) are
1259 displayed in the public catalog list.
1260 * A complete set of thesauruses are now included in the seed data. Thesauruses
1261 can now be identified using short and long codes.
1262 * The labels for see and see-also references in the public catalog are
1263 a bit more patron-friendly, and can now be tweaked via TPAC template
1264 customization in the browse.tt2 file.
1270 Copy Tags and Digital Bookplates
1271 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1272 Copy tags will allow staff to apply custom, pre-defined labels or tags
1273 to copies. Copy tags are searchable in both the staff client and public
1274 catalog. This feature was designed to be used for Digital Bookplates to
1275 attach donation or memorial information to copies, but may be used for
1276 broader purposes to tag items.
1278 Each copy tag can either be publicly-visible or visible only to staff.
1279 Copy tags also have types that can be used for restricting catalog
1280 searches on copy tags to particular types.
1282 Copy tags are displayed in the copy table in the record summary page in
1283 the public catalog, and a new library setting can be used to add
1284 a "Digital Bookplate" search field. Copy tags can also be used
1285 as a search filter, e.g.,
1287 * `copy_tag(bookplate, jane smith)`: search for records that have a
1288 copy tag of type 'bookplate' whose value contains 'jane smith'.
1289 * `copy_tag(*, jane smith)`: search for records that have a
1290 copy tag of any type whose value contains 'jane smith'.
1292 All staff-side interfaces related to copy tags exist only in the web
1293 staff client. There are two new administration interfaces for managing
1294 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1295 button for applying copy tags to copies; that interface can also be
1296 used to create new copy tags on the fly. Furthermore, the copy buckets
1297 interface now has an 'Apply Tags' action for assigning tags to groups
1303 Two new permission are included:
1305 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1306 'Administration -> Server Administration -> Copy Tag Types'
1307 * `ADMIN_COPY_TAG`: required to create a new tag under
1308 'Administration -> Local Administration -> Copy Tags'
1310 The existing permission `UPDATE_COPY` controls whether or not a user
1311 can link copies to tags.
1315 A new library setting, 'Enable Digital Bookplate Search', controls
1316 whether to display a 'Digital Bookplate' field in the search index
1317 drop-downs in the catalog. A 'Digital Bookplate' search will include
1318 all records that have a copy that matches the tag specified by the user.
1319 It should be noted that this library setting does not affect the
1320 display of copy tags on the catalog record summary page.
1325 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1326 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1327 The call number prefix and suffix, when present, are now included in
1328 subfields $k and $m of the 852 field when running `marc_export` with
1329 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1330 server configured to embed item data in 852 fields, the affixes are now
1331 included in subfields $k and $m.
1341 Batch Editing of Patron Records
1342 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1343 There is a now a new interface analogous to the Copy Bucket interface
1344 to select and group a set of users into a User Bucket.
1345 The addition of users to a User Bucket is possible from the Patron Search
1346 interface by the use of a new grid Action, and directly on the User Bucket
1347 interface by user barcode. It is also possible to add users to a User
1348 Bucket by uploading a text file that contains a list of user barcodes.
1350 From this interface it is possible to perform a set of specific batch update
1351 operations on user records.
1356 These fields can now be changed in batch via an action on the User Bucket
1357 grid if the staff user has the `UPDATE_USER` permission:
1360 * Primary Permission Group (group application permissions consulted)
1362 * Home Library (`UPDATE_USER` checked against both old and new value)
1363 * Privilege Expiration Date
1364 * Barred flag (`BAR_PATRON` permission consulted)
1365 * Internet Access Level
1367 Changes made in this interface can be rolled back.
1369 As a batch process, rather than a direct edit, this mechanism explicitly skips
1370 processing of Action/Trigger event definitions for user update.
1375 The batch edit mechanism also allows for the batch deletion of user. The staff
1376 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1378 Changes made in this interface can be rolled back.
1380 As a batch process, rather than a direct edit, this mechanism explicitly skips
1381 processing of Action/Trigger event definitions for user deletion.
1383 This mechanism does not use the Purge User functionality, but instead simply
1384 marks the users as deleted.
1386 Editing Statistical Category Entries
1387 ++++++++++++++++++++++++++++++++++++
1389 All users in the bucket can have their Statistical Category Entries
1390 modified. Unlike user data field updates, modification of Statistical
1391 Category Entries is permanent and cannot be rolled back.
1393 As a batch process, rather than a direct edit, this mechanism explicitly skips
1394 processing of Action/Trigger event definitions for user update.
1396 New Service Requirement
1397 +++++++++++++++++++++++
1399 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1400 unused in production. If this service has been removed from the configuration
1401 of a live Evergreen instances, it will need to be added back in order for
1402 batch user editing to succeed.
1407 Honor Timezone of the Acting Library
1408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1413 * Display day-granular due dates in the circulating library's timezone.
1414 * Only display the date portion of the due date for day-granular circulations.
1415 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1416 * Provide infrastructure for more advanced formatting of timestamps.
1417 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1422 This is a followup to the work done for 2.12, where we added the ability
1423 for the client to specify a timezone in which timestamps should be interpreted
1424 in business logic and the database.
1426 Most specifically, this work focuses on circulation due dates and the closed
1427 date editor. Due dates, where displayed using stock templates (including
1428 receipt templates) and used for fine calculation, are now manipulated in the
1429 library's configured timezone. This is controlled by the new 'lib.timezone'
1430 setting available via the Library Settings Editor, loaded from the server when
1431 required. Additionally, closings are recorded in the library's timezone so that
1432 due date calculation is more accurate. The closed date editor is also
1433 taught how to display closings in the
1434 closed library's timezone. Closed date entries also explicitly record if they
1435 are a full day closing, or a multi-day closing. This significantly simplifies
1436 the editor, and may be useful in other contexts.
1438 To accomplish this, we use the moment.js library and the moment-timezone addon.
1439 This is necessary because the stock AngularJS date filter does not understand
1440 locale-aware timezone values, which are required to support DST. A simple
1441 mapper translates the differences in format values from AngularJS date to
1444 Of special note are a set of new filters used for formatting timestamps under
1445 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1446 filters provide the functionality, and autogrid is enhanced to make use of
1447 these where applicable. egGrid and egGridField are also taught to accept
1448 default and field-specific options for applying date filters. These filters may
1449 be useful in other or related contexts.
1451 The egDueDate filter, used for all existing displays of due date via Angular
1452 code, intentionally interprets timestamps in two different ways WRT timezone,
1453 based on the circulation duration. If the duration is day-granular (that is,
1454 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1455 of seconds) then the date is interpreted as being in the circulation library's
1456 timezone. If it is an hourly loan (any duration that does not meet the
1457 day-granular criterium) then it is instead displayed in the client's timezone,
1458 just as all other timestamps currently are, because of the previous Evergreen
1461 The public catalog is adjusted to always display the due date in the circulating
1462 library's timezone. Because the public catalog displays only the date portion of the due
1463 date field, this difference is currently considered acceptable. If this proves
1464 to be a problem in the future, a minor adjustment can be made to match the
1465 egDueDate filter logic.
1467 Now that due dates are globally stored in the configured timezone of the
1468 circulating library, the automatic adjustment to day-granular due dates needs
1469 to take those timezones into account.
1471 An optional SQL command is provided by the upgrade script to retroactively
1472 adjust existing due dates after library configuration is complete.
1478 Enhancements to Hard Due Date Functionality
1479 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1480 It will now be possible to delete Hard Due Date Values for dates that have
1481 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1482 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1483 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1488 Patron Search by Birth Date
1489 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1490 * Now you can include the patron birth year and/or birth month and/or
1491 birth day when searching for patrons using the web staff client.
1492 * Day and month values are exact matches. E.g. month "1" (or "01")
1493 matches January, "12" matches December.
1494 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1495 1915, 1599, etc. For exact matches use the full 4-digit year.
1499 Patron Search from Place Hold
1500 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1501 This feature allows staff members, when placing a
1502 hold on behalf of a patron in the web staff client, to search for
1503 patrons by names and other searchable patron information, rather than
1504 relying on barcode alone. In particular, after performing a catalog
1505 search or going to a specific bib record and clicking the 'Place Hold'
1506 button, the form now includes a 'Patron Search' button. This button
1507 will open a dialog allowing the staff member search for and select
1513 Retrieve Recent Patrons
1514 ^^^^^^^^^^^^^^^^^^^^^^^
1516 Adds a new library setting 'Number of Retrievable Recent Patrons'
1517 ('ui.staff.max_recent_patrons') that specifies the number of recently
1518 retrieved patrons that can be re-fetched from the staff client.
1520 A value of 0 means no recent patrons can be retrieved.
1521 A value greater than 1 means staff will be able to retrieve multiple
1522 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1524 The default value is 1 for backwards compatibility.
1531 Fuller title in XUL client Simplified Pull List
1532 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1533 The Simplified Pull List in the XUL client will now display subfields 245$n and
1534 $p in the title field. The addition will make it easier for staff to distinguish
1535 between different parts or seasons in a series.
1541 Transit Cancel Time and Terminology Change
1542 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1547 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1548 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1549 are preserved in the database, though still not visible to the end user in the staff client.
1550 This allows for better tracking of when transits are canceled for the purposes of knowing
1551 which staff member canceled the transit, etc.
1553 NOTE: This change may require the re-creation of transit reports to filter out canceled
1554 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1555 Is NULL' will suffice.
1557 "Canceled Transit" Terminology Change
1558 +++++++++++++++++++++++++++++++++++++
1560 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1561 For internal continuity, however, the following permission codes have not changed:
1564 * `ABORT_REMOTE_TRANSIT`
1565 * `ABORT_TRANSIT_ON_LOST`
1566 * `ABORT_TRANSIT_ON_MISSING`
1574 Offline Circulation Available in Web Staff Client
1575 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1576 Offline circulation is now available in the web staff client. In order to use the
1577 offline interface, users must first log into the web staff client, perform
1578 a patron search, select a user from the results, and open the patron editor
1579 interface to collect all the relevent configuration information for the
1580 workstation. In addition, the offline interface available from the Circulation
1581 menu provides a 'Download block list' button for users who are logged in.
1583 As is the case in the old staff client, users can check materials in and out,
1584 renew items, and create new patron accounts while offline. The patron fields
1585 available in the offline patron registration editor are the same ones that
1586 are available to staff when working online.
1590 Add Circ Modifier to Record Detail Page in Staff TPAC
1591 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1592 The circulation modifier field is added to the table of copies to make
1593 more information available to staff without having to open
1600 Date+Time Format Settings for Web Client
1601 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1603 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1604 and adds two settings for use with the webstaff client:
1606 * 'Format Dates with this pattern'
1607 * 'Format Date+Time with this pattern'
1609 These settings use format strings as documented here:
1611 https://docs.angularjs.org/api/ng/filter/date
1613 There is overlap with how the Dojo formats worked, but also some differences.
1615 The original 'Format Dates' and 'Format Times' settings worked together, but the
1616 new settings work independently. Certain field elements will use one, and
1617 certain field elements will use the other. These distinctions are hard-coded
1618 in the various UI templates, with the idea being that timestamp fields in
1619 which the date component alone is sufficient information (for example, date of birth)
1620 will use the 'Format Dates' setting. Fields where the time component is
1621 important (for example, checkout time) will use the 'Format Date+Time' setting.
1623 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1624 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1630 Global Option to Remove Sound for a Specific Event
1631 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1632 A new `nosound.wav` file has been added to the web client. The file can be used
1633 to globally disable audio alerts for a specific event on an Evergreen system.
1635 For example, to silence the alert that sounds after a successful patron search:
1639 mkdir -p /openils/var/web/audio/notifications/success/patron/
1640 cd /openils/var/web/audio/notifications/success/patron/
1641 ln -s ../../nosound.wav by_search.wav
1648 The official Evergreen manual has been split into eight new manuals, each
1649 designed for a specific audience. This new approach is designed to make
1650 the documentation more readable and usable.
1652 The specific audiences for the new manuals are:
1654 * Acquisitions staff
1657 * Public services staff who use the public catalog
1659 * System administrators who use the command line
1660 * System administrators who use the Web client
1661 * System administrators and programmers who wish to integrate Evergreen
1662 with other technologies
1664 All manuals are available at http://docs.evergreen-ils.org
1670 Improvements to ebook API
1671 ^^^^^^^^^^^^^^^^^^^^^^^^^
1673 Evergreen now supports checking out and placing holds on
1674 OverDrive and OneClickdigital ebook titles from within the public
1675 catalog. This is an experimental feature. It is not recommended for production
1676 use without careful testing.
1678 When ebook integration is enabled, a "Check Out E-Item" link will be
1679 displayed when viewing an ebook title from a supported vendor in the
1680 catalog. Clicking on the link allows the user to check out and download
1681 that title from the vendor directly within the catalog.
1683 If no copies are available for the title, a "Place Hold on E-Item" link
1684 is displayed instead, and the user may place a hold on the title. (Note
1685 that some vendors require the user's account to have an email address
1686 before permitting a hold.)
1688 My Account includes the ability to view current ebook checkouts and
1689 holds, download already-checked-out titles, and cancel holds.
1691 For API integration to work, you need to request API access from the
1692 vendor, and the vendor must have a way of authenticating your patrons.
1693 Your Evergreen system also needs to be configured for ebook API
1694 integration, following the instructions in the command line system
1695 administration manual
1698 This feature assumes that you are importing MARC records supplied by the
1699 vendor into your Evergreen system, using Vandelay or some other MARC
1700 import method. This feature does not search the vendor's online
1701 collections or automatically import vendor records into your system; it
1702 merely augments records that are already in Evergreen.
1704 Improvements to Bill Payment Pages
1705 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1706 The bill payment pages in the public catalog have been revamped
1709 * use the term "charges" instead of "fees"
1710 * include images of credit cards accepted
1711 * make the default print receipt template match other itemized receipts;
1712 note that this change is not automatically applied when upgrading.
1713 * display billing type
1714 * add button to pay only selected charges
1715 * reformat the credit card number input page
1721 Clickable Copy Locations
1722 ^^^^^^^^^^^^^^^^^^^^^^^^
1723 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1724 the associated copy location will display as a link in the public catalog summary display.
1725 This link can be useful for retrieving maps or other directions to the copy
1726 location to aid users in finding material.
1731 Download Checkout History CSV Fixed for Large Number of Circulations
1732 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1733 Downloading checkout history as a CSV from My Account has been fixed
1734 for users with a large circulation history. Previously, this would
1735 time out for patrons with more than 100 or so circulations.
1737 This feature no longer uses the action/trigger mechanism and the public catalog
1738 now generates the CSV directly. The old action/trigger code is still
1739 present in the database and should be removed at some point in the
1745 Google Books Preview Rewrite
1746 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1747 The Google Books Preview functionality in record detail pages has been
1748 rewritten to modernize its style and optimize its performance:
1750 * The Dojo JavaScript framework is no longer used, saving approximately
1751 150K of JavaScript and CSS and four network requests per page load.
1752 * The Embedded Viewer is not loaded unless a possible preview is found,
1753 saving more network and memory overhead.
1754 * The Google Books Loader is used to load the Embedded Viewer instead of the
1755 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1757 * All variables are self-contained and do not pollute the global namespace.
1758 * Event listeners are registered to handle clicks, rather than attaching
1759 `href="javascript:function()"` to <a> elements.
1760 * Book previews are displayed in a panel sized according to the viewport
1761 of the browser, improving its appearance on both mobile and desktop
1763 * The rewritten code is now served up directly from
1764 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1769 jQuery for the Public Catalog
1770 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1771 This release adds optional support for jQuery in the public catalog. This support
1772 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1773 `config.tt2` template.
1779 New Popularity Parameters
1780 ^^^^^^^^^^^^^^^^^^^^^^^^^
1781 New popularity parameters for in-house use over time and for count of distinct
1782 organizational units that own a title are now available. Evergreen sites
1783 can use these parameters to create new statistical popularity badges for
1784 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1786 The in-house use parameters will apply a badge to titles that have the most
1787 in-house use activity over time. The organizational unit count parameter
1788 will apply a badge to titles owned by the most number of libraries in a
1789 consortium. Ownership is determined by the copy's circulation library.
1794 Option to Suspend Holds at the Time They are Placed
1795 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1796 Users now have the option to suspend a hold at the same time they place the
1797 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1798 who want to suspend a hold at the time it is placed. There is also an option
1799 to set the activation date at the same time. This option is also available
1800 when placing holds on a batch of titles from 'My List' and will apply to
1801 all the titles in the batch.
1812 Fix to reporter.classic_current_circ View
1813 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1814 The `reporter.classic_current_circ` view, which is part of some
1815 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1816 has been fixed to not exclude loans for patrons who do not have a
1817 billing address set. Users of this view should rerun
1818 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1823 New Report Source Table Allowing Report of "Last" Deleted copy
1824 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1826 This source table allows you to construct a clever aggregate report template
1827 which will report bibliographic IDs where a library or a group of libraries
1828 no longer have a copy attached but *had* a copy attached. This is especially
1829 useful when a holdings sync is required with an external vendor.
1832 Instructions for creating a report template with this source:
1834 * Create a new report template using "Library Holdings Count with Deleted" as the source
1835 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1836 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1837 * 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"
1838 * Add "Bib ID" to Displayed Fields
1839 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1840 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1841 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1844 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1845 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1846 specified date range. Unfortunately the user will have to manually type the date range without the date
1847 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1848 copy and more than two deleted copies."
1853 Add Provider to Provider Note Link
1854 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1855 The Provider reporting source now includes a link to the Provider Note reporting source.
1860 Link ILS User and Working Location Reporting Sources
1861 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1862 The Working Location reporting source now has labels
1863 and it is now linked to the ILS User reporting source, allowing
1864 reports to display or filter on staff working location.
1869 New Circulation Report Source "All Circulation Combined Types"
1870 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1872 This report source will allow you to create a single report template for all of the following:
1875 * In-house uses of non-cataloged items
1877 * Circulations of non-cataloged items
1879 To distinguish between these different types of library use, it's important to display these columns
1880 in your report templates:
1889 Reports Template Searching
1890 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1891 A new form appears along the top of the reports interface for searching
1892 report templates. Once found, typical template actions (e.g. create new
1893 report) are available from within the results interface.
1895 Searches may be performed across selected (visible) folders or all
1896 folders visible to the logged in user.
1898 Searches are case-insensitive, any word order, with left-anchored words.
1899 All searched words must appear in at least one of the searched fields.
1904 * Searching for 'stat cat' matches:
1906 ** statistical category
1907 ** categories, statistical
1908 ** patrons (stat cat)
1909 * Searching for 'stat cat' does not match:
1911 *** both words must be present in the searched field(s)
1913 *** location contains 'cat' but it's not left-anchored.
1918 The templates, reports, and output interfaces now support paging via
1919 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1931 Web Staff Client Serials Module
1932 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1933 The serials module has been ported over to the web staff
1934 client, implementing a unified serials interface that combines
1935 ideas from both the serial control view and alternate serials
1936 control view from the old staff client.
1938 In addition to carrying over functionality that was available
1939 in the old staff client, several new features are included:
1941 * the ability to save prediction pattern codes as templates
1942 that can be shared and reused within an Evergreen database
1943 * a more streamlined interface for managing subscriptions,
1944 distributions, and streams
1945 * it is no longer necessary to create a starting issue in
1946 order to predict a run of issues; the dialog box for
1947 generating a set of predicted issues now lets you specify
1948 the starting point directly.
1949 * the ability to more directly edit MFHDs
1951 The new serials interfaces can be accessed from the record
1952 details page via a Serials drop-down button that links to
1953 a subscription management page, a quick-receive action, and
1954 a MFHD management page. There is also a new 'Serials Administration'
1955 page where prediction pattern and serial copy templates can
1966 SIP Bugfix Changes How Encoding Is Determined in Configuration
1967 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1969 The combined fix for the above mentioned SIP bugs alters the way that
1970 SIPServer looks up the output encoding in the configuration file (typically
1971 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1974 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1975 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1976 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.
1977 4. If none of the above exist, then the default encoding (ASCII) is used.
1979 Number 3 is provided to ease the transition to the new code. It is
1980 the current location of the +encoding+ element in the sample
1981 configuration file and as such, where it is likely to be found in
1982 actual files. It is recommended that you alter your configuration to
1983 move this element out of the +implementation_config+ element and into
1984 its parent +institution+ element. Ideally, SIPServer should *not* look into
1985 the implementation config, and this check may be removed at some time
1993 Web Client Acknowledgments
1994 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1996 The project to develop a new browser-based web client launched four
1997 years ago at the September 2013 Evergreen developer hack-a-way when the
1998 developer community voted to move away from the XUL client and explore other
1999 platforms. The first web client preview became available in Evergreen 2.7 when
2000 circulation was available in the new platform.
2002 The browser-based client is available due to the work of many coders, testers,
2003 bug reporters, documentors, translators, project managers, spec writers, funders
2004 and other contributors over the past four years.
2006 The Evergreen project would like to acknowledge the following organizations
2007 that funded development of the Web Staff Client:
2010 * British Columbia Libraries Cooperative
2011 * Consortium of Ohio Libraries
2013 * Georgia Public Library Service
2014 * Grand Rapids Public Library
2016 * Kenton County Public Library
2017 * King County Library System
2020 * Pennsylvania Integrated Library System
2021 * Pioneer Library System
2024 The Evergreen project would also like to thank the following individuals who
2025 contributed code, translations, documentation patches, tests, bug reports,
2026 technical specifications, and project management to the Web Staff Client:
2063 * Freddy Enrique Pelayo Huapalla
2089 Evergreen 3.0 Acknowledgments
2090 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2092 The Evergreen project would like to acknowledge the following
2093 organizations that commissioned developments in this release of
2097 * British Columbia Libraries Cooperative (BC Sitka)
2099 * Georgia Public Library Service
2100 * King County Library System
2102 * Pennsylvania Integrated Library System
2103 * Pioneer Library System
2105 We would also like to thank the following individuals who contributed
2106 code, translations, documentation patches, and tests to this release of
2155 We also thank the following organizations whose employees contributed
2158 * British Columba Libraries Cooperative
2162 * Emerald Data Networks, Inc.
2163 * Equinox Open Library Initiative
2165 * Grand Rapids Public Library
2166 * Indiana State Library
2168 * King County Library System
2169 * Lake Agassiz Regional Library
2170 * Laurentian University
2171 * Linn-Benton Community College
2173 * Merrimack Valley Library Consortium
2175 * North of Boston Library Exchange
2176 * Pennsylvania Integrated Library System
2177 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2179 * Traverse Area District Library
2181 We regret any omissions. If a contributor has been inadvertently
2182 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob