1. System Platform Quick Start Guide
For more information on the configuration of WIN-911, please review the System Platform Installation Checklist.
A. Where to Install WIN-911
WIN-911 must be installed to a deployed WinPlatform node with an MXAccess license.
You can read additional information about nodes and licensing in the Nodes and Licensing Document.
B. MXAccess Licensing
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, then you will need to contact the Technical Support. To open a new support case you can submit a ticket Online or call 1-512-326-101
C. 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.
To do this, follow these steps:
1. Open the IDE, connect to your Galaxy, and double-click on your WinPlatform.
2. On the General tab, check the box for Enable InTouch Alarm Provider.
NOTE: If the box for Register using … is checked, be sure to check the same box in WIN-911 when configuring the System Platform Galaxy.
3. Save your changes and redeploy your platform.
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 change. If it does, WIN-911 will stop functioning.
2. Accessing WIN-911
There are two ways to open WIN-911 Workspace for editing:
- Clicking the shortcut that was created in the WIN-911 host's start menu,
- Opening a browser anywhere on the WIN-911 network and entering the WIN-911 Configuration URL.
The WIN-911 Configuration website can be accessed from any computer that is on the WIN-911 network if you have the proper credentials. Simply open a browser and enter the URL: http://'WIN911 computer name'/WIN911.
A. System Platform Connection to WIN-911
Open the WIN-911 configurator and select Alarming > System Platform > Galaxies.
The following are options in the Connection Details are user-configurable:
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.
- Append Alarm Comment with Ack Message
- Replace Alarm Comment with Ack Message
- Use Alarm Comment as Ack Message
Enable Authentication: System Platform can be configured to require authentication from clients (like WIN-911) that wish to connect. If the Galaxy is configured with this requirement you will need to create credentials (Username and Password) that WIN-911 can use. Check the provided box and enter the credentials in the respective text-entry fields.
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.
NOTE: You must provide an Area in order to receive alarms from that Area. System Platform recommends nesting all Areas under a common root Area.
3. Watchdogs (Optional)
WIN-911’s System Platform Source supports Watchdog alarms as an optional part of the configuration. Watchdogs monitor a specific device for a changing alarm state. If an update is not received within the specified timeout period, the watchdog will become an active alarm. Watchdogs can thus be used to monitor the operation and connectivity of critical devices.
Watchdogs have a configurable Severity from 0 – 1000 inclusively and may also have Labels attached. Watchdogs are associated with a Strategy for alarm escalation. Ways to configure strategies are discussed later in this document.
Name: Enter a unique, user-friendly name to identify this watchdog configuration. This is the name that will be most prominently displayed in the alarm notification.
Area: Enter the Galaxy Area that this Watchdog is associated with.
Device Name: The full syntax of the alarm (Object.Attribute) in your Galaxy that the Watchdog is intended to monitor. In the following example, the object name is PLC5 and the Attribute name is RAMP001. Therefore, you would enter PLC5.RAMP001 for your device name.
4. Heartbeat (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.
This link to the Heartbeats Webinar will discuss how to make a heartbeat connection to WIN-911.
- Create an attribute in your Archestra IDE > Device that is a type of Integer which allows input.
- Create QuickScript that monitors the attribute value and triggers recovery procedures/methods when the heartbeat fails.
- WIN-911 Workspace > Alarming > System Platform > Galaxy > Heartbeat > Enable Heartbeat.
- Enter the name of the attribute you created in step 1.
- Set the heartbeat update rate (in Minutes) with the Write Interval combo-box.
- 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 System Platform alarm information to WIN-911. 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.
- Create a separate attribute within your Galaxy that allows input. You can use a Discrete, for example.
- 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.
- 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.
- 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.
- WIN-911 Workspace > Alarming > System Platform > Galaxies > Heartbeat >Enable Heartbeat Suspension.
- Enter the name of the attribute you created in step 1.
- Set the suspension timeout (in Minutes) with the Timeout combo box.
- 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.
5. Configuring Notifiers
WIN-911 offers four different options for delivering alarm notifications; email, SMS, Voice and the WIN-911 Mobile App. The next step in the process is to create the Gateway connection for all desired notification methods and add the users as contacts in WIN-911. If you are not familiar with this process you may review the How-To notifier videos.
Retries - Additional notification events
Delay Between Retries - Time between notification retry.
Delay After - Allow time for the user to address the alarm before moving onto the next contact.
Start Tactic – Which callout list will be started
Stop Condition – When to stop the callout list.
6. Bringing Alarms Into WIN-911
A. Alarm Subscriptions
It is important to understand how to use Subscriptions to bring alarms into WIN-911.
Open the Alarming > System Platform > Subscriptions tab.
The WIN-911 connection to System Platform allows filtering alarms by the following categories:
When building a subscription filter the items are case sensitive and must match what is configured in your SCADA.
NOTE: As demonstrated in the image below, the categories are ANDed together while the individual items in the category are ORed together. For more information watch the System Platform Alarm Subscriptions video.
B. Subscription Routes
Now that an alarm subscription has been created, the alarms must be routed to a specific strategy.
Open Alarming > System Platform > Galaxies
Then select the Subscription Routes tab.
Select a Subscription and the Strategy you wish to associate with alarm events matching the Subscription. Subscriptions are ranked to determine which route to follow when an alarm matches more than one Subscription.
NOTE: As a troubleshooting tip during testing and commissioning it is recommended to build an All Alarms filter and place it at the bottom of the list. This way if something in the subscription is misspelled then the all alarm filter will catch the alarm and you can use the WIN-911 LogViewer to troubleshoot.
Testing and Troubleshooting
By now all the following steps have been completed:
Connection between WIN-911 and System Platform
- Optional: Watchdogs and Heartbeats
- Notifier Gateways
- Notifier Connections (people)
- Tactics and Strategies
- Alarms Brought Into WIN-911
The next step is to trigger a test alarm and verify it was sent to the proper user. If the alarm does not appear, use the WIN-911 Log Viewer to troubleshoot the alarm.
Open windows explorer and find the Log Viewer tool.
Verify the alarm was sent to the appropriate strategy:
Double click the alarm for more information about the dispatch process: