docs/modules/local_admin/pages/group_penalty_thresholds.adoc

   1 = Group Penalty Thresholds =
   2 :toc:
   3
   4 Group Penalty Thresholds enable you to configure which penalty thresholds apply to which patron groups and organizational units. This interface is accessed at *Administration -> Local Administration -> Group Penalty Thresholds*. Stock Evergreen includes four penalties each with a threshold value of 10, and you can configure three others as needed.
   5
   6 * PATRON_EXCEEDS_FINES: Blocks specified circulation actions if patron exceeds X in fines
   7 * PATRON_EXCEEDS_OVERDUE_COUNT: Blocks specified circulation actions if patron exceeds X overdue items
   8 * PATRON_EXCEEDS_CHECKOUT_COUNT: Blocks specified circulation actions if patron exceeds X items checked out
   9 * PATRON_EXCEEDS_LOST_COUNT: Blocks specified circulation actions if patron exceeds X lost items
  10
  11 Additional penalties that can be configured with Group Penalty Thresholds include:
  12
  13 * PATRON_EXCEEDS_LONGOVERDUE_COUNT: Blocks specified circulation actions if patron exceeds X long-overdue items
  14 * PATRON_EXCEEDS_COLLECTION_WARNING: Blocks specified circulation actions if patron exceeds X in fines. A user with this penalty will be flagged for review by the Collections API.
  15 * PATRON_IN_COLLECTIONS: Blocks specified circulation actions if patron exceeds X in fines. This penalty is set by the Collections API.
  16
  17 Accounts that meet or exceed penalty thresholds display an alert message when opened and require staff overrides for blocked transactions.
  18
  19 To configure which circulation actions are blocked by each penalty, navigate to *Administration -> Local Administration -> Standing Penalties* and refer to the documentation for xref:admin:lsa-standing_penalties.adoc[Standing Penalties]. Note that the Org Depth of the standing penalty matters if your Group Penalty Threshold is not at the top of the organization tree. If you want all penalty blocks to take effect everywhere, you will need to set the standing penalty Org Depth to 0, otherwise penalty blocks will only apply at the level they are mapped to a threshold.
  20
  21 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.
  22
  23 Penalty thresholds are not retroactive - they will only be applied to new circulation transactions that occur after the penalty threshold is set.
  24
  25 == Creating Group Penalty Thresholds ==
  26 [[create_group_penalty_thresholds]]
  27
  28 . Go to *Administration -> Local Administration -> Group Penalty Threshold*.
  29 +
  30 To view the group penalty thresholds for your library enter your library shortname into the Library filter. This value will default to your workstation library.
  31 Multi-branch libraries can enter the system and then check the box to display the descendants.
  32 +
  33 image::group_penalty_thresholds/group-penalty-thresholds-1.png[Library Filter]
  34
  35 . Select *New Group Penalty Threshold*.
  36 +
  37 image::group_penalty_thresholds/group-penalty-thresholds-2.png[New Group Penalty Threshold]
  38 +
  39 . Choose or enter the appropriate value for each field.
  40 .. _Group_: The patron profile group to which the threshold should apply. If your selected profile group has sub-groups (or child groups) they will be included in this threshold unless they have their own more specific threshold set.
  41 .. _ID_: The system-assigned ID for the Group Penalty Threshold.
  42 .. _Penalty_: The penalty for which the threshold should be set.
  43 .. _Org Unit_: The library organizational unit to which the threshold should apply. Child organizaional units will be included in this threshold unless they have their own more specific threshold set.
  44 ... *Note:* This dropdown includes several penalties for which numerical thresholds are not applicable. For the purposes of the Group Penalty Thresholds interface, you can ignore ALERT_NOTE, SILENT_NOTE, and anything that starts with INVALID_ or STAFF_
  45 .. _Threshold_: The numeric value of the threshold. This can represent a monetary value or a count value depending on the selected penalty.
  46 . Select *Save* to save your changes, or *Cancel* to exit the modal without saving.
  47 +
  48 image::group_penalty_thresholds/group-penalty-thresholds-3.png[Group Penalty Threshold Editor]
  49
  50 TIP: You may set up penalties with a too high to reach limit to achieve the no limit effect.
  51
  52 TIP: If you create a new penalty type in Standing Penalties, you can use Group Penalty Threshold to map it to a specific threshold, if a numeric threshold is applicable for that penalty.
  53
  54 == Editing Group Penalty Thresholds ==
  55 [[edit_group_penalty_thresholds]]
  56
  57 . Select the penalty you'd like to edit.
  58 . Click the actions button and select *Edit Selected*.
  59 . Make your changes and click *Save*.
  60 +
  61 image::group_penalty_thresholds/group-penalty-thresholds-4.png[Group Penalty Actions Menu]
  62
  63 Double clicking a penalty on the list will also open it in editing mode. Edit, then save.
  64
  65 == Deleting Group Penalty Thresholds ==
  66 [[delete_group_penalty_thresholds]]
  67
  68 . Select the penalty you'd like to delete.
  69 . Click the actions button and select *Delete Selected*.
  70 . The penalty will be deleted.
  71 +
  72 image::group_penalty_thresholds/group-penalty-thresholds-5.png[Group Penalty Actions Menu]