PI Notifications: Powerful and Extensible

Size: px

Start display at page:

Download "PI Notifications: Powerful and Extensible"

Christine Wood
5 years ago
Views:

1 PI Notifications: Powerful and Extensible Presented By: Beth McNeill Development Lead David Moler Software Developer Where PI geeks meet 9/23/2010

4 PI Notifications Components and connections PI-SDK Clients: PI Notifications Clients: Web Browser ANSDK AF SDK TCP 5450 TCP 5458 TCP 80/443 PI-SDK Notification Scheduler & Analytic Processors Data Buffering Services AFSDK TCP 5458 Acknowledgement Web Page ANSDK TCP 5450 TCP 5450 TCP 5457 TCP 5457 PI Server Asset Framework (AF) Server TCP 1433 MS SQL Express/ Server

8 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 8 Notification Templates Based on element templates Create template once Notification created when element created Options include Create Start

9 Delivery Channels How a message is delivered , web service and OCS included Extensible write your own! Helper classes available vcampus example XML delivery channel Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 9

static subject for email Choose what content to

12 Current: Message Specify subject (not dynamic) Specify content (no control over layout) Specify static subject for Choose what content to include Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 12

Web Part Trend Content defined on notification Each subscriber requests

13 Current: Subscriptions Notification 1 Content 1. Trigger Input 2. Attribute 3. Web Page 4. Acknowledgement 5. Web Part Trend Content defined on notification Each subscriber requests content individually 1, 2, 4, 5 1, 2, 4, 5 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 13

14 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 14 Current: Subscriptions Notification Content 1. Trigger Input 2. Attribute 3. Web Page 4. Acknowledgement 5. Web Part Trend Each new subscribers must request content not scalable/maintainable 1 1, 2, 4, 5 1, 2, 4, 5?!?!

16 PI Notifications 2010: Subscriptions Notification Simple Format 1. Simple 2. Detailed (default) 3. New paradigm: message format Subscribers request a message format Group, notification, global defaults Message format and subscribers can be set on Notification Template Detailed Detailed Detailed Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 16

19 Sample Delivery Channel Web Page Custom delivery channel that outputs a web page when triggered Review contact configuration & available helper Support formatting so user can compose web page content Exhibit preview and improved test Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved

20 Delivery Channel configuration behavior Configuration stored in ConfigString Contact Properties (e.g. Importance) are inherited from parent Values can be overridden or defaulted When formatting is available, only contact properties should be stored Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 20

21 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 21 Delivery Channel: Property Inheritance Notification Notification Template Contact Definition Template (Template is null) Template (Contact Definition is null) T = AFNotificationContact = AFNotificationContactTemplate T

22 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 22 Delivery Channel: Property Inheritance Notification Notification Template High (inherited) Importance = High Importance = Normal Normal (inherited) T = AFNotificationContact = AFNotificationContactTemplate T

23 How to I use the ConfigStringHelper? public override string ConfigString { get { return _confighelper.configstring; } set { if (ConfigString!= value) { _confighelper.configstring = value; SaveConfigChanges(); } } } Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 23

24 How to I use the ConfigStringHelper? public string Url { get { return _confighelper.getvalue("url"); } set { if (_confighelper.setvalue("url", value)) { SaveConfigChanges(); } } } Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 24

25 Delivery Channels: with pre-formatting Notification Delivery Format Message= Notification Triggered Bob - Delivery Channel ConfigString= bob@foo.com; ConfigString= bob@foo.com Message=Notification Triggered Alice - Delivery Channel ConfigString= alice@foo.com; ConfigString= alice@foo.com Message=Notification Triggered Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 25

27 What objects are available? ANDeliveryFormat Stores plug-in specific message configuration Key value pairs <string, string> (e.g. [ Subject ] = Notification Triggered Built-In components to work with common types (rich text, plain text, attachments) Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 27

28 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 28 What needs to change in my Delivery Channel? public class WebPage : AFDeliveryChannel { ///*** old delivery channel implementation hidden***/// public void Send( ANProcessedDeliveryFormat processedformat, bool test) } public static Type ConfigurationManagerType { get; }

29 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 29 How do I implement the Configuration Helper? internal class WebPageConfigurationManager : ANFormattableDeliveryChannelConfigurationManager { public override void InitializeGlobalFormat( ANDeliveryFormat globaldefaultformat) public override ANProcessedDeliveryFormat ProcessResults( ANDeliveryFormat deliveryformat, ANNotificationResults results, bool test) } public override Type GetEditorType()

30 Sending Formatted Notification Delivery Format Results Process Results Processed Delivery Format Send

31 What else do I need to implement? internal partial class WebPageEditorControl : ANWPFDeliveryFormatEditor { protected override void LoadFromDeliveryFormat( ANDeliveryFormat deliveryformat, bool readonly) } protected override void SaveToDeliveryFormat( ANDeliveryFormat deliveryformat) Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 31

32 Editor Implementation protected override void LoadFromDeliveryFormat( ANDeliveryFormat deliveryformat, bool readonly) { _messageeditor.readonly = readonly; _messageeditor.notificationcontext = base.notificationcontext; _messageeditor.messageconfiguration = deliveryformat["message"]; } protected override void SaveToDeliveryFormat(ANDeliveryFormat deliveryformat) { deliveryformat["message"] = _messageeditor.messageconfiguration; } Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 32

33 Sending Formatted Notification Delivery Format Results Process Results Processed Delivery Format Send

34 Sending Formatted Notification Xaml Results Xaml Processor Processed Xaml Convert Xaml (to HTML or Plain Text)

35 public override ANProcessedDeliveryFormat ProcessResults( ANDeliveryFormat deliveryformat, ANNotificationResults results, bool test) { var processedresults = new ANProcessedDeliveryFormat(); string processedxaml = ANXamlFormatProcessor.ProcessResults( deliveryformat["message"], results); processedresults["message"] = processedxaml; return processedresults; } public void Send(ANProcessedDeliveryFormat processedformat, bool test) { string processedxaml = processedformat["message"]; using (StreamWriter writer = new StreamWriter(Url)) writer.writeline(anxamlconverter.converttohtml(processedxaml)); } Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 35

36 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 36 Summary Message composition is highly desired Formats improve configuration for users Implementation straightforward using builtin components Old delivery channels will still work

37 Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 37 Wrap-up Power of notification templates assist implementation Delivery Channel enables extensibility Customize content with new formatting features in upcoming release

38 More Information Previous Presentations - vcampus Builders' Café Webinar Series: Tour of the AF and PI Notifications Developer Tools vcampus - forums Where PI geeks meet 2010 OSIsoft, LLC. All Rights Reserved 38

TOUR OF THE AF AND PI NOTIFICATIONS DEVELOPER TOOLS THE BUILDERS' CAFÉ WEBINAR SERIES

TOUR OF THE AF AND PI NOTIFICATIONS DEVELOPER TOOLS THE BUILDERS' CAFÉ WEBINAR SERIES AGENDA Overview PI AF PI Notifications The OSIsoft SDKs PI AF Developer Tools PI Notifications Developer Tools Q&A