This commit is contained in:
@@ -6,7 +6,9 @@ Notifications can be delivered via email, SMS text (via email) or directly in th
|
||||
|
||||
## 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 Service Work orders then they will not be able to receive notifications about changes to Work order objects.
|
||||
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 Service Work orders then they will not be able to receive notifications about changes to Work order objects.
|
||||
|
||||
## How notification subscriptions work
|
||||
|
||||
@@ -36,7 +38,11 @@ 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 example if you are creating 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 controls when you are notified _in advance_ of the actual date of the event whatever that might be.
|
||||
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 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.
|
||||
|
||||
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.
|
||||
|
||||
@@ -56,9 +62,9 @@ In the case of an event that can have a report associated with it, you can selec
|
||||
|
||||
### Delivery method
|
||||
|
||||
Currently you can choose between `Deliver in application` or `Deliver to email address` (SMTP internet email) delivery.
|
||||
Currently you can choose between _Deliver in application_ or _Deliver to email address_ (SMTP internet email) delivery.
|
||||
|
||||
In app will deliver to the AyaNova [notifications](home-notifications.md) form and alert via the bell icon at the top of the AyaNova application window.
|
||||
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).
|
||||
|
||||
@@ -70,13 +76,13 @@ Delivery via SMS / Text message is supported through email delivery as nearly al
|
||||
|
||||
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 gateway account.
|
||||
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 the cellular data plan charges may apply for receiving notification texts, check with your provider.
|
||||
Depending on your mobile / cellular data plan charges may apply for receiving notification texts, check with your provider.
|
||||
|
||||
#### Slack and other communication services
|
||||
|
||||
@@ -94,7 +100,9 @@ By default AyaNova will fill this field in with your email address if it's set i
|
||||
|
||||
### 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. For example, you could create a subscription to the Object Created event, select the type as Customer and the Tag as "residential". That way any Customer created and saved with the Tag "residential" will trigger a notification to you but if a Customer is created without the tag "residential" you will not be alerted.
|
||||
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.
|
||||
|
||||
For example, you could create a subscription to the Object Created event, select the type as Customer and the Tag as "residential". That way any Customer created and saved with the Tag "residential" will trigger a notification to you but if a Customer is created without the tag "residential" you will not be alerted.
|
||||
|
||||
**All** the tags selected in the subscription are required to be on the object at the moment it is saved / updated / deleted in order to match the subscription requirements and trigger notification. If other tags are on the object besides the ones related to this filter they have no effect on the notification filter.
|
||||
|
||||
@@ -108,7 +116,7 @@ For all other descendants, they will process notifications and filter by tag aga
|
||||
|
||||
Changing the work order header tags on an existing work order does not automatically trigger a re-evaluation of descendant notification items. Only when those descendants themselves are edited and saved will the tags be re-assessed. This means that ideally tags should be set _first_ on the work order before any descendant items that might be dependant on certain tags being present.
|
||||
|
||||
## Events are triggered when...
|
||||
## Notification events are triggered when...
|
||||
|
||||
### Business object edited
|
||||
|
||||
@@ -117,6 +125,7 @@ When a new or updated AyaNova core business object is saved or deleted it trigge
|
||||
In other words if you create a new subscription, only objects saved _after_ you created that subscription will trigger notifications to you.
|
||||
|
||||
In the case of time delayed notifications they are still created at the moment of saving the object but with a delayed delivery date.
|
||||
|
||||
For example, if you create a subscription to be notified a year after a Customer record is created, the event is created the moment the Customer is created and first saved and stored internally for a year before delivery.
|
||||
(If that Customer should be deleted before the year is up then that age notification will automatically be deleted)
|
||||
|
||||
@@ -126,40 +135,43 @@ When an event takes place at the server that triggers events related to server o
|
||||
|
||||
## General notification type
|
||||
|
||||
The General notification type is a special case, all users are automatically subscribed to In Application delivery of general notifications meaning they will always receive critical system notifications as well as direct notifications from other users **inside AyaNova application**
|
||||
There are no settings adjustable for in app General notifications however it is possible to create a general notification with email delivery.
|
||||
The General notification type is a special case, all users are automatically subscribed to In Application delivery of general notifications meaning they will always receive critical system notifications as well as direct notifications from other users **inside the AyaNova application**.
|
||||
|
||||
There are no settings adjustable for in-app General notifications, they are built in, however it is possible to create another general notification with email delivery.
|
||||
|
||||
## Notification event types
|
||||
|
||||
| EVENT | DESCRIPTION |
|
||||
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Object deleted | Deletion of core business object of selected type and tags |
|
||||
| Object created | Creation of core business object of selected type and tags |
|
||||
| Object modified | Any changes and saving of core business object of selected type and tags |
|
||||
| Work order status change | Any _change_ of Workorder Status including from no status (new) to a _specific_ selected status ID value |
|
||||
| Contract expiring | Customer service contract expiration |
|
||||
| CSR accepted | Customer service request accepted. (intended for Customer users) |
|
||||
| CSR rejected | Customer service request rejected. (intended for Customer users) |
|
||||
| Quote status change | Any _change_ of Quote Status including from no status (new) to a _specific_ selected status ID value |
|
||||
| Object age | Any object, Age (conditional on AgeValue) after creation event of any object of selected specific type and optionally selected tags |
|
||||
| Reminder imminent | A Reminder is about to reach it's specified start date/time |
|
||||
| Review imminent | A Review is about to reach it's specified review date/time |
|
||||
| Scheduled on work order | User is scheduled on (added to) a Work order |
|
||||
| Scheduled on work order imminent | Scheduled date and time reached for workorder which User is scheduled |
|
||||
| Work order completed status overdue | Workorder not set to a "Completed" type Status before the selected duration from created date |
|
||||
| Work order completed | Service work order is set to any status that is flagged as a "Completed" type of status. (Customer / HeadOffice or staff User notification) |
|
||||
| Outside service overdue | An item sent for 3rd party service is overdue from projected repair time frame |
|
||||
| Outside service received | An item sent for 3rd party service has been received back |
|
||||
| Part request received | An out of stock part requested via a Workorder has been received |
|
||||
| Notify health check | Automatic daily "ping" notification to confirm notification and Generator system is active at server |
|
||||
| Backup status | Result of last Backup operation at server |
|
||||
| Customer service reminder | Scheduled service date / time is about to be reached. (Customer or HeadOffice type users only) |
|
||||
| Work order total exceeds threshold | The balance of a Work order has exceeded a threshold and is set to completed status (the "Andy") |
|
||||
| Workorder status age | A Workorder has been sitting at the selected status for longer than the selected time frame |
|
||||
| Unit warranty expiry | A Unit's warranty expiration date is reached |
|
||||
| Unit meter reading multiple exceeded | A meter reading has a difference from the last reading by the selected amount (negative OR positive to cover count _down_ meters or rollover / reset meters, can tag filter by Unit tag) |
|
||||
| General notification | Any general notification including direct text notifications between users (built in but provided for email alternative delivery) |
|
||||
| Server operations problem | Any timely and serious issue related to internal AyaNova Server operations requiring attention |
|
||||
| Quote status age | A Quote has been sitting at the selected status for longer than the selected time frame |
|
||||
| Copy of customer notification | Copy of any notification sent to Customer for AyaNova User. Filterable by Customer Tag |
|
||||
| Work order created for customer | Customer notification sent when a service type work order is created for them (or if HeadOffice Contact user, one of their Customers) |
|
||||
The following table shows the types of notification events currently available for subscription.
|
||||
|
||||
| EVENT | DESCRIPTION |
|
||||
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Object deleted | Deletion of core business object of selected type and tags |
|
||||
| Object created | Creation of core business object of selected type and tags |
|
||||
| Object modified | Any changes and saving of core business object of selected type and tags |
|
||||
| Work order status change | Any _change_ of Workorder Status including from no status (new) to a _specific_ selected status ID value |
|
||||
| Contract expiring | Contract expiration |
|
||||
| CSR accepted | Customer service request accepted. (intended for Customer users) |
|
||||
| CSR rejected | Customer service request rejected. (intended for Customer users) |
|
||||
| Quote status change | Any _change_ of Quote Status including from no status (new) to a _specific_ selected status ID value |
|
||||
| Object age | Any object, Age (conditional on AgeValue) after creation event of any object of selected specific type and optionally selected tags |
|
||||
| Reminder imminent | A Reminder is about to reach it's specified start date/time |
|
||||
| Review imminent | A Review is about to reach it's specified review date/time |
|
||||
| Scheduled on work order | User is scheduled on (added to) a Work order |
|
||||
| Scheduled on work order imminent | Scheduled date and time reached for workorder which User is scheduled |
|
||||
| Work order completed status overdue | Workorder not set to a "Completed" type Status before the selected duration from created date |
|
||||
| Work order completed | Service work order is set to any status that is flagged as a "Completed" type of status. (Customer / HeadOffice or staff User notification) |
|
||||
| Outside service overdue | Unit sent for 3rd party service is overdue |
|
||||
| Outside service received | Unit sent for 3rd party service has been received back |
|
||||
| Part request received | Part requested via a Workorder has been received |
|
||||
| Notify health check | Automatic daily "ping" notification to confirm notification and Generator system is active at server |
|
||||
| Backup status | Result of last automated backup |
|
||||
| Customer service reminder | Scheduled service date / time is about to be reached. (Customer or HeadOffice type users only) |
|
||||
| Work order total exceeds threshold | The balance of a Work order has exceeded a threshold and is set to completed status (the "Andy") |
|
||||
| Workorder status age | A Workorder has been sitting at the selected status for longer than the selected time frame |
|
||||
| Unit warranty expiry | A Unit's warranty expiration date is reached |
|
||||
| Unit meter reading multiple exceeded | A meter reading entry has a difference from the last reading by the selected amount (negative OR positive to cover count _down_ meters or rollover / reset meters, can tag filter by Unit tag) |
|
||||
| General notification | Any general notification including direct text notifications between users (built in but provided for email alternative delivery) |
|
||||
| Server operations problem | Any timely and serious issue related to internal AyaNova Server operations requiring attention |
|
||||
| Quote status age | A Quote has been sitting at the selected status for longer than the selected time frame |
|
||||
| Copy of customer notification | Copy of any notification sent to Customer for AyaNova User. Filterable by Customer Tag |
|
||||
| Work order created for customer | Customer notification sent when a service type work order is created for them (or if HeadOffice Contact user, one of their Customers) |
|
||||
|
||||
Reference in New Issue
Block a user