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@larl.org>
Signed-off-by: Remington Steed <rjs7@calvin.edu>
Signed-off-by: Ben Shum <bshum@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 (executable)
--- 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 (file)
--- 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