[open-ils-commits] [GIT] Evergreen ILS branch rel_3_1 updated. 30b98d693996826d7315ff9d915e7a8c4cb2d6be
Evergreen Git
git at git.evergreen-ils.org
Tue Apr 16 17:34:21 EDT 2019
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, rel_3_1 has been updated
via 30b98d693996826d7315ff9d915e7a8c4cb2d6be (commit)
via b48fccb4229dd796db06b6100a4571d52a37420f (commit)
via 23fcea809a60344de416525d23d2c95e8f90cb23 (commit)
via 26cd78721545371f48007ea7a3cb7e10718cd25b (commit)
from 1ca32b1ab05dd5df8b673148ee6fdf3d135e0a95 (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 30b98d693996826d7315ff9d915e7a8c4cb2d6be
Author: abneiman <abneiman at equinoxinitiative.org>
Date: Wed Dec 12 14:48:35 2018 -0500
docs: LP1258628: screenshots & updates to actiontriggers.adoc
Added a handful of screenshots; added language for Message Center definitions, and pulled in language about testing action triggers from this document: http://docs.evergreen-ils.org/dev/_creating_action_triggers.html
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/actiontriggers.adoc b/docs/admin/actiontriggers.adoc
index 9f9d19ebf3..b8c3960b2a 100644
--- a/docs/admin/actiontriggers.adoc
+++ b/docs/admin/actiontriggers.adoc
@@ -28,6 +28,7 @@ Event Definitions is the main tab and contains the key fields when working with
Table 1: Action Trigger Event Definitions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
|==============================================
|*Field* |*Description*
| Owning Library |The shortname of the library for which the action / trigger / hook is defined.
@@ -43,34 +44,44 @@ Table 1: Action Trigger Event Definitions
| Failure Cleanup |After an event is reacted to and if there is a failure a cleanup module can be run to clean up after the event.
| Granularity |Used to group events by how often they should be run. Options are Hourly, Daily, Weekly, Monthly, Yearly, but you may also create new values.
| Max Event Validity Delay |Allows events to have a range of time that they are valid. This value works with the *Processing Delay* to define a time range.
+| Message Library Path |Defines the org_unit object for a Patron Message Center message.
+| Message Template |A Template Toolkit template that can be used to generate output for a Patron Message Center message. The output may or may not be used by the reactor or another external process.
+| Message Title |The title that will display on a Patron Message Center message.
+| Message User Path |Defines the user object for a Patron Message Center message.
| Opt-In Settings Type |Choose which User Setting Type will decide if this event will be valid for a certain user. Use this to allow users to Opt-In or Opt-Out of certain events.
| Opt-In User Field |Set to the name of the field in the selected hook's core type that will link the core type to the actor.usr table.
| Success Cleanup |After an event is reacted to successfully a cleanup module can be run to clean up after the event.
| Template |A Template Toolkit template that can be used to generate output. The output may or may not be used by the reactor or another external process.
-|===============================================
+|==============================================
Creating Action Triggers
~~~~~~~~~~~~~~~~~~~~~~~~
. From the top menu, select *Administration* -> *Local Administration* -> *Notifications / Action triggers*.
. Click on the _New_ button.
++
+image::media/new_event_def.png[New Event Definition]
++
. Select an _Owning Library_.
. Create a unique _Name_ for your new action trigger.
. Select the _Hook_.
. Check the _Enabled_ check box.
. Set the _Processing Delay_ in the appropriate format. E.g. _7 days_ to run 7 days from the trigger event or _00:01:00_ to run 1 hour after the _Processing Delay Context Field_.
. Set the _Processing Delay Context Field_ and _Processing Group Context Field_.
-. Select the _Reactor_, _Validator_, _Failure Cleanup_.
-. Select the _Granularity_.
-
+. Select the _Reactor_ and _Validator_.
+. Set the _Event Repeatability Delay_.
+. Select the _Failure Cleanup_ and _Granularity_.
. Set the _Max Event Validity Delay_.
-
++
+image::media/event_def_details.png[Event Definition Details]
++
+. If you wish to send a User Message through the Message Center, set a _Message Library Path_. Enter text in the _Message Template_. Enter a title for this message in _Message Title_, and set a value in _Message User Path_.
. Select the _Opt-In Setting Type_.
-
. Set the _Opt-In User Field_.
-
. Select the _Success Cleanup_.
-
++
+image::media/event_def_details_2.png[Event Definition Details]
++
. Enter text in the _Template_ text box if required. These are for email messages. Here is a sample template for sending 90 day overdue notices:
@@ -140,17 +151,16 @@ Testing Action Triggers
. Go to the list of action triggers.
. Click on the blue link text for the action trigger you'd like to test.
++
+image::media/test_event_def.png[Blue Link Text]
++
. Go to the Test tab.
. If there is a test available, fill in the required information.
. View the output of the test.
-[WARNING]
-============
-If you are testing an email or SMS notification,
-use your own account as an example. Using the Test
-feature will actually result in the notification
-being sent if configured correctly.
-============
+image::media/test_event_def_output.png[Test Output]
+
+WARNING: If you are testing an email or SMS notification, use a test account and email as an example. Using the Test feature will actually result in the notification being sent if configured correctly. Similarly, use a test item or barcode when testing a circulation-based event like Mark Lost since the test will mark the item as lost.
anchor:hooks[]
@@ -207,4 +217,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.
-
diff --git a/docs/media/event_def_details.png b/docs/media/event_def_details.png
new file mode 100644
index 0000000000..cfa21b72aa
Binary files /dev/null and b/docs/media/event_def_details.png differ
diff --git a/docs/media/event_def_details_2.png b/docs/media/event_def_details_2.png
new file mode 100644
index 0000000000..6bb189728e
Binary files /dev/null and b/docs/media/event_def_details_2.png differ
diff --git a/docs/media/new_event_def.png b/docs/media/new_event_def.png
new file mode 100644
index 0000000000..21fb860f32
Binary files /dev/null and b/docs/media/new_event_def.png differ
diff --git a/docs/media/test_event_def.png b/docs/media/test_event_def.png
new file mode 100644
index 0000000000..313acb96c6
Binary files /dev/null and b/docs/media/test_event_def.png differ
diff --git a/docs/media/test_event_def_output.png b/docs/media/test_event_def_output.png
new file mode 100644
index 0000000000..ced6610637
Binary files /dev/null and b/docs/media/test_event_def_output.png differ
diff --git a/docs/root_staff_client_admin.adoc b/docs/root_staff_client_admin.adoc
index 78a35f06d5..8031a865b4 100644
--- a/docs/root_staff_client_admin.adoc
+++ b/docs/root_staff_client_admin.adoc
@@ -188,10 +188,6 @@ include::admin/receipt_template_editor.adoc[]
include::circulation/self_check_configuration.adoc[]
-:leveloffset: -1
-
-include::admin/actiontriggers.adoc[]
-
:leveloffset: 0
// SEARCH ADMIN
@@ -277,10 +273,20 @@ include::admin/lsa-work_log.adoc[]
include::admin/staff_client-recent_searches.adoc[]
+// Other
+
+Other administration
+====================
+
+Introduction
+------------
+
+This section describes other staff client administrator tasks.
+
+include::admin/actiontriggers.adoc[]
:leveloffset: 0
include::shared/attributions.adoc[]
include::shared/end_matter.adoc[]
-
commit b48fccb4229dd796db06b6100a4571d52a37420f
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Wed Oct 10 18:37:59 2018 -0700
Docs: correcting inaccurate statement in action trigger docs
diff --git a/docs/admin/actiontriggers.adoc b/docs/admin/actiontriggers.adoc
index 660fa57642..9f9d19ebf3 100644
--- a/docs/admin/actiontriggers.adoc
+++ b/docs/admin/actiontriggers.adoc
@@ -142,8 +142,15 @@ Testing Action Triggers
. Click on the blue link text for the action trigger you'd like to test.
. Go to the Test tab.
. If there is a test available, fill in the required information.
-. View the output of the test. If you are testing an email or SMS notification,
-don't worry -- the patron will not receive an email or SMS during your test.
+. View the output of the test.
+
+[WARNING]
+============
+If you are testing an email or SMS notification,
+use your own account as an example. Using the Test
+feature will actually result in the notification
+being sent if configured correctly.
+============
anchor:hooks[]
commit 23fcea809a60344de416525d23d2c95e8f90cb23
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Mon Oct 8 14:42:30 2018 -0700
Docs: adding info about testing action triggers
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/actiontriggers.adoc b/docs/admin/actiontriggers.adoc
index 9351f631af..660fa57642 100644
--- a/docs/admin/actiontriggers.adoc
+++ b/docs/admin/actiontriggers.adoc
@@ -104,6 +104,7 @@ Creating Action Triggers
. Once you are satisfied with your new event trigger, click the _Save_ button located at the bottom of the form.
+
[TIP]
=========
A quick and easy way to create new action triggers is to clone an existing action trigger.
@@ -134,6 +135,15 @@ Deleting Action Triggers
. Check the check box next to the action trigger you wish to delete
. Click _Delete Selected_ on the top-right of the page.
+Testing Action Triggers
+^^^^^^^^^^^^^^^^^^^^^^^
+
+. Go to the list of action triggers.
+. Click on the blue link text for the action trigger you'd like to test.
+. Go to the Test tab.
+. If there is a test available, fill in the required information.
+. View the output of the test. If you are testing an email or SMS notification,
+don't worry -- the patron will not receive an email or SMS during your test.
anchor:hooks[]
commit 26cd78721545371f48007ea7a3cb7e10718cd25b
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Mon Oct 8 14:37:30 2018 -0700
Docs: adding action/triggers to staff client admin docs
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/actiontriggers.adoc b/docs/admin/actiontriggers.adoc
index ae72a081e5..9351f631af 100644
--- a/docs/admin/actiontriggers.adoc
+++ b/docs/admin/actiontriggers.adoc
@@ -1,6 +1,9 @@
Notifications / Action Triggers
-------------------------------
+Introduction
+~~~~~~~~~~~~
+
indexterm:[action triggers, event definitions, notifications]
Action Triggers give administrators the ability to set up actions for
diff --git a/docs/root_staff_client_admin.adoc b/docs/root_staff_client_admin.adoc
index 4b047e1ca7..78a35f06d5 100644
--- a/docs/root_staff_client_admin.adoc
+++ b/docs/root_staff_client_admin.adoc
@@ -188,6 +188,9 @@ include::admin/receipt_template_editor.adoc[]
include::circulation/self_check_configuration.adoc[]
+:leveloffset: -1
+
+include::admin/actiontriggers.adoc[]
:leveloffset: 0
-----------------------------------------------------------------------
Summary of changes:
docs/admin/actiontriggers.adoc | 47 ++++++++++++++++++++++++++++-------
docs/media/event_def_details.png | Bin 0 -> 22913 bytes
docs/media/event_def_details_2.png | Bin 0 -> 7671 bytes
docs/media/new_event_def.png | Bin 0 -> 28442 bytes
docs/media/test_event_def.png | Bin 0 -> 28383 bytes
docs/media/test_event_def_output.png | Bin 0 -> 22292 bytes
docs/root_staff_client_admin.adoc | 13 ++++++++--
7 files changed, 49 insertions(+), 11 deletions(-)
create mode 100644 docs/media/event_def_details.png
create mode 100644 docs/media/event_def_details_2.png
create mode 100644 docs/media/new_event_def.png
create mode 100644 docs/media/test_event_def.png
create mode 100644 docs/media/test_event_def_output.png
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list