From: Angela Kilsdonk Date: Mon, 18 Oct 2021 13:38:28 +0000 (-0400) Subject: docs: 3.8 Triggered Events Log Rewrite X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=4e2d6a2011a90b545062f2de53289f475c5fffa0;p=Evergreen.git docs: 3.8 Triggered Events Log Rewrite Signed-off-by: Angela Kilsdonk Signed-off-by: Andrea Buntz Neiman Signed-off-by: Galen Charlton --- diff --git a/docs/modules/circulation/assets/images/media/item_tel_display.png b/docs/modules/circulation/assets/images/media/item_tel_display.png new file mode 100644 index 0000000000..ff6a366adb Binary files /dev/null and b/docs/modules/circulation/assets/images/media/item_tel_display.png differ diff --git a/docs/modules/circulation/assets/images/media/item_tel_location.png b/docs/modules/circulation/assets/images/media/item_tel_location.png new file mode 100644 index 0000000000..6f4ddda45d Binary files /dev/null and b/docs/modules/circulation/assets/images/media/item_tel_location.png differ diff --git a/docs/modules/circulation/assets/images/media/patron_tel_display.png b/docs/modules/circulation/assets/images/media/patron_tel_display.png new file mode 100644 index 0000000000..ecdfbacb6a Binary files /dev/null and b/docs/modules/circulation/assets/images/media/patron_tel_display.png differ diff --git a/docs/modules/circulation/assets/images/media/patron_tel_location.png b/docs/modules/circulation/assets/images/media/patron_tel_location.png new file mode 100644 index 0000000000..89e7974152 Binary files /dev/null and b/docs/modules/circulation/assets/images/media/patron_tel_location.png differ diff --git a/docs/modules/circulation/assets/images/media/patron_tel_tabs.png b/docs/modules/circulation/assets/images/media/patron_tel_tabs.png new file mode 100644 index 0000000000..286cbca63d Binary files /dev/null and b/docs/modules/circulation/assets/images/media/patron_tel_tabs.png differ diff --git a/docs/modules/circulation/pages/triggered_events.adoc b/docs/modules/circulation/pages/triggered_events.adoc index dfdea9e2a3..4bc50dcee1 100644 --- a/docs/modules/circulation/pages/triggered_events.adoc +++ b/docs/modules/circulation/pages/triggered_events.adoc @@ -1,68 +1,165 @@ -= Triggered Events and Notices = += Triggered Events Log = :toc: +indexterm:[events, notifications] == Introduction == - -Improvements to the Triggered Events interface enables you to easily filter, -sort, and print triggered events from the patron's account or an item's details. -This feature is especially useful when tracking notice completion from a -patron's account. - -== Access and View == - -You can access *Triggered Events* from two Evergreen interfaces: a patron's -account or an item's details. - -To access this interface in the patron's account, open the patron's record and -click *Other* -> *Triggered Events / Notifications*. - -To access this interface from the item's details, enter the item barcode into -the *Item Status* screen, and click *Actions* -> *Show* -> *Triggered Events*. - -Information about the patron, the item, and the triggered event appear in the -center of the screen. Add or delete columns to the display by right clicking on -any column. The *Column Picker* appears in a pop up box and enables you to -select the columns that you want to display. - -image::media/Triggered_Events_and_Notices1.jpg[Triggered_Events_and_Notices1] - -== Filter == - -The triggered events that display are controlled by the filters on the right -side of the screen. By default, Evergreen displays completed circulation -events. Notice that the default filters display *Event State is Complete* and -*Core Type is Circ*. - -To view completed hold-related events, such as hold capture or hold notice -completion, choose *Event State is Complete* and *Core Type is Hold* from the -drop down menu. - -You can also use the *Event State* filter to view circs and holds that are -*pending* or have an *error*. - -Add and delete filters to customize the list of triggered events that displays. -To add another filter, click *Add Row*. To delete a filter, click the red _X_ -adjacent to a row. - -image::media/Triggered_Events_and_Notices2.jpg[Triggered_Events_and_Notices2] - -== Sort == - -You can sort your results by clicking the column name. - -image::media/Triggered_Events_and_Notices3.jpg[Triggered_Events_and_Notices3] - - -== Print == - -You can select the events that you want to print, or you can print all events. -To print selected events, check the boxes adjacent to the events that you want -to print, and click *Print Selected Events*. To print all events, simply click -*Print All Events*. - -== Reset == - -If the triggered event does not complete or the notice is not sent and the -trigger needs to be run again, then select the event, and click *Reset Selected -Events*. - +As of version 3.8, the Patron and Item Triggered Events Logs have been +reimplemented in Angular as well as given improvements in query +efficiency. + +== Patron Triggered Events Log == +[[patron_triggered_events_log]] + +The Patron Triggered Events Log provides an interface where library +staff can view and sort triggered events and notifications associated +with circulations and holds on a patron’s account. This feature is often +used to identify if a notice, such as an overdue notice, was generated +by Evergreen for a patron. Entries remain in the Triggered Events Log +for a time period established in the Trigger Event Definition field +*Retention Interval*. + +The Triggered Events Log can be accessed by retrieving a patron record +and selecting *Other → Triggered Events / Notifications*. As of 3.8, +this interface will open in a new browser tab. Future developments for +Evergreen may include integration with the existing patron account +interface. In order to view the Triggered Events Log, a staff member +will need the `VIEW_TRIGGER_EVENT` permission either directly or by a +group or profile membership. + +image::media/patron_tel_location.png[Patron Triggered Events Log Location] + +The Patron Triggered Events Log separates Hold Events and Circulation +Events into their own tabs. + +image::media/patron_tel_tabs.png[Patron Tiggered Events Log Tabs] + +The Circulation tab will display events such as predue notices, overdue +notices, and autorenewal notices, as well as events like Mark Item Lost +or Mark Item Long Overdue. The Hold tab will display events such as hold +notifications and curbside pickup offers. Both email and text/SMS +notification events that are generated by Evergreen will display in this +interface. + +There are two available actions, *Cancel Selected Events* and *Reset +Selected Events*. Cancel will set an event to invalid and Reset will set +an event back to pending. Cancel does not check the current event state +so staff should use caution when using this action. + +More information about the Notifications/Actions Triggers feature in +Evergreen, which generates patron notices, can be found xref:admin:actiontriggers.adoc[here]. + +image::media/patron_tel_display.png[Patron Triggered Events Log Display] + +When retrieved from a patron record, the Triggered Event Log interface +shows only patron-related events, and only specific events that have +been scheduled or executed. + +Filtering and sorting are available in the column headers. Filtering is +case-sensitive, and more information about how column filters work is +available xref:admin:staff_client-column_filters.adoc[here]. + +This interface displays the following columns for Circulation & Hold +Events. The default columns for display are note in _italics_: + +* _Name_ - the name of the event +* _Reactor_ - the event’s Reactor, i.e., what action is carried out +* _Event Run Time_ - the time the event was run +* _Event State_ - the event state. Possible values include “complete”, +“pending”, or “error” +* _Context Library_ - the shortname of the library / Org Unit associated +with the event +* _Title_ - the title of the item associated with the event +* _Author_ - the author of the item associated with the event +* Patron Barcode - the barcode of the patron associated with the event +* Hook - what the Event “hooks” to in the fieldmapper; e.g., all predue +and overdue notices have a hook of *checkout.due* (due date) +* Event ID - the database Event ID +* Event Start Time - the time the Event started +* Event Update Time - the time the Event was updated +* Event Complete Time - the time the Event was completed +* Context User - the database ID of the user (i.e. patron) associated with +the event +* Context Item - the barcode of the item associated with the event +* Context Bib - the database ID of the bib record associated with the +event +* The columns Event Definition ID , Event Add Time, Event Update PID, +Event User Data, Event Template Output, Event Error Output, Event Target +Object ID, and Event Async Output are all fields that are only really +useful to Administrators & aren’t recommended for general end-users. + +== Item Triggered Events Log == +[[item_triggered_events_log]] + +The Item Triggered Events Log displays the same information as the +Patron Triggered Events Log, but from the perspective of a specific +item. In order to view the Triggered Events Log, a staff member will +need the VIEW_TRIGGER_EVENT permission either directly or by a group or +profile membership. Entries remain in the Triggered Events Log for a +time period established in the Trigger Event Definition field *Retention +Interval*. + +The Triggered Events Log can be accessed from the *Item Status* +interface (or any access point that invokes this interface). With a +single item selected in Item Status, navigate to *Detail View* and then +select the *Triggered Events* tab. This will open the rewritten +Triggered Events Log in a new browser tab. Alternatively, from either +the Item Status List View or Detail View, navigate to the *Actions Menu* +and select *Show Triggered Events*. + +image::media/item_tel_location.png[Item Triggered Events Log Location] + +The rewritten Triggered Events Log separates Hold Events and Circulation +Events into their own tabs. + +image:media/item_tel_display.png[Item Triggered Events Log Display] + +Circulation Events include predue notices, overdue notices, and +autorenewal notices as well as events like Mark Item Lost or Mark Item +Long Overdue. Hold Events include hold notifications and curbside pickup +offers. Circ and Holds notices can be sent via SMS or Email. + +There are two available actions, *Cancel Selected Events* and *Reset +Selected Events*. Cancel will set an event to invalid and Reset will set +an event back to pending. Cancel does not check the current event state +so staff should use caution when using this action. + +A full list of Events, including lists of Hooks, Reactors, and +Validators can be seen in the Admin interface *Notifications / Action +Triggers*. More information about Events can be seen xref:admin:actiontriggers.adoc[here]. + +Filtering and sorting are available in the column headers. Filtering is +case-sensitive, and more information about how column filters work is +available xref:admin:staff_client-column_filters.adoc[here]. + +Columns for Circulation & Hold Events (default columns in _italics_): + +* _Patron Barcode_ - the barcode of the patron associated with the event +** Note that if the staff user doesn’t have appropriate VIEW_USER +permissions, they will see the database ID in this column. +* _Name_ - the name of the event +* _Reactor_ - the event’s Reactor, i.e., what action is carried out +* _Event Run Time_ - the time the event was run [note that there is an +existing Angular bug with datetime display] +* _Event State_ - the event state. Possible values include “complete”, +“pending”, or “error” +* _Title_ - the title of the item associated with the event +* _Author_ - the author of the item associated with the event +* Hook - what the Event “hooks” to in the fieldmapper; e.g., all predue +and overdue notices have a hook of *checkout.due* (due date) +* Event ID - the database Event ID +* Event Start Time - the time the Event started +* Event Update Time - the time the Event was updated +* Event Complete Time - the time the Event was completed +* Context User - the username or barcode of the user (i.e. patron) +associated with the event +** Note that if the staff user doesn’t have appropriate VIEW_USER +permissions, they will see the database ID in this column. +* Context Library - the database ID of the library / Org Unit associated +with the event +* Context Bib - the database ID of the bib record associated with the +event +* Context Item - the database ID of the item associated with the event +* The columns Event Definition ID , Event Add Time, Event Update PID, +Event User Data, Event Template Output, Event Error Output, Event Target +Object ID, and Event Async Output are all fields that are only really +useful to Administrators & aren’t recommended for general end-users.