From: Galen Charlton <gmc@equinoxinitiative.org>
Date: Thu, 20 Sep 2018 21:16:58 +0000 (-0400)
Subject: LP#1772680: add some release notes and installation instructions
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=d47e93c512e3e06c94c7fc2a75e392142dd4097d;p=evergreen%2Fpines.git

LP#1772680: add some release notes and installation instructions

Some text initially written by Jaswinder Singh <Jaswinder.Singh0011@gmail.com>.

Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
---

diff --git a/docs/RELEASE_NOTES_NEXT/Integrations/Enhanced_RBDigital_Integration.adoc b/docs/RELEASE_NOTES_NEXT/Integrations/Enhanced_RBDigital_Integration.adoc
new file mode 100644
index 0000000000..097d1cd629
--- /dev/null
+++ b/docs/RELEASE_NOTES_NEXT/Integrations/Enhanced_RBDigital_Integration.adoc
@@ -0,0 +1,65 @@
+Enhanced RBDigital Integration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This feature adds enhanced support for digital resources supplied
+by RBDigital, including
+
+  * An option to enable a public catalog search tab parallel
+    to Evergreen's native search that searches the RBDigital
+    catalog for licensed resources.
+  * The ability to register Evergreen patron accounts with
+    the RBDigital service on the fly.
+  * The ability to add RBDigital items to a wishlist; the
+    contents of that wishlist then display in the public catalog
+    My Account page.
+
+Installation and activation
++++++++++++++++++++++++++++
+
+This feature depends on acquiring subscription access to the
+RBDigital service and getting credentials to the RBDigital
+API. In particular, you will need to obtain a:
+
+  * library ID for the RBDigital service
+  * API token
+  * rbdigital.com hostname for your services, e.g., "foo.rbdigital.com"
+
+Once you have that information, to enable the full integration,
+perform the following steps:
+
+  * Enable the Global Flag "Extras: Enable public catalog search tab
+    for digital resource searches (e.g., RBDigital".
+  * Set the "RBDigital Base URI" Library Setting to "https://api.rbdigital.com/v1"
+    for all organization units that will have access to the service.
+  * Ensure that the `ebook_api.enabled` variable in
+    `/openils/var/templates/opac/parts/config.tt2` is set to `true`.
+
+Additional settings are stored in new database tables in the `extra`
+schema, and at present can only be populated using direct SQL access.
+
+Given a library ID, API token, and RBDigital service hostname,
+run the following SQL, adjusted for the RBDigital values:
+
+[source, postgres]
+------------------------------------------------------------------------------
+INSERT INTO extra.rbdigital_digital_services_authorized(digital_services_id, home_ou) VALUES (1, 1);
+INSERT INTO rbdigital.digital_services_authorized (
+    digital_services_id,
+    digital_services_library_id,
+    digital_services_library_token,
+    digital_services_name,
+    digital_services_library_url,
+    id,
+    library_id,
+    home_ou) 
+  VALUES (
+    2,
+    '__RBDIGITAL_LIBARRY_ID__',
+    '__RBDIGITAL_API_TOKEN__',
+    '__NAME_OF_SERVICE__',
+    '__RBDIGITAL_SERVICE_HOSTNAME__',
+    2,
+    1,
+    1
+  );
+------------------------------------------------------------------------------