From 10c578a66cc9814045e5576d9c6d941d7aed5b0f Mon Sep 17 00:00:00 2001 From: Jane Sandberg Date: Mon, 18 Sep 2017 07:35:47 -0700 Subject: [PATCH] Docs reorg: splitting action/triggers into command-line and staff-client manuals Signed-off-by: Jane Sandberg --- docs/admin/actiontriggers.adoc | 62 --------------------- docs/admin/actiontriggers_process.adoc | 63 ++++++++++++++++++++++ docs/installation/server_installation.adoc | 4 +- docs/root_command_line_admin.adoc | 7 +-- 4 files changed, 67 insertions(+), 69 deletions(-) create mode 100644 docs/admin/actiontriggers_process.adoc diff --git a/docs/admin/actiontriggers.adoc b/docs/admin/actiontriggers.adoc index 08df5a9be2..47801ce2de 100644 --- a/docs/admin/actiontriggers.adoc +++ b/docs/admin/actiontriggers.adoc @@ -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. -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 index 0000000000..8a6fc861d3 --- /dev/null +++ b/docs/admin/actiontriggers_process.adoc @@ -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 +---- + diff --git a/docs/installation/server_installation.adoc b/docs/installation/server_installation.adoc index 1273865f30..1634e7a816 100644 --- a/docs/installation/server_installation.adoc +++ b/docs/installation/server_installation.adoc @@ -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 ------------------------------------------------------------------------------ -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 ------------------------------- diff --git a/docs/root_command_line_admin.adoc b/docs/root_command_line_admin.adoc index 6cd68b8cbe..d9dcbf14b6 100644 --- a/docs/root_command_line_admin.adoc +++ b/docs/root_command_line_admin.adoc @@ -58,6 +58,8 @@ include::development/pgtap.adoc[] include::development/support_scripts.adoc[] +include::admin/actiontriggers_process.adoc[] + include::reports/reporter_daemon.adoc[] @@ -82,11 +84,6 @@ include::development/updating_translations_launchpad.adoc[] :leveloffset: 0 -Local Administration -==================== - -include::admin/actiontriggers.adoc[] - // CATALOGING ADMIN Cataloging Administration -- 2.43.2