admin/raven
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
John Cardinal
2022-01-28 00:28:22 +00:00
parent d4668578e9
commit d0c0d33578
1 changed files with 34 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/8.0/ayanova/docs/home-notify-subscriptions.md
View File

@@ -14,7 +14,7 @@ Notification subscriptions are stored in a database table at the server and the
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.
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 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.
@@ -84,7 +84,7 @@ Many communication services support an SMTP gateway that can work with AyaNova's
#### 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.
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
@@ -94,7 +94,7 @@ 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 +108,6 @@ 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...
### Business object edited
@@ -132,37 +131,34 @@ There are no settings adjustable for in app General notifications.
## Notification event types
| EVENT | DESCRIPTION |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ObjectDeleted | Deletion of core business object of selected type and tags |
| ObjectCreated | Creation of core business object of selected type and tags |
| ObjectModified | Any changes and saving of core business object of selected type and tags |
| WorkorderStatusChange | Any _change_ of Workorder Status including from no status (new) to a _specific_ selected status ID value |
| ContractExpiring | Customer service contract expiration |
| CSR Accepted | Customer service request accepted. (intended for Customer users) |
| CSR Rejected | Customer service request rejected. (intended for Customer users) |
| QuoteStatusChange | Any _change_ of Quote Status including from no status (new) to a _specific_ selected status ID value |
| ObjectAge | Any object, Age (conditional on AgeValue) after creation event of any object of selected specific type and optionally selected tags |
| ReminderImminent | A Reminder in AyaNova is about to reach it's specified date/time |
| ScheduledOnWorkorder | User is scheduled on (added to) a Work order |
| ScheduledOnWorkorderImminent | Scheduled date and time reached for workorder which User is scheduled |
| WorkorderCompletedStatusOverdue | Workorder not set to a "Completed" type Status before the selected duration from created date |
| WorkorderCompleted | Service work order is set to any status that is flagged as a "Completed" type of status. (Customer / HeadOffice or staff User notification) |
| OutsideServiceOverdue | An item sent for 3rd party service is overdue from projected repair time frame |
| OutsideServiceReceived | An item sent for 3rd party service has been received back |
| PartRequestReceived | An out of stock part requested via a Workorder has been received |
| NotifyHealthCheck | Automatic daily "ping" notification to confirm notification and Generator system is active at server |
| BackupStatus | Result of last Backup operation at server |
| CustomerServiceReminder | Scheduled service date / time is about to be reached. (Customer or HeadOffice type users only) |
| WorkorderTotalExceedsThreshold | The balance of a Work order has exceeded a threshold and is set to completed status (the "Andy") |
| WorkorderStatusAge | A Workorder has been sitting at the selected status for longer than the selected time frame |
| UnitWarrantyExpiry | A Unit's warranty expiration date is reached |
| UnitMeterReadingMultipleExceeded | 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) |
| GeneralNotification | Any general notification including direct text notifications between users (built in but provided for email alternative delivery) |
| ServerOperationsProblem | Any timely and serious issue related to internal AyaNova Server operations requiring attention |
| QuoteStatusAge | A Quote has been sitting at the selected status for longer than the selected time frame |
| 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) |
| 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 in AyaNova is about to reach it's specified 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) |