docs/RELEASE_NOTES_3_3.adoc

   1 Evergreen 3.3 Release Notes
   2 ===========================
   3 :toc:
   4 :numbered:
   5
   6 Evergreen 3.3.2
   7 ----------------
   8
   9 This release contains bug fixes improving on Evergreen 3.3.1.
  10 All bug fixes refer to the web staff client unless otherwise specified.
  11
  12 Bug fixes
  13 ~~~~~~~~~
  14
  15 Circulation
  16 ^^^^^^^^^^^
  17 * Corrects a rounding error that caused fines to exceed the max fines
  18 amount
  19 (https://bugs.launchpad.net/evergreen/+bug/1704819[Bug #1704819])
  20 * Corrects an issue with printing Items Out receipts
  21 (https://bugs.launchpad.net/evergreen/+bug/1790896[Bug #1790896])
  22 * SIP Visa payments are now recorded as credit card, rather than cash
  23 payments
  24 (https://bugs.launchpad.net/evergreen/+bug/1796942[Bug #1796942])
  25 * Converting change to patron credit no longer requires staff members
  26 to refresh the screen to see the new credit
  27 (https://bugs.launchpad.net/evergreen/+bug/1775639[Bug #1775639])
  28 * The patron summary now includes tooltips that were available in
  29 the XUL client
  30 (https://bugs.launchpad.net/evergreen/+bug/1772206[Bug #1772206])
  31 * The patron holds grid now includes a SMS Carrier column
  32 (https://bugs.launchpad.net/evergreen/+bug/1748265[Bug #1748265])
  33 * When registering a new patron from Pending Patrons, the address
  34 type dropdown now supports a default value
  35 (https://bugs.launchpad.net/evergreen/+bug/1816180[Bug #1816180])
  36 * The Items Out grid now includes a Monograph Parts column
  37 (https://bugs.launchpad.net/evergreen/+bug/1789257[Bug #1789257])
  38 * The annotate checkbox on the bill payment screen is now sticky
  39 (https://bugs.launchpad.net/evergreen/+bug/1759343[Bug #1759343])
  40 * Group member details grid settings can now be saved
  41 (https://bugs.launchpad.net/evergreen/+bug/1774707[Bug #1774707])
  42 * The patron registration date of birth field can now display a
  43 format example
  44 (https://bugs.launchpad.net/evergreen/+bug/1819181[Bug #1819181])
  45
  46 Cataloging
  47 ^^^^^^^^^^
  48
  49 * The MARC editor displays a warning when a cataloger attempts to
  50 close the tab without saving
  51 (https://bugs.launchpad.net/evergreen/+bug/1538678[Bug #1538678])
  52 * The MARC editor displays a warning when permissions issues
  53 prevent a record from saving
  54 (https://bugs.launchpad.net/evergreen/+bug/1693580[Bug #1693580])
  55 * The holdings editor saves default values more consistently
  56 (https://bugs.launchpad.net/evergreen/+bug/1812900[Bug #1812900])
  57 * The flat-text editor now uses a monospace font
  58 (https://bugs.launchpad.net/evergreen/+bug/1817601[Bug #1817601])
  59 * Statistical categories and their entries are now alphabetized in the
  60 holdings editor (Bugs
  61 https://bugs.launchpad.net/evergreen/+bug/1744386[Bug #1744386] and
  62 https://bugs.launchpad.net/evergreen/+bug/1777184[Bug #1777184])
  63 * The holdings editor now lists monograph parts in reverse alphabetical
  64 order
  65 (https://bugs.launchpad.net/evergreen/+bug/1760893[Bug #1760893])
  66 * Buckets created from the MARC Batch Import process are now available
  67 in the MARC Batch Edit interface
  68 (https://bugs.launchpad.net/evergreen/+bug/1440890[Bug #1440890])
  69 * The record bucket interface only displays the Merge action when
  70 multiple records are selected
  71 (https://bugs.launchpad.net/evergreen/+bug/1760599[Bug #1760599])
  72 * Fixes an issue with the displayed number of items out
  73 (https://bugs.launchpad.net/evergreen/+bug/1770217[Bug #1770217])
  74
  75 Client
  76 ^^^^^^
  77
  78 * Fixes conflicting dependency information caused be the release of
  79 Angular 8
  80 (https://bugs.launchpad.net/evergreen/+bug/1830972[Bug #1830972])
  81 * Angular grids include several new accessibility features and
  82 keyboard shortcuts
  83 (https://bugs.launchpad.net/evergreen/+bug/1816480[Bug #1816480])
  84 * The menu in the top right corner is now named "Logout and more..."
  85 (https://bugs.launchpad.net/evergreen/+bug/1796914[Bug #1796914])
  86 * Several dropdown menus now require less scrolling
  87 (https://bugs.launchpad.net/evergreen/+bug/1669120[Bug #1669120])
  88
  89
  90 Public Catalog
  91 ^^^^^^^^^^^^^^
  92
  93 * Avoids Internal Server Errors on search result page
  94 (https://bugs.launchpad.net/evergreen/+bug/1155706[Bug #1155706])
  95 * Double clicking the Place Hold button can no longer result in
  96 multiple holds
  97 (https://bugs.launchpad.net/evergreen/+bug/1029601[Bug #1029601])
  98
  99 Reports
 100 ^^^^^^^
 101
 102 * Adds a more user-friendly interface for boolean filters
 103 (https://bugs.launchpad.net/evergreen/+bug/1642337[Bug #1642337])
 104
 105 System administration
 106 ^^^^^^^^^^^^^^^^^^^^^
 107
 108 * Improves consistency in terminology in the Local Administration
 109 screen
 110 (https://bugs.launchpad.net/evergreen/+bug/1776913[Bug #1776913])
 111 * The Library Settings Editor now displays some example timezones
 112 for the lib.timezone setting
 113 (https://bugs.launchpad.net/evergreen/+bug/1817332[Bug #1817332])
 114
 115 Automated tests
 116 ^^^^^^^^^^^^^^^
 117 * Fixes an automated test related to translations and internationalization
 118 (https://bugs.launchpad.net/evergreen/+bug/1768987[Bug #1768987])
 119
 120 Database
 121 ^^^^^^^^
 122
 123 * Adds some foreign key functions that may be missing from your database
 124 (https://bugs.launchpad.net/evergreen/+bug/1772028[Bug #1772028])
 125
 126
 127 Acknowledgments
 128 ~~~~~~~~~~~~~~~
 129 We would like to thank the following individuals who contributed code,
 130 testing and documentation patches to the 3.3.2 point release of
 131 Evergreen:
 132
 133 * John Amundson
 134 * a. bellenir
 135 * Jason Boyer
 136 * Galen Charlton
 137 * Garry Collum
 138 * Dawn Dale
 139 * Jeff Davis
 140 * Bill Erickson
 141 * Jason Etheridge
 142 * Lynn Floyd
 143 * Jeff Godin
 144 * Rogan Hamby
 145 * Kyle Huckins
 146 * Sam Link
 147 * Terran McCanna
 148 * Michele Morgan
 149 * Bill Ott
 150 * Suzanne Paterno
 151 * Dan Pearl
 152 * Mike Risher
 153 * Geoff Sams
 154 * Janet Schrader
 155 * Remington Steed
 156 * Jason Stephenson
 157 * Josh Stompro
 158 * Cesar Velez
 159 * Dan Wells
 160
 161
 162 Evergreen 3.3.1
 163 ---------------
 164
 165 This release contains bug fixes improving on Evergreen 3.3.0.
 166
 167 Bug fixes
 168 ~~~~~~~~~
 169
 170 General
 171 ^^^^^^^
 172
 173 * Fixes a compatibility problem with the Item Status screen related to
 174   JavaScript arrow functions
 175   (https://bugs.launchpad.net/evergreen/+bug/1821196[Bug #1821196])
 176
 177 Booking
 178 ^^^^^^^
 179
 180 * Fixes a bug in the Booking URL path that failed with newer Apache
 181   (https://bugs.launchpad.net/evergreen/+bug/1823387[Bug #1823387])
 182
 183 Circulation
 184 ^^^^^^^^^^^
 185
 186 * Fixes a display bug with the patron record Group Members list
 187   (https://bugs.launchpad.net/evergreen/+bug/1642036[Bug #1642036])
 188 * Fixes title sort on the patron Items Out Screen
 189   (https://bugs.launchpad.net/evergreen/+bug/1782014[Bug #1782014])
 190 * Fixes a refresh bug on the catalog record Holds View tab when moving between
 191   records (https://bugs.launchpad.net/evergreen/+bug/1792188[Bug #1792188])
 192 * Fixes the ability to place holds from item buckets
 193   (https://bugs.launchpad.net/evergreen/+bug/1806394[Bug #1806394])
 194
 195 Cataloging
 196 ^^^^^^^^^^
 197
 198 * Fixes a bug where copy templates would not apply properly
 199   (https://bugs.launchpad.net/evergreen/+bug/1788680[Bug #1788680])
 200 * Fixes the default cursor focus on the holdings editor
 201   (https://bugs.launchpad.net/evergreen/+bug/1752968[Bug #1752968])
 202 * Fixes a bug with Postgres 10 support related to MARC Batch Import/Export
 203   (https://bugs.launchpad.net/evergreen/+bug/1820339[Bug #1820339])
 204 * Fixes a bug in the new MARC Import/Export related to Record Match Set
 205   expressions (https://bugs.launchpad.net/evergreen/+bug/1823982[Bug #1823982])
 206 * Fixes a bug that failed to honor the "Retain empty bib records"
 207   (cat.bib.keep_on_empty) setting when transferring items
 208   (https://bugs.launchpad.net/evergreen/+bug/1333893[Bug #1333893])
 209 * Fixes a bug that failed to include deleted bib records in TCN search
 210   (https://bugs.launchpad.net/evergreen/+bug/1813633[Bug #1813633])
 211
 212 System administration
 213 ^^^^^^^^^^^^^^^^^^^^^
 214
 215 * Added database indexes to speed up purging of Action Trigger event output
 216   fields (https://bugs.launchpad.net/evergreen/+bug/1778940[Bug #1778940])
 217 * Fixes the help text in action_trigger_aggregator.pl related to the remote-acct
 218   argument (https://bugs.launchpad.net/evergreen/+bug/1803729[Bug #1803729])
 219 * Adds a missing page title for the Closed Dates Editor
 220   (https://bugs.launchpad.net/evergreen/+bug/1814943[Bug #1814943])
 221 * Adds a missing page title for the Statistical Popularity Badges admin page
 222   (https://bugs.launchpad.net/evergreen/+bug/1826890[Bug #1826890])
 223 * Changes the direction of column sort indicators in the new Angular grids
 224   (https://bugs.launchpad.net/evergreen/+bug/1825578[Bug #1825578])
 225 * Adds Hatch printing support to the new Angular screens
 226   (https://bugs.launchpad.net/evergreen/+bug/1793005[Bug #1793005])
 227
 228
 229 Acknowledgments
 230 ~~~~~~~~~~~~~~~
 231 We would like to thank the following individuals who contributed code,
 232 testing and documentation patches to the 3.3.1 point release of
 233 Evergreen:
 234
 235 * John Amundson
 236 * Jason Boyer
 237 * Galen Charlton
 238 * Garry Collum
 239 * Jeff Davis
 240 * Bill Erickson
 241 * Jason Etheridge
 242 * Blake Graham-Henderson
 243 * Rogan Hamby
 244 * Millissa Macomber
 245 * Katie G. Martin
 246 * Terran McCanna
 247 * Mike Rylander
 248 * Jane Sandberg
 249 * Janet Schrader
 250 * Dan Scott
 251 * Ben Shum
 252 * Remington Steed
 253 * Jason Stephenson
 254 * Josh Stompro
 255 * Dan Wells
 256 * Beth Willis
 257 * John Yorio
 258
 259
 260 3.3.0 Upgrade notes
 261 -------------------
 262
 263 Migrating Parent/guardian information
 264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 265 Sites who traditionally store parent/guardian information in the
 266 patron 'Secondary Identification' field can migrate values from this
 267 field to the new guardian field with the following SQL:
 268
 269 [source,sql]
 270 -------------------------------------------------------------------------
 271 BEGIN;
 272
 273 -- 1. Find the local ID of the parent/guardian identification type
 274
 275 SELECT * FROM config.identification_type;
 276
 277 -- 2. On my test system, the id is "101".  It will vary!.
 278 -- Migrate the value from the ident2 field to the guardian field.
 279
 280 UPDATE actor.usr
 281     SET guardian = ident_value2
 282 WHERE
 283     ident_type2 = 101 -- !! CHANGE TO SUIT
 284     AND ident_value2 IS NOT NULL
 285     AND ident_value2 <> '';
 286
 287 -- 3. delete the original secondary identification data
 288
 289 UPDATE actor.usr
 290     SET ident_value2 = NULL, ident_type2 = NULL
 291 WHERE
 292     ident_type2 = 101; -- !! CHANGE TO SUIT
 293
 294 COMMIT;
 295 -------------------------------------------------------------------------
 296
 297
 298 Upgrading PostgreSQL
 299 ~~~~~~~~~~~~~~~~~~~~
 300 Evergreen now supports PostgreSQL 9.6 and 10.
 301 If you upgrade your database from a PostgreSQL version of 9.5, or
 302 lower, to PostgreSQL versions 9.6 or 10, you will need to recreate 3
 303 indexes in additon to the normal database upgrade steps.  The index
 304 recreation is necessary because of changes to the PostgreSQL
 305 `unaccent` extension module.
 306
 307 The following snippet of SQL code will do the necessary steps:
 308
 309 [source,sql]
 310 ------------------------------------------------------------------------
 311 DROP INDEX actor_usr_first_given_name_unaccent_idx;
 312 DROP INDEX actor_usr_second_given_name_unaccent_idx;
 313 DROP INDEX actor_usr_family_name_unaccent_idx;
 314 CREATE INDEX actor_usr_first_given_name_unaccent_idx ON actor.usr
 315       (evergreen.unaccent_and_squash(first_given_name));
 316 CREATE INDEX actor_usr_second_given_name_unaccent_idx ON actor.usr
 317       (evergreen.unaccent_and_squash(second_given_name));
 318 CREATE INDEX actor_usr_family_name_unaccent_idx ON actor.usr
 319       (evergreen.unaccent_and_squash(family_name));
 320 ------------------------------------------------------------------------
 321
 322
 323 3.3.0 New Features
 324 ------------------
 325
 326 Administration
 327 ~~~~~~~~~~~~~~
 328
 329 Include Item Status in marc_export Items Export
 330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 331 The marc_export script now includes the item status in the 852 subfield s when exporting items.
 332
 333 Ability to Reingest Certain Record Attributes In pingest.pl
 334 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 335 An option, `--attr`, has been added to the `pingest.pl` support script
 336 that allows the user to specify which record attributes to reingest.
 337 It can be used one or more times to specify one or more attributes to
 338 ingest.  It can be omitted to reingest all record attributes.  This
 339 option is ignored if the `--skip-attrs` option is used.
 340
 341 The `--attr` option is most useful after doing something specific that
 342 requires only a partial ingest of records.  For instance, if you add a
 343 new language to the `config.coded_value_map` table, you will want to
 344 reingest the `item_lang` attribute on all of your records.  The
 345 following command line will do that, and only that, ingest:
 346
 347 ----
 348 $ /openils/bin/pingest.pl --skip-browse --skip-search --skip-facets \
 349     --skip-display --attr=item_lang
 350 ----
 351
 352
 353
 354 Architecture
 355 ~~~~~~~~~~~~
 356
 357 Database Support for PostgreSQL 10
 358 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 359 The Evergreen database can now be built with PostgreSQL version 10.
 360
 361 This update has implications for developers who write PgTap tests.  In
 362 versions of PostgreSQL prior to 10, one could write `\set ECHO` to
 363 disable the echoing of commands as they were run.  In PostgreSQL
 364 version 10, using `\set` without a value is an error.  One should now
 365 write `\set ECHO none` in order to disable the echoing of commands.
 366 This latter form works in all versions of PostgreSQL currently
 367 supported by Evergreen.
 368
 369
 370
 371 Ubuntu 18.04 Bionic Beaver
 372 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 373 Evergreen can now be installed on Ubuntu 18.04 Bionic Beaver.  To
 374 install the prerequisites, use ubuntu-bionic as the Makefile.install
 375 target.
 376
 377 This update also fixes a Perl warning in the HoldNotify module that is
 378 an error in the version of Perl (5.26) that is installed on Ubuntu
 379 18.04.
 380
 381
 382
 383
 384 Cataloging
 385 ~~~~~~~~~~
 386
 387 MARC Import/Export Interface Update (Angular Port)
 388 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 389 This MARC Import/Export (AKA Vandelay) interface is now built on
 390 Angular(7) instead of Dojo.  The functionality is consistent with the
 391 previous version of the interface, with minor UI adjustments to match
 392 the Angular style, plus one new interface called 'Recent Imports'.
 393
 394 Import Templates
 395 ++++++++++++++++
 396 Users may now save sets of import attributes from the MARC import form as
 397 named templates.  Users may select a default template, applied on page load
 398 by default, and users may delete existing templates.
 399
 400 Recent Imports Tab
 401 ++++++++++++++++++
 402 This is a new interface which allows users to see active and recent
 403 Vandelay sesssions originating from the same workstation or logged in
 404 user account.  Active sessions include real-time progress information so
 405 the user may track the progress without refreshing the page.
 406
 407 This interface makes it possible to exit the main import tab or the
 408 Vandelay interface altogether and return at a later time to check on
 409 import progress.  It also allows users to start multiple imports at
 410 the same time and follow the status of each in one interace.
 411
 412
 413 Spine Label Sheet Printing
 414 ++++++++++++++++++++++++++
 415
 416 Catalogers can now print spine labels onto 8 1/2 x 11 inch label sheets.
 417
 418
 419 Circulation
 420 ~~~~~~~~~~~
 421
 422 Patron Parent/Guardian Field
 423 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 424 Patrons now have a new dedicated parent/guardian field.  This field is
 425 editable in the patron edit interface, displays in the patron
 426 summary side bar on the browser client, and is search-able from the
 427 patron search interface in the browser client.
 428
 429 Patron Editor
 430 +++++++++++++
 431 In addition to the standard "show" and "suggest" visibility settings,
 432 the new guardian field comes with a library setting
 433 'ui.patron.edit.guardian_required_for_juv' ("GUI: Juvenile account
 434 requires parent/guardian").  When this setting is applied, a value
 435 will be required in the patron editor when the juvenile flag is active.
 436
 437 Allow Others to Use My Account (Privacy Waiver)
 438 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 439 Patrons who wish to authorize other people to use their account may
 440 now do so via My Account.  In the Search and History Preferences tab
 441 under Account Preferences, a new section labeled "Allow others to use
 442 my account" allows patrons to enter a name and indicate that the
 443 specified person is allowed to place holds, pickup holds, view
 444 borrowing history, or check out items on their account.  This
 445 information is displayed to circulation staff in the patron account
 446 summary in the web client.  (Staff may also add, edit, and remove
 447 entries via the patron editor.)
 448
 449 A new library setting, "Allow others to use patron account (privacy
 450 waiver)," is used to enable or disable this feature.
 451
 452
 453
 454 Client
 455 ~~~~~~
 456
 457 Server and Booking Administration Moved To Angular
 458 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 459 The Administration => Server Administration and
 460 Administration => Booking Administration pages have been ported to
 461 Angular using the new Angular grids.  Entry points from both AngularJS
 462 and Angular web clients point to the new interfaces.
 463
 464 Option to Enable Experimental Angular Staff Catalog
 465 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 466 A new org unit setting labeled 'GUI: Enable Experimental Angular
 467 Staff Catalog' (ui.staff.angular_catalog.enabled) has been added, allowing
 468 sites to enable a menu option in the browser client for accessing
 469 the experimental Angular staff catalog.
 470
 471 When set to true, a new entry in the navigation bar appears in the
 472 Cataloging menu labled "Staff Catalog (Experimental)".
 473
 474 New Features (Since 3.2)
 475 ++++++++++++++++++++++++
 476  * Pub date filter
 477  * Copy location filter
 478  * Group formats and editions
 479  * Identifier search
 480  * MARC search
 481  * Browse search
 482  * Place holds
 483  * Record baskets and actions
 484  * Record detail tabs/actions point to AngularJS versions where needed.
 485  * Record detail View In Catalog button
 486
 487
 488
 489 OPAC
 490 ~~~~
 491
 492 View upcoming booking reservations in the OPAC
 493 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 494 A new tab in the My Account section of the OPAC shows
 495 patrons information about reservations on their account.
 496 Here, patrons can check on upcoming reservations, as
 497 well as reservations they currently have checked out.
 498
 499 Note: this interface pulls its timezone from the Library
 500 Settings Editor.  Make sure that you have a timezone
 501 listed for your library in the Library Settings Editor
 502 before using this feature.
 503
 504 Display UPC as Option for Public Catalog Advanced Search
 505 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 506 The Numeric Search tab of the public catalog Advanced Search
 507 now includes an option to search by UPC (Universal Product Code).
 508
 509
 510
 511 3.3.0 Acknowledgments
 512 ---------------------
 513 The Evergreen project would like to acknowledge the following
 514 organizations that commissioned developments in this release of
 515 Evergreen:
 516
 517 * King County Library System (KCLS)
 518 * MassLNC Evergreen Development Initiative
 519 * Pennsylvania Integrated Library System (PaILS)
 520
 521 We would also like to thank the following individuals who contributed
 522 code, translations, documentations patches and tests to this release of
 523 Evergreen:
 524
 525 * Adam Bowling
 526 * Steve Callender
 527 * Eva Cerninakova
 528 * Jeff Davis
 529 * Jason Etheridge
 530 * Bill Erickson
 531 * Rogan Hamby
 532 * Kathy Lussier
 533 * Terran McCanna
 534 * Andrea Buntz Neiman
 535 * Jennifer Pringle
 536 * Jane Sandberg
 537 * Chris Sharp
 538 * Ben Shum
 539 * Remington Steed
 540 * Jason Stephenson
 541 * Anahi Valdez
 542 * Dan Wells
 543 * Stephen Woidowski
 544 * John Yorio
 545
 546
 547 We also thank the following organizations whose employees contributed
 548 patches:
 549
 550 * BC Libraries Cooperative
 551 * Catalyte
 552 * CW MARS
 553 * Emerald Data Networks
 554 * Equinox Open Library Initiative
 555 * Georgia PINES
 556 * King County Library System
 557 * Linn-Benton Community College
 558 * MassLNC
 559
 560 We regret any omissions.  If a contributor has been inadvertently
 561 missed, please open a bug at http://bugs.launchpad.net/evergreen/
 562 with a correction.