AVEVA Manuals
AVEVA Manuals
AVEVA Manuals
InTouch HMI
formerly Wonderware
© 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, SimCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA t rademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: Wednesday, November 4, 2020
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to cont act sales and customer training, see https://sw.aveva.com/contact.
For information on how to cont act technical support, see https://sw.aveva.com/support.
2
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Contents
Chapter 1 About InTouch HMI ........................................................................................... 13
Types of InTouch Applications ................................................................................................. 13
Standalone Applications .................................................................................................... 13
Managed InTouc h Applications .......................................................................................... 13
Published Applications....................................................................................................... 14
InTouchView Applications .................................................................................................. 15
Building Applications ............................................................................................................... 16
Running Applications............................................................................................................... 16
3
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Chapter 6 Deploying and Working with Terminal Services and Remote Desktop
Services................................................................................................................................... 93
Deploying and Working with Terminal Services and Remote Desktop Services Terminal Servic es
Overview ............................................................................................................................... 93
Planning Considerations for Terminal Server Applications .................................................... 93
Deploying InTouch Applications in a Terminal Services Environment .............................. 94
Alarms in a Terminal Services Environment .................................................................. 94
Security in a Terminal Services Environment ................................................................. 94
I/O in a Terminal Services Environment ........................................................................ 95
Script Execution in a Terminal Services Environment ..................................................... 95
Logging on to a Terminal Session Properly to Run InTouch ............................................ 95
Alarm Query Syntax in a Terminal Service Environment ................................................. 95
Miscellaneous Limitations in a Terminal Services Environment ....................................... 95
Retrieving Information A bout the InTouch Client Session Using Scripts ................................. 96
TseGetClient Id() Function ............................................................................................ 96
TseGetClientNodeName() Function .............................................................................. 97
TseQueryRunningOnConsole() Function ....................................................................... 97
TseQueryRunningOnClient () Function .......................................................................... 97
Remote Desktop Servic es Overview ........................................................................................ 97
Remote Desktop Servic es Role Servic es ............................................................................ 98
Securing your Remote Desktop Servic es (RDS) Connections .............................................. 99
Windows Server 2016 Remote Desktop Services Best Practices ........................................ 100
5
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
6
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
7
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
8
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
9
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
10
Contents AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
11
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 1
About InTouch HMI
A Human Machine Interface (HMI) software application shows a graphic al representation of a
manufacturing environment. The tools, materials, and processes used to create a product appear as
visual elements in an HMI application’s windows. Plant operators interact with an application’s graphical
interface to monitor and administer manufacturing processes.
You use Application Manager to create and manage InTouch applications. The application development
environment, called WindowMaker, includes a set of graphic and other development tools to build your
applications. You run your applications using WindowViewer.
Standalone Applications
A standalone application is created and managed by Application Manager. A standalone application
consists of a set of files maintained by the InTouch HMI in the directory file system. It is built entirely with
WindowMaker and run with WindowViewer and can also cont ain Industrial Graphics. A standalone
application can be deployed across multiple network nodes and is not restricted to a single node. It can
be imported to the ArchestrA IDE and convert ed to a managed application.
13
About InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Managed InTouc h applic ations appear in the InTouch Application Manager as Managed and can be
edited only by starting WindowMak er from within the IDE. You can only start a managed application in
WindowViewer, from the Application Manager. When WindowViewer starts, it copies a managed
application’s files to a folder during run time.
Each managed application is associated with an ArchestrA InTouchViewApp object, which is derived
from a base template. The InTouchViewApp o bject only contains a reference to the managed InTouch
application folder and other behavior-specific information of the managed InTouch application.
Application files are stored in separate folders in the ArchestrA file repository. One folder cont ains the
most recent checked-in version of the InTouch application and the ot her contains the most recent
checked-out version. The ArchestrA IDE includes the Industrial Graphic Editor, which you can use to
create symbols that represent production processes in your InTouch HMI application. You can fast
switch from WindowMaker and WindowViewer to test a managed application only if the WindowMaker
was opened from the IDE.
Published Applications
You can publish a managed application from the derived In TouchViewA pp template. When you publish a
managed application, a user-defined folder is created containing InTouch application files and any
Industrial graphics embedded in the application. You use Application Manager’s Find utility to locate the
folder. Thereafter, the converted application appears in Application Manager as a published application.
Published
Application
Derived
$InTouchViewApp Find
Derived Template
Export
14
About InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
You can use WindowMaker to migrate a published application from a version of InTouch prior to version
11.1 (2014 R2 Patch 01) to version 11. 1 Patch 01. You can then modify the published application by
updating the application source files and re-publishing. A fter you publish a managed application, you can
still use embedded Industrial graphics to write data to a Galaxy or visualize data. A published application
cannot be imported again into a Galaxy. After migrating a published Managed application, you need to
republish the application. The ArchestrA Embedded Alarm Cont rol will be upgraded to the new version
upon republishing.
InTouchView Applications
InTouchView applications show vis ual interfaces for use in an Application Server environment.
InTouchView applications run in WindowViewer, with Application Server providing most of the HMI
functionality. An application can also be configured to serve as InTouch Tag Server application,
providing other nodes with secure tag information. InTouchView applications are useful in scenarios
where a client node only needs to access dat a and does not need t he full functionality of a development
node.
InTouchView applications offer only some of t he standard functions available from full -featured InTouch
applications. InTouchView applications:
Cannot connect to I/O sourc es other than the ArchestrA Application Server Galaxy or InTouch Tag
Server.
Cannot generate alarms. However, you can display and acknowledge alarms from remote alarm
providers, such as ArchestrA objects and InTouch alarms.
Do not log application data or events. An InTouchView application generates only SYS and
USER-related events.
When the application consumes data from a Galaxy, it can be secured only with ArchestrA security.
Cannot reference tags within embedded Industrial Graphics.
You develop InTouch applications with WindowMaker, and run them in WindowViewer. You can then
change an InTouch application to an InTouchView application that will allow y ou to manage your InTouch
applications through the Application Server. Likewise, you can change an InTouchView applicatio n to an
InTouch application.
The following lists show which WindowMaker commands and Tagname Dictionary options are
unavailable when creating InTouchView applications.
Unavailable Special menu commands:
o Access Names
o Alarm Groups
o Configure...Alarms
o Configure...Historical Logging
o Configure...Distributed Name Manager
Unavailable Tagname Dictionary options:
o Alarms
o Details & Alarms
o Log Data
o Log E vents
o Priority
15
About InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Building Applications
WindowMaker provides graphic tools, a scripting language, and tag management utilities to define the
behavior of objects that appear in your application’s windows. Using WindowMaker, you can create tags
that represent data points associated with window objects. Data from a manufacturing process is
ultimately associated as a tag value. This tag data can be used in your application for alarm monitoring,
creating trends, and det ermining how the application behaves during run time.
The following figure shows some of WindowMaker’s tools to create InTouch HMI applications.
You can use a wide variety of graphic tools that range from simple shapes that can be combined to
create more complex objects to standard Industrial Graphics with predefined properties. You can create
different types of scripts based upon their triggering mechanism. You can also i nsert predefined InTouch
functions into your scripts. You can define a variety of tag value thresholds with the Tagname Dictionary
that determines when a tag is in a normal or an alarmed state.
Running Applications
You use WindowViewer to run all types of InTouch applications. After you deploy a managed application
from the ArchestrA IDE, you open it in WindowViewer from Application Manager. You can use a wide
variety of run-time triggers to start scripts while an application is running. You can configure
WindowViewer to store application dat a and alarms in files or SQL Server databases. You can enforc e
security by requiring operators to log on to WindowViewer and preventing operators from making any
changes to the computer running WindowViewer. Operators can start and stop an application’s historical
logging by selecting WindowViewer menu commands. You can configure the computer that runs
WindowViewer to act as a client or a server based upon how tag data is stored and distributed.
16
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 2
Licensing in InTouch HMI
About InTouch HMI Licensing
InTouch HMI us es the AVEVA Enterprise License Server to make licenses available to InTouch. The
AVEVA Enterprise License Manager manages one or more License Servers.
To make licenses available to InTouch HMI, complet e the following steps:
1. Import the entitlement XML file rec eived upon purchase of the license.
2. Using the License Manager interfac e, select the licenses on the entitlement that you want to activate
on the License Server.
3. Once the licenses are activated, they becomes available to WindowMak er or WindowViewer upon
start up.
The activated licenses appear in the License Manager under the License Grid.
InTouch releases and returns the consumed license to the Lic ense Server when:
The machine running InTouch is shutdown or
The InTouch application is shutdown
Note: In the event of InTouch HMI shutting down abnormally, licenses will not be returned. InTouc h HMI
must be restarted and manually shut down to release licenses.
The License Manager and License Server are installed with InTouc h HMI. InTouch HMI will point to your
local License Server by default. You can change this configuration in the post -install Configurator. Refer
to the AVEVA Enterprise Licensing Guide for the detailed procedure.
17
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: An InTouchView application consumes the same license as the Graphic Run Time Module's
ViewApp application, if configured with a Galaxy data source.
18
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If y ou configure the InTouchView application to connect to data from a Galaxy then the licenses available
are:
Supervisory Client Supervisory Supervisory Client
ReadWrite Client Read-Only Server License
License License
Reserving Licenses
You can reserve licenses to specific devices in the License Manager. Reserving a license to a particular
devic e ensures that the license cannot be acquired by another InTouch application and interrupt or
prevent your application from running.
Reserving Licenses
You can reserve licenses to specific devices in the License Manager. Reserving a license to a particular
devic e ensures that the license cannot be acquired by another InTouch appl ication and interrupt or
prevent your application from running.
User-ba sed License Reservation
In the AVEVA Enterprise License Manager license reservation page, it is possible to mark a license to be
reserved to a specific user. While the reservation page allows this particular configuration, it's important
to know that neit her InTouch OMI nor InTouch HMI ViewApps support user -bas ed license reservations.
The end-result will be the inability for the soft ware to acquire the license reserved. Therefore, only use
devic e-based reservations for Supervisory Client licenses.
Device-based License Re servation
When res erving a Supervis ory Client license for a specific devic e, the Device Name needs to be the
name of the computer running the InTouch HMI/OMI ViewApp. In the case where the ViewA pp is running
inside of an RDS or Terminal Server, the Device Name needs to follow this naming pattern:
<RDS HostName>-< RDP ClientName>-<index>
19
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
where RDS HostName is the name of the RDS or Terminal Server, and RDPClientName is the name of
the PC running the RDP client software, and "index" is 1, unless there will be multiple RDP sessions from
a single client machine, in which case the index should be increment ed (starting at 1) for each
reservation for that specific RDP client, up to the total number of RDP sessions from that specific RDP
client.
Example 1: A computer with a hostname of "ControlRoomA" runs InTouc h OMI
Device Name: "ControlRoomA"
Example 2: A computer with a hostname of "ControlRoomB" running a single Remote Desktop Client
(RDP), connecting to the Remote Desktop Server (aka: Terminal Server) with a hostname of
"PrimaryRDS"
Device Name: "Primary RDS -ControlRoomB -1"
Example 3: Two comput ers with hostnames "SupervisorP C1" and "LineMgrA", respectively, each
running a single Rem ote Desktop Client (RDP ) connecting to the Remote Desktop S erver (aka: Terminal
Server) with a hostname of "PrimaryRDS"
Device Names:
License Reservation 1: "Primary RDS -SupervisorP C1-1"
License Reservation 2: "Primary RDS -LineMgrA-1"
Situation: A computer with a hostname of "ExecutiveDesktop" running four (4) Remote Desktop Clients
(RDPs), connecting to the Remote Desktop Server (aka: Terminal Server) with a hostname of
"PrimaryRDS"
Device Names:
License Reservation 1: "Primary RDS -ExecutiveDesktop-1"
License Reservation 2: "Primary RDS -ExecutiveDesktop-2"
License Reservation 3: "Primary RDS -ExecutiveDesktop-3"
License Reservation 4: "Primary RDS -ExecutiveDesktop-4"
For RDS load balancing support, all RDS licenses can be activated on a single License Server that
multiple RDS client sessions can point to. The licenses on the server must be of the same capability so
that the licenses can be shared amongst each RDS client session. Licenses are considered to be of the
same capability if their internal parameters have the same value. No res ervations are needed in this
scenario. If different license types for different RDS client sessions are required, then a License Server
must be installed on each RDS server.
Refer to the AVEVA Enterprise Licensing Guide for detailed license reservation procedures.
Floating Licenses
Floating licenses are not reserved to any machine. It is recommended to have floating licens es of the
same product name and capabilities on a single License Server. For example, you could have a License
Server with several activated InTouc h 2017 Runtime 60K tags licenses with the same capabilities. This is
a recommended practice to ensure determi nistic license consumption.
However, it is not recommended to have licenses of the same product name but different capabilities
activated on t he same License Server. For example, you could have a mix of InTouch 2017 Runtime 60K
tags activated licens es with InTouc h 2017 Runtime 500 tags activated licens es on the same licens e
server. In this scenario, there is no way to ensure which instance of WindowViewer will consume the
license with the higher tag count.
20
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The company name and license serial number do not appear in this dialog. This information
appears in the AVEVA Enterprise License Manager int erface.
b. From WindowViewer, click File, About WindowViewer. The About WindowViewer dialog box
appears.
Note: The View License option is disabled for InTouch Application Manager. Because Application
Manager does not consume a license, you can only view the EULA. The About Application Manager
dialog box does not display any license -related information.
2. For both WindowMaker and WindowViewer, click View License Agreement to view the E nd User
License Agreement.
21
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. Select View License to view t he details for the license. The License Information dialog box displays.
The parameters displayed in the license information for WindowMak er and WindowViewer are as
follows:
o Acquired License Name: the full name of the license consumed by the product from the
License Server
o Tag Count: the number of tags allowed by the consumed license.
o Window Count: the number of windows allowed by the consumed license.
o ReadOnly: displays the I/O Read/Write permissions allowed by the license. No indicates that
the application can write to I/O tags.
o Runtime Timeout: the application runtime allotted by the license. The InTouch session will end
when the timeout period elapses.
o Language Lock: applies to licenses for InTouc h on Chinese operating systems only. A Chinese
license must be consumed for InTouch to run on a Chinese operating system.
The Language Lock restriction does not apply for a connection license.
o Expiration Date: the date the consumed license expires.
o Borrow Time Status: intended to notify the user when the license is 50% past whatever the
allotted borrow time is. The status will change to Active when the 50% has been reached. If the
license is not renewed when the borro w time has fully elapsed, InTouch will become unlicensed.
22
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Important: The application will continue to run with the capabilities of the last good license. In this
example, the original sixty-thousand tag count will remain when entering the Grace Period.
23
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
In Demo Mode, InTouch will display a message stating that it will run in demo mode. WindowViewer will
only run in Demo Mode for two hours before timing out. WindowMaker will run in Demo Mode indefini tely.
In Demo Mode InTouch will:
Allow 32 Local tags (Excluding system tags)
Allow maximum of 32 windows
When Demo Mode timeout is reached, InTouc h will prompt to exit.
Note: While in Demo Mode, even if you activate a valid license, you need to exit Wi ndowMaker or
WindowViewer and restart InTouch to consume the valid license.
Configuring the ViewLicenseRetry Count key in the InTouch.ini file, will instruct WindowViewer to
continue to attempt acquiring a license in the background for the number of times s pecified in the
parameter. If a license is acquired, the dialog box will close and WindowViewer will be launched.
24
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
When WindowMaker or WindowViewer ent ers the Grac e Period, you will be prompted with the following
dialog:
You have the options to be reminded again, to ret ry to acquire the license, or to exit the application.
Scenario 1: Consumed License is Lost
WindowMaker or WindowViewer will go in to Grace P eriod if it consumes a valid license from the License
Server and the license is deactivat ed while the product is still running.
To exit the Grace Period and resume normal operation, activate a valid license on the License Server.
When the license is consumed, WindowMaker or WindowViewer will exit the Grace Period and normal
operation will res ume.
Scenario 2: License Expired
WindowMaker or WindowViewer will go in to Grace P eriod if it consumes a valid license from the License
Server and the license expires. To exit the Grace Period and resume normal o peration, activate a valid
license on the License Server.
If WindowMaker or WindowViewer fails to acquire the license, the first dialog will appear again.
Scenario 3: License is Downgraded
AVEVA Enterprise License Manager is a server -based licensing system, which means that licenses
need to be renewed periodically. If a WindowMaker or WindowViewer license is downgraded during this
renewal to one of lesser capability, it will enter the Grace Period. See Managing Consumption of a
Different License After Startup on page 22 for a detailed description of downgrade scenarios.
To exit the Grace Period and resume normal operation, retry to acquire the last good license or a better
license.
Important: The functionality enabled by your last good license will persist in Grace Period mode.
25
Licensing in InTouch HMI AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
In all of the above scenarios, if you select the option to retry to acquire the license and an appropriate
license is successfully acquired, you will see the following dialog:
If InTouch fails to acquire the licens e, the first dialog will appear again.
Note: Configuring the ViewLicenseRetry Count key in the InTouch.ini file, will instruct WindowViewer to
continue to attempt acquiring a license in the background for the number of times specified in the
parameter. If a license is acquired, the dialog box will close and Windo wViewer will be launched.
26
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 3
Managing InTouch HMI Applications
About Managing InTouch HMI Applications
When managing InTouch HMI applications, you:
Create or delete InTouc h applications. See Creating an InTouch Application on page 28 and
Deleting an InTouch Application from the Application Manager on page 56.
Open applications in either WindowMaker or WindowViewer. See Opening an A pplication in
WindowMak er and WindowViewer on page 52.
Search for applications. See Finding InTouch Applications on page 56.
Move an application to a different computer. See Publishing Applications to Remote Nodes on page
63.
Distribute applications among multiple comput ers. See About Distributing Applications on page 73.
Manage InTouch services. See About Managing InTouch Services on page 101.
Import or ex port tag definitions, windows, and scripts. See Exporting and Importing InTouch
Components on page 107.
Configure security. See About Securing InTouch on page 167.
You can extend your application by:
Translating text strings and alarm comments into different languages. See About S witching a
Language at Run Time on page 203.
Integrating an application with ArchestrA. See Managed InTouch A pplications on page 13 and About
Viewing Applications at Runtime on page 217.
Displaying applications on multiple monitors. See About Setting Up a Multi-Monitor System on page
243.
Using applications on a Tablet PC. See About Using InTouch on a Tablet PC on page 251.
For the Windows Vista, Windows 7, and Windows Server 2008 operating systems, a standard us er can
use the InTouch Application Manager to find an application and open WindowViewer. Application
properties will be read-only for the standard user. All read/write or configuration operations from
Application Manager require administrative privileges.
27
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
28
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The INTOUCH.ini file is created when you create an application. The INTOUCH.ini file contains the
default configuration settings for your application. As you configure your application, the new settings are
written to the INTOUCH.ini file.
After you create an application, you can copy an existing INTOUCH.ini file to the application folder. This
way, you do not need to configure customized InTouch parameters each time you create a new
application.
To create a new application
1. You can create a new application, using different options on the Application Manager.
a. Click File menu, click New.
29
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The Blank template will not include the default Graphic toolbox symbols and SAL symbols. In all
templates you can use both InTouch Symbols and Industrial graphics in your application. If you have
created any application templates and they are available in the correct folder, those templates will
also be displayed.
30
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Click Finish.
A horizontal bar displays the progress of creating the application. After the application is created, it
appears in the Application Manager’s list of applications.
31
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the Special menu, click Application Type.The Application Type dialog box appears.
32
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: If the AVEVA Edge related options are not enabled, launch WindowMaker.
5. Click .
A success message is displayed after the application is uploaded to AVEVA Connect.
The uploaded application is displayed in the application list, prefixed with Cloud | <Application
Name>.
33
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Once the application is uploaded to the Shared Drive it is accessible to all users. Users can then
download and delete the application from the cloud store.
1. Click .
The User Information dialog box appears.
2. Enter the username and password.
3. The password must comply with the following rules:
At least 6 characters long
1 lower case character
1 upper case character
1 number
1 special character
4. Select the access type.
5. Click Save.
8. After you have configured all the us ers, click to export the configured list.
34
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
9. In AVEVA Edge Management, upload the list, during the ‘Add a device’ procedure under the User
Configuration option.
After the edge device is configured and paired, the list of users will be created on the edge device.
These users will be able to access the web client and view the application graphics.
Importing an existing user list
If you have a list of existing users to be included, prepare a .csv file in the required format.
Note: When enabled, all connecting clients must be using the same System Management Server as
the InTouch from which this OPC UA Server instance has been deployed. Also, InTouch HMI must
be run in the context of a user with Administrative privileges, which gives InTouch HMI access to the
encryption certificates that enable secure communications.
2. Configure the OPC UA server: S et the configuration options and deploy the OPC UA server to a
run-time node.
3. IT compliance/firewall validation: Firewall configuration and verification must be completed at this
point of the configuration. The node to whic h the OPC UA Server has been deployed must have
Inbound Rules for the firewall configured and verified.
IMPORTANT! A firewall test must be succe ssfully performed before proceeding with the
remaining configuration ta sks.
4. Configure the OPC UA Client: Client configuration may include the following:
Define the OPC UA server address (in the format
opc.tcp://<ServerName>:<PortNumber>).
Select the correct OPC UA server security policy (Basic256Sha256).
Add the users to the InTouchHMIOP CUAWriteUsers user group.
35
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. Click .
The OP C UA Server dialog box appears.
3. The OP C UA server will be disabled by default. To configure the server, click Enable OPCUA.
4. Edit the Port Number. By default the port will be set to 48032.
36
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: The port number is unique for a user and RDS session. Assign alternate port numbers for
additional RDS sessions.
5. Security Configuration: It is strongly recommended that you enable this option, as this will encrypt
the payloads across the connection. Note that the client must match this configuration.
The Client Access Rules options allow you to determine the type of access the client will have to
InTouch data.
a. Select the Allow anonymous client connection (no username/password) checkbox to allow
anonymous access.
b. Select the Allow authenticated InTouch Users to write to attributes, depending on their
security role checkbox to allow only authenticated us ers.
6. Click OK.
7. After configuration, start the WindowViewer to launc h the OPC UA Server. OPC UA clients can now
access InTouch HMI data.
37
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
5. On the next screen, select the option "Allow the connection." Click Next.
38
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
For Workgroup environments: Select Public. The Domain and P rivate settings have no affect in
a Workgroup environment.
7. Finally, provide a name for this rule (for ex ample, "OP C UA Server"). If you will be configuring
multiple OP C UA services, be sure to use names that differentiat e each service from the others.
8. Now, check that the new rule has been added to the list of InB ound Rules in the Windows Firewall
and that it is enabled.
9. Verify that you can connect to the run-time node from the OPC UA client node by repeating the
Firewall Test.
Firewall Test
To perform a firewall test with Telnet
1. From a separate node from where the OP C UA Server service is running, enable Telnet by turning
on the Telnet Client Windows Feature.
39
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: This test is ideally run from the OPC UA client node.
2. Prior to running this test, verify that WindowViewer is running. If the OPC UA Service Host is
configured, WindowViewer will start the InTouch OP C UA Service. See Configuring the InTouch
OPC UA Server on page 36 for det ails.
3. Run Telnet in a command window on the OPC UA client node by entering the following:
telnet <nodeName or ipAddress> <portNumber>
where
o nodeName is the machine name of the InTouch HMI run -time node. Use nodeName or
ipAddress, not both.
o ipAddre ss is the IP address of the InTouch HMI run -time node. Use nodeName or ipA ddress,
not both.
o portNumber is the port number you configured in InTouch HMI for the OPC UA Service. The
default port number 48032.
Example: telnet 10.10.10.06 48031
If the command is not successful, it will time out with a message stating that the connection
failed. In this case, go to Configure the Run-Time Node Firewall on page 37.
40
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If the telnet command is successful, the command prompt changes to a Telnet prompt.
If the Firewall Test is successful, configure the OPC UA client and OPC UA server certificates.
The next step in setting up your OP C UA connection depends on if you are using a third-party
OPC UA client application, or the OP C UA connection available with OI Gateway.
41
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
To open the Certificate Manager, either type “Manage Computer Certificates” in the Windows
search box and select, or open the command prompt and run " certlm.msc."
2. In the tree view, expand the Personal node, then click on Certificates.
42
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
5. Depending on type of certificat es that your client application uses, you will need to export the
certificate as one of two certificate file types:
.cer file, if the client uses the Windows Certificat e Store
.der file, if the client uses file-based certificates.
E ven though the file extensions are different, the file formats are the same.
6. In the Certificate Export Wizard, select the following options.
Export Private Key: select “No, do not export the private key” (default), then click Next.
Export File Format: select either “DER encoded binary X. 509 (.CE R)” or “B ase-64 encoded
X.509 (.CE R),” depending on the requirements of your client application. Make the selection,
then click Next.
File to Export: enter a file name to export the Root CA, for example “c:\temp\<machine
name> OPC UA Server.cer,” then click Next.
43
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
7. When the Export Wizard finishes, you may need to change the file extension of the certificate from
“.cer” to “.der,” depending on what your client application is expecting. You will need to do this if your
OPC UA Client application stores certificates in a specific folder, rather than in the Windows
Certificate Store.
44
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. Right click on the certificate file and select Install Certificate” from the context menu.
45
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: Access to this folder requires administrator rights, and the folder is hidden by default.
Port Usage
OPC UA communicates via a single TCP port. This is specified in the Endpoint Connection setting in
the configuration of the OPC UA Server, and defaults to port 48032. For details, see Configuring the
InTouch OP C UA Server on page 36.
If you will run multiple OP C UA Servers on the same computer using RDS sessions, you must specify a
different port number for each subsequent server.
46
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Confirm that this port is not blocked by any firewall software installed on your computer. For information
about testing and configuring communications through firewall, see Configuring the Firewall for the OPC
UA Service on page 37.
2. In the console tree, navigate to the OI.GATEWAY.3 node under Operations Integration Supervisory
Servers (1).
3. Create an OPC UA connection.
4. Configure OPC UA Server Det ails (2).
47
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
IMPORTANT! The reason for thi s initial test failure is because the certificates between the
client and server applications must be trusted. Installing the certificates will fix this.
Trusting the Certificate between the OPC UA Server and OPC UA Client
In this release of the OP C UA Server service, the operation of creating the trust between the OPC UA
Server and the OPC UA client must be done manually. The Te st operation causes the OI Gateway to
submit its own certificate to the OPC UA Server node so it can be trusted. The following steps show how
to then trust the client certificate from the OPC UA Server node. If you are not using OI Gateway, follow
the procedures listed in Configuring Server and Client Certificates for Third -Party OP C UA Client
Applications on page 41.
1. Access the folder C:\ProgramData\AV EVA\PCS\OP C UA Rejected Client Certificates.
This is the location where the certificat e from the client is initially placed by default as an attempt to
connect to the OPC UA Server.
Note: The P rogramData folder is hidden by default. You may need to enable the hidden items option
in Windows Explorer in order to view it.
2. Right -click on the certificate name, for example, OI Gateway OPC UA@OP CUA client node{long
hex ID}.der.
3. Select Install Certificate from the context menu. This opens the Certificate Import Wizard.
4. Select Local Machine for the Store Location, then click Next.
5. From the Select Certificate Store list, select Trusted People as the certificate store. This is the
only choice that will work with the OPC UA certificate.
6. Close the wizard to complete installation.
7. Finally, delete the certificate from the OP C UA Rejected Client Certificates folder, since the
certificate is now installed.
48
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. From the OP C UA client node, open the System Platform Management Console again, and click
the Test button in OPC UA parameters window. At the bottom of the window, the OPC UA
Namespace alias list will be automatically populat ed, indicating the connection was successful.
49
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Add a group under the OPC UA Connection (named Group01 in the following figure). The device
group name prefixes OPCUA_ to the group name you enter.
5. Click the Brow se OPC UA Server button to browse the OPC UA hierarchy.
6. Optional: Add OPC UA tags to monitor in the alias list to help ens ure that you can browse the
namespace.
50
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
7. Switch back to OI Gateway configuration in the System Platform Management Console , and
notice that the OPC UA tags are now listed in the Device Items window.
8. By default, item names in the list duplicate the complete item reference path. Rename the items as
needed to be more user-friendly.
Additionally, you can enable and disable the web client using the and icons.
51
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
52
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
1. To customize the order of the options, click the icon and select Customize…
2. Under the Items tab, select an option (for example WindowMaker), and click the Move Up or Move
Down buttons to change the order the options appear on the toolbar.
To remove option from the Toolbar
Click on the checkbox against the option.
For example, clear the checkbox against the option WindowMak er and click Close. The Window Maker
option will not appear on the toolbar.
53
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o Change Thumbnail: Click the icon, and select the image from the Brows e dialog box. The
image will be displayed in the Icon and List view.
o WindowMaker: Click to launch WindowMaker.
o WindowViewer: Click to launch WindowViewer.
o Delete: Click to delete the application.
o Open application folder: Click to navigate to the applicatio n folder.
o Application propertie s: Click to launch the application properties.
The application is unlocked and available for use. For more information, see Application Editing Lock s on
page 88.
54
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
55
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
56
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
To find applications
1. On the Tool s menu, click Find Applications. The Brow se For Folder dialog box appears.
57
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Upon click of OK, each window is automatically placed in the Template Windows folder in the
Windows & Scripts pane.
You must now create and assign a thumbnail to the application you want to make into a template.
To create and assign an application thumbnail:
1. Using any screen capture program, take a screen capture of your application at either configuration
or run time.
a. Save the image to any picture file format, such as a .bmp or .png file, and copy it to your
application folder.
2. From your application folder, open the INTOUCH.INI file with a standard text editor such as Notepad.
3. Edit the INTOUCH.INI file to include the file name of the image in the ApplicationThumbnail field.
Note: The ApplicationThumbnail field is case sensitive and must exactly match the name and
extension of the thumbnail image.
Note: The application template thumbnail you created in the previous procedure is extracted from the
exported .aaPKG file. If your application template appears in the Application Template Browser with a
blank thumbnail, a valid image could not be extracted. Be sure a valid image file format was used to save
the thumbnail and the ex act filename is entered int o the ITOUCH.INI.
58
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. After the export is complete, click Close. Click View Details, to check for any errors.
4. The .aapkg file will be available in the location specified, and can no w be used as an application
template to create new applications.
Converting Windows
Only the symbols and scripts of a window are convert ed. The window’s color, type, frame, title bar, size
control, and Close button are excluded from the converted symbol.
Based on the InTouc h graphic type, window graphics are converted as follows:
All InTouch graphic primitives are converted to corres ponding Industrial Graphic primitives.
An InTouch Smart Symbol is converted to an Industrial embedded graphic.
An Industrial Graphic within a window is converted to an embedded symbol. No new symbol is
created for an embedded symbol.
An InTouch symbol is converted to a group with the property TreatAsIcon=True.
An InTouch cell is converted to a group with the property TreatAsIcon=False.
59
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
60
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The following procedure explains how to use the Language Assistant tool to migrate InTouch window
localization strings to an Industrial graphic.
a. Convert an InTouch window to an Industrial Graphic.
b. Import the contents of an InTouch language XML file to Language Assistant to create a global
dictionary of phrases.
c. Export an Industrial Graphic to an XML file.
d. Import the symbol XML file to Language Assistant, which will automatically apply a global
dictionary translation to the Industrial Graphic phrases.
e. Publish the Industrial Graphic XML file from Language Assistant .
f. Import the XML file to the Industrial Graphic Toolbox containing the translated text strings.
Migrating InTouch Scripts to Industrial Graphics
Scripts containing InTouch or QuickScript functions cannot be converted to an Industrial Graphic.
Migrating InTouch History Objects to Industrial Graphics
InTouch windows containing an InTouch Historical Trend are not completely converted to Industrial
Graphics. Only some parts of the Historical Trend may appear in the converted symbol. Trend
components like scooter bars may not appear in the converted Industrial Graphic.
61
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
a. Select the window to be converted from the Windows & Scripts pane.
b. Right -click to show the shortcut menu and select Convert To Industrial Graphic....
c. Continue at Step 3.
File Menu Method
d. Click File from the menu bar and select Convert To Industrial Graphic....
3. The Windows to Convert dialog box appears, select the windows that you want to convert.
By default, the window selected in the previous screen will be checked. You can now select
additional windows.
4. Click OK.
A message appears and indicates the windows are being converted in succession. After the
windows are converted, a succession of Check In dialog boxes appear to enter an optional
comment for each window that was converted.
5. Observe the WindowMaker Industrial Graphic Toolbox and the ArchestrA IDE Graphic Toolbox.
The converted windows should appear as Industrial Graphics in both tool boxes.
62
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Both the conversion progress dialog box and the conversion report include the following information
about a window conversion:
Window name
Conversion status that indicates if the window was converted successfully or if errors occurred.
Warning messages that occurred during the conversion.
Error messages that occurred during the window conversion.
63
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
You can post published applications to a web server where they can be downloaded and installed. The
following package information is shown for posted applications:
Package description
Publisher name
Published file name (executable)
Application resolution
For example:
64
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Any files with names of the form Compiled window files with the
SSD_*.xml. file name extension .wvw.
For a run-time only application, all files with a file names of SSD_*.xml are excluded.
65
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. Click Next. The InTouch Application Publi sher – Step 2 of 4 dialog box appears.
66
Managing InTouch HMI ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
6. Click Next. The InTouch Application Publi sher – Step 4 of 4 dialog box appears.
67
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 4
Migrating and Upgrading Applications
Moving from a Legacy Application to the New Standalone
Application
Prior to System Platform 2020, InTouc h HMI users could create the following types of applications:
Standalone
Modern
Managed
Published
Standalone applications were built using legacy symbols and controls. Modern applications supported
the use of Industrial Graphics (formerly known as ArchestrA graphics/symbols) in addition to legacy
symbols. Managed applications were built using the IDE and Galaxy Objects. Standalone applications
could be published into a package and then distributed to other nodes, resulting in Published
applications..
In InTouch HMI 2020, modern applications have been redesigned as more comprehensive standalone
applications. The new standalone application offers many improvements over legacy standalone
applications.
Easy distribution – Copy and paste the application folder to a different node. No import or export
operations needed.
Use of Industrial Graphics – The new standalone application combines the ease of use of earlier
legacy applications with modern industrial graphics.
Ready for the cloud – Applications created on-premise nodes can now be viewed on a HTML5
compliant browser.
Light weight – The applications files are light weight and allow for better performance and use.
There is no change in behavior of Managed and Published applications.
69
Migrating and Upgrading ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Create a backup copy before migrating the old application to the current version of the InTouch HMI.
You can migrate existing standalone, modern, or published InTouch applications to the current InTouch
version. You must specify the folder to create the backup copy and if you want to exclude any files from
the backup.
1. From the application list, double -click on an application. The Application Migration dialog box
appears.
2. To convert the application resolution from the original to the current resolution, select the Convert the
application resolution from <existing resolution> to <new resolution> checkbox.
3. To change the default backup path (<Application Directory> \Bak), clear Use Default Backup Path
box. Then, type the path to the folder in the Backup Path box where you want to save the backup. If
the folder does not exist, you must create it, and then create the backup.
4. In the Ignore Files box, you can specify any files that you want to exclude from the backup. By
default, all files in the application directory are backed up. Type the file names you want to exclude
separated by a semicolon (;). Or, use standard wild card characters ('*' and '?') to exclude a set of
files by the common characters in their names.
5. After configuring the necessary options, click OK.
70
Migrating and Upgrading ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: Standalone applications can be copied from one node to another and found using the Find
Applications option, they do not need to be imported or ex port ed.
71
Migrating and Upgrading ApplicationsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
72
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 5
Distributing Applications
About Distributing Applications
Distributed applications typically have a central development station, central data storage, and client
stations. You use InTouch Network Application Development (NAD) to build and maintain distribut ed
applications. NAD allows many client stations to maintain a copy of a single application without restricting
the development of that application. Using an individual copy of the application provides Viewer
redundancy. Client stations are aut omatically notified when the application changes. You can create
single computer, client-based, and server-based InTouch applications.
You can also manage and deploy InTouch applications using the ArchestrA IDE. For more information
about using the ArchestrA IDE with the InTouch HMI, see About InTouch HMI and ArchestrA Integration
in the InTouc h® HMI and A rchestrA® Int egration Guide.
InTouch Process
App. serial connection
73
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Client-Based Architecture
In a client -based arc hitecture, there is a unique copy of one InTouch application for each computer
running WindowViewer (View node) or in a unique location on a network server. In the following
example, an application is developed and tested on the development node and then copied to each View
node.
There is inherent redundancy because each node can be self-sufficient, and there is no limit to the
number of View nodes you can use.
Each View node must have an identical copy of the application and identical access to any network data
sources, such as I/O Servers or the IndustrialSQL Server. However, each View node maintains a
separate conversation with the shared server, which can res ult in increase d net work loading.
You can modify and test the application on the development node without affecting the running process.
However, you must distribute the modified application to the View nodes. You must shut down each View
node locally, copy the new application to it, and then restart.
Server-Based Architecture
A server-based architecture distributes a common InTouch application to several View nodes. In the
following figure, two View nodes access the same application from the development node.
74
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: If you configure your application to write historical data to t he master application node's application
directory, all NA D nodes attempt to write their historical data to the master application. To avoid this, on
each NA D node, configure historical data to write to a local directory, not the master application node.
If you are distributing a large, complex application to numerous nodes, slow system response time may
be apparent on the initial download. Updates, however, are optimized. Applic ation transfer may be a
problem for slow net works or over serial connections.
Also, be aware of other network constraints, such as the user of routers that filter out certain types of
network traffic and addresses.
Note: InTouchView is restricted to the single Galaxy Access Name. You cannot create ot her Access
Names for InTouchView. For more information about the restrictions of InTouchView, see Viewing
Applications at Run Time on page 217.
The View node must have the same access to data sources as the development node.
75
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
You can set up an InTouch application to identify an element of data stored on another node by using a
three-part addressing convention in an Access Name. The Access Name addressing convention
includes the node name, application name, and topic name where the remote data is located. An
InTouch application obtains remote data using the Access Name in combination with an item name. For
more information about defining an Access Name for a remote I/O Server, see Data Access with I/O in
the InTouch® HMI Data Management Guide
Note: When you create Access Names in WindowMaker, if the Access Name uses the SuiteLink
protocol, the software prevents Access Names from accessing the same node, application and topic. Do
not use the IOS etAccessName() function to redirect Access Names to duplicate ones during run time or
else the redirected Access Name will not work.
Using a local I/O Server significantly increases the load on the process connection net work. For
example, three nodes triples the traffic created by one node, as each node's requests must be separately
processed.
For more information about defining an Access Name for a local I/O Server, see Dat a Access with I/O in
the InTouch® HMI Data Management Guide.
SuiteLink
The SuiteLink communications protocol is based on the TCP/ IP protocol. Use SuiteLink for your
high-speed industrial applications, as it provides these features:
76
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Value Time Quality (V TQ), in which a timestamp and quality indicator are associated with all data
values delivered to V TQ-aware clients. The InTouch HMI is a VTQ-aware client whose tag dat a is
delivered wit h a VTQ indicat or.
Extensive diagnostics of the data throughput, the server loading, comput er resource consumption,
and network transport are made accessible through the Microsoft Windows operating system
performance monitor.
Consistent high data volumes can be maintained between applications regardless if the applications
are on a single node or distributed over a large number of nodes.
SuiteLink is not a replacement for DDE, FastDDE, or Net DDE. Each connection between a client and a
server depends on your network requirements.
77
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: If you are using SuiteLink, the node name is limited to 15 characters.
Before you can access a file through UNC, you must create a file share on the computer you want to
access. For more information, see your Windows documentation.
For example, assume that you have a computer with the network name of "EngineRm" that you have
shared the root drive "C:\" with the share name of "Root". To set up a UNC path to t he " C:\IT\Apps\Boiler"
application you must use the following UNC:
\\EngineRm\Root\IT\Apps\Boiler
If the "Boiler" directory itself was shared as "Boiler," the UNC could be shortened to:
\\EnginerRm\Boiler
No path is required if the share is a pat h specified in the PA TH environment variable.
Note: If you need to writ e to a file referred to by a UNC address, the share must be a read/write share,
even on a local node. If you create a share that is password-protected, you will not be able to access the
share with a UNC unless you first set up a network drive mapping. You can set up a drive mapping from
the remote node by using Windows Explorer.
78
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Only one InTouch node can log to a distributed history file. However, an unlimited number of InTouch
nodes can view the cont ents of the file.
View Node View Node View Node View Node
A remote node ret rieving data from a history file may not see data for the last hour of data (based on the
logger node's time). Remote trends can only view data that has been written to the logging node's disk.
Data for each tag c hecked for 'Log Data' is automatically written to disk after 22 samples for that tag have
been collected. If the HTUpdat eToCurrent Time() function is called, data is written to disk regardless of
the number of samples collected. By default, data is written to disk once an hour. You can change this
interval by adding the following line to the INTOUCH.ini file:
ForceLogging=X;
Where X is minutes and can be set to any interval bet ween 5 and 120.
Note: The NetDDE Helper service must be running when you use the distributed history system.
The following figure shows the configuration of a typical distributed history system using Network
Application Development (NA D) to distribute the application.
Node 1 Node 2
Node3
Log/Retrieve Retrieve
Retrieve Retrieve
Log/Retrieve
Remote
Local
History File
History File
(HistPrv1)
Nodes 1 and 2 contain copies of the same InTouch application; however, the application is configured to
allow only Node 1 to log to a local history file, whereas either node can retrieve from the local history file
or the remote history file. Node 3 is also logging to and retrieving from the remote history file location.
Node 3, the history provider, is assigned the name HistPrv1. Node 1 is both a development and run-time
station, while Node 2 is just a run-time station.
Do the following major steps to create this type of application:
1. Create a history provider list. See Configuring Remot e History Providers on page 80.
2. Create and configure a historical trend object. For mo re information, see Trending Tag Dat a in the
InTouch® HMI Data Management Guide
3. Configure the application for distributed logging. See Configuring Distributed Historical Logging on
page 81.
4. Distribute the application. See Configuring an InTouch Application for NA D on page 83.
You can distribut e your application manually or by using NA D. When you distribute your application, the
historical provider list file is distributed as part of the application.
79
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
After you have distribut ed your application, you can run the View nodes and retrieve both local tags and
tags from a remote history provider. While the application runs on all the View nodes, only the logging
node logs to the historical log file; other nodes can only read from it.
Note: A remote history provider cannot be configured for an InTouchView application. For more
information about the limitations of InTouchView applications, see InTouchView Applications on page
15.
While the local InTouch application is considered a history provider, you do not need to define it for your
application.
If you reference an undefined history provi der in an application, WindowViewer ignores the reference
and an error message is written to the Logger.
The HistData utility cannot retrieve historical information from a Historian provider.
To configure a history provider
1. On the Special menu, point to Configure, and then click Distributed Name Manager. The
Di stributed Name Manager dialog box appears.
2. Click the Di stributed Hi story tab.
3. In the Provider Name box, type the name you want to use for the new historical provider.
A provider name can be 16 alphanumeric characters or fewer.
4. To configure an InTouch history provider, do the following:
a. Click InTouch Provider.
80
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
b. In theUNC box, type the UNC path to the InTouch application directory and then click Add.
The UNC path format is:
\\node_name\volume_name\directory\
If the UNC location is password-protected, you must first establish a node connection using
Windows Explorer.
5. To configure a IndustrialSQL Server history provider, do the following:
a. Click InSQL Provider.
b. Click Configure InSQL Provider. The InSql History Provider Properties dialog box appears.
c. In the Data Source box, type the name, up to 35 characters, of the node where the IndustrialSQL
Server database resides.
d. In the User box, type the user name for the logon account. The user account must have
database permissions to retrieve data.
e. In the Password and Re-enter password boxes, type the password for the logon account.
f. Click Test to validat e the connection to the IndustrialSQL Server. When a message appears,
click OK.
g. Click OK to close the InSql History Providers Properties dialog box.
6. Click OK.
81
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: Historical logging cannot be configured for an InTouchView application. For more information
about the limitations of InTouchView applications, see InTouchView Applications on page 15.
2. Select the Enable Historical Logging check box to turn on global tag logging.
3. Select Store Log Files in Specific Directory, and then in the input box, type the pat h of the location
where the log files are stored.
You must type a valid Universal Naming Convention (UNC) path. For ex ample,
\\Node\Share\Path
If you are using NAD, make sure the path points to a folder other than the application folder.
4. In the Name of Logging Node box, type the name of the node that will be logging to the history log
file.
This setting only allows the node named here to log to the file.
5. Click OK.
Note: When an application with the Enable Historical Logging option selected is distributed to a
WindowViewer node, that node checks this option to determine if it should log or not. If Enable
Hi storical Logging is selected, the possible settings are:Field equals name of Node - Logging
enabled Field does not equal name of Node - Logging disabled.
82
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Caution: Do not use a root folder or a UNC pathname that points to a root folder. The View node
recursively deletes all files and subfolders in the specified destination application folder before copying
the master application directory. Therefore, never use the path of the master application folder or a UNC
to the master application folder.
If you do not specify a folder, WindowViewer automatically creates a local subfolder named NA D in the
folder from which WindowViewer is launched. The NA D folder should be considered a temporary folder
and no other files should be saved to it except those copied by NAD itself.
To configure an application for NAD
1. Start Application Manager.
83
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the Tool s menu, click Node Properties. The Node Properties dialog box appears.
84
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o Click Load Changes into WindowViewer to dynamically load in WindowViewer the changes
made in the development node. This may affect performance for large updates.
Note: It is recommended that you use the Load Change s into WindowViewer option only if the
application changes are minor and few in number. Examples of minor changes include changes
made within an existing window, resizing of graphic toolbar elements, addi ng new graphic toolbar
elements, and reference substitutions. When making changes that require that WindowViewer be
restarted, such as adding new tags, adding new windows, or changing the configuration—or if in
doubt—use one of the Restart options instead.
o Click Prompt user to load changes into WindowViewer to show the operator a message that
the application has changed. The message prompts the operator to load the changes.
7. Click OK.
Note: If the Prompt to Notify Clients on Close option is selected, every time WindowMaker is closed it
will verify if there are any changes from the last notification. If there are any changes, a dialog box wit h
the prompt ‘Do you want to notify the NAD clients?’ will appear. Click Yes to notify the clients, click No to
ignore the changes.
85
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
86
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
See Also
$ApplicationChanged
RestartWindowViewer() Function
Shuts down WindowViewer, copies the updated master application (if configured to do so), and then
restarts WindowViewer.
Category
system
Syntax
RestartWindowViewer();
Remarks
This function is used to update an application when the automatic update Network Application
Development (NA D) functions are not used.
Use the $ApplicationChanged system tag to determine when a NAD update has occurred.
You use t he Notify Clients command to initiate a NAD update. However, the operator may want to delay
the update until a later time. You can use this function with a button action script so that the operator can
restart WindowViewer when it is convenient.
You could instead use the ReloadWindowViewer() function, whic h updates the View node without
shutting down WindowViewer.
See Also
$ApplicationChanged, ReloadWindowViewer()
ReloadWindowViewer() Function
Dynamically updates WindowViewer wit h the updated master NAD application without any interruption in
service.
Category
system
Syntax
ReloadWindowViewer();
Allows the user control over reloading WindowViewer.
Remarks
Use this function to update an application when the automatic update Network Application Development
(NA D) functions are not used.
Use the $ApplicationChanged system tag to determine when a NAD update has occurred.
You use t he Notify Clients command to initiate a NAD update. However, the operator may want to delay
the update until a later time. You can use this function with a button action script so that the operator can
reload the application in WindowViewer when it is convenient.
See Also
$ApplicationChanged
87
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: WindowViewer recursively deletes all files and sub folders in the destination application folder
except those required for run-time language switching. This folder should be considered a temporary
folder. No other files should be plac ed in it.
The NAD client starts an update by creating a local list of files and sub-directories that appear in the client
application directory. As it looks for updat es in the list of master files, the NAD client removes the
corresponding client file for each master file from the local list. The remaining entries in the local list are
obsolete files and sub-directories that should be delet ed from the application.
All downloaded files are copied to a temporary sub-directory called NA D_Temp. Files are only copied
from NA D_Temp to the application directory if all of the new and updated files are copied successfully
within the re-t ry limits. If the NAD client has to abandon an update, the running application is not
corrupted by the partial introduction of new or updated files.
If contact with the NA D master fails aft er all new and updated files have been downloaded, the update
can still be completed by copying the updat es from NAD_Temp and deleting the obsolete files. This
ensures that files are not erased simply because a lost connection makes it impossible to confirm their
existence on the master application.
NAD can detect whether additional changes have been made to the master application during
application download. If such a situation arises, NA D abandons the download of the application. If you
run the Noti fy Clients command after the latest update, NA D automatically begins downloading the
latest application files at the next polling period. Otherwise, it waits until the next Notify Clients
command issued before an application download takes place.
Caution: If you do not use DRC to scale the application, WindowViewer only runs the application if the
node's screen resolution is identical to the screen resolution of the application development node. If the
resolutions are different, WindowViewer prompts the operator to run WindowMaker to convert the
application to the node's resolution. Use caution when doing this if you have set up a UNC path to the
master application directory, as this will only modify the original application.
88
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Select the Allow WindowViewer to dynamically change resolution check box if you want
WindowViewer to locally scale the master application.
5. In the Dynamic Re solution area, select one of the following:
o Select Use application resolution if you want WindowViewer to run the application at the
resolution it was developed for and ignore the node's resolution. For example, if the application
was developed at 800x600 and the node's resolution is 1024x768, WindowViewer does not
dynamically scale the application. Instead, the application res olution remains at 800x600.
o Select Convert to screen video resolution if you want WindowViewer to run the application at
the node's resolution and ignore the resolution the application was developed at. For example, if
the node is running at 800x600 and the application was developed at 1280x1024,
WindowViewer dynamically scales the application to fit the node's 800x60 0 resolution.
89
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
– If the target resolution is different from the screen resolution when the application was
created, then WindowViewer will scale to the current screen res olution from the original
application resolution instead. The original application resolution is the screen resolution
when the application was created regardless of the target resolution settings. For example, if
the application was developed at 1920x1080 with a target resolution of 1280x 1024 and the
view node is running the application at resolution of 800x600, WindowViewer will
dynamically scale the application to use the original application resolution of 1920x1080. For
more information, see Original Application Resolution on page 218.
o Select Custom resolution if you want WindowViewer to run the application at a specific
resolution you specify in the Width (X) and Height (Y) (must be integer values) boxes. The
application's resolution and the node's resolution are bot h ignored. For example, if Width (X )
and Height (Y) are set to 512 and 384, respectively, the application is dynamically scaled to fit in
a 512x384-pixel area on the node's screen.
– If the target resolution is different from the screen resolution when the application was
created, then WindowViewer will scale to the current screen res olution from the original
application resolution instead. The original application resolution is the screen resolution
when the application was created regardless of the target resolution settings.
6. Click OK.
90
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. Select the Lock Window Size check box. By default, the check box is not selected.
4. Click OK.
To lock the application resolution from Application Manager
1. Open Application Manager.Click to select the application you want to configure.
2. Click File on the menu bar, then click Properties. The Properties dialog box appears.
91
Distributing Applications AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. Select the Lock Window Size switch. By default, the check box is not selected.
4. Click OK.
92
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 6
Deploying and Working with Terminal
Services and Remote Desktop Services
Terminal Services Overview
Terminal Services is a configurable service included in the Microsoft Windows Server operating systems
that runs Windows-based applications centrally from a server. In Terminal Services, client computers
access the server node, where multiple instances of InTouch software applications run simultaneously.
93
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
Note: Alarm P roviders are not supported on Terminal sessions. They are only supported on the Terminal
Cons ole.
Caution: Security auditing requires significant resources. Enable auditing when you evaluate your pilot
server to accurately estimate your InTouch application hardware requirements.
94
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
Note: Running with the same logon account on multiple sessions can cause corruption and other
unexpected results.
95
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
DDE from MS Office (for Yes Excel and the InTouch HMI must be running
example, Hot-link configured in in the same session.
Excel)
Printing Alarms No --
TseGetClientId() Function
Returns a string version of the client ID (the TCP/IP address of the client) if the View application is
running on a Terminal Server client. This client ID is used internally to generat e SuiteLink server names
and logger file names. Otherwise, the TseGetClientId() function returns an empty string.
Syntax
MessageResult=TseGetClientId();
96
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
Example
The client IP address 10.103.202.1 is saved to the MsgTag tag.
MsgTag=TseGetClientID();
TseGetClientNodeName() Function
Returns the client node name if the View application is running on a Terminal Server client assigned a
name that can be identified by Windows. Otherwise, the TseGetClientNodeName() function returns an
empty string.
Syntax
MessageResult=TseGetClientNodeName();
Example
The client node name is returned as the value assigned to the MsgTag tag.
MsgTag=TseGetClientNodeName();
TseQueryRunningOnConsole() Function
The TseQueryRunningOnConsole() function can be run from a script to indicate whether the View
application is running on a Terminal Services console.
Syntax
Result=TseQueryRunningOnConsole();
Return Value
Returns a non-zero integer value if the View applic ation is running on a Terminal Services console.
Otherwise, the TseQueryRunningOnConsole() function returns a zero.
Example
Int Tag is set to 1 if WindowViewer is running on a Terminal Services console.
IntTag=TseQueryRunningOnConsole();
TseQueryRunningOnClient() Function
Returns a non-zero integer value if the View applic ation is running on a Terminal Services client.
Otherwise, it returns a zero.
Syntax
Result=TseQueryRunningOnClient();
Return Value
Returns 0 if View is not running on a Terminal Services client.
Example
Int Tag is set to 1 if WindowViewer is running on a Terminal Services client.
IntTag=TseQueryRunningOnClient;
97
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
When a user accesses a program on an RD Session Host server, the program runs on the server. Each
user sees only their individual session. The session is managed transparently by the server operating
system and is independent of any other client session. Additionally, you can configure Remote Desktop
Services to use Hy per-V™ to either assign virtual machines to users or have Remote Desktop Services
dynamically assign an available virtual machine to a user upon connection.
For more information about Remote Desktop Services, see the Remote Desktop Services page on the
Windows Server 2008 R2 TechCenter (http://go.microsoft.com/fwlink/?LinkId=138055).
98
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
RD Virtualization Host: Remote Desktop Virtualization Host (RD Virt ualization Host) integrates
with Hyper-V to host virtual machines and provide them to users as virtual desktops. You can assign
a unique virt ual desktop to each user in your organization, or provide them shared access to a pool of
virtual desktops.
99
Deploying and Working with Terminal Services and Remote Desktop ServicesAVEVA™ InTouch HMI formerly Wonderware Application Man
100
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 7
Managing InTouch Services
About Managing InTouch Services
A service is a Windows process that performs a specific unattended background system function without
a user interface or a required us er logon.
The following startup options are available for Windows services:
Automatic. When Windows restarts, the service automatically starts without any user intervention.
Manual. A user or an application process must explicitly start the servic e.
Di sable. The service is prevented from starting. This is useful for troubleshooting.
Note: The parameters option in the InTouc h WindowViewer service is not support ed.
Note: A logged on user must have proper access to the network location if a network application is
used to run as a service or a network path is used as a historical logging folder.
If WindowViewer is already running as a servic e and you attempt to start it again from a shortcut icon or
by clicking WindowViewer on the Windows Start menu, a message is logged in the ArchestrA Logger.
The message describes the restrictions to starting WindowViewer when it has been configured to run as
a service.
101
Managing InTouch Services AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If WindowViewer is already running as a service and you attempt to launch Application Manager or
WindowMaker, a warning message will be logged in the A rchestrA Logger. The message explains that
Application Manager and WindowMaker cannot open when WindowViewer is running as a service.
Important: When running WindowViewer as a servic e, the user account privileges have been set to
non-interactive to reduce the potential security exposure of running a servic e with administrator
privileges.
102
Managing InTouch Services AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the Tool s menu, click Node Properties. The Node Properties dialog box appears.
3. Select the Start WindowViewer as a service check box to configure WindowViewer to aut omatically
run as a service.
The Application to run as a service group box will become enabled.
4. Click the ellipsis button to prompt a file explorer and navigate to your InTouch application.
The application directory will populate in the group box.
5. Click OK.
6. Click the WindowViewer icon in the Application Manager toolbar.
WindowViewer will now run as a service for the specified InTouch application.
Note: You can also fast switch from WindowMaker to WindowViewer to start the WindowViewer service
for the InTouch application if you have configured the Node Properties as described in the above steps.
You can do this in place of starting WindowViewer from the A pplication Manager.
103
Managing InTouch Services AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: The above functionality is not supported for Managed InTouch applications. If you attempt to
fast-switch a Managed application from WindowMaker to run as a service in WindowViewer, a warni ng
message will be logged in the ArchestrA Logger.
Stopping a Service
You can manually stop the WindowViewer service using the Control Panel.
To stop the WindowViewer service using the Control Panel
1. Start the Control Panel.
2. Double-click Administrative Tools and then double-click Services. The Service s dialog box
appears.
3. In the details pane, right-click WindowViewer and then click Stop.
104
Managing InTouch Services AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
When you install the InTouc h HMI, you specify an administrative ac count that all ArchestrA services run
under, if the account was not created already. This account is considered the master ArchestrA account.
The InTouch services use the master A rchestrA account to automatically start up.
Note: The master account is also called the impersonation account. An impersonation account is the
user or group account that provides access to the restricted resource "area" of your site or server.
If you want to change the master account, use the ArchestrA Change Network Account Utility.
Caution: Changing the master account affects all ArchestrA services, not just InTouch services.
105
Managing InTouch Services AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
106
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 8
Exporting and Importing InTouch
Components
About Exporting and Importing InTouch Components
You can build InTouch applications more quickly by importing or exporting some or all of the components
of an existing application. You can import tag definitions, windows, scripts, application style libraries,
Industrial graphics, client controls, localization strings, HTML5 widgets, and script function libraries from
your existing application to a new application. Tag definitions are imported and exported from the
Application Manager, other components are imported and ex port ed via WindowMak er.
InTouch Application
DBDump
Tagname
Dictionary
CSV File
PumpInP PumpRPM
Inlet
RPM
Pressure
PumpOutP PumpState
Outlet On/Off
Pressure State DBLoad
You use the DBDump utility within the Application Manager to export the contents of the Tagname
Dictionary to a Comma S eparated Value (CSV) file. You can view and edit the exported file with Mic rosoft
Notepad or Microsoft Excel. After making edits, you then import the tag definitions to an InTouch
application with the DBLoad utility, which is also an Applic ation Manager utility.
You must convert an application to the current version of the InTouch HMI soft ware before you can
export the tag definitions.
To export tag definitions
1. Close WindowMaker and WindowViewer.
2. Start Application Manager. The Application Manager dialog box shows a list of InTouch
applications.
3. Select the application from the list.
107
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Click the DBDump icon. The CSV File to Dump To: dialog box appears.
5. In the Name of CSV Dump file box, type a name for the file with a .cs v file name extension.
6. Select the type of data grouping in the export file.
o Select the Group output by type s check box to group the data by the types of tags in the export
file. This is the default.
o Clear Group output by type s to save the output to the export file alphabetically by tag name.
7. Click OK to save the contents of the Tagname Dictionary to the selected file. A message appears
indicating the contents were saved successfully to the file.
The file consists of keywords, their attributes, and data from the Tagname Dictionary arranged in column
order beneath keyword attributes.
Notice the :MemoryDisc keyword in the ex ample of the Excel spreadsheet. This keyword identifies
memory discrete tags that were exported from a Tagname Dictionary. On the same spreadsheet row, the
attributes of a memory discrete tag appear in separate spreadsheet columns. For example, the Logged
attribute column shows whether a memory discrete tag’s dat a is logged or not.
Immediately beneath the keyword and attributes row are the exported tags and their associated
properties. In the example of the Excel spreadsheet, OutputValve is a memory discrete tag whose data is
not logged.
You can view or edit the ex port file created by DB Dump with a ny program that supports the .csv file
format. Typically, Excel is used because its columnar spreadsheet format makes it easy to organize tag
data. But, you can also use Microsoft Notepad if you prefer to view or edit the file’s contents in its native
comma-delimited string format.
You can also use the DBLoad utility instead of the InTouch TemplateMaker to create SuperTag
instances. For more information, see Creating SuperTag Instances on page 139.
For more information on creating import files, see Creating an Import File Template on page 110.
The DB Load import file contains a set of keywords that organize Access Names, alarm groups, and tag
data within the file.
A colon (:) precedes all keywords.
To continue a line, enter a backslash (\) at the end of the line.
To enter comments, precede them with a semi -colon (;).
The following table lists the keywords within a DB Load import file. The table lists the keywords in the
order they are specified when you create the file with DBDump. But you can specify keywords in any
order wit hin the file.
Keyword Description
:mode Specifies how duplicate tag records are handled when importing the
contents of the DBLoad file to an application’s Tagname Dictionary.
109
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Keyword Description
Each keyword includes a set of associated attributes that specify the properties of Access Names, alarm
groups, and tags. For example, the :IOAccess keyword includes attributes to specify the application,
topic, and communication protocol, which are properties of every InTouch Access Name.
After creating a template, you then manually add tag dat a beneath the keyword that identifies the type of
tag. You insert the properties of your tags in the corresponding attribute columns associated with the tag
type keywords.
To create a template import file
1. Open the Application Manager.
2. Create a new InTouch application.
For more information about the steps to create an application, see Creating an InTouch Application
on page 28.
3. Select the new application from the list shown in Application Manager.
4. Export the contents of the application’s Tagname Dictionary with the DB Dump utility.
For more information about exporting tags, see Exporting Tag Definitions on page 107.
5. Edit the file to insert tag data that you want to import.
110
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
:MODE=REPLACE
If a duplicate tag is encountered, the DB Load utility deletes the existing tag in the Tagname Dictionary
and replaces it with the tag from the import file with the same name.
:MODE=UPDATE
If a duplicate tag is encount ered, the DBLoad utility overwrites the existing tag definition in the Tagname
Dictionary only with dat a explicitly specified from the import file. All other data associated with the tag
remains unchanged in the Tagname Dictionary.
Fields are considered explicitly defined if th e field is in the record and entered by you or is set by the
":KEYWORD= value" mechanism. If a field is not specified in the record, and the keyword has been reset
using the ":KEYWORD=" command, the current field value is not updated.
The following is an example of what occurs when an import file in the update mode is loaded/merged into
the Tagname Dictionary:
:Mode=update
:Group=Group1
:IODisc,Group,DConversion
Tagname1,Group2,
; Tagname1's Group updated to Group2 only
Tagname2,,
; Tagname2's Group updated to Group1 and the DConversion left as is
Tagname3,,Reverse
; Tagname3's Group updated to Group1 and the DConversion to "Reverse"
; the following line "resets" the Group field to its default value
:Group=
; Data field "Group" is reset to its default value
Tagname4,,
; Tagname4 will be left alone
111
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The tag types must be compatible if the type is being changed and the tag is in use. For example, an
existing historical trend tag cannot be changed to an I/O Integer if the tag is in use by the application.
Also, a tag cannot be changed to ReadOnly=yes if the tag is being used on an input link in the
application. Because of these restrictions, update t he us e counts for t he target applic ation before running
the DBLoad utility.
:MODE=ASK
DBLoad stops when a duplicat e tag is encountered while loading the Tagname Dictionary. The
Duplicate Name dialog box appears and shows a list of options to handle duplicate tags. This is the
default import mode.
:MODE=IGNORE
The DB Load import utility ignores the duplicat e tag and continues processing the remaining records of
the import file.
:MODE=TERMINATE
The DB Load import operation stops when a duplicate tag is encount ered.
:MODE=TEST
DBLoad scans the import file for errors and does not attempt to load tag definitions into the Tagname
Dictionary. DBLoad generates a report that identifies any format errors by line number and location in the
import file.
Run DBLoad with :mode=test first to identify any errors in the import file. After correcting any errors,
change the mode keyword value to :mode=replace or :mode=update before running DBLoad.
112
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The following table shows the list of attributes associated with the :IOAccess keyword. The table lists the
attributes in the order they are specified when using a templat e import file created with the DB Dump
utility.
String Default
Posi tion Attribute s Acceptable Values Values
113
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
String Default
Posi tion Attribute s Acceptable Values Values
114
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The following table shows the list of attributes associated with the :AccessGroup keyword. The table lists
the attributes in the order they are specified when using a template import file created with the DBDump
utility.
String Default
Posi tion Attribute s Acceptable Values Values
115
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
String Default
Posi tion Attribute s Acceptable Values Values
116
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
String Default
Posi tion Attribute s Acceptable Values Values
Default
Attribute Acceptable Value Value
117
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
118
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
119
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
120
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
121
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
122
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
123
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Default
Attribute Acceptable Value Value
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 InitialDisc
8 OffMsg
9 OnMsg
10 AlarmState
11 AlarmPri
12 AlarmComment
13 AlarmAckModel
14 DSCAlarmDisable
15 DSCAlarmInhibitor
16 SymbolicName
124
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 InitialDisc
8 OffMsg
9 OnMsg
10 AlarmState
11 AlarmPri
12 Conversion
13 AccessName
14 ItemUseTagname
15 ItemName
16 ReadOnly
17 AlarmComment
18 AlarmAckModel
19 DSCAlarmDisable
20 DSCAlarmInhibitor
21 SymbolicName
125
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 RetentiveAlarmP arameters
8 AlarmValueDeadband
9 AlarmDevDeadband
10 EngUnits
11 InitialValue
12 MinValue
13 MaxValue
14 Deadband
15 LogDeadband
16 LoLoAlarmState
17 LoLoAlarmValue
18 LoLoAlarmPri
19 LoAlarmState
20 LoAlarmValue
21 LoAlarmPri
22 HiAlarmStat e
23 HiAlarmV alue
24 HiAlarmP ri
126
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
25 HiHiAlarmState
26 HiHiAlarmValue
27 HiHIAlarmPri
28 MinorDevAlarmState
29 MinorDevAlarmValue
30 MinorDevAlarmPri
31 MajorDevAlarmState
32 MajorDevAlarmValue
33 MajorDevAlarmPri
34 DevTarget
35 ROCAlarmSt ate
36 ROCAlarmV alue
37 ROCAlarmP ri
38 ROCTimeB ase
39 AlarmComment
40 AlarmAckModel
41 LoLoAlarmDisable
42 LoAlarmDisable
43 HiAlarmDisable
44 HiHiAlarmDisable
45 MinDevAlarmDisable
46 MajDevAlarmDisable
47 RocAlarmDisable
48 LoLoAlarmInhibit or
49 LoAlarmInhibitor
50 HiAlarmInhibitor
51 HiHiAlarmInhibitor
52 MinDevAlarmInhibitor
53 MajDevAlarmInhibitor
54 RocAlarmInhibit or
127
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
55 SymbolicName
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 RetentiveAlarmP arameters
8 AlarmValueDeadband
9 AlarmDevDeadband
10 EngUnits
11 InitialValue
12 MinEU
13 MaxEU
14 Deadband
15 LogDeadband
16 LoLoAlarmState
17 LoLoAlarmValue
18 LoLoAlarmPri
19 LoAlarmState
20 LoAlarmValue
21 LoAlarmPri
128
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
22 HiAlarmStat e
23 HiAlarmV alue
24 HiAlarmP ri
25 HiHiAlarmState
26 HiHiAlarmValue
27 HiHIAlarmPri
28 MinorDevAlarmState
29 MinorDevAlarmValue
30 MinorDevAlarmPri
31 MajorDevAlarmState
32 MajorDevAlarmValue
33 MajorDevAlarmPri
34 DevTarget
35 ROCAlarmSt ate
36 ROCAlarmV alue
37 ROCAlarmP ri
38 ROCTimeB ase
39 AlarmComment
39 MinRaw
40 MaxRaw
41 Conversion
42 AccessName
43 ItemUseTagname
44 ItemName
45 ReadOnly
46 AlarmComment
47 AlarmAckModel
48 LoLoAlarmDisable
49 LoAlarmDisable
50 HiAlarmDisable
129
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
51 HiHiAlarmDisable
52 MinDevAlarmDisable
53 MajDevAlarmDisable
54 RocAlarmDisable
55 LoLoAlarmInhibit or
56 LoAlarmInhibitor
57 HiAlarmInhibitor
58 HiHiAlarmInhibitor
59 MinDevAlarmInhibitor
60 MajDevAlarmInhibitor
61 RocAlarmInhibit or
62 SymbolicName
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 RetentiveAlarmP arameters
8 AlarmValueDeadband
9 AlarmDevDeadband
10 EngUnits
130
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
11 InitialValue
12 MinValue
13 MaxValue
14 Deadband
15 LogDeadband
16 LoLoAlarmState
17 LoLoAlarmValue
18 LoLoAlarmPri
19 LoAlarmState
20 LoAlarmValue
21 LoAlarmPri
22 HiAlarmStat e
23 HiAlarmV alue
24 HiAlarmP ri
25 HiHiAlarmState
26 HiHiAlarmValue
27 HiHiAlarmPri
28 MinorDevAlarmState
29 MinorDevAlarmValue
30 MinorDevAlarmPri
31 MajorDevAlarmState
32 MajorDevAlarmValue
33 MajorDevAlarmPri
34 DevTarget
35 ROCAlarmSt ate
36 ROCAlarmV alue
37 ROCAlarmP ri
38 ROCTimeB ase
39 AlarmComment
40 AlarmAckModel
131
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
41 LoLoAlarmDisable
42 LoAlarmDisable
43 HiAlarmDisable
44 HiHiAlarmDisable
45 MinDevAlarmDisable
46 MajDevAlarmDisable
47 RocAlarmDisable
48 LoLoAlarmInhibit or
49 LoAlarmInhibitor
50 HiAlarmInhibitor
51 HiHiAlarmInhibitor
52 MinDevAlarmInhibitor
53 MajDevAlarmInhibitor
54 RocAlarmInhibit or
55 SymbolicName
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 RetentiveAlarmP arameters
132
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
8 AlarmValueDeadband
9 AlarmDevDeadband
10 EngUnits
11 InitialValue
12 MinEU
13 MaxEU
14 Deadband
15 LogDeadband
16 LoLoAlarmState
17 LoLoAlarmValue
18 LoLoAlarmPri
19 LoAlarmState
20 LoAlarmValue
21 LoAlarmPri
22 HiAlarmStat e
23 HiAlarmV alue
24 HiAlarmP ri
25 HiHiAlarmState
26 HiHiAlarmValue
27 HiHiAlarmPri
28 MinorDevAlarmState
29 MinorDevAlarmValue
30 MinorDevAlarmPri
31 MajorDevAlarmState
32 MajorDevAlarmValue
33 MajorDevAlarmPri
34 DevTarget
35 ROCAlarmSt ate
36 ROCAlarmV alue
37 ROCAlarmP ri
133
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
38 ROCTimeB ase
39 MinRaw
40 MaxRaw
41 Conversion
42 AccessName
43 ItemUseTagname
44 ItemName
45 ReadOnly
46 AlarmComment
47 AlarmAckModel
48 LoLoAlarmDisable
49 LoAlarmDisable
50 HiAlarmDisable
51 HiHiAlarmDisable
52 MinDevAlarmDisable
53 MajDevAlarmDisable
54 RocAlarmDisable
55 LoLoAlarmInhibit or
56 LoAlarmInhibitor
57 HiAlarmInhibitor
58 HiHiAlarmInhibitor
59 MinDevAlarmInhibitor
60 MajDevAlarmInhibitor
61 RocAlarmInhibit or
62 SymbolicName
134
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The table shows the order that :MemoryMsg keyword attributes are specified when DB Dump is used to
create the import file. See Tag Keyword Attributes on page 117 for the data associated with these
attributes and their default values.
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 MaxLength
8 InitialMessage
9 AlarmComment
10 SymbolicName
1 Group
2 Comment
3 Logged
4 E vent Logged
5 E vent LoggingPriority
6 RetentiveV alue
7 MaxLength
8 InitialMessage
9 AccessName
10 ItemUseTagname
135
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
11 ItemName
12 ReadOnly
13 AlarmComment
14 SymbolicName
Note: InTouch Group Var tags are obsolet e. The :GroupV ar keyword is included to support legacy
applications only.
The table shows the order that :GroupVar key word attributes are specified when DBDump is used to
create the import file. See Tag Keyword Attributes on page 117 for the data associated with these
attributes and their default values.
1 Group
2 Comment
3 SymbolicName
1 Group
2 Comment
3 SymbolicName
136
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
1 Group
2 Comment
1 Group
2 Comment
3 E vent Logging
4 E vent LoggingPriority
5 RetentiveV alue
6 SymbolicName
1 Group
137
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2 Comment
3 E vent Logging
4 E vent LoggingPriority
5 RetentiveV alue
6 SymbolicName
1 Group
2 Comment
3 E vent Logging
4 E vent LoggingPriority
5 RetentiveV alue
6 SymbolicName
In the following example, a blank string is indicated by quotation marks (" "):
:Comment="HI"
:MemoryDisc,Comment,Group
Tagname1,,$System
Tagname2,"",$System
where:
138
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The value of the Comment field for Tagname1 is Hi, and the value of the Comment field for Tagname2 is
a blank comment.
Microsoft Excel ignores quotation marks that denote a blank string when it saves the file, resulting in the
following:
:Comment="HI"
:MemoryDisc,Comment,Group
Tagname1,,$System
Tagname2,,$System
To ensure that a blank string is used with Excel, type a space in the cell as the attribute value.
139
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
7. In the Name of CSV Load file box, locate and select the file you want to import.
8. Click OK.
The next step varies based upon whether DBLoad imports new or existing tag definitions to the
Tagname Dictionary.
o If you are importing new tag definitions, the new tag data is loaded into the application’s
Tagname Dictionary. A message appears confirming the dat a was successfully loaded and
merged.
o If you are importing existing tag definitions, the import stops if the :mode keyword is set to
:mode=ask and the import file contains duplicate tags. You are shown options to handle the
duplicate tags or you can cancel the import. For more information about keyword options, see
Setting the Operating Mode for Dictionary Import Files on page 111.
Importing Windows
Importing windows from an existing InTouch application into your current applicati on allows you to
reduce development time because y ou can reuse your previously created windows, objects, and window
scripts.
140
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
You must convert an application to the current version of the InTouch HMI soft ware before you can
import windows.
By default, placeholders are created for the tags associated with an imported window. After importing,
you can convert the placeholders to local tags or remote tag references. For more information, see Tag
Placeholders for Imported Windows and Scripts on page 147. If the associated tags already exist in the
target application, during the import you can select to use these instead.
When you import windows containing SmartSymbols and select to use existing tags, the InTouch HMI
still keeps placeholders for the recovered symbols, even though the tags are available in the target
application.
When you import a window from an application that contains SuperTags, only the SuperTag instances
actually used in the window are import ed into the new application. The entire SuperTag template
structure is not import ed. For example, if t he application has hundreds of SuperTag member t ags defined
in it, and only 50 of those are us ed in the imported window, only those 50 are imported.
Important: If you move InTouch window files using any method other than importing or exporting them,
the contents of the application Tagname Dictionary can become corrupt.
To import a window
1. Close all windows in your current application.
2. On the File menu, click Import, and then click Windows and Scripts. The Import from directory
dialog box appears.
3. Select the folder for the application containing the windows to import.
4. Click OK. The Application Data Import Options dialog box appears.
5. Select the Windows check box and then click Select to select the individual windows to import.
6. Select the Use Exi sting Tags (Conserve Placeholders) check box if the tags associated with the
imported windows already exist in your application and you want to use them instead of
placeholders.
7. Click Import.
141
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
8. Convert the placeholder tags to either local tags or remot e tag references. For more information, see
Converting Placeholder Tags for an Imported W indow on page 142.
9. If an imported window contains one or more wizards, double -click on each wizard to open its
properties panel. If an imported window contains one or more SmartSymbols, edit each
SmartSymbol and create new instances.
142
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
After the conversion, the Substi tute Tagnames dialog box shows the new tags.
6. Click OK.
Exporting Windows
You can export application windows to:
Create or maintain a library application of all windows.
Create remote tag referenc es in another application.
You must convert an application to the current version of the InTouch HMI soft ware before you can
export windows.
When you export a window, all objects and animation links associated with that window are exported.
The tags associated with the objects in the window are converted to placeholder tags to prevent existing
tags in the destination application from being overwritten. For more information on converting
placeholder tags, see Converting Placeholder Tags for an Imported Window on page 142.
Important: If you move InTouch window files using any method other than importing or exporting them,
the application’s Tagname Dictionary can be corrupted.
To export a window
1. Close all windows in your current application.
2. On the File menu, click Export, and then click Windows. The Export to directory dialog box
appears.
143
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Importing Scripts
You can import existing QuickScripts from an InTouch application into your current application to save
development time.
You must convert an application to the current version of the InTouch HMI soft ware before you can
import scripts.
By default, placeholders are created for the tags associated with an imported QuickScript. After
importing, you can convert the placeholders to local tags or remot e tag references. For more information,
see Tag Placeholders for Imported Windows and Scripts on page 147. If the associated tags already
exist in the target application, during the import you can choose to use these instead.
To import a window script, you must import the entire window.
For an imported ActiveX E vent script to function properly in the target application, the same ActiveX
control and the same event for which the script was originally created must also be used in the target
application and it must be loaded into memory. If the window containing an ActiveX c ontrol is closed, any
scripts associated with it (either ActiveX E vent scripts or QuickScripts) do not run properly.
To import a QuickScript
1. Close all windows in your current application.
2. On the File menu, click Import, and then click Windows and Scripts. The Import from directory
dialog box appears.
3. Select the folder for the application that contains the s cripts to import.
144
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Click OK. The Application Data Import Options dialog box appears.
5. Select the check box for the QuickScript type(s) that you want to import and then click Select to
select the individual script(s ) to import.
Note: To import a window script, you must import the entire window. For more information, see Importing
Windows on page 140.
6. Select the Use Exi sting Tags (Conserve Placeholders) check box if the tags associated with the
imported script(s) already exist in your application and y ou want to use them instead of placeholders.
7. Click Import. If your application has scripts with identical names, you are prompted to overwrite,
skip, or rename.
8. Convert the placeholder tags to either local tags or remot e tag references. For more information, see
Converting Placeholder Tags in an Import ed Script on page 145.
145
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
146
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
147
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The following flowchart describes ho w tags are handled for imported windows and QuickScripts.
BEGIN
Import a window
or QuickScript
No No
No
END
148
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the File menu, click Export, and then click All Industrial Graphics.
The Export Industrial Graphics dialog box appears to specify the destination folder and the name
of the export file.
149
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The Import Industrial Graphics dialog box appears to specify the folder containing an export file of
Industrial Graphics.
3. Using Windows Explorer, go to the folder containing an aaPKG file of exported Industrial Graphics.
4. Select the aaPKG file to import.
The File name field shows the name of the file you selected.
5. Click Open.
The Import Industrial Graphics dialog box appears wit h the following options for overwriting graphics:
o Skip: Do not Import - The graphics will not be imported
o Overwrite if the importing graphic change version is higher - Will import the graphics only if the
version of the file imported is higher than the installed version.
o Overwrite regardless of graphic change version - The graphics will be imported.
6. Click OK.
A horizontal bar shows the progress of the Industrial Graphics being imported into the active
application. When finished, the progress indicator disappears.
Note: This procedure explains how to export selected Industrial Graphics. See Exporting Industrial
Graphics from an Application on page 148 for instructions to export all Industrial Graphics.
150
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Important: Only standalone applications can import custom client controls. You cannot im port custom
client controls to legacy or published InTouch HMI applications.
151
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The Import Client Control (s) dialog box appears with a field to enter the name of a custom client
control you created.
4. Using Windows Explorer, go to the folder where you plac ed the client control .dll file.
5. Select the client control .dll file and click Open.
WindowMaker updates and shows the custom client control you imported in the Industrial Graphic
Toolbox.
You can also remove an imported client control from the Industrial Graphic Toolbox. First, select the
client control within the Industrial Graphic Toolb ox. Then, right-click to show the shortcut menu and
select Delete.
Note: Conflict detection is based solely on the name of the control. Library filenames or versions have no
affect on conflict detection.
152
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
For example, if you import a client control .dll containing the two controls MathControl and TrendControl
and the current library contains cont rols of the same name, the Import Client Control dialog box will
display:
The existing client control .dll will be replac ed, and the new control will now be avai lable in the library.
If you see "Remove" in t he "Proceeding will" column, it means there are controls in the current library that
are not in the importing library. Because the hosting .dll must be replaced to resolve the conflicting
controls, any controls that are in the current.dll but not in the importing .dll will be removed upon
proceeing with the import.
For example, importing a client control .dll c ontaining the controls MathControl and DatabaseControl and
the current library cont ains MathControl and TrendControl, TrendControl will be removed from t he library
upon import.
153
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The Import Client Cont rol dialog box will prompt you to acknowledge the removal:
The library will be replaced and TrendControl will be removed upon completion of the import.
Restart WindowMaker to updat e the controls in the Graphic Toolbox.
Note: If you have imported a newer version of client control already embedded in a symbol, restarting
WindowMaker and refreshing the graphic thumbnail will not update the contents of the control. You must
edit and save the symbol for the new client control to be reflected in the thumbnail.
Important: You cannot drag and drop the custom client control fr om the Industrial Graphic Toolbox onto
the Industrial Graphic. You must always embed the custom client control.
154
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Carousel Widget
A carousel widget allows you to cycle through elements —images or slides of text—like a carousel,
without any input. This widget can be used to display dashboards, alerts or alarm information on large
monitors on the plant floor.
Properties
In addition to the standard graphics properties, you can also configure properties specific to the widget,
under Widget Properties.
Name Description Default
Autoplay If the Autoplay property is set to true, the carousel widget True
will automatically start on load. If it is set to false, the user
must select the next item to start the carousel.
BackgroundColor Sets a background color for the widget. Specify the color White
155
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
QR Code Scanner
The QRCode_Scanner widget connects to a camera to scan for a QR code and returns the resulting
string.
Properties
Property Name Description Default Value
156
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
AutoStop If set to true, the camera will stop after scanning a QR True
Code.
BackgroundColor Sets the background color of the widget. Specify the Black
color value in RGB, HTML Code (#FF0000) or valid
HTML color name.
Limitation
The device must have a camera.
Using the QR Code on a physical machine instead of a virtual machine is recommended.
Access the web client using the secure URL (https://) when using the web client remot ely.
Usage
You can configure a script to read the QR code and display a graphic based on the scanned value.
In RunTime, the QR Code Scanner widget will appear with a floating toolbar wit h the following buttons -
AutoStart, AutoStop and StartStop
When the widget is loaded, the camera will start automatically if AutoStart is set to True. To leave the
camera on, click AutoStop.
To manually start the camera, click StartStop and scan the QR Code.
The camera will stay on after you scan the QR code, allowing the user to scan additional QR codes. To
stop the camera, click StartStop.
The floating toolbar will display the QRCode derived from the QR Code scanned by the camera.
The user can script an action based on the QRCode returned.
157
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: No progress bar or progress information window appears during the import. An information
window opens when the import successfully complet es.
Note: The version or filename or either .dll have no affect on method conflict detection.
158
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Upon import, conflicting methods will be displayed in the Import Sript Function Library dialog box:
In this example, the Math::Int32 Add(Int32, Int32) exists in the current library and contains t he
same class, method name and parameters as a method in t he importing library. It is marked " Replace" in
the "Proceeding will" column. Proceeding with the import will replace the entire script library in the
application with the importing library.
The Math::132 Subtract(Int32, Int32) is marked "Remove" because the importing library does
not contain the subtract method. Script method conflict resolution requires replacing the entire script
library, which will also result in the removal of this method if it is not in the importing library.
You cannot cancel the import of an individual method that would remove an existing method from the
library, as in the example above. You must proceed with all the conflicting met hods or canc el the entire
import.
Important: Only .NE T class library files can be detected as duplicates at time of import. .aaSLIB library
and .wdf script extension files will not import if they conflict with methods in the existing library. In this
case, no notification of the conflict will be given.
Important: This section describes the workflow within WindowMaker to access a application’s style
libraries. For more information about editing application styles, see WindowMaker online help or the
Industrial Graphic Editor Us er Guide.
159
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: WindowViewer can run only one application at a time. If a platform is deploy ed on a local node, the
configured styles of the Galaxy will take precedence over any configured styles in any other standalone
or managed applications.
160
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. From the File menu, select Import and then Application Style Library.
The Import Application Style Library dialog box appears with fields to specify a file name.
3. Select the folder where the exported XML file is located and select it to show the name of the export
file in the File Name field.
4. Click Open.
A dialog box confirms that the Application Style Library was imported successfully.
Important: This section describes the workflow within WindowMaker to map alarm priority ranges to
alarm severities. While InTouch does not have built-in Alarm Severity management as does Application
Server, users can make use of InTouch tags to implement Alarm Border animation. In this case, the
priority to severity mapping in the dialog box is used only as a visual aid to associate priorities to alarm
border colors and alarm indicat or icons. For more information about configuring alarm priority mapping
and alarm shelving, see WindowMaker online help or the Industrial Graphic Editor User Guide.
3. In the From Priority and To Priority Range fields, click and enter numbers from 1 to 999 to set the
lower and upper boundaries of an alarm priority range for each alarm severity.
Each priority range should be contiguous without overlap between priority ranges. Alarm severity 1
starts at priority 1 by default.
4. In the Shelve column, select or clear the check box to enable alarm shelving for each alarm severity.
5. Click OK to save your changes.
Your changes are saved to the application’s application folder.
161
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
163
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. Select the symbols from the Industrial Graphic Toolbox whose localization strings you want to
export.
o Left-click on a symbol name to select a single symbol.
o Press the Ctrl key and left-click on symbol names to select two or more symbols.
o Left-click on a symbol name and then press the Shift key and left -click on another symbol name
to select all symbols between the two selected symbols.
3. Right -click on a selected symbol to show the shortcut menu.
4. Select Export, then Localization, and finally Selected Symbols(s)....
The Export Locale Data dialog box appears.
164
Exporting and Importing InTouch ComponentsAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
On completion, the Industrial Graphic Library and the Situational Awareness Library appear in the
Industrial Graphic Toolbox.
165
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 9
Securing InTouch
About Securing InTouch
You can protect your InTouch applications using:
Traditional InTouch-bas ed security
Operating system-based security
ArchestrA-based security
The following figure shows the relationship between the three types of security.
167
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
A timer measures the period the operator has not interacted with the running InTouch application. The
timer resets each time the operator uses a mouse or any other input device to enter data. If the timer
expires, the user is automatically logged off.
Note: The inactivity timer does not res et for Active-X controls, and OLE Aut omation controls.
168
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. In the Inactivity area, configure the warning and time -out values. Do the following:
o In the Warning box, type the number of seconds that can elapse before the $InactivityWarning
tag is set to 1.
o In the Timeout box, type the number of seconds that can elapse before the $Inactivity Timeout
tag is set to 1 and the user is automatically logged off.
3. Click OK.
4. To show a window named "Warning - Logoff Pending" after the inactivity warning time elaps es,
create a condition script with "$InactivityWarning" as the condition and the following script body:
Show "Logoff Pending";
5. To show a window named "Logged Off" after the inactivity timeout elapses, create a condition script
with "$Inactivity Timeout" as the condition and the following script body:
Show "Logged Off";
169
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: The inactivity timer does not res et for ActiveX controls, OLE and aut omation controls.
Data Type
Discrete (read only)
See Also
$InactivityWarning
Example(s)
The following example is an "on true" condition script:
If $InactivityTimeout == 1 THEN
Show "Logged Off";
ENDIF
See Also
$InactivityWarning
Note: The inactivity timer does not res et for ActiveX controls, OLE automation controls, and SPC
wizards.
Data Type
Discrete (read only)
Example(s)
The following example is an "on true" condition script.
If $InactivityWarning == 1 THEN
170
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
171
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
172
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Include the EnableDis ableK eys() function within the script to enable/disable the ALT, ESC, and WIN
keys. The EnableDisableKeys() function enables or disables system keys based on the discret e
values of its arguments:
EnableDisableKeys(AltKey,EscKey,WinKey);
An argument value of 1 enables the key filter to disable the key.
EnableDisableKeys() Function
Enables/disables key filters for the Alt, Escape, and Windows keys.
Category
View
Syntax
EnableDisableKeys(AltKey, EscKey, WinKey);
Parameters
AltKey
Integer to enable or disable key filters for the Alt key:
1 = enable filter (disable Alt key)
0 = disable filter (enable Alt key)
EscKey
Integer to enable or disable key filters for the Escape key:
1 = enable filter (disable Esc key)
0 = disable filter (enable Esc key)
WinKey
Integer to enable or disable key filters for the Windows key:
1 = enable filter (disable Win key)
0 = disable filter (enable Win key)
Remarks
Disabling the Alt key also disables the Win+L key combination (for locking the Windows desktop). Win+L
is the shortcut for another combination of keys that involves the Alt key. Thus, disabling the Alt key also
disables the shortcut for locking the Windows desktop.
Disabling the Esc key disables it for all actions.
Example(s)
EnableDisableKeys(0,0,0); // enable all three keys
EnableDisableKeys(1,1,1); // disable all three keys
EnableDisableKeys(0,0,1); // enable Alt and Escape keys, disable Windows key.
173
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. In the Menus area, select the WindowViewer menus and commands that you want to be visible t o an
operator. Do the following:
o Clear the WindowMaker check box to make the WindowMaker command unavailable from the
WindowViewer File menu. Clearing this option does not affect the fast switch to WindowMaker.
o Clear the Logic check box to hide the WindowViewer Logic menu that contains commands to
start and stop QuickScripts.
Note: You can use the $LogicRunning system tag to enable the operator to start and stop all
QuickScripts.
If you select the Allow CTRL-Break to stop scripts option, the operat or can stop all QuickScripts from
running regardless of whet her the Logic menu appears or not.
Currently executing asynchronous QuickFunctions cannot be stopped. However, you can prevent
operators from starting new asynchronous QuickFunc tions.
o Select the Debug check box if you are testing your application. Otherwise, clear the Debug
check box to hide the Debug menu during run time.
174
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o Clear the Special menu items to prevent operators from stopping ongoing InTouch functions like
logging and I/O connections.
o Clear the Security check box to prevent operators from changing security related options.
4. In the Window area, select the window controls that you want to make available to an operator from
WindowViewer. These options affect the window that is running the InTouch application. Do the
following:
o Clear the Control Menu check box to hide the controls that close, minimize, maximize, and
resize the window.
o Clear the Minimize Box check box to prevent an operator from minimizing the window.
o Clear the Maximize Box check box to prevent an operator from maximizing the window.
o Clear the Size Control s check box to prevent an operator from resizing the window.
5. In the Title bar area, configure the title bar of the window running the InTouc h applic ation. Do the
following:
o In the Title Bar Text box, type a title to be shown in the WindowViewer title bar.
o Select the Show Application Directory check box to include the path to the InTouch
application's folder in the title bar.
o Select the Hide Title Bar check box to hide the window’s title bar.
6. In the Mi scellaneous area, do the following:
o Select the Impossi ble to Close check box to prevent an operator from closing the
WindowViewer window running the InTouch application. Selecting this option disables the
window’s Close button.
If you want to hide the Close button, clear the Control Menu check box in the Window area.
o Clear the Allow CTRL-Break to stop scripts check box to disable the CTRL + BREAK key
combination that enables operators to stop QuickScripts.
Note: Currently executing asynchronous QuickFunctions cannot be stopped. However, you can prevent
new asynchronous QuickFunctions from exec uting.
o Select the Hide Cursor check box to hide the mouse pointer during run time. This is useful if you
are designing the application for a touc h-screen.
o Select the Always Maximize check box to keep the window running the InTouch application fully
maximized on the operator’s screen.
7. Click OK.
8. Restart WindowViewer to apply your changes.
175
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Authorization is the proc ess of determining if an authenticated user has access to the requested
resources. Typically, access to InTouc h functions is grant ed bas ed upon the user’s membership in a
group or assigned access level.
176
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Operating system-based security uses the InTouch AddP ermission() script function to define and
maintain a list of users and their corresponding access levels. This list, created after the execution of the
AddPermission() call, is written to disk. The file containing the authentication details of users is not
copied to NA D client nodes.
The operator can log on to the application by executing the Log on menu command under Security in
the WindowViewer Special menu (if the Special menu is shown), or you can create a custom log on
window with touch-sensitive input objects that are linked to internal security tags.
The commands used to establish security on an application are located under Security on the Special
menu in both WindowMaker and WindowViewer. The security commands are used to log on and off t he
application, change passwords, and to configure the list of valid user names, passwords, and access
levels.
For example, you can control access to a window, the visibility of an object, and so on, by specifying the
logged on operat or's access level must be greater than 2000.
177
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Configure the InTouc h application to use either InTouch OS or A rchestrA OS security. The ArchestrA
security can be either user-based or group-based. You configure ArchestrA security using the
ArchestrA IDE. For more information, see the ArchestrA IDE documentation.
Join the WindowViewer comput er to the correct domain for your net work.
Within WindowMaker, enable Smart Card authentication for the InTouch application. For more
information, see Enabling Smart Card Aut hentication in WindowMak er on page 178.
Configure the Smart Cards for the domain where you will use them.
Install card drivers on the WindowViewer computer. Smart Card and their drivers are
hardware-specific. For information on installing and setting up your Smart Card reader, refer to the
documentation for your specific reader.
Connect the Smart Card reader to the appropriate port of the WindowViewer computer. For
instructions, see the documentation that comes with the Smart Card.
o More than one Smart Card reader is required to perform verified write functions, which involve
more than one user.
o To use Smart Card with Terminal s erver and RDP clients, a Smart Card reader must be attached
to the client systems to enable Smart Card authentication. To connect a Smart Card reader to a
Terminal Server using RDP, you need to make sure that the RDP client connection settings have
the Smart Card option enabled under Local Devices and Re source s.
Note: If you click Arche strA, be sure that you have c onfigured ArchestrA OS security (OS user-based or
OS group-based) using the ArchestrA IDE.
3. On the Special menu, click Smart Card Authentication so that a check mark appears. By default,
this is not checked.
178
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. On the Special menu, point to Security, and then click Log On. The Login dialog box appears.
If you have inserted your smart card, your log on certificate—the domain and the user name—is
shown in the dialog box.
The smart card log on dialog box also appears if the LogonCurrentUser() or PostLogonDialog()
functions execute from scripts in WindowViewer. These functions are available only in InTouc h
scripting, not in ArchestrA client scripting.
4. In the PIN box, enter the PIN for the smart card being used
If a smart card is not available, the system will prompt you to log on with your user ID and password.
5. Click OK. You are logged on to WindowViewer.
Note: Aft er you log on as a smart card user, you must keep the card in the smart card reader. If you
remove it, the system logs you off.
Important: For Galaxies that have security enabled and are migrated to Application Server version 3.5,
the "Can Modify Operate Attributes" operational permission setting will be copied to the "Can Verify
Writes" attribute. Starting with Application Server 3. 5, Galaxies have the "Can Veri fy Writes" operational
permission setting disabled by default.
179
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Within InTouch Tag Viewer, a run-time user can only writ e to an indirect tag with a reference to an
ArchestrA attribute.
You can use smart cards for authentication for secured and verified data writes. For more information,
see Using Secured and Verified Writes on page 179.
2. Add a comment for the write action by selecting from the predefined Comment list or by entering a
comment in the Comment text box. The comment is limited to 200 characters.
You can predefine a list of comments using the SignedWrite() script function, or you can enter a new
comment in the Comment text box. The predefined comments list is only accessible when using the
SignedWrite() script function.
3. If you are authenticating using a network user account, the user account options are shown.
Do the following.
a. In the Username box, type your user name. The name of the currently logged -on user is shown
by default. If no user is currently logged on, the box is blank.
b. In the Pa ssword box, type the password associated with the user name.
c. In the Domain box, type the domain name.
180
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
d. Click OK.
4. If you are authenticating using a smart card, the smart card options appear.
181
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If you have only one smart card reader available, you can use one smart card reader with one smart
card for the Operator or for t he Verifier. When the Operator logs on using certificate number and P IN,
the Verifier needs to log on using the us ername and password or vice versa.
You can use username and password aut hentication for both the operator and the verifier.
To perform a verified write
1. Attempt to Modify the value of an attribut e configured with the Verified Write security classification.
The Verified Write dialog box appears. The Mode buttons are disabled if no smart card is available.
2. Add a comment for the write action by selecting from the predefined Comment list or by entering
your own comment in the Comment box. The comment is limited to 200 characters.
The predefined comments list is only accessible when using the SignedWrite() script function.
3. If you are authenticating using a network user account, the user account options are shown.
Do the following.
a. In the Username box, type your user name. The name of the currently logged -on user is shown
by default. If no user is currently logged on, the box is blank.
b. In the Pa ssword box, type the password associated with the user name.
c. In the Domain box, type the domain name.
d. Click OK.
e. To Authenticate using a smart card instead, click the Certificate button. Go to Step 4.
182
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. If you are authenticating using a smart card, the smart card options are shown.
You can use the SignedW rite() script function to configure the following in the Secured Write or Verified
Write dialog box:
Show a reas on message
Populate the predefined Comment list
183
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If the value is modified using the SignedWrite() function, then the Secured or Verified Writes dialog
box shows options based on the parameter settings from the function.
If the value is modified by a user operation, then the reason message area shows the field attribute
description, if there is one. If the attribute is not a field attribute or does not have a desc ription, then
the reason message area shows the description of the ApplicationObject to whic h the attribute
belongs. The predefined Comment list is not available.
You can view the reason message in the Secured Write or Verified Write dialog box when you try to
modify the value of the attribute in InTouch WIndowViewer. The dialog box displays the name of the
attribute and the new value that is written to the attribute.
Note: The reason description and the predefined Comment list and box are shown in the Secured Write
or Verified Write dialog box only in InTouch WindowViewer and not in Tag Viewer.
Note: The $ConfigureUsers tag only works if the security type is set to InTouch. It does not work for
ArchestrA-based and operating system based security.
184
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
a. In the User Name box, type the name that you want to assign to the operator.
b. In the Pa ssword box, type an operator password up to a maximum of 29 characters.
c. In the Access Level box, type the operator’s access level (lowest = 0 to highest = 9999).
d. Click Add to add the user name to the InTouch security list.
5. To change a user name, select the name, mak e any changes, and then click Update.
6. To delet e a user name, select the name and then click Delete.
7. Click OK.
185
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
AddPermission() Function
Assigns a certain InTouch access level to a given user group on the local system or on the domain. When
a user belonging to t hat group logs on to t he InTouch HMI after t he AddPermission() function is called, he
or she receives the specified access level.
Category
security
Syntax
DiscreteTag=AddPermission( "Domain", "Group", AccessLevel);
186
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Arguments
Domain
Name of the domain or local computer in which the group is located.
Group
Windows user group.
AccessLevel
InTouch access level that you want to associate with the given group.
Remarks
Valid for operating system security only. When this function is called, it checks for the presenc e of the
specified group in the specified domain or workgroup. If successful, TRUE is returned, and the specified
Access Level is associated with the group for subsequent user log ons. In all other cases, (that is, if an
invalid value is specified for any of the arguments) FALSE is returned.
This function is typically configured to run on application start up. It does not affect users that are currently
logged on. Only users that log on after AddPermission() is successfully called receive the access level
associated with their group.
Examples
DiscreteTag=AddPermission( "corporate_hq", "InTouchAdmins", 9000);
DiscreteTag=AddPermission( "johns01", "InTouchUsers", 5000);
See Also
PostLogonDialog(), InvisibleVerifyCredentials(), IsAssignedRole(), AttemptInvisibleLogon(),
QueryGroupMembership()
ChangePassword() Function
Shows the Change Password dialog box, allowing the logged on operator to change his/her password.
Category
security
Syntax
[Result=]ChangePassword();
Return Value
Returns one of the following int eger values:
0 = Cancel was pressed.
1 = OK was pressed.
Remarks
If the operat or uses a touch screen, the operator can use the alphanumeric keyboard to enter the new
password.
Example
The following script can be plac ed on a button or called from a condition script or data change script.
Errmsg=ChangePassword();
187
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Category
security
Usage
$AccessLevel
Remarks
The value for this tag is determined by the access level assigned to the currently logged-in user's security
profile within the InTouch HMI. This profile can be accessed using the Configure Users menu in
WindowViewer.
The actual numeric value of $AccessLevel has no meaning to WindowViewer, except that a value of
9000 or greater indicates administrative privileges and enables the Security menu within
WindowViewer. Use the $AccessLevel system tag to further customize security within the system.
Data Type
Integer (read only)
Valid Values
0 through 9999
Example(s)
The following statement is used for t he visibility link to make an object, such as a button, visible based on
the logged on user's access level:
$AccessLevel >= 2000;
{Objects can have a "disable" link associated with them, with the expression based
on $AccessLevel.}
$AccessLevel < 5411;
IF $AccessLevel <=500 THEN
Show "Access Denied"; {popup window denying access}
ELSE
Show "Access Granted"; {popup window granting access}
ENDIF;
See Also
$Operat or, $OperatorEntered, $PasswordEntered; $ConfigureUsers
188
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Valid Values
1
Example(s)
You can create a discrete push button that opens the Change Password dialog box. Assign a single
discrete push button link, with the Set option selected, to the push button. When the button is pressed,
the $ChangeP assword system tag is set to 1, and the Change Password dialog box opens.
See Also
$AccessLevel, $OperatorEntered, $PasswordEntered, $Operator, $ConfigureUsers
189
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: You can also show the Log On dialog box using the PostLogonDialog() function. For more
information, see PostLogonDialog() Function on page 191.
To log on to an application
1. On the Special menu, point to Security, and then click Log On. The Log On dialog box appears.
2. In the Name box, type your user name.
3. In the Pa ssword box, type your password.
4. Click OK.
190
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: The $ConfigureUsers tag only works if the security type is set to InTouch. It does not work for
ArchestrA-based security.
PostLogonDialog() Function
Shows the InTouch Logon dialog box and returns TRUE.
Category
security
Syntax
DiscreteTag=PostLogonDialog();
Examples
DiscreteTag=PostLogonDialog();
See Also
InvisibleV erifyCredentials(), AttemptInvisibleLogon(), IsAssigne dRole(), QueryGroupMembership(),
AddPermission()
191
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
LogonCurrentUser() Function
Logs on to InTouch with a user account that is currently logged on to the Windows operating system.
InTouch configured with OS security: the user is logged on to WindowViewer.
InTouch configured with Arc hestrA security: the user must be a member of ArchestrA OS user-based
or OS group-based security.
InTouch configured with A rchestrA OS user -based or OS group-based security and the user account
is configured with smart card credentials: user is logged on using the smart card credentials. The
user is logged off if the smart card is removed from the reader.
Category
security
Syntax
IntegerResult = LogonCurrentUser();
Return Value
Returns -1 and no change to the values assigned to $Operator, $OperatorName, $OperatorDomain, and
$AccessLevel if the logon fails.
Remarks
This function is available only in InTouc h scripting, not in ArchestrA client scripting.
Example
IntegerResult = LogonCurrentUser();
See Also
PostLogonDialog(), InvisibleVerifyCredentials(), IsAssignedRole(), AttemptInvisibleLogon(),
QueryGroupMembership(), AddPermission()
Logoff() Function
Logs the user off from an InTouch application.
Category
security (write only)
Syntax
DiscreteTag = LogOff();
Remarks
Logs off the currently logged on user and sets the current user status to the default none operator.
Example
DiscreteTag = LogOff();
See Also
PostLogonDialog(), InvisibleVerifyCredentials(), IsAssignedRole(), AttemptInvisibleLogon(),
QueryGroupMembership(), AddPermission()
AttemptInvisibleLogon() Function
The AttemptInvisibleLogon() function can be used in a script to log on a user to InTouch using the
supplied credentials. The us er is not required to enter a password or user ID.
192
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Category
security
Syntax
DiscreteTag=AttemptInvisibleLogon( "UserId", "Password", "Domain" );
Arguments
UserId
A valid user account name.
Password
Password of the user.
Domain
Name of the local c omput er, work group, or domain to which the user belongs. This argument applies
only if the current security type is operating system-based.
Return Value
Returns TRUE if authentication is successful. Otherwise, it returns FALSE.
Remarks
An attempt is made to log on to the InTouch HMI using the supplied credentials.
If the logon attempt succeeds, then TRUE is returned and the $OperatorDomain, $OperatorName,
$AccessLevel, and $Operator system tags are updated accordingly.
If the log on attempt fails, then FA LSE is returned, and the currently logged on us er (if any) continues
to be the current user.
The Domain argument is only valid for operating system-bas ed security. If ArchestrA security mode is in
use and if ArchestrA security is in turn using operating system-based security, the UserId argument
should contain the fully qualified user name with domain name or computer name.
Examples
When security is operating system-bas ed:
DiscreteTag=AttemptInvisibleLogon("UserId", "Password", "Domain" );
When security is either InTouch-based or ArchestrA-based:
DiscreteTag=AttemptInvisibleLogon("UserId", "Password", "" );
See Also
PostLogonDialog(), InvisibleVerifyCredentials(), IsAssignedRole(), QueryGroupMembership(),
AddPermission()
193
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: When the $OperatorEntered system tag is valid, $AccessLevel and $Operator system tags are set
to their pre-defined values.
Data Type
Message (write only)
See Also
$AccessLevel, $Operator, $PasswordEnt ered, $ChangeP assword, $ConfigureUsers
Note: When the $PasswordEntered is valid, the $AccessLevel and $Operator system tags are set to
their pre-defined values.
Data Type
Message (write only)
See Also
$AccessLevel, $Operator, $OperatorE ntered, $ChangePassword, $ConfigureUs ers
194
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
See Also
$Operat or
By using this expression, the object or button is secured from tampering if no one is logged on.
InvisibleVerifyCredentials() Function
The InvisibleVerify Credentials() function can be used in a synchronous QuickScript to verify the
credentials of the given user without logging the user on to the I nTouch HMI.
Category
security
Syntax
AnalogTag=InvisibleVerifyCredentials( "UserId", "Password", "Domain" );
Arguments
UserId
Windows operating system user account name that is part of local computer, work group, or domain.
Password
Password for the account.
Domain
The Windows domain for the account.
Remarks
If the supplied combination of user, password, and domain are valid then the corresponding access level
associated with the user is returned as an integer. Otherwise, -1 is returned.
195
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: The InvisibleVerifyCredentials() function must be run from a synchronous QuickScript. The
function always returns -1 if run from an asynchronous QuickScript.
This function does not change the currently logged on user. The Domain argument is onl y valid for
operating system-based security. If ArchestrA security is in use and if ArchestrA security is in turn using
operating system-based security, the UserId argument should contain the fully qualified user name with
domain name or computer name.
Example
AnalogTag=InvisibleVerifyCredentials( "john", "Password", "corporate_hq" );
See Also
PostLogonDialog(), Attempt InvisibleLogon(), IsAssignedRole(), QueryGroupMembership(),
AddPermission()
GetAccountStatus() Function
Returns the number of days until the user’s password expires.
Category
security
Syntax
Result=GetAccountStatus(Domain, UserID);
Arguments
Domain
Name of the domain or local computer in which the us er account is located.
UserI D
Windows user account name that is part of the loc al computer, workgroup, or domain.
Return Value
This function also returns the following values:
Result Description
-4 Account disabled
Remarks
Use this script function wit h operating system-based security. Do not use this function with the ArchestrA
security mode.
196
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If the GetAccountStatus() function is used with ArchestrA security, the script attempts to retrieve the
account information directly from the domain controller. This works as long as the ArchestrA Galaxy
Repository is using operating system security with the same domain.
Example(s)
Status = GetAccountStatus("Corporate_HQ","Operator");
IsAssignedRole() Function
Determines whether the currently logged on user is a member of the s pecified user role. Only applies to
ArchestrA security.
Category
security
Syntax
DiscreteTag=IsAssignedRole( "RoleName" );
Arguments
RoleName
The role associated with an Application Server us er.
Remarks
Valid for ArchestrA security mode only and applies to the currently logged on us er. If a user is currently
logged on and has the RoleName role assigned in the Galaxy IDE, then TRUE is returned. Otherwise,
FALSE is returned.
Example
DiscreteTag=IsAssignedRole( "Administrators" );
See Also
AttemptInvisibleLogon(), PostLogonDialog(), InvisibleVerifyCredentials(), QueryGroupMembership(),
AddPermission()
QueryGroupMembership() Function
Determines whet her the currently logged on user is a member of the specified user group. Only applies
to operating system security.
Category
security
Syntax
DiscreteTag=QueryGroupMembership( "Domain", "Group" );
Arguments
Domain
Name of the domain or local computer in which the group is located
Group
Name of the group.
Remarks
Valid for operating system security mode only and applies to the currently logged on us er. If a user is
currently logged on and if he or she is part of the group located on the domain, then TRUE is returned.
Otherwise, FALSE is returned.
197
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The QueryGroupMembership() function works with operating system-based security and with ArchestrA
security only when the ArchestrA security is set to operating system-based security.
Examples
DiscreteTag=QueryGroupMembership( "corporate_hq", "InTouchAdmins" );
DiscreteTag=QueryGroupMembership( "JohnS01", "InTouchUsers" );
See Also
PostLogonDialog(), InvisibleVerifyCredentials(), IsAssignedRole(), AttemptInvisibleLogon(),
AddPermission()
198
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Operating System
Arche strA
InTouch Security Security Security
$ConfigureUsers Yes No No
199
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Operating System
Arche strA
InTouch Security Security Security
AddPermission() No Yes No
ChangePassword() Yes No No
IsAssignedRole() No No Yes
New Application No
Launch WindowMak er No
200
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
DBLoad No
DBDump No
Delet e Application No
Rename Application No
Application Properties No
Export as Template No
Import Application No
Node Properties
Memory Settings No
Performance No
Refresh Yes
Views Yes
201
Securing InTouch AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Show Header No
Enable NavBar No
User Name No
Password No
Secure Gateway No
202
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 10
Switching a Language at Run Time
About Switching a Language at Run Time
You can develop applications that can be switched to another language at run time.
To enable run-time language switching, you must complet e the following tasks:
Configure multiple languages for the application.
Export your application text for offline translation.
Translat e one or more exported dictionary files.
Import one or more translated dictionary files.
As part of the setup for run-time language switching, you can also localize alarm comments and alarm
fields. In addition to switching the run-time language of text strings, you can also configure run-time
language switching of alarm comments, alarm states, alarm types, and alarm classes in the Alarm
Viewer and Alarm DB View controls.
Note: If you are using language switching in combination with Network Application Development (NAD),
we recommended that you set the change mode to "Restart WindowViewer" or "Prompt user to restart
WindowViewer" instead of "Load changes into WindowViewer" or "Prompt user to load changes into
WindowViewer" for the NAD client node.
The Configure Languages dialog box shows the base language of the application.
3. Click Add. The Add Language dialog box appears.
203
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Specify the language and font settings. Configuring the font settings defines the default font
properties of your translated text.
o In the By Name or the Locale ID list, click the language to add. If you select the language by
name, the corres ponding locale ID appears in the Locale ID list, and vic e versa.
o Click Font. The Font dialog box opens. Configure the font and then click OK.
5. Click OK to close the Add Language dialog box. The language you configured is listed in the
Configure Languages dialog box.
204
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the Special menu, point to Language, and then click Configure Languages. The Configure
Languages dialog box appears.
3. In the list of languages, select the target language, and then click Modify Font. A standard Windows
Font dialog box appears.
4. Make your changes and then click OK.
5. Click OK to close the Configure Languages dialog box.
205
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
5. In the Touch Pushbuttons area, click Action. The Touch -> Action Script dialog box appears.
6. Double-click anywhere in the script area of the Touch -> Action Script dialog box. The Select Tag
dialog box appears.
Note: You can also us e the script function SwitchDisplayLanguage(LocaleID) instead of the $Language
tag.
206
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
SwitchDisplayLanguage() Function
Switches the display of visible, static texts and alarm fields in a desired language for which translated
strings are provided.
Category
misc
Syntax
SwitchDisplayLanguage(LocaleID);
Parameter
LocaleI D
The language in which static text strings and alarm fields are to be shown at run time.
Example(s)
In this example, German is the language to be shown at run time.
SwitchDisplayLanguage(1031);
See Also
$Language system tag
Note: The $Language tag is configured as a local tag to allow independent language switching in the
Web Client. Multiple user sessions can view the web client in different languages. The change in
language in the web client will not affect the language selected in WindowViewer and vice versa.
Category
system
Data Type
Integer (read / write)
207
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Text on wizards.
You cannot export the dictionary until you close all windows in WindowMaker. If you make changes to
your application after you export your dictionary files, you must export the dictionary file again. For more
information, see Exporting Text to an Existing Dictionary File on page 208.
You can only export the text strings for one language at a time. By default, the InTouc h HMI opens the My
InTouch Applications folder. If you choose any other folder, the InTouch HMI then defaults to that path.
Creating a new folder to export phrases for e ach language makes it easy to manage dictionary files. For
example, ...\My InTouch Applications\My German Files\.
The InTouch HMI creates a dictionary file for your application and a separate dictionary file for each
SmartSymbol within the application. The application dictionary name has a format of application
name_localeID whereas SmartSymbol dictionary files have a format of SSD_Name of the
Symbol_localeID_GUID.
When you export the dictionary for an application, the file is an .xml file that you can edit using Microsoft
Excel 2003 or later.
To export application text for offline translation
1. Start WindowMaker and open the application for which you want export text strings for offline
translation.
2. On the Special menu, point to Language, and then click Export Dictionary. The Export Dictionary
dialog box appears.
208
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If you export more than one time to the same directory, the Confirm File Replace dialog box appears.
If you click Yes, the existing .xml files are updated with any new strings and language information added
since you export ed last. If the existing dictionary file contains translations for any phrases and you
imported it to the InTouch HMI previously, those translations a re preserved. If you deleted any phrases
from the application since the last export, they are removed from the dictionary file.
3. Click OK.
The XML file opens in Excel with columns for the:
o Phrases in your application.
o Translat ed phras es from the translator.
o Translat ed font name.
o Translat ed font properties.
o Translat ed font size.
o Base font properties.
o Base font size.
209
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Type the language-specific text in the Translation column in the row that corresponds with the base
language string in the Phrase column.
5. If necessary, change the font parameters for the translated strings to fit the text in the space allowed
in WindowViewer.
o In TranslatedFontName column, type the font name.
o In the TranslatedFontP roperty column, type the not ation for the font properties:
B = bold
I = italic
U = underline
For example, if you want to the text to be bold, type B in the TranslatedFontProperty column. If
you want the text to be bold and underlined, type BU in the TranslatedFontProperty column.
6. Save the file using XML Data as the file type.
Important: If you save as another file type, such as XML Spreadsheet, Excel changes the schema and
the InTouch HMI cannot load the file. If you change the name of the XML file, run-time language
switching does not work.
210
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the Special menu, point to Language, and then click Import Dictionary. The Import Dictionary
dialog box opens.
Caution: Before exporting alarm and tag comments, back up any files in your target directory in case of
possible dat a corruption or errors.
211
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
2. On the Special menu, point to Language, and then click Export Alarm Fields. The Export Alarm
Fields dialog box appears.
3. In the Path box, type the folder to which you want to export the dictionary. Click Browse to select an
existing folder or create a new folder.
4. In the Two characters representing Unique application box, type the two characters. The ID can
only contain alphanumeric characters and it is case-sensitive.
Caution: If you previously exported alarm or tag comments from this application, you must use the same
two-character application ID when you export them the next time. If you enter a new two -character
application ID, the InTouch HMI regenerates the IDs for all the alarms and tags, which causes all existing
translations to be lost.
Note: If the size of the alarm comment configured in the t ag dictionary is greater than 127 characters
or the tag comment is greater than 46 characters, the alarm or tag comment is not exported. You are
notified that the comment was not exported to the dictionary file at the end of the export process and
an AlarmComment.log or TagComment.log file is created in the export directory.
6. Click Close to return to the WindowMaker window or click Close and Launch Explorer to open the
folder containing the dictionary file.
212
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Click Yes to update the existing dictionary files wit h any new strings and language information added
since you export ed last. If the existing dictionary file contains translations for any phrases and you
imported it to InTouch previously, those translations are preserved. If you deleted any phrases from the
application since the last export, they are removed from the dictionary file.
Click Yes to All to update existing dictionary files for all languages configured in the InTouch HMI.
Click No or No to All to prevent overwriting the existing file or the existing files for all languages,
respectively.
The existing translations for any alarm comments, alarm fields and tag comments are preserved if they
are exported again.
Enter the translation for the translation strings. Do not change any of the other information.
You can override some of the Alarm State, Alarm Type, and Alarm Class values. The maximum allowed
length for these values is 50 characters.
The following Alarm State values can be overridden for InTouch generated alarms:
ACK_RTN ACK_RTN
ACK_ALM ACK_ALM
The following Alarm Type values can be overridden for InTouch generated alarms:
SPC SPC
HIHI HIHI
HI HI
213
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
LO LO
LOLO LOLO
MINDEV MINDEV
MAJDEV MAJDEV
ROC ROC
DSC DSC
OPR OPR
LGC LGC
DDE DDE
SYST SYST
USER USER
PRO PRO
LOGON_FAILED LOGON_FAILED
The following Alarm Class values can be overridden for InTouch generat ed alarms:
DEV DEV
ROC ROC
DSC DSC
EVENT EVENT
VALUE VALUE
214
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
3. In the Path box, type the path to the dictionary file to import or click Browse to browse and select the
file.
4. Click Import. If there is no translation done in the dictionary file, a dialog box appears saying that
there are no translated dictionary files to import.
5. Click OK. If the import is successful, the Import Successful dialog box appears.
215
Switching a Language at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
216
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 11
Viewing Applications at Run Time
About Viewing Applications at Runtime
You use WindowViewer to run your InTouch applications. Applications that are designed specifically for
use in an ArchestrA Application Server environment are called InTouchView applications. You can us e
the InTouch Web Client to view Industrial graphics in any HTML5 supported web browser. These
applications run in WindowViewer, but the Application Server provides most of the HMI functionality.
Note: If the specified target res olution is less than the screen res olution, the width and height of the
runtime window cannot be adjusted beyond the specified target resolution. Maximizing the
WindowViewer window will enlarge it only to the maximum of the target res olution.
217
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
If the specified target resolution is greater than the screen resolution, vertical and horizontal scroll bars
will display at run time. Windows will scroll accordingly. Popup windows and popup graphics from
ShowSymbol animations and ShowGraphic scripts will not be scrolled.
Error messages and popup dialogs will display in the center of the application at its target resolution, not
the center of the screen. The same applies to keyboards and keypads.
218
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
About WindowViewer
WindowViewer provides the run-time environment for InTouc h applic ations. Based upon your
application’s operational requirements, you can configure how WindowViewer supports an applicati on.
For example, depending on your application’s security requirements, you can configure the menus and
commands available to operators from WindowViewer.
Note: Close WindowViewer before changing the Regional Formats of the Operating System.
1. Open WindowMaker.
2. On the Special menu, point to Configure, and then click WindowViewer. The WindowViewer
Properties dialog box appears.
219
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
220
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
When you select this option, the Close on Transfer to WindowViewer option located on the
WindowMaker Properties/General tab is automatically selected too. If memory is not an issue,
and you are using the fast switch to move between WindowViewer and WindowMaker, this
option should be cleared.
o Select the Close all open windows check box if you want all open windows to close
automatically when you trans fer from WindowViewer to WindowMak er.
6. In the Inactivity area, set warning and time-out periods for operator inactivity.
For more information about setting warning and time-out periods, see Configuring an Inactivit y
Time-Out on page 167.
7. In the Time/Timer Control area, do the following:
o In the Tick Interval box, type the interval that the InTouch HMI uses to check its internal timers.
This interval det ermines when Application While Running, Window While Showing, Condition
While On True/On False, Key and Touch Pushbutton Action While Down QuickScripts can be
started.
This option sets the value for TimerTickInterval paramet er in the INTOUCH.ini file. You should
set the Tick Interval no longer than 50 msec for a script scheduled to run every 100 msec. On
computers running Windows XP or Windows 2003, the lower tick interval is 10 msec.
o In the Update for Time Variables box, type the interval in milliseconds that time is updat ed for
system tags like $Msec, $Second, or $Minute.
We recommend that you use the default setting of 1000 milliseconds. Setting this option to zero
prevents time variables from being updated.
8. In the Mi scellaneous area, do the following:
o Select Beep when objects touched if you want the InTouch application to emit a beep sound
when operators select touch-sensitive objects on a window.
o Select Update all trends "Fa st" if you want your trend objects to be updated more quickly.
Select this option only if no objects overlap run -time trends on the application window. If you
select this option and any object overlaps a trend, the object can be drawn incorrectly.
o Select Debug Scripts if you want a message to be written to the Logger each time a QuickScript
runs.
If you select Debug from the Window Configuration property sheet, you can switch
QuickScript logging on and off from WindowViewer's Special menu.
o Select the Use old SendKeys check box if you are using an international application developed
with InTouch version 3. 26 or earlier.
9. In the Blink Frequency area, type the interval length in milliseconds for your Slow, Medium, and
Fast blink animation links.
10. In the I/O area, do the following:
o In the Retry Initiates box, type the number of seconds to wait before the InTouc h application
retries connecting to an I/O Server after a failed connection attempt. The I/O Retry Initiates box
has no effect when InTouch can successfully connect to the I/O server the first time.
o Select the Start local servers check box if you want a dialog box to appear when you start
WindowViewer and the I/O Server you are trying to communicate with is not running.
o Select the Reinitialize Default check box if you want to reinitialize Access Names with their
default settings. Current values assigned to Access Names are ignored and they are reinitialized
with their original settings.
11. In the Hotlinks area, do the following:
221
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o Select the Show Halo around Hotlink check box if you want an object on the run time screen to
be highlighted when the user moves the cursor over it.
o Select the Halo follows object shape check box if you want a highlight halo around the
contours of an object when the user moves the cursor over it.
o If you want a halo around Active X controls, select the Show halo around Active X control
check box.
12. In the Keyboard area, select the type of keyboard you want to use, if any.
For more information about setting keyboard options in WindowViewer, see Animating Objectsin the
InTouch® HMI Visualization Guide.
13. Click OK.
222
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Restart WindowViewer.
223
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The Remote Acce ss Properties dialog box appears with options to grant Read/Write or Read Only
access to the application open in WindowMaker. Read/Write access is the default.
224
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
225
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
d. In the In-Memory Window Expiration Time box, enter the maximum duration for which the
closed in-memory windows will remain in cache memory at run time. You can enter a value
between 0 and 8760 hours. The default value is 0 hours, which designates no time limit.
The memory limit or the expiration time limit is applied depending on which limit is reached first.
4. In the High Priority Window Caching area, do the following:
a. Select the Enable High Priority Window Caching check box to allow some windows to be
marked as high priority. These windows will always be kept in cached memory after they are
closed at run time.
b. In the Memory Limit for High Priority Windows box, enter the limit for keeping closed
high-priority windows in cac he memory at run time. The default memory limit is 90%. The system
removes the oldest in-memory window first, and then removes the oldest high -priority window
when the percentage of used memory exceeds this limit at run time.
c. In the High Priority Windows box, select the windows you want to mark as high priority.
5. Click OK.
Caution: Modify the wwHeap memory settings only if you are experiencing memory conflicts reported in
the SMC Logger.
You can configure the wwHeap Memory settings by specifying the wwHeap size and start location. The
default size, default start location, and allowable location range vary by operating system.
The default sizes are described in the following table:
32-bit 1519 MB
226
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
64-bit 2048 MB
The default locations and allowable loc ation ranges are described in the following table:
Default Start
Operating System Location Allowable Range
227
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. Do the following:
o In the Size box, enter the size of the wwHeap memory. You can enter any value between 1 MB
and 2048 MB.
o In the Start Location box, enter the start address.
5. To restore the default values, click Restore Default.
6. Click OK.
228
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Numbers that appear in Industrial Graphics can be shown in the format of the country set as the home
location with the Windows Control Panel’s Region setting. During run time, Industrial Graphic numeric
values can be displayed with thous ands and decimal separators that match the numeric format of the
country specified in the OS Regional Settings.
To set the advanced formatting properties
1. On the Special menu, point to Configure and then click WindowViewer. The WindowViewer
Properties dialog box appears.
2. Click the Advanced Format tab.
3. In the Real Formatting Decimal Precision area, enter the number of decimal places that you want
to be shown at run time for eac h real type number range.
4. In the Special Characters to Show at Runtime area, do the following:
o In the Bad Quality with No Value box, enter the character you want to be shown at run time
when the quality of the data point is bad and there is no last known good value. The default
character is !. You can enter any ASCII character, except a space.
229
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o In the Value Too Large for Fixed Width box, enter the character you want to be displayed at
run time when the value is too large to be displayed. The default character is *. You can enter
any ASCII character, except space.
5. To show numbers within Industrial Graphics in the format of the country specified by computer’s
Region setting, select the checkbox in the Regional Settings area.
By default, the Regional Settings option is disabled.
Note: WindowViewer checks the OS Regional Settings only on start up. This means that you may
need to restart WindowViewer if you do either of the following:
1) Select the Regional Settings option while WindowViewer is running.
2) Change the OS Regional Settings while WindowViewer is running with the Regional Settings
option selected.
230
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
To enable numeric formatting by regional locale, the Regional Settings option must be selected during
design time to format Industrial graphic numbers to the country selected in the Region setting. By
default, the Regional Settings option is disabled.
Note: WindowViewer checks the OS Regional Settings only on startup. This means that you may need
to restart WindowViewer if you do either of the following:
1) Select the Regional Settings option while WindowViewer s running.
2) Change the OS Regional Settings while WindowViewer is running with the Regional Settings option
selected.
231
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Set the Regional Locale of the Computer Hosting the HMI/SCADA Software
To enable numeric formatting by regional locale, the computer a ViewApp runs on must have its re gion
set to the country in which you want Industrial graphic numbers to be formatted.
The Region setting is accessible from the Windows Control Panel. If you want to display Industrial
graphic numbers in a non-U.S. format, select the Formats tab and select a country in the Format field.
232
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
4. To allow WindowViewer to use any available processor, click Allow WindowViewer to select from
all available processors.
5. To restrict the processors that WindowViewer can use, click WindowViewer is limited to use only
the processors selected below and then do any of the following:
o Make sure the CPU check box is selected for each processor you want WindowViewer to be
able to run on.
o Click Limit to 0 to only allow WindowViewer to run on processor 0. When you click this button,
the CPU 0 check box is automatically selected.
o Click Allow All to select all check boxes.
You can clear a selected processor at any time and select a new processor from the list. You can
also select multiple processors at a time. If you clear a processor check box, the WindowViewer
instance continues to run on that processor.
233
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
6. Click OK. WindowViewer starts on the next CPU based on the other View sessions.
Click Details to change from the list view to the details view. The det ails show the window's type and the
date and time when a window was last modified.
In the details view, you can select and deselect any unopened window by clicking on any portion of its
row, not just the check box. The entire row is highlighted when selected.
To open selected windows click OK.
To cancel your selections and close the dialog box, click Cancel.
To return the dialog box to list view, click List.
To select all listed windows, click Select All.
To clear all selected windows, click Clear All.
234
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
To sort the list in ascending or descending order, click the column header.
2. Click the check box next to the name of each window that you want to open.
3. Click OK to close the dialog box and open windows you selected.
Note: If a "Replace" type window is selected, it closes any windows that it intersects.
2. Click the check box next to the name of one or more windows that you want to close.
3. Click OK to close the windows you selected.
235
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Fast-switching is for rapid development testing only. Do not use it in a production environment. You can
hide the command for switching to WindowMaker.
To transfer from WindowViewer to WindowMaker
1. On the File menu, click WindowMaker. The Window s to Edit dialog box appears.
2. Click the check box next to the name of each window that you want to open when you trans fer to
WindowMaker.
3. Click OK to close the dialog box and transfer to WindowMaker.
Note: If the application developer selected the Close WindowViewer option when WindowViewer's
properties were configured during development, WindowViewer automatically closes when you transfer
to WindowMaker.
Working with Keyboard, Mouse and Touch Gestures to Pan and Zoom
at Run Time
Frame windows allow you to pan and zoom on Industrial Graphics at run time. This functionality is
enabled by the InteractionMode property in WindowMaker.
See the InTouch HMI Visualization Guide for additional information on configuring frames in
WindowMaker.
When ZoomPercent is set for a symbol, the symbol will be zoomed to t he set percent at the c enter of the
viewable area.
When ZoomPercent is set for a symbol’s element, the symbol will be zoomed to the set percent but will
center on the element.
The following script is an example of ZoomPercent set for an element:
TextBox1.ZoomPercent = 500
236
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: You cannot zoom in on the frame contents if your mouse point er is outside the frame.
Scroll down with the mouse wheel to zoom out on the frame contents.
Select the zoom in and zoom out icons from the Pan and Zoom Control Toolbar. You must then left
click on the contents of the frame to zoom in.
Double left mous e click on the frame contents to restore the zoom level to 100%
Use the Zoom Level combobox to select a predefined zoom level:
Select the Rubber Band Zoom icon from the Pan and Zoom Control Toolbar to select a specific area
to zoom in on.
To zoom with keyboard gestures:
Do the following:
237
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: For both panning methods, the horizontal and vertical scroll bars will adjust in accordanc e with the
pan directions.
238
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Panning Limitations
The following limitations apply:
panning is not supported using keyboard gestures
Window Controls can override mouse, keyboard and touch input. As a result, panning may be
disabled over areas with Window Controls.
Note: Industrial Graphic pop ups shown by the ShowSymbol animation or ShowSymbol script function
will have pan and zoom enabled by default. However, you cannot disable this configuration.
The following table lists action scripts commonly configured for touc h support.
Note: When touch interaction is used on an area wit h animation, the animation will t ake precedence over
panning actions and panning actions will be ignored. If one finger retains touc h interaction, any
subsequent touch points will be ignored.
To enable panning in this scenario,select the Pan icon in the Pan and Zoom Toolbar.
Touch Gesture Limitations
Some limitations apply to touch gesture functionality for run time panning and zooming. The below
functionality is not supported:
Scaling fonts for Windows Common Cont rols
239
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: Additionally, a symbol with an embedded windows control uses different mechanisms for scaling
than a symbol without a cont rol. A symbol with an embedded control has a maximum zoom limitation of
500%, while a symbol without a control can zoom up to 5000%. The advant age of a symbol without a
control is smoother scaling. An additional limitation of using symbols with embedded controls is, while
zooming is in progress, the control will flicker. This is particularly visible while zooming wit h touch
gestures.
You can use InTouch with Information Server in the following ways:
Process visualization
You can publish InTouch applications to the Information Server port al to show your production
process and controls through a Web browser.
Data interaction
You can use the Information Server portal to read values from and write back values to InTouch t ags.
This enables you to interact with your plant processes without using an InTouch client.
Alarm Display
240
Viewing Applications at Run TimeAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
You can use the Information Server portal to show InTouc h real time and historical alarm data.
Historical Data Display
You can use the Information Server portal to show InTouc h historical dat a saved in a Historian
database.
Table Weaver display
You can use InTouch to create displays for Table Weaver content units.
For more information, see the Information Server documentation.
241
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 12
Setting Up a Multi-Monitor System
About Setting Up a Multi-Monitor System
A multi-monitor system shows an InTouch application on several monitors simultaneously. Together, a
multi-monitor configuration creates a composite screen composed of all monitors connected to the
computer running an InTouch application. Each monitor can s how a portion of t he screen or only a single
window component like a keypad.
While running an InTouch application, you can move the mouse between monitors and drag windows
from one monitor to another. Also, in some multi-monitor configurations you can show an entire InTouch
application window across all monitors, as shown in the following figure.
Multi-Monitor Configurations
You can use two basic multi-monitor configurations.
Single video card
Multiple video card
Each configuration has unique hardware, software, and configuration requirements. Also, each
configuration supports a different set of multi-monitor features.
The composite screen resolution is the sum of the individual horizontal and vertical resolution of each
monitor. For example, a popular video card connects four 17 inch monit ors stacked as a c ube: two on the
bottom and two on the top. In the previous figure, each monitor runs at a screen resolution of 800 x 600
pixels. The composite virtual screen resolution is 1600 x 1200 pixels.
243
Setting Up a Multi-Monitor SystemAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
The single video card drives all monitors simultaneously to create a single, large screen.
The properties of all attached monit ors can be configured using a single set of screen values.
The composite screen shows the Windows taskbar across all of t he monitors in the bottom row of the
configuration.
Windows applications can be maximized to fit all monitors.
In this figure, the resolution setting is for four monitors arranged side by side in a single row. The
resolution for each monitor is 1024 x 768. Added together, the composite screen res olution is 40 96 x
768. You only need to configure a single monitor’s res olution, color depth, and refresh rate. The
resolution setting applies to all monitors connected to the single video card.
244
Setting Up a Multi-Monitor SystemAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
DRC enables each View node to scale the application to a number of user-defined options, including a
custom resolution. This scaling takes place while WindowViewer compiles the application and does not
require WindowMaker. Because each View node can use a different DRC setting, you must configure
each individual View node.
DRC makes it easy to support multi-monitor systems. Simply select from the DRC res olution conversion
options to show an InTouch application over the entire composite screen or just a portion of it.
You click a numbered rectangle in the Di splay Properties dialog box to select the monitor you want to
configure. You arrange the numbered rectangles to match the physical placement of the monitors.
Screen resolution, color depth and refresh rate apply only to the monitor you select.
245
Setting Up a Multi-Monitor SystemAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
What are the recommended configuration settings for the video card?
The X Location and Y Location values determine the horizontal and vertical pixel placement of a
window’s top left corner on a screen. The origin of horizontal and vertical pixel scales is at the top left
corner of a screen.
The Window Width and Window Height settings determine the overall size of the window. For
example, you can configure a window with the following settings:
X location = 1024
Y location = 0
Window Width = 1024
246
Setting Up a Multi-Monitor SystemAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
247
Setting Up a Multi-Monitor SystemAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Parameter Description
For example, if you want to show your InTouc h application with a screen resolution of 2560 x 1024
on two horizontal monitors, enter the following:
[InTouch]
MultiScreen=1
MultiScreenWidth=1280
MultiScreenHeight=1024
Note: If the ScaleForResolution parameter is not added to the InTouch.ini file, the default value is
enabled (ScaleForResolution=1). When you disable the parameter (ScaleForResolution=0), you are still
prompted to convert the res olution. But, the resolution conversion does not occur.
Important: It is recommended that you make a backup copy of the application before moving it to an
different environment.
248
Setting Up a Multi-Monitor SystemAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
For example, if an application is developed on a computer with a single monitor with a resolution of 1024
x 768 and is intended to run on a system with four monitors in a side-by -side configuration with a total
resolution of 4096 x 768, this requires an application conversion.
When you deploy the application on the multi-monitor system, a message appears prompting you to
convert the application.
If the ScaleForResolution .ini setting is configured, you still see this message but the application is not
converted and can then be run as designed. Simply click Yes to continue startup.
If the .ini s etting is not configured, the InTouch HMI converts and scale all of the graphics and windows in
the application to the new resolution. Doing so stretches and enlarge all windows and graphic displays,
thus creating some unwanted results.
Important: Make sure that the multi-monitor Win.ini parameter settings are also configured on the
destination computer before running your application. Win.ini settings do not automatically transfer wit h
an InTouch application.
249
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
C HAPTER 13
Using InTouch on a Tablet PC
About Using InTouch on a Tablet PC
Windows XP Tablet PC Edition and InTouch comes pre-installed with a line of portable Tablet PCs.
These rugged Tablet PCs are waterproof and vibration resistant, making them suitable for most industrial
environments. Tablet PCs are also available from other computer manufacturers that can run InTouch
applications.
Operators carry a Tablet PC with them as they move around their plant. The Tablet PC runs an InTouch
application that represents their actual plant processes. Using a pen that acts as a screen pointer or an
input device, operators select InTouch objects on the screen or as a keyboard substitute to writ e notes
directly on the screen.
Operators can write notes and annotate a running InTouc h application with direct observations about
their actual plant processes.
The Annotate Layout dialog box contains a toolbar and menu options. The dialog box shows the screen
capture in its client area. You can annotate the image using various drawing tools, and save, print, or
send the screen capture in an e-mail message.
251
Using InTouch on a Tablet PC AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Each of thes e tools has certain options such as size, color, or transparency.
To set these options, click the downward arrow next to each tool’s icon and then click the command
for the option.
To restore these options to their default settings, on the Tool s menu, click Restore Defaults.
252
Using InTouch on a Tablet PC AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
AnnotateLayout() Function
Shows the Annotate Layout dialog box, where you can annotat e the current view screen from where
this script function is called. This function is only supported on the Windows XP Tablet PC Edition
operating system.
Category
System
Syntax
AnnotateLayout()
Remarks
When Annotate Layout dialog box appears, the screen image of WindowViewer is captured. Use the
dialog box to:
Annotate the screen capture using the pen in conjunction with tool bar and menu item settings.
Save the image and the annotation as a .gif or .jpeg file.
Print the image and the annotation (if a printer is configured).
Send the image and the annotation as an attachment of an e-mail message (if SMTP is configured).
253
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
A PPENDIX A
Customizing Applications Settings from the
INTOUCH.ini File
The first time you run an InTouch application, the INTOUCH.ini file is creat ed in the application f older.
When the INTOUCH.ini file is creat ed, values are assigned to a set of parameters that determine the
operating characteristics of an individual InTouch application.
As you continue configuring your application from WindowMaker or WindowViewer, new IN TOUCH.ini
parameters are created or existing parameters are modified. For example, when you configure logging
from the WindowMaker Hi storical Logging Properties dialog box, logging paramet ers are added to the
INTOUCH.ini file.
Other configuration paramet ers must be manually added to the INTOUCH.ini file.
After you customize your application, you can copy the INTOUCH.ini file to a different application's
folder. This way, you can create consistent operating characteristics for your applications without havin g
to repeat all customization steps.
AllowPubAppE dit Sets the application flag, so that it can edit a published
application. If the value is 1, you can edit a published
InTouch file.
CommentRetentive Determines whet her run-time changes to the Alarm
Comment field are saved.
ForceLogging Sets the length of the interval when tag values are
periodically written to the Historical Log file regardless
of their current values.
255
Customizing Applications Settings from the INTOUCH.ini FileAVEVA™ InTouch HMI formerly Wonderware Application Management and Ex
256
Customizing Applications Settings from the INTOUCH.ini FileAVEVA™ InTouch HMI formerly Wonderware Application Management and Ex
ForceLogging specifies the length of the fixed logging interval in minutes. ForceLogging can be set to
a value from 5 to 120. The default is ForceLogging=60.
ForceLogCurrentValue
ForceLogCurrentValue forces the InTouch HMI to write log entries for all logged tags even if the
current values are less than or equal to their log deadband ranges. The default is
ForceLogCurrentValue=0.
In the following example, current tag values are written to the Historical Log file at 15 minute intervals or
when the value of the tag changes:
ForceLogging=15
ForceLogCurrentValue=1
257
Customizing Applications Settings from the INTOUCH.ini FileAVEVA™ InTouch HMI formerly Wonderware Application Management and Ex
LoopTimeout=20
258
Customizing Applications Settings from the INTOUCH.ini FileAVEVA™ InTouch HMI formerly Wonderware Application Management and Ex
Resizing the Input Fields of Analog and String User Input Links
You can add the Resizable InputLink parameter to the INTOUCH.ini file to resize the input box of the
Analog or String user input links with your mouse. The Resizable InputLink parameter must be set to a
non-zero value.
After the Input field is resized the first time, WindowViewer adds the Resizable InputLink Width and
Resizable InputLink Height parameters to the INTOUCH.ini file. These parameters specify the width and
height of Input boxes in pixels.
Example:
Resizable InputLink = 1
Resizable InputLink Width=300
Resizable InputLink Height=50
Also, you can edit the INTOUCH.ini file to manually modify the values assigned to thes e paramet ers.
259
AVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
A PPENDIX B
Managing Security for InTouch HMI
General Considerations for Security
Before you review the information in this section, it is recommended that you go through the following
checklist to ensure you plan to cover the security areas that apply to your ICS and organization.
Security Area Reference Section
Physical and virt ual access to the host General Guidelines for Securing the Host on page
262
Latest Windows patches applied Windows Updates on page 263
Protecting the host from viruses and malware Scanning the Host on page 264
Access to content on the host Protecting the Applications and Content on the
Host on page 264
Securing your network Securing the Net work on page 264
Configuring services and ports Managing Net work Services and Ports on page
266
Securing client/server communication Securing Communic ation bet ween the Client and
Server on page 266
User and group management Securing Systems through Aut hentication and
Authorization on page 268
Planning for emergencies Contingency Planning on page 269
For a list of security feature help topics refer to the table at the end of this section.
Introduction
This appendix provides a general overview on how to securely deploy your AVEVA software product as
an Industrial Control Systems (ICS) application.
AVEVA's approach to securing site networks and ICS software is driven by the following principles:
View security from both Management and Tec hnical perspectives
Ensure that security is addressed from both IT and ICS perspectives.
Design and develop multiple network, system and software security layers.
Ensure industry, regulatory and int ernational standards are taken int o account.
Aim to prevent security breaches, support ed by detection and mitigation.
These principles are realized by implementing the following security recommendations:
Prevent security breaches using the following components:
o Firewalls
o Network-based intrusion prevention/det ection
o Host-based intrusion prevention/detection
261
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: AVEVA strongly recommends following the guidelines prescribed by the U.S. Department of
Commerce for securing ICS software. The document "Guide to Industrial Control Systems (ICS)
Security" [NIS T Special Publication 800 -82 Revision
2](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.S P.800-82r2.pdf ) provides detailed
information about ICS, typical system topologies, security threats and vulnerabilities, and
recommendations for implementing security measures.
Note: The "host" is the Windows computer or Windows Embedded device on which your ICS software is
installed and running.
There are several factors to consider for securing the host including:
Access to the host
Keeping track of and applying the latest Windows updates
Keeping the host computer free of viruses and malware
Protecting the applications and content on the host
Each of thes e factors is covered in the sections below.
262
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Windows Updates
Check that the Windows operating system on the host is a version that is under what Microsoft calls
"mainstream support", which means Microsoft actively maintains and releases updates for it. Older
versions of Windows are under Micros oft "extended support", which means they are not actively
maintained and therefore might become vulnerable wit hout notice. For more information about the
different versions of Windows and the different levels of support, see [Windows lifecycle fact sheet](
https://support.microsoft.com/en-us/help/13853/ windows-lifec ycle-fact-sheet ).
Automate Micros oft product updat es using Microsoft Windows Server Update Services (WSUS ), which
enables you to manage and distribute updates to computers on your net work. For more information
about WSUS, see [Windows Server Update
Services](https://docs.microsoft.com/en-us/ windows -server/administration/ windows -server-update-s erv
ices/get-started/ windows -server-update-servic es-wsus ). If the host does not or will not have a reliable
connection to the WSUS server, perhaps because it is located on a private net work, you can either
develop a procedure to manually apply updates or consider changing the operating system to a
Long-Term Servicing Channel (LTSC) version of Windows, which is updat ed less frequently.
In addition, AVEVA ICS software is tested for compatibility with Micros oft updates the results of which are
published on the Securit y Central site https://softwaresupportsp.aveva.com/#/securit ycentral. Security
advis ories and bulletins are also published on this site.
263
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Note: AVEVA's Global Customer Support (GCS) group publishes a Technology Mat rix
https://gcsresource.aveva.com/TechnologyMatrix/Home/Index for AVEVA software products. This
matrix lists the Windows operating system versions against which a software product has been t ested for
compatibility. In addition, it lists compatible runtime, browser and virtualization environments for the
software. It also includes a list of other products that can be installed on the same computer and lists
other products with whic h this software can communicate.
264
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
265
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
In no cas e should your ICS network and devices be directly accessible from t he public internet. If there is
some part of your ICS that you want to be accessible, (for example, if you want be able to view
web-enabled HMI screens from a browser or smart phone), your ICS soft ware should include features
that securely pass the necessary traffic between your ICS network and a public -facing server.
266
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
A self-signed certificate is issued and signed by the same application that presents it. Self-signed
certificates are easy to create and manage, but they are s ecure only if you control both the server and the
client and therefore cont rol which certificat es are installed on each.
In contrast, CA-signed certificates are slightly difficult and expensive to acquire, but they are more
flexible than self-signed certificates because you do not need to control both the server and the client. If
you configure the server to present a CA-signed certificate, the client will accept the certificate because it
recognizes the Certificat e Authority.
Domain-issued certificates are internal certific ates typically managed by your IT department. They are
issued and validated by an Active Directory Certificate Authority. Domain -issued certificat es are free and
can be issued instantly.
You need to renew CA -signed and Domain-issued certificates at regular intervals.
For more information about how to enable Encrypted Channel features and manage self -signed
certificates in your ICS software, see the documentation for that software. However, acquiring a
CA-signed certificate and then using it to sign other certificat es is typically beyond the scope of ICS
software documentation.
Note: Encrypted and unenc rypted communications typically use different network ports.
Cloud-based Systems
It is possible that your ICS software might access cloud-based solutions, or might itself be hosted on the
Cloud.It is import ant to mitigate the risks associated with cloud-based access and hosting.
Accessing Cloud-Based Solutions
Several AVEVA applications are now being made available through the Cloud, and ICS soft ware may
need to connect to these applications. One of the main risks associated with accessing cloud -based
applications is unauthorized access. Connecting ICS soft ware to Cloud solutions must be done in a
secure manner, and needs to use secure prot ocols such as Transport Layer Security (TLS ).
It is important that data integrity is maintained at all times. Use data classification to identify data that is
sensitive and data that can be made public. Secure machines,storage and networking in order to secure
the data that is stored and transmitted. Work with your Cloud Service Provider (CSP) to configure users,
assign access levels and monitor and control access. Ensure that the CSP's buildings are ph ysically
secure and protected from unauthorized access.
Cloud-based ICS Software
While hosting ICS software on the Cloud provides several benefits such as flexibility, scalability and
availability, it is also fraught with security risks such as susceptibility to hacking resulting in damage to the
organization's reputation . Therefore, it is important to implement a security strategy before you make
your ICS soft ware accessible on the Cloud. For securing ICS soft ware on the Cloud, you need to
consider the following:
Securing access points by putting in place authentication, monitoring and support mechanisms.
Implementing cloud-based, cent ralized security measures including encrypting communications
using TLS.
267
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
268
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o Provides a single point of access to all network resources after the user is identified and
authenticated.
To manage users and groups:
First define a specific role for each group, and then configure the group privileges to fit that role.
Groups may overlap, but it is often better to have clearly separate groups and then assign individual
users to multiple groups, if necessary.
Set or change the password for the ICS software's default user (e.g., "guest").
Define stringent password policies to force users to creat e strong passwords. Enforce mandatory
password updat es on a regular basis.
Contingency Planning
Incidents are inevit able. It is, therefore, important to develop a strategy to detect an incident quickly and
respond to it in a timely manner in order to minimize loss and protect your system. An organiz ation must
consider contingencies arising from incidents such as fire, flood and so on, and those arising from failure
of hardware or software components. Cyber attacks such as ransomware are becoming more common
and must also be considered.
An organization should have contingency plans in plac e to cover the entire range of failures and
eventualities. Employees should be trained and be familiar with the contents of the contingency plans.
As part of planning for contingencies, it is important to establish a site, physically separated fro m the
central one, that has replication capability. Doing so will ensure the integrity of an operational system
where the central site is at risk from fire, floods or other disasters. The replication capability includes
having duplicated hardware, and requires soft ware configuration and key state information to be
periodically propagated from the central site to the recovery site. Each recovery scenario is unique, so it
is important to consult with system integration experts regarding the design of communic ations
equipment, hardware and the configuration of the soft ware.
269
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Protecting the data stored in your system is also of paramount importance. Full and incremental backups
must be scheduled on a regular basis. Backups should be verified by running tests to restore from
backed up data. Backups should be stored offline so that they are safe from cyber attacks such as
ransomware.
Organizations should also have business continuity and disaster rec overy plans that are similar to
contingency plans. These plans are covered briefly in the sections to follow.
270
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
o List of individuals responsible for performing, testing, maintaining and restoring backups.
List of personnel with physical and virtual access to the ICS .
Detailed configuration information about the components of the ICS.
Schedule for testing the DRP.
Conclusion
Security lapses pres ent a serious threat to ICS software and infrastructure. Therefore, it is important for
every organization to:
Be proactive about preventing security lapses
Identify potential lapses
Detect them in a timely manner when they occur
Address lapses to ensure minimum dis ruption and maximum availability
To this end:
Computers and networks must be secured
Users and groups must be authenticated and authorized
Contingency plans must be in place to recover from untoward or intentional events
Refer to the document "Guide to Industrial Control Systems (ICS) Security" [NIS T Special Publication
800-82 Revision 2](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-82r2.pdf ) for
additional details and recommendations.
271
Managing Security for InTouch H MIAVEVA™ InTouch HMI formerly Wonderware Application Management and Extension Guide
Protecting the Applications and Lock ing System Keys Restrict operator access to
Cont ent on the Host standard Windows functions by
disabling system keys on the
computer running an InTouch
application.
Managing Users and Groups Using InTouch-B ased Security Restrict which functions an
through ICS Software operator is allowed to perform by
linking those functions to internal
tags.
Managing Users and Groups Using Operating S ystem-Based Inherit some user/group account
through Windows Security policies from the Windows
operating system.
272
Index
$
$AccessLevel system tag • 187
$ApplicationChanged system tag • 86
$ChangePassword system tag • 188
$ConfigureUsers system tag • 184, 189, 190
$InactivityTimeout system tag • 167, 170
$InactivityWarning system tag • 167, 170
$Language system tag • 205, 207
$Operat or system tag • 190, 194
16PenTrendDrawMode parameter • 258
$Operat orEnt ered system tag • 193
$PasswordEntered system tag • 190, 193
1
16PenTrendDrawMode parameter • 258
A
AnnotateLayout() function • 251, 253
Application Manager
modifying an application • 54
opening an application with WindowViewer • 52
Application Publisher
description • 63
applications
configuring for run-time language switching • 203
creating for InTouchView • 31
extending overview • 27
logging remote referenced tags • 257
securing in a Terminal Services environment • 94
task management oveview • 27
ArchestrA
format of numbers within graphics • 228
master user acccount • 104
architectures
client-bas ed • 74
Network Application Development • 75
server-based • 74
B
beep sound for objects • 219
blinking speeds • 219
C
ChangePassword() function • 187
client-bas ed arc hitecture • 74
closing WindowViewer on transfer to WindowMak er • 219
closing/opening windows • 235
commands
Net Start view • 104
Net Stop view • 104
Notify Clients • 75
unavailable from InTouchView • 15
core affinity • 232
D
DBDump
description • 107
exporting tags • 107
viewing contents of exported file • 108
DBLoad
creating input file • 110
description • 107
input file • 109
IOAccess keyword • 112
mode keyword • 111
debugging scripts • 219
DRCSee Dynamic Resolution Conversion • 88
E
event logs
logging remote referenced tags • 257
F
Fast Switch • 219
files, INTOUCH.ini • 28
ForceLogCurrentValue parameter • 256
ForceLogging parameter • 256
functions
AddPermission() function • 176, 186
AnnotateLayout() function • 251
AttemptInvisibleLogon() function • 192
EnableDisableKeys() function • 171, 173
GetAccountStatus() function • 196
GetNodeName() function • 94
HTSetPenName() function • 81
HTUpdateToCurrent Time() function • 78
InvisibleV erifyCredentials() function • 195
IOReinitialize() function • 95
IOSetAccessName() function • 76
IsAssignedRole() function • 196
Logoff() function • 192
PostLogonDialog() function • 189, 191
QueryGroupMembership() function • 197
SwitchDisplayLanguage() function • 205
TseGetClient Id() function • 94, 96
TseGetClientNodeName() function • 97
TseQueryRunni ngOnClient () function • 97
TseQueryRunningOnConsole() function • 97
WWMultiMonitorNode() function • 249
G
Galaxy
restrictions for InTouchView applications • 15
GetAccountStatus() function • 196
H
historical logging
restrictions for InTouchView applications • 15
setting logging frequency • 256
I
inactivity time-out • 167
INTOUCH.ini file
custom parameters • 255
InTouchView
creating an application • 31
description • 217
WindowMaker restrictions • 15
IOAccess keyword • 112
K
keywords
GroupVar keyword • 136
IndirectAnalog keyword • 137
IndirectMsg keyword • 138
IODisc keyword • 125
MemoryDisc keyword • 124
MemoryMsg keyword • 134
TagID keyword • 137
L
language switching
configuring • 203
LoopTimeout parameter • 257
M
Mode keyword • 111
multi-monitor system
description • 243
single video card configuration • 243
N
NADSee Network Application Development • 75
Net Start view command • 104
Net Stop view command • 104
Network Application Development
description • 75
network architectures
server-based • 74
single computer • 73
supported types • 73
NoKeyboardResize parameter • 259
Notify Clients command • 75, 87
number format • 228
O
objects
blink speed • 219
objects, blink speed • 219
oldrightmousebehavior parameter • 257
opening/closing windows • 235
P
parameters
16PenTrendDrawMode • 258
CommentRetentive • 258
ForceLogCurrentValue • 256
ForceLogging • 256
LoopTimeout • 257
MultiScreen • 247
MultiScreenHeight • 247
MultiScreenWidt h • 247
NoKeyboardResize • 259
oldrightmousebehavior • 257
PrintScreenWait • 258
PrintWindow • 258
Resizable InputLink • 259
ScaleForRes olution • 258
PrintScreenWait parameter • 258
PrintWindow parameter • 258
processors • 232
R
Region setting • 228
ReloadWindowViewer() function • 87
RESET command • 139
Resizable InputLink parameter • 259
RestartWindowViewer() function • 87
run time
customizing • 219
Fast Switch • 219
run time, customizing for InTouchView • 219
S
ScaleForRes olution parameter • 248
scripts
setting loop timeout limit • 257
security
adding user permissions with a script • 186
change user password with a script • 187
determine us er group members hip with a script • 196
inactivity time-out feature • 167
InTouch-bas ed authentication • 176
log on a user to InTouch aut omatically with a script • 192
overview • 167
restricting access to InTouch functionality • 194
retrieving information about the current logged on user wit h a script • 197
show InTouch Logon dialog box with a script • 191
using operating system-bas ed authentication • 176
verifying user credentials with a script • 195
server-based arc hitecture • 74
services
configuring a user account • 104
configuring WindowViewer to start as a servic e • 102
description • 101
manually starting • 104
starting WindowViewer • 101
stopping using a command • 104
stopping using the Cont rol Panel • 104
system tags
$AccessLevel system tag • 187
$AccessLevel system tag • 190
$ApplicationVersion system tag • 86
$ChangePassword system tag • 188
$ChangePassword system tag • 184
$ConfigureUsers system tag • 189
$ConfigureUsers system tag • 184
$ConfigureUsers system tag • 190
$InactivityTimeout system tag • 170
$InactivityTimeout system tag • 167
$InactivityWarning system tag • 170
$InactivityWarning system tag • 167
$Language system tag • 205
$LogicRunning system tag • 173
$Operat or system tag • 94, 190, 198
$Operat orDomainEntered system tag • 194
$Operat orEnt ered system tag • 193
$Operat orEnt ered system tag • 190
$Operat orName system tag • 197
$PasswordEntered system tag • 193
$PasswordEntered system tag • 190
T
Tablet PC
description • 251
making window annotations • 252
Tagname Dictionary
creating DBLoad input file • 110
exporting contents with DBDump • 107
formatting an input file • 109
tags
$InactivityTimeout system tag • 167
exporting contents of Tagname Dictionary • 107
logging remote referenced • 257
SuperTag instances • 139
Terminal Services
defining Read Only applications in remote sessions • 223
Terminal Services Client command • 93
tick interval • 219
transferring to WindowMaker from WindowViewer • 235
TseGetClient Id() function • 94
W
WindowMaker
disabling trans fer from WindowViewer • 173
editing lock • 88
restrictions when developing InTouchView applications • 15
setting mouse behavior • 257
WindowViewer
closing all open windows on transfer to WindowMaker • 219
closing on transfer to WindowMaker • 219
configuring to start as a Windows service • 102
customizing • 219
resizing the numeric keypad • 259
running as a service • 101
setting drawing mode of 16-Pen Trend • 258
setting print waiting period • 258
setting script looping timeout interval • 257
starting as a service • 102