Skip to content

Commit 37feeaa

Browse files
IanSkelskeykenstir
authored andcommitted
Enhance push notification documentation for Hemlock integration
Updated the setup guide to improve clarity when creating a new user setting type for push notifications in the Hemlock app. Improved form value descriptions, added a table for better readability, and included an optional push notification type in the example configuration. Release-Note: Improve Hemlock push notification setup clarity in documentation Signed-off-by: Ian Skelskey <[email protected]>
1 parent 77d68ba commit 37feeaa

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

docs/pn-setup-guide/create-an-action-trigger.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,16 @@ As an EG admin, login to the Staff client and go to Server Administration >> Use
1818

1919
Procedure:
2020
* Click `New User Setting Type`
21-
* Set Datatype to "string"
22-
* Set Description to "Data stored by the Hemlock app for patrons that have opted into push notifications"
23-
* Set Label to "Hemlock Push Notification data"
24-
* Set Name to "hemlock.push_notification_data"
25-
* Check OPAC/Patron Visible
21+
* Set the following form values:
22+
23+
| Label | Value |
24+
| ------------------- | ---------------------------------------------------------------------------------- |
25+
| Datatype | string |
26+
| Description | Data stored by the Hemlock app for patrons that have opted into push notifications |
27+
| Label | Hemlock Push Notification data |
28+
| Name | hemlock.push_notification_data |
29+
| OPAC/Patron Visible | checked |
30+
2631
* Click `Save`
2732

2833
## Create an Action Trigger
@@ -37,7 +42,7 @@ Procedure:
3742
* Set the following form values:
3843

3944
| Label | Value |
40-
|--------------------------------|--------------------------------|
45+
| ------------------------------ | ------------------------------ |
4146
| Owning Library | CONS |
4247
| Hook | checkout.due |
4348
| Processing Delay | -300 days |
@@ -68,6 +73,11 @@ url http://localhost:8842/send
6873
title Courtesy Notice
6974
body You have a item due
7075
76+
# the push notification type (optional)
77+
# controls the app screen that launches when you tap the notification.
78+
# fines, general, holds, pmc, checkouts
79+
type checkouts
80+
7181
# if the patron is not a mobile app user, token will be empty;
7282
# this does no harm and allows hemlock-sendmsg to keep a metric of all send attempts
7383
token [%- helpers.get_user_setting(user.id, 'hemlock.push_notification_data') %]

0 commit comments

Comments
 (0)