***Important notes before configuring WIN-911***


Please review the System Requirements page for supported SCADA versions and other helpful information.





*** Important System Platform Notes ***


Please review the System Platform Network Diagrams for recommended architecture examples.



MXAccess Licensing


WIN-911 must be installed to a deployed WinPlatform node with an MXAccess license.


If you do not have an MXAccess license, you can download the license for  MXAccess for SP 2014 R2


If you require an MXAccess license for System Platform 2012 and older, then click the link and scroll down to SCADA/HMI Utilities and patches.  

NOTE: If you are using System Platform 2017 or System Platform 2020, then you will need to contact WIN-911 Technical Support. To open a new support case you can submit a ticket Online or call 1-512-326-1011



 

Wonderware Alarm Toolkit 

 

The Alarm Toolkit requires that your WinPlatform act as an InTouch Alarm Provider.  You can enable this feature in the Archestra IDE.


Open the IDE, connect to your Galaxy, and double-click on your WinPlatform.


 

        On the General tab, check the box for Enable InTouch Alarm Provider.


NOTEIf the box for Register using … is checked, be sure to check the same box in WIN-911 when configuring the System Platform Galaxy.

 

 

 

Save your changes and redeploy your platform.



Security 

 

If you are using Security in your Galaxy, then you will need a dedicated user account and password to use with WIN-911. The password for this account should never changeAcknowledgments and the WIN-911 Heartbeats will not work if this is not defined correctly or if the password changes.





*** WIN-911 Configuration ***



In the WIN-911 Workspace, expand Alarm Sources > System Platform > Click Add New Galaxy.


Fill out the corresponding fields in WIN-911 to connect to the System Platform Galaxy.
Name: This setting should match the name of the Galaxy name defined in the Archestra IDE.

Enable Galaxy_<galaxy> Query Syntax: This selection should match the setting in your WinPlatform, as defined in the General tab (pictured above) of WinPlatform settings in the Archestra IDE. This was configured earlier in the article. 

Ack Message Method: WIN-911 provides flexibility and offers three options for delivering an acknowledgment message to the System Platform. These options affect the way the alarm comment appears after the acknowledgment executes. 


Enable Authentication: System Platform can be configured to require authentication from clients (like WIN-911) that wish to acknowledge alarms.If you have Authentication Mode defined as Galaxy, OS User based, or OS Group based, you must Enable Security in WIN-911. Check the provided box and enter the credentials in the respective text-entry fields.

You can check your Galaxy settings by opening the IDE. On the Galaxy menu, click Configure and then click Security.


 

Ignore COMM Alarms: When this option is selected, WIN-911 will not dispatch any COMM alarms associated with this Galaxy.



Areas: System Platform organizes its alarms by areas, which is a hierarchical structure that begins with a root area(s). These areas can contain child areas called descendants. WIN-911 queries alarms based on their areas. When an area is queried, its immediate alarms and those of its descendants are fetched.


NOTEYou must provide an Area in order to receive alarms from that Area. System Platform recommends nesting all Areas under a common root Area.




Configure Subscriptions - Expand Subscription section and click +Add Subscription




Type in a Name and select which Notification Policy the alarms will be sent to.




Clicking "Add Filter" and using the built-in "AND / OR" options with "Add Criterion" adds another layer of customization to each filter, allowing subscriptions to be as simple or complex as needed. 

In this example, the filter will catch any alarms in the Area that contains the text Lift Station 22 AND Does Not Contain alarms with the Attribute matching the text Door Alarm.





Click "Save Galaxy" when finished.  Alarms will be sent to the configured Notification Policy for the first matching subscription

NOTE: Only 1 subscription can be matched, and no further processing against other subscriptions will occur. 

Create as many subscriptions as needed. Reorder by dragging a line item up or down the list.

NOTE: A "catch all" for all alarms sent to a "Do Not Notify" Policy can be added as the last line item to verify alarms are being sent to WIN-911, you will see them in the Log Viewer. This Subscription filter can be deleted upon confirmation that alarms are being seen in WIN-911.




And always... Save your changes!





Watchdogs (Optional) 


A Watchdog alarm will be triggered and contacts will be notified when there is no alarm activity from a specific Device in System Platform, in a specified amount of time.


Fill out required fields, configure timeout, select which Notification Policy this Watchdog alarm should call out to and set the severity of your choice.

Name: User defined alarm name

Area: The Galaxy Area that this Watchdog Device is configured under.

Device Name: The full syntax of the alarm (Object.Attribute) in your Galaxy that the Watchdog is intended to monitor.

NoteIn the following example, the object name is PLC5 and the Attribute name is RAMP001. Therefore, you would enter PLC5.RAMP001 for your device name.





Heartbeats (Optional) 


The heartbeat is an optional feature that allows WIN-911 to indicate its operational status by writing a periodically changing value to an integer attribute in your Galaxy. We call this function a 'Heartbeat' because it provides a 'vital-sign' to your Galaxy, allowing for corrective action to be taken. 

 

The Heartbeat takes the form of an Integer value that ramps from 0 to 9 on a period of your choosing. After the value reaches 9 it resets to one, and the process is repeated, ad infinitum. If the attribute fails to update within the specified time, you can assume that WIN-911 is in an impaired state and no longer able to receive alarm event information. 

 

    NOTE: the heartbeat is the only WIN-911 function that will write data to the System Platform.





Heartbeat setup:

  1. Create an attribute in your Archestra IDE > Device that is a type of Integer which allows input. 
  2. Create QuickScript that monitors the attribute value and triggers recovery procedures/methods when the heartbeat fails. 
  3. WIN-911 Workspace > Alarming > System Platform > Galaxy > Heartbeat > Enable Heartbeat
  4. Enter the name of the attribute you created in step 1. 
  5. Set the heartbeat update rate (in Minutes) with the Write Interval combo-box. 
  6. Save your edits in the WIN-911 Workspace. 

 

The Heartbeat Suspension feature is provided as a means of forcing a heartbeat failure in the event of a 'partial communications failure' between your System Platform Application and WIN-911. WIN-911's System Platform Data Source leverages two Wonderware Toolkits. 

- The MxAccess toolkit provides System Platform with information from WIN-911, like alarm acknowledgment requests and heartbeat data. 

- The Alarm Toolkit provides WIN-911 with the alarm information from System Platform. 


If the Alarm Toolkit stops responding while MxAccess remains, your Application will still be receiving a healthy heartbeat from WIN-911 even while WIN-911 is not receiving alarm events. 



Heartbeat suspension:

  1. Create a separate attribute within your Galaxy that allows input. You can use a Discrete, for example. 
  2. Set the attribute with an alarm condition that cycles in and out of alarm on a periodic basis. In our Discrete example, you can set the alarm state for On
  3. You will need to determine what amount of time you wish to check WIN-911 for alarm coverage. Let's say every 5 minutes in this scenario. 
  4. You will need to provide a way to write data to the attribute you created in step 1. You can use QuickScript or another source of data like OPC. In this example, this data will need to be toggled at a rate that is less than the desired timeout, say every four minutes. 
  5. WIN-911 Workspace > Alarming > System Platform > Galaxies > Heartbeat >Enable Heartbeat Suspension
  6. Enter the name of the attribute you created in step 1. 
  7. Set the suspension timeout (in Minutes) with the Timeout combo box. 
  8. Save your edits in the WIN-911 Workspace. 

 

This will result in a dummy-alarm that WIN-911 will be advised of every four minutes. While this cycle continues, the heartbeat will continue to update, and you can assume that WIN-911 is alive and capable of carrying out its duties. If the suspension timeout elapses without a new alarm being detected, WIN-911 will stop the heartbeat. 






Back to Quick Start Homepage >


Technical Support


To create a support case, you will need either your Customer Care Code or your Serial number. You can create a Case online or contact the product support line: (512) 326-1011.