This commit is contained in:
@@ -1,3 +1,57 @@
|
||||
# FORM-HOME-NOTIFY-SUBSCRIPTIONS Placeholder
|
||||
# NOTIFICATION SUBSCRIPTIONS
|
||||
|
||||
This is a placeholder page for sections that are not written yet
|
||||
AyaNova has dozens of different types of notifications that can be subscribed to for events of interest.
|
||||
They can be delivered via email / SMS or directly in application or both.
|
||||
|
||||
This form is used to control notification subscriptions.
|
||||
|
||||
## 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 on it's ID value.
|
||||
|
||||
|
||||
## Notification subscription edit form
|
||||
|
||||
Depending on the event type selected you will see different form fields as appropriate to that event.
|
||||
|
||||
### Notification event
|
||||
This is where you select the type of event you are subscribing to. All event types are listed 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 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.
|
||||
|
||||
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 example In application 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
|
||||
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.
|
||||
|
||||
### Decimal value
|
||||
Some events are related to monetary or other numeric amounts or thresholds, for example a workorder total price exceeded or meter count exceeded, this field will be presented in those cases to enter the numeric amount related to the event that you want to be notified.
|
||||
|
||||
### Report
|
||||
In the case of an event that can have a report associated with it, you can select a report to be automatically sent with the event (in the case of email delivery) or linked to (in the case of in application delivery).
|
||||
|
||||
### Delivery method
|
||||
Currently you can choose between In application which will deliver to the [notifications](form-home-notifications.md) form and alert via the bell icon at the top of the AyaNova application window and email / SMS delivery via SMTP.
|
||||
|
||||
### Deliver to Address
|
||||
If email / SMS delivery method is chosen this field is where you enter the address for delivery. If it is to your SMS / MMS device then you must set the address provided by your cellular provider for their [SMS / MMS gateway](https://www.wikihow.com/Send-a-Text-from-Email)
|
||||
|
||||
By default AyaNova will fill this field in with your email address set in your [User settings](form-home-user-settings.md) form however you can change it to any value you wish.
|
||||
|
||||
### Tags
|
||||
Here you can select one or more [Tags](ay-start-form-tags.md) (if the event is related to a taggable object) to act as a filter 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.
|
||||
|
||||
If no tags are selected then tags are not considered at all when processing notifications.
|
||||
|
||||
|
||||
|
||||
## Notification event types
|
||||
| CODE | MEANING |
|
||||
| ----- | ------------------------------ |
|
||||
| E1000 | Could not connect to the database specified in the [connection string](ops-config-db.md). |
|
||||
|
||||
Reference in New Issue
Block a user