From a866d29fbe702aaffcff007fda646784f81f2381 Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Wed, 29 Jul 2020 13:58:30 +0000 Subject: [PATCH] --- .../docs/form-home-notify-subscriptions.md | 53 ++++++++++++++++++- .../ayanova/docs/ops-notification-system.md | 2 +- 2 files changed, 52 insertions(+), 3 deletions(-) diff --git a/docs/8.0/ayanova/docs/form-home-notify-subscriptions.md b/docs/8.0/ayanova/docs/form-home-notify-subscriptions.md index 70ca2505..3a01c79d 100644 --- a/docs/8.0/ayanova/docs/form-home-notify-subscriptions.md +++ b/docs/8.0/ayanova/docs/form-home-notify-subscriptions.md @@ -50,8 +50,57 @@ Here you can select one or more [Tags](ay-start-form-tags.md) (if the event is r If no tags are selected then tags are not considered at all when processing notifications. +## Events are triggered when... + +### Business object edited +When a new or updated AyaNova core business object is saved or deleted it triggers notification processing. + +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) + +### Something happens at the server +When an event takes place at the server that triggers events related to server operations. For example when the system backs up automatically. + + +## 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 Users can also subscribe to this same type of notification to be delivered via email / sms optionally. ## Notification event types -| CODE | MEANING | + + +| EVENT | DESCRIPTION | | ----- | ------------------------------ | -| E1000 | Could not connect to the database specified in the [connection string](ops-config-db.md). | +| 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 | +| ServiceBankDepleted | Service bank has run out and balance is within selected advance notice level | +| 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 | +| WorkorderCloseByPassed | Workorder not set to a completed type status by the pre-selected date/time | +| 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 | +| CustomerServiceImminent | Scheduled service date / time is about to be reached. Intended for Customer type User | +| PartRequested | An out of stock Part has been requested on a Work order | +| WorkorderTotalExceedsThreshold | The balance of a Work order has exceeded a threshold (aka 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 readingn *multiple* exceeds selected threshold (e.g. every 10,000 etc) | +| 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 | + + diff --git a/docs/8.0/ayanova/docs/ops-notification-system.md b/docs/8.0/ayanova/docs/ops-notification-system.md index 78e8efa4..acfb0b39 100644 --- a/docs/8.0/ayanova/docs/ops-notification-system.md +++ b/docs/8.0/ayanova/docs/ops-notification-system.md @@ -23,7 +23,7 @@ Operations users should subscribe to several key notifications related directly * BackupStatus - results of last backup operation * ServerOperationsProblem - sent whenever the server encounters any unusual condition or error that could be critical for the continuing operation of the AyaNova server -These are in addition to the normal operations methods of monitoring the health and status of the server such as [server logs](form-ops-logs.md), [metrics](form-ops-metrics.md), [job queue](form-ops-jobs.md) etc. +These are in addition to the normal operations methods of monitoring the health and status of the server such as [server logs](form-ops-log.md), [metrics](form-ops-metrics.md), [job queue](form-ops-jobs.md) etc.