docs/modules/admin/pages/lsa-standing_penalties.adoc

   1 = Standing Penalties =
   2 :toc:
   3
   4 Evergreen includes twenty-one stock penalties, and adminstrators can create other penalty types if needed. Each penalty can be configured to block zero, one, or several circulation actions.
   5
   6 Penalties can be viewed and edited by navigating to *Administration -> Local Administration -> Standing Penalties.
   7
   8 [[standing_penalty_types]]
   9 == Standing Penalty Types ==
  10
  11 The following standing penalties are available in Evergreen:
  12
  13 * PATRON_EXCEEDS_FINES - Patron exceeds fine threshold
  14 * PATRON_EXCEEDS_OVERDUE_COUNT - Patron exceeds max overdue item threshold
  15 * PATRON_EXCEEDS_CHECKOUT_COUNT - Patron exceeds max checked out item threshold
  16 * PATRON_EXCEEDS_COLLECTIONS_WARNING - Patron exceeds pre-collections warning fine threshold
  17 * PATRON_EXCEEDS_LOST_COUNT - Patron exceeds max lost item threshold
  18 * ALERT_NOTE - Alerting note, no blocks
  19 * SILENT_NOTE - Note, no blocks
  20 * STAFF_C - Alerting block on Circ
  21 * STAFF_CH - Alerting block on Circ and Hold
  22 * STAFF_CR - Alerting block on Circ and Renew
  23 * STAFF_CHR - Alerting block on Circ, Hold and Renew
  24 * STAFF_HR - Alerting block on Hold and Renew
  25 * STAFF_H - Alerting block on Hold
  26 * STAFF_R - Alerting block on Renew
  27 * INVALID_PATRON_ADDRESS - Patron has an invalid address
  28 * PATRON_IN_COLLECTIONS - Patron has been referred to a collections agency
  29 * INVALID_PATRON_EMAIL_ADDRESS - Patron had an invalid email address
  30 * INVALID_PATRON_DAY_PHONE - Patron had an invalid daytime phone number
  31 * INVALID_PATRON_EVENING_PHONE - Patron had an invalid evening phone number
  32 * INVALID_PATRON_OTHER_PHONE - Patron had an invalid other phone number
  33 * PATRON_EXCEEDS_LONGOVERDUE_COUNT - Patron exceeds max long-overdue threshold
  34
  35 The following penalties are system applied:
  36
  37 * PATRON_EXCEEDS_FINES
  38 * PATRON_EXCEEDS_OVERDUE_COUNT
  39 * PATRON_EXCEEDS_CHECKOUT_COUNT
  40 * PATRON_EXCEEDS_COLLECTIONS_WARNING
  41 * PATRON_EXCEEDS_LOST_COUNT
  42 * PATRON_IN_COLLECTIONS
  43 * PATRON_EXCEEDS_LONGOVERDUE_COUNT
  44
  45 All other penalties are manually applied by a staff member or via a specific staff action.
  46
  47 For any penalties that use threshold values, you can configure those threshold values in *Administration -> Local Administration-> Group Penalty Thresholds*. Refer to documentation for xref:local_admin:group_penalty_thresholds.adoc[Group Penalty Thresholds].
  48
  49 For information on how to manually apply penalties to a patron account, see the xref:circulation:circulation_patron_records_web_client.html#_alerts[Alerts and Blocks] documentation.
  50
  51 [[blocked_actions]]
  52 == Blocked Actions ==
  53
  54 The following circulation actions can be blocked by penalties:
  55
  56 * *CIRC* - Users cannot check out items, except items which may fill a hold. Items which can fill a hold are subjec to the FULFILL action, which is listed below and can be blocked separately.
  57 * *HOLD* - Users cannot place holds on items.
  58 * *RENEW* - Users cannot renew items.
  59 * *CAPTURE* - This penalty prevents a user's holds from being captured. If the _HOLD_ penalty has not been applied to a user's account, then the patron can place a hold, but the targeted item will not appear on a pull list and will not be
  60 captured for a hold if it is checked in.
  61 * *FULFILL* - This penalty prevents a user from checking out an item that is on hold.  If the _HOLD_ and _CAPTURE_ penalties have not been applied to a user's account, then the user can place a hold on an item, and the item can be captured
  62 for a hold.  However, when they try to check out the item, the circulator will see a pop up box with the name of the penalty type, _FULFILL_.  The circulator must correct the problem with the account or must override the penalty to check out the item.
  63
  64 [[standing_penalty_grid]]
  65 == Standing Penalty Types Grid ==
  66
  67 The grid for Standing Penalty Types displays the following columns:
  68
  69 * _Penalty ID_ - the system assigned penalty ID number
  70 * _Name_ -  the name of the penalty. This cannot be edited for any of the stock penalties since they are referenced by name in legacy code. Do not use spaces in the penalty name.
  71 * _Label_ - a brief description of the penalty
  72 * _Block List_ - a list of the actions blocked by the penalty. These actions are listed in the Blocked Actions section above, and can be entered in any order using the pipe character as a delimiter.
  73 * _Staff Alert_ - this indicates whether a staff member will be alerted about the penalty when viewing a patron's account.
  74 * _Org Depth_ - the scope of the penalty, in terms of where a block or restriction will apply relative to the organizational unit where the penalty is calculated (e.g., the circulation library).
  75 ** If you are using Group Penalty Thresholds, Org Depth matters if the 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 penalty Org Depth to 0, otherwise penalty blocks will only apply at the level they are mapped to a threshold.
  76 ** Valid values for Org Depth include:
  77 *** NULL / no value set
  78 *** 0 - penalty applies to the Consortium
  79 *** 1 - penalty applies to the System
  80 *** 2 - penalty applies to the Branch
  81 *** 3 - penalty applies to the Sub-library
  82 * _Ignore Proximity_ - if a numeric value is set here, this instructs the system to ignore a penalty if the proximity between a patron's home library and the item's home (or circulating) library is greater than the Ignore Proximity value. Possible values include:
  83 ** NULL / no value set - penalty is not ignored anywhere
  84 ** 0 - penalty is ignored at the patron's home branch
  85 ** 2 - penalty is ignored at the patron's home system
  86
  87 NOTE: Ignore Proximity will honor proximity adjustments. See the documentation on xref:admin:Org_Unit_Proximity_Adjustments.adoc[Org Unit Proximity Adjustments] for more information about proximity adjustments. Consult your Evergreen administrator if you are not sure whether or not your Evergreen installation uses proximity adjustments.
  88
  89 Actions on the grid include Delete Selected and Edit Selected, as well as a separate button for New Standing Penalty Type. You can also edit a penalty type by double clicking on its grid row.
  90
  91 [[editing_penalty_type]]
  92 == Editing a Standing Penalty Type ==
  93
  94 To edit a standing penalty, either select the row and then navigate to Edit Selected in the Actions Menu on the upper right of the grid, right click on the row and choose Edit Selected, or double click on the grid row you wish to edit.
  95
  96 This will open the edit modal:
  97
  98 image::lsa-standing_penalties/penalty_edit_modal.png[Standing Penalty Edit Modal]
  99
 100 Make your desired changes, and select *Save* to save your changes, or *Cancel* to exit the modal without saving.
 101
 102 NOTE: The Name field cannot be edited for any of the stock penalties since they are referenced by name in legacy code.
 103
 104 NOTE: Do not use spaces in the penalty name.
 105 [[creating_penalty_type]]
 106 == Creating a Standing Penalty Type ==
 107
 108 To create a new standing penalty type, select the New Standing Penalty Type button in the upper-left of the grid. This will open the create modal.
 109
 110 Enter your penalty values in the appropriat fields, documented above under Standing Penalty Types Grid. The only field that is required is Name. Do not use spaces in the penalty name. All other fields are optional.
 111
 112 Select *Save* to save your changes, or *Cancel* to exit the modal without saving.
 113
 114 Standing penalties can be shared and used by the full Evergreen consortium.
 115
 116 TIP: If you add a penalty, a stock Evergreen system cannot automatically apply the new penalty. Added penalties need to be manually applied by a staff member to a patron account, or custom code needs to be written to automatically apply the new penalty. See the documentation about xref:circulation:circulation_patron_records_web_client.adoc#patron_blocks[circulation blocks] for more information about manually applying a penalty.
 117
 118 [[deleting_penalty_type]]
 119 == Deleting a Standing Penalty Type ==
 120
 121 To delete a standing penalty type, either select the row and then navigate to Delete Selected in the Actions Menu on the upper right of the grid or right click on the row and choose Delete Selected.
 122
 123 WARNING: The interface does not warn you before deleting a standing penalty type, and deleting stock standing penalty types may cause unintended negative consequences in your Evergreen system. Proceed with extreme caution.