This commit is contained in:
2022-01-27 23:48:52 +00:00
parent 86ebbb07be
commit 5e58fadc50

View File

@@ -1,8 +1,17 @@
# NOTIFICATION SUBSCRIPTIONS
# Notification subscriptions
This form is used to control notification subscriptions which are events that happen within AyaNova that a User may be interested in knowning about.
This form is used to control notification subscriptions which are events that happen within AyaNova that a User can subscribe to.
Notifications can be delivered in multiple ways: via email / SMS or directly in application.
Notifications can be delivered via email, SMS text (via email) or directly in the AyaNova web application.
## Authorization Roles required
Notification subscriptions are available to _all_ users of AyaNova regardless of their [roles](ay-biz-admin-roles.md) however some types of subscriptions are not available to all roles, for example if a user has no rights to view a Customer then they will not be able to receive notifications about a Customer object.
## How notification subscriptions work
Subscriptions are stored in a database table at the server and AyaNova checks this table each time a notifiable event takes place and processes a notifiation for any active subscribers.
If the notification is selected to deliver in app in the AyaNova web app [notifications form](home-notifications.md) then it is placed in a table awaiting pick up by the web application. If a notification is to be delivered via email then it is placed in a delivery queue and processed in turn by the server.
## Notification subscription list
@@ -42,6 +51,22 @@ In the case of an event that can have a report associated with it, you can selec
Currently you can choose between In application which will deliver to the [notifications](home-notifications.md) form and alert via the bell icon at the top of the AyaNova application window and email / SMS delivery via SMTP.
AyaNova SMTP (email delivery) notification messages are deliberately as short as possible, plain text with simple links where necessary and to the point so they work well with 3rd party services and small devices.
#### SMS / Text delivery
Delivery via SMS / Text message is supported through email delivery as nearly all cellular providers have a special "gateway" address that can be used for email to text deliveries.
For example, in the US AT&T customers can use the address ##########@txt.att.net substituting the ### symbols for their cellular phone number.
The web site [https://smsemailgateway.com/](https://smsemailgateway.com/) hosts a public domain list of many global cellular providers and their email gateway account.
Most providers also list this information on their web sites, look for the terms SMS Email Gateway address or contact them directly to get the address.
#### Slack and other communication services
Many communication services support an SMTP gateway that can work with AyaNova's notification system; for example Slack supports sending emails to Slack in [several ways](https://slack.com/help/articles/206819278-Send-emails-to-Slack).
### Deliver to Address
If email / SMS delivery method is chosen this field is where you enter the address for delivery. If it is to your SMS / MMS device then you must set the address provided by your cellular provider for their [SMS / MMS gateway](https://www.wikihow.com/Send-a-Text-from-Email)
@@ -111,9 +136,6 @@ There are no settings adjustable for in app General notifications, however Users
| CopyOfCustomerNotification | Copy of any notification sent to Customer for AyaNova User. Filterable by Customer Tag |
| WorkorderCreatedForCustomer | Customer notification sent when a service type work order is created for them (or if HeadOffice Contact user, one of their Customers) |
00000000000000000000000000000000000000000000000000000000000000000000000000
TODO: Notes for docs / items to cover