Differences

This shows you the differences between two versions of the page.

--- evergreen-admin:customization:circ [2009/10/26 18:44] – phasefx
+++ evergreen-admin:customization:circ [2022/02/10 13:34] (current) – external edit 127.0.0.1
@@ Line 37: / Line 37: @@
 ===== Circ Scripts =====
+FIXME Need more here + examples
+==== Description of Default Files ====
+These files are found in /openils/var on your Evergreen server.
+=== circ/circ_lib.js ===
+  * this file contains a library of often used functions and constants.  these can be called in other scripts and you can add your own utility functions here.
+  * Some examples:
+    * findGroupConfig(): returns the config values from circ_groups.js
+    * isGroupDescendant( parent, child): returns true if the child patron group is a descendent of the parent
+    * isPrecat: a constant that returns true/false if an item is a pre-cat
+=== circ/circ_duration.js ===
+  * this file is called when an item is checked out and results in:
+    * loan duration rule
+    * recurring fine rule
+    * max fine rule
+=== circ/circ_groups.js ===
+  * this file determines patron limits
+  * the function findGroupConfig() retrieves values from this file
+    * this function is called in circ_permit_hold.js, circ_permit_patron.js and patron_penalty.js
+=== circ/circ_permit_copy.js ===
+=== circ/circ_permit_patron.js ===
+=== penalty/patron_penalty.js ===
+=== circ/circ_permit_hold.js ===
+  * called on renewal, can be used to prevent holds
+=== circ/circ_permit_renew.js ===
+  * called on renewal, can be used to prevent renewals
 ===== In-db Circ Matrix =====