Docs reorg: splitting action/triggers into command-line and staff-client manuals
authorJane Sandberg <sandbej@linnbenton.edu>
Mon, 18 Sep 2017 14:35:47 +0000 (07:35 -0700)
committerJane Sandberg <sandbej@linnbenton.edu>
Mon, 18 Sep 2017 14:35:47 +0000 (07:35 -0700)
Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
docs/admin/actiontriggers.adoc
docs/admin/actiontriggers_process.adoc [new file with mode: 0644]
docs/installation/server_installation.adoc
docs/root_command_line_admin.adoc

index 08df5a9..47801ce 100644 (file)
@@ -188,65 +188,3 @@ Table 4. Action Trigger Validators
 
 You may also create, edit and delete Validators. Just remember that their must be an associated subroutine in the Reactor.pm Perl module.
 
 
 You may also create, edit and delete Validators. Just remember that their must be an associated subroutine in the Reactor.pm Perl module.
 
-Processing Action Triggers
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To run the action triggers, an Evergreen administrator will need to run the trigger processing script. This should be set up as a cron job to run periodically. To run the script, use this command:
-
-----
-/openils/bin/action_trigger_runner.pl --process-hooks --run-pending
-----
-
-You have several options when running the script:
-
-* --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
-
-* --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
-
-* --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
-----
diff --git a/docs/admin/actiontriggers_process.adoc b/docs/admin/actiontriggers_process.adoc
new file mode 100644 (file)
index 0000000..8a6fc86
--- /dev/null
@@ -0,0 +1,63 @@
+Processing Action Triggers
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To run action triggers, an Evergreen administrator will need to run the trigger processing script. This should be set up as a cron job to run periodically. To run the script, use this command:
+
+----
+/openils/bin/action_trigger_runner.pl --process-hooks --run-pending
+----
+
+You have several options when running the script:
+
+* --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
+
+* --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
+
+* --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
+----
+
index 1273865..1634e7a 100644 (file)
@@ -438,8 +438,8 @@ To enable the default set of hooks, issue the following command as the
 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
 ------------------------------------------------------------------------------
 
 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
 ------------------------------------------------------------------------------
 
-For more information about configuring and using action triggers, see
-<<_notifications_action_triggers,Notifications / Action Triggers>>.
+For more information about configuring and running action triggers, see
+<<_processing_action_triggers,Notifications / Action Triggers>>.
 
 Creating the Evergreen database
 -------------------------------
 
 Creating the Evergreen database
 -------------------------------
index 6cd68b8..d9dcbf1 100644 (file)
@@ -58,6 +58,8 @@ include::development/pgtap.adoc[]
 
 include::development/support_scripts.adoc[]
 
 
 include::development/support_scripts.adoc[]
 
+include::admin/actiontriggers_process.adoc[]
+
 include::reports/reporter_daemon.adoc[]
 
 
 include::reports/reporter_daemon.adoc[]
 
 
@@ -82,11 +84,6 @@ include::development/updating_translations_launchpad.adoc[]
 :leveloffset: 0
 
 
 :leveloffset: 0
 
 
-Local Administration
-====================
-
-include::admin/actiontriggers.adoc[]
-
 // CATALOGING ADMIN
 
 Cataloging Administration
 // CATALOGING ADMIN
 
 Cataloging Administration