1. InTouch Edge HMI Quick Start

 

This article introduces users to key concepts of WIN-911 as it guides the reader through the configuration of a simple alarm notification solution with InTouch Edge HMI. Topics include deployment considerations, configuring connectivity between WIN-911 and InTouch, and basic configuration of WIN-911 notification. For more information on the configuration of WIN-911, please review the InTouch Edge HMI Installation Checklist.

InTouch Edge HMI has also used the name InTouch ME and is also known as AVEVA Edge, but they are the same product and the names are interchangeable. For the purpose of this article, the names are referring to the same data source (SCADA). 


The following items will be discussed in this article:  

  • Where to Install WIN-911
  • Accessing WIN-911
  • InTouch Edge HMI Connection to WIN-911
  • Notifiers
  • Configuring Tactics & Strategies
  • Health Alarms
  • Heartbeats (Optional)
  • Bringing Alarms into WIN-911
  • Testing and Troubleshooting


A. Where to Install WIN-911  


WIN-911 must be installed on a computer with network access to an InTouch Edge HMI Project Runtime.

 

The TCP/IP Server Runtime must be running on the HMI in order for WIN-911 to connect. WIN-911 recommends that the start-up mode for this program be Automatic.

 

The status of this program can be verified, and its start-up mode changed, from the Tasks menu. Look for TCP/IP Server Runtime.

 

The default communications port is 1234.  This can be configured in the Studio Manager.

  • In the Studio Manager,
  • Go to Project Explorer, then
  • Go to your Project Name, then
  • Go to Project Settings, then
  • Communication, then
  • TCP Port.

If you alter the default port, be sure to adjust the port setting on WIN-911 to match.

  • In WIN-911, choose the Alarming menu, then
  • InTouch Edge HMI, then
  • Projects


Depending on your network architecture and redundancy requirements, you have a few installation options. Each of these architectures requires the use of different combinations of WIN-911 licenses and add-ons. Review the InTouch Edge HMI Network Diagrams for examples of these options. 


You can read additional information about nodes and licensing in the Nodes and Licensing Document.  


B. Accessing WIN-911


There are two ways to open WIN-911 Workspace for editing: 

  1. Clicking the shortcut that was created in the WIN-911 host's start menu,
  2. 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.


C. InTouch Edge HMI Connection to WIN-911 


The InTouch Edge HMI Project Details workspace defines the parameters WIN-911 requires to establish a connection to the InTouch Edge HMI Project that you wish to monitor for alarm events. It specifies the location and any credentials required by the Project to successfully pass data to and from the SCADA during runtime operations. This section will walk through the connection settings.


Note that only the data sources you selected during the installation will appear.



Open the WIN-911 configuration and navigate to Alarming > InTouch  Edge HMI > Projects: Project Details



C.1 Name

Enter a unique, user-friendly name to identify the particular InTouch Edge HMI Project you wish to connect with. This name does not have to be the actual Project name as determined by InTouch Edge HMI, but it is recommended, especially if you are connecting to multiple projects.  

 

    C.2 Server

Enter the syntactically correct server name that this project resides on. You can use localhost if the project is located on the WIN-911 host. There is a browse button provided for your convenience.  

 

    C.3 Port

Enter the TCP port as specified by the InTouch Edge HMI project settings. 


You can enter the port number directly into the text-box or use the stepper (up/down arrows) located to the right. The default port is 1234 but can be modified by the user in the communications tab of the project settings. 


To view the project settings, open the  InTouch Edge HMI > Project Explorer > right-click on the Project > Project Settings > Communication. The TCP port is located on the upper-left. The port can be set to any valid TCP port (0 <-> 65535).


    C.4 Username

WIN-911 must log into InTouch Edge HMI 's security system using a valid  InTouch Edge HMI user. 'Guest' is the default entry. 

 

    C.5 Password

InTouch Edge HMI security can be optionally enhanced with the inclusion of a user-defined password. If InTouch Edge HMI is configured with a password you must enter it here before WIN-911 will be recognized as a valid user.   

    C.6 Test Connection

Use the Test Connection button to verify the server and port settings. The InTouch Edge HMI Runtime must be running for the test to be valid. If it initially fails, verify that the InTouch Edge HMI Project is running, then check the server and port settings against those in the InTouch Edge HMI  Studio Project Settings > Communication tab. 



D. 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. For more information on this process, you can review the How-To notifier videos.  

 

E. Configuring Notification (Tactics & Strategies) 

 

Review the instructional video on how to work with Tactics & Strategies

 

In WIN-911 a Basic Tactic represents a simple callout list of users to be notified in the event of an alarm. Advanced Tactics provide conditional logic, dynamic Role-based notification, and actions beyond alarm notification. Basic Tactics are available with any WIN-911 license, while the Advanced Tactics are available only on the advanced license.


This example will configure a Basic Tactic. Start by open the Basic Tactics as shown here. 


 


  • 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. 




A strategy is the list of policies put in place when the alarm occurs that will specify the escalation logic to follow throughout the alarm lifetime. This includes the starting, stopping and renotify actions. Basic Strategies (shown here) are available on any license, and the Advanced Strategies require the Advanced license. 


  • Start Tactic – Which callout list will be started
  • Stop Condition – When to stop the callout list. 
  • Renotify on Any State Change – This option allows all previously notified Connections to receive an update with the latest state information. This option is required for Mobile notification.

 


F. Health Alarms  


Data source connectivity is critically important to WIN-911's ability to dispatch alarms events and provide production data. If a situation occurs where WIN-911 loses connection to the data source it is important to notify the end use of this event. This is a special alarm is called a health alarm and is configured from WIN-911's interface with InTouch Edge HMI and alerts the user when the connection to the SCADA is broken. 

 

Open the WIN-911 configuration and navigate to Alarming > InTouch  Edge HMI > Projects: Health. As shown below. 




On this page select a strategy to initiate in the event a health alarm occurs. 

G. Watchdogs (Optional)


Device connectivity is critically important to WIN-911's ability to dispatch alarms events and provide production data. Situations can occur where WIN-911 or InTouch Edge HMI loses its connection to a device (for any number of reasons), leaving it in an impaired state. To guard against such things, you are provided with Watchdog Alarms.

 

Watchdog Alarms are special monitoring tools provided by WIN-911 to help ensure the operation and availability of devices in your production environment. The Watchdog will monitor a changing value from specific InTouch Edge HMI tags and activate when a set period of time elapses without the tag value updating. The recipient of the Watchdog alarm can assume that the associated device is offline.

 

WIN-911 actively polls a tag's value within the platform's database. It expects a valid response which compares it to a previous value, as defined by the Watchdog timeout.

 

Configure a Watchdog:

  1. Create a tag within InTouch Edge HMI that is set to increment at a set rate, say, 30 seconds.
  2. Create a Watchdog in WIN-911 > Alarming > InTouch Edge HMI > Projects > Watchdogs and give it a unique name that will be recognized by the recipient.
  3. Enter the syntactically correct tag name in the respective field.
  4. Set a timeout, in seconds, which is greater than the increment rate specified in step 1, say, 45 seconds.
  5. Select the strategy you want to handle notifications when the Watchdog activates.
  6. Enter a severity that properly conveys the significance of the Watchdog.

 

Watchdog alarms are not part of the InTouch Edge HMI alarm system, but rather separate from and in addition to the alarms managed by the SCADA. WIN-911 polls these tags evaluate alarm conditions and handle all related processing. With InTouch Edge HMI native alarm types, WIN-911 is a passive recipient of alarm information.  


NOTE: A Watchdog alarm can also be used in conjunction with your Health alarm to monitor WIN-911's connection to InTouch Edge HMI. Although the Health alarm will cover the vast majority of connection issues, it is recommended as a matter of best-practices, to enhance connection monitoring with independent Watchdogs.



Navigate to Alarming > InTouch  Edge HMI > Projects: Watchdogs, as shown below.

Name

The name is a user-defined property that identifies the alarm to the recipient. There is no syntax requirement imposed on this text-entry field except that it must be unique to the project.  

 

Description

The description field provides the recipient useful context for this unique alarm condition. The default string appears pre-loaded and can be edited as needed by the WIN-911 administrator.  

 

TagName

InTouch Edge HMI tag that WIN-911 will monitor for a changing value (or changing alarm state). This field must match the name of the tag as it is configured in InTouch Edge HMI.

 

Timeout

The elapsed time (seconds) when WIN-911 will periodically check the tag for a changed value. The value range must be greater than the expected change rate of the tag's value. It is recommended that the tag's data type be a value other than boolean. A good candidate would be a ramping integer.  

 

Strategy

Select the Strategy that will dispatch this alarm.  


Severity

The severity is a user-configurable property that alerts the recipient of the importance of the alarm event. Use the slider or the number stepper to set the alarm's severity ranking between 0 and 1000, with 1000 being the most extreme. Due to the critical nature of this alarm, WIN-911 recommends a high severity ranking.

 

Labels


Labels may be attached to any alarm condition.


H. Bring Alarms Into WIN-911


The InTouch Edge HMI data source supports two different methods to bring alarms into WIN-911. However, you only need to use one of these methods. 

  • Subscription Filters
    • Allows filtering on worksheet numbers, messages, tag names, priority and selections.
    • Filters are less taxing on the processor
    • Dynamically brings alarms over
      • Add a new alarm that fits an existing filter, and that alarm is already filtered into WIN-911 
  • Alarm Import
    • Group alarms and point to a specific strategy

It is recommended you use filters to bring your InTouch alarms into WIN-911, as it is a dynamic process and does not require as much memory.

 

For more information watch the InTouch Edge HMI Filter and Imports video.


I. Testing and Troubleshooting  


By now all the following steps have been completed:

 

  • Where to Install WIN-911
  • Accessing WIN-911
  • InTouch Edge HMI Connection to WIN-911
  • Notifiers
  • Configuring Tactics & Strategies
  • Health Alarms
  • Heartbeats (Optional)
  • Bringing Alarms into WIN-911
  • Testing and Troubleshooting


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. 


1. Open windows explorer and find the Log Viewer tool.


2. Verify the alarm was sent to the appropriate strategy:



3. Double click the alarm for more information about the dispatch process:




Technical Support


To create a support case, you will need either your Maintenance Support number or your CD Tracking number. You can create a Case online or contact the product support line: (512)326-1011.