User Tools

Site Tools


evergreen-user:action_trigger

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
evergreen-user:action_trigger [2012/01/04 17:41] – [Event Definitions] edoceoevergreen-user:action_trigger [2022/02/10 13:34] (current) – external edit 127.0.0.1
Line 95: Line 95:
  
 == Granularity == == Granularity ==
 +
 +A string used to distinguish among events that should be run (by the action_trigger_runner.pl script) at different times.
 +
 +If a site is busy or large enough that all the events typically run overnight won't be able to finish by morning if they're all run in a big lump, or if you have some events that you don't even need to run every night, you can use the granularity field (and the --granularity and --granularity-only options of action_trigger_runner.pl) to group events and selectively run them.
 +
 == Max Event Validity Delay == == Max Event Validity Delay ==
 == Opt-In Setting Type == == Opt-In Setting Type ==
Line 128: Line 133:
  
 This allows one to define key/value type data which becomes available during the processing of the trigger (Validator, Reactor).  These options may be useful when creating custom validators for example.  The Parameter Name can match ///[\w,\-\.]+///, but just ///\w+/// is more practical.  The Parameter Value is eval'd on the server side, so they must be stored as valid Perl values.  For strings, wrap them in quotes.  This data is stored in action_trigger.event_params, also bound by event_def. This allows one to define key/value type data which becomes available during the processing of the trigger (Validator, Reactor).  These options may be useful when creating custom validators for example.  The Parameter Name can match ///[\w,\-\.]+///, but just ///\w+/// is more practical.  The Parameter Value is eval'd on the server side, so they must be stored as valid Perl values.  For strings, wrap them in quotes.  This data is stored in action_trigger.event_params, also bound by event_def.
 +
 +===== Processing Action Triggers =====
 +
 +When events occur records are created in the action_trigger.event table and these events are processed by the action_trigger_runner.pl script.  Usually as a set of cron tasks for the opensrf user.
 +
 +<code>
 +# General A/T
 +*/2 * * * * action_trigger_runner.pl --process-hooks --run-pending
 +
 +# Run Specific Granularity Only
 +20 20 * * * action_trigger_runner.pl --run-pending --granularity Daily-Active-Report --granularity-only
 +
 +# Just do these hooks
 +21 21 * * * action_trigger_runner.pl --run-pending --hooks=checkout
 +
 +# Example with Wrapper
 +4 4 * * * /openils/cron/daily-overdue.sh
 +</code>
 +
 +It's not uncommon to have dozens of entries in the crontab for Evergreen.  One may also want to create create wrapper shell scripts for the action_trigger_runner script to permit in-line documentation or other features.  Here is an example.
 +
 +<code>
 +#!/bin/bash
 +# I'm some documentation on this script!
 +# Run holds available, only the daily-hold granularity
 +
 +/openils/bin/action_trigger_runner.pl \
 +  --debug-stdout \
 +  --verbose \
 +  --run-pending \
 +  --hooks=hold.available \
 +  --granularity=Daily-Hold \
 +  --granularity-only \
 +  >/var/log/atr.log \
 +  2>/var/log/atr.log
 +
 +logger --id --tag atr "Action Trigger Runner for Daily Available Holds Done" 
 +</code>
  
evergreen-user/action_trigger.1325716874.txt.gz · Last modified: 2022/02/10 13:33 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.