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.
125 * Fixes an issue where a column header in some interfaces were automatically
126 highlighted in green when retrieving the interface.
132 We would like to thank the following individuals who contributed code,
133 tests and documentation patches to the 3.0.8 point release of
168 This release contains bug fixes improving on Evergreen 3.0.6.
170 * Fixes a performance issue with the Patron Billing History screen and
171 other screens that cause Flattener.pm to re-create joins
173 * Fixes an issue that prevented patron alerts from showing to staff at
175 * Corrects the "Holdable" attribute display on the Item Status detailed
177 * Fixes the ability to delete multiple copies from Item Status.
181 We would like to thank the following individuals who contributed code,
182 tests and documentation patches to the 3.0.7 point release of
196 This release is a security release that fixes cross-site scripting
197 (XSS) vulnerabilities in the Evergreen public catalog. This release
198 also includes several other bugfixes improving on Evergreen 3.0.5.
200 Security Issue: XSS Vulnerability in Public Catalog
201 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202 This release fixes several cross-site scripting (XSS) vulnerabilities
203 in the public catalog. When upgrading, Evergreen administrators should
204 review whether any of the following templates have been customized
205 or overridden. If so, either the template should be replaced with the
206 stock version or the XSS fix (which entails adding the `| html` filter
207 in several places) applied to the customized version.
209 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
210 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
211 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
213 Note that exploiting the XSS vulnerabilities fixed in this release
214 would require either the ability to create maliciously-constructed
215 MARC bibliographic or holdings records or the ability to set a
216 maliciously constructed organizational unit name.
220 Evergreen 3.0.6 also includes the following changes:
222 * When using 'Selection Lists -> Edit MARC Order Record' in the web
223 staff client, now only one click is required to save the MARC
224 record rather than two.
225 * The volume/copy editor in the web staff client now better handles
226 editing multiple items that have different sets of statistical
227 category values assigned to them.
228 * The act of merging bibliographic records now updates bookbags
229 that referred to the source bibliographic record rather than
230 effectively deleting entries for that record.
231 * Additional columns were added to the Holds Pull List in the
233 * The patron registration form in the web staff client now correctly
234 manages setting user preferences.
235 * An error in a pgTAP unit test was corrected.
239 We would like to thank the following individuals who contributed code,
240 tests and documentation patches to the 3.0.6 security release of
256 This release contains bug fixes improving on Evergreen 3.0.4.
258 * The MARC Editor in the Web staff client now wraps long fields.
259 * The MARC Editor no longer allows catalogers to enter new lines
261 * Fixes an issue that prevented serials items from being deleted or
263 * The Web staff client Check In screen no longer reloads the whole
264 page multiple times each time an item is scanned.
265 * Fixes an issue that displayed the oldest -- rather than the newest
266 -- transit in the Web staff client Item Status page.
267 * Fixes an issue that prevented the reports module from being displayed
269 * Fixes an issue in the Web staff client reports module that caused
270 syntax errors in reports that use virtual fields and joins.
271 * Fixes an issue that prevented several dropdown menus in the Web staff
272 client from activating.
273 * Fixes an issue that created duplicate copy data when copies or
274 volumes with parts were transferred.
275 * Fixes the Trim List feature in the Web staff client Check In screen.
276 * The Item Status grid now displays the Circulation Modifier.
277 * Restores missing data from the Profile column in Place Hold patron
279 * Fixes an issue with the http -> https redirect on Apache 2.4.
280 * Fixes an color contrast accessibility issue in the Web staff
281 client and adds underlining to links in grid cells for added accessibility.
282 * Adds automated regression and unit tests for the Web staff client
284 * Adds a process for spell-checking the official documentation.
285 * Adds a script that simplifies the release process related to translations.
290 We would like to thank the following individuals who contributed code,
291 tests and documentation patches to the 3.0.5 point release of
296 * Blake Graham-Henderson
311 This release contains bug fixes improving on Evergreen 3.0.3:
313 * Fixes a bug that caused all searches limited by shelving location to
315 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
316 rather than the ordering agency's SAN.
317 * Fixes a bug that prevented Safari/iOS users from logging in to the
319 * Fixes a bug that prevented users from using the browse interface.
320 * Fixes a bug in the Item Status List view that caused incorrect due
322 * Approval code is now a required field in the web client's patron
323 credit card payment form.
324 * Fixes a bug with credit card payments that caused a receipt to print
325 showing that the patron paid the bill when the payment had not actually
327 * Fixes a bug that prevented the EDI translator from being installed on
329 * Fixes a bug that caused entries to show up multiple times in the
330 Items Out and Holds tabs in the patron record.
331 * Fixes a bug that caused grids on Bills and Patron Messages
332 screens to not display properly.
333 * The following fields are now available for the Checkout and Items Out
340 ** money_summary.balance_owed
341 ** money_summary.total_paid
342 ** money_summary.total_owed
347 * The following fields are now available on the Bill Payment receipt templates:
357 * Payment type is now a column in the payments tab of the patron record
358 Bill History section.
359 * The "Replace Barcode" function now makes it more difficult for staff
360 members to attempt to create blank patron barcodes.
361 * The patron bills screen now prevents staff members from double-clicking
362 on the Apply Payment button (which otherwise would apply two payments).
363 * Fixes a bug that prevented patrons attached to statistical categories
364 from displaying in the patron search-to-hold dialog.
365 * Fixes a performance issue related to uploading CSV files of barcodes
366 to the item status and patron bucket interfaces.
367 * Fixes several small bugs in the Spanish translation.
368 * Fixes a performance bug related to patrons logging in by barcode.
372 We would like to thank the following individuals who contributed code,
373 tests and documentation patches to the 3.0.4 point release of
395 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
396 update the visibility attributes of all bibs that make use of Located URIs or
397 bib sources. It may take a while to run on large datasets. If it it running
398 too long, it can be canceled and the following psql commands will create and
399 run a script that will perform the same action serially over time without
400 blocking writes to bibs:
403 \o /tmp/luri_visibility_update.sql
404 SELECT 'UPDATE biblio.record_entry SET ' ||
405 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
406 'WHERE id = ' || id || '; SELECT ' || id || ';'
407 FROM biblio.record_entry
409 SELECT DISTINCT cn.record
410 FROM asset.call_number cn
412 AND cn.label = '##URI##'
415 FROM asset.uri_call_number_map m
416 WHERE m.call_number = cn.id
419 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
424 \i /tmp/luri_visibility_update.sql
427 It will output the id of each updated bib so that the script can be killed
428 and then edited to remove completed bibs. The remainder can be run at a
431 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
432 we do NOT update the bib's visibility attributes, as doing so causes a loop
433 and an eventual trigger stack violation. This flag should ONLY be used when
434 forcing reingest of record attributes (NOT visibility attributes), search,
435 facet, and display fields, so if using this flag under normal operation,
436 proceed at your own risk and know that Located URI and bib source changes
437 will not be reflected in the visibility attributes of the record.
441 This release contains several bug fixes improving on Evergreen 3.0.1:
443 * Fixes several issues related to the display of located URIs and records with
444 bib sources in search results.
445 * Setting `opac_visible` to false for a copy location group now hides only
446 the location group itself, rather than also hiding every single copy in the
448 * Fixes a bug that prevented the copy editor from displaying the _fine level_
449 and _loan duration_ fields.
450 * The "Edit Items" grid action in the Item Status interface will now open
451 in the combined volume/copy editor in batch. This makes the behavior
452 consistent with the "Edit Selected Items" grid action in the copy
454 * Staff members are now required to choose a billing type when creating a
455 bill on a user account.
456 * The Web client now provides staff users with an alert and option to
457 override when an item with the Lost and Paid status is checked in.
458 * Fixes a bug where the Web client offline circ interface was not able
459 to set its working location.
460 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
462 * The MARC editor in the Web staff client now presents bib sources in
464 * Both circulation and grocery bills are now printed when a staff user selects
465 a patron account and clicks "Print Bills".
466 * Fixes an issue in the XUL serials interface the "Receive move/selected"
467 action from succeeding.
468 * Fixes a typo in the user password testing interface.
472 We would like to thank the following individuals who contributed code,
473 tests and documentation patches to the 3.0.3 point release of
492 This release contains several bug fixes improving on Evergreen 3.0.1:
494 * Copy templates created in XUL Holdings Maintenance will now be
495 automatically converted and displayed in the web staff client's
497 * The list of report templates now includes a column indicating whether
498 the template was originally created in the XUL staff client or the web
499 staff client; staff need to know this since report templates created in
500 one interface cannot be edited in the other.
501 * Call number prefixes and suffixes are now displayed in various grids
502 in the web staff client, including
503 ** Pending Copy Buckets
505 ** Checkin/Capture Holds
507 ** Patron Bills History
514 ** Bib Record View Holds
516 * Many patron fields have been redacted from the web staff client's patron
517 and record holds grids, leaving patron name, username, and ID.
518 * Fixes two bugs where patron records could fail to be saved upon editing.
519 * The web staff patron editor now better warns staff users about
520 duplicate names, IDs, phone numbers, and email addresses.
521 * Human readable labels are now displayed for certain fields in standing
523 * The patron summary in the web staff client now correctly displays
524 primary and secondary ID values.
525 * The web staff client's billing full details page now displays
526 information about the staff user that created a payment.
527 * The web staff client now requires staff users to explicitly set a
528 billing type when adding a manual bill.
529 * The web staff client's patron bill annotation modal now works.
530 * Patron barcode search completion in the web staff client now allows
531 the user to select from all of the matching patron records.
532 * The Hold Shelf Slip print template in the web staff client now has
533 access to the call number.
534 * The Checkout Receipt print template in the web staff client now can
535 include summary financial information, incuding current balance, total
536 paid on outstanding fines, and total owed.
537 * The web staff print templates for current and historical bills can
538 now include copy barcode and title.
539 * Fixes a bug that resulted in some catalog searches unexpectedly
541 * Fixes a bug that resulted in catalog searches that specify a location
542 limit returning incorrect results.
543 * Fixes a bug where deleted copies could make records visible in the
545 * Fixes a bug where certain queries on copies used in the public catalog
547 * Fixes a bug place a hold request in the public catalog could result
548 in "forgetting" the type and library of the user's previous search.
549 * The web staff client now respects staff user session timeouts, and
550 will log out all open tabs if a user's session has timed out.
551 * The web staff Z39.50 page will now give the staff user an alert if
552 they attempt to import a record with a duplicate TCN.
553 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
554 entries from being deleted.
555 * Fixes a bug that made using the volume/copy editor to change a copy's
557 * The administration interface for hard due dates now ensures that
558 new (or edited) ceiling dates have their time component set to end
559 of day, resolving an issue where ceiling dates would not be applied
560 during the ceiling date itself.
561 * The web staff client can now include dynamic information in browser
562 tab titles, e.g., "Smith, Jane - Checkout".
563 * The Concerto sample data set now includes data allowing for testing
564 placing holds on monographic parts.
565 * Asset merging during bibliographic record merging now correctly
566 recognizes call number prefixes and suffixes and deletes disused
568 * Fixes a bug where displaying user surveys could result in PCRUD
570 * Fixes a bug where pg_restore of an Evergreen database could fail
571 to create certain indexes on the `actor.usr` table.
575 We would like to thank the following individuals who contributed code,
576 tests and documentation patches to the 3.0.2 point release of
607 This release contains several bug fixes improving on Evergreen 3.0.0
609 * Fixes a bug in the web staff client that prevented initials from being
610 stored with copy notes.
611 * Adds billing types that may have been missed by systems that were
612 running Evergreen prior to the 1.4 release.
613 * Fixes a web staff client bug with the CSV export option available from
614 the Import Queue in the MARC Batch Import/Export interface.
615 * Adds the missing copy alert field in the web client's volume/copy
617 * Fixes a bug where the setting to require date of birth in patron
618 registration was not being honored in the web staff client.
619 * Fixes a bug in the web staff client patron registration form where the
620 password wasn't generating from the last four digits of the patron's
622 * Fixes an issue in the web staff client where the complete barcode did
623 not display in some interfaces when partial barcodes were scanned.
624 * Fixes an HTML error in the new copy tags that display on the record
626 * Fixes a web staff client bug where recording a large number of in-house
627 uses at one time doesn't display a confirmation dialog once it hits the
629 * Adds a _Print Full Grid_ action in the web staff client
630 holds pull list to allow staff to print the entire pull list as it
631 displays on the screen. This change also changes the _Export CSV_ action
632 to an _Export Full CSV_ option.
633 * Fixes an issue with the Patron Messages interface that prevented it
634 from saving column configuration changes in the web staff client.
635 * Fixes a bug in the web staff client where a billing prompt did not
636 correctly display after marking an item damaged in those systems that
637 have enabled the setting to bill for damaged items.
638 * Adds an option to the specific due date feature that allows saving
639 that due date until logout. This allows all circulations from a given
640 workstation to be due on the same date.
644 We would like to thank the following individuals who contributed code,
645 tests and documentation patches to the 3.0.1 point release of
667 The minimum version of PostgreSQL required to run Evergreen 3.0 is
668 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
670 Change to Names of Shared Libraries
671 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
672 OpenSRF 3.0 changes how the shared libraries for services written in
673 C are named. If upgrading from an earlier version of Evergreen,
674 `opensrf.xml` should be edited so that shared library file names
675 listed in the `<implementation>` tag start with "lib". For example,
678 ---------------------------------------------------------------------
680 <language>C</language>
681 <implementation>oils_cstore.so</implementation>
682 ---------------------------------------------------------------------
684 should be changed to:
687 ---------------------------------------------------------------------
689 <language>C</language>
690 <implementation>liboils_cstore.so</implementation>
691 ---------------------------------------------------------------------
693 SIP Bugfix Requires SIPServer Upgrade
694 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
696 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
697 crash" requires that you also upgrade SIPServer with the fix for
698 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
699 SIP client problems." This means that if you use SIP2 with Evergreen,
700 you must also upgrade SIPServer to the latest commit in the Git
701 repository. Conversely, if you upgrade SIPServer to the latest commit
702 in Git, you must also upgrade Evergreen or, at least, apply the patch
703 for Launchpad Bug 1542495. These two patches are complementary and
704 cannot be applied independently of one another.
706 `open-ils.auth.login`
707 ~~~~~~~~~~~~~~~~~~~~~
708 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
709 API's in the `opensrf_core.xml` file.
714 ---------------------------------------------------------------------
715 --- a/Open-ILS/examples/opensrf_core.xml.example
716 +++ b/Open-ILS/examples/opensrf_core.xml.example
717 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
719 <match_string>open-ils.auth.authenticate.verify</match_string>
720 <match_string>open-ils.auth.authenticate.complete</match_string>
721 + <match_string>open-ils.auth.login</match_string>
722 <match_string>open-ils.auth_proxy.login</match_string>
723 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
724 <match_string>open-ils.actor.user.password</match_string>
725 ---------------------------------------------------------------------
729 Administrators of Evergreen who use RTL locales and who have customized
730 `style-rtl.css.tt2` should now incorporate their customizations into
733 Multi-Time Zone Installations
734 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
736 For Evergreen consortia that span more than one time zone, the following
737 query will adjust all historical, unaged circulations so
738 that if their due date field is pushed to the end of the day, it is done
739 in the circulating library's time zone, and not the server time zone.
741 It is safe to run this after any change to library time zones.
743 Running this is not required, as no code before this change has
744 depended on the time string of '23:59:59'. It is also not necessary
745 if all of your libraries are in the same time zone, and that time zone
746 is the same as the database's configured time zone.
755 for ou_id in select id from actor.org_unit loop
756 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
757 if new_tz is not null then
758 update action.circulation
759 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
760 where circ_lib = ou_id
761 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
770 Deprecation of XUL staff client
771 -------------------------------
772 Starting with the release of 3.0.0, patches that fix XUL bugs will not
773 be merged into master or backported unless they meet one or more of
774 the following conditions:
776 a. the bug is a security issue
777 b. the bug involves the destruction of data
778 c. the bug is a regression of functionality in the XUL staff client
779 introduced by other work done to Evergreen
781 Under no circumstances will XUL staff client feature enhancements be merged.
783 This policy will continue through the 3.0.x and 3.1.x maintenance
784 release cycles, and will become moot upon the release of 3.2.0, when
785 the XUL staff client is slated to be entirely removed.
794 Evergreen 3.0 features a new, modern staff client that runs in the web browser
795 and can be used on desktop and mobile devices. All functional areas of the
796 system, including circulation, cataloging, acquisitions, serials, reports,
797 booking, administration, and offline circulation, are available in the new staff
798 client. Chrome and Firefox are officially supported for use with the web client.
800 Library staff will no longer need to download separate software to perform most
801 actions in Evergreen. A Chrome plugin called Hatch will be available as a
802 separate installation for workstations that require seamless, dialog-free
803 printing to multiple printers.
805 In addition to adding more portability and stability, the new staff client also
806 presents a cleaner and more modern interface for users. By virtue of running in
807 a browser, actions that users are accustomed to performing on other web sites
808 should now be available in the Evergreen client.
810 The old, XUL client will continue to be available to allow for a gradual
811 transition to the browser-based client, but no new features will be added. The
812 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
822 New EDI Order Generator
823 ^^^^^^^^^^^^^^^^^^^^^^^
828 . New database tables exist for configuring vendor-specific EDI order
832 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
835 ** Collection of `edi_attr`s. Each edi_account may be linked to one
837 ** One `edi_attr_set` per known vendor is added to the stock data, matching
838 the stock configuration found in the JEDI template.
839 * `acq.edi_attr_set_map`
840 ** Link between `edi_attr`s and `edi_attr_set`s.
842 . EDI Attribute Sets are manged via a new (browser client only) configuration
843 interface at 'Administration -> Acquisitions Administration -> EDI
846 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
847 is not set, default values will be used. Links between an EDI account
848 and an attribute set are managed in the EDI Accounts configuration
851 . Local modifications to the stock EG JEDI template are managed by modifying
852 and/or adding additional `edi_att_set`s as needed.
854 . A new `edi_order_pusher.pl` script is added which replaces the functionality
855 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
857 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
858 definition is no longer required and can be disabled.
863 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
864 specifies whether PO's generated via the account should be built using
865 EDI attributes or fall back to traditional JEDI A/T template generation.
867 This allows sites to activate EDI attributes on a per-account basis, making
868 it possible to migrate piecemeal to EDI attributes. For the initial roll
869 out of this new feature, no accounts will be configured to use EDI
870 attributes by default.
876 3 Day Courtesy Notice by SMS
877 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
878 New optional SMS text notification to be sent out 3 days prior to the due
879 date of any circulating item for patrons who have an SMS text number and
880 carrier stored in their accounts. This action trigger is disabled by default,
881 but can be enabled and modified by going into 'Administration -> Local Administration ->
882 Notifications / Action Triggers'.
884 You may wish to make use of granularity so that these messages are batched
885 and sent at the same time each day.
890 Add Description Field to Circulation and Hold Configuration Entries
891 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
892 The circulation and hold policy configuration rules now each have a
893 description field. This allows administrators to add comments to
894 describe the purpose of each rule.
899 Apache Internal Port Configuration Option
900 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901 Apache configuration now supports a new variable which allows admins to
902 specify the port used by Apache to handle HTTP traffic. The value is
903 used for HTTP requests routed from Perl handlers back to the same Apache
904 instance, like added content requests. Use this when running Apache
905 with a non-standard port, typical with a proxy setup. Defaults to "80".
908 -------------------------------------------------------------------
911 PerlSetVar OILSWebInternalHTTPPort "7080"
914 -------------------------------------------------------------------
919 Configurable Bib Record Display Fields
920 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
922 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
923 fields: 'Display Field?' and 'Display XPath'.
925 When 'Display Field' is set to true, data from the field will be extracted
926 from each record and added to a new table of display data for each bib
929 If a value is present in the 'Display XPath' field, this XPath will be
930 applied to the extracted data *after* the base XPath (from the 'XPath'
931 field) is applied to each field.
933 This data acts as a replacement for the various and sundry ways bib record
934 data is currently extracted, including inline XPath in the TPAC, reporter
935 views, real-time 'MVR' compilation from MODS, etc. and will be available
936 to the user interface, notification templates, etc. for rendering bib
939 The browser client gets a new service 'egBibDisplay' which is capable
940 of translating the display field data from various formats into
941 data more suitable for JavaScript usage.
943 The database gets 3 new views for representing display data in various
946 * `metabib.flat_display_entry`
947 ** List of all display fields linked to their configuration.
948 * `metabib.compressed_display_entry`
949 ** Same as `metabib.flat_display_entry` except there's one row
950 per display field type, with 'multi' rows compressed into
951 JSON arrays. Non-multi fields are represented as JSON
953 * `metabib.wide_display_entry`
954 ** Tabular view of display field data, one column per well-known
955 field. Values are represented JSON, consistent with
956 `metabib.flat_display_entry`. The view does *not* contain locally
957 configured display fields, as each field must be encoded in
958 the view and IDL definition. This is essentially a replacement
959 for `reporter.simple_record`.
964 After making changes to display field configuration, it's possible to
965 reingest only display field data in the database using the following:
968 ---------------------------------------------------------------------
969 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
970 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
971 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
972 ---------------------------------------------------------------------
978 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
979 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
980 The existing permission was incorrectly created with a code of
981 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
982 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
983 update changes the permission code to match what the event requires.
989 Hold Targeter V2 Repairs and Improvements
990 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
991 * Make the batch targeter more resilient to a single-hold failure.
992 * Additional batch targeter info logging.
993 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
994 * Removes the confusingly named `--target-all` option
995 ** The same behavior can be achieved by using `--retarget-interval "0s"`
996 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
998 New --next-check-interval Option
999 ++++++++++++++++++++++++++++++++
1000 Specify how long after the current run time the targeter will retarget
1001 the currently affected holds. Applying a specific interval is useful
1002 when the retarget-interval is shorter than the time between targeter
1005 For example, if the targeter is run nightly at midnight with a
1006 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1007 since the holds won't be processed again until 48 hours later. This
1008 ensures that the org unit closed date checks are looking at the correct
1011 This setting overrides the default behavior of calculating the next
1012 retarget time from the retarget-interval.
1014 New --soft-retarget-interval Option
1015 +++++++++++++++++++++++++++++++++++
1016 This is a replacement for (and rebranding of) the `--skip-viable` option.
1017 The new option allows for time-based soft-targeting instead simple binary
1018 on/off soft-targeting.
1020 How soft-targeting works:
1022 * Update hold copy maps for all affected holds
1023 * Holds with viable targets (on the pull list) are otherwise left alone.
1024 * Holds without viable targets are retargeted in the usual manner.
1030 New marc_export --descendants Option
1031 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1033 The `marc_export` script has a new option, `--descendants`. This option
1034 takes one argument of an organizational unit shortname. It works much
1035 like the existing `--library` option except that it is aware of the
1036 org. tree and will export records with holdings at the specified
1037 organizational unit and all of its descendants. This is handy if you
1038 want to export the records for all of the branches of a system. You
1039 can do that by specifying this option and the system's shortname,
1040 instead of specifying multiple `--library` options for each branch.
1042 The `--descendants` option can be repeated, as the `--library` option can.
1043 All of the specified org. units and their descendants will be included
1044 in the output. It can also be combined with individual `--library`
1045 options when necessary.
1050 RTL and LTR Public Catalog Stylesheets Merged
1051 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1052 The RTL stylesheet for the public catalog,
1053 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1054 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1055 template will provide RTL or LTR styles based on the value of
1056 the `rtl` flag of the active locale. An `rtl` variable is also available
1057 in the template to allow the correct style to be chosen.
1062 Miscellaneous Improvements
1063 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1065 * If a filter is in effect in the Library Settings Editor,
1066 the filter will continue to be applied after a user
1067 changes the selected library.
1068 * Copy templates used for serials now correctly link to age
1069 protection rules and MARC item type values (for the
1070 "Circ as Type" field). During upgrade, the database update
1071 will set to NULL any age protection and circ as type fields
1072 in serial copy templates that do not point to defined values.
1077 Obsolete Internal Flag Removed
1078 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1080 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1081 flag was removed from the `config.internal_flags` table. It was
1082 rendered obsolete by the addition of the 3 flags to control the
1083 browse, search, and facet indexing.
1088 Tweaks to Caching/Expiry of Public Catalog Assets
1089 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1090 The default cache expiration time for static assets (e.g.,
1091 CSS, image, and JavaScript files) in the public catalog and
1092 the Kid's PAC has been increased to one year. Links to all
1093 such assets now have a cache-busting value tacked on as a
1094 query parameter. This value is refreshed when `autogen.sh` is
1095 run, but it can also be manually set by adjusting the
1096 `ctx.cache_key` Template Toolkit variable.
1101 Action/Trigger Events Data Purging
1102 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1104 Action/Trigger event definitions have a new field called 'Retention
1105 Interval'. When an optional interval value is applied, events and
1106 template output data linked to the event definition will be deleted
1107 from the database once they reach the specified age.
1109 Retention Interval Restrictions for Passive Hooks
1110 +++++++++++++++++++++++++++++++++++++++++++++++++
1112 Restrictions are placed on retention interval values for event definitions
1113 using passive hooks to prevent data from being deleted while it's still
1114 needed by the system.
1116 The presence of event data is how the system knows not to send duplicate
1117 events. As long as a scenario exists where a duplicate event may be
1118 generated, the events must be retained.
1120 To apply a retention interval value to a passive-hook event definition:
1122 * The event definition must have a max_delay value.
1123 * The retention interval must be larger than the difference between
1124 the `delay` and `max_delay` values.
1126 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1127 interval must be greater than 3 days to ensure no duplicate events are
1128 created between the first event on day 7 and the end of the event validity
1134 A new `purge_at_events.sh` script is installed in the bin directory
1135 (typically `/openils/bin`) which should be added to CRON for regular
1138 NOTE: On large data sets, this script can take a long time to run and
1139 create higher than normal I/O load as it churns though the event and
1140 event_output tables. You may wish to run the script by hand the first
1141 time so it can be monitored. It can be run in psql like so:
1144 ---------------------------------------------------------------
1145 SELECT action_trigger.purge_events();
1146 ---------------------------------------------------------------
1148 NOTE: On *very* large data sets (10s to 100s of millions of event and
1149 event_output rows), it may be advisable to first repopulate the `event`
1150 and `event_output` tables with only the desired data before starting
1151 regular purges. This can be done, for example, using the copy to temp
1152 table, truncate source table, repopulate source table from temp table
1153 approach. This will be much faster than the `purge_events()` function
1154 in cases where most of the data will be purged.
1159 A number of `action_trigger.hook` entries which have always been treated
1160 as active hooks, though are configured as passive hooks, have been
1161 updated to properly reflect the non-passive-ness. This allows for
1162 simpler configuration of their retention interval values.
1168 Remove JSPAC Redirects
1169 ^^^^^^^^^^^^^^^^^^^^^^
1170 Future versions of Evergreen will no longer contain automatic redirects
1171 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1172 that the JSPAC is no longer supported. Existing sites, however, may
1173 wish to retain JSPAC redirects in their Apache configuration files since
1174 JSPAC URLs may still be used in the wild to access their catalogs.
1176 The original JSPAC URL redirects are all retained in the file
1177 `Open-ILS/examples/jspac_redirects.conf` for reference.
1187 New open-ils.auth.login API
1188 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1189 The `open-ils.auth` service has a new API for requesting an authentication
1190 token. It performs the same steps as the
1191 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1192 using the bare password. No intermediate password hashing is required.
1194 The paramaters are the same as the `.complete` call with a few modifications.
1196 1. Using the generic 'identifier' parameter in combination with the
1197 'org' parameter allows the API to reliably determine if an identifier
1198 value is a username or barcode. The caller is no longer required to
1199 make that determination up front.
1201 2. The 'nonce' parameter is no longer used.
1207 Batch Patron Contact Invalidation
1208 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1209 The following methods are used to mark patron contact fields
1210 as invalid by moving the invalid value to a standing penalty:
1212 * `open-ils.actor.invalidate.email`
1213 * `open-ils.actor.invalidate.day_phone`
1214 * `open-ils.actor.invalidate.evening_phone`
1215 * `open-ils.actor.invalidate.other_phone`
1217 These methods now accept a fifth argument specifying the value
1218 of the contact field, e.g., a specific phone number or email
1219 address. If supplied, and if a specific patron ID (the first
1220 argument) is not supplied, all patrons with that specific contact
1221 value will have it marked invalid.
1231 Pure-SQL catalog searching
1232 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1233 Public and staff catalog search is now both more accurate and faster
1234 by redesigning how the visibility of records is calculated.
1244 Authority Record and Headings Browse Improvements
1245 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1246 Various improvements are made to support for authority records
1247 and headings browsing:
1249 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1250 headings from authority records. Since the MODS and MADS stylesheets
1251 extract headings in similar ways, duplicate browse entries are now
1252 much less likely to occur.
1253 * A new configuration table, `authority.heading_field`, is now used
1254 to specify how headings should be extracted from authority records.
1255 * Related headings can now be identified as narrower or broader when
1256 browsing in the public catalog.
1257 * See references are now more reliably included in the browse list.
1258 * Scope (public) notes now display only under the main heading.
1259 * There is now a global flag, Display related headings (see-also) in browse,
1260 that can be used to control whether related headings (see-alsos) are
1261 displayed in the public catalog list.
1262 * A complete set of thesauruses are now included in the seed data. Thesauruses
1263 can now be identified using short and long codes.
1264 * The labels for see and see-also references in the public catalog are
1265 a bit more patron-friendly, and can now be tweaked via TPAC template
1266 customization in the browse.tt2 file.
1272 Copy Tags and Digital Bookplates
1273 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1274 Copy tags will allow staff to apply custom, pre-defined labels or tags
1275 to copies. Copy tags are searchable in both the staff client and public
1276 catalog. This feature was designed to be used for Digital Bookplates to
1277 attach donation or memorial information to copies, but may be used for
1278 broader purposes to tag items.
1280 Each copy tag can either be publicly-visible or visible only to staff.
1281 Copy tags also have types that can be used for restricting catalog
1282 searches on copy tags to particular types.
1284 Copy tags are displayed in the copy table in the record summary page in
1285 the public catalog, and a new library setting can be used to add
1286 a "Digital Bookplate" search field. Copy tags can also be used
1287 as a search filter, e.g.,
1289 * `copy_tag(bookplate, jane smith)`: search for records that have a
1290 copy tag of type 'bookplate' whose value contains 'jane smith'.
1291 * `copy_tag(*, jane smith)`: search for records that have a
1292 copy tag of any type whose value contains 'jane smith'.
1294 All staff-side interfaces related to copy tags exist only in the web
1295 staff client. There are two new administration interfaces for managing
1296 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1297 button for applying copy tags to copies; that interface can also be
1298 used to create new copy tags on the fly. Furthermore, the copy buckets
1299 interface now has an 'Apply Tags' action for assigning tags to groups
1305 Two new permission are included:
1307 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1308 'Administration -> Server Administration -> Copy Tag Types'
1309 * `ADMIN_COPY_TAG`: required to create a new tag under
1310 'Administration -> Local Administration -> Copy Tags'
1312 The existing permission `UPDATE_COPY` controls whether or not a user
1313 can link copies to tags.
1317 A new library setting, 'Enable Digital Bookplate Search', controls
1318 whether to display a 'Digital Bookplate' field in the search index
1319 drop-downs in the catalog. A 'Digital Bookplate' search will include
1320 all records that have a copy that matches the tag specified by the user.
1321 It should be noted that this library setting does not affect the
1322 display of copy tags on the catalog record summary page.
1327 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1328 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1329 The call number prefix and suffix, when present, are now included in
1330 subfields $k and $m of the 852 field when running `marc_export` with
1331 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1332 server configured to embed item data in 852 fields, the affixes are now
1333 included in subfields $k and $m.
1343 Batch Editing of Patron Records
1344 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1345 There is a now a new interface analogous to the Copy Bucket interface
1346 to select and group a set of users into a User Bucket.
1347 The addition of users to a User Bucket is possible from the Patron Search
1348 interface by the use of a new grid Action, and directly on the User Bucket
1349 interface by user barcode. It is also possible to add users to a User
1350 Bucket by uploading a text file that contains a list of user barcodes.
1352 From this interface it is possible to perform a set of specific batch update
1353 operations on user records.
1358 These fields can now be changed in batch via an action on the User Bucket
1359 grid if the staff user has the `UPDATE_USER` permission:
1362 * Primary Permission Group (group application permissions consulted)
1364 * Home Library (`UPDATE_USER` checked against both old and new value)
1365 * Privilege Expiration Date
1366 * Barred flag (`BAR_PATRON` permission consulted)
1367 * Internet Access Level
1369 Changes made in this interface can be rolled back.
1371 As a batch process, rather than a direct edit, this mechanism explicitly skips
1372 processing of Action/Trigger event definitions for user update.
1377 The batch edit mechanism also allows for the batch deletion of user. The staff
1378 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1380 Changes made in this interface can be rolled back.
1382 As a batch process, rather than a direct edit, this mechanism explicitly skips
1383 processing of Action/Trigger event definitions for user deletion.
1385 This mechanism does not use the Purge User functionality, but instead simply
1386 marks the users as deleted.
1388 Editing Statistical Category Entries
1389 ++++++++++++++++++++++++++++++++++++
1391 All users in the bucket can have their Statistical Category Entries
1392 modified. Unlike user data field updates, modification of Statistical
1393 Category Entries is permanent and cannot be rolled back.
1395 As a batch process, rather than a direct edit, this mechanism explicitly skips
1396 processing of Action/Trigger event definitions for user update.
1398 New Service Requirement
1399 +++++++++++++++++++++++
1401 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1402 unused in production. If this service has been removed from the configuration
1403 of a live Evergreen instances, it will need to be added back in order for
1404 batch user editing to succeed.
1409 Honor Timezone of the Acting Library
1410 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1415 * Display day-granular due dates in the circulating library's timezone.
1416 * Only display the date portion of the due date for day-granular circulations.
1417 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1418 * Provide infrastructure for more advanced formatting of timestamps.
1419 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1424 This is a followup to the work done for 2.12, where we added the ability
1425 for the client to specify a timezone in which timestamps should be interpreted
1426 in business logic and the database.
1428 Most specifically, this work focuses on circulation due dates and the closed
1429 date editor. Due dates, where displayed using stock templates (including
1430 receipt templates) and used for fine calculation, are now manipulated in the
1431 library's configured timezone. This is controlled by the new 'lib.timezone'
1432 setting available via the Library Settings Editor, loaded from the server when
1433 required. Additionally, closings are recorded in the library's timezone so that
1434 due date calculation is more accurate. The closed date editor is also
1435 taught how to display closings in the
1436 closed library's timezone. Closed date entries also explicitly record if they
1437 are a full day closing, or a multi-day closing. This significantly simplifies
1438 the editor, and may be useful in other contexts.
1440 To accomplish this, we use the moment.js library and the moment-timezone addon.
1441 This is necessary because the stock AngularJS date filter does not understand
1442 locale-aware timezone values, which are required to support DST. A simple
1443 mapper translates the differences in format values from AngularJS date to
1446 Of special note are a set of new filters used for formatting timestamps under
1447 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1448 filters provide the functionality, and autogrid is enhanced to make use of
1449 these where applicable. egGrid and egGridField are also taught to accept
1450 default and field-specific options for applying date filters. These filters may
1451 be useful in other or related contexts.
1453 The egDueDate filter, used for all existing displays of due date via Angular
1454 code, intentionally interprets timestamps in two different ways WRT timezone,
1455 based on the circulation duration. If the duration is day-granular (that is,
1456 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1457 of seconds) then the date is interpreted as being in the circulation library's
1458 timezone. If it is an hourly loan (any duration that does not meet the
1459 day-granular criterium) then it is instead displayed in the client's timezone,
1460 just as all other timestamps currently are, because of the previous Evergreen
1463 The public catalog is adjusted to always display the due date in the circulating
1464 library's timezone. Because the public catalog displays only the date portion of the due
1465 date field, this difference is currently considered acceptable. If this proves
1466 to be a problem in the future, a minor adjustment can be made to match the
1467 egDueDate filter logic.
1469 Now that due dates are globally stored in the configured timezone of the
1470 circulating library, the automatic adjustment to day-granular due dates needs
1471 to take those timezones into account.
1473 An optional SQL command is provided by the upgrade script to retroactively
1474 adjust existing due dates after library configuration is complete.
1480 Enhancements to Hard Due Date Functionality
1481 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1482 It will now be possible to delete Hard Due Date Values for dates that have
1483 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1484 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1485 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1490 Patron Search by Birth Date
1491 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1492 * Now you can include the patron birth year and/or birth month and/or
1493 birth day when searching for patrons using the web staff client.
1494 * Day and month values are exact matches. E.g. month "1" (or "01")
1495 matches January, "12" matches December.
1496 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1497 1915, 1599, etc. For exact matches use the full 4-digit year.
1501 Patron Search from Place Hold
1502 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1503 This feature allows staff members, when placing a
1504 hold on behalf of a patron in the web staff client, to search for
1505 patrons by names and other searchable patron information, rather than
1506 relying on barcode alone. In particular, after performing a catalog
1507 search or going to a specific bib record and clicking the 'Place Hold'
1508 button, the form now includes a 'Patron Search' button. This button
1509 will open a dialog allowing the staff member search for and select
1515 Retrieve Recent Patrons
1516 ^^^^^^^^^^^^^^^^^^^^^^^
1518 Adds a new library setting 'Number of Retrievable Recent Patrons'
1519 ('ui.staff.max_recent_patrons') that specifies the number of recently
1520 retrieved patrons that can be re-fetched from the staff client.
1522 A value of 0 means no recent patrons can be retrieved.
1523 A value greater than 1 means staff will be able to retrieve multiple
1524 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1526 The default value is 1 for backwards compatibility.
1533 Fuller title in XUL client Simplified Pull List
1534 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1535 The Simplified Pull List in the XUL client will now display subfields 245$n and
1536 $p in the title field. The addition will make it easier for staff to distinguish
1537 between different parts or seasons in a series.
1543 Transit Cancel Time and Terminology Change
1544 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1549 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1550 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1551 are preserved in the database, though still not visible to the end user in the staff client.
1552 This allows for better tracking of when transits are canceled for the purposes of knowing
1553 which staff member canceled the transit, etc.
1555 NOTE: This change may require the re-creation of transit reports to filter out canceled
1556 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1557 Is NULL' will suffice.
1559 "Canceled Transit" Terminology Change
1560 +++++++++++++++++++++++++++++++++++++
1562 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1563 For internal continuity, however, the following permission codes have not changed:
1566 * `ABORT_REMOTE_TRANSIT`
1567 * `ABORT_TRANSIT_ON_LOST`
1568 * `ABORT_TRANSIT_ON_MISSING`
1576 Offline Circulation Available in Web Staff Client
1577 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1578 Offline circulation is now available in the web staff client. In order to use the
1579 offline interface, users must first log into the web staff client, perform
1580 a patron search, select a user from the results, and open the patron editor
1581 interface to collect all the relevent configuration information for the
1582 workstation. In addition, the offline interface available from the Circulation
1583 menu provides a 'Download block list' button for users who are logged in.
1585 As is the case in the old staff client, users can check materials in and out,
1586 renew items, and create new patron accounts while offline. The patron fields
1587 available in the offline patron registration editor are the same ones that
1588 are available to staff when working online.
1592 Add Circ Modifier to Record Detail Page in Staff TPAC
1593 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1594 The circulation modifier field is added to the table of copies to make
1595 more information available to staff without having to open
1602 Date+Time Format Settings for Web Client
1603 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1605 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1606 and adds two settings for use with the webstaff client:
1608 * 'Format Dates with this pattern'
1609 * 'Format Date+Time with this pattern'
1611 These settings use format strings as documented here:
1613 https://docs.angularjs.org/api/ng/filter/date
1615 There is overlap with how the Dojo formats worked, but also some differences.
1617 The original 'Format Dates' and 'Format Times' settings worked together, but the
1618 new settings work independently. Certain field elements will use one, and
1619 certain field elements will use the other. These distinctions are hard-coded
1620 in the various UI templates, with the idea being that timestamp fields in
1621 which the date component alone is sufficient information (for example, date of birth)
1622 will use the 'Format Dates' setting. Fields where the time component is
1623 important (for example, checkout time) will use the 'Format Date+Time' setting.
1625 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1626 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1632 Global Option to Remove Sound for a Specific Event
1633 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1634 A new `nosound.wav` file has been added to the web client. The file can be used
1635 to globally disable audio alerts for a specific event on an Evergreen system.
1637 For example, to silence the alert that sounds after a successful patron search:
1641 mkdir -p /openils/var/web/audio/notifications/success/patron/
1642 cd /openils/var/web/audio/notifications/success/patron/
1643 ln -s ../../nosound.wav by_search.wav
1650 The official Evergreen manual has been split into eight new manuals, each
1651 designed for a specific audience. This new approach is designed to make
1652 the documentation more readable and usable.
1654 The specific audiences for the new manuals are:
1656 * Acquisitions staff
1659 * Public services staff who use the public catalog
1661 * System administrators who use the command line
1662 * System administrators who use the Web client
1663 * System administrators and programmers who wish to integrate Evergreen
1664 with other technologies
1666 All manuals are available at http://docs.evergreen-ils.org
1672 Improvements to ebook API
1673 ^^^^^^^^^^^^^^^^^^^^^^^^^
1675 Evergreen now supports checking out and placing holds on
1676 OverDrive and OneClickdigital ebook titles from within the public
1677 catalog. This is an experimental feature. It is not recommended for production
1678 use without careful testing.
1680 When ebook integration is enabled, a "Check Out E-Item" link will be
1681 displayed when viewing an ebook title from a supported vendor in the
1682 catalog. Clicking on the link allows the user to check out and download
1683 that title from the vendor directly within the catalog.
1685 If no copies are available for the title, a "Place Hold on E-Item" link
1686 is displayed instead, and the user may place a hold on the title. (Note
1687 that some vendors require the user's account to have an email address
1688 before permitting a hold.)
1690 My Account includes the ability to view current ebook checkouts and
1691 holds, download already-checked-out titles, and cancel holds.
1693 For API integration to work, you need to request API access from the
1694 vendor, and the vendor must have a way of authenticating your patrons.
1695 Your Evergreen system also needs to be configured for ebook API
1696 integration, following the instructions in the command line system
1697 administration manual
1700 This feature assumes that you are importing MARC records supplied by the
1701 vendor into your Evergreen system, using Vandelay or some other MARC
1702 import method. This feature does not search the vendor's online
1703 collections or automatically import vendor records into your system; it
1704 merely augments records that are already in Evergreen.
1706 Improvements to Bill Payment Pages
1707 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1708 The bill payment pages in the public catalog have been revamped
1711 * use the term "charges" instead of "fees"
1712 * include images of credit cards accepted
1713 * make the default print receipt template match other itemized receipts;
1714 note that this change is not automatically applied when upgrading.
1715 * display billing type
1716 * add button to pay only selected charges
1717 * reformat the credit card number input page
1723 Clickable Copy Locations
1724 ^^^^^^^^^^^^^^^^^^^^^^^^
1725 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1726 the associated copy location will display as a link in the public catalog summary display.
1727 This link can be useful for retrieving maps or other directions to the copy
1728 location to aid users in finding material.
1733 Download Checkout History CSV Fixed for Large Number of Circulations
1734 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1735 Downloading checkout history as a CSV from My Account has been fixed
1736 for users with a large circulation history. Previously, this would
1737 time out for patrons with more than 100 or so circulations.
1739 This feature no longer uses the action/trigger mechanism and the public catalog
1740 now generates the CSV directly. The old action/trigger code is still
1741 present in the database and should be removed at some point in the
1747 Google Books Preview Rewrite
1748 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1749 The Google Books Preview functionality in record detail pages has been
1750 rewritten to modernize its style and optimize its performance:
1752 * The Dojo JavaScript framework is no longer used, saving approximately
1753 150K of JavaScript and CSS and four network requests per page load.
1754 * The Embedded Viewer is not loaded unless a possible preview is found,
1755 saving more network and memory overhead.
1756 * The Google Books Loader is used to load the Embedded Viewer instead of the
1757 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1759 * All variables are self-contained and do not pollute the global namespace.
1760 * Event listeners are registered to handle clicks, rather than attaching
1761 `href="javascript:function()"` to <a> elements.
1762 * Book previews are displayed in a panel sized according to the viewport
1763 of the browser, improving its appearance on both mobile and desktop
1765 * The rewritten code is now served up directly from
1766 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1771 jQuery for the Public Catalog
1772 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1773 This release adds optional support for jQuery in the public catalog. This support
1774 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1775 `config.tt2` template.
1781 New Popularity Parameters
1782 ^^^^^^^^^^^^^^^^^^^^^^^^^
1783 New popularity parameters for in-house use over time and for count of distinct
1784 organizational units that own a title are now available. Evergreen sites
1785 can use these parameters to create new statistical popularity badges for
1786 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1788 The in-house use parameters will apply a badge to titles that have the most
1789 in-house use activity over time. The organizational unit count parameter
1790 will apply a badge to titles owned by the most number of libraries in a
1791 consortium. Ownership is determined by the copy's circulation library.
1796 Option to Suspend Holds at the Time They are Placed
1797 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1798 Users now have the option to suspend a hold at the same time they place the
1799 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1800 who want to suspend a hold at the time it is placed. There is also an option
1801 to set the activation date at the same time. This option is also available
1802 when placing holds on a batch of titles from 'My List' and will apply to
1803 all the titles in the batch.
1814 Fix to reporter.classic_current_circ View
1815 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1816 The `reporter.classic_current_circ` view, which is part of some
1817 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1818 has been fixed to not exclude loans for patrons who do not have a
1819 billing address set. Users of this view should rerun
1820 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1825 New Report Source Table Allowing Report of "Last" Deleted copy
1826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1828 This source table allows you to construct a clever aggregate report template
1829 which will report bibliographic IDs where a library or a group of libraries
1830 no longer have a copy attached but *had* a copy attached. This is especially
1831 useful when a holdings sync is required with an external vendor.
1834 Instructions for creating a report template with this source:
1836 * Create a new report template using "Library Holdings Count with Deleted" as the source
1837 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1838 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1839 * 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"
1840 * Add "Bib ID" to Displayed Fields
1841 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1842 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1843 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1846 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1847 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1848 specified date range. Unfortunately the user will have to manually type the date range without the date
1849 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1850 copy and more than two deleted copies."
1855 Add Provider to Provider Note Link
1856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1857 The Provider reporting source now includes a link to the Provider Note reporting source.
1862 Link ILS User and Working Location Reporting Sources
1863 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1864 The Working Location reporting source now has labels
1865 and it is now linked to the ILS User reporting source, allowing
1866 reports to display or filter on staff working location.
1871 New Circulation Report Source "All Circulation Combined Types"
1872 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1874 This report source will allow you to create a single report template for all of the following:
1877 * In-house uses of non-cataloged items
1879 * Circulations of non-cataloged items
1881 To distinguish between these different types of library use, it's important to display these columns
1882 in your report templates:
1891 Reports Template Searching
1892 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1893 A new form appears along the top of the reports interface for searching
1894 report templates. Once found, typical template actions (e.g. create new
1895 report) are available from within the results interface.
1897 Searches may be performed across selected (visible) folders or all
1898 folders visible to the logged in user.
1900 Searches are case-insensitive, any word order, with left-anchored words.
1901 All searched words must appear in at least one of the searched fields.
1906 * Searching for 'stat cat' matches:
1908 ** statistical category
1909 ** categories, statistical
1910 ** patrons (stat cat)
1911 * Searching for 'stat cat' does not match:
1913 *** both words must be present in the searched field(s)
1915 *** location contains 'cat' but it's not left-anchored.
1920 The templates, reports, and output interfaces now support paging via
1921 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1933 Web Staff Client Serials Module
1934 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1935 The serials module has been ported over to the web staff
1936 client, implementing a unified serials interface that combines
1937 ideas from both the serial control view and alternate serials
1938 control view from the old staff client.
1940 In addition to carrying over functionality that was available
1941 in the old staff client, several new features are included:
1943 * the ability to save prediction pattern codes as templates
1944 that can be shared and reused within an Evergreen database
1945 * a more streamlined interface for managing subscriptions,
1946 distributions, and streams
1947 * it is no longer necessary to create a starting issue in
1948 order to predict a run of issues; the dialog box for
1949 generating a set of predicted issues now lets you specify
1950 the starting point directly.
1951 * the ability to more directly edit MFHDs
1953 The new serials interfaces can be accessed from the record
1954 details page via a Serials drop-down button that links to
1955 a subscription management page, a quick-receive action, and
1956 a MFHD management page. There is also a new 'Serials Administration'
1957 page where prediction pattern and serial copy templates can
1968 SIP Bugfix Changes How Encoding Is Determined in Configuration
1969 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1971 The combined fix for the above mentioned SIP bugs alters the way that
1972 SIPServer looks up the output encoding in the configuration file (typically
1973 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1976 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1977 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1978 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.
1979 4. If none of the above exist, then the default encoding (ASCII) is used.
1981 Number 3 is provided to ease the transition to the new code. It is
1982 the current location of the +encoding+ element in the sample
1983 configuration file and as such, where it is likely to be found in
1984 actual files. It is recommended that you alter your configuration to
1985 move this element out of the +implementation_config+ element and into
1986 its parent +institution+ element. Ideally, SIPServer should *not* look into
1987 the implementation config, and this check may be removed at some time
1995 Web Client Acknowledgments
1996 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1998 The project to develop a new browser-based web client launched four
1999 years ago at the September 2013 Evergreen developer hack-a-way when the
2000 developer community voted to move away from the XUL client and explore other
2001 platforms. The first web client preview became available in Evergreen 2.7 when
2002 circulation was available in the new platform.
2004 The browser-based client is available due to the work of many coders, testers,
2005 bug reporters, documentors, translators, project managers, spec writers, funders
2006 and other contributors over the past four years.
2008 The Evergreen project would like to acknowledge the following organizations
2009 that funded development of the Web Staff Client:
2012 * British Columbia Libraries Cooperative
2013 * Consortium of Ohio Libraries
2015 * Georgia Public Library Service
2016 * Grand Rapids Public Library
2018 * Kenton County Public Library
2019 * King County Library System
2022 * Pennsylvania Integrated Library System
2023 * Pioneer Library System
2026 The Evergreen project would also like to thank the following individuals who
2027 contributed code, translations, documentation patches, tests, bug reports,
2028 technical specifications, and project management to the Web Staff Client:
2065 * Freddy Enrique Pelayo Huapalla
2091 Evergreen 3.0 Acknowledgments
2092 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2094 The Evergreen project would like to acknowledge the following
2095 organizations that commissioned developments in this release of
2099 * British Columbia Libraries Cooperative (BC Sitka)
2101 * Georgia Public Library Service
2102 * King County Library System
2104 * Pennsylvania Integrated Library System
2105 * Pioneer Library System
2107 We would also like to thank the following individuals who contributed
2108 code, translations, documentation patches, and tests to this release of
2157 We also thank the following organizations whose employees contributed
2160 * British Columba Libraries Cooperative
2164 * Emerald Data Networks, Inc.
2165 * Equinox Open Library Initiative
2167 * Grand Rapids Public Library
2168 * Indiana State Library
2170 * King County Library System
2171 * Lake Agassiz Regional Library
2172 * Laurentian University
2173 * Linn-Benton Community College
2175 * Merrimack Valley Library Consortium
2177 * North of Boston Library Exchange
2178 * Pennsylvania Integrated Library System
2179 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2181 * Traverse Area District Library
2183 We regret any omissions. If a contributor has been inadvertently
2184 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob