LP#1938835: release notes for the customizable staff portal
authorGalen Charlton <gmc@equinoxOLI.org>
Wed, 22 Dec 2021 21:54:22 +0000 (16:54 -0500)
committerMike Rylander <mrylander@gmail.com>
Thu, 24 Mar 2022 12:57:14 +0000 (08:57 -0400)
To test
-------
[1] Apply the patch.
[2] Verify that the Angular staff portal is now the default
    and that it displays the stock portal entries.
[3] In the new Staff Portal Page local administration interface,
    make changes to add, subtract, or modify portal page entries.
[4] Verify that those changes appear on the staff portal page and
    that they are sensitive to the workstation that the staff
    user is logged in as.

Sponsored-by: Pioneer Library System
Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>
Signed-off-by: Shula Link <slink@gchrl.org>
Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Dan Guarracino <dguarracino@pls-net.org>
docs/RELEASE_NOTES_NEXT/Client/Customizable_Staff_Portal.adoc [new file with mode: 0644]

diff --git a/docs/RELEASE_NOTES_NEXT/Client/Customizable_Staff_Portal.adoc b/docs/RELEASE_NOTES_NEXT/Client/Customizable_Staff_Portal.adoc
new file mode 100644 (file)
index 0000000..afcdab5
--- /dev/null
@@ -0,0 +1,57 @@
+== Customizable Staff Portal ==
+
+The staff portal / staff home page is now customizable. A new Local
+Administration interface, Staff Portal Page, allows staff users who
+have the new `ADMIN_STAFF_PORTAL_PAGE` permission to specify groups
+of Evergreen menu links, external links, catalog search widgets,
+and free text to display on the staff home page.
+
+The portal customization is available only on the Angular version of
+the portal, so access to the AngularJS version is now redirected to
+the Angular one.
+
+Different portal pages may be configured for different Organizational
+Units. The displayed portal page will depend on the staff user's
+workstation. The Organizational Unit tree will be walked up starting
+from the workstation until one or more `config.ui_staff_splash_page_entry`
+rows are found for the Organizational Unit. The set of entries for
+that Organizational Unit will constitute the entire splash page entries
+to display, i.e., it won't try to merge branch, system, and
+consortial-level entries.
+
+The administration interface allows authorized to:
+
+* create, modify, or delete portal page entries
+* clone a library's set of portal page entries to a
+  different library
+
+Portal page entries consist of the following fields:
+
+* Entry Label: free text that displays on the portal page
+* Entry Type: Catalog Search, Header, Link, Menu Item, or Text and/or HTML
+* Entry Target URL: target of Link or Menu Item entries
+* Entry Text: Free text and limited HTML to display for Text/HTML entry
+  types. HTML is sanitized to allow only basic formatting and link
+  elements.
+* Entry Image URL: for specifying an icon to display with the
+  portral entry.
+* Owner: the Organization Unit that owns the entry.
+* Page Column and Column Position: these control the positioning
+  of the entry. The portal is styled so that three columns are
+  displayed by default, as with the legacy hard-coded portal, but
+  if the user chooses to define more than three columns, columns
+  after the third will stack vertically as additional rows.
+
+=== Upgrade notes ===
+
+This patch adds the following:
+
+  * New database table `config.ui_staff_splash_page_entry`. This
+    stories the entries to display on the portal.
+  * New database table `config.ui_staff_portal_page_entry_type`.
+    This is a lookup table for entry types.
+  * New permission `ADMIN_STAFF_SPLASH_PAGE`. This is implicitly
+    available to stock Local and Global Administrator permission
+    groups via the `EVERYTHING` permission.
+  * New grid setting for the administration interface.
+