Notification Engine


The Notification Engine allows users to connect and manage their packages' notification settings directly from within BI xPress Server, allowing users the ability to send rich, dynamic messages through E-mail, SMS, SQL, Text Files, Event Logs, and even Twitter.


Feature Highlights

  Create highly customizable message templates

  Quickly develop complex notification events to handle a variety of scenarios


Table of Contents

  How does the Notification Engine work?

  Advanced Syntax

  Templates

  Events

  Notification Requests


How does the Notification Engine work?

The Notification Engine harnesses the power of HTTP Requests to manage which notification events trigger. Once BI xPress Server receives an HTTP Request, BI xPress Server will handle the notification, sending all valid events using the event's corresponding provider(s).



Configuring the Notification Engine to be ready to receive HTTP Requests and send out notifications is simple. Below can be found a list of all the steps necessary to configure the Notification Engine. As well as a brief description of any details displayed within the Notification Engine's home page.



1.   Templates: Message Templates are used to lend form and reason to the HTTP requests that are received by the Notification Engine. They are fully customizable and control what information is included within the notification.

o   Name: The name for the message template

o   No. of Notification: The amount of notification events assigned to the following message template

o   Content Type: The type of content contained within the message template. Currently only HTML and Plaintext are supported

o   Preview: Allows the user to quickly preview the message template

o   Edit: Provides the user the ability to manually update the message template

o   Delete: Provides the user the ability to delete the message template



2.   Events: Notification Events are used to manage the HTTP requests that are received by the Notification Engine. They handle which Message Template(s) and Provider(s) will be used to send the notification based on the parameters sent by the HTTP request.

o   Notification: The name of the notification

o   Last Status: The data and time the notification was last sent as well as whether or not it was successfully sent

o   No. of Executions: The amount of times the notification has been run

o   Priority: The priority level of the notification. Any Notification request sent with the same name and a priority greater than or equal to the listed priority will trigger the notification event

o   Event Name: The name of the event BI xPress Server will be listening for. Only HTTP requests that are sent with this event name could be triggered

o   Test: Allows the user to send a test notification to confirm the notification is properly configured

o   Edit: Provides the user the ability to manually update the notification event

o   Delete: Provides the suer the ability to delete the message template


3.   Notifications Requests: Once the Notification Engine has been configured, users can request notifications through either the BI xPress Notification Framework, Command Line or through HTTP Web Request