docs/RELEASE_NOTES_2_9.txt

   1 Evergreen 2_9 Release Notes
   2 ===========================
   3 :toc:
   4 :numbered:
   5
   6 Upgrade notes
   7 -------------
   8
   9 New Features
  10 ------------
  11
  12
  13
  14 Acquisitions
  15 ~~~~~~~~~~~~
  16
  17
  18
  19 Improved reporting of progress during purchase order activation
  20 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  21 The progress dialog that is displayed when activating a purchase
  22 order now displays more information, particularly during the asset
  23 creation phase. It is now also updated in a more linear fashion;
  24 making it less likely for it to appear that the activation has
  25 stalled.
  26
  27
  28
  29
  30 ==== "Blanket" Orders
  31
  32 "Blanket" orders allow staff to invoice an encumbered amount multiple times,
  33 paying off the charge over a period of time.  The work flow supported by this
  34 development assumes staff does not need to track the individual contents of
  35 the order, only the amounts encumbered and invoiced in bulk.
  36
  37 ===== Example
  38
  39  . Staff creates PO with a Direct Charge of "Popular Fiction 2015" and
  40    a charge type of "Blanket Order".
  41  . The amount entered for the charge equals the total amount expected
  42    to be charged over the duration of the order.
  43  . When a shipment of "Popular Fiction" items arrive, staff creates an
  44    invoice from the "Popular Fiction 2015" PO page and enters the amount
  45    billed/paid for the received shipment under the "Popular Fiction 2015"
  46    charge in the invoice.
  47  . When the final shipment arrives, staff select the 'Final invoice
  48    for Blanket Order' option on the invoice screen to mark the PO as
  49    'received' and drop any remaining encumbrances to $0.
  50   .. Alternatively, if the PO needs to be finalized without creating
  51      a final invoice, staff can use the new 'Finalize Blanket Order'
  52      option on the PO page.
  53
  54 ===== New Components/Terminology/Concepts
  55
  56  * Invoice Item Types have a new flag called 'blanket', available under
  57    Admin -> Server Administration -> Acq -> Invoice Item Types in the
  58    staff client.
  59  * Any direct charge using a 'blanket' item type will create a long-lived
  60    charge that can be invoiced multiple times.
  61  * Such a charge is considered open until its purchase order is "finalized"
  62    (received).
  63  * "Finalizing" a PO changes the PO's state to 'received' (assuming there are
  64    no pending lineitems on the PO) and fully dis-encumbers all blanket charges
  65    on the PO by setting the fund_debit amount to $0 on the original fund_debit
  66    for the charge.
  67  * Invoicing a 'blanket' charge does the following under the covers:
  68   .. Create an invoice_item to track the payment
  69   .. Create a new fund_debit to implement the payment whose amount matches the
  70      invoiced amount.
  71   .. Subtract the invoiced amount from the fund_debit linked to the original
  72      'blanket' po_item, thus reducing the amount encumbered on the charge as
  73      a whole by the invoiced amount.
  74  * A PO can have multiple blanket charges.  E.g. you could have a blanket
  75    order for "Popular Fiction 2015" and a second charge for "Pop Fiction
  76    2015 Taxes" to track / pay taxes over time on a blanket charge.
  77  * A PO can have a mix of lineitems, non-blanket charges, and blanket charges.
  78  * A 'blanket' Invoice Item Type cannot also be a 'prorate' type, since it's
  79    nonsensical.  Blanket items are encumbered, whereas prorated items are
  80    only paid at invoice time and never encumbered.
  81
  82
  83
  84
  85
  86
  87 Administration
  88 ~~~~~~~~~~~~~~
  89
  90
  91
  92 Examples in Apache configuration for "No Image"
  93 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  94 There are now commented out examples for custom images to be used when
  95 "no image" is present in the catalog for cover art. The included examples
  96 are for small/medium/large jacket image art in the event they are not
  97 found by the configured Added Content module.
  98
  99
 100
 101
 102 Pre-Expiration A/T Event Definition
 103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 104 A new Action Trigger event definition ("30 Day Account Expiration Courtesy
 105 Notice") for sending alerts to users before their accounts are expired has
 106 been added.  This is intended to give users time to renew their account before
 107 they lose access to library services.
 108
 109
 110
 111
 112 Upgrade Notes
 113 ^^^^^^^^^^^^^
 114
 115 Remove Script-Based Circulation Configuration
 116 +++++++++++++++++++++++++++++++++++++++++++++
 117
 118 Evergreen no longer supports script-based circulation policies.  All
 119 policies must now be managed within the Local Administration ->
 120 Circulation Policies, Hold Policies, and related interfaces.
 121
 122 Remove open-ils.penalty service
 123 +++++++++++++++++++++++++++++++
 124
 125 Evergreen no longer uses the 'open-ils.penalty' service.  It is safe
 126 (though not required) to remove the following XML chunks from
 127 /openils/conf/opensrf.xml after stopping services.
 128
 129 [source,xml]
 130 ----------------------------------------------------------------------------
 131
 132 <!-- first element -->
 133
 134 <open-ils.penalty>
 135     <keepalive>3</keepalive>
 136     <stateless>1</stateless>
 137     <language>perl</language>
 138     <implementation>OpenILS::Application::Penalty</implementation>
 139     <max_requests>99</max_requests>
 140     <unix_config>
 141         <max_requests>1000</max_requests>
 142         <unix_log>open-ils.penalty_unix.log</unix_log>
 143         <unix_sock>open-ils.penalty_unix.sock</unix_sock>
 144         <unix_pid>open-ils.penalty_unix.pid</unix_pid>
 145         <min_children>1</min_children>
 146         <max_children>15</max_children>
 147         <min_spare_children>1</min_spare_children>
 148         <max_spare_children>5</max_spare_children>
 149     </unix_config>
 150     <app_settings>
 151         <patron_penalty>penalty/patron_penalty.js</patron_penalty>
 152         <script_path>LIBDIR/javascript</script_path>
 153         <script_path>LOCALSTATEDIR</script_path>
 154         <script_path>LOCALSTATEDIR/catalog</script_path>
 155    </app_settings>
 156 </open-ils.penalty>
 157
 158 <!-- second element -->
 159
 160 <appname>open-ils.penalty</appname>
 161 ----------------------------------------------------------------------------
 162
 163
 164
 165
 166 Improved caching of web server templates
 167 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 168 Template Toolkit processors used by Apache are now cached for
 169 better performance (by virtue of thereby being able to take advantage
 170 of Template Toolkit's internal caching mechanism). In addition, the
 171 *compiled* versions of the templates themselves can be cached to
 172 provide an additional performance boost.
 173
 174 Two Apache virtualhost configuration variables are added to
 175 control caching of compiled templates:
 176
 177  * `OILSWebCompiledTemplateCache` - specifies location on the
 178    web server filesystem to store compiled templates.
 179  * `OILSWebTemplateStatTTL` - specifies number of seconds before
 180    checking to see if a newer version of a cached template is
 181    available.
 182
 183 As a result of the caching changes, it is now necessary for
 184 Evergreen administrators to reload Apache to ensure that a change
 185 to (say) TPAC templates becomes visible.
 186
 187
 188
 189
 190 Cataloging
 191 ~~~~~~~~~~
 192
 193
 194
 195 Display Authority Subject Heading Thesaurus Value
 196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 197
 198 There is now a new column in the *Manage Authorities* search results. Each result row now displays each authority's thesaurus value with a "Thes: " prefix. In the authority MARC editor interface the thesaurus value corresponds to the "Subject Heading Thesaurus" fixed field (http://www.loc.gov/marc/authority/ad008.html) labeled “Subj”. For example, a value of "Thes: a" means that the authority is a Library of Congress Subject Heading, and a value of "Thes: k" means the authority is a Canadian Subject Heading.
 199
 200 *A Library of Congress list of thesaurus values:*
 201
 202
 203 * '' = Alternate no attempt to code
 204 * a = Library of Congress Subject Headings
 205 * b = LC subject headings for children's literature
 206 * c = Medical Subject Headings
 207 * d = National Agricultural Library subject authority file
 208 * k = Canadian Subject Headings
 209 * n = Not applicable
 210 * r = Art and Architecture Thesaurus
 211 * s = Sears List of Subject Headings
 212 * v = Repertoire de vedettes-matiere
 213 * z = Other
 214 * | = No attempt to code
 215
 216
 217
 218
 219 Importing Statistical Categories
 220 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 221 You can now retrieve statistical categories (stat cats) from the MARC
 222 record and apply them to the items in Evergreen. When importing or
 223 overlaying items through the Vandelay MARC batch import process, edit
 224 your Holdings Import Profile to tell Evergreen which subfield contains
 225 your stat cat data. That subfield in your MARC records should be
 226 formatted like the following:
 227
 228 ----
 229 CATEGORY 1|VALUE 1||CATEGORY 2|VALUE 2
 230 ----
 231
 232 Notice that the pipe character '|' is used to separate each category
 233 from its value, and two pipes separate each pair of category values.
 234
 235 If you are overlaying existing copies which already have stat cats
 236 attached to them, the overlay process will keep those values unless the
 237 incoming copies contain updated values for matching categories.
 238
 239
 240
 241
 242 Remove the ‡biblios.net Z39.50 target from seed data
 243 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 244 The Z39.50 target at z3950.biblios.net/bibliographic has not worked
 245 for years, so its service definition is no longer provided in the
 246 seed data for new installations of Evergreen.
 247
 248 Users of existing Evergreen systems should consider removing
 249 the Z39.50 definition for ‡biblios.net. This can be done from
 250 Admin | Server Administration | Z39.50 Servers in the staff
 251 client.
 252
 253
 254
 255
 256 SKOS for coded values
 257 ^^^^^^^^^^^^^^^^^^^^^
 258 Some vocabularies used (or which could be used) for stock
 259 record attributes and coded value maps in Evergreen are
 260 published on the web using SKOS. The record attributes system
 261 can now associate Linked Data URIs with specific attribute
 262 values. In particular, seed data supplying URIs for the
 263 RDA Content Type, Media Type, and Carrier Type in this release.
 264
 265 This is an experimental, "under-the-hood" feature that will be built
 266 upon in subsuquent releases.
 267
 268
 269
 270
 271 MARC Tag-table Service
 272 ^^^^^^^^^^^^^^^^^^^^^^
 273 The tag tables for the web staff client MARC editor are
 274 now stored in the database rather than a separate XML
 275 tooltips file as used by the XUL MARC editor.  The tag-table
 276 service, which is part of the web staff client sprint 2
 277 preview in this release, has the following features:
 278
 279 - specifies whether (sub)fields are optional or mandatory
 280 - specifies whether (sub)fields are repeatable or not
 281 - a coded value map can be associated with a subfield to
 282   establish a controlled vocabulary for that subfield
 283 - MARC field and subfield definitions can be overridden
 284   by institutions further down in the organizational unit
 285   hierarchy.  This allows, for example, a library to specify
 286   definitions for local MARC tags.
 287 - values supplied by the tag-table service are used to
 288   populate values in context menus in the web staff client
 289   MARC editor.
 290
 291 The initial seed data for the in-database tag table is
 292 derived from the current tooltips XML file.
 293
 294
 295
 296
 297 Web staff client cataloging preview
 298 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 299 The web staff client now includes additional functionality
 300 to support cataloging and item maintenance, including:
 301
 302 - a new MARC editor
 303 - the service backing the authority headings chooser now
 304   has the ability to filter the browse by subject thesaurus
 305 - Z39.50 search and record import
 306 - improvements to copy and record bucket functionality
 307 - embedding the link checker interface
 308 - embedding the MARC batch import/export interface
 309 - the web staff volume/copy editor
 310
 311 Nearly all of the cataloging functionality available in the XUL
 312 staff client is now present in the web staff client with the
 313 exception of printing spine labels. Nonetheless, the web staff
 314 client remains a preview and is not recommended for production use.
 315
 316
 317
 318
 319 Circulation
 320 ~~~~~~~~~~~
 321
 322
 323
 324 Conditional Negative Balances
 325 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 326 Evergreen sites will now have more control over whether a negative balance can
 327 be applied to a user's billing record and when that negative balance can be
 328 applied. Through a series of Library Settings, a site can prohibit negative
 329 balances on bills or can allow those negative balances to be applied for a
 330 specific period of time after a lost or overdue bill is charged to the user.
 331 Sites can set a default for all types of bills or can apply distinct settings
 332 for lost bills and for overdue fines. The more specific settings will override
 333 the default.
 334
 335 Sites that opt to allow negative balances for a specific period of time must
 336 1) enable the relevant "prohibit negative balances" setting(s) and 2) specify
 337 the time period in the relevant Negative Balance Interval setting(s).
 338
 339 In addition to the new library settings, the system now has a new account
 340 adjustment payment type. This payment type will be utilized for libraries
 341 prohibiting negative balances to replace the previous voiding behavior that
 342 caused the negative balances to occur. The account adjustment payment type will
 343 also be used for all libraries, regardless of the state of negative balance
 344 settings, in cases where overdue fines are adjusted when an overdue item is
 345 marked lost.
 346
 347 An _Adjust to Zero_ option has been added to the bills interface of the patron
 348 record. This option will always adjust the selected bill to a zero balance.
 349 It can also be used to easily clear a negative balance from the patron's
 350 record. A user must have the new ADJUST_BILLS permission to see and use this
 351 option.
 352
 353 This new feature also changes the behavior for the client option to void a bill
 354 from the patron record. If a user does not have the VOID_BILLING permission, the
 355 option to void bills will be hidden in the bills interface and in the Full
 356 Details view of a specific bill.
 357
 358 To truly remove the ability to produce negative balances on a transaction,
 359 administrators need to 1) enable the relevant setting in the Library Settings
 360 Editor and 2) remove the VOID_BILLING permission from staff accounts since
 361 manual voiding will continue to produce negative balances.
 362
 363 New Library Settings
 364 ++++++++++++++++++++
 365  * Negative Balance Interval (Default) (bill.negative_balance_interval_default)
 366  * Negative Balance Interval for Lost (bill.negative_balance_interval_on_lost) -
 367  * Negative Balance Interval for Overdues (bill.negative_balance_interval_on_overdues
 368  * Prohibit negative balance on bills (Default) (bill.prohibit_negative_balance_default)
 369  * Prohibit negative balance on bills for lost materials (bill.prohibit_negative_balance_on_lost)
 370  * Prohibit negative balance on bills for overdue materials (bill.prohibit_negative_balance_on_overdues)
 371
 372 New Permissions
 373 +++++++++++++++
 374  * ADJUST_BILLS
 375
 376
 377
 378
 379 Selfcheck Inactivity Warning
 380 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 381
 382 The Selfcheck interface now warns patrons when they are about to be
 383 logged out due to inactivity 20 seconds prior to logging them out.
 384
 385 The inactivity timeout is also reset with each checkout to avoid timeouts
 386 while checking out lots of items.
 387
 388
 389
 390
 391 User Registration Includes Inactive Accounts in Dupe Search
 392 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 393 When registering a user, the system checks to see if there are already exiting users with the same name, address, email, etc. Now this duplicate user search includes inactive users so that matches can be re-activated if desired, rather than creating duplicate accounts.
 394
 395
 396
 397
 398 Client
 399 ~~~~~~
 400
 401
 402
 403 Link in catalog to clear Added Content cache
 404 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 405 On the catalog's record summary page, there is now a link for staff that
 406 allow them to forcibly clear the cache for the Added Content for that
 407 record. This is helpful if the Added Content retrieved the wrong
 408 cover jacket art, summary, etc. and caches the wrong result.
 409
 410
 411
 412
 413 Disable Google Analytics in Staff Client
 414 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 415 In the staff client interface, Google Analytics for the web catalog is
 416 now disabled by default. This was a preventive measure to reduce the
 417 potential risks for leaking patron information.
 418
 419
 420
 421
 422 Move Acquisitions Admin Menu
 423 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 424 In the staff client interface, the Acquisitions Administration menu is
 425 now directly accessible from the main "Admin" menu instead of
 426 living under "Server Administration". It has also been renamed as "Acquisitions
 427 Administration".
 428
 429
 430
 431
 432 OPAC
 433 ~~~~
 434
 435
 436
 437 Account Expiration Date in My Account
 438 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 439 The Account Expiration Date has been added to the catalog's My Account display
 440 on the main Account Summary page and the Account Preferences page.  This should
 441 help patrons with figuring out when their accounts are due to expire before
 442 they actually expire.
 443
 444
 445
 446
 447
 448 Column sorting in circulation screens
 449 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 450
 451 Sorting of selected columns is now available in the *Items Checked Out*, *Check Out History*,
 452 and *Holds* screens.
 453
 454 * Clicking on the appropriate column heads now sorts the contents from
 455 ``ascending'' to ``descending'' to ``no sort''.  (The ``no sort'' restores the
 456 original list as presented in the screen.)
 457
 458 * The sort indicator (an up or down arrow) is placed to the right
 459 of the column head, as appropriate.
 460
 461 * The combined *Title/Author* column in the *Items Checked Out* screen is now separated into two
 462 independently sortable columns (Title and Author).
 463
 464 * Title sorting is done with the non-filing characters (leading ``the'', ``a'',
 465 ``an'', and other langugage equivalents) removed. The leading articles are rendered in
 466 a smaller font, so as to keep the main entry prominent.  In
 467 addition to the non-filing characters removed for the sort, leading
 468 non-alphanumeric characters are ignored in the sort.
 469
 470
 471
 472
 473 New bib source variable for catalog customization
 474 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 475 For bibliographic records, there is a "bib source" that can be
 476 associated with every record. This source is now available as a
 477 variable that can be used behind the scenes when customizing
 478 the online catalog. The new bib source variables do not present
 479 themselves in the catalog display by default.
 480
 481
 482
 483
 484 New class attribute for e-resource links
 485 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 486 In the catalog, links to electronic resources now have a link class
 487 attribute of "uri_link" to make them easier to customize or build
 488 additional services upon.
 489
 490
 491
 492
 493
 494 Removal of deprecated "JSPAC" interface
 495 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 496
 497 The deprecated Javascript OPAC interface known as "JSPAC" is no
 498 longer included in Evergreen as of this release.
 499
 500 With the understanding that local sites may have made use of
 501 existing parts of the old JSPAC interface -- especially images and
 502 CSS -- no attempt is made at upgrade time to automatically remove
 503 the existing files from disk.
 504
 505 When upgrading, you may wish to remove "index.xml" from your Apache
 506 DirectoryIndex directives.
 507
 508 The following directories, xml, js, and css files were formerly part
 509 of JSPAC, and you may be able to safely remove them from your system
 510 after verifying that they and their contents are no longer required:
 511
 512 - web/opac/common/css/
 513 - web/opac/common/js/dtree.js
 514 - web/opac/common/xml/
 515 - web/opac/extras/bbags.js
 516 - web/opac/extras/bbags.xml
 517 - web/opac/skin/default/js/
 518 - web/opac/skin/default/xml/
 519 - web/opac/theme/
 520
 521 The list of images removed in this change is lengthy, and not
 522 included here.
 523
 524
 525
 526
 527 Removal of legacy selfcheck interface
 528 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 529
 530 The legacy selfcheck interface is no longer included in Evergreen as
 531 of this release.
 532
 533 This interface was formerly located at a URL ending in
 534 extras/selfcheck/selfcheck.xml
 535
 536 No attempt is made at upgrade time to automatically remove this
 537 interface.
 538
 539 It is recommended that you remove this interface and its associated
 540 configuration after performing an upgrade:
 541
 542 (paths relative to Evergreen web root)
 543
 544 - opac/extras/selfcheck/selfcheck.css
 545 - opac/extras/selfcheck/selfcheck.js
 546 - opac/extras/selfcheck/selfcheck.xml
 547 - opac/extras/selfcheck/selfcheck_print.css
 548
 549 You can also remove the related Apache configuration block starting
 550 with:
 551
 552 [source, conf]
 553 <LocationMatch .*/selfcheck.xml>
 554
 555
 556
 557
 558 Acknowledgments
 559 ---------------
 560 The Evergreen project would like to acknowledge the following
 561 organizations who commissioned developments in this release of
 562 Evergreen:
 563
 564  * Georgia Public Library Service
 565  * Grand Rapids Public Library
 566  * Kenton County Public Library
 567  * King County Library System
 568  * Massachusetts Library Network Cooperative
 569  * NC Cardinal
 570  * OhioNet
 571  * Pennsylvania Integrated Library System
 572
 573 We would also like to thank the following individuals who contributed
 574 code, documentations patche and tests to this release of Evergreen:
 575
 576  * Thomas Berezansky
 577  * Matt Berowski
 578  * Adam Bowling
 579  * Jason Boyer
 580  * Christine Burns
 581  * Galen Charlton
 582  * Bill Erickson
 583  * Jason Etheridge
 584  * Jeff Davis
 585  * Lynn Floyd
 586  * Jeff Godin
 587  * Angela Kilsdonk
 588  * Doug Kyle
 589  * Debbie Luchenbill
 590  * Kathy Lussier
 591  * Terran McCanna
 592  * Stephen Moss
 593  * Dan Pearl
 594  * Michael Peters
 595  * Mike Rylander
 596  * Jane Sandberg
 597  * Dan Scott
 598  * Ben Shum
 599  * Josh Stompro
 600  * Remington Steed
 601  * Jason Stephenson
 602  * Yamil Suarez
 603  * Dan Wells
 604  * Liam Whalen
 605
 606 We also thank the following organizations whose employees contributed
 607 patches:
 608
 609  * Anderson County Library
 610  * Berklee College of Music
 611  * Bibliomation
 612  * British Columbia Libraries Cooperative
 613  * Calvin College
 614  * Catalyst Dev Works
 615  * Central/Western Massachusetts Automated Resource Sharing
 616  * Emerald Data Networks, Inc.
 617  * Equinox Software, Inc.
 618  * Georgia Public Library Service
 619  * Grand Rapids Public Library
 620  * Indiana State Library
 621  * King County Library System
 622  * Lake Agassiz Regional Library
 623  * Laurentian University
 624  * Linn-Benton Community College
 625  * Massachusetts Library Network Cooperative
 626  * Merrimack Valley Library Consortium
 627  * MOBIUS
 628  * Sigio
 629  * Traverse Area District Library
 630
 631 We regret any omissions.  If a contributor has been inadvertantly
 632 missed, please open a bug at http://bugs.launchpad.net/evergreen/
 633 with a correction.
 634