Server Options

Parent Previous Next

Server Framework


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


Important Note

Before connecting to BI xPress Server's Notification Engine, users will first need at least one Event configured within the BI xPress Server Notification Engine.



1.   Address: The URL used to connect to Workbench Server. Click the "Test" button to confirm a successful connection

2.   Event Name: The name of the event that BI xPress Server will send once it receives the notification from the SSIS Package. Once the Address is populated, click the "Refresh" button to query BI xPress Server for a list of all configured events that can be used

3.   Severity: The Severity level of the notification that will be sent to Workbench Server. All Events with the same event name and a priority less than or equal to the listed severity will trigger once BI xPress Server receives the notification from the SSIS Package

4.   Parameters: A detailed list of all parameters that will be sent along side the notification to BI xPress Server.  There are two types of parameters, reserved and custom parameters.

5.   Events to Notify: Events to Notify allows users the ability to specify upon which event(s) they wish to have the Notification Engine send to BI xPress Server:

o   OnError: The Notification Engine will notify BI xPress Server to trigger the selected event when when an error occurs

o   OnWarning: The Notification Engine will notify BI xPress Server to trigger the selected event when when a warning occurs

o   OnSuccess: The Notification Engine will notify BI xPress Server to trigger the selected event upon a successful execution of the SSIS Package(s)

o   OnComplete: The Notification Engine will notify BI xPress Server to trigger the selected event once the SSIS Package(s) have completed executing


6.   How soon to be notified? Species when the user wishes for the Auditing Framework to send the notification to BI xPress Server


Once done configuring the Notification Engine Options, click the Next button to head to the Summary page to begin the process of adding / updating the Notification Framework.


Reserved Parameters

Reserved parameters are default notification properties that are always sent alongside the notification to BI xPress Server. Below is a list of reserved parameters along side example values:


Reserved Parameters for Notification Engine

Parameter Name

Example Value

PackageName

SSIS Package 1

Status

COMPLETED W/ ERRORS

StatusShort

WARNING

TotalAlertCount

1932

WarningCount

5243

ErrorCount

10015

Runtime

2 day,4 hr,8 min,16 sec

MachineName

PROD-SRVR-234

ExecutionAccount

CompanyDomainName\SsisPackageExecutorAccount

WasInteractive

True

PackageStartTime

10/12/2016 12:18:46 PM

PackageEndTime

10/12/2016 12:18:46 PM

FrameworkVersion

2016.4.4.1001

Alerts

A collection of alerts (warnings and errors).  Each alert has the following properties with example values:


Individual Alert Parameters

Parameter Name

Example Value

AlertCode

-2147183868

AlertDescription

Warning: Could not open global shared memory to communicate with performance DLL; data flow performance counters are not available.  To resolve, run this package as an administrator, or on the system's console.

AlertTimeStamp

10/26/2016 4:47:02 PM

AlertType

WarningAlert

SourceId

{8E88893A-075B-4A4E-A016-BB72FD5F9E63}

SourceName

DFT_Process_Sales


An alert's AlertType parameter can be one of the following values:

ErrorAlert

WarningAlert

TimeThresholdAlert

RowCountThresholdAlert



Custom Parameters

Additional properties that users can configure to send alongside the notification to BI xPress Server. These custom parameters contain either a static value, or can be associated directly to a variable or project / package parameter.


Variable Syntax


<namespace>::<variableName>



Variable Arguments

namespace - the namespace used by the variable the user wishes to send alongside the notification. By default, SSIS provides two namespaces: User and System. However additional user-defined namespaces can be created.


variableName - The name of the variable the user wishes to pass alongside the notificaiton.


Package Parameter Syntax


$Package::<packageParameterName>



Package Parameter Arguments

packageParameterName - The name of the package parameter the user wishes to pass alongside the notificaiton.


Project Parameter Syntax


$Project::<projectParameterName>



Project Parameter Arguments

projectParameterName - The name of the project parameter the user wishes to pass alongside the notificaiton.


Important Note

For Project Parameters to be passed alongside the notification to BI xPress Server, the package must be executed within Project Deployment Model.