From f6eccc6ad0f8f4c856a7fa28558899df67d81b7d Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Wed, 6 Oct 2010 14:24:30 -0400 Subject: [PATCH] Add notifications section to server administration chapter. Action trigger edits. --- 1.6/admin/actiontriggers.xml | 37 +++--- 1.6/admin/serveradministration.xml | 196 ++++++++++++++++++++++++++++- 2 files changed, 211 insertions(+), 22 deletions(-) diff --git a/1.6/admin/actiontriggers.xml b/1.6/admin/actiontriggers.xml index ff2ad72d5f..82c6a47ec6 100644 --- a/1.6/admin/actiontriggers.xml +++ b/1.6/admin/actiontriggers.xml @@ -295,27 +295,22 @@ The following items are 90 days overdue and have been marked LOST. To run the action triggers, an Evergreen administrator will need to run the trigger processing script /openils/bin/action_trigger_runner.pl . This should be set up as a cron job to run periodically. - You will need to add some Hooks to the /openils/conf/action_trigger_filters.json file. Below is an example to add the password.reset_request, - hold.available and checkout.due hooks so that they will be processed by action_trigger_runner.pl. - - - + You have several options when running the script: + + : Run the pending events. + : Create hook events + : OpenSRF core config file. Defaults to: + /openils/conf/opensrf_core.xml. + : File containing a JSON Object which describes any hooks that should + use a user-defined filter to find their target objects. Defaults to: /openils/conf/action_trigger_filters.json + : When in process-hooks mode, wait up to [seconds] for the lock file to go away. + Defaults to 3600 (1 hour). + : Define which hooks to create events for. If none are defined, it defaults to the list of hooks defined + in the option. + : Print server responses to stdout (as JSON) for debugging. + : Sets the lock file for the process. + : Show help information. + diff --git a/1.6/admin/serveradministration.xml b/1.6/admin/serveradministration.xml index cf27a50bb7..5bd6e4ca6f 100644 --- a/1.6/admin/serveradministration.xml +++ b/1.6/admin/serveradministration.xml @@ -2048,6 +2048,200 @@ WHERE id = 17;
- Notifications + Email Notifications + Email notifications can be set up for Holds, Overdue items and Predue items. There are two ways to configure notifications for each of these type of notifications. +
+ Hold Notifications + Hold notifications can be used that that library users are sent an email when their items are available for pickup. This notification is triggered when the item being held + is captured by a library staff member and the item is in the on holds shelf status. + + Hold Notifications using the Action Trigger + The easiest way to set up hold notifications is to use the Action Trigger mechanism introduced in Evergreen 1.6. + + + From the staff client menu, Click on + + Admin + Local Administration + Notifications / Action triggers + + + + + + Locate the Action Trigger Definition with the Name Hold Ready for Pickup Email Notification. + + + Double click on the item row to open the editing page, but not on the hyperlinked Name + + + Double click on the item row to open the editing page, but not on the hyperlinked Name + + + Check the Enabled check box to enable it. + + + Edit the Template text box to customize the body of the email as needed. Note that text between [% %] are variables to be + generated by the system. For example, [% user.family_name %] with be replaced by the family name of the user receiving a notice. + + + Click Save to save your changes. + + + Hold notices are now activated and will be processed the next time action triggers are processed. See for + more details on processing action triggers. + + + + + Hold Notifications using the Evergreen Configuration File + An older method for Setting up hold notifications is through the Configuration file /openils/conf/opensrf.xml. + + + Open the file /openils/conf/opensrf.xml with your favorite text editor + Locate this section of the configuration file: + + +true + +]]> + + + + Ensure that <email> is set to true. + + + Locate the following section of the configuration file: + + + +... +]]> + + Point the <template> variable to the hold notification template you will be using for hold notifications. + + + Locate the template and edit as desired. Use the example template provided as a guide. + + + +
+
+ Overdue and Predue Notifications + Overdue and Predue email notifications can be used to inform users that they have materials which are overdue or to warn them that materials are almost overdue. + + Activating Overdue Existing Overdue Action Triggers + The easiest way to set up overdue notifications is to use the Action Trigger mechanism introduced in Evergreen 1.6. + + + From the staff client menu, Click on + + Admin + Local Administration + Notifications / Action triggers + + + + + + Locate the Action Trigger Definition you wish to activate. There are several overdue notices preloaded wit Evergreen 1.6. + + + Double click on the item row to open the editing page, but not on the hyperlinked Name + + + Double click on the item row to open the editing page, but not on the hyperlinked Name + + + Check the Enabled check box to enable it. + + + Edit the Template text box to customize the body of the email as needed. Note that text between [% %] are variables to be + generated by the system. For example, [% user.family_name %] with be replaced by the family name of the user receiving a notice. + + + Click Save to save your changes. + + + Overdue notices are now activated and will be processed the next time action triggers are processed. See for + more details on processing action triggers. + + + + + Creating Overdue and Predue Notifications by Cloning Existing Action Triggers + If you wish to add overdue notices for different periods of time or wish to create a predue notice simply clone an existing overdue note, give it a + unique Name, customize as needed. and save. + There are no pre-existing predue notices so they will need to be created by cloning an existing overdue notice. + To make them predue notices, use a negative value in the Processing Delay Context Field. For example, to create a predue notice the day before the + due date, use the value -1 days. + + + Creating Overdue and Predue Notices using the Evergreen Configuration File + It is also possible to create overdue and predue notices using the Evergreen configuration file /openils/conf/opensrf.xml + + + Open /openils/conf/opensrf.xml with your favorite text editor. + Locate this section of the configuration file: + + +... + + + 7 days + + noemail + + true + + /openils/var/data/templates/overdue_7day.example + + + + + + + + 3 days + 13 days + + + 1 day + false + true + /openils/var/data/templates/predue_1day.example + + +... +]]> + + + + From this section of the configuration file, you may: + + Point to the template file for the specific notice: <email_template> + Set the interval time for the specific notice: <notify_interval> + Indicate whether to attempt email notification for the notice: <email_notify> + For predue notices, you may also specify on which circulation ranges to activate the courtesy notice: + <circ_duration_range> + + + + Locate the templates and edit as desired. Use the example templates provided as guides. + + + From the configuration file you may also set the default email sender address. however, this is just the default and the email sender + address for specific organizational units can be specified in the library settings editor + from the staff client. + + + You also need to set the email server from the configuration file. By default, it uses the localhost. + +
-- 2.43.2