1 = Evergreen 3.10 Release Notes =
8 This release contains bug fixes improving on Evergreen 3.10.1.
13 * https://bugs.launchpad.net/evergreen/+bug/1972738[Bug 1972738] requires a schema update
14 * https://bugs.launchpad.net/evergreen/+bug/1920826[Bug 1920826] requires a schema update
15 * https://bugs.launchpad.net/evergreen/+bug/2009073[Bug 2009073] requires a schema update. Sites that have customized styles for the `oils_SH` CSS class should review their changes upon upgrade.
19 ==== Accessibility ====
21 * Fixes duplicate ID in staff catalog bib actions (https://bugs.launchpad.net/evergreen/+bug/2016341[Bug 2016341])
22 * Adds empty alt attributes for images and icons that already have equivalent text representation (https://bugs.launchpad.net/evergreen/+bug/2018208[Bug 2018208])
23 * Adds labeling to captcha math problem in OPAC (https://bugs.launchpad.net/evergreen/+bug/2015141[Bug 2015141])
24 * Fixes tab order in adminitration splash pages (https://bugs.launchpad.net/evergreen/+bug/2015137)
25 * Fixes default modal background color (https://bugs.launchpad.net/evergreen/+bug/2008918[Bug 2008918])
26 * Adds aria-label to staff catalog search +/- buttons (https://bugs.launchpad.net/evergreen/+bug/2002363[Bug 2002363])
27 * Adds H1 headings to staff pages (https://bugs.launchpad.net/evergreen/+bug/1994711[Bug 1994711])
28 * Fixes headings hierarchy and source order on staff catalog search results (https://bugs.launchpad.net/evergreen/+bug/2009865[Bug 2009865])
29 * Fixes highlight contrast & semantic markup in staff catalog & Bootstrap OPAC search results (https://bugs.launchpad.net/evergreen/+bug/2009073[Bug 2009073])
30 * Adds ARIA landmarks and roles for various Angular staff interfaces
31 (https://bugs.launchpad.net/evergreen/+bug/1615707[Bug 1615707])
32 * Fixes color contrast in staff search results pagination (https://bugs.launchpad.net/evergreen/+bug/2018326[Bug 2018326])
33 * Adds accessible names to purchase order checkboxes (https://bugs.launchpad.net/evergreen/+bug/2009092[Bug 2009092])
35 ==== Acquisitions ====
37 * Fixes line item ID link in Acq Search so the PO opens and then jumps to the correct line item (https://bugs.launchpad.net/evergreen/+bug/2003946[Bug 2003946])
39 ==== Administration ====
41 * Deduplicates entries in ils_events.xml (https://bugs.launchpad.net/evergreen/+bug/1369345[Bug 1369345])
42 * Encourages distinct results when querying ahopl IDL source (https://bugs.launchpad.net/evergreen/+bug/1964986[Bug 1964986])
43 * Restores missing database updates for version-upgrade from 3.5.1 to 3.6.0 (https://bugs.launchpad.net/evergreen/+bug/1920826[Bug 1920826])
44 * Improved error handling by open-ils.pcrud (https://bugs.launchpad.net/evergreen/+bug/1808016[Bug 1808016])
48 * Adds consistency to SMS Carrier dropdown display (https://bugs.launchpad.net/evergreen/+bug/1889916[Bug 1889916])
52 * Ensures authority linker is working in all embedded MARC editors (https://bugs.launchpad.net/evergreen/+bug/1716479[Bug 1716479])
56 * Adds a note to the Mark Patron Email Invalid function (https://bugs.launchpad.net/evergreen/+bug/1752334[Bug 1752334])
57 * Treats empty string as null for preferred name field (https://bugs.launchpad.net/evergreen/+bug/1996651[Bug 1996651])
58 * Fixes incorrect total circs in Item Status Detail View (https://bugs.launchpad.net/evergreen/+bug/2018534[Bug 2018534])
59 * Removes irrelevant actions from Hold Shelf actions menu (https://bugs.launchpad.net/evergreen/+bug/2004052[Bug 2004052])
60 * Removes patron information from the 'Check Out Staff' field in Item Status Circ History list (https://bugs.launchpad.net/evergreen/+bug/2001728[Bug 2001728])
61 * Fixes a caching issue that occasionally caused incorrect holds addresses to print on transit slips (https://bugs.launchpad.net/evergreen/+bug/1778567[Bug 1778567])
65 * Adds index to speed up display of the Hopeless Holds interface in large systems (https://bugs.launchpad.net/evergreen/+bug/1972738[Bug 1972738])
66 * Adds validator to Survey Date so surveys can not be created with an end date before their start date (https://bugs.launchpad.net/evergreen/+bug/1879517[Bug 1879517])
67 * Quiets extraneous console noise in some AngularJS grids (https://bugs.launchpad.net/evergreen/+bug/2013223[Bug 2013223])
68 * Restores correct link to AngularJS Patron Requests interface (https://bugs.launchpad.net/evergreen/+bug/2019150[Bug 2019150])
69 * Fixes Angular multi-select component to add a special case for shelving locations (https://bugs.launchpad.net/evergreen/+bug/1863387[Bug 1863387])
71 ==== Course Materials ====
73 * Fixes circ modifier column in Course Materials grid (https://bugs.launchpad.net/evergreen/+bug/1972917[Bug 1972917])
75 ==== Documentation ====
77 * Fixes to Server Installation documentation
78 * Updates to Record Buckets documentation (https://bugs.launchpad.net/evergreen/+bug/1845253[Bug 1845253])
79 * Updates to Fonts & Sound Settings documentation
80 * Adds documentation for OpenAthens (https://bugs.launchpad.net/evergreen/+bug/1998921[Bug 1998921])
84 * Fixes button styling in Boostrap OPAC (https://bugs.launchpad.net/evergreen/+bug/1981774[Bug 1981774])
85 * Adjusts functionality of "Where" button in OPAC (https://bugs.launchpad.net/evergreen/+bug/1970476[Bug 1970476])
86 * Fixes Google Books preview when loading from search results page (https://bugs.launchpad.net/evergreen/+bug/1791791(Bug 1791791)
87 * Fixes label alignment in MyAccount Circ History (https://bugs.launchpad.net/evergreen/+bug/2015481[Bug 2015484])
90 ==== Miscellaneous ====
92 * Adds fixes to AngularJS test suite (https://bugs.launchpad.net/evergreen/+bug/1915326[Bug 1915326])
96 === Acknowledgements ===
98 We would like to thank the following individuals who contributed code, testing, and documentation to the 3.10.2 point release of Evergreen:
108 * Blake Graham-Henderson
117 * Andrea Buntz Neiman
131 == Evergreen 3.10.1 ==
133 This release contains bug fixes improving on Evergreen 3.10.0. This release includes
134 fixes for two security bugs.
136 === Security Fixes ===
138 ==== Protect qtype CGI Parameter ====
140 Malicious DoS attempts have been witnessed in the wild making use of
141 the fact that Evergreen does not check the contents of the `qtype` CGI
142 parameter. While these fail their intent, it would be better to
143 simply drop such searches on the floor when they're seen.
145 Evergreen will now confirm that the search class in the `qtype` parameter
146 is valid, and that the remainder of the value is structured correctly,
147 before processing the search request.
149 This is https://bugs.launchpad.net/evergreen/+bug/1811685[Bug 1811685].
151 ==== Catalog Search Denial of Service Protection ====
153 Here we add two ways to protect against denial of service attacks:
155 * Limit concurrent search requests per client IP address
156 ** This helps address issues of accidental spamming from a malfunctioning OPAC workstation, or web crawlers of various types. The limit is controlled by a global flag called *opac.max_concurrent_search.ip*. By default there is no limit set.
157 * Limit the global concurrent search requests for the same query
158 ** This helps address both simple and distributed DoS that send the same search request over and over. The limit is controlled by a global flag called *opac.max_concurrent_search.query*, and defaults to 20.
160 When a limit is exceeded the client receives an HTTP 429 "Too many requests" response from the web server, and the connection is ended.
162 This is https://bugs.launchpad.net/evergreen/+bug/1361782[Bug 1361782].
164 === Upgrade notes ===
166 * https://bugs.launchpad.net/evergreen/+bug/2003707[Bug 2003707] - During upgrade, if you're running with `opensrf_core.xml` located anywhere other than `/openils/conf` in a single-tenant manner, make sure that `SYSCONFDIR` as set in `autogen.sh` matches what's set in the installed `Cronscript.pm`
167 * https://bugs.launchpad.net/evergreen/+bug/1998355[Bug 1998355] requires a schema update
168 * https://bugs.launchpad.net/evergreen/+bug/1441750[Bug 1441750] requires a schema update
169 * https://bugs.launchpad.net/evergreen/+bug/1995623[Bug 1995623] requires a schema update
170 * https://bugs.launchpad.net/evergreen/+bug/1361782[Bug 1361782] requires a schema update
174 ==== Accessibility ====
176 * Fixes color contrast on modal headers (https://bugs.launchpad.net/evergreen/+bug/1999954[Bug 1999954])
177 * Adjusts staff interface badges to comply with color contrast guidelines (https://bugs.launchpad.net/evergreen/+bug/1999282[Bug 1999282])
178 * Increases color contrast on staff client links and buttons (https://bugs.launchpad.net/evergreen/+bug/1991562[Bug 1991562])
179 * Adds accessible search form labels to staff catalog search form (https://bugs.launchpad.net/evergreen/+bug/1998855[Bug 1998855])
180 * Adds keyboard navigation support to menus within staff catalog bib records (https://bugs.launchpad.net/evergreen/+bug/1814978[Bug 1814978])
181 * Adds input labels in the manage authorities interface fields (https://bugs.launchpad.net/evergreen/+bug/1989284[Bug 1989284)]
182 * Adds labels to metarecord holds checkboxes in staff client + alt-text for decorative image (https://bugs.launchpad.net/evergreen/+bug/1999304[Bug 1999304])
184 ==== Acquisitions ====
186 * Fixes funds dropdown in new acqusitions interfaces (https://bugs.launchpad.net/evergreen/+bug/1999544[Bug 1999544])
187 * Opens provider link in new tab (https://bugs.launchpad.net/evergreen/+bug/2004187[Bug 2004187])
188 * Adds line item count to line item search results (https://bugs.launchpad.net/evergreen/+bug/2003947[Bug 2003947])
189 * Fixes error with saving circ mods using batch line item update (https://bugs.launchpad.net/evergreen/+bug/2002920[Bug 2002920])
190 * Fixes issue where closed invoices were showing in the link to invoice modal (https://bugs.launchpad.net/evergreen/+bug/1999268[Bug 1999268])
191 * Moves line item loading progress bar to the summary area (https://bugs.launchpad.net/evergreen/+bug/1999410[Bug 1999410])
193 ==== Administration ====
195 * `autogen.sh` can now accept a `-c` switch to specify the location of `opensrf_core.xml`. This is useful for certain multi-tenant setups of Evergreen. (https://bugs.launchpad.net/evergreen/+bug/2003707[Bug 2003707])
196 * Avoids permission lookup when there's no authtoken (https://bugs.launchpad.net/evergreen/+bug/1990306[Bug 1990306])
197 * Fixes an issue with `marc_stream_importer.pl` temp file creation (https://bugs.launchpad.net/evergreen/+bug/1943634[Bug 1943634])
198 * Adds patron database ID to Stripe payment record (https://bugs.launchpad.net/evergreen/+bug/1969994[Bug 1969994])
199 * Fix to prevent multiple server processes from being created by `oils_ct.sh` (https://bugs.launchpad.net/evergreen/+bug/1908455[Bug 1908455])
200 * Fixes an issue where last-copy delete was not creating hold notices (https://bugs.launchpad.net/evergreen/+bug/2007591[Bug 2007591])
201 * Fix to reduce bloating of `search.symspell_dictionary` (https://bugs.launchpad.net/evergreen/+bug/1998355[Bug 1998355)]
202 * Fix to allow legacy `mod_perl` handlers to check `eg.auth.token` (https://bugs.launchpad.net/evergreen/+bug/1996908[Bug 1996908])
203 * Fix to change legacy `ARRAY_TO_STRING(ARRAY_AGG())\ functions to `STRING_AGG()` functions (https://bugs.launchpad.net/evergreen/+bug/1441750[Bug 1441750])
204 * Fixes typo in `AddedContent.pm` (https://bugs.launchpad.net/evergreen/+bug/2012105[Bug 2012105])
205 * Fixes permissions check in Library Settings Editor (https://bugs.launchpad.net/evergreen/+bug/2006749[Bug 2006749])
206 * Fixes regression introduced in patch for https://bugs.launchpad.net/evergreen/+bug/2006749[Bug 2006749] (https://bugs.launchpad.net/evergreen/+bug/2007880[Bug 2007880])
207 * Search performance improvements for PostgreSQL 12+ (https://bugs.launchpad.net/evergreen/+bug/1999274[Bug 1999274])
211 * Fixes an error emailing records from the staff catalog & OPAC (https://bugs.launchpad.net/evergreen/+bug/1955079[Bug 1955079])
212 * Removes deleted call numbers from shelf browse (https://bugs.launchpad.net/evergreen/+bug/2003742[Bug 2003742])
213 * Adjusts styling of disable search menu items in staff catalog search (https://bugs.launchpad.net/evergreen/+bug/1998969[Bug 1998969])
217 * Fixes issue where holdings template importer wouldn't import the full file (https://bugs.launchpad.net/evergreen/+bug/1980544[Bug 1980544])
218 * Fixes an issue where statcats in holding templates wouldn't save correctly (https://bugs.launchpad.net/evergreen/+bug/1999696[Bug 1999696])
219 * Fixes inconsistent button placement in delete holdings modal (https://bugs.launchpad.net/evergreen/+bug/1945355[Bug 1945355])
220 * Adds styling to show that a holding template changed a statcat value (https://bugs.launchpad.net/evergreen/+bug/2003755[Bug 2003755])
221 * Fixes erroneous error message in cover image upload modal (https://bugs.launchpad.net/evergreen/+bug/1988321[Bug 1988321])
222 * Fixes an issue where last-copy delete was not creating hold notices (https://bugs.launchpad.net/evergreen/+bug/2007591[Bug 2007591])
223 * Restores the ability to create empty call numbers in the holdings editor (https://bugs.launchpad.net/evergreen/+bug/1998494[Bug 1998494])
224 * Fixes MARC editor heading linker for fields 600, 651, and 655 (https://bugs.launchpad.net/evergreen/+bug/2007351[Bug 2007351])
225 * Protects "magic" statuses from overwrite when using holdings editor template (https://bugs.launchpad.net/evergreen/+bug/1999401[Bug 1999401])
226 * Prevents deletion of shelving locations with items attached + adds undelete action on shelving location editor (https://bugs.launchpad.net/evergreen/+bug/2002435[Bug 2002435])
227 * Fixes item tag scoping in holdings editor (https://bugs.launchpad.net/evergreen/+bug/1965447[Bug 1965447])
229 ==== Circulation ====
231 * Clears `hopeless_date` when hold is captured (https://bugs.launchpad.net/evergreen/+bug/1915440[Bug 1915440])
232 * Fixes an issue where large hold shelf lists could fail to load (https://bugs.launchpad.net/evergreen/+bug/1971745[Bug 1971745])
233 * Fixes slowness in the holds shelf query (https://bugs.launchpad.net/evergreen/+bug/1971745[Bug 1971745])
234 * Fixes an issue where the patron registration form sent unnecessarily large amount of data upon save (https://bugs.launchpad.net/evergreen/+bug/1976126[Bug 1976126])
235 * Fixes display issue with depth selector in patron note modal (https://bugs.launchpad.net/evergreen/+bug/1980874[Bug 1980874])
236 * Removes extra "pre-fetch all holds" checkbox from view holds page (https://bugs.launchpad.net/evergreen/+bug/2002337[Bug 2002337])
240 * Adds localization to Record Summary heading (https://bugs.launchpad.net/evergreen/+bug/1999446[Bug 1999446])
241 * Adds a user-visible error if a user attempts to login to the staff client without STAFF_LOGIN permissions (https://bugs.launchpad.net/evergreen/+bug/1969641[Bug 1969641])
242 * Fixes grid refresh issue on old Dojo grids (https://bugs.launchpad.net/evergreen/+bug/1625192[Bug 1625192])
243 * Fixes shelving location selector that was broken in several interfaces (https://bugs.launchpad.net/evergreen/+bug/1995418[Bug 1995418]
244 * Angular fixes including removing alert_message from print template, adding min/max to date picker, and preventing selecting a past date at checkout (https://bugs.launchpad.net/evergreen/+bug/1995623[Bug 1995623])
245 * Adds offline message to Angular login page (https://bugs.launchpad.net/evergreen/+bug/1958258[Bug 1958258])
246 * Fixes Angular login redirect issue (https://bugs.launchpad.net/evergreen/+bug/2006513[Bug 2006513])
249 ==== Documentation ====
251 * Updates to Standing Penalties and Group Penalty Thresholds documentation
252 * Updates `create_release_notes.sh` to use asciidoctor formatting (https://bugs.launchpad.net/evergreen/+bug/1995653[Bug 1995653])
253 * Adds Evergreen Web Services documentation
254 * Adds Mark Item as Missing Pieces documentation (https://bugs.launchpad.net/evergreen/+bug/1706664[Bug 1706664])
255 * Updates to Server Installation documentation for current ng-build parameters (https://bugs.launchpad.net/evergreen/+bug/1863921[Bug 1863921])
256 * Updates to Web Client Best Practices documentation
257 * Updates to Describing Your Organization documentation
258 * Updates to Load MARC Order Records documentation
259 * Updates to Purchase Order, Selection Lists, and Line Items documentation
263 * Fixes Google Books preview (https://bugs.launchpad.net/evergreen/+bug/1955403[Bug 1955403])
264 * Fixes patron address alignment (https://bugs.launchpad.net/evergreen/+bug/1944602[Bug 1944602])
265 * Fixes button arrangement in MyAccount holds interface (https://bugs.launchpad.net/evergreen/+bug/1980275[Bug 1980275])
266 * Fixes alignment in publication year search filter fields (https://bugs.launchpad.net/evergreen/+bug/1974581[Bug 1974581])
267 * Fixes an issue with holds history pagination (https://bugs.launchpad.net/evergreen/+bug/1422927[Bug 1422927])
268 * Adds localization to sr-only, aria-label, and title fields (https://bugs.launchpad.net/evergreen/+bug/1992490[Bug 1992490])
269 * Fixes an error emailing records from the staff catalog & OPAC (https://bugs.launchpad.net/evergreen/+bug/1955079[Bug 1955079])
270 * Fixes display problem in 856 subfields $n, $z, and $3 (https://bugs.launchpad.net/evergreen/+bug/1966995[Bug 1966995])
271 * Fixes facet display issue in grouped record search results (https://bugs.launchpad.net/evergreen/+bug/1980304[Bug 1980304])
272 * Fixes small-screen display issue with navigation links in copy table (https://bugs.launchpad.net/evergreen/+bug/1983729[Bug 1983729])
273 * Fixes small-screen display issue with table displays (https://bugs.launchpad.net/evergreen/+bug/1984269[Bug 1984269])
274 * Corrects duplicate DOB display in patron self-registration form (https://bugs.launchpad.net/evergreen/+bug/1965065[Bug 1965065])
275 * Fixes display issue with applied filters (https://bugs.launchpad.net/evergreen/+bug/1980302[Bug 1980302])
276 * Fixes syntax error introduced in bug https://bugs.launchpad.net/evergreen/+bug/1992490[Bug 1992490] (https://bugs.launchpad.net/evergreen/+bug/2008925[Bug 2008925])
277 * Fixes styling of patron messages (https://bugs.launchpad.net/evergreen/+bug/1980142[Bug 1980142])
279 ==== Miscellaneous ====
281 * Fixes field order in New Survey modal (https://bugs.launchpad.net/evergreen/+bug/1991590[Bug 1991590])
282 * Changes Angular `styleext` setting to `style` (https://bugs.launchpad.net/evergreen/+bug/1995211[Bug 1995211])
286 * Fixes an error with display of certain shared reports folders (https://bugs.launchpad.net/evergreen/+bug/1999944[Bug 1999944])
289 === Acknowledgements ===
291 We would like to thank the following individuals who contributed code, testing, and documentation to the 3.10.1 point release of Evergreen:
303 * Blake Graham-Henderson
317 * Andrea Buntz Neiman
330 == Evergreen 3.10.0 ==
332 === Upgrade notes ===
334 The database update includes a partial reingest.
339 ==== Acquisitions ====
341 ===== Further Angularization of Acquisitions Interfaces =====
343 The following acquisitions interfaces were rewritten in Angular:
345 * Purchase Orders and Selection Lists
346 * Line Item management, including
347 ** Receiving and claiming
348 ** Creation of line item items singly and in batch
349 * Load MARC Order Records
351 Improvements over the previous interfaces include:
353 * The line item table can now be sorted and filtered
354 * New settings to control the owning library that is
355 applied to auto-created line item items.
357 ===== Support for Advanced Shipment Notices in Acquisitions =====
359 This version of Evergreen supports DESADV EDI messages. These messages are
360 created by vendors when they pack and ship items, and contain:
362 * A list of dispatched POs, lineitems, and the number of items per lineitem.
363 * A package-level barcode (e.g. https://en.wikipedia.org/wiki/Serial_shipping_container_code) that represents the package as a whole.
365 Staff can scan that package-level barcode to retrieve information on every
366 item in the package, including an option to auto-receive every item in the box.
368 ===== New column in General Acquisitions Search =====
370 The general acquisitions search grid now has a column
371 for purchase order ID.
373 ===== New Permission for Fund Rollovers =====
375 A new permission, `ADMIN_FUND_ROLLOVER`, is added to control access
376 to the fund rollover function. This allows having some users be able
377 to manage funds without being to invoke the rollover action, as
378 rollovers can be hard to undo.
380 During upgrade, any permission group with the `ADMIN_FUND` permission
381 will get the new `ADMIN_FUND_ROLLOVER` permission to avoid surprises.
382 Consequently, an Evergreen administrator who wishes to lock down
383 access to the feature should follow up by removing the new permission
386 In new databases, `ADMIN_FUND_ROLLOVER` is granted only to the stock
387 Acquisitions Administrators permission group.
389 ===== Inactive funds can no longer make allocations or transfers =====
391 In the Funds Administration page, if a fund is not marked as
392 active, the "Create allocation" and "Transfer money" options
393 will no longer be available.
395 In the occassional cases where these operations are necessary,
396 you can edit the fund to mark it active, perform your financial
397 operations, then mark it inactive again.
399 ==== Administration ====
401 ===== Geosort feature can now use Bing Maps API =====
403 The API can be configured at *Server Administration*
404 -> *Geographic Location Service*.
406 ===== Refresh Time for Carousel =====
408 This adds the time (rather than just the date) to the
409 Last Refresh Time column of the Local Administration >
412 ===== Hours of Operation Note field =====
414 Adds a note field to each day's hours to record split hours or service related notes. The notes appear enclosed in parentheses next to each day's hours when viewing a library's hours in the Bootstrap OPAC and TPAC
416 ===== HTML email =====
418 Administrators can now configure action triggers to send HTML-formatted
419 email. Evergreen continues to send emails in plain-text by default, but
420 you can now configure an email template to send as HTML by adding the appropriate
421 header to the email. For example: Content-Type: text/html;charset=utf-8
423 ===== Match Quality Ratio Option Added to marc_stream_importer.pl =====
425 Command line options have been added to the marc_stream_importer.pl
426 support script to specify the match quality ratio used when matching
427 bibliographic or authority records for overlay:
429 * --bib-match-quality-ratio
430 * --auth-match-quality-ratio
432 These options specify the match quality ratio, as a decimal number
433 (i.e. 1.0), for overlay of records with the overlay on 1 match
434 options. They correspond to the similar options in the staff client
437 ===== Configuring sign-on to OpenAthens =====
440 ====== Purpose ======
442 If your institution uses OpenAthens, you can configure Evergreen to sign
443 patrons in to OpenAthens using their Evergreen account. This will let them
444 connect to OpenAthens resources seamlessly once they have logged in to
445 Evergreen. Patrons are assigned an OpenAthens identity dynamically based
446 on their Evergreen login, and do not need accounts created manually in
449 ====== Registering your Evergreen installation with the OpenAthens service ======
451 Using your OpenAthens administrator account at https://admin.openathens.net/,
452 complete the following steps:
454 . Register a local authentication connection for Evergreen:
455 .. Go to *Management* -> *Connections*.
456 .. Under *Local authentication* click *Create*.
457 .. In the wizard that appears, select *Evergreen* as the local authentication
458 system type (or *API* if Evergreen is not listed) and click *Configure*.
459 .. For *Display name*, enter the name of your Evergreen portal that your
460 patrons will be familiar with. They will need to be able to recognise and
461 select this name from a list of sign-in options on OpenAthens.
462 .. For *Callback URL* enter *https://<HOSTNAME>/eg/opac/sso/openathens* where
463 <HOSTNAME> is the public hostname of your Evergreen installation, and click
464 *Save*. (If you have installed Evergreen somewhere other than /eg, modify the
466 .. On the details page that appears, take a copy of the *Connection ID* and
467 *Connection URI* that have been generated. You will need these when
468 configuring Evergreen.
469 . Generate an API key:
470 .. Go to *Management* -> *API keys* and click *Create*.
471 .. For *Name*, enter 'Evergreen' or whatever name you use for your Evergreen
472 portal internally, and click *Save*.
473 .. Take a copy of the 36-character key that has been generated. You will need
474 this when configuring Evergreen.
476 Full OpenAthens documentation for local authentication API connections is
477 available at http://docs.openathens.net/display/public/MD/API+connector.
479 ====== Configuring Evergreen ======
481 OpenAthens sign-on is configured in the staff client under *Local
482 Administration* -> *OpenAthens Sign-on*. To make a connection, select *New
483 Sign-on to OpenAthens*, and set the values as follows:
485 * *Owner* - the organisation within your library hierarchy that owns the
486 connection to OpenAthens. If your whole consortium has signed up to OpenAthens
487 as a single customer, then you would select the top-level. If only one
488 regional library system or branch is the OpenAthens customer, select that.
489 Whichever organisation you select, the OpenAthens connection will take effect
490 for all libraries below it in your organisational hierarchy. A single
491 OpenAthens sign-on configuration normally equates to a single *domain* in the
492 OpenAthens service. If in doubt refer to your OpenAthens account manager or
493 implementation partner.
494 * *Active* - Enable this connection (enabled by default). N.B. Evergreen
495 does not support more than one active connection to OpenAthens at a time per
496 organisation. If more than one connection is added per organisation,
497 Evergreen will use only the _first_ connection that has *Active* enabled.
498 * *API key* - the 36-character OpenAthens *API key* that was generated in step
500 * *Connection ID* - the numerical *Connection ID* that was generated for the
501 OpenAthens local authentication connection in step 1 above.
502 * *Connection URI* - the *Connection URI* that was generated for the
503 OpenAthens local authentication connection in step 1 above.
504 * *Auto sign-on* - controls _when_ patrons are signed on to OpenAthens:
505 ** *enabled* (recommended) - As soon as a patron logs in to Evergreen, they
506 are signed in to OpenAthens. This happens via a quick redirect that the user
508 ** *disabled* - The patron is not signed in to OpenAthens to start with. When
509 they first access an OpenAthens-protected resource, they will need to search
510 for your institution at the OpenAthens log-in page and choose your Evergreen
511 portal as the sign-in method (they will see the name you entered as the
512 *Display name* in step 1 above). Evergreen will then prompt for log-in if
513 they have not already logged in. After that, they are signed in to OpenAthens
514 and OpenAthens redirects them to the resource.
515 * *Auto sign-out* - controls whether the patron is signed out of OpenAthens
516 when they log out of Evergreen. If *enabled* the patron will be sent to the
517 OpenAthens sign-out page when they log out of Evergreen. You can optionally
518 configure the OpenAthens service to send them back to your home page again
519 after this; the setting can be found at https://admin.openathens.net/ under
520 *Preferences* -> *Domain* -> *After sign out*.
521 * *Unique identifier field* - controls which attribute of patron accounts is
522 used as the unique identifier in OpenAthens. The supported values are 'id'
523 and 'usrname', but you should leave this set to the default value of 'id'
524 unless you have a reason to do otherwise. It is important that this attribute
525 does not change during the lifetime of a patron account, otherwise they would
526 lose any personalised settings they have saved on third party resources. It
527 is also important that you do not re-use old patron accounts for new users,
528 otherwise a new user could see personalised settings saved by an old user.
529 * *Display name field* - controls which attribute of patron accounts is
530 displayed in the OpenAthens portal at https://admin.openathens.net/. (This
531 is where you can see which accounts have been used, and what use patrons are
532 making of third party resources.) The supported values are 'id', 'usrname'
533 and 'fullname'. Whichever you choose, OpenAthens will only use it within
534 your portal view; it won't be released to third-party resources.
535 * *Release X* - one setting for each of the attributes that it is possible to
536 release to OpenAthens. Depending on your user privacy policy, you can
537 configure any of these attributes to be released to OpenAthens as part of
538 the sign-on process. None are enabled by default. OpenAthens in turn doesn't
539 store or release any of these attributes to third party resources, unless
540 you configure that separately in the OpenAthens portal. You have to
541 configure this in two stages. Firstly, mapping Evergreen attributes to
542 OpenAthens attributes, and secondly releasing OpenAthens attributes to third
543 party resources. See the OpenAthens documenation pages at
544 http://docs.openathens.net/display/public/MD/Attribute+mapping and
545 http://docs.openathens.net/display/public/MD/Attribute+release. You will need
546 to know the exact names of the attributes that are released. These are listed
547 in the following table:
550 |Setting|Attribute released|Description
554 |the patron's prefix, overriden by the preferred prefix if that is set
558 |the patron's first name, overriden by the preferred first name if that is set
562 |the patron's middle name, overriden by the preferred middle name if that is set
566 |the patron's last name, overriden by the preferred last name if that is set
570 |the patron's suffix, overriden by the preferred suffix if that is set
574 |the patron's email address
576 |Release home library
578 |the _shortcode_ of the patron's home library (e.g. 'BR1' in the Concerto
583 |the patron's barcode
586 Click 'Save' to finish creating the connection. (If you can't see the
587 connection you just created for a branch library, enable the "+ Descendants"
590 ====== Network access - server ======
592 As part of the sign-on process, Evergreen makes a connection to the OpenAthens
593 service to transfer details of the user that is signing on. This data does not
594 go via the user's browser, to avoid revealing the private API key and to avoid
595 the risk of spoofing. You need to open up port 443 outbound in your firewall,
596 from your Evergreen server to login.openathens.net.
598 ====== Network access - web client ======
600 If you restrict internet access for your web client machines, you need to open
601 up port 443 outbound in your firewall, from your web clients to the following
604 * connect.openathens.net
605 * login.openathens.net
606 * wayfinder.openathens.net
608 ====== Admin permissions ======
610 To delegate OpenAthens configuration to other staff users, assign the
611 *ADMIN_OPENATHENS* permission.
613 ===== Optionally allow patrons to renew after hitting fine maximum =====
615 When a patron hits the max fine limit, a standing penalty is applied to their account. By default, that penalty (PATRON_EXCEEDS_FINES)
616 is configured to block renewals.
618 This release adds a new org unit setting, _circ.permit_renew_when_exceeds_fines_. If enabled for a particular org unit, renewals are
619 permitted (as long as all other circulation eligibility criteria are met).
621 ===== Optionally remove traditional catalog from menu =====
623 Libraries that have fully migrated to the Angular staff catalog
624 may optionally hide the "Staff Catalog (Traditional)" menu
625 options. To do so, in the Library Settings Editor, set the
626 "ui.staff.traditional_catalog.enabled" setting to False.
628 After changing the setting, you will need to log out and log
629 back in to see the changes to the menu.
631 ==== Architecture ====
633 ===== (Developer-focused) Use ESLint for eg2 =====
635 The `eg2` Angular application now uses ESLint rather than TSLint for
636 source code linting. This is motivated by the deprecation of TSLint
637 by the Angular CLI, but ESLint also offer some improvements.
639 In particular, ESLint checks the HTML templates in addition to the
640 TypeScript code. For example, it will catch uses of `==` in the
641 templates when `===` is preferred.
643 The primary ESLint rules applied to the project are configured in
644 `Open-ILS/src/eg2/.eslintrc.json`. To override them for specific
645 directories, `.eslintrc` files can be used. An example of this
646 is `Open-ILS/src/eg2/src/app/share/.eslintrc`, which turns off
647 the `angular-eslint/no-output-on-prefix` check that discourages
648 using `onFoo` as the name of `@Output()` properties. This rule
649 is now enforced in most of `eg2`, but it was decided not to immediately
650 mandate for shared components.
652 The command to run the lint checks remains the same: from
653 `Open-ILS/src/eg2/`, run `ng lint`.
655 ===== Operating System Requirements =====
657 Evergreen 3.10 now supports installation on Ubuntu 22.04 (Jammy Jellyfish).
659 This release removes support for Debian Stretch and Ubuntu 18.04 (Bionic Beaver).
663 ===== Record Note Merges =====
665 During a merge of bibliographic records notes will now merge and a
666 notation on each added that they were originally from another record.
667 A note is also added that the merge was performed.
669 ==== Circulation ====
671 ===== Experimental Angular Circulation Interfaces =====
673 This Evergreen release includes new, experimental versions of many
674 circulation interfaces. To enable these interfaces:
676 . In the Library Settings Editor, enable the setting called
677 _Enable Angular Circulation Menu_.
678 . Add the _ACCESS_ANGULAR_CIRC_ permission to any users who
679 will be testing the experimental interfaces.
681 These interfaces are experimental, and should not be used for production
682 work. Please report any issues with the interfaces at
683 https://bugs.launchpad.net/evergreen
685 ===== New Patrons with Negative Balances interface =====
687 The _Patrons with Negative Balances_ interface has been re-implemented
690 ===== OPAC-visible statisitical categories are now visible in the OPAC =====
692 This release restores a previously available feature: the ability to
693 display statistical categories (stat cats) in the OPAC. If an
694 item stat cat has "OPAC Visibility" set to true, its values will
695 display in the record page's item table, underneath the call number.
696 If a patron stat cat has "OPAC Visibility" set to true, its values
697 will display in the patron's account under Preferences ->
698 Personal Information (below the account expiration date).
700 Since these values have not been visible for some time, Evergreen
701 libraries may wish to review them before making them public. To
702 set all stat cats to private, so that OPAC visibility can be
703 restored on a case-by-case basis after review, you can use the
709 UPDATE asset.stat_cat SET opac_visible=false WHERE opac_visible=true;
712 UPDATE actor.stat_cat SET opac_visible=false WHERE opac_visible=true;
715 ===== Renewal Due Date Extended to Cover Lost Time =====
717 When an item is renewed before it's due date, libraries now have the option
718 to extend the renewal's due date to include any time lost from the early
721 For example, a 14 day checkout renewed after 12 days will result in a due date
722 on the renewal of 14 days plus 2 days to cover the lost time.
724 ====== Settings ======
726 Two new fields are available under Admin => Local Administration =>
727 Circulation Policies.
729 *Early Renewal Extends Due Date*
731 Enables this new feature for a circulation policy.
733 *Early Renewal Minimum Duration Interval*
735 Specifies the amount of time a circulation has to be checked out before a
736 renewal will result in an extended due date.
738 For example, if you wanted to support due date extensions on 14-day checkout
739 renewals, but only if the item has been checked out at least 8 days, you
740 would enter "8 days" for the value of this field.
742 If no value is set for a given matchpoint that supports renewal extension,
743 all renewals using that matchpoint will be eligible.
745 ===== Override All Option when Placing Multiple Staff Holds =====
747 When placing multiple holds in the Angular Staff Catalog, staff users with permission to override the failed holds will see an Override All button which will perform all overrides at once.
749 Overriding each failed hold individually remains an option.
751 ===== Source library addresses now available on transit slips =====
753 Transit slip templates previously could include the address of
754 the library that the item is being transitted _to_. With this
755 release, the address of the library the item is being transitted
756 _from_ is also available.
757 This change applies to both the Hold Transit Slip and the Transit
760 ===== Courses can be un-archived =====
762 Course reserves staff can now un-archive a course that was previously archived, either from
763 its course page, or from the course list.
765 Un-archiving a course makes it active again. Users with public roles in the course (such
766 as instructors) remain associated with the course. Non-public users (such as students)
771 ===== Additional trailing punctuation removed from certain fields =====
773 MarcXML facet, display, and browse fields will undergo some extra
774 cleanup before displaying to a user. Of particular note for any
775 title fields that match these criteria, ending `/`, `:`, `;`, and
778 This change does not affect MODS fields. You can check if a
779 particular field uses MarcXML or MODS in Server Administration
780 -> MARC Search/Facet Fields by consulting the Format column.
783 ==== Miscellaneous ====
785 * The Field Documentation interface (under Local Administration) has
786 been ported to Angular with an org selector as an additional filter.
787 * The Pending Users and Bucket View grids in the User Buckets interface
788 now includes a column for the patron's balance owed. (LP#1980257)
789 * Patron Interface Gets a New Penalty Refresh Action. (LP#1823225)
790 * A new workstation setting optionally allows the full library name to be
791 added to the Angular Org Unit Selector. (LP#1771636)
792 * The tabs on the Claiming Administration page have been reordered to
793 Claim Policies, Claim Policy Actions, Claim Event Types, and Claim
794 Types. This reflects the fact that Claim Types tend to be configured
795 once and are not typically adjusted when setting up a new claim
797 * Links in the staff catalog summary area now open in a new tab. (LP#1953692)
798 * The Item Status list view now includes an optional column for
799 Total Circulations. (LP#1964629)
800 * The credit card payment approval code is now available as a column in
801 the bill history payments table in the patron record. (LP#1818303)
802 * The group member details grid now contains columns for preferred names.
804 * The patron profile name is now available to the Hold Shelf Slip
805 print template as `patron.profile.name`. (LP#1724032)
806 * Removed the Message Center from the Patron -> Other Menu (deprecated),
807 added action for unarchiving Notes, and added confirmation dialogs
808 for Remove Note, Archive Note, and Unarchive Note. (LP#1977877)
809 * Curbside request notes and user messages are now purged when a user
810 record is deleted. (LP#1934162)
811 * If the patron record has a preferred name set, the SIP server now
812 returns it in response to patron lookups. (LP#1984114)
813 * The label and description of the acq.fund.allow_rollover_without_money
814 library setting are updated for greater clarity (LP#1982031)
815 * The Cash Reports interface (under Local Administration) is ported to
816 Angular. (LP#1859701)
817 * The Library Settings Editor (under Local Administration) is ported to
818 Angular. (LP#1839341)
820 ==== Acknowledgments ====
822 The Evergreen project would like to acknowledge the following
823 organizations that commissioned developments in this release of
827 * Evergreen Community Development Initiative
828 * Equinox Open Library Initiative
829 * King County Library System
831 We would also like to thank the following individuals who contributed
832 code, translations, documentations patches and tests to this release of
849 * Blake Graham Henderson
864 * Andrea Buntz Neiman
878 We also thank the following organizations whose employees contributed
885 * Equinox Open Library Initiative
886 * Georgia Public Library Service
887 * Greater Clarks Hill Regional Library
888 * Kenton County Library
889 * King County Library System
890 * Lake Agassiz Regional Library
891 * Linn Benton Community College
895 * Princeton University
897 * Westchester Library System
899 We regret any omissions. If a contributor has been inadvertently
900 missed, please open a bug at http://bugs.launchpad.net/evergreen/