From e8cec11d81733cdac9334cd4e25e82d8838dccd4 Mon Sep 17 00:00:00 2001 From: John Cardinal Date: Tue, 28 Jul 2020 23:19:43 +0000 Subject: [PATCH] --- .../ayanova/docs/form-home-notifications.md | 3 ++ .../docs/form-ops-notification-settings.md | 6 ++-- .../ayanova/docs/ops-notification-system.md | 29 +++++++++++++++++++ 3 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 docs/8.0/ayanova/docs/form-home-notifications.md create mode 100644 docs/8.0/ayanova/docs/ops-notification-system.md diff --git a/docs/8.0/ayanova/docs/form-home-notifications.md b/docs/8.0/ayanova/docs/form-home-notifications.md new file mode 100644 index 00000000..990dc171 --- /dev/null +++ b/docs/8.0/ayanova/docs/form-home-notifications.md @@ -0,0 +1,3 @@ +# FORM-HOME-NOTIFICATIONS + +This is a placeholder page for sections that are not written yet diff --git a/docs/8.0/ayanova/docs/form-ops-notification-settings.md b/docs/8.0/ayanova/docs/form-ops-notification-settings.md index 1a417e17..a6737b2a 100644 --- a/docs/8.0/ayanova/docs/form-ops-notification-settings.md +++ b/docs/8.0/ayanova/docs/form-ops-notification-settings.md @@ -1,3 +1,5 @@ -# OPS-NOTIFICATION-SETTINGS Placeholder +# NOTIFICATION SETTINGS + +This form is used to configure SMTP mail server settings for notification purposes. + -This is a placeholder page for sections that are not written yet diff --git a/docs/8.0/ayanova/docs/ops-notification-system.md b/docs/8.0/ayanova/docs/ops-notification-system.md new file mode 100644 index 00000000..78e8efa4 --- /dev/null +++ b/docs/8.0/ayanova/docs/ops-notification-system.md @@ -0,0 +1,29 @@ +# NOTIFICATION SYSTEM + +AyaNova has a built in notification system that alerts users to events of interest that occur in AyaNova. + + +## Types of notifications +AyaNova has a default in application "General" type notification (used for internal system alerts and direct notification messages between users) to which all users are automtically subscribed by default. +(Users can also optionally add email delivery for General notifications) + +Beyond General notifications, Users can [optionally subscribe](form-home-notify-subscriptions.md) to dozens of other types of built in notifications for specific events such as a particular type of object being created or a Work order status changing. + +## Notification delivery methods +There are two methods of delivering notifications: +* In the AyaNova application in the [Notifications](form-home-notifications.md) form +* Email via SMTP server which includes delivery to regular email programs as well as to devices via [SMS / MMS gateways](https://www.wikihow.com/Send-a-Text-from-Email) provided by Cellular providers. + +## Email delivery configuration +The in application delivery does not require any configuration however the SMTP delivery is required to be set up in the [Ops Notification settings](form-ops-notification-settings.md) form. + +## Operations specific notification events +Operations users should subscribe to several key notifications related directly to system operations: +* NotifyHealthCheck - a recurring daily notification system "ping" sent out between 8am and 10am once every 24 hours minimum every day which is a verification that the notification system is up and running +* 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. + + +