[OPEN-ILS-DEV] Notification / Action Trigger docs update

[Josh Stompro]

Mike,

How does this look based on your explanation?

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.

Josh Stompro - LARL IT Director

From: Open-ils-dev [mailto:open-ils-dev-bounces at list.georgialibraries.org] On Behalf Of Mike Rylander
Sent: Thursday, June 18, 2015 2:15 PM
To: Documentation discussion for Evergreen software; Evergreen Development Discussion List
Subject: Re: [OPEN-ILS-DEV] Notification / Action Trigger docs update

Josh,

Those definitions are correct, however, the Template definition is a little too specific.  Not sure what we can do about that, as it should actually probably be more vague -- that field is just a Template Toolkit template that the event can use to generate output.  What is done with that output is determined by the reactor ... or, in some cases, a completely separate, external process.


--
Mike Rylander
 | President
 | Equinox Software, Inc. / The Open Source Experts
 | phone:  1-877-OPEN-ILS (673-6457)
 | email:  miker at esilibrary.com<mailto:miker at esilibrary.com>
 | web:  http://www.esilibrary.com


On Thu, Jun 18, 2015 at 2:18 PM, Josh Stompro <stomproj at exchange.larl.org<mailto:stomproj at exchange.larl.org>> wrote:
user/stompro/action_trigger_doc_update
http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/stompro/action_trigger_doc_update

Here is a branch with some updates to the action trigger docs.  This adds some missing field descriptions, updates an example template, and changes the section title so it matches the staff client menu label.

Could someone that is familiar with A/T Event Defs let me know If these field definitions are correct.

+| 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.
+| 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.
+| 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 succesfully a cleanup module can be run to clean up after the event.
+| Template                       |The message template in Perl Template Toolkit format.

Let me know how this looks.  (I’ll fix the misspelled “successfully”, just saw that)  I didn’t address the new message center fields so that this can apply to 2.7 and 2.8.  Those will get added later when the documentation for the message center gets done.
Josh


Lake Agassiz Regional Library - Moorhead MN larl.org<http://larl.org>
Josh Stompro     | Office 218.233.3757 EXT-139<tel:218.233.3757%20EXT-139>
LARL IT Director | Cell 218.790.2110<tel:218.790.2110>


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://libmail.georgialibraries.org/pipermail/open-ils-dev/attachments/20150622/3a2afc07/attachment.html>