[open-ils-commits] [GIT] Evergreen ILS branch master updated. 10c578a66cc9814045e5576d9c6d941d7aed5b0f
Evergreen Git
git at git.evergreen-ils.org
Mon Sep 18 10:35:55 EDT 2017
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 10c578a66cc9814045e5576d9c6d941d7aed5b0f (commit)
via 899b6a5ad00bf302d3ed3cc104b1592db43c8a9f (commit)
from 9d163e48d52b359f9ce9bb456f3591ebe2ae43f0 (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 10c578a66cc9814045e5576d9c6d941d7aed5b0f
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Mon Sep 18 07:35:47 2017 -0700
Docs reorg: splitting action/triggers into command-line and staff-client manuals
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/actiontriggers.adoc b/docs/admin/actiontriggers.adoc
index 08df5a9..47801ce 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 0000000..8a6fc86
--- /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 1273865..1634e7a 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 6cd68b8..d9dcbf1 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
commit 899b6a5ad00bf302d3ed3cc104b1592db43c8a9f
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Mon Sep 18 07:26:08 2017 -0700
Docs: adding the MARC Templates documentation back
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/marc_templates.adoc b/docs/admin/marc_templates.adoc
new file mode 100644
index 0000000..2c1de41
--- /dev/null
+++ b/docs/admin/marc_templates.adoc
@@ -0,0 +1,63 @@
+MARC Templates
+--------------
+
+MARC Templates make the cataloging process more efficient for catalogers. At this time, MARC Templates have to be
+created on the server, rather than in the Web client.
+
+Adding MARC Templates
+~~~~~~~~~~~~~~~~~~~~~
+
+. Create a marc template in the directory _/openils/var/templates/marc/_. It should be in xml format. Here is an
+ example file `k_book.xml`:
++
+[source,xml]
+---------------------------------------------------------------------
+<record>
+ <leader>00620cam a2200205Ka 4500</leader>
+ <controlfield tag="008">070101s eng d</controlfield>
+ <datafield tag="010" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ </datafield>
+ <datafield tag="020" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ </datafield>
+ <datafield tag="082" ind1="0" ind2="4">
+ <subfield code="a"></subfield>
+ </datafield>
+ <datafield tag="092" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ </datafield>
+ <datafield tag="100" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ </datafield>
+ <datafield tag="245" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ <subfield code="b"></subfield>
+ <subfield code="c"></subfield>
+ </datafield>
+ <datafield tag="260" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ <subfield code="b"></subfield>
+ <subfield code="c"></subfield>
+ </datafield>
+ <datafield tag="300" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ <subfield code="b"></subfield>
+ <subfield code="c"></subfield>
+ </datafield>
+ <datafield tag="500" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ </datafield>
+ <datafield tag="650" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ <subfield code="v"></subfield>
+ </datafield>
+ <datafield tag="650" ind1="" ind2="">
+ <subfield code="a"></subfield>
+ </datafield>
+</record>
+---------------------------------------------------------------------
++
+. Add the template to the to the marctemplates list in the _open-ils.cat_ section of the Evergreen configuration
+ file `opensrf.xml`.
+. Restart perl services for changes to take effect with the command `/openils/bin/osrf_ctl.sh -l -a restart_perl`
diff --git a/docs/root_command_line_admin.adoc b/docs/root_command_line_admin.adoc
index a19ca19..6cd68b8 100644
--- a/docs/root_command_line_admin.adoc
+++ b/docs/root_command_line_admin.adoc
@@ -87,6 +87,8 @@ Local Administration
include::admin/actiontriggers.adoc[]
+// CATALOGING ADMIN
+
Cataloging Administration
=========================
@@ -95,6 +97,16 @@ Cataloging Staff Interface
include::admin/physical_char_wizard_db.adoc[]
+Cataloging timesavers and shortcuts
+-----------------------------------
+
+:leveloffset: 1
+
+include::admin/marc_templates.adoc[]
+
+:leveloffset: 0
+
+// STAFF ADMIN
include::admin/staff_from_command_line.adoc[]
Patron Data
-----------------------------------------------------------------------
Summary of changes:
docs/admin/actiontriggers.adoc | 62 -------------------
docs/admin/actiontriggers_process.adoc | 63 ++++++++++++++++++++
.../k_audio.xml => docs/admin/marc_templates.adoc | 37 +++++++----
docs/installation/server_installation.adoc | 4 +-
docs/root_command_line_admin.adoc | 17 ++++-
5 files changed, 101 insertions(+), 82 deletions(-)
create mode 100644 docs/admin/actiontriggers_process.adoc
copy Open-ILS/src/templates/marc/k_audio.xml => docs/admin/marc_templates.adoc (56%)
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list