1 Introduction
This document contains steps to configure alerts for any event in the OBDX application. An alert configuration is identified by following properties:
- Event Group: It groups similar events of similar functionalities together. An Event Group may contain multiple events.
- Event: An event could be any action taken by the user or system in OBDX application that triggers alert. Each event maps to a corresponding action or an activity executed in the business logic in OBDX. OBDX application may receive events from external system which are responsible for triggering alert.
- Message template: This is a template of the message that needs to be sent as an alert to the receiver. An event can have multiple templated based on the channel on which it is getting delivered.
- Message Destination: Destination is the channel on which alert/ notification will be delivered to the user. OBDX supports 5 such channels – Email, SMS, WhatsApp, Push Notification and On-screen notification.
- Message Attribute: A message template contains the message to be delivered to the receiver. The message is relevant to the action being performed in the specific event and it contains dynamic data values from the business logic. A message attribute is an identifier, which is used in the message template to replace with the actual values dynamically.
- Message Action: Some of the events in OBDX contains an actionable link in its content. This link is responsible for the navigation of user to desired location from the alert. Message action attribute defines the action to be executed during event processing.
This document also contains the business logic required to invoke an event for triggering alert within OBDX and other miscellaneous aspects.