Changes between Initial Version and Version 1 of sysadminGeneratingEmailNotices


Ignore:
Timestamp:
Jun 23, 2009, 9:25:00 AM (13 years ago)
Author:
Dan Scott
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • sysadminGeneratingEmailNotices

    v1 v1  
     1= Generating email notices =
     2
     3'''Note''': the following method is the legacy way of generating email notices for overdues and reminders. A new method based on the action/trigger/event mechanism launched in Evergreen 1.6 relying on passive scripts and supports wonderful things like patron's locale preferences, etc. However, the legacy method is what we have working today, so let's roll with it.
     4
     5Out of the box, Evergreen provides templates for a reminder notice the day before an item is due, and an overdue notice that is generated 7 days after the item was due.
     6
     7{{{
     8# We run the script out of the source directory due to a dependency on oils_header.pl
     9# Eventually we should just copy all the files into the normal bin directory
     10cd /home/lauadmin/Evergreen-trunk/Open-ILS/src/support-scripts/
     11# Dump the help for the script
     12perl generate_circ_notices.pl --help
     13
     14Evergreen Circulation Notice Generator
     15
     16    ---osrf_config <config_file>
     17
     18    --send-email
     19        If set, generate email notices
     20
     21    --use-email-outfile <file>
     22        Instead of sending emails, append each email (complete with headers) to this file
     23
     24    --use-email-recipient <user@example.com>
     25        Send all email notices to this user instead of the patron.  This updates the
     26        email address on the user object attached to the circulations, so no
     27        change to the email templates is required.
     28
     29    --generate-day-intervals
     30        If set, notices which have a notify_interval of >= 1 day will be processed.
     31
     32    --generate-global-templates
     33        Collect all non-emailed notices into a global set and generate templates based on that set.
     34
     35    --append-global-email-fail
     36        If an attempt was made to send an email notice but it failed, the notice is appended
     37        to the global notice file set.  This will only have any bearing if --generate-global-templates
     38        is enabled.
     39
     40    --days-back <days_back_comma_separted>
     41        This is used to set the effective run date of the script.
     42        This is useful if you don't want to generate notices on certain days.  For example, if you don't
     43        generate notices on the weekend, you would run this script on weekdays and set --days-back to
     44        0,1,2 when it's run on Monday to capture any notices from Saturday and Sunday.
     45
     46    --notice-types <overdue,predue,...>
     47        Comma-separated list of notice types to generate for this run of the script
     48
     49    --help
     50        Print this help message
     51# So, to dump the output of both reminders and overdues into a file for review for the last 7 days:
     52perl generate_circ_notices.pl --use-email-outfile ~/fakeemail.lst --notice-type overdue,predue --days-back 0,1,2,3,4,5,6,7
     53}}}