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