docs/RELEASE_NOTES_2_4.txt

   1 Evergreen 2.4 Beta1 Release Notes
   2 =================================
   3 :toc:
   4 :numbered:
   5
   6 Upgrade notes
   7 -------------
   8
   9 Custom Toolbar Permissions
  10 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  11 With the addition of more granular permissions for configuring a custom
  12 toolbars, the ADMIN_TOOLBAR permission alone will not allow users to
  13 configure a custom toolbar. This permission must now be used in conjunction
  14 with one or more of the following permissions:
  15
  16 * ADMIN_TOOLBAR_FOR_ORG
  17 * ADMIN_TOOLBAR_FOR_USER
  18 * ADMIN_TOOLBAR_FOR_WORKSTATION
  19
  20 New features
  21 ------------
  22
  23 Acquisitions
  24 ~~~~~~~~~~~~
  25
  26 Acquisitions Inline Item Detail View
  27 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  28
  29 Acquisitions selection lists and purchase order interfaces contain a new link
  30 beside each lineitem which, when clicked, creates an inline grid of copies
  31 linked to the lineitem.  The grid contains the same information that displays
  32 in the full copy edit grid (from clicking on the Copies(n) link).  However,
  33 the inline grid is read-only, so it displays much faster and does not require
  34 the user to change visual contexts.
  35
  36 Included along the top of the lineitem table is a new 'Expand All' link which,
  37 when clicked, expands or collapses the inline grid for all visible lineitems.
  38
  39 Acquisitions Lineitem Order Identifiers
  40 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  41
  42 Staff now have the ability to specify the identifier value to use for
  43 lineitems when communicating order information to vendors.  This is
  44 particularly important when a lineitem has, for example, multiple ISBNs.
  45 Determining which ISBN is to act as the "order identifier" allows staff
  46 to provide the most accurate order information to vendors.
  47
  48 Supported identifier types include ISBN, ISSN, and UPC.  Order identifier
  49 values are relayed to vendors via EDI and print PO.
  50
  51 Permissions
  52 +++++++++++++
  53 Two new permissions are added for this feature:
  54
  55  * ACQ_SET_LINEITEM_IDENTIFIER
  56   ** Allows staff to apply order identifiers to lineitems
  57  * ACQ_ADD_LINEITEM_IDENTIFIER
  58   ** Implies that new identifiers shall be added to linked bib records,
  59      when a linkage exists.
  60
  61 Acquisitions Purchase Order and other Interface Improvements
  62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  63
  64 Feature Summary
  65 +++++++++++++++
  66
  67 The following features, which primarily affect the user interface layer,
  68 improve Acquisitions work flows.
  69
  70   * Avoid double-activation of POs
  71   * Disable invoice and cancel options for pending POs
  72   * Disable zero-copy checkbox for activated POs
  73   * Disable new charges for activated POs
  74   * Replace "Shelving Location" with Copy Location
  75
  76   * Rearranging "actions" drop-down
  77     ** More consistency in actions applying to selected lineitems specifically
  78     ** Things moved from the per-lineitem dropdown to the main one when
  79        sensible.
  80     ** Add to PO dialog added
  81     ** You can no longer add lineitems to a PO if they're already on one.
  82     ** Actions in dropdown now enabled/disabled differently depending on
  83        the interface where it appears (PO vs Selection List vs Acq Search etc.)
  84
  85   * Batch update for line items
  86      ** Apply updates to all copies of all selected line items at once
  87      ** Relies on a middle layer method that streams back information that
  88         would suit a more asynchronous display in the future (rather than
  89         simply reloading the page upon success, which it does now)
  90      ** For failure cases, specific information about which line item cannot
  91         be updated, and why, is available to the client, although taking
  92         best advantage of this information for user-friendly display is left
  93         to the future.
  94   * Add optional fund, circ modifier and collection code fields to distribution
  95   formulas.
  96   * The invoices interface auto-populates "# Invoiced" column with number of
  97   invoicable copies, and copies the "billed cost" column to the "amount paid"
  98   column if the latter doesn't have anything in it yet.
  99
 100 Acquisitions MARC Upload Form Persistence
 101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 102 Adds a two-layer persistence mechanism for the acquisitions MARC file upload
 103 interface.  A set of org unit settings now exist for managing default values
 104 for the interface.  Additionally, for each field where no org unit setting
 105 value is configured, the last-used value will be persisted locally and re-
 106 used with subsequent loads of the interface.
 107
 108 Default Number of Acquisitions Copies to Order
 109 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 110 Acquisitions providers have a new "Default # Copies" field.  When the value
 111 is set, this number of copies will be automatically added to each lineitem
 112 added to a purchase order for the provider.  This takes place during PO
 113 creation from a selection list or existing bib record and when a lineitem is
 114 added to an existing purchase order.  If a lineitem already has copies
 115 attached, no default copies are added.
 116
 117 OPAC
 118 ~~~~
 119
 120 Removal of JSPAC
 121 ^^^^^^^^^^^^^^^^
 122 TPAC is now the default catalog in Evergreen. The default apache configuration
 123 now points to TPAC, staff client OPAC options now point to TPAC, and the JSPAC
 124 to TPAC toggle has been removed from the portal page.
 125
 126 Display alternate graphic (880) fields
 127 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 128
 129 By default, Evergreen displays alternate graphic fields, if any, for
 130 contributors (1xx / 7xx), titles (245), edition statements (250), imprints
 131 (260), notes (5xx), subjects (6xx), and series (4xx / 8xx) in search results and record details
 132 per the Library of Congress MARC21 specifications:
 133
 134 * http://www.loc.gov/marc/bibliographic/bd880.html
 135 * http://www.loc.gov/marc/bibliographic/ecbdcntf.html
 136 * http://www.loc.gov/marc/bibliographic/ecbdmulti.html (Model A)
 137
 138 Default display
 139 +++++++++++++++
 140 In general, alternate graphic fields display below the corresponding
 141 primary field. One exception is the attribution summary on the record details
 142 page, in which the alternate graphic field contents display between the
 143 primary field content and the attribution statement. To support CSS
 144 customizations, HTML elements for the graphic fields have the class attribute
 145 value `graphic880`.
 146
 147 MARC21 Feeds from OpenSearch
 148 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 149 In addition to the already supported formats, you can now get raw MARC21 from
 150 OpenSearch feeds, à la:
 151
 152     http://<host>/opac/extras/opensearch/1.1/-/marc21?searchTerms=piano
 153
 154
 155 Options to Hide Some User Preferences
 156 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 157 The config.tt2 file now provides options to disable phone notification options, password changes, and e-mail address changes in TPAC. These options are useful
 158 for libraries that do not do phone notifications and for those that use
 159 centralized authentication.
 160
 161 Note the ability to disable user name changes is already available through the
 162 Library Settings editor.
 163
 164 Public Copy Notes
 165 ^^^^^^^^^^^^^^^^^
 166 Public copy notes are now visible in TPAC.
 167
 168 Search Changes
 169 ^^^^^^^^^^^^^^
 170 A number of changes have been made to search to allow more control and improve
 171 performance. These changes and their associated configurations are global to
 172 the entire system and can not be configured on a per-library basis.
 173
 174 Amongst other things the new search code fixes:
 175
 176 * Invalid queries being generated from advanced searches
 177 * Some timeouts from backend code taking too long to perform a search
 178 * Some filters being one-use only
 179 * Negations not working properly where multiple indexes are involved
 180
 181 Improvements include:
 182
 183 * Exact matches on input should be more likely to float to the top of results
 184 * Non-English stemming can be used, alongside or instead of English stemming
 185 * Entered search terms can be found across multiple indexes
 186
 187 Default configuration is geared towards English but is easily changed. In a
 188 production environment changes will likely require re-indexing, however.
 189
 190 The upgrade script could be pre-tweaked to install desired configuration before
 191 it builds and/or re-builds many of the indexes.
 192
 193 Permissions
 194 +++++++++++
 195 One new permission is added for this feature:
 196
 197   * ADMIN_INDEX_NORMALIZER
 198
 199 Searching for deleted records
 200 +++++++++++++++++++++++++++++
 201 Evergreen now supports searching for deleted records via the '#deleted'
 202 QP modifier.
 203
 204 In order to support this, sites must enable the
 205 'ingest.metarecord_mapping.preserve_on_delete' internal flag.  It is off by
 206 default since the ability to search for deleted records requires keeping
 207 metarecord mappings around when bibs are deleted, which may not be desirable
 208 for the typical site.
 209
 210 Two new QP filters: create_date and edit_date
 211 +++++++++++++++++++++++++++++++++++++++++++++
 212 These filter on the fields of the same name in biblio.record_entry.
 213
 214 e.g.
 215
 216   * create_date(,2013-02-01)  =>  records created before 2013-02-01
 217   * create_date(2013-02-01)   =>  records created since 2013-02-01
 218   * create_date(2013-02-01,2013-02-28)  =>  records created in Feb 2013
 219   * create_date(yesterday)    =>  records since created yesterday
 220
 221 Show local call number in TPAC My Lists display
 222 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 223 If an opac-visible call number exists that is owned by an org unit
 224 relevant to the patron, show the most relevant call number label
 225 and owning branch name in the My Lists display for each record in
 226 the list.  Call number is displayed in both saved and temporary lists.
 227
 228 A call number is considered relevant if its owner is one of:
 229
 230 physical location library
 231 preferred library (plib, home, etc.)
 232 search library
 233
 234 If no relevant call number is found, no call number is displayed.
 235
 236 TPAC Google Books preview
 237 ^^^^^^^^^^^^^^^^^^^^^^^^^
 238 Setting `ctx.google_books_preview` to `1` in the TPAC `config.tt2`
 239 configuration file will cause the TPAC to check to see, as part of the record
 240 details view, if Google Books has an online preview available. If it does,
 241 then a preview button will be displayed in the book cover image location.
 242 If the user then clicks the preview button, the preview will load below the
 243 title of the book in the record details page.
 244
 245 By default, this functionality is disabled to protect the privacy of users
 246 who might not want to share their browsing behavior with Google.
 247
 248 TPAC Org Unit Hiding
 249 ^^^^^^^^^^^^^^^^^^^^
 250 Adds support for the opac.org_unit_hiding.depth org unit setting to
 251 TPAC, which makes out-of-scope org units disappear (except when
 252 explicitly requested).
 253
 254 Org unit hiding is based on the physical_loc (Physical Location) param /
 255 cookie, which is the closest analog to 'ol' (original location), from
 256 which it was based in the JSPAC.
 257
 258 UI Changes
 259 ++++++++++
 260
 261  * All search org unit selectors
 262  * Holds pickup lib selector
 263  * Copy summary in search results page
 264  * Copy list in search results page
 265  * Copy summary in record detail page (which controls the copy grid).
 266  * Hold summary in record detail page
 267
 268 Cataloging
 269 ~~~~~~~~~~
 270
 271 MARC Import Tag Stripping
 272 ^^^^^^^^^^^^^^^^^^^^^^^^^
 273 Administrators can configure MARC tags which are removed from MARC records
 274 imported via Z39.50 and the Vandelay MARC Import/Export UI (ACQ and non-ACQ).
 275 Tags are organized into groups.  Groups can be marked as optional or required.
 276 For each tag, every instance of the tag (including all subfields) are removed
 277 from the record.
 278
 279 MARC fields which are contained within required ('always_apply') tag groups
 280 are always removed from inbound records.  No action is needed.  Tag groups
 281 which are optional will appear in MARC import interfaces (see below) allowing
 282 staff to select which groups of tags to strip from incoming records at import
 283 time.
 284
 285 Interfaces Affected
 286 +++++++++++++++++++
 287
 288  * Admin UI
 289   ** Admin => Server Administration => MARC Import Remove Fields
 290  * Z39.50 Import
 291   ** Cataloging => Import Record from Z39.50
 292   ** Optional groups appear with the other import options
 293  * Vandelay
 294   ** Cataloging => MARC Import/Export (Vandelay)
 295   ** Acquisitions => Load Order Records
 296   ** Optional groups appear with the other import options
 297
 298 Permissions
 299 +++++++++++
 300 Three new permissions are added for this feature:
 301
 302   * CREATE_IMPORT_TRASH_FIELD
 303   * UPDATE_IMPORT_TRASH_FIELD
 304   * DELETE_IMPORT_TRASH_FIELD
 305
 306 Vandelay Default Match Set
 307 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 308 A new org unit setting to specify a default Record Match Set when
 309 importing MARC records through the MARC Batch Import/Export interface. It does
 310 not affect the default match set selected in acquisitions. If this
 311 is set, it will not be possible to leave the Record Match Set field blank;
 312 it may be necessary to define a default match set that replicates the current
 313 default behavior.
 314
 315 A new "Vandelay" org unit settings group is also created.
 316
 317 Direct access to Item Attribute Editor
 318 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 319 You can now access the item attribute editor via Admin -> Local Admin -> Item
 320 Attribute Editor. No copy record is loaded into the editor, but it is available to without first finding an item and loading it into the editor:
 321
 322   * Configure copy templates.
 323   * Hide fields in the copy editor.
 324
 325 Circulation
 326 ~~~~~~~~~~~
 327
 328 Clickable Patron Indicators
 329 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 330 When retrieving a patron record, staff can now click on the indicators listed
 331 beneath the patron's name and launch the related tabs.
 332
 333 For example, clicking on (See Notes) will open the associated patron's notes.
 334
 335 "Warn patrons when their account is about to expire"
 336 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 337 To give staff the ability to warn patrons when their account is about to
 338 expire, the staff client can display an alert message on the patron information
 339 window.  A new library setting, `Warn patrons when their account is about to
 340 expire` in the *Circulation* section of the *Library Settings Editor*,
 341 determines how many days in advance of a patron's account expiry date the alert
 342 should be displayed. By default, warnings about upcoming patron account expiry
 343 dates are not displayed.
 344
 345 Show Hold Patron Name in TPAC
 346 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 347 When looking up patron information for hold placement via the staff client in
 348 TPac, the hold patron name is now shown next to the entered barcode. In the
 349 event that the barcode is not found, a notice is displayed and the submit
 350 button is disabled until a valid barcode is entered or the staff member is
 351 switched to.
 352
 353 Show Holds On Bib Menu Option
 354 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 355 Add direct "Show holds on bibs" menu option from item checkin, item status,
 356 and patron hold interfaces. This gives staff a quicker way of viewing who
 357 else has holds on an item instead of having to click an option to view the
 358 bib record, then clicking into the menus to view holds.
 359
 360 Administration
 361 ~~~~~~~~~~~~~~
 362
 363 Calculated Proximity Adjustments
 364 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 365 Allows customization to the way that Evergreen measures the distance between
 366 org units for the purposes of 1) determining what copy at what org unit is best
 367 suited for targeting a title-level hold, and 2) determining what hold is best
 368 suited for fulfillment by a copy-in-hand at capture (checkin) time.  The
 369 customization is based on a table 'actor.org_unit_proximity_adjustment', with
 370 certain matching criteria that the system compares to properties of the holds
 371 and copies in question.
 372
 373 Permissions
 374 +++++++++++
 375 One new permission is added for this feature:
 376
 377   * ADMIN_PROXIMITY_ADJUSTMENT
 378     ** Allows staff to administer the proximity adjustments
 379
 380
 381 Custom best-hold selection sort order
 382 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 383 The ranking algorithm that chooses the best hold to target a copy in
 384 hand at a capture time used to be fairly simple.  It had two modes, FIFO
 385 and not-FIFO, and that was it.
 386
 387 This change allows full configuration of that algorithm.  In other
 388 words, when the system captures a copy and sets out to evaluate what
 389 hold, if any, that copy might best fulfill, site staff of sufficient
 390 permission level are now empowered to choose exactly which comparisons
 391 the systems makes in what order.  This gives said staff much greater
 392 flexibility than they have today over holds policy.
 393
 394 For more information, see the included tech spec documents.
 395
 396 Permissions
 397 +++++++++++
 398 One new permission is added for this feature:
 399
 400   * ADMIN_HOLD_CAPTURE_SORT
 401     ** Allows staff to adminster the custom best-hold selection sort order.
 402
 403 Generic CSV Notification Generator/Receiver
 404 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 405
 406 New Action/Trigger template and sample event definitions for creating a CSV
 407 export file for various patron actions, primarily for the purpose of creating
 408 patron notices via external notification mechanisms.
 409
 410 The reference implementation for this development is the TalkingTech iTiva
 411 product, which consumes CSV files for generating phone/text notifications and
 412 produces CSV results files for informing the ILS of notification statuses.
 413 The template and send/receive scripts, however, should be generic enough to
 414 create CSV for any type of 3rd-party notification product.
 415
 416 For more information, see the included tech spec documents.
 417
 418 Storing Z39.50 Server Credentials
 419 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 420
 421 In the Z39.50 configuration interface, staff now have the option to apply
 422 z39.50 login credentials to each Z39.50 server at different levels of the
 423 org unit hierarchy (similar to org unit settings).  When credentials are set
 424 for a Z39 server, searches against the z39 server will used the stored
 425 credentials, unless other credentials are provided by the caller, in which
 426 case the caller credentials are used.
 427
 428 For security purposes, passwords may not be retrieved or reported on by staff.
 429 Staff can only apply new values for credentials or clear existing ones.
 430
 431 URL Verification
 432 ^^^^^^^^^^^^^^^^
 433 In order to support verification of URLs, Evergreen now has several new
 434 capabilities, and extensions to some existing features.
 435
 436 A wizard-style interface that walks a staff member through the process of collecting records and URLs to verify, verifying and reviewing the URLs.
 437
 438 URL validation sessions are built as a whole to support immediate and
 439 future review of any URLs.  Each session carries a name, an owner, a set
 440 of record search criteria, a set of tag and subfield combinations describing
 441 the location of URLs to validate, a record container for tracking individual
 442 records to verify, and a set of state and data tables for managing the
 443 processing of individual URLs.
 444
 445 A set of middle-layer methods provide the business logic required to collect
 446 records, extract, parse and test the validity of the URLs.
 447
 448 For more information, see the included tech spec documents.
 449
 450 Permissions
 451 +++++++++++
 452 One new permission is added for this feature:
 453
 454  * URL_VERIFY
 455
 456 Serials
 457 ~~~~~~~
 458
 459 Serial Control: Embed Alternate Interfaces
 460 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 461 As another step toward a unified interface, the serial control subscription
 462 editor now consists of an embedded version of the alternate control. This
 463 reduces duplication of both code and documentation, and smooths the eventual
 464 transition to a single interface.
 465
 466 In order to not lose any essential features, the following additions were made
 467 to the new combination editor:
 468
 469 * note editors on subscriptions and distributions
 470 * labeled dropdown for distribution summary options ("Add to record entry", "Use record entry only", etc.)
 471 * legacy record entry linkage setup (Allows one to tie a distribution's information to a particular serial record entry (i.e. a MFHD record))
 472
 473 Serial Control: Set Special Statuses
 474 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 475 The Serial Control interface prevents direct editing of serial item statuses
 476 for data integrity reasons. As an alternative to direct control, the interface
 477 now offers new menu options for setting items to 'claimed', 'not held', and
 478 'not published'. Note that these statuses are still currently useful for
 479 reporting and display purposes only.
 480
 481 Staff Client
 482 ~~~~~~~~~~~~
 483
 484 Staff client search preferences
 485 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 486 Staff can now set workstation-level search preferences through Admin ->
 487 Workstation Administration -> Set Search Preferences.
 488
 489   * Default Search Library sets the library that is searched by default from
 490   the advanced search page and the portal page.
 491   * Preferred library is used to identify copies that should display first.
 492   * Advanced search default pane allows staff to set the numeric or expert
 493   searches as the default search tab.
 494
 495 The option to change the preferred search library from the search results page
 496 is no longer available when logged into the staff client.
 497
 498 add "about:about" to developer menu in staff client
 499 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 500
 501 about:about gives access to various XULRunner diagnostic tools.
 502 Useful ones include:
 503
 504 about:buildconfig::
 505     Get information about how the staff client is built.
 506 about:config::
 507     Tweak XULRunner settings.
 508 about:memory::
 509     Get detailed information about the memory usage of the staff
 510     client.
 511
 512
 513 Miscellaneous
 514 -------------
 515
 516 Loading Sample Data
 517 ~~~~~~~~~~~~~~~~~~~
 518 One common need for people evaluating Evergreen, as well as for developers,
 519 writers, and testers, is a set of sample data that can be easily loaded into
 520 the Evergreen database and provide a consistent set of results for testing
 521 and training purposes.
 522
 523 This release features sets of sample data consisting of:
 524
 525 * 100 bibliographic records retrievable via a "concerto" keyword search
 526 * 100 French bibliographic records
 527 * Associated call numbers, copies, parts, and conjoined items
 528 * Patron accounts, including some recently expired patrons
 529 * Circulation transactions, including some holds and some overdue items
 530
 531 To load the sample data into a freshly installed Evergreen database, you can
 532 pass the following arguments to the `eg_db_config` script (either when you are
 533 creating the initial database schema, or as a separate call after creating the
 534 database schema):
 535
 536 * `--load-all-sample`: Loads all sample data, including bibliographic records,
 537    call numbers, copies, users, and transactions.
 538 * `--load-concerto-sample`: Loads a subset of sample data that includes just
 539   100 bibliographic records, and associated call numbers and copies.