Docs: Adding group penalty thresholds
authorJennifer Pringle <jennifer.pringle@bc.libraries.coop>
Mon, 13 Jun 2022 20:29:56 +0000 (13:29 -0700)
committerJane Sandberg <js7389@princeton.edu>
Wed, 17 Aug 2022 19:57:58 +0000 (12:57 -0700)
new page and screenshots for group penalty thresholds

Signed-off-by: Jane Sandberg <js7389@princeton.edu>
docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-1.png [new file with mode: 0644]
docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-2.png [new file with mode: 0644]
docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-3.png [new file with mode: 0644]
docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-4.png [new file with mode: 0644]
docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-5.png [new file with mode: 0644]
docs/modules/local_admin/nav.adoc
docs/modules/local_admin/pages/group_penalty_thresholds.adoc [new file with mode: 0644]

diff --git a/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-1.png b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-1.png
new file mode 100644 (file)
index 0000000..72499e7
Binary files /dev/null and b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-1.png differ
diff --git a/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-2.png b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-2.png
new file mode 100644 (file)
index 0000000..b4122a7
Binary files /dev/null and b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-2.png differ
diff --git a/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-3.png b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-3.png
new file mode 100644 (file)
index 0000000..ba034ce
Binary files /dev/null and b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-3.png differ
diff --git a/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-4.png b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-4.png
new file mode 100644 (file)
index 0000000..25cce38
Binary files /dev/null and b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-4.png differ
diff --git a/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-5.png b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-5.png
new file mode 100644 (file)
index 0000000..6e6939d
Binary files /dev/null and b/docs/modules/local_admin/assets/images/group_penalty_thresholds/group-penalty-thresholds-5.png differ
index 01f8d80..c349dd3 100644 (file)
@@ -3,6 +3,7 @@
 ** xref:admin:lsa-address_alert.adoc[Address Alert]
 ** xref:admin:lsa-barcode_completion.adoc[Barcode Completion]
 ** xref:admin:emergency_closing_handler.adoc[Emergency Closing Handler]
+** xref:local_admin:group_penalty_thresholds.adoc[Group Penalty Thresholds]
 ** xref:admin:hold_driven_recalls.adoc[Hold-driven recalls]
 ** xref:admin:hold_groups_admin.adoc[Hold Groups Administration]
 ** xref:local_admin:multiple_holds_admin.adoc[Placing Multiple Holds]
diff --git a/docs/modules/local_admin/pages/group_penalty_thresholds.adoc b/docs/modules/local_admin/pages/group_penalty_thresholds.adoc
new file mode 100644 (file)
index 0000000..a665fa4
--- /dev/null
@@ -0,0 +1,60 @@
+= Group Penalty Thresholds =
+:toc:
+
+Group Penalty Thresholds block circulation transactions for users who exceed maximum check out limits, 
+number of overdue items, or fines. Settings for your library are visible under 
+*Administration -> Local Administration-> Group Penalty Thresholds*. There are four penalties in use now.
+
+
+* PATRON_EXCEEDS_FINES:        Blocks new circulations and renewals if patron exceeds X in fines
+* PATRON_EXCEEDS_OVERDUE_COUNT:        Blocks new circulations if patron exceeds X overdue items
+* PATRON_EXCEEDS_CHECKOUT_COUNT: Blocks new circulations if patron exceeds X items out
+* PATRON_EXCEEDS_LOST_COUNT: Blocks new circulations and placing holds if patron exceeds X lost items
+
+
+Accounts that meet or exceed penalty thresholds display an alert message when opened and require staff 
+overrides for blocked transactions.
+
+Group Penalty Thresholds may be set up on different levels in terms of patron profiles and libraries. 
+Penalties on more specific levels of profile and/or library take precedence. This allows you to 
+set up penalties on a higher level of profile and/or library system instead of branch, for most 
+profiles and/or branches to share. If there are rules applied to lower level profiles or a branch, 
+you just need to set them up for these specific profile/branch.
+
+== Creating Local Penalty Thresholds ==
+
+. Go to *Administration -> Local Administration -> Group Penalty Threshold*.
+
+To view the group penalty thresholds for your library enter your library code into the Library filter.
+Multi-branch libraries can enter the system and then check the box to display the descendants.
+
+image::group_penalty_thresholds/group-penalty-thresholds-1.png[Library Filter]
+
+. Click *New Penalty Threshold*.
++
+image::group_penalty_thresholds/group-penalty-thresholds-2.png[]
++
+. Choose or enter the appropriate value for each field.
+. Click *Save*.
++
+image::group_penalty_thresholds/group-penalty-thresholds-3.png[]
+
+TIP: You may set up penalties with a too high to reach limit to achieve the no limit effect.
+
+== Editing Local Penalty Thresholds ==
+
+. Select the penalty you'd like to edit.
+. Click the actions button and select *Edit Selected*.
+. Make your changes and click *Save*.
++
+image::group_penalty_thresholds/group-penalty-thresholds-4.png[]
+
+Double clicking a penalty on the list will open it in editing mode. Edit, then save.
+
+== Deleting Local Penalty Thresholds ==
+
+. Select the penalty you'd like to delete.
+. Click the actions button and select *Delete Selected*.
+. The penalty will be deleted.
++
+image::group_penalty_thresholds/group-penalty-thresholds-5.png[]
\ No newline at end of file