You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rename and update Action Trigger setup documentation
Renames the \"create-an-action-trigger.md\" file to \"configure-evergreen.md\" to better reflect its content. Enhances documentation by adding detailed procedures for cloning and creating action triggers with reminders and warnings. Links to a newly added sample template subsection for better guidance.
- Guide title changed to \"Configure Evergreen Action Triggers\"
- Added sections on cloning and creating action triggers from scratch
- Included tips and warnings for best practices
- Provided a link to the Evergreen Action Trigger documentation for additional help
Release-Note: Update and rename Action Trigger documentation for clarity
Signed-off-by: Ian Skelskey <[email protected]>
Copy file name to clipboardexpand all lines: docs/pn-setup-guide/configure-evergreen.md
+30-5
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
---
2
+
2
3
sidebar_position: 4
3
4
---
4
-
# Create an action trigger
5
+
# Configure Evergreen Action Triggers
5
6
6
7
This guide is for the Evergreen Administrator.
7
8
It will help you set up your Evergreen (EG) server for sending a push notifications with an action trigger. It assumes that your System Administrator has already installed the `hemlock-sendmsg` daemon, and it's listening on `localhost:8842`.
@@ -37,7 +38,29 @@ The action trigger uses the CallHTTP reactor to send a request to the hemlock-se
37
38
38
39
As an EG admin, login to the Staff client and go to Local Administration >> Notifications / Action Triggers.
39
40
40
-
Procedure:
41
+
Checkout the [Evergreen Action Trigger documentation](https://docs.evergreen-ils.org/docs/latest/admin/actiontriggers.html) for more information.
42
+
43
+
### Cloning an Existing Action Trigger
44
+
45
+
:::tip
46
+
Cloning an existing action trigger is a good way to start especially if you are not familiar with action triggers. It is easier to modify an existing action trigger than to create one from scratch and can help reduce errors and save time on troubleshooting.
47
+
- Make sure that you clone a working action trigger.
48
+
- Clone an action trigger that uses the same hook as the one you want to create.
49
+
:::
50
+
51
+
1. Right click an existing event definition and click `Clone Selected` or select the event definition and click `Clone Selected` from the Actions menu.
52
+
2. When prompted to clone the environment, select `Yes`.
53
+
3. Set the reactor to `CallHTTP`.
54
+
4. Set the template according to the [sample template](#sample-template) below.
55
+
56
+
### Creating an Action Trigger from Scratch
57
+
58
+
:::warning
59
+
Creating an action trigger from scratch can be tricky as the environment and parameters of action triggers can be complex. Only create an action trigger from scratch if you are certain you can do so.
60
+
:::
61
+
62
+
This example event definition is for a courtesy notice. Some details may need to be adjusted for your specific use case. It is most important to set the reactor to `CallHTTP` and the template according to the [sample template](#sample-template) below.
Whether cloning an existing action trigger or creating a new one, the template should be set as follows. The parameters `title`, `body`, and `type` will vary depending on the type of notification you want to send.
Copy file name to clipboardexpand all lines: docs/pn-troubleshooting-guide/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,7 @@ Ensure that notifications are enabled for the app:
122
122
123
123
#### "500 Error" after signing in
124
124
<details>
125
-
1. Ensure the User Setting Type is created. After signing in, the app tries to store the push notification token in the database, and it gets this error if the User Setting Type is missing. See [Push Notification Setup Guide](../pn-setup-guide/create-an-action-trigger.md).
125
+
1. Ensure the User Setting Type is created. After signing in, the app tries to store the push notification token in the database, and it gets this error if the User Setting Type is missing. See [Push Notification Setup Guide](../pn-setup-guide/configure-evergreen.md).
0 commit comments