The Notification Framework allows users to create notification event handlers on events such as OnError, OnWarning, OnSuccess, and OnComplete for any SSIS Packages through either the self-contained (classic) Notification Framework or by harnessing the power of BI xPress Server's Notification Engine.
• Add notification to multiple packages at once
• Easy to maintain through XML configuration files
• Send email and SMS text messages
Pragmatic Workbench (32-bit) must be used when applying the Notification Engine to SSIS packages on a machine that only contains SSDT for Visual Studio 2015.
Table of Contents
Regardless of whether the user selects the Classic or Server Framework, the following changes will be made to the SSIS Package when applying the Notification Framework. These changes are done based on options that are selected during application of the Notification Framework:
• Configuration File(s) or Package Parameter(s) may be created
• Package level Event Handlers will be created to capture and send runtime information within the OnError, OnWarning, OnSuccess and / or OnComplete Events.
If using the Classic Notification Framework, the SSIS Package contains a self-contained framework that gathers and sends the notification using the selected method(s).
The Notification Engine harnesses the power of HTTP Requests to manage which notification events trigger. Within an SSIS Package, the Notification Engine will send an HTTP Request to the user's BI xPress Server. Once BI xPress Server receives the HTTP Request, BI xPress Server will handle the notification, sending all valid events using the event's corresponding provider(s).
Do not alter any of the task names or descriptions created by BI xPress as BI xPress will not recognize any previously created tasks.
To use the BI xPress Server Notification Engine, the SSIS Package the user is attempting to apply the Notification Engine to will need access to a running instance of BI xPress Server.
The Notification Framework can be launched through Pragmatic Workbench or within the development environment (BIDS, SSDT, or VS). If launching through the development environment, the Notification Framework can be accessed by either locating the BI xPress toolbar or by right-clicking an SSIS Project or Package within the Solution Explorer. In both cases, there will be an option to select "Add / Remove Notification Framework (BI xPress)", this option will immediately launch the Notification Framework.
Once the Notification Framework has loaded, there will be a series pages that will help users configure the Notification Framework for their package(s). These pages change depending on whether the user wishes to add or remove the Notification Framework. Below can be found a list of all pages found within the Notification Framework, a brief description of their function, and a link to more details:
1. Select Action: The Select Action page allows users the ability to choose whether they wish to add / update or remove the Notification Framework from their SSIS packages. Depending on which action they choose, the available pages will change. Below can be found the underlying differences between Adding / Updating and Removing the Notification Framework:
Add / Update the Notification Framework
1. Select Packages: When adding / updating the Notification Framework, the Select Packages page allows users the ability to select which packages they wish to add / update the Notification Framework.
2. Choose Framework Type: When adding / updating the Notification Framework, users can choose between the classic Notification Framework or the new BI xPress Server Notification Engine.
1. Classic Options: Classic Options allows users the ability to specify what events the user wishes to be notified on, the notification method(s) to use, how soon the user wishes to be notified, and configuration options for Email and SMS settings
2. Server Options: Server Options allows users to specify the server address and event name as well as the ability to add custom parameters, what events the user wishes to be notified on, and how soon the user wishes to be notified
Removing the Notification Framework
1. Select Packages: When removing the Notification Framework, the Select Packages page allows users the ability to select which packages the user wish to remove the Notification Framework.
2. Summary: The Summary page provides users with information, warnings, and errors that may occur during the application or removal of the Notification Framework
Navigating between the above pages can be done by using the back and next buttons located on the lower right of each page