From 7b4d50ef830b2dc7320d6cb0d9d42ab4fae80f88 Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Sun, 6 Mar 2022 19:16:52 +0000 Subject: [PATCH] --- .../docs/customer-notify-subscriptions.md | 91 +++++++------------ .../ayanova/docs/home-notify-subscriptions.md | 14 ++- 2 files changed, 47 insertions(+), 58 deletions(-) diff --git a/docs/8.0/ayanova/docs/customer-notify-subscriptions.md b/docs/8.0/ayanova/docs/customer-notify-subscriptions.md index e7305d0f..9a2c596f 100644 --- a/docs/8.0/ayanova/docs/customer-notify-subscriptions.md +++ b/docs/8.0/ayanova/docs/customer-notify-subscriptions.md @@ -16,27 +16,43 @@ On the other hand if you enable Customers to set up their _own_ notifications vi We realize not every site can or will want to set up external access for their customers to AyaNova so we provide this feature but we strongly recommend going the Customer self subscribed notifications route instead wherever possible. -000000000000000000000000000000000000000000000000000000000000000000000000000 ## 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. +This form is available to User's with the following [roles](ay-biz-admin-roles.md): -For example, if a user has no rights to Service Work orders then they will not be able to receive notifications about changes to Work order objects. +Full access -## How notification subscriptions work +- Business administration +- Service manager -Notification subscriptions are stored in a database table at the server and the AyaNova server checks this table each time a notifiable event takes place and processes a notification for any active subscribers to that event and any filtered (tag) settings that match. +Read only access -For example if a User subscribes to be notified when a Customer is modified then AyaNova checks for any subscribers to that event when the Customer record is saved to the server. +- Business administration - restricted +- Service manager - restricted +- Service technician +- Sales - restricted -If the notification is selected to deliver in app to the AyaNova web app [notifications form](home-notifications.md) then it is placed in a table to wait for pick up by the AyaNova web application. -If a notification is set to be delivered via email then it is placed in an email notification delivery queue and processed in turn by the server. +## How to access Customer notification subscriptions + +Customer notification subscriptions are accessed in the following ways: + +- From the `Customers` navigation pane `Customer notifications` item to open the Customer notification subscriptions [data table](ay-start-form-data-tables.md) + +## How customer notifications work + +Customer notification subscriptions are stored in a database table at the server and the AyaNova server checks this table each time a notifiable event takes place and processes a notification for any customers that match the Customer tags selected if the object in question (such as a work order) also matches the object tags set for that notification. + +For example if a Customer service request accepted notification is created, when that CSR is set to accepted and saved the notification will be generated and placed in an email notification delivery queue and processed in turn by the server. + +### Email address + +Notifications are sent to the email address that is set in the [Customer](customers.md) record. If no email address is set that Customer is automatically skipped for notification and no error will arise as this is considered a normal situation. To confirm who will get notified make use of the [Who will receive](#who-will-receive) feature. ## Notification subscription list -The list form shows all the notifications you are currently subscribed to. You can open a subscription to edit it by clicking anywhere on the row. +The list form shows all the notifications currently created. You can open a subscription to edit it by clicking anywhere on the row. ## Notification subscription edit form @@ -46,21 +62,19 @@ Not all fields listed below are available for all event types, depending on the This is where you select the type of event you are subscribing to. All event types available are listed in the table below. -### Type - -Some events are related to core AyaNova business object operations, for example when an object is created or deleted or modified. This is the field where you select the type of object you are interested in such as a Customer or Work order etc. All core AyaNova business object types are available here. - ### Notify before event -For age and time based events, this is where you set a time duration of how far in advance of the event date you want to be notified. +For age and time based events, this is where you set a time duration of how far in advance of the event date you want the customer to be notified. -For example if you are creating a subscription for when a service contract expires and you want to be notified 2 weeks in advance of the expiration date you would select 14 days here. You can select days hours and minutes as appropriate. -Remember, this setting controls when you are notified _in advance_ of the actual date of the event whatever that might be. +### Duration -As you can subscribe to the same event more than once you can use this feature to create an escalating notification system for some events by setting a longer advance notice and having it deliver to a less immediate location. +For age based events, this is where you set a time duration of how far *after* an event date you want to be notified. + +For example if you are creating a subscription to follow up with a customer, "How was our service?" check after a work order is set to a completed status and you want them to be notified 2 weeks after service takes place you would select 14 days here. You can select days hours and minutes as appropriate. + +Remember, this setting controls when the customer is notified *past* the actual date of the event whatever that might be. -For example In application first and then another identical subscription but with a shorter time frame to a more immediately noticeable location such as direct SMS or an alternate address to another user to catch critical events in case they might get missed. ### Status @@ -72,47 +86,10 @@ Some events are related to monetary or other numeric amounts or thresholds, for ### Report -In the case of an event that can have a report associated with it, you can select a report link to be automatically sent with the event so the report can be opened from the message. +In the case of an event that can have a report associated with it, you can select a report to be automatically attached to the email notification sent with the event. -### Delivery method -Currently you can choose between _Deliver in application_ or _Deliver to email address_ (SMTP internet email) delivery. - -In app will deliver to the AyaNova [in-app notifications](home-notifications.md) form and alert via the bell icon at the top of the AyaNova application window. - -SMTP / email delivery will send notifications to an SMTP server however this form of delivery is not just for email alone as it can work with many different communications methods including 3rd party communication platforms and SMS / MMS via email gateways (see below). - -AyaNova SMTP (email delivery) notification messages are intentionally designed to be 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. - -Wiki How has an overview: [SMS / MMS gateway](https://www.wikihow.com/Send-a-Text-from-Email) for how this works and the web site [https://smsemailgateway.com/](https://smsemailgateway.com/) hosts a public domain list of many global cellular providers and their email to text gateway accounts. - -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. - -#### Charges may apply - -Depending on your mobile / cellular data plan charges may apply for receiving notification texts, check with your provider. - -#### 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). - -#### Duplicate subscriptions for different delivery methods - -Users can create any number of duplicate notification subscriptions with different delivery methods for more complex scenarios such as a dedicated Slack email address, Gmail address, SMS text delivery to a smart phone, in app etc etc. In this way you can be notified in multiple ways at once for critical notifications. - -### Deliver to Address - -If SMTP / email delivery method is chosen this field is where you enter the address where the notification is delivered. - -By default AyaNova will fill this field in with your email address if it's set in your [User settings](home-user-settings.md) form however you can change it to any value you wish. - -### Tags +### Object Tags Here you can _filter_ by selecting one or more [Tags](ay-start-form-tags.md) (if the event is related to a taggable object) to include or exclude specific objects. diff --git a/docs/8.0/ayanova/docs/home-notify-subscriptions.md b/docs/8.0/ayanova/docs/home-notify-subscriptions.md index 4aa50657..f0d281d2 100644 --- a/docs/8.0/ayanova/docs/home-notify-subscriptions.md +++ b/docs/8.0/ayanova/docs/home-notify-subscriptions.md @@ -38,7 +38,7 @@ Some events are related to core AyaNova business object operations, for example ### Notify before event -For age and time based events, this is where you set a time duration of how far in advance of the event date you want to be notified. +For time based events, this is where you set a time duration of how far in advance of the event date you want to be notified. For example if you are creating a subscription for when a service contract expires and you want to be notified 2 weeks in advance of the expiration date you would select 14 days here. You can select days hours and minutes as appropriate. @@ -48,6 +48,18 @@ As you can subscribe to the same event more than once you can use this feature t For example In application first and then another identical subscription but with a shorter time frame to a more immediately noticeable location such as direct SMS or an alternate address to another user to catch critical events in case they might get missed. +### Duration + +For age based events, this is where you set a time duration of how far _after_ an event date you want to be notified. + +For example if you are creating a subscription for work order status age and you want to be notified when 2 weeks has passed with the work order still set to that status, you would select 14 days here. You can select days hours and minutes as appropriate. + +Remember, this setting controls when you are notified _past_ the actual date of the event whatever that might be. + +As you can subscribe to the same event more than once you can use this feature to create an escalating notification system for some events by setting a shorter age notice and having it deliver to a less immediate location. + +For example In application first and then another identical subscription but with a longer time frame to a more immediately noticeable location such as direct SMS or an alternate address to another user to catch critical events in case they might get missed. + ### Status Events tied to Status settings on other objects such as a Workorder status or Quote status require a selection of the desired status. In those cases a Status field is available to choose the exact status of interest.