be98568a5ce5ef7c43099e5a679738ae21956d6b
[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
160 Circulation
161 ~~~~~~~~~~~
162
163 Patron Parent/Guardian Field
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
165 Patrons now have a new dedicated parent/guardian field.  This field is 
166 editable in the patron edit interface, displays in the patron
167 summary side bar on the browser client, and is search-able from the
168 patron search interface in the browser client.
169
170 Patron Editor
171 +++++++++++++
172 In addition to the standard "show" and "suggest" visibility settings, 
173 the new guardian field comes with a library setting 
174 'ui.patron.edit.guardian_required_for_juv' ("GUI: Juvenile account 
175 requires parent/guardian").  When this setting is applied, a value 
176 will be required in the patron editor when the juvenile flag is active.
177
178 Allow Others to Use My Account (Privacy Waiver)
179 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
180 Patrons who wish to authorize other people to use their account may
181 now do so via My Account.  In the Search and History Preferences tab
182 under Account Preferences, a new section labeled "Allow others to use
183 my account" allows patrons to enter a name and indicate that the
184 specified person is allowed to place holds, pickup holds, view
185 borrowing history, or check out items on their account.  This
186 information is displayed to circulation staff in the patron account
187 summary in the web client.  (Staff may also add, edit, and remove
188 entries via the patron editor.)
189
190 A new library setting, "Allow others to use patron account (privacy
191 waiver)," is used to enable or disable this feature.
192
193
194
195 Client
196 ~~~~~~
197
198 Booking Administration Moved To Angular
199 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
200 The Administration => Booking Administration pages have been ported to
201 Angular using the new Angular grids.  Entry points from both AngularJS
202 and Angular apps point to the new interfaces.
203
204 Option to Enable Experimental Angular Staff Catalog
205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
206 A new org unit setting labeled 'GUI: Enable Experimental Angular 
207 Staff Catalog' (ui.staff.angular_catalog.enabled) has been added, allowing
208 sites to enable a menu option in the browser client for accessing
209 the experimental Angular staff catalog.
210
211 When set to true, a new entry in the navigation bar appears in the
212 Cataloging menu labled "Staff Catalog (Experimental)".
213
214 New Features (Since 3.2)
215 ++++++++++++++++++++++++
216  * Pub date filter
217  * Copy location filter
218  * Group formats and editions
219  * Identifier search
220  * MARC search
221  * Browse search
222  * Place holds
223  * Record baskets and actions
224  * Record detail tabs/actions point to AngularJS versions where needed.
225  * Record detail View In Catalog button
226
227
228
229 OPAC
230 ~~~~
231
232 View upcoming booking reservations in the OPAC
233 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
234 A new tab in the My Account section of the OPAC shows
235 patrons information about reservations on their account.
236 Here, patrons can check on upcoming reservations, as 
237 well as reservations they currently have checked out.
238
239 Note: this interface pulls its timezone from the Library
240 Settings Editor.  Make sure that you have a timezone
241 listed for your library in the Library Settings Editor
242 before using this feature.
243
244 Display UPC as Option for Public Catalog Advanced Search
245 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
246 The Numeric Search tab of the public catalog Advanced Search
247 now includes an option to search by UPC (Universal Product Code).
248
249
250
251 Acknowledgments
252 ---------------
253 The Evergreen project would like to acknowledge the following
254 organizations that commissioned developments in this release of
255 Evergreen:
256
257 * Pennsylvania Integrated Library System (PaILS)
258
259 We would also like to thank the following individuals who contributed
260 code, translations, documentations patches and tests to this release of
261 Evergreen:
262
263 * Steve Callender
264 * Jeff Davis
265 * Jason Etheridge
266 * Bill Erickson
267 * Rogan Hamby
268 * Kathy Lussier
269 * Chris Sharp
270 * Ben Shum
271 * Jason Stephenson
272 * Dan Wells
273 * John Yorio
274
275
276 We also thank the following organizations whose employees contributed
277 patches:
278
279 * BC Libraries Cooperative
280 * CW MARS
281 * Equinox Open Library Initiative
282 * Georgia PINES
283 * King County Library System
284 * Linn-Benton Community College
285 * MassLNC
286
287 We regret any omissions.  If a contributor has been inadvertently
288 missed, please open a bug at http://bugs.launchpad.net/evergreen/
289 with a correction.