1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.7.
10 * Fixes an issue that caused records with located URIs to be
11 retrieved in Copy Location and Copy Location Group searches.
12 * Fixes an error message that appeared in the search box
13 while placing hold after an advanced search.
14 * Fixes regression errors in the search results page.
15 * Removes redundant call numbers from the Show More Details
17 * Adds spaces between subfields when suggesting a call
18 number for a new volume.
19 * MarcXML exports from the MARC Batch Import/Export ->
20 Export Records screen now downloads the file, rather than opening
22 * Adds some padding to the bottom of Web Client interfaces.
23 * Fixes an issue that prevented users from searching for
24 receivable issues using Database ID or ISSN in the Serials
25 Batch Receive interface.
26 * The Item Status Circulation Library column now displays a
27 shortname rather than the full library name.
28 * The Item Status Remaining Renewals column now displays
30 * The Item Status now has a "Last Renewal Workstation" column
32 * Fixes the circulation counts displayed in Item Status Details.
33 * Staff members can now manually override the patron juvenile
34 flag value, regardless of the patron's date of birth.
35 * Checkboxes on patron registration screen are now properly aligned
37 * The user permission group dropdowns in the patron registration,
38 edit, and search interfaces now have scrollbars.
39 * The Merge Patrons interface now displays the date of birth.
40 * When a patron summary contains an image of the patron,
41 that image tag now has a null alt attribute to remove it from
42 the flow of a screen reader.
43 * The MARC editor now handles 008 fields better.
44 * Corrects an issue that caused the transit dialog showed the
46 * The cursor in the in-house use screen now automatically goes
48 * The novelist entry in `eg_vhost.conf` includes two new
50 * Corrects an issue with the `--max-sleep` argument on the
51 `action_trigger_runner.pl` support script.
52 * Corrects an issue with how the `eg_pbx_allocator.pl` script
53 detects an existing lock file.
54 * The 3.0.2-3.0.3 upgrade script disables triggers before
55 recalculating bib visibility.
59 We would like to thank the following individuals who contributed code,
60 tests and documentation patches to the 3.0.8 point release of
86 This release contains bug fixes improving on Evergreen 3.0.6.
88 * Fixes a performance issue with the Patron Billing History screen and
89 other screens that cause Flattener.pm to re-create joins
91 * Fixes an issue that prevented patron alerts from showing to staff at
93 * Corrects the "Holdable" attribute display on the Item Status detailed
95 * Fixes the ability to delete multiple copies from Item Status.
99 We would like to thank the following individuals who contributed code,
100 tests and documentation patches to the 3.0.7 point release of
114 This release is a security release that fixes cross-site scripting
115 (XSS) vulnerabilities in the Evergreen public catalog. This release
116 also includes several other bugfixes improving on Evergreen 3.0.5.
118 Security Issue: XSS Vulnerability in Public Catalog
119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120 This release fixes several cross-site scripting (XSS) vulnerabilities
121 in the public catalog. When upgrading, Evergreen administrators should
122 review whether any of the following templates have been customized
123 or overridden. If so, either the template should be replaced with the
124 stock version or the XSS fix (which entails adding the `| html` filter
125 in several places) applied to the customized version.
127 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
128 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
129 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
131 Note that exploiting the XSS vulnerabilities fixed in this release
132 would require either the ability to create maliciously-constructed
133 MARC bibliographic or holdings records or the ability to set a
134 maliciously constructed organizational unit name.
138 Evergreen 3.0.6 also includes the following changes:
140 * When using 'Selection Lists -> Edit MARC Order Record' in the web
141 staff client, now only one click is required to save the MARC
142 record rather than two.
143 * The volume/copy editor in the web staff client now better handles
144 editing multiple items that have different sets of statistical
145 category values assigned to them.
146 * The act of merging bibliographic records now updates bookbags
147 that referred to the source bibliographic record rather than
148 effectively deleting entries for that record.
149 * Additional columns were added to the Holds Pull List in the
151 * The patron registration form in the web staff client now correctly
152 manages setting user preferences.
153 * An error in a pgTAP unit test was corrected.
157 We would like to thank the following individuals who contributed code,
158 tests and documentation patches to the 3.0.6 security release of
174 This release contains bug fixes improving on Evergreen 3.0.4.
176 * The MARC Editor in the Web staff client now wraps long fields.
177 * The MARC Editor no longer allows catalogers to enter new lines
179 * Fixes an issue that prevented serials items from being deleted or
181 * The Web staff client Check In screen no longer reloads the whole
182 page multiple times each time an item is scanned.
183 * Fixes an issue that displayed the oldest -- rather than the newest
184 -- transit in the Web staff client Item Status page.
185 * Fixes an issue that prevented the reports module from being displayed
187 * Fixes an issue in the Web staff client reports module that caused
188 syntax errors in reports that use virtual fields and joins.
189 * Fixes an issue that prevented several dropdown menus in the Web staff
190 client from activating.
191 * Fixes an issue that created duplicate copy data when copies or
192 volumes with parts were transferred.
193 * Fixes the Trim List feature in the Web staff client Check In screen.
194 * The Item Status grid now displays the Circulation Modifier.
195 * Restores missing data from the Profile column in Place Hold patron
197 * Fixes an issue with the http -> https redirect on Apache 2.4.
198 * Fixes an color contrast accessibility issue in the Web staff
199 client and adds underlining to links in grid cells for added accessibility.
200 * Adds automated regression and unit tests for the Web staff client
202 * Adds a process for spell-checking the official documentation.
203 * Adds a script that simplifies the release process related to translations.
208 We would like to thank the following individuals who contributed code,
209 tests and documentation patches to the 3.0.5 point release of
214 * Blake Graham-Henderson
229 This release contains bug fixes improving on Evergreen 3.0.3:
231 * Fixes a bug that caused all searches limited by shelving location to
233 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
234 rather than the ordering agency's SAN.
235 * Fixes a bug that prevented Safari/iOS users from logging in to the
237 * Fixes a bug that prevented users from using the browse interface.
238 * Fixes a bug in the Item Status List view that caused incorrect due
240 * Approval code is now a required field in the web client's patron
241 credit card payment form.
242 * Fixes a bug with credit card payments that caused a receipt to print
243 showing that the patron paid the bill when the payment had not actually
245 * Fixes a bug that prevented the EDI translator from being installed on
247 * Fixes a bug that caused entries to show up multiple times in the
248 Items Out and Holds tabs in the patron record.
249 * Fixes a bug that caused grids on Bills and Patron Messages
250 screens to not display properly.
251 * The following fields are now available for the Checkout and Items Out
258 ** money_summary.balance_owed
259 ** money_summary.total_paid
260 ** money_summary.total_owed
265 * The following fields are now available on the Bill Payment receipt templates:
275 * Payment type is now a column in the payments tab of the patron record
276 Bill History section.
277 * The "Replace Barcode" function now makes it more difficult for staff
278 members to attempt to create blank patron barcodes.
279 * The patron bills screen now prevents staff members from double-clicking
280 on the Apply Payment button (which otherwise would apply two payments).
281 * Fixes a bug that prevented patrons attached to statistical categories
282 from displaying in the patron search-to-hold dialog.
283 * Fixes a performance issue related to uploading CSV files of barcodes
284 to the item status and patron bucket interfaces.
285 * Fixes several small bugs in the Spanish translation.
286 * Fixes a performance bug related to patrons logging in by barcode.
290 We would like to thank the following individuals who contributed code,
291 tests and documentation patches to the 3.0.4 point release of
313 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
314 update the visibility attributes of all bibs that make use of Located URIs or
315 bib sources. It may take a while to run on large datasets. If it it running
316 too long, it can be canceled and the following psql commands will create and
317 run a script that will perform the same action serially over time without
318 blocking writes to bibs:
321 \o /tmp/luri_visibility_update.sql
322 SELECT 'UPDATE biblio.record_entry SET ' ||
323 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
324 'WHERE id = ' || id || '; SELECT ' || id || ';'
325 FROM biblio.record_entry
327 SELECT DISTINCT cn.record
328 FROM asset.call_number cn
330 AND cn.label = '##URI##'
333 FROM asset.uri_call_number_map m
334 WHERE m.call_number = cn.id
337 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
342 \i /tmp/luri_visibility_update.sql
345 It will output the id of each updated bib so that the script can be killed
346 and then edited to remove completed bibs. The remainder can be run at a
349 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
350 we do NOT update the bib's visibility attributes, as doing so causes a loop
351 and an eventual trigger stack violation. This flag should ONLY be used when
352 forcing reingest of record attributes (NOT visibility attributes), search,
353 facet, and display fields, so if using this flag under normal operation,
354 proceed at your own risk and know that Located URI and bib source changes
355 will not be reflected in the visibility attributes of the record.
359 This release contains several bug fixes improving on Evergreen 3.0.1:
361 * Fixes several issues related to the display of located URIs and records with
362 bib sources in search results.
363 * Setting `opac_visible` to false for a copy location group now hides only
364 the location group itself, rather than also hiding every single copy in the
366 * Fixes a bug that prevented the copy editor from displaying the _fine level_
367 and _loan duration_ fields.
368 * The "Edit Items" grid action in the Item Status interface will now open
369 in the combined volume/copy editor in batch. This makes the behavior
370 consistent with the "Edit Selected Items" grid action in the copy
372 * Staff members are now required to choose a billing type when creating a
373 bill on a user account.
374 * The Web client now provides staff users with an alert and option to
375 override when an item with the Lost and Paid status is checked in.
376 * Fixes a bug where the Web client offline circ interface was not able
377 to set its working location.
378 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
380 * The MARC editor in the Web staff client now presents bib sources in
382 * Both circulation and grocery bills are now printed when a staff user selects
383 a patron account and clicks "Print Bills".
384 * Fixes an issue in the XUL serials interface the "Receive move/selected"
385 action from succeeding.
386 * Fixes a typo in the user password testing interface.
390 We would like to thank the following individuals who contributed code,
391 tests and documentation patches to the 3.0.3 point release of
410 This release contains several bug fixes improving on Evergreen 3.0.1:
412 * Copy templates created in XUL Holdings Maintenance will now be
413 automatically converted and displayed in the web staff client's
415 * The list of report templates now includes a column indicating whether
416 the template was originally created in the XUL staff client or the web
417 staff client; staff need to know this since report templates created in
418 one interface cannot be edited in the other.
419 * Call number prefixes and suffixes are now displayed in various grids
420 in the web staff client, including
421 ** Pending Copy Buckets
423 ** Checkin/Capture Holds
425 ** Patron Bills History
432 ** Bib Record View Holds
434 * Many patron fields have been redacted from the web staff client's patron
435 and record holds grids, leaving patron name, username, and ID.
436 * Fixes two bugs where patron records could fail to be saved upon editing.
437 * The web staff patron editor now better warns staff users about
438 duplicate names, IDs, phone numbers, and email addresses.
439 * Human readable labels are now displayed for certain fields in standing
441 * The patron summary in the web staff client now correctly displays
442 primary and secondary ID values.
443 * The web staff client's billing full details page now displays
444 information about the staff user that created a payment.
445 * The web staff client now requires staff users to explicitly set a
446 billing type when adding a manual bill.
447 * The web staff client's patron bill annotation modal now works.
448 * Patron barcode search completion in the web staff client now allows
449 the user to select from all of the matching patron records.
450 * The Hold Shelf Slip print template in the web staff client now has
451 access to the call number.
452 * The Checkout Receipt print template in the web staff client now can
453 include summary financial information, incuding current balance, total
454 paid on outstanding fines, and total owed.
455 * The web staff print templates for current and historical bills can
456 now include copy barcode and title.
457 * Fixes a bug that resulted in some catalog searches unexpectedly
459 * Fixes a bug that resulted in catalog searches that specify a location
460 limit returning incorrect results.
461 * Fixes a bug where deleted copies could make records visible in the
463 * Fixes a bug where certain queries on copies used in the public catalog
465 * Fixes a bug place a hold request in the public catalog could result
466 in "forgetting" the type and library of the user's previous search.
467 * The web staff client now respects staff user session timeouts, and
468 will log out all open tabs if a user's session has timed out.
469 * The web staff Z39.50 page will now give the staff user an alert if
470 they attempt to import a record with a duplicate TCN.
471 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
472 entries from being deleted.
473 * Fixes a bug that made using the volume/copy editor to change a copy's
475 * The administration interface for hard due dates now ensures that
476 new (or edited) ceiling dates have their time component set to end
477 of day, resolving an issue where ceiling dates would not be applied
478 during the ceiling date itself.
479 * The web staff client can now include dynamic information in browser
480 tab titles, e.g., "Smith, Jane - Checkout".
481 * The Concerto sample data set now includes data allowing for testing
482 placing holds on monographic parts.
483 * Asset merging during bibliographic record merging now correctly
484 recognizes call number prefixes and suffixes and deletes disused
486 * Fixes a bug where displaying user surveys could result in PCRUD
488 * Fixes a bug where pg_restore of an Evergreen database could fail
489 to create certain indexes on the `actor.usr` table.
493 We would like to thank the following individuals who contributed code,
494 tests and documentation patches to the 3.0.2 point release of
525 This release contains several bug fixes improving on Evergreen 3.0.0
527 * Fixes a bug in the web staff client that prevented initials from being
528 stored with copy notes.
529 * Adds billing types that may have been missed by systems that were
530 running Evergreen prior to the 1.4 release.
531 * Fixes a web staff client bug with the CSV export option available from
532 the Import Queue in the MARC Batch Import/Export interface.
533 * Adds the missing copy alert field in the web client's volume/copy
535 * Fixes a bug where the setting to require date of birth in patron
536 registration was not being honored in the web staff client.
537 * Fixes a bug in the web staff client patron registration form where the
538 password wasn't generating from the last four digits of the patron's
540 * Fixes an issue in the web staff client where the complete barcode did
541 not display in some interfaces when partial barcodes were scanned.
542 * Fixes an HTML error in the new copy tags that display on the record
544 * Fixes a web staff client bug where recording a large number of in-house
545 uses at one time doesn't display a confirmation dialog once it hits the
547 * Adds a _Print Full Grid_ action in the web staff client
548 holds pull list to allow staff to print the entire pull list as it
549 displays on the screen. This change also changes the _Export CSV_ action
550 to an _Export Full CSV_ option.
551 * Fixes an issue with the Patron Messages interface that prevented it
552 from saving column configuration changes in the web staff client.
553 * Fixes a bug in the web staff client where a billing prompt did not
554 correctly display after marking an item damaged in those systems that
555 have enabled the setting to bill for damaged items.
556 * Adds an option to the specific due date feature that allows saving
557 that due date until logout. This allows all circulations from a given
558 workstation to be due on the same date.
562 We would like to thank the following individuals who contributed code,
563 tests and documentation patches to the 3.0.1 point release of
585 The minimum version of PostgreSQL required to run Evergreen 3.0 is
586 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
588 Change to Names of Shared Libraries
589 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
590 OpenSRF 3.0 changes how the shared libraries for services written in
591 C are named. If upgrading from an earlier version of Evergreen,
592 `opensrf.xml` should be edited so that shared library file names
593 listed in the `<implementation>` tag start with "lib". For example,
596 ---------------------------------------------------------------------
598 <language>C</language>
599 <implementation>oils_cstore.so</implementation>
600 ---------------------------------------------------------------------
602 should be changed to:
605 ---------------------------------------------------------------------
607 <language>C</language>
608 <implementation>liboils_cstore.so</implementation>
609 ---------------------------------------------------------------------
611 SIP Bugfix Requires SIPServer Upgrade
612 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
614 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
615 crash" requires that you also upgrade SIPServer with the fix for
616 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
617 SIP client problems." This means that if you use SIP2 with Evergreen,
618 you must also upgrade SIPServer to the latest commit in the Git
619 repository. Conversely, if you upgrade SIPServer to the latest commit
620 in Git, you must also upgrade Evergreen or, at least, apply the patch
621 for Launchpad Bug 1542495. These two patches are complementary and
622 cannot be applied independently of one another.
624 `open-ils.auth.login`
625 ~~~~~~~~~~~~~~~~~~~~~
626 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
627 API's in the `opensrf_core.xml` file.
632 ---------------------------------------------------------------------
633 --- a/Open-ILS/examples/opensrf_core.xml.example
634 +++ b/Open-ILS/examples/opensrf_core.xml.example
635 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
637 <match_string>open-ils.auth.authenticate.verify</match_string>
638 <match_string>open-ils.auth.authenticate.complete</match_string>
639 + <match_string>open-ils.auth.login</match_string>
640 <match_string>open-ils.auth_proxy.login</match_string>
641 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
642 <match_string>open-ils.actor.user.password</match_string>
643 ---------------------------------------------------------------------
647 Administrators of Evergreen who use RTL locales and who have customized
648 `style-rtl.css.tt2` should now incorporate their customizations into
651 Multi-Time Zone Installations
652 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
654 For Evergreen consortia that span more than one time zone, the following
655 query will adjust all historical, unaged circulations so
656 that if their due date field is pushed to the end of the day, it is done
657 in the circulating library's time zone, and not the server time zone.
659 It is safe to run this after any change to library time zones.
661 Running this is not required, as no code before this change has
662 depended on the time string of '23:59:59'. It is also not necessary
663 if all of your libraries are in the same time zone, and that time zone
664 is the same as the database's configured time zone.
673 for ou_id in select id from actor.org_unit loop
674 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
675 if new_tz is not null then
676 update action.circulation
677 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
678 where circ_lib = ou_id
679 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
688 Deprecation of XUL staff client
689 -------------------------------
690 Starting with the release of 3.0.0, patches that fix XUL bugs will not
691 be merged into master or backported unless they meet one or more of
692 the following conditions:
694 a. the bug is a security issue
695 b. the bug involves the destruction of data
696 c. the bug is a regression of functionality in the XUL staff client
697 introduced by other work done to Evergreen
699 Under no circumstances will XUL staff client feature enhancements be merged.
701 This policy will continue through the 3.0.x and 3.1.x maintenance
702 release cycles, and will become moot upon the release of 3.2.0, when
703 the XUL staff client is slated to be entirely removed.
712 Evergreen 3.0 features a new, modern staff client that runs in the web browser
713 and can be used on desktop and mobile devices. All functional areas of the
714 system, including circulation, cataloging, acquisitions, serials, reports,
715 booking, administration, and offline circulation, are available in the new staff
716 client. Chrome and Firefox are officially supported for use with the web client.
718 Library staff will no longer need to download separate software to perform most
719 actions in Evergreen. A Chrome plugin called Hatch will be available as a
720 separate installation for workstations that require seamless, dialog-free
721 printing to multiple printers.
723 In addition to adding more portability and stability, the new staff client also
724 presents a cleaner and more modern interface for users. By virtue of running in
725 a browser, actions that users are accustomed to performing on other web sites
726 should now be available in the Evergreen client.
728 The old, XUL client will continue to be available to allow for a gradual
729 transition to the browser-based client, but no new features will be added. The
730 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
740 New EDI Order Generator
741 ^^^^^^^^^^^^^^^^^^^^^^^
746 . New database tables exist for configuring vendor-specific EDI order
750 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
753 ** Collection of `edi_attr`s. Each edi_account may be linked to one
755 ** One `edi_attr_set` per known vendor is added to the stock data, matching
756 the stock configuration found in the JEDI template.
757 * `acq.edi_attr_set_map`
758 ** Link between `edi_attr`s and `edi_attr_set`s.
760 . EDI Attribute Sets are manged via a new (browser client only) configuration
761 interface at 'Administration -> Acquisitions Administration -> EDI
764 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
765 is not set, default values will be used. Links between an EDI account
766 and an attribute set are managed in the EDI Accounts configuration
769 . Local modifications to the stock EG JEDI template are managed by modifying
770 and/or adding additional `edi_att_set`s as needed.
772 . A new `edi_order_pusher.pl` script is added which replaces the functionality
773 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
775 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
776 definition is no longer required and can be disabled.
781 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
782 specifies whether PO's generated via the account should be built using
783 EDI attributes or fall back to traditional JEDI A/T template generation.
785 This allows sites to activate EDI attributes on a per-account basis, making
786 it possible to migrate piecemeal to EDI attributes. For the initial roll
787 out of this new feature, no accounts will be configured to use EDI
788 attributes by default.
794 3 Day Courtesy Notice by SMS
795 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
796 New optional SMS text notification to be sent out 3 days prior to the due
797 date of any circulating item for patrons who have an SMS text number and
798 carrier stored in their accounts. This action trigger is disabled by default,
799 but can be enabled and modified by going into 'Administration -> Local Administration ->
800 Notifications / Action Triggers'.
802 You may wish to make use of granularity so that these messages are batched
803 and sent at the same time each day.
808 Add Description Field to Circulation and Hold Configuration Entries
809 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
810 The circulation and hold policy configuration rules now each have a
811 description field. This allows administrators to add comments to
812 describe the purpose of each rule.
817 Apache Internal Port Configuration Option
818 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
819 Apache configuration now supports a new variable which allows admins to
820 specify the port used by Apache to handle HTTP traffic. The value is
821 used for HTTP requests routed from Perl handlers back to the same Apache
822 instance, like added content requests. Use this when running Apache
823 with a non-standard port, typical with a proxy setup. Defaults to "80".
826 -------------------------------------------------------------------
829 PerlSetVar OILSWebInternalHTTPPort "7080"
832 -------------------------------------------------------------------
837 Configurable Bib Record Display Fields
838 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
840 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
841 fields: 'Display Field?' and 'Display XPath'.
843 When 'Display Field' is set to true, data from the field will be extracted
844 from each record and added to a new table of display data for each bib
847 If a value is present in the 'Display XPath' field, this XPath will be
848 applied to the extracted data *after* the base XPath (from the 'XPath'
849 field) is applied to each field.
851 This data acts as a replacement for the various and sundry ways bib record
852 data is currently extracted, including inline XPath in the TPAC, reporter
853 views, real-time 'MVR' compilation from MODS, etc. and will be available
854 to the user interface, notification templates, etc. for rendering bib
857 The browser client gets a new service 'egBibDisplay' which is capable
858 of translating the display field data from various formats into
859 data more suitable for JavaScript usage.
861 The database gets 3 new views for representing display data in various
864 * `metabib.flat_display_entry`
865 ** List of all display fields linked to their configuration.
866 * `metabib.compressed_display_entry`
867 ** Same as `metabib.flat_display_entry` except there's one row
868 per display field type, with 'multi' rows compressed into
869 JSON arrays. Non-multi fields are represented as JSON
871 * `metabib.wide_display_entry`
872 ** Tabular view of display field data, one column per well-known
873 field. Values are represented JSON, consistent with
874 `metabib.flat_display_entry`. The view does *not* contain locally
875 configured display fields, as each field must be encoded in
876 the view and IDL definition. This is essentially a replacement
877 for `reporter.simple_record`.
882 After making changes to display field configuration, it's possible to
883 reingest only display field data in the database using the following:
886 ---------------------------------------------------------------------
887 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
888 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
889 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
890 ---------------------------------------------------------------------
896 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
897 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
898 The existing permission was incorrectly created with a code of
899 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
900 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
901 update changes the permission code to match what the event requires.
907 Hold Targeter V2 Repairs and Improvements
908 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
909 * Make the batch targeter more resilient to a single-hold failure.
910 * Additional batch targeter info logging.
911 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
912 * Removes the confusingly named `--target-all` option
913 ** The same behavior can be achieved by using `--retarget-interval "0s"`
914 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
916 New --next-check-interval Option
917 ++++++++++++++++++++++++++++++++
918 Specify how long after the current run time the targeter will retarget
919 the currently affected holds. Applying a specific interval is useful
920 when the retarget-interval is shorter than the time between targeter
923 For example, if the targeter is run nightly at midnight with a
924 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
925 since the holds won't be processed again until 48 hours later. This
926 ensures that the org unit closed date checks are looking at the correct
929 This setting overrides the default behavior of calculating the next
930 retarget time from the retarget-interval.
932 New --soft-retarget-interval Option
933 +++++++++++++++++++++++++++++++++++
934 This is a replacement for (and rebranding of) the `--skip-viable` option.
935 The new option allows for time-based soft-targeting instead simple binary
936 on/off soft-targeting.
938 How soft-targeting works:
940 * Update hold copy maps for all affected holds
941 * Holds with viable targets (on the pull list) are otherwise left alone.
942 * Holds without viable targets are retargeted in the usual manner.
948 New marc_export --descendants Option
949 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
951 The `marc_export` script has a new option, `--descendants`. This option
952 takes one argument of an organizational unit shortname. It works much
953 like the existing `--library` option except that it is aware of the
954 org. tree and will export records with holdings at the specified
955 organizational unit and all of its descendants. This is handy if you
956 want to export the records for all of the branches of a system. You
957 can do that by specifying this option and the system's shortname,
958 instead of specifying multiple `--library` options for each branch.
960 The `--descendants` option can be repeated, as the `--library` option can.
961 All of the specified org. units and their descendants will be included
962 in the output. It can also be combined with individual `--library`
963 options when necessary.
968 RTL and LTR Public Catalog Stylesheets Merged
969 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
970 The RTL stylesheet for the public catalog,
971 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
972 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
973 template will provide RTL or LTR styles based on the value of
974 the `rtl` flag of the active locale. An `rtl` variable is also available
975 in the template to allow the correct style to be chosen.
980 Miscellaneous Improvements
981 ^^^^^^^^^^^^^^^^^^^^^^^^^^
983 * If a filter is in effect in the Library Settings Editor,
984 the filter will continue to be applied after a user
985 changes the selected library.
986 * Copy templates used for serials now correctly link to age
987 protection rules and MARC item type values (for the
988 "Circ as Type" field). During upgrade, the database update
989 will set to NULL any age protection and circ as type fields
990 in serial copy templates that do not point to defined values.
995 Obsolete Internal Flag Removed
996 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
998 An obsolete and unused `ingest.disable_metabib_field_entry` internal
999 flag was removed from the `config.internal_flags` table. It was
1000 rendered obsolete by the addition of the 3 flags to control the
1001 browse, search, and facet indexing.
1006 Tweaks to Caching/Expiry of Public Catalog Assets
1007 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1008 The default cache expiration time for static assets (e.g.,
1009 CSS, image, and JavaScript files) in the public catalog and
1010 the Kid's PAC has been increased to one year. Links to all
1011 such assets now have a cache-busting value tacked on as a
1012 query parameter. This value is refreshed when `autogen.sh` is
1013 run, but it can also be manually set by adjusting the
1014 `ctx.cache_key` Template Toolkit variable.
1019 Action/Trigger Events Data Purging
1020 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1022 Action/Trigger event definitions have a new field called 'Retention
1023 Interval'. When an optional interval value is applied, events and
1024 template output data linked to the event definition will be deleted
1025 from the database once they reach the specified age.
1027 Retention Interval Restrictions for Passive Hooks
1028 +++++++++++++++++++++++++++++++++++++++++++++++++
1030 Restrictions are placed on retention interval values for event definitions
1031 using passive hooks to prevent data from being deleted while it's still
1032 needed by the system.
1034 The presence of event data is how the system knows not to send duplicate
1035 events. As long as a scenario exists where a duplicate event may be
1036 generated, the events must be retained.
1038 To apply a retention interval value to a passive-hook event definition:
1040 * The event definition must have a max_delay value.
1041 * The retention interval must be larger than the difference between
1042 the `delay` and `max_delay` values.
1044 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1045 interval must be greater than 3 days to ensure no duplicate events are
1046 created between the first event on day 7 and the end of the event validity
1052 A new `purge_at_events.sh` script is installed in the bin directory
1053 (typically `/openils/bin`) which should be added to CRON for regular
1056 NOTE: On large data sets, this script can take a long time to run and
1057 create higher than normal I/O load as it churns though the event and
1058 event_output tables. You may wish to run the script by hand the first
1059 time so it can be monitored. It can be run in psql like so:
1062 ---------------------------------------------------------------
1063 SELECT action_trigger.purge_events();
1064 ---------------------------------------------------------------
1066 NOTE: On *very* large data sets (10s to 100s of millions of event and
1067 event_output rows), it may be advisable to first repopulate the `event`
1068 and `event_output` tables with only the desired data before starting
1069 regular purges. This can be done, for example, using the copy to temp
1070 table, truncate source table, repopulate source table from temp table
1071 approach. This will be much faster than the `purge_events()` function
1072 in cases where most of the data will be purged.
1077 A number of `action_trigger.hook` entries which have always been treated
1078 as active hooks, though are configured as passive hooks, have been
1079 updated to properly reflect the non-passive-ness. This allows for
1080 simpler configuration of their retention interval values.
1086 Remove JSPAC Redirects
1087 ^^^^^^^^^^^^^^^^^^^^^^
1088 Future versions of Evergreen will no longer contain automatic redirects
1089 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1090 that the JSPAC is no longer supported. Existing sites, however, may
1091 wish to retain JSPAC redirects in their Apache configuration files since
1092 JSPAC URLs may still be used in the wild to access their catalogs.
1094 The original JSPAC URL redirects are all retained in the file
1095 `Open-ILS/examples/jspac_redirects.conf` for reference.
1105 New open-ils.auth.login API
1106 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1107 The `open-ils.auth` service has a new API for requesting an authentication
1108 token. It performs the same steps as the
1109 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1110 using the bare password. No intermediate password hashing is required.
1112 The paramaters are the same as the `.complete` call with a few modifications.
1114 1. Using the generic 'identifier' parameter in combination with the
1115 'org' parameter allows the API to reliably determine if an identifier
1116 value is a username or barcode. The caller is no longer required to
1117 make that determination up front.
1119 2. The 'nonce' parameter is no longer used.
1125 Batch Patron Contact Invalidation
1126 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1127 The following methods are used to mark patron contact fields
1128 as invalid by moving the invalid value to a standing penalty:
1130 * `open-ils.actor.invalidate.email`
1131 * `open-ils.actor.invalidate.day_phone`
1132 * `open-ils.actor.invalidate.evening_phone`
1133 * `open-ils.actor.invalidate.other_phone`
1135 These methods now accept a fifth argument specifying the value
1136 of the contact field, e.g., a specific phone number or email
1137 address. If supplied, and if a specific patron ID (the first
1138 argument) is not supplied, all patrons with that specific contact
1139 value will have it marked invalid.
1149 Pure-SQL catalog searching
1150 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1151 Public and staff catalog search is now both more accurate and faster
1152 by redesigning how the visibility of records is calculated.
1162 Authority Record and Headings Browse Improvements
1163 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1164 Various improvements are made to support for authority records
1165 and headings browsing:
1167 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1168 headings from authority records. Since the MODS and MADS stylesheets
1169 extract headings in similar ways, duplicate browse entries are now
1170 much less likely to occur.
1171 * A new configuration table, `authority.heading_field`, is now used
1172 to specify how headings should be extracted from authority records.
1173 * Related headings can now be identified as narrower or broader when
1174 browsing in the public catalog.
1175 * See references are now more reliably included in the browse list.
1176 * Scope (public) notes now display only under the main heading.
1177 * There is now a global flag, Display related headings (see-also) in browse,
1178 that can be used to control whether related headings (see-alsos) are
1179 displayed in the public catalog list.
1180 * A complete set of thesauruses are now included in the seed data. Thesauruses
1181 can now be identified using short and long codes.
1182 * The labels for see and see-also references in the public catalog are
1183 a bit more patron-friendly, and can now be tweaked via TPAC template
1184 customization in the browse.tt2 file.
1190 Copy Tags and Digital Bookplates
1191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1192 Copy tags will allow staff to apply custom, pre-defined labels or tags
1193 to copies. Copy tags are searchable in both the staff client and public
1194 catalog. This feature was designed to be used for Digital Bookplates to
1195 attach donation or memorial information to copies, but may be used for
1196 broader purposes to tag items.
1198 Each copy tag can either be publicly-visible or visible only to staff.
1199 Copy tags also have types that can be used for restricting catalog
1200 searches on copy tags to particular types.
1202 Copy tags are displayed in the copy table in the record summary page in
1203 the public catalog, and a new library setting can be used to add
1204 a "Digital Bookplate" search field. Copy tags can also be used
1205 as a search filter, e.g.,
1207 * `copy_tag(bookplate, jane smith)`: search for records that have a
1208 copy tag of type 'bookplate' whose value contains 'jane smith'.
1209 * `copy_tag(*, jane smith)`: search for records that have a
1210 copy tag of any type whose value contains 'jane smith'.
1212 All staff-side interfaces related to copy tags exist only in the web
1213 staff client. There are two new administration interfaces for managing
1214 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1215 button for applying copy tags to copies; that interface can also be
1216 used to create new copy tags on the fly. Furthermore, the copy buckets
1217 interface now has an 'Apply Tags' action for assigning tags to groups
1223 Two new permission are included:
1225 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1226 'Administration -> Server Administration -> Copy Tag Types'
1227 * `ADMIN_COPY_TAG`: required to create a new tag under
1228 'Administration -> Local Administration -> Copy Tags'
1230 The existing permission `UPDATE_COPY` controls whether or not a user
1231 can link copies to tags.
1235 A new library setting, 'Enable Digital Bookplate Search', controls
1236 whether to display a 'Digital Bookplate' field in the search index
1237 drop-downs in the catalog. A 'Digital Bookplate' search will include
1238 all records that have a copy that matches the tag specified by the user.
1239 It should be noted that this library setting does not affect the
1240 display of copy tags on the catalog record summary page.
1245 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1246 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1247 The call number prefix and suffix, when present, are now included in
1248 subfields $k and $m of the 852 field when running `marc_export` with
1249 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1250 server configured to embed item data in 852 fields, the affixes are now
1251 included in subfields $k and $m.
1261 Batch Editing of Patron Records
1262 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1263 There is a now a new interface analogous to the Copy Bucket interface
1264 to select and group a set of users into a User Bucket.
1265 The addition of users to a User Bucket is possible from the Patron Search
1266 interface by the use of a new grid Action, and directly on the User Bucket
1267 interface by user barcode. It is also possible to add users to a User
1268 Bucket by uploading a text file that contains a list of user barcodes.
1270 From this interface it is possible to perform a set of specific batch update
1271 operations on user records.
1276 These fields can now be changed in batch via an action on the User Bucket
1277 grid if the staff user has the `UPDATE_USER` permission:
1280 * Primary Permission Group (group application permissions consulted)
1282 * Home Library (`UPDATE_USER` checked against both old and new value)
1283 * Privilege Expiration Date
1284 * Barred flag (`BAR_PATRON` permission consulted)
1285 * Internet Access Level
1287 Changes made in this interface can be rolled back.
1289 As a batch process, rather than a direct edit, this mechanism explicitly skips
1290 processing of Action/Trigger event definitions for user update.
1295 The batch edit mechanism also allows for the batch deletion of user. The staff
1296 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1298 Changes made in this interface can be rolled back.
1300 As a batch process, rather than a direct edit, this mechanism explicitly skips
1301 processing of Action/Trigger event definitions for user deletion.
1303 This mechanism does not use the Purge User functionality, but instead simply
1304 marks the users as deleted.
1306 Editing Statistical Category Entries
1307 ++++++++++++++++++++++++++++++++++++
1309 All users in the bucket can have their Statistical Category Entries
1310 modified. Unlike user data field updates, modification of Statistical
1311 Category Entries is permanent and cannot be rolled back.
1313 As a batch process, rather than a direct edit, this mechanism explicitly skips
1314 processing of Action/Trigger event definitions for user update.
1316 New Service Requirement
1317 +++++++++++++++++++++++
1319 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1320 unused in production. If this service has been removed from the configuration
1321 of a live Evergreen instances, it will need to be added back in order for
1322 batch user editing to succeed.
1327 Honor Timezone of the Acting Library
1328 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1333 * Display day-granular due dates in the circulating library's timezone.
1334 * Only display the date portion of the due date for day-granular circulations.
1335 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1336 * Provide infrastructure for more advanced formatting of timestamps.
1337 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1342 This is a followup to the work done for 2.12, where we added the ability
1343 for the client to specify a timezone in which timestamps should be interpreted
1344 in business logic and the database.
1346 Most specifically, this work focuses on circulation due dates and the closed
1347 date editor. Due dates, where displayed using stock templates (including
1348 receipt templates) and used for fine calculation, are now manipulated in the
1349 library's configured timezone. This is controlled by the new 'lib.timezone'
1350 setting available via the Library Settings Editor, loaded from the server when
1351 required. Additionally, closings are recorded in the library's timezone so that
1352 due date calculation is more accurate. The closed date editor is also
1353 taught how to display closings in the
1354 closed library's timezone. Closed date entries also explicitly record if they
1355 are a full day closing, or a multi-day closing. This significantly simplifies
1356 the editor, and may be useful in other contexts.
1358 To accomplish this, we use the moment.js library and the moment-timezone addon.
1359 This is necessary because the stock AngularJS date filter does not understand
1360 locale-aware timezone values, which are required to support DST. A simple
1361 mapper translates the differences in format values from AngularJS date to
1364 Of special note are a set of new filters used for formatting timestamps under
1365 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1366 filters provide the functionality, and autogrid is enhanced to make use of
1367 these where applicable. egGrid and egGridField are also taught to accept
1368 default and field-specific options for applying date filters. These filters may
1369 be useful in other or related contexts.
1371 The egDueDate filter, used for all existing displays of due date via Angular
1372 code, intentionally interprets timestamps in two different ways WRT timezone,
1373 based on the circulation duration. If the duration is day-granular (that is,
1374 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1375 of seconds) then the date is interpreted as being in the circulation library's
1376 timezone. If it is an hourly loan (any duration that does not meet the
1377 day-granular criterium) then it is instead displayed in the client's timezone,
1378 just as all other timestamps currently are, because of the previous Evergreen
1381 The public catalog is adjusted to always display the due date in the circulating
1382 library's timezone. Because the public catalog displays only the date portion of the due
1383 date field, this difference is currently considered acceptable. If this proves
1384 to be a problem in the future, a minor adjustment can be made to match the
1385 egDueDate filter logic.
1387 Now that due dates are globally stored in the configured timezone of the
1388 circulating library, the automatic adjustment to day-granular due dates needs
1389 to take those timezones into account.
1391 An optional SQL command is provided by the upgrade script to retroactively
1392 adjust existing due dates after library configuration is complete.
1398 Enhancements to Hard Due Date Functionality
1399 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1400 It will now be possible to delete Hard Due Date Values for dates that have
1401 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1402 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1403 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1408 Patron Search by Birth Date
1409 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1410 * Now you can include the patron birth year and/or birth month and/or
1411 birth day when searching for patrons using the web staff client.
1412 * Day and month values are exact matches. E.g. month "1" (or "01")
1413 matches January, "12" matches December.
1414 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1415 1915, 1599, etc. For exact matches use the full 4-digit year.
1419 Patron Search from Place Hold
1420 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1421 This feature allows staff members, when placing a
1422 hold on behalf of a patron in the web staff client, to search for
1423 patrons by names and other searchable patron information, rather than
1424 relying on barcode alone. In particular, after performing a catalog
1425 search or going to a specific bib record and clicking the 'Place Hold'
1426 button, the form now includes a 'Patron Search' button. This button
1427 will open a dialog allowing the staff member search for and select
1433 Retrieve Recent Patrons
1434 ^^^^^^^^^^^^^^^^^^^^^^^
1436 Adds a new library setting 'Number of Retrievable Recent Patrons'
1437 ('ui.staff.max_recent_patrons') that specifies the number of recently
1438 retrieved patrons that can be re-fetched from the staff client.
1440 A value of 0 means no recent patrons can be retrieved.
1441 A value greater than 1 means staff will be able to retrieve multiple
1442 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1444 The default value is 1 for backwards compatibility.
1451 Fuller title in XUL client Simplified Pull List
1452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1453 The Simplified Pull List in the XUL client will now display subfields 245$n and
1454 $p in the title field. The addition will make it easier for staff to distinguish
1455 between different parts or seasons in a series.
1461 Transit Cancel Time and Terminology Change
1462 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1467 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1468 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1469 are preserved in the database, though still not visible to the end user in the staff client.
1470 This allows for better tracking of when transits are canceled for the purposes of knowing
1471 which staff member canceled the transit, etc.
1473 NOTE: This change may require the re-creation of transit reports to filter out canceled
1474 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1475 Is NULL' will suffice.
1477 "Canceled Transit" Terminology Change
1478 +++++++++++++++++++++++++++++++++++++
1480 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1481 For internal continuity, however, the following permission codes have not changed:
1484 * `ABORT_REMOTE_TRANSIT`
1485 * `ABORT_TRANSIT_ON_LOST`
1486 * `ABORT_TRANSIT_ON_MISSING`
1494 Offline Circulation Available in Web Staff Client
1495 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1496 Offline circulation is now available in the web staff client. In order to use the
1497 offline interface, users must first log into the web staff client, perform
1498 a patron search, select a user from the results, and open the patron editor
1499 interface to collect all the relevent configuration information for the
1500 workstation. In addition, the offline interface available from the Circulation
1501 menu provides a 'Download block list' button for users who are logged in.
1503 As is the case in the old staff client, users can check materials in and out,
1504 renew items, and create new patron accounts while offline. The patron fields
1505 available in the offline patron registration editor are the same ones that
1506 are available to staff when working online.
1510 Add Circ Modifier to Record Detail Page in Staff TPAC
1511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1512 The circulation modifier field is added to the table of copies to make
1513 more information available to staff without having to open
1520 Date+Time Format Settings for Web Client
1521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1523 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1524 and adds two settings for use with the webstaff client:
1526 * 'Format Dates with this pattern'
1527 * 'Format Date+Time with this pattern'
1529 These settings use format strings as documented here:
1531 https://docs.angularjs.org/api/ng/filter/date
1533 There is overlap with how the Dojo formats worked, but also some differences.
1535 The original 'Format Dates' and 'Format Times' settings worked together, but the
1536 new settings work independently. Certain field elements will use one, and
1537 certain field elements will use the other. These distinctions are hard-coded
1538 in the various UI templates, with the idea being that timestamp fields in
1539 which the date component alone is sufficient information (for example, date of birth)
1540 will use the 'Format Dates' setting. Fields where the time component is
1541 important (for example, checkout time) will use the 'Format Date+Time' setting.
1543 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1544 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1550 Global Option to Remove Sound for a Specific Event
1551 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1552 A new `nosound.wav` file has been added to the web client. The file can be used
1553 to globally disable audio alerts for a specific event on an Evergreen system.
1555 For example, to silence the alert that sounds after a successful patron search:
1559 mkdir -p /openils/var/web/audio/notifications/success/patron/
1560 cd /openils/var/web/audio/notifications/success/patron/
1561 ln -s ../../nosound.wav by_search.wav
1568 The official Evergreen manual has been split into eight new manuals, each
1569 designed for a specific audience. This new approach is designed to make
1570 the documentation more readable and usable.
1572 The specific audiences for the new manuals are:
1574 * Acquisitions staff
1577 * Public services staff who use the public catalog
1579 * System administrators who use the command line
1580 * System administrators who use the Web client
1581 * System administrators and programmers who wish to integrate Evergreen
1582 with other technologies
1584 All manuals are available at http://docs.evergreen-ils.org
1590 Improvements to ebook API
1591 ^^^^^^^^^^^^^^^^^^^^^^^^^
1593 Evergreen now supports checking out and placing holds on
1594 OverDrive and OneClickdigital ebook titles from within the public
1595 catalog. This is an experimental feature. It is not recommended for production
1596 use without careful testing.
1598 When ebook integration is enabled, a "Check Out E-Item" link will be
1599 displayed when viewing an ebook title from a supported vendor in the
1600 catalog. Clicking on the link allows the user to check out and download
1601 that title from the vendor directly within the catalog.
1603 If no copies are available for the title, a "Place Hold on E-Item" link
1604 is displayed instead, and the user may place a hold on the title. (Note
1605 that some vendors require the user's account to have an email address
1606 before permitting a hold.)
1608 My Account includes the ability to view current ebook checkouts and
1609 holds, download already-checked-out titles, and cancel holds.
1611 For API integration to work, you need to request API access from the
1612 vendor, and the vendor must have a way of authenticating your patrons.
1613 Your Evergreen system also needs to be configured for ebook API
1614 integration, following the instructions in the command line system
1615 administration manual
1618 This feature assumes that you are importing MARC records supplied by the
1619 vendor into your Evergreen system, using Vandelay or some other MARC
1620 import method. This feature does not search the vendor's online
1621 collections or automatically import vendor records into your system; it
1622 merely augments records that are already in Evergreen.
1624 Improvements to Bill Payment Pages
1625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1626 The bill payment pages in the public catalog have been revamped
1629 * use the term "charges" instead of "fees"
1630 * include images of credit cards accepted
1631 * make the default print receipt template match other itemized receipts;
1632 note that this change is not automatically applied when upgrading.
1633 * display billing type
1634 * add button to pay only selected charges
1635 * reformat the credit card number input page
1641 Clickable Copy Locations
1642 ^^^^^^^^^^^^^^^^^^^^^^^^
1643 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1644 the associated copy location will display as a link in the public catalog summary display.
1645 This link can be useful for retrieving maps or other directions to the copy
1646 location to aid users in finding material.
1651 Download Checkout History CSV Fixed for Large Number of Circulations
1652 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1653 Downloading checkout history as a CSV from My Account has been fixed
1654 for users with a large circulation history. Previously, this would
1655 time out for patrons with more than 100 or so circulations.
1657 This feature no longer uses the action/trigger mechanism and the public catalog
1658 now generates the CSV directly. The old action/trigger code is still
1659 present in the database and should be removed at some point in the
1665 Google Books Preview Rewrite
1666 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1667 The Google Books Preview functionality in record detail pages has been
1668 rewritten to modernize its style and optimize its performance:
1670 * The Dojo JavaScript framework is no longer used, saving approximately
1671 150K of JavaScript and CSS and four network requests per page load.
1672 * The Embedded Viewer is not loaded unless a possible preview is found,
1673 saving more network and memory overhead.
1674 * The Google Books Loader is used to load the Embedded Viewer instead of the
1675 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1677 * All variables are self-contained and do not pollute the global namespace.
1678 * Event listeners are registered to handle clicks, rather than attaching
1679 `href="javascript:function()"` to <a> elements.
1680 * Book previews are displayed in a panel sized according to the viewport
1681 of the browser, improving its appearance on both mobile and desktop
1683 * The rewritten code is now served up directly from
1684 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1689 jQuery for the Public Catalog
1690 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1691 This release adds optional support for jQuery in the public catalog. This support
1692 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1693 `config.tt2` template.
1699 New Popularity Parameters
1700 ^^^^^^^^^^^^^^^^^^^^^^^^^
1701 New popularity parameters for in-house use over time and for count of distinct
1702 organizational units that own a title are now available. Evergreen sites
1703 can use these parameters to create new statistical popularity badges for
1704 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1706 The in-house use parameters will apply a badge to titles that have the most
1707 in-house use activity over time. The organizational unit count parameter
1708 will apply a badge to titles owned by the most number of libraries in a
1709 consortium. Ownership is determined by the copy's circulation library.
1714 Option to Suspend Holds at the Time They are Placed
1715 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1716 Users now have the option to suspend a hold at the same time they place the
1717 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1718 who want to suspend a hold at the time it is placed. There is also an option
1719 to set the activation date at the same time. This option is also available
1720 when placing holds on a batch of titles from 'My List' and will apply to
1721 all the titles in the batch.
1732 Fix to reporter.classic_current_circ View
1733 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1734 The `reporter.classic_current_circ` view, which is part of some
1735 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1736 has been fixed to not exclude loans for patrons who do not have a
1737 billing address set. Users of this view should rerun
1738 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1743 New Report Source Table Allowing Report of "Last" Deleted copy
1744 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1746 This source table allows you to construct a clever aggregate report template
1747 which will report bibliographic IDs where a library or a group of libraries
1748 no longer have a copy attached but *had* a copy attached. This is especially
1749 useful when a holdings sync is required with an external vendor.
1752 Instructions for creating a report template with this source:
1754 * Create a new report template using "Library Holdings Count with Deleted" as the source
1755 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1756 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1757 * 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"
1758 * Add "Bib ID" to Displayed Fields
1759 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1760 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1761 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1764 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1765 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1766 specified date range. Unfortunately the user will have to manually type the date range without the date
1767 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1768 copy and more than two deleted copies."
1773 Add Provider to Provider Note Link
1774 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1775 The Provider reporting source now includes a link to the Provider Note reporting source.
1780 Link ILS User and Working Location Reporting Sources
1781 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1782 The Working Location reporting source now has labels
1783 and it is now linked to the ILS User reporting source, allowing
1784 reports to display or filter on staff working location.
1789 New Circulation Report Source "All Circulation Combined Types"
1790 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1792 This report source will allow you to create a single report template for all of the following:
1795 * In-house uses of non-cataloged items
1797 * Circulations of non-cataloged items
1799 To distinguish between these different types of library use, it's important to display these columns
1800 in your report templates:
1809 Reports Template Searching
1810 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1811 A new form appears along the top of the reports interface for searching
1812 report templates. Once found, typical template actions (e.g. create new
1813 report) are available from within the results interface.
1815 Searches may be performed across selected (visible) folders or all
1816 folders visible to the logged in user.
1818 Searches are case-insensitive, any word order, with left-anchored words.
1819 All searched words must appear in at least one of the searched fields.
1824 * Searching for 'stat cat' matches:
1826 ** statistical category
1827 ** categories, statistical
1828 ** patrons (stat cat)
1829 * Searching for 'stat cat' does not match:
1831 *** both words must be present in the searched field(s)
1833 *** location contains 'cat' but it's not left-anchored.
1838 The templates, reports, and output interfaces now support paging via
1839 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1851 Web Staff Client Serials Module
1852 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1853 The serials module has been ported over to the web staff
1854 client, implementing a unified serials interface that combines
1855 ideas from both the serial control view and alternate serials
1856 control view from the old staff client.
1858 In addition to carrying over functionality that was available
1859 in the old staff client, several new features are included:
1861 * the ability to save prediction pattern codes as templates
1862 that can be shared and reused within an Evergreen database
1863 * a more streamlined interface for managing subscriptions,
1864 distributions, and streams
1865 * it is no longer necessary to create a starting issue in
1866 order to predict a run of issues; the dialog box for
1867 generating a set of predicted issues now lets you specify
1868 the starting point directly.
1869 * the ability to more directly edit MFHDs
1871 The new serials interfaces can be accessed from the record
1872 details page via a Serials drop-down button that links to
1873 a subscription management page, a quick-receive action, and
1874 a MFHD management page. There is also a new 'Serials Administration'
1875 page where prediction pattern and serial copy templates can
1886 SIP Bugfix Changes How Encoding Is Determined in Configuration
1887 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1889 The combined fix for the above mentioned SIP bugs alters the way that
1890 SIPServer looks up the output encoding in the configuration file (typically
1891 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1894 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1895 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1896 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.
1897 4. If none of the above exist, then the default encoding (ASCII) is used.
1899 Number 3 is provided to ease the transition to the new code. It is
1900 the current location of the +encoding+ element in the sample
1901 configuration file and as such, where it is likely to be found in
1902 actual files. It is recommended that you alter your configuration to
1903 move this element out of the +implementation_config+ element and into
1904 its parent +institution+ element. Ideally, SIPServer should *not* look into
1905 the implementation config, and this check may be removed at some time
1913 Web Client Acknowledgments
1914 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1916 The project to develop a new browser-based web client launched four
1917 years ago at the September 2013 Evergreen developer hack-a-way when the
1918 developer community voted to move away from the XUL client and explore other
1919 platforms. The first web client preview became available in Evergreen 2.7 when
1920 circulation was available in the new platform.
1922 The browser-based client is available due to the work of many coders, testers,
1923 bug reporters, documentors, translators, project managers, spec writers, funders
1924 and other contributors over the past four years.
1926 The Evergreen project would like to acknowledge the following organizations
1927 that funded development of the Web Staff Client:
1930 * British Columbia Libraries Cooperative
1931 * Consortium of Ohio Libraries
1933 * Georgia Public Library Service
1934 * Grand Rapids Public Library
1936 * Kenton County Public Library
1937 * King County Library System
1940 * Pennsylvania Integrated Library System
1941 * Pioneer Library System
1944 The Evergreen project would also like to thank the following individuals who
1945 contributed code, translations, documentation patches, tests, bug reports,
1946 technical specifications, and project management to the Web Staff Client:
1983 * Freddy Enrique Pelayo Huapalla
2009 Evergreen 3.0 Acknowledgments
2010 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2012 The Evergreen project would like to acknowledge the following
2013 organizations that commissioned developments in this release of
2017 * British Columbia Libraries Cooperative (BC Sitka)
2019 * Georgia Public Library Service
2020 * King County Library System
2022 * Pennsylvania Integrated Library System
2023 * Pioneer Library System
2025 We would also like to thank the following individuals who contributed
2026 code, translations, documentation patches, and tests to this release of
2075 We also thank the following organizations whose employees contributed
2078 * British Columba Libraries Cooperative
2082 * Emerald Data Networks, Inc.
2083 * Equinox Open Library Initiative
2085 * Grand Rapids Public Library
2086 * Indiana State Library
2088 * King County Library System
2089 * Lake Agassiz Regional Library
2090 * Laurentian University
2091 * Linn-Benton Community College
2093 * Merrimack Valley Library Consortium
2095 * North of Boston Library Exchange
2096 * Pennsylvania Integrated Library System
2097 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2099 * Traverse Area District Library
2101 We regret any omissions. If a contributor has been inadvertently
2102 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob