1 Evergreen 3.0 Release Notes
2 ===========================
9 The minimum version of PostgreSQL required to run Evergreen 3.0 is
10 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
12 Change to Names of Shared Libraries
13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 OpenSRF 3.0 changes how the shared libraries for services written in
15 C are named. If upgrading from an earlier version of Evergreen,
16 `opensrf.xml` should be edited so that shared library file names
17 listed in the `<implementation>` tag start with "lib". For example,
20 ---------------------------------------------------------------------
22 <language>C</language>
23 <implementation>oils_cstore.so</implementation>
24 ---------------------------------------------------------------------
29 ---------------------------------------------------------------------
31 <language>C</language>
32 <implementation>liboils_cstore.so</implementation>
33 ---------------------------------------------------------------------
35 SIP Bugfix Requires SIPServer Upgrade
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
39 crash" requires that you also upgrade SIPServer with the fix for
40 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
41 SIP client problems." This means that if you use SIP2 with Evergreen,
42 you must also upgrade SIPServer to the latest commit in the git
43 repository. Conversely, if you upgrade SIPServer to the latest commit
44 in git, you must also upgrade Evergreen or, at least, apply the patch
45 for Launchpad Bug 1542495. These two patches are complementary and
46 cannot be applied independently of one another.
50 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
51 API's in the `opensrf_core.xml` file.
56 ---------------------------------------------------------------------
57 --- a/Open-ILS/examples/opensrf_core.xml.example
58 +++ b/Open-ILS/examples/opensrf_core.xml.example
59 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
61 <match_string>open-ils.auth.authenticate.verify</match_string>
62 <match_string>open-ils.auth.authenticate.complete</match_string>
63 + <match_string>open-ils.auth.login</match_string>
64 <match_string>open-ils.auth_proxy.login</match_string>
65 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
66 <match_string>open-ils.actor.user.password</match_string>
67 ---------------------------------------------------------------------
71 Administrators of Evergreen who use RTL locales and who have customized
72 `style-rtl.css.tt2` should now incorporate their customizations into
75 Multi-Time Zone Installations
76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78 For Evergreen consortia that span more than one time zone, the following
79 query will adjust all historical, unaged circulations so
80 that if their due date field is pushed to the end of the day, it is done
81 in the circulating library's time zone, and not the server time zone.
83 It is safe to run this after any change to library time zones.
85 Running this is not required, as no code before this change has
86 depended on the time string of '23:59:59'. It is also not necessary
87 if all of your libraries are in the same time zone, and that time zone
88 is the same as the database's configured time zone.
97 for ou_id in select id from actor.org_unit loop
98 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
99 if new_tz is not null then
100 update action.circulation
101 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
102 where circ_lib = ou_id
103 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
112 Deprecation of XUL staff client
113 -------------------------------
114 Starting with the release of 3.0.0, patches that fix XUL bugs will not
115 be merged into master or backported unless they meet one or more of
116 the following conditions:
118 a. the bug is a security issue
119 b. the bug involves the destruction of data
120 c. the bug is a regression of functionality in the XUL staff client
121 introduced by other work done to Evergreen
123 Under no circumstances will XUL staff client feature enhancements be merged.
125 This policy will continue through the 3.0.x and 3.1.x maintenance
126 release cycles, and will become moot upon the release of 3.2.0, when
127 the XUL staff client is slated to be entirely removed.
140 New EDI Order Generator
141 ^^^^^^^^^^^^^^^^^^^^^^^
146 . New database tables exist for configuring vendor-specific EDI order
150 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
153 ** Collection of edi_attr's. Each edi_account may be linked to one
155 ** One edi_attr_set per known vendor is added to the stock data, matching
156 the stock configuration found in the JEDI template.
157 * acq.edi_attr_set_map
158 ** Link between edi_attr's and edi_attr_set's.
160 . EDI Attribute Sets are manged via a new (browser client only) configuration
161 interface at Administration -> Acquisitions Administration -> EDI
164 . Each acq.edi_account should be linked to an acq.edi_attr_set. If a link
165 is not set, default values will be used. Links between an EDI account
166 and an attribute set are managed in the EDI Accounts configuration
169 . Local modifications to the stock EG JEDI template are managed by modifying
170 and/or adding additional edi_att_set's as needed.
172 . A new edi_order_pusher.pl script is added which replaces the functionality
173 of edi_pusher.pl. edi_pusher.pl is still available.
175 . After moving to edi_order_pusher.pl, the JEDI Action/Trigger event
176 definition is no longer required. It can be disabled.
181 EDI accounts have a new boolean field "Use EDI Attributes" (use_attrs) that
182 specifies whether PO's generated via the account should be built using
183 EDI attributes or fall back to traditional JEDI A/T template generation.
185 This allows sites to activate EDI attributes on a per-account basis, making
186 it possible to migrate piecemeal to EDI attributes. For the initial roll
187 out of this new feature, no accounts will be configured to use EDI
188 attributes by default.
194 3 Day Courtesy Notice by SMS
195 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
196 New optional SMS text notification to be sent out 3 days prior to the due
197 date of any circulating item for patrons who have an SMS text number and
198 carrier stored in their accounts. This action trigger is disabled by default,
199 but can be enabled and modified by going into Admin > Local Administration >
200 Notifications / Action Triggers.
202 You may wish to make use of granularity so that these messages are batched
203 and sent at the same time each day.
208 Add Description Field to Circulation and Hold Configuration Entries
209 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
210 The circulation and hold policy configuration rules now each have a
211 description field. This allows administrators to add comments to
212 describe the purpose of each rule.
217 Apache Internal Port Configuration Option
218 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
219 Apache configuration now supports a new variable which allows admins to
220 specify the port used by Apache to handle HTTP traffic. The value is
221 used for HTTP requests routed from Perl handlers back to the same Apache
222 instance, like added content requests. Use this when running Apache
223 with a non-standard port, typical with a proxy setup. Defaults to "80".
226 -------------------------------------------------------------------
229 PerlSetVar OILSWebInternalHTTPPort "7080"
232 -------------------------------------------------------------------
237 Configurable Bib Record Display Fields
238 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240 Admin -> Server Admin -> 'MARC Search/Facet Fields' have 2 new configuration
241 fields: 'Display Field?' and 'Display XPATH'.
243 When 'Display Field' is set to true, data from the field will be extracted
244 from each record and added to a new table of display data for each bib
247 If a value is present in the 'Display XPATH' field, this XPATH will be
248 applied to the extracted data *after* the base XPATH (from the 'XPath'
249 field) is applied to each field.
251 This data acts as a replacement for the various and sundry ways bib record
252 data is currently extracted, including inline XPATH in the TPAC, reporter
253 views, real-time 'MVR' compilation from MODS, etc. and will be available
254 to the user interface, notification templates, etc. for rendering bib
257 The browser client gets a new service 'egBibDisplay' which is capable
258 of translating the display field data from various formats into
259 data more suitable for JavaScript usage.
261 The database gets 3 new views for representing display data in various
264 * metabib.flat_display_entry
265 ** List of all display fields linked to their configuration.
266 * metabib.compressed_display_entry
267 ** Same as metabib.flat_display_entry except there's one row
268 per display field type, with 'multi' rows compressed into
269 JSON arrays. Non-multi fields are represented as JSON
271 * metabib.wide_display_entry
272 ** Tabular view of display field data, one column per well-known
273 field. Values are represented JSON, consistent with
274 metabib.flat_display_entry. The view does *not* contain locally
275 configured display fields, as each field must be encoded in
276 the view and IDL definition. This is essentially a replacement
277 for reporter.simple_record.
282 After making changes to display field configuration, it's possible to
283 reingest only display field data in the database using the following:
286 ---------------------------------------------------------------------
287 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
288 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
289 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
290 ---------------------------------------------------------------------
296 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
297 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
298 The existing permission was incorrectly created with a code of
299 COPY_STATUS_LONGOVERDUE.override, while the event thrown requires a
300 permission with a code of COPY_STATUS_LONG_OVERDUE.override. This
301 update changes the permission code to match what the event requires.
307 Hold Targeter V2 Repairs and Improvements
308 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
309 * Make the batch targeter more resilient to a single-hold failure.
310 * Additional batch targeter info logging.
311 * Set OSRF_LOG_CLIENT in hold_targeter_v2.pl for log tracing
312 * Removes the confusingly named --target-all option
313 ** The same behavior can be achieved by using --retarget-interval "0s"
314 * Removes --skip-viable (see --soft-retarget-interval below)
316 New --next-check-interval Option
317 ++++++++++++++++++++++++++++++++
318 Specify how long after the current run time the targeter will retarget
319 the currently affected holds. Applying a specific interval is useful
320 when the retarget-interval is shorter than the time between targeter
323 For example, if the targeter is run nightly at midnight with a
324 --retarget-interval 36h, you would set --next-check-interval to 48hr,
325 since the holds won't be processed again until 48 hours later. This
326 ensures that the org unit closed date checks are looking at the correct
329 This setting overrides the default behavior of calculating the next
330 retarget time from the retarget-interval.
332 New --soft-retarget-interval Option
333 +++++++++++++++++++++++++++++++++++
334 This is a replacement for (and rebranding of) the --skip-viable option.
335 The new option allows for time-based soft-targeting instead simple binary
336 on/off soft-targeting.
338 How soft-targeting works:
340 * Update hold copy maps for all affected holds
341 * Holds with viable targets (on the pull list) are otherwise left alone.
342 * Holds without viable targets are retargeted in the usual manner.
348 New marc_export --descendants option
349 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
351 The marc_export script has a new option, --descendants. This option
352 takes one argument of an organizational unit shortname. It works much
353 like the existing --library option except that it is aware of the
354 org. tree and will export records with holdings at the specified
355 organizational unit and all of its descendants. This is handy if you
356 want to export the records for all of the branches of a system. You
357 can do that by specifying this option and the system's shortname,
358 instead of specifying multiple --library options for each branch.
360 The --descendants option can be repeated, as the --library option can.
361 All of the specified org. units and their descendants will be included
362 in the output. It can also be combined with individual --library
363 options when necessary.
368 RTL and LTR Public Catalog Stylesheets Merged
369 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
370 The RTL stylesheet for the public catalog,
371 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
372 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
373 template will provide RTL or LTR styles based on the value of
374 the `rtl` flag of the active locale. An `rtl` variable is also available
375 in the template to allow the correct style to be chosen.
380 Miscellaneous Improvements
381 ^^^^^^^^^^^^^^^^^^^^^^^^^^
383 * If a filter is in effect in the Library Settings Editor,
384 the filter will continue to be applied after a user
385 changes the selected library.
386 * Copy templates used for serials now correctly link to age
387 protection rules and MARC item type values (for the
388 "Circ as Type" field). During upgrade, the database update
389 will set to NULL any age protection and circ as type fields
390 in serial copy templates that do not point to defined values.
395 Obsolete Internal Flag Removed
396 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
398 An obsolete, and unused, ingest.disable_metabib_field_entry internal
399 flag was removed from the config.internal_flags table. It was
400 rendered obsolete by the addition of the 3 flags to control the
401 browse, search, and facet indexing.
406 Tweaks to Caching/Expiry of Public Catalog Assets
407 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
408 The default cache expiration time for static assets (e.g.,
409 CSS, image, and JavaScript files) in the public catalog and
410 the Kid's PAC has been increased to one year. Links to all
411 such assets now have a cache-busting value tacked on as a
412 query parameter. This value is refreshed when `autogen.sh` is
413 run, but it can also be manually set by adjusting the
414 `ctx.cache_key` Template Toolkit variable.
419 Action/Trigger Events Data Purging
420 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
422 Action/Trigger event definitions have a new field called "Retention
423 Interval". When an optional interval value is applied, events and
424 template output data linked to the event definition will be deleted
425 from the database once they reach the specified age.
427 Retention Interval Restrictions for Passive Hooks
428 +++++++++++++++++++++++++++++++++++++++++++++++++
430 Restrictions are placed on retention interval values for event definitions
431 using passive hooks to prevent data from being deleted while it's still
432 needed by the system.
434 The presence of event data is how the system knows not to send duplicate
435 events. As long as a scenario exists where a duplicate event may be
436 generated, the events must be retained.
438 To apply a retention interval value to a passive-hook event definition:
440 * The event definition must have a max_delay value.
441 * The retention interval must be larger than the difference between
442 the delay and max_delay values.
444 For example, if the delay is 7 days and max_delay is 10 days, the retention
445 interval must be greater than 3 days to ensure no duplicate events are
446 created between the first event on day 7 and the end of the event validity
452 A new purge_at_events.sh script is installed in the bin directory
453 (typically /openils/bin) which should be added to CRON for regular
456 NOTE: On large data sets, this script can take a long time to run and
457 create higher than normal I/O load as it churns though the event and
458 event_output tables. You may wish to run the script by hand the first
459 time so it can be monitored. It can be run in psql like so:
462 ---------------------------------------------------------------
463 SELECT action_trigger.purge_events();
464 ---------------------------------------------------------------
466 NOTE: On *very* large data sets (10s to 100s of millions of event and
467 event_output rows), it may be advisable to first repopulate the event
468 and event_output tables with only the desired data before starting
469 regular purges. This can be done, for example, using the copy to temp
470 table, truncate source table, repopulate source table from temp table
471 approach. This will be much faster than the purge_events() function
472 in cases where most of the data will be purged.
477 A number of action_trigger.hook entries which have always been treated
478 as active hooks, though are configured as passive hooks, have been
479 updated to properly reflect the non-passive-ness. This allows for
480 simpler configuration of their retention interval values.
486 Remove JSPAC Redirects
487 ^^^^^^^^^^^^^^^^^^^^^^
488 Future versions of Evergreen will no longer contain automatic redirects
489 from JSPAC URLs to TPAC URLs, with the exception of myopac.xml, given
490 that the JSPAC is no longer supported. Existing sites, however, may
491 wish to retain JSPAC redirects in their Apache configuration files since
492 JSPAC URLs may still be used in the wild to access their catalogs.
494 The original JSPAC URL redirects are all retained in the file
495 Open-ILS/examples/jspac_redirects.conf for reference.
505 New open-ils.auth.login API
506 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
507 The open-ils.auth service has a new API for requesting an authentication
508 token. It performs the same steps as the
509 open-ils.auth.authenticate.init and .complete APIs in a single call,
510 using the bare password. No intermediate password hashing is required.
512 The paramaters are the same as the .complete call with a few modifications.
514 1. Using the generic "identifier" parameter in combination with the
515 "org" parameter allows the API to reliably determine if an identifier
516 value is a username or barcode. The caller is no longer required to
517 make that determination up front.
519 2. The 'nonce' parameter is no longer used.
525 Batch Patron Contact Invalidation
526 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
527 The following methods are used to mark patron contact fields
528 as invalid by moving the invalid value to a standing penalty:
530 * `open-ils.actor.invalidate.email`
531 * `open-ils.actor.invalidate.day_phone`
532 * `open-ils.actor.invalidate.evening_phone`
533 * `open-ils.actor.invalidate.other_phone`
535 These methods now accept a fifth argument specifying the value
536 of the contact field, e.g., a specific phone number or email
537 address. If supplied, and if a specific patron ID (the first
538 argument) is not supplied, all patrons with that specific contact
539 value will have it marked invalid.
549 Pure-SQL catalog searching
550 ^^^^^^^^^^^^^^^^^^^^^^^^^^
551 Public and staff catalog search is now both more accurate and faster
552 by redesigning how the visibility of records is calculated.
562 Authority Record and Headings Browse Improvements
563 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
564 Various improvements are made to support for authority records
565 and headings browsing:
567 * The MARC to MADS XSLT stylesheet is now used as part of parsing
568 headings from authority records. Since the MODS and MADS stylesheets
569 extract headings in similar ways, duplicate browse entries are now
570 much less likely to occur.
571 * A new configuration table, `authority.heading_field`, is now used
572 to specify how headings should be extracted from authority records.
573 * Related headings can now be identified as narrower or broader when
574 browsing in the public catalog.
575 * See references are now more reliably included in the browse list.
576 * Scope (public) notes now display only under the main heading.
577 * There is now a global flag, Display related headings (see-also) in browse,
578 that can be used to control whether related headings (see-alsos) are
579 displayed in the public catalog list.
580 * A complete set of thesauruses are now included in the seed data. Thesauruses
581 can now be identified using short and long codes.
582 * The labels for see and see-also references in the public catalog are
583 a bit more patron-friendly, and can now be tweaked via TPAC template
584 customization in the browse.tt2 file.
590 Copy Tags and Digital Bookplates
591 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
592 Copy tags will allow staff to apply custom, pre-defined labels or tags
593 to copies. Copy tags are searchable in both the staff client and public
594 catalog. This feature was designed to be used for Digital Bookplates to
595 attach donation or memorial information to copies, but may be used for
596 broader purposes to tag items.
598 Each copy tag can either be publicly-visible or visible only to staff.
599 Copy tags also have types that can be used for restricting catalog
600 searches on copy tags to particular types.
602 Copy tags are displayed in the copy table in the record summary page in
603 the public catalog, and a new library setting can be used to add
604 a "Digital Bookplate" search field. Copy tags can also be used
605 as a search filter, e.g.,
607 * `copy_tag(bookplate, jane smith)`: search for records that have a
608 copy tag of type `bookplate` whose value contains `jane smith`.
609 * `copy_tag(*, jane smith)`: search for records that have a
610 copy tag of any type whose value contains `jane smith`.
612 All staff-side interfaces related to copy tags exist only in the web
613 staff client. There are two new administration interfaces for managing
614 copy tags and copy tag types. The copy editor now has a `Copy Tags`
615 button for applying copy tags to copies; that interface can also be
616 used to create new copy tags on the fly. Furthermore, the copy buckets
617 interface now has an `Apply Tags` action for assigning tags to groups
623 Two new permission are included:
625 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
626 Server Administration->Copy Tag Types
627 * `ADMIN_COPY_TAG`: required to create a new tag under
628 Local Administration->Copy Tags
630 The existing permission `UPDATE_COPY` controls whether or not a user
631 can link copies to tags.
635 A new library setting, "Enable Digital Bookplate Search", controls
636 whether to display a "Digital Bookplate" field in the search index
637 drop-downs in the catalog. A "Digital Bookplate" search will include
638 all records that have a copy that matches the tag specified by the user.
639 It should be noted that this library setting does not affect the
640 display of copy tags on the catalog record summary page.
645 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
646 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
647 The call number prefix and suffix, when present, are now included in
648 subfields $k and $m of the 852 field when running `marc_export` with
649 the `--items` switch. Similarly, when using Evergreen as a Z39.50
650 server configured to embed item data in 852 fields, the affixes are now
651 included in subfields $k and $m.
661 Batch Editing of Patron Records
662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
663 There is a now a new interface analogous to the Copy Bucket interface
664 to select and group a set of users into a User Bucket.
665 The addition of users to a User Bucket is possible from the Patron Search
666 interface by the use of a new grid Action, and directly on the User Bucket
667 interface by user barcode. It is also possible to add users to a User
668 Bucket by uploading a text file that contains a list of user barcodes.
670 From this interface it is possible to perform a set of specific batch update
671 operations against users.
676 The fields can now be changed in batch via an action on the User Bucket
677 grid if the staff user has the UPDATE_USER permission:
680 * Primary Permission Group (group application permissions consulted)
682 * Home Library (UPDATE_USER checked against both old and new value)
683 * Privilege Expiration Date
684 * Barred flag (BAR_PATRON permission consulted)
685 * Internet Access Level
687 Each change set requires a name. Buckets may have multiple change sets. All
688 users in the Bucket at the time of processing are updated when the change
689 set is processed, and change sets are processed immediately upon successful
690 creation. The interface delivers progress information regarding the
691 processing stage and percent of completion.
693 While processing the users, the original value for each field edited is
694 recorded for potential future rollback. Users can examine the success and
695 failure of applied change sets.
697 The user will be able to rollback the entire change set, but not parts thereof.
698 The rollback will affect only those users that were successfully updated by the
699 original change set and may be different from the current set of users in the
700 Bucket. Users can manually discard change sets, removing them from the
701 interface but preventing future rollback.
703 As a batch process, rather than a direct edit, this mechanism explicitly skips
704 processing of Action/Trigger event definitions for user update.
709 The batch edit mechanism also allows for the batch deletion of user. The staff
710 user must have both the UPDATE_USER and DELETE_USER permissions.
712 Each delete set requires a name. Buckets may have multiple delete sets. All
713 users in the Bucket at the time of processing are marked as deleted when
714 the delete set is processed. The interface delivers progress information
715 regarding the processing stage and percent of completion.
717 While processing the users, the original value for the "deleted" field will be
718 recorded for potential future rollback. Users are able to examine the
719 success and failure of applied delete sets in the same interface used for the
720 above described change sets.
722 As a batch process, rather than a direct edit, this mechanism explicitly skips
723 processing of Action/Trigger event definitions for user deletion.
725 This mechanism does not use the Purge User functionality, but instead simply
726 marks the users as deleted.
728 Editing Statistical Category Entries
729 ++++++++++++++++++++++++++++++++++++
731 All users in the bucket can have their Statistical Category Entries
732 modified. Unlike user data field updates, modification of Statistical
733 Category Entries is permanent and cannot be rolled back. No named change
734 sets are required. The interface will deliver progress information regarding
735 the processing stage and percent of completion.
737 As a batch process, rather than a direct edit, this mechanism explicitly skips
738 processing of Action/Trigger event definitions for user update.
740 New service requirement
741 +++++++++++++++++++++++
743 This new functionality makes use of the QStore service, which was previously
744 unused in production. If this service has been removed from the configuration
745 of a live Evergreen instances, it will need to be added back in order for
746 batch user editing to succeed.
751 Honor timezone of the acting library
752 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
757 * Display day-granular due dates in the circulating library's timezone.
758 * Only display the date portion of the due date for day-granular circulations.
759 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
760 * Provide infrastructure for more advanced formatting of timestamps.
761 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
766 This is a followup to the work done for 2.12, where we added the ability
767 for the client to specify a timezone in which timestamps should be interpreted
768 in business logic and the database.
770 Most specifically, this work focuses on circulation due dates and the closed
771 date editor. Due dates, where displayed using stock templates (including
772 receipt templates) and used for fine calculation, are now manipulated in the
773 library's configured timezone. This is controlled by the new 'lib.timezone'
774 setting available via the Library Settings Editor, loaded from the server when
775 required. Additionally, closings are recorded in the library's timezone so that
776 due date calculation is more accurate. The closed date editor is also
777 taught how to display closings in the
778 closed library's timezone. Closed date entries also explicitly record if they
779 are a full day closing, or a multi-day closing. This significantly simplifies
780 the editor, and may be useful in other contexts.
782 To accomplish this, we use the moment.js library and the moment-timezone addon.
783 This is necessary because the stock AngularJS date filter does not understand
784 locale-aware timezone values, which are required to support DST. A simple
785 mapper translates the differences in format values from AngularJS date to
788 Of special note are a set of new filters used for formatting timestamps under
789 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
790 filters provide the functionality, and autogrid is enhanced to make use of
791 these where applicable. egGrid and egGridField are also taught to accept
792 default and field-specific options for applying date filters. These filters may
793 be useful in other or related contexts.
795 The egDueDate filter, used for all existing displays of due date via Angular
796 code, intentionally interprets timestamps in two different ways WRT timezone,
797 based on the circulation duration. If the duration is day-granular (that is,
798 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
799 of seconds) then the date is interpreted as being in the circulation library's
800 timezone. If it is an hourly loan (any duration that does not meet the
801 day-granular criterium) then it is instead displayed in the client's timezone,
802 just as all other timestamps currently are, because of the previous Evergreen
805 The OPAC is adjusted to always display the due date in the circulating
806 library's timezone. Because the OPAC displays only the date portion of the due
807 date field, this difference is currently considered acceptable. If this proves
808 to be a problem in the future, a minor adjustment can be made to match the
809 egDueDate filter logic.
811 Now that due dates are globally stored in the configured timezone of the
812 circulating library, the automatic adjustment to day-granular due dates needs
813 to take those timezones into account.
815 An optional SQL command is provided by the upgrade script to retroactively
816 adjust existing due dates after library configuration is complete.
822 Enhancements to Hard Due Date Functionality
823 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
824 It will now be possible to delete Hard Due Date Values for dates that have
825 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
826 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
827 as well as scheduling Ceiling Date changes via Hard Due Date Values.
832 Patron Search by Birth Date
833 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
834 * Now you can include the patron birth year and/or birth month and/or
835 birth day when searching for patrons using the web based staff client.
836 * Day and month values are exact matches. E.g. month "1" (or "01")
837 matches January, "12" matches December.
838 * Year searches are "contains" searches. E.g. year "15" matches 2015,
839 1915, 1599, etc. For exact matches use the full 4-digit year.
843 Patron Search from Place Hold
844 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
845 This feature allows staff members, when placing a
846 hold on behalf of a patron in the web staff client, to search for
847 patrons by names and other searchable patron information, rather than
848 relying on barcode alone. In particular, after performing a catalog
849 search or going to a specific bib record and clicking the 'Place Hold'
850 button, the form now includes a 'Patron Search' button. This button
851 will open a dialog allowing the staff member search for and select
857 Retrieve Recent Patrons
858 ^^^^^^^^^^^^^^^^^^^^^^^
860 Adds a new library setting 'Number of Retrievable Recent Patrons'
861 ('ui.staff.max_recent_patrons') that specifies the number of recently
862 retrieved patrons that can be re-fetched from the staff client.
864 A value of 0 means no recent patrons can be retrieved.
865 A value greater than 1 means staff will be able to retrieve multiple
866 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
868 The default value is 1 for backwards compatibility.
875 Fuller title in XUL client Simplified Pull List
876 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
877 The Simplified Pull List in the XUL client will now display subfields 245$n and
878 $p in the title field. The addition will make it easier for staff to distinguish
879 between different parts or seasons in a series.
885 Transit Cancel Time and Terminology Change
886 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
891 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
892 the rows in action.transit_copy, action.hold_transit_copy, and action.reservation_transit_copy
893 are preserved in the database, though still not visible to the end user in the staff client.
894 This allows for better tracking of when transits are canceled for the purposes of knowing
895 which staff member canceled the transit, etc.
897 NOTE: This change may require the re-creation of transit reports to filter out canceled
898 transits from the results. Cloning the template and adding a Base Filter of Cancel Time
899 Is NULL will suffice.
901 "Canceled Transit" Terminology Change
902 +++++++++++++++++++++++++++++++++++++
904 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
905 For internal continuity, however, the following permission codes have not changed:
908 * ABORT_REMOTE_TRANSIT
909 * ABORT_TRANSIT_ON_LOST
910 * ABORT_TRANSIT_ON_MISSING
918 Offline Circ Available in Web Staff Client
919 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
920 Offline circ is now available in the web staff client. In order to use the
921 offline interface, users must first log into the web staff client, perform
922 a patron search, select a user from the results, and open the patron editor
923 interface to collect all the relevent configuration information for the
924 workstation. In addition, the offline interface available from the Circulation
925 menu provides a _Download block list_ button for users who are logged in.
927 As is the case in the old staff client, users can check materials in and out,
928 renew items, and create new patron accounts while offline. The patron fields
929 available in the offline patron registration editor are the same ones that
930 are available to staff when working online.
934 Add Circ Modifier to Record Detail Page in Staff TPAC
935 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
936 The circ_modifier field is added to the table of copies to make
937 more information available to staff without having to open
944 Date+Time Format Settings for Web Client
945 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
947 This change deprecates the existing Format Dates and Format Times settings
948 and adds two settings for use with the webstaff client:
950 * Format Dates with this pattern
951 * Format Date+Time with this pattern
953 These settings use format strings as documented here:
955 https://docs.angularjs.org/api/ng/filter/date
957 There is overlap with how the Dojo formats worked, but also some differences.
959 The original Format Dates and Format Times settings worked together, but the
960 new settings work independently. Certain field elements will use one, and
961 certain field elements will use the other. These distinctions are hard-coded
962 in the various UI templates, with the idea being that timestamp fields in
963 which the date component alone is sufficient information (for example, DOB)
964 will use the Format Dates setting. Fields where the time component is
965 important (for example, Checkout Time) will use the Format Date+Time setting.
967 When the settings Format Dates and Format Date+Time are unset, we will default
968 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
974 Global option to remove sound for a specific event
975 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
976 A new nosound.wav file has been added to the web client. The file can be used
977 to globally disable audio alerts for a specific event on an Evergreen system.
979 For example, to silence the alert that sounds after a successful patron search:
981 * mkdir -p /openils/var/web/audio/notifications/success/patron/
982 * cd /openils/var/web/audio/notifications/success/patron/
983 * ln -s ../../nosound.wav by_search.wav
994 Improvements to Bill Payment Pages
995 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
996 The bill payment pages in the public catalog have been revamped
999 * use the term "charges" instead of "fees"
1000 * include images of credit cards accepted
1001 * make the default print receipt template match other itemized receipts;
1002 note that this change is not automatically applied when upgrading.
1003 * display billing type
1004 * add button to pay only selected charges
1005 * reformat the credit card number input page
1011 Clickable Copy Locations
1012 ^^^^^^^^^^^^^^^^^^^^^^^^
1013 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1014 the associated copy location will display as a link in the OPAC summary display.
1015 This link can be useful for retrieving maps or other directions to the copy
1016 location to aid users in finding material.
1021 Download Checkout History CSV Fixed for Large Number of Circulations
1022 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1023 Downloading checkout history as a CSV from My Account has been fixed
1024 for users with a large circulation history. Previously, this would
1025 time out for patrons with more than 100 or so circulations.
1027 This feature no longer uses the action/trigger mechanism and the OPAC
1028 now generates the CSV directly. The old action/trigger code is still
1029 present in the database and should be removed at some point in the
1035 Google Books Preview rewrite
1036 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1037 The Google Books Preview functionality in record detail pages has been
1038 rewritten to modernize its style and optimize its performance:
1040 * The Dojo JavaScript framework is no longer used, saving approximately
1041 150K of JavaScript and CSS and four network requests per page load.
1042 * The Embedded Viewer is not loaded unless a possible preview is found,
1043 saving more network and memory overhead.
1044 * The Google Books Loader is used to load the Embedded Viewer instead of the
1045 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1047 * All variables are self-contained and do not pollute the global namespace.
1048 * Event listeners are registered to handle clicks, rather than attaching
1049 `href="javascript:function()"` to <a> elements.
1050 * Book previews are displayed in a panel sized according to the viewport
1051 of the browser, improving its appearance on both mobile and desktop
1053 * The rewritten code is now served up directly from
1054 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1061 This release adds optional support for jQuery in the TPAC. This support
1062 is enabled by setting the ctx.want_jquery variable to a true value in the
1063 config.tt2 TPAC template.
1069 New Popularity Parameters
1070 ^^^^^^^^^^^^^^^^^^^^^^^^^
1071 New popularity parameters for in-house use over time and for count of distinct
1072 organizational units that own a title are now available. Evergreen sites
1073 can use these parameters to create new statistical popularity badges for
1074 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1076 The in-house use parameters will apply a badge to titles that have the most
1077 in-house use activity over time. The organizational unit count parameter
1078 will apply a badge to titles owned by the most number of libraries in a
1079 consortium. Ownership is determined by the copy's circulation library.
1084 Option to Suspend Holds at the Time They are Placed
1085 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1086 Users now have the option to suspend a hold at the same time they place the
1087 hold. The _Place Hold_ screen has a checkbox that can be enabled for users
1088 who want to suspend a hold at the time it is placed. There is also an option
1089 to set the activation date at the same time. This option is also available
1090 when placing holds on a batch of titles from _My List_ and will apply to
1091 all the titles in the batch.
1102 Fix to reporter.classic_current_circ view
1103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1104 The `reporter.classic_current_circ` view, which is part of some
1105 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1106 has been fixed to not exclude loans for patrons who do not have a
1107 billing address set. Users of this view should rerun
1108 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1113 New report source table allowing report of "last" deleted copy
1114 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1116 This source table allows you to construct a clever aggregate report template
1117 which will report bibliographic IDs where a library or a group of libraries
1118 no longer have a copy attached but *had* a copy attached. This is especially
1119 useful when a holdings sync is required with an external vendor.
1122 Instructions for creating a report template with this source:
1124 * Create a new report template using "Library Holdings Count with Deleted" as the source
1125 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1126 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1127 * 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"
1128 * Add "Bib ID" to Displayed Fields
1129 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1130 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1131 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1134 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1135 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1136 specified date range. Unfortunately the user will have to manually type the date range without the date
1137 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1138 copy and more than two deleted copies."
1143 Add Provider to Provider Note link
1144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1145 The Provider reporting source now includes a link to the Provider Note reporting source.
1150 Link ILS User and Working Location Reporting Sources
1151 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1152 The Working Location reporting source now has labels
1153 and it is now linked to the ILS User reporting source, allowing
1154 reports to display or filter on staff working location.
1159 New circulation report source "All Circulation Combined Types"
1160 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1162 This report source will allow you to create a single report template for all of the following:
1165 * In-house uses of non-cataloged items
1167 * Circulations of non-cataloged items
1169 To distinguish between these different types of library use, it's important to display these columns
1170 in your report templates:
1179 Reports Template Searching
1180 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1181 A new form appears along the top of the reports interface for searching
1182 report templates. Once found, typical template actions (e.g. create new
1183 report) are available from within the results interface.
1185 Searches may be performed across selected (visible) folders or all
1186 folders visible to the logged in user.
1188 Searches are case-insensitive, any word order, with left-anchored words.
1189 All searched words must appear in at least one of the searched fields.
1194 * Searching for 'stat cat' matches:
1196 ** statistical category
1197 ** categories, statistical
1198 ** patrons (stat cat)
1199 * Searching for 'stat cat' does not match:
1201 *** both words must be present in the searched field(s)
1203 *** location contains 'cat' but it's not left-anchored.
1208 The templates, reports, and output interfaces now support paging via
1209 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1221 Web Staff Client Serials Module
1222 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1223 The serials module has been ported over to the web staff
1224 client, implementing a unified serials interface that combines
1225 ideas from both the serial control view and alternate serials
1226 control view from the old staff client.
1228 In addition to carrying over functionality that was available
1229 in the old staff client, several new features are included:
1231 * the ability to save prediction pattern codes as templates
1232 that can be shared and reused within an Evergreen database
1233 * a more streamlined interface for managing subscriptions,
1234 distributions, and streams
1235 * it is no longer necessary to create a starting issue in
1236 order to predict a run of issues; the dialog box for
1237 generating a set of predicted issues now lets you specify
1238 the starting point directly.
1239 * the ability to more directly edit MFHDs
1241 The new serials interfaces can be accessed from the record
1242 details page via a Serials drop-down button that links to
1243 a subscription management page, a quick-receive action, and
1244 a MFHD management page. There is also a new Serials Administration
1245 page where prediction pattern and serial copy templates can
1256 SIP Bugfix Changes How Encoding Is Determined in Configuration
1257 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1259 The combined fix for the above mentioned SIP bugs alters the way that
1260 SIPServer looks up the output encoding in the configuration file (typically
1261 oils_sip.xml). SIPServer now looks for the encoding in the following
1264 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1265 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1266 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.
1267 4. If none of the above exist, then the default encoding (ASCII) is used.
1269 Number 3 is provided to ease the transition to the new code. It is
1270 the current location of the +encoding+ element in the sample
1271 configuration file and as such, where it is likely to be found in
1272 actual files. It is recommended that you alter your configuration to
1273 move this element out of the +implementation_config+ element and into
1274 its parent +institution+ element. Ideally, SIPServer should *not* look into
1275 the implementation config, and this check may be removed at some time
1282 The Evergreen project would like to acknowledge the following
1283 organizations that commissioned developments in this release of
1287 * British Columbia Libraries Cooperative (BC Sitka)
1289 * Georgia Public Library Service
1290 * King County Library System
1292 * Pennsylvania Integrated Library System
1293 * Pioneer Library System
1295 We would also like to thank the following individuals who contributed
1296 code, translations, documentations patches and tests to this release of
1345 We also thank the following organizations whose employees contributed
1348 * British Columba Libraries Cooperative
1352 * Emerald Data Networks, Inc.
1353 * Equinox Open Library Initiative
1355 * Grand Rapids Public Library
1356 * Indiana State Library
1358 * King County Library System
1359 * Lake Agassiz Regional Library
1360 * Laurentian University
1361 * Linn-Benton Community College
1363 * Merrimack Valley Library Consortium
1365 * North of Boston Library Exchange
1366 * Pennsylvania Integrated Library System
1367 * Pohjois-Karjalan Tietotekniikkakeskus Oy
1369 * Traverse Area District Library
1371 We regret any omissions. If a contributor has been inadvertently
1372 missed, please open a bug at http://bugs.launchpad.net/evergreen/