Command Line
The BI xPress Server's Notification Engine command line tool allows users the ability send rich notifications through their BI xPress Server. The BI xPress Server Notification Engine command line tool utilizes the HttpEngine.exe located within the Notification Engine Command Line directory. By default, this is can be found in the following location, though this may change depending on the installation location set during install time:
C:\Program Files (x86)\Pragmatic Works\Workbench Server\Notification Engine Command Line\HttpEngine.exe
Any framework (such as Scheduled Tasks, TFS Build Server, Microsoft Systems Center) that is capable of starting an application and passing parameters using command line arguments will be capable of utilizing the the BI xPress Notification Engine command line tool to send rich notifications from their BI xPress Server.
HttpEngine.exe [Help] {<Operation>} {<Information>} [<Parameters>] |
Switch Arguments
To introduce a parameter argument to the HttpEngine.exe, use either a -- followed immediately by the parameter switch or - followed by the short form version of the parameter switch. If the switch requires a value, an = (equal) will be used to separate the parameter argument with the parameter value and must be surrounded by " (double-quotes) if the value contains a space or special character(s).
Below is a list of all Parameter Arguments grouped by their specific purpose:
Switch |
Description |
||
[-Operation] "value" |
This operation specifies the type of operation the Notification Engine command line tool will take. The sendNotifications operation will send all notifications with the same event name as the value of the eventName switch. The sendNotification operation will send the notification that has the notification id that matches the value of the notificationId switch. Users can specify the following values:
|
||
Switch |
Description |
-eventName "value" |
When used with the "sendNotifications" operation switch, all notification events that use the specified eventName will trigger, sending all related notifications. |
-notificationId "value" |
When used with the "sendNotification" Operation switch, only the notification that has the specified notification id will trigger, sending a single notification. |
Switch |
Description |
-"name" "value" [...n] |
Users can pass any number of key-value paired parameters through the Notification Engine's command line tool. Each parameter the user wishes to pass through must have a switch for the parameter name and the value they wish to match to that parameter. |
Examples
The following example sends all notifications with the event name "SSISNotification" and does not pass any parameters to that notification event
HttpEngine.exe "sendNotifications" -eventName "SSISNotification" |
The following example sends the notification with the Notification ID of "{edbc4104-126f-4646-8030-36e69aa3b892}" and passes the value "Completed" to the parameter named "Status"
HttpEngine.exe "sendNotification" -NotificationId "{edbc4104-126f-4646-8030-36e69aa3b892}" -Status "Completed" |
The following example sends all notifications with the event name "SSISNotification" and and sets the parameter named Status to "Completed", the parameter named PackageName to "ETLPackage.dtsx" and the parameter named Framework to "2015.3.7"
HttpEngine.exe "sendNotifications" -eventName "SSISNotification" -Status "Completed" -PackageName "ETLPackage.dtsx" -Framework "2015.3.7" |
