Events
Notification Events are used to manage the notification 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.
|
Notification events need at least one template before becoming available. |
1. Notification Name: This details a user-friendly name that helps differentiate the notifications
2. Notification ID: An auto generated unique identifier for the current notification
3. 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
4. Severity: The severity threshold for the notification. Any Notification request sent with the same event name as well as a priority greater than or equal to the listed severity will trigger the notification event
5. Filters: Additional conditions based on notification parameters that limit whether or not the notification will be triggered. All HTTP requests that match the filters will be excluded from being triggered
6. Provider: The type of notification that will be sent
o Event Log: When triggered, a Notification using the Event Log Provider will write the message template to the Windows Event Log where BI xPress Server is located. Truncation may occur if the message template is longer than 15,000 characters
|
|
To use the Event Log provider, The BI xPress Application Pool will need to initially create a "BI xPress" event source. The initial creation of an event source requires administrative privileges. After initially creating the event source, these administrative privileges are not required. Alternatively, an administrator can manually create the event source from an elevated Windows PowerShell prompt using the following information:
|
o SMS Text Message: When triggered, a Notification using the SMS Text Message Provider will text the message template to the desired phone number(s).
o E-Mail: When triggered, a Notification using the E-mail Provider will e-mail the message template to the desired e-mail address(es)
o SQL: When triggered, a Notification using the SQL Provider will attempt to execute the message template as T-SQL
o Text File: When triggered, a Notification using the Text File Provider will write the message template to a text file
o Twitter: When triggered, a Notification using the Twitter Provider will tweet the message template. Truncation may occur if the message template is longer than 140 characters.
o Visual Studio Team Services: When triggered, a work item is created using the message template as the work item's repro steps and description
|
To use the Visual Studio Team Services provider, users will need to create a Personal Access Token with the "Work Items (read and write)" scope selected. For more information on creating a Personal Access Token within your Visual Studio Team Services Instance or TFS Server, go here. |
o REST Call: When triggered, a REST call is made to the specified URL, using the message template as the payload. Basic, OAUTH1 and OAUTH2 authentication types are supported.
o Run Process: When triggered, the specified executable is run. Optionally, a file can be created containing the message template and passed to the executable as a command line parameter.
7. Message Template: The current template that will be applied to the Provider when a valid HTTP request is received.
8. Enabled: Whether or not the current notification is enabled and listening for HTTP requests
Each Provider has additional properties that will need to be set in order for the Notification to be properly configured.
