From 3bdd78ae2f75a9f23cdeeca08fb2e6cd4335594a Mon Sep 17 00:00:00 2001 From: Kathy Lussier Date: Fri, 10 Mar 2017 15:38:10 -0500 Subject: [PATCH] Docs: Additions to 2.12 release notes Adds organizations that commissioned development, contributors who have contributed since the beta release, new notes for ebook integration, and some some missed features. Signed-off-by: Kathy Lussier Signed-off-by: Galen Charlton --- docs/RELEASE_NOTES_2_12.adoc | 195 ++++++++++++++++++++++++++--------- 1 file changed, 144 insertions(+), 51 deletions(-) diff --git a/docs/RELEASE_NOTES_2_12.adoc b/docs/RELEASE_NOTES_2_12.adoc index 44b0531db8..4c97540a90 100644 --- a/docs/RELEASE_NOTES_2_12.adoc +++ b/docs/RELEASE_NOTES_2_12.adoc @@ -452,51 +452,124 @@ Also add Arabic (Jordan) as a new supported language. -E-book integration -^^^^^^^^^^^^^^^^^^ -OverDrive and OneClickdigital integration has been added to Evergreen. The -system will now support: - * Display of e-book availability in the search results and record summary - pages. - * Display of e-book checkouts and holds in a patron's My Account pages. - -To enable this feature, Evergreen sites need to: - * Ensure the new block and open-ils.ebook_api service have been - added to opensrf.xml and (in the case of the open-ils.ebook_api_service) - opensrf_core.xml. Both blocks are now included in the example files. - * Contact their vendor to obtain credentials for their API account. - * Edit the config.tt2 file to set ebook_api.enabled to true. Administrators - will also need to enable specific vendor APIs and add base URIs that are used - in 856 fields. - * Add the credentials for their API account in the new Ebook API Integration - settings provided in the Library Settings Editor. - -New settings available in the Library Settings Editor -+++++++++++++++++++++++++++++++++++++++++++++++++++++ -The following settings have been added to the Library Settings Editor: - * OneClickdigital Basic Token (ebook_api.overdrive.discovery_base_uri) - * OneClickdigital Library ID (ebook_api.oneclickdigital.library_id) - * Overdrive Account ID (ebook_api.overdrive.account_id) - * Overdrive Authorization Name (ebook_api.overdrive.authorizationname) - * Overdrive Basic Token (ebook_api.overdrive.basic_token) - * Overdrive Circulation API Base URI (ebook_api.overdrive.circulation_base_uri) - * Overdrive Discovery API Base URI (ebook_api.overdrive.discovery_base_uri) - * Overdrive Granted Authorization Redirect URI (ebook_api.overdrive.granted_auth_redirect_uri) - * Overdrive Password Required (ebook_api.overdrive.password_required) - * Overdrive Website ID (ebook_api.overdrive.websiteid) - -New config.tt2 settings -+++++++++++++++++++++++ - * ebook_api.enabled - * ebook_api.ebook_test_.enabled - * ebook_api.ebook_test.base_uris - * ebook_api.oneclickdigital.enabled - * ebook_api.oneclickdigital.base_uris - * ebook_api.overdrive.enabled - * ebook_api.overdrive.base_uris - - - +Ebook API integration +^^^^^^^^^^^^^^^^^^^^^ +Evergreen 2.12 supports partial integration with third-party APIs +provided by OverDrive and OneClickdigital. When ebook API integration +is enabled, bibliographic records from these vendors that appear in your +OPAC will include vendor holdings and availability information. Also, +when a user is logged in, the OPAC dashboard and My Account interface +will include information about that user's checkouts and holds for +supported vendors. + +For API integration to work, you need to request API access from the +vendor and configure your Evergreen system according to the instructions +below. You also need to configure the new `open-ils.ebook_api` service. + +This feature assumes that you are importing MARC records supplied by the +vendor into your Evergreen system, using Vandelay or some other MARC +import method. This feature does not search the vendor's online +collections or automatically import vendor records into your system; it +merely augments records that are already in Evergreen. + +A future Evergreen release will add the ability for users to check out +titles, place holds, etc., directly via the OPAC. + +Ebook API service configuration ++++++++++++++++++++++++++++++++ +This feature uses the new `open-ils.ebook_api` OpenSRF service. This +service must be configured in your `opensrf.xml` and `opensrf_core.xml` +config files for ebook API integration to work. See +`opensrf.xml.example` and `opensrf_core.xml.example` for guidance. + +OverDrive API integration ++++++++++++++++++++++++++ +Before enabling OverDrive API integration, you will need to request API +access from OverDrive. OverDrive will provide the values to be used for +the following new org unit settings: + + * *OverDrive Basic Token*: The basic token used for API client + authentication. To generate your basic token, combine your client + key and client secret provided by OverDrive into a single string + ("key:secret"), and then base64-encode that string. On Linux, you + can use the following command: `echo -n "key:secret" | base64 -` + * *OverDrive Account ID*: The account ID (a.k.a. library ID) for your + OverDrive API account. + * *OverDrive Website ID*: The website ID for your OverDrive API + account. + * *OverDrive Authorization Name*: The authorization name (a.k.a. + library name) designated by OverDrive for your library. If your + OverDrive subscription includes multiple Evergreen libraries, you + will need to add a separate value for this setting for each + participating library. + * *OverDrive Password Required*: If your library's OverDrive + subscription requires the patron's PIN (password) to be provided + during patron authentication, set this setting to "true." If you do + not require the patron's PIN for OverDrive authentication, set this + setting to "false." (If set to "true," the password entered by a + patron when logging into the OPAC will be cached in plain text in + memcached.) + * *OverDrive Discovery API Base URI* and *OverDrive Circulation API + Base URI*: By default, Evergreen uses OverDrive's production API, so + you should not need to set a value for these settings. If you want + to use OverDrive's integration environment, you will need to add the + appropriate base URIs for the discovery and circulation APIs. See + OverDrive's developer documentation for details. + * *OverDrive Granted Authorization Redirect URI*: Evergreen does not + currently support granted authorization with OverDrive, so this + setting is not currently in use. + +For more information, consult the +https://developer.overdrive.com/docs/getting-started[OverDrive API +documentation]. + +To enable OverDrive API integration, adjust the following OPAC settings +in config.tt2: + + * `ebook_api.enabled`: set to "true". + * `ebook_api.overdrive.enabled`: set to "true". + * `ebook_api.overdrive.base_uris`: list of regular expressions + matching OverDrive URLs found in the 856$9 field of older OverDrive + MARC records. As of fall 2016, OverDrive's URL format has changed, + and the record identifier is now found in the 037$a field of their + MARC records, with "OverDrive" in 037$b. Evergreen will check the + 037 field for OverDrive record identifiers; if your system includes + older-style OverDrive records with the record identifier embedded in + the 856 URL, you need to specify URL patterns with this setting. + +OneClickdigital API integration ++++++++++++++++++++++++++++++++ +Before enabling OneClickdigital API integration, you will need to +request API access from OneClickdigital. OneClickdigital will provide +the values to be used for the following new org unit settings: + + * *OneClickdigital Library ID*: The identifier assigned to your + library by OneClickdigital. + * *OneClickdigital Basic Token*: Your client authentication token, + supplied by OneClickdigital when you request access to their API. + +For more information, consult the +http://developer.oneclickdigital.us/[OneClickdigital API documentation]. + +To enable OneClickdigital API integration, adjust the following OPAC +settings in config.tt2: + + * `ebook_api.enabled`: set to "true". + * `ebook_api.oneclickdigital.enabled`: set to "true". + * `ebook_api.oneclickdigital.base_uris`: list of regular expressions + matching OneClickdigital URLs found in the 859$9 field of your MARC + records. Evergreen uses the patterns specified here to extract + record identifiers for OneClickdigital titles. + +Additional configuration ++++++++++++++++++++++++++++++++ +Evergreen communicates with third-party vendor APIs using the new +`OpenILS::Utils::HTTPClient` module. This module is configured using +settings in `opensrf.xml`. The default settings should work for most +environments by default, but you may need to specify a custom location +for the CA certificates installed on your server. You can also disable +SSL certificate verification on HTTPClient requests altogether, but +doing so is emphatically discouraged. @@ -536,24 +609,36 @@ that allows the user to control the setting. - - - RDA Improvements ^^^^^^^^^^^^^^^^ * Author fields are now normalized to strip ending periods so that authors from RDA and non-RDA records are collapsed in browse and facet headings. - * All author/contributor roles will now be displayed in the record detail. + * All author/contributor roles will now display in the record detail page. Previously, some of the roles were omitted or were duplicated. +Obalkyknih.cz Integration +^^^^^^^^^^^^^^^^^^^^^^^^^ +Evergreen now integrates with Czech added content provider obalkyknih.cz. A new +setting called obalkyknih_cz.enabled is available in +templates/opac/parts/config.tt2 to enable this new feature. + + Acknowledgments --------------- The Evergreen project would like to acknowledge the following organizations that commissioned developments in this release of Evergreen: -TODO +* Bibliomation +* British Columbia Libraries Cooperative +* C/W MARS +* Georgia PINES +* King County Library System +* Linn Libraries Consortium +* MassLNC +* Pennsylvania Integrated Library System +* Pioneer Library System We would also like to thank the following individuals who contributed code, translations, documentations patches and tests to this release of @@ -563,6 +648,7 @@ Evergreen: * Bill Erickson * Billy Horn * Blake Henderson +* Bob Wicksall * Chris Sharp * Christine Burns * Christine Morgan @@ -583,10 +669,12 @@ Evergreen: * Jennifer Pringle * Jillianne Presley * Jim Keenan +* Jonathan Schatz * Josh Stompro * Kate Butler * Kathy Lussier * Kyle Huckins +* Linda Jansová * Michele Morgan * Michelle Purcell * Mike Rylander @@ -595,6 +683,7 @@ Evergreen: * Rogan Hamby * Terran McCanna * Thomas Berezansky +* Victoria Lewis We also thank the following organizations whose employees contributed patches: @@ -603,8 +692,9 @@ patches: * Catalyst DevWorks * C/W MARS * Equinox Open Library Initiative -* Georga PINES +* Georgia PINES * Indiana State Library +* The Institute for the Study of Totalitarian Regimes, Prague * King County Library System * Lake Agassiz Regional Library * Laurentian University @@ -614,9 +704,12 @@ patches: * MOBIUS Consortium * National Library of the Czech Republic * North of Boston Library Exchange +* Pioneer Library System * Rodgers Memorial Library +* Sigio * Traverse Area District Library + We regret any omissions. If a contributor has been inadvertently missed, please open a bug at http://bugs.launchpad.net/evergreen/ with a correction. -- 2.43.2