Docs: finalizing 3.3 release notes and related documentation
[working/Evergreen.git] / docs / RELEASE_NOTES_3_3.adoc
1 Evergreen 3.3 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Upgrade notes
7 -------------
8
9 Migrating Parent/guardian information
10 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11 Sites who traditionally store parent/guardian information in the
12 patron 'Secondary Identification' field can migrate values from this
13 field to the new guardian field with the following SQL:
14
15 [source,sql]
16 -------------------------------------------------------------------------
17 BEGIN;
18
19 -- 1. Find the local ID of the parent/guardian identification type
20
21 SELECT * FROM config.identification_type;
22
23 -- 2. On my test system, the id is "101".  It will vary!.
24 -- Migrate the value from the ident2 field to the guardian field.
25
26 UPDATE actor.usr 
27     SET guardian = ident_value2 
28 WHERE 
29     ident_type2 = 101 -- !! CHANGE TO SUIT
30     AND ident_value2 IS NOT NULL 
31     AND ident_value2 <> '';
32
33 -- 3. delete the original secondary identification data
34
35 UPDATE actor.usr 
36     SET ident_value2 = NULL, ident_type2 = NULL
37 WHERE
38     ident_type2 = 101; -- !! CHANGE TO SUIT
39
40 COMMIT;
41 -------------------------------------------------------------------------
42
43
44 Upgrading PostgreSQL
45 ^^^^^^^^^^^^^^^^^^^^
46 Evergreen now supports PostgreSQL 9.6 and 10.
47 If you upgrade your database from a PostgreSQL version of 9.5, or
48 lower, to PostgreSQL versions 9.6 or 10, you will need to recreate 3
49 indexes in additon to the normal database upgrade steps.  The index
50 recreation is necessary because of changes to the PostgreSQL
51 `unaccent` extension module.
52
53 The following snippet of SQL code will do the necessary steps:
54
55 [source,sql]
56 ------------------------------------------------------------------------
57 DROP INDEX actor_usr_first_given_name_unaccent_idx;
58 DROP INDEX actor_usr_second_given_name_unaccent_idx;
59 DROP INDEX actor_usr_family_name_unaccent_idx;
60 CREATE INDEX actor_usr_first_given_name_unaccent_idx ON actor.usr
61       (evergreen.unaccent_and_squash(first_given_name));
62 CREATE INDEX actor_usr_second_given_name_unaccent_idx ON actor.usr
63       (evergreen.unaccent_and_squash(second_given_name));
64 CREATE INDEX actor_usr_family_name_unaccent_idx ON actor.usr
65       (evergreen.unaccent_and_squash(family_name));
66 ------------------------------------------------------------------------ 
67
68
69 New Features
70 ------------
71
72 Administration
73 ~~~~~~~~~~~~~~
74
75 Include Item Status in marc_export Items Export
76 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77 The marc_export script now includes the item status in the 852 subfield s when exporting items.
78
79 Ability to Reingest Certain Record Attributes In pingest.pl
80 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
81 An option, `--attr`, has been added to the `pingest.pl` support script
82 that allows the user to specify which record attributes to reingest.
83 It can be used one or more times to specify one or more attributes to
84 ingest.  It can be omitted to reingest all record attributes.  This
85 option is ignored if the `--skip-attrs` option is used.
86
87 The `--attr` option is most useful after doing something specific that
88 requires only a partial ingest of records.  For instance, if you add a
89 new language to the `config.coded_value_map` table, you will want to
90 reingest the `item_lang` attribute on all of your records.  The
91 following command line will do that, and only that, ingest:
92
93 ----
94 $ /openils/bin/pingest.pl --skip-browse --skip-search --skip-facets \
95     --skip-display --attr=item_lang
96 ----
97
98
99
100 Architecture
101 ~~~~~~~~~~~~
102
103 Database Support for PostgreSQL 10
104 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
105 The Evergreen database can now be built with PostgreSQL version 10.
106
107 This update has implications for developers who write PgTap tests.  In
108 versions of PostgreSQL prior to 10, one could write `\set ECHO` to
109 disable the echoing of commands as they were run.  In PostgreSQL
110 version 10, using `\set` without a value is an error.  One should now
111 write `\set ECHO none` in order to disable the echoing of commands.
112 This latter form works in all versions of PostgreSQL currently
113 supported by Evergreen.
114
115
116
117 Ubuntu 18.04 Bionic Beaver
118 ^^^^^^^^^^^^^^^^^^^^^^^^^^
119 Evergreen can now be installed on Ubuntu 18.04 Bionic Beaver.  To
120 install the prerequisites, use ubuntu-bionic as the Makefile.install
121 target.
122
123 This update also fixes a Perl warning in the HoldNotify module that is
124 an error in the version of Perl (5.26) that is installed on Ubuntu
125 18.04.
126
127
128
129
130 Cataloging
131 ~~~~~~~~~~
132
133 MARC Import/Export Interface Update (Angular Port)
134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 This MARC Import/Export (AKA Vandelay) interface is now built on
136 Angular(7) instead of Dojo.  The functionality is consistent with the
137 previous version of the interface, with minor UI adjustments to match
138 the Angular style, plus one new interface called 'Recent Imports'.
139
140 Import Templates
141 ++++++++++++++++
142 Users may now save sets of import attributes from the MARC import form as 
143 named templates.  Users may select a default template, applied on page load 
144 by default, and users may delete existing templates.
145
146 Recent Imports Tab
147 ++++++++++++++++++
148 This is a new interface which allows users to see active and recent
149 Vandelay sesssions originating from the same workstation or logged in
150 user account.  Active sessions include real-time progress information so
151 the user may track the progress without refreshing the page.
152
153 This interface makes it possible to exit the main import tab or the
154 Vandelay interface altogether and return at a later time to check on
155 import progress.  It also allows users to start multiple imports at
156 the same time and follow the status of each in one interace.
157
158
159 Spine Label Sheet Printing
160 ++++++++++++++++++++++++++
161
162 Catalogers can now print spine labels onto 8 1/2 x 11 inch label sheets.
163
164
165 Circulation
166 ~~~~~~~~~~~
167
168 Patron Parent/Guardian Field
169 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
170 Patrons now have a new dedicated parent/guardian field.  This field is 
171 editable in the patron edit interface, displays in the patron
172 summary side bar on the browser client, and is search-able from the
173 patron search interface in the browser client.
174
175 Patron Editor
176 +++++++++++++
177 In addition to the standard "show" and "suggest" visibility settings, 
178 the new guardian field comes with a library setting 
179 'ui.patron.edit.guardian_required_for_juv' ("GUI: Juvenile account 
180 requires parent/guardian").  When this setting is applied, a value 
181 will be required in the patron editor when the juvenile flag is active.
182
183 Allow Others to Use My Account (Privacy Waiver)
184 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
185 Patrons who wish to authorize other people to use their account may
186 now do so via My Account.  In the Search and History Preferences tab
187 under Account Preferences, a new section labeled "Allow others to use
188 my account" allows patrons to enter a name and indicate that the
189 specified person is allowed to place holds, pickup holds, view
190 borrowing history, or check out items on their account.  This
191 information is displayed to circulation staff in the patron account
192 summary in the web client.  (Staff may also add, edit, and remove
193 entries via the patron editor.)
194
195 A new library setting, "Allow others to use patron account (privacy
196 waiver)," is used to enable or disable this feature.
197
198
199
200 Client
201 ~~~~~~
202
203 Server and Booking Administration Moved To Angular
204 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
205 The Administration => Server Administration and 
206 Administration => Booking Administration pages have been ported to
207 Angular using the new Angular grids.  Entry points from both AngularJS
208 and Angular web clients point to the new interfaces.
209
210 Option to Enable Experimental Angular Staff Catalog
211 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
212 A new org unit setting labeled 'GUI: Enable Experimental Angular 
213 Staff Catalog' (ui.staff.angular_catalog.enabled) has been added, allowing
214 sites to enable a menu option in the browser client for accessing
215 the experimental Angular staff catalog.
216
217 When set to true, a new entry in the navigation bar appears in the
218 Cataloging menu labled "Staff Catalog (Experimental)".
219
220 New Features (Since 3.2)
221 ++++++++++++++++++++++++
222  * Pub date filter
223  * Copy location filter
224  * Group formats and editions
225  * Identifier search
226  * MARC search
227  * Browse search
228  * Place holds
229  * Record baskets and actions
230  * Record detail tabs/actions point to AngularJS versions where needed.
231  * Record detail View In Catalog button
232
233
234
235 OPAC
236 ~~~~
237
238 View upcoming booking reservations in the OPAC
239 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240 A new tab in the My Account section of the OPAC shows
241 patrons information about reservations on their account.
242 Here, patrons can check on upcoming reservations, as 
243 well as reservations they currently have checked out.
244
245 Note: this interface pulls its timezone from the Library
246 Settings Editor.  Make sure that you have a timezone
247 listed for your library in the Library Settings Editor
248 before using this feature.
249
250 Display UPC as Option for Public Catalog Advanced Search
251 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
252 The Numeric Search tab of the public catalog Advanced Search
253 now includes an option to search by UPC (Universal Product Code).
254
255
256
257 Acknowledgments
258 ---------------
259 The Evergreen project would like to acknowledge the following
260 organizations that commissioned developments in this release of
261 Evergreen:
262
263 * King County Library System (KCLS)
264 * MassLNC Evergreen Development Initiative
265 * Pennsylvania Integrated Library System (PaILS)
266
267 We would also like to thank the following individuals who contributed
268 code, translations, documentations patches and tests to this release of
269 Evergreen:
270
271 * Adam Bowling
272 * Steve Callender
273 * Eva Cerninakova
274 * Jeff Davis
275 * Jason Etheridge
276 * Bill Erickson
277 * Rogan Hamby
278 * Kathy Lussier
279 * Terran McCanna
280 * Andrea Buntz Neiman
281 * Jennifer Pringle
282 * Jane Sandberg
283 * Chris Sharp
284 * Ben Shum
285 * Remington Steed
286 * Jason Stephenson
287 * Anahi Valdez
288 * Dan Wells
289 * Stephen Woidowski
290 * John Yorio
291
292
293 We also thank the following organizations whose employees contributed
294 patches:
295
296 * BC Libraries Cooperative
297 * Catalyte
298 * CW MARS
299 * Emerald Data Networks
300 * Equinox Open Library Initiative
301 * Georgia PINES
302 * King County Library System
303 * Linn-Benton Community College
304 * MassLNC
305
306 We regret any omissions.  If a contributor has been inadvertently
307 missed, please open a bug at http://bugs.launchpad.net/evergreen/
308 with a correction.