[open-ils-commits] ***SPAM*** [GIT] Evergreen ILS branch master updated. d445150a1adb9b696dbf3531eca9d31d65224d5f
Evergreen Git
git at git.evergreen-ils.org
Thu Jan 22 16:23:39 EST 2015
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".
The branch, master has been updated
via d445150a1adb9b696dbf3531eca9d31d65224d5f (commit)
via 82bb11794dfac2fb2e9d711998261a88b25cad7f (commit)
from 9436b7c40f88af13f5bf3fac878f92e1e7c4e43c (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit d445150a1adb9b696dbf3531eca9d31d65224d5f
Author: Remington Steed <rjs7 at calvin.edu>
Date: Wed Nov 26 09:21:52 2014 -0500
LP#1396161: Improve public docs and change osrf-config default from script help
The public docs have an "Action Triggers" chapter, so this commit
applies the same improvements there to match the help docs in the
script. Also in the public docs, in two places a filename was split
across lines, causing a gap to appear in the HTML version of the docs.
That is corrected here. This commit also removes the 'osrf-config'
option from the examples in the script help docs, since they are using
the default value.
Signed-off-by: Remington Steed <rjs7 at calvin.edu>
Signed-off-by: Ben Shum <bshum at biblio.org>
diff --git a/Open-ILS/src/support-scripts/action_trigger_runner.pl.in b/Open-ILS/src/support-scripts/action_trigger_runner.pl.in
index 8f23780..1c217bc 100755
--- a/Open-ILS/src/support-scripts/action_trigger_runner.pl.in
+++ b/Open-ILS/src/support-scripts/action_trigger_runner.pl.in
@@ -135,14 +135,14 @@ $0 : Create and process action/trigger events
# To run all pending events that have no granularity set. This is what
# you tell CRON to run at regular intervals
- perl $0 --osrf-config @sysconfdir@/opensrf_core.xml --run-pending
+ perl $0 --run-pending
# To batch create all "checkout.due" events
- perl $0 --osrf-config @sysconfdir@/opensrf_core.xml --hooks=checkout.due --process-hooks
+ perl $0 --hooks=checkout.due --process-hooks
# To batch create all events for a specific granularity and to send notices for all pending
# events with that same granularity.
- perl $0 --osrf-config @sysconfdir@/opensrf_core.xml --run-pending --granularity=Hourly --process-hooks
+ perl $0 --run-pending --granularity=Hourly --process-hooks
HELP
}
diff --git a/docs/admin/actiontriggers.txt b/docs/admin/actiontriggers.txt
index 2d055a6..7d125e7 100644
--- a/docs/admin/actiontriggers.txt
+++ b/docs/admin/actiontriggers.txt
@@ -192,26 +192,54 @@ To run the action triggers, an Evergreen administrator will need to run the trig
You have several options when running the script:
-* --run-pending: Run the pending events
+* --run-pending: Run pending events to send emails or take other actions as
+specified by the reactor in the event definition.
* --process-hooks: Create hook events
-* --osrf-config=[config_file]: OpenSRF core config file. Defaults to: /openils/conf/
-opensrf_core.xml.
+* --osrf-config=[config_file]: OpenSRF core config file. Defaults to:
+/openils/conf/opensrf_core.xml
* --custom-filters=[filter_file]: 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
+that should use a user-defined filter to find their target objects. Defaults to:
+/openils/conf/action_trigger_filters.json
* --max-sleep=[seconds]: When in process-hooks mode, wait up to [seconds] for the lock file to go
away. Defaults to 3600 (1 hour).
* --hooks=hook1[,hook2,hook3,...]: Define which hooks to create events for. If none are defined, it
defaults to the list of hooks defined in the --custom-filters option.
+Requires --process-hooks.
+
+* --granularity=[label]: Limit creating events and running pending events to
+those only with [label] granularity setting.
* --debug-stdout: Print server responses to STDOUT (as JSON) for debugging.
* --lock-file=[file_name]: Sets the lock file for the process.
+* --verbose: Show details of script processing.
+
* --help: Show help information.
+Examples:
+
+* Run all pending events that have no granularity set. This is what you tell
+CRON to run at regular intervals.
++
+----
+perl action_trigger_runner.pl --run-pending
+----
+
+* Batch create all "checkout.due" events
++
+----
+perl action_trigger_runner.pl --hooks=checkout.due --process-hooks
+----
+
+* Batch create all events for a specific granularity and to send notices for all
+pending events with that same granularity.
++
+----
+perl action_trigger_runner.pl --run-pending --granularity=Hourly --process-hooks
+----
commit 82bb11794dfac2fb2e9d711998261a88b25cad7f
Author: Josh Stompro <stomproj at larl.org>
Date: Tue Nov 25 15:56:50 2014 -0600
LP#1396161: action_trigger_runner.pl documentation update
- Removed --granularity-only help docs. Ever since the script was changed to
support parallel execution of different granularity levels the granularity-only
setting has always been set when using --granularity.
- Added --verbose help docs. This option wasn't included in the help docs.
- Clarification - added some clarification to a few of the help descriptions.
- Added an additional example for processing hooks and running pending events
with a granularity set.
- Removed two references to the --granularity-only flag in the Telephony docs.
I believe this change is valid for 2.7, 2.6 and 2.5 since the change to the script
was made in 2010.
Signed-off-by: Josh Stompro <stomproj at larl.org>
Signed-off-by: Remington Steed <rjs7 at calvin.edu>
Signed-off-by: Ben Shum <bshum at biblio.org>
diff --git a/Open-ILS/src/support-scripts/action_trigger_runner.pl.in b/Open-ILS/src/support-scripts/action_trigger_runner.pl.in
index 9df711a..8f23780 100755
--- a/Open-ILS/src/support-scripts/action_trigger_runner.pl.in
+++ b/Open-ILS/src/support-scripts/action_trigger_runner.pl.in
@@ -100,7 +100,8 @@ $0 : Create and process action/trigger events
@sysconfdir@/action_trigger_filters.json
--run-pending
- Run pending events
+ Run pending events to send emails or take other actions as specified
+ by the reactor in the event definition.
--process-hooks
Create hook events
@@ -112,12 +113,11 @@ $0 : Create and process action/trigger events
--hooks=hook1[,hook2,hook3,...]
Define which hooks to create events for. If none are defined,
it defaults to the list of hooks defined in the --custom-filters option.
+ Requires --process-hooks
--granularity=<label>
- Run events with {label} granularity setting, or no granularity setting
-
- --granularity-only
- Used in combination with --granularity, prevents the running of events with no granularity setting
+ Limit creating events and running pending events to those only
+ with <label> granularity setting.
--debug-stdout
Print server responses to stdout (as JSON) for debugging
@@ -125,18 +125,25 @@ $0 : Create and process action/trigger events
--lock-file=<file_name>
Lock file
+ --verbose
+ Show details of script processing.
+
--help
Show this help
Examples:
- # To run all pending events. This is what you tell CRON to run at
- # regular intervals
+ # To run all pending events that have no granularity set. This is what
+ # you tell CRON to run at regular intervals
perl $0 --osrf-config @sysconfdir@/opensrf_core.xml --run-pending
# To batch create all "checkout.due" events
perl $0 --osrf-config @sysconfdir@/opensrf_core.xml --hooks=checkout.due --process-hooks
+ # To batch create all events for a specific granularity and to send notices for all pending
+ # events with that same granularity.
+ perl $0 --osrf-config @sysconfdir@/opensrf_core.xml --run-pending --granularity=Hourly --process-hooks
+
HELP
}
diff --git a/docs/TechRef/Telephony/telephony-setup-guide.txt b/docs/TechRef/Telephony/telephony-setup-guide.txt
index 04363ea..251262b 100644
--- a/docs/TechRef/Telephony/telephony-setup-guide.txt
+++ b/docs/TechRef/Telephony/telephony-setup-guide.txt
@@ -386,7 +386,7 @@ On your institution's utility server, change to the opensrf user and issue the f
NOTE: For a busy institution that might have lots of overdue circulations (> 1000) you should take care to do this at some point in the day that won't disrupt other important processes on the utility box. This could take a while (hours, potentially).
-------------------------------------------------------
-/openils/bin/action_trigger_runner.pl --run-pending --process-hooks --granularity Telephony --granularity-only
+/openils/bin/action_trigger_runner.pl --run-pending --process-hooks --granularity Telephony
-------------------------------------------------------
When that command finishes, you should have some rows in your *action_trigger.event* table where the "event_def" column matches the ID of the telephony event definition you just set up and the "state" column is "complete".
@@ -575,7 +575,7 @@ On the other hand, if you're eventually going to run telephony notices for holds
-------------------------------------------------------
# Runs all pending telephony A/T events every half hour (offset by 10 min)
-10,40 * * * * . ~/.bashrc && /openils/bin/action_trigger_runner.pl --osrf-config /openils/conf/opensrf_core.xml --run-pending --process-hooks --granularity Telephony --granularity-only
+10,40 * * * * . ~/.bashrc && /openils/bin/action_trigger_runner.pl --osrf-config /openils/conf/opensrf_core.xml --run-pending --process-hooks --granularity Telephony
-------------------------------------------------------
Holidays
-----------------------------------------------------------------------
Summary of changes:
.../support-scripts/action_trigger_runner.pl.in | 25 ++++++++-----
docs/TechRef/Telephony/telephony-setup-guide.txt | 4 +-
docs/admin/actiontriggers.txt | 38 +++++++++++++++++---
3 files changed, 51 insertions(+), 16 deletions(-)
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list