lp1744756 Release Notes for PGTDEs collab/khuckins/lp1744756-custom-profile-group
authorKyle Huckins <khuckins@catalyte.io>
Thu, 14 Jun 2018 16:11:34 +0000 (16:11 +0000)
committerKyle Huckins <khuckins@catalyte.io>
Tue, 10 Jul 2018 15:59:42 +0000 (15:59 +0000)
- Include release notes for Permission Group Tree Display
Entry UI and usage.
- Include pictures of interface for documentation.

Signed-off-by: Kyle Huckins <khuckins@catalyte.io>
 Changes to be committed:
new file:   docs/RELEASE_NOTES_NEXT/Client/pgtde.adoc
new file:   docs/media/pgtde_01.png
new file:   docs/media/pgtde_02.png

docs/RELEASE_NOTES_NEXT/Client/pgtde.adoc [new file with mode: 0644]
docs/media/pgtde_01.png [new file with mode: 0644]
docs/media/pgtde_02.png [new file with mode: 0644]

diff --git a/docs/RELEASE_NOTES_NEXT/Client/pgtde.adoc b/docs/RELEASE_NOTES_NEXT/Client/pgtde.adoc
new file mode 100644 (file)
index 0000000..c7dd72a
--- /dev/null
@@ -0,0 +1,57 @@
+Permission Group Display Entries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+In some cases, it is useful to have the ability to reorder permission, or to make
+only specific groups available in the permission group selector for specific
+Org Units. An interface has been made available to allow this.
+
+Group Tree Display Entry Interface
+++++++++++++++++++++++++++++++++++
+
+Permission Group Display Entries can be reordered, added, or removed via
+_Administration -> Local Admin -> Permission Tree Display Entries_.
+Select the Org Unit you wish to edit the entries in.
+
+Each entry must be inserted manually into the new 
+permissions.group_tree_display_entry table, as no default entries exist.
+
+image::media/pgtde_01.png[Group Tree Display Entry Admin UI]
+
+Moving an Entry
++++++++++++++++
+Moving an entry will shift its position up or down in the patron profile
+selector for a given Org Unit.
+
+* Select an entry
+* Press either the *Move Up* or *Move Down* button. The entry will be 
+moved up or down, accordingly.
+* Click *Save* to save your edits.  
+
+NOTE: You may only move up or down entries that have sibling entries.
+
+Removing an Entry
++++++++++++++++++
+If you want a particular Org Unit to not have access to specific
+entries, you may remove an entry. Removing an entry will remove it from 
+view. The entry will remain in the database, marked as disabled.
+
+* Select an entry and press the *Remove* button. 
+* Click *Save* to save your edits.  
+
+Adding an Entry
++++++++++++++++
+You may "add" entries that have been removed previously. This is useful
+for moving entries to different parents, or making them root entries.
+
+image::media/pgtde_02.png[Add Entry modal]
+
+* If desired, select an entry to be used as the parent entry. 
+* Press the *Add* button. 
+* Select a entry to add from the dropdown.
+* If you've selected a parent entry, you may check the *Add Root Entry*
+box to override that parent and add the entry on the root level. 
+* If you did not select a parent entry, the entry will be added on the root 
+level of the tree.
+* Click *Save* to save your edits.
+
+NOTE: There must be a disabled entry, or the *Add* button will be disabled.
+
diff --git a/docs/media/pgtde_01.png b/docs/media/pgtde_01.png
new file mode 100644 (file)
index 0000000..58895b2
Binary files /dev/null and b/docs/media/pgtde_01.png differ
diff --git a/docs/media/pgtde_02.png b/docs/media/pgtde_02.png
new file mode 100644 (file)
index 0000000..3a3106c
Binary files /dev/null and b/docs/media/pgtde_02.png differ