1.InTouch Quick Start Guide

 

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. 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 Installation Checklist.



A. Where to Install WIN-911

  

When integrating WIN-911 into an existing InTouch system, there are four recommended architectures to use:

  • One InTouch Application with one WIN-911 system
  • Redundant InTouch Applications with WIN-911 and a Hot Backup system
  • One InTouch RD Server with one WIN-911 system
  • Two Standalone InTouch Applications with one WIN-911 system


Each of these architectures requires the use of different combinations of WIN-911 licenses and add-ons.  Review the InTouch Network Diagrams for examples of these options. 

In all cases, a copy of InTouch will need to be installed on the WIN-911 computer (though an InTouch license is not required). InTouch must be installed as it places dependencies on the PC in order for WIN-911 to connect through Wonderware's Distributed Alarm System (Alarm Manager and SuiteLink). Be sure to install the same version of InTouch as the InTouch server you will be connecting to. A mismatch in versions may cause connectivity issues.

 

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


B. Running WIN-911 on a Remote System or Terminal Services Server


If you are using InTouch across your network or onTerminal Services server, it is recommended that you review the Remote InTouch Configuration article.


C. 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 following URL: http://'WIN911 computer name'/WIN911.


D. InTouch Connection to WIN-911


Open the WIN-911 configurator and select Alarming > InTouch > Applications


NOTE: Only the data sources you installed will appear 



Select the Application tab.



Application: Enter the name of your InTouch Application 


Node Name: WIN-911 will connect to the single running Application on this specified Node. If your application is running on the local machine, use localhost. Otherwise, enter its hostname or IP address. The IP address should be static; if using a dynamic address, the user will have to update the address each time the IP changes. 


Click the ellipse button to browse to your Node 

SuiteLink Node Name: In the event that your InTouch Application network is configured such that the SuiteLink node is separate from the WindowViewer node, you will have to provide WIN-911 with the location of the SuiteLink node. Enter the node in the provided text box after selecting the Specify SuitLink Node Name checkbox. 


There are two formats to choose from:

  • RDShostname 
  • RDShostname: clientIPaddress. 


E. Watchdogs (Optional)   


WIN-911’s InTouch Source supports Watchdog alarms which is an optional part of the configuration. Watchdogs monitor a changing alarm state (or changing tag value) within your Application. 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. Configuring strategies are discussed later in this document. 




  • Name: the friendly name for this Watchdog configuration. Provide a user-friendly name here, as this is the name that will be most prominently displayed in alarm notifications. 
  • Description: a description of this configuration. 
  • Tagname: InTouch Tag that WIN-911 will monitor for a changing alarm state (or changing tag value). This field must match the name of the tag as it is configured in InTouch. 
  • Timeout: the elapsed time (seconds) when WIN-911 will periodically check the tag for activity. 
  • Strategy: the strategy to execute for the Watchdog alarm. 

F. Heartbeats (Optional)   


WIN-911 can indicate its operational status by writing a periodically changing value to a tag in your InTouch Tagname Dictionary. We call this function a Heartbeat because it provides a vital-sign to your Application, 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 tag 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 demonstrate how to configure a heartbeat connection from WIN-911 using InTouch. 


NOTEThe above link will start halfway through at the InTouch configuration.


 




F.1 To set up a heartbeat:

    1. Create a tag in your InTouch - Windowmaker > Tools > Tagname Dictionary that is a type of Integer which allows input (i.e. Memory Integer).

    2. Create InTouch QuickScript that monitors the Tag value and triggers recovery procedures/methods when the heartbeat fails.

    3. WIN-911 Workspace > Alarming > InTouch > Applications > Heartbeat > Enable Heartbeat.

    4. Enter the tag name of the InTouch Tag 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 InTouch Application and WIN-911. WIN-911's InTouch Data Source leverages two Wonderware Toolkits. The SuiteLink toolkit provides InTouch with data from WIN-911, like alarm acknowledgment requests and heartbeat data. The Alarm Toolkit provides InTouch alarm information to WIN-911. If the Alarm Toolkit stops responding while SuiteLink remains, your InTouch Application will still be receiving a healthy heartbeat from WIN-911 even while WIN-911 is not receiving alarm events.

 

F.2 To setup heartbeat suspension:

    1. Create a separate tag in your InTouch - Windowmaker > Tools > Tagname Dictionary that allows input. You can use a Memory Discrete, for example.

    2. Set that tag with an alarm condition that cycles in and out of alarm on a periodic basis. In our Memory 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 tag you created in step 1. You can use InTouch QuickScript or another source of data like OPC. In this example, the 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 > InTouch > Applications > Heartbeat >Enable Heartbeat Suspension.

    6. Enter the tag name 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. As long as 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.


G. 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, review the How-To notifier videos.  

 

H. Configuring Notification (Tactics & Strategies) 


If you are not familiar with configuring Tactics and Strategies, refer to the instructional video.

 

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

 

I. Bring Alarms Into WIN-911


The InTouch 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 Tagnames, Groups or Priority 
    • 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 Filter and Imports video.


J. Troubleshooting

By now all the following steps have been completed:

 

The connection between WIN-911 and InTouch 

  • Optional: Watchdogs and Heartbeats
  • Notifier Gateways
  • Notifier Connections (people)
  • Tactics and Strategies
  • Alarms have been 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. 


        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:




Once you review each tab and verify that the alarm behaved according to your Tactic and Strategy, you have finalized the steps to test and troubleshoot your alarms.


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.