AVEVA™ InTouch HMI

formerly Wonderware

Guide to Documentation

aveva.com
 © 2021 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means,
electronic, mechanical, photocopying, recording, 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 software described in this documentation is furnished under
a license agreement. This software 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, IntelaTrac, InTouch, OASyS,
PIPEPHASE, PRiSM, PRO/II, PROVISION, 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 trademarks can be found at: https://sw.aveva.com/legal. All other
brands may be trademarks of their respective owners.
Publication date: Monday, August 23, 2021
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to contact sales and customer training, see https://sw.aveva.com/contact.
For information on how to contact technical support, see https://sw.aveva.com/support.

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 2
Contents

Chapter 1 About Your InTouch Documentation ................................................. 4

Overview ..............................................................................................................................................4
Getting an Overview of InTouch Features and Concepts .........................................................................4
About the InTouch Documentation Set ..................................................................................................4
InTouch HMI Application Management and Extension Guide ..................................................................... 5
InTouch HMI Data Management Guide ....................................................................................................... 5
InTouch HMI Visualization Guide ................................................................................................................. 6
InTouch HMI SmartSymbols Guide .............................................................................................................. 6
InTouch HMI and ArchestrA Integration Guide............................................................................................ 6
InTouch HMI Alarms and Events Guide ........................................................................................................ 7
InTouch HMI Scripting and Logic Guide ....................................................................................................... 7
InTouch HMI Supplementary Components Guide ....................................................................................... 7
InTouch HMI Tag Viewer Guide.................................................................................................................... 8
Finding the Information You Need .........................................................................................................8
Searching the Document Set ........................................................................................................................ 8
Using the Index............................................................................................................................................. 9
Context-Sensitive Help on Script Functions and ActiveX Properties............................................................ 9
Other Resources for Information ...........................................................................................................9

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 3
Chapter 1

About Your InTouch Documentation

Overview
Welcome to the Guide to InTouch® HMI Documentation. The InTouch HMI comes with a complete set of user
guides. This guide explains how to find the information you need from these guides.
The InTouch documentation is organized into separate manuals that are easy to navigate and are focused on
helping you get your work done. To learn more about the structure and contents of the documentation set, see
About the InTouch Documentation Set on page 4.
We’ve included some helpful hints on how to find the information you’re looking for, both in the PDF documents
and in the online help. For more information, see Finding the Information You Need on page 8.

Getting an Overview of InTouch Features and Concepts

As a development environment, the InTouch HMI provides you with many flexible and powerful features. To
grasp the basic understanding of the features and concepts, you can create a "practice" application to try out
some of the features you’re interested in.
Detailed steps about on how to perform specific development tasks are available in the guides. We have also
provided a few other ways to find the information you’re interested in. For more information, see Finding the
Information You Need on page 8.

About the InTouch Documentation Set

The information in the InTouch documentation set is organized using a task-based approach. This means that
the information isn’t structured around individual dialog boxes, menu items, or other user interface features,
but rather around the things that you can do using the InTouch HMI.
To make the documentation easier for you to handle, the content is split into several smaller guides that cover
specific functional areas of the InTouch HMI. The documentation set consists of the following guides:
 The InTouch HMI Application Management and Extension Guide describes how to create and manage
InTouch applications locally and in a network environment. It also covers application-level functionality, such
as security. This guide describes how to run an InTouch application in different environments, such as with
Terminal Services, on a Tablet PC, and using multiple monitors.
 The InTouch HMI Data Management Guide describes how to work with data items in the InTouch HMI and
connect your application to the physical devices in your plant environment.

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 4
 AVEVA™ InTouch HMI Guide to Documentation
Chapter 1 – About Your InTouch Documentation

 The InTouch HMI Visualization Guide describes how to develop the graphical operator interface of an
InTouch application. This guide includes information on how to create visualization windows, how to draw
and animate graphic elements, and how to use wizards and ActiveX controls in your application.
 The InTouch HMI SmartSymbols Guide describes how to create reusable templates for graphic symbols that
can save you a lot of engineering time and effort.
 The InTouch HMI and ArchestrA®Integration Guide describes how to integrate the InTouch HMI and
ArchestrA technology to develop more robust applications that use richer graphics.
 The InTouch HMI Alarms and Events Guide describes how to configure alarms for your data items, how to
view and acknowledge alarms, and how to use the alarm clients and utilities supplied with the InTouch HMI.
 The InTouch HMI Scripting and Logic Guide describes how to write scripts in the InTouch HMI to automate
common tasks and processes. This guide includes a reference of the InTouch scripting language and
functions.
 The InTouch HMI Supplementary Components Guide describes software components that you can optionally
install and use with the InTouch HMI. You can set up connectivity to SQL databases, do statistical process
control, trend data, and manage recipes. The supplementary components also include a library of symbols,
such as meters, valves, and pumps.
 The InTouch HMI Tag Viewer Guide describes how to use the Tag Viewer at run time to monitor and modify
tag values.

InTouch HMI Application Management and Extension Guide

The InTouch® HMI Application Management and Extension Guide describes how InTouch applications are
managed locally and in a network environment, as well as other application-level functionality, such as security.
This guide covers:
 Creating and managing InTouch applications
 Exporting and importing InTouch applications or specific elements
 Securing applications
 Working with networked, multi-node applications
 Running applications
 Managing the InTouch services
 Switching an application’s display language at run time
 Using the InTouch HMI on a Tablet PC
 Setting up a multi-monitor system
 Customizing your application using the intouch.ini file

InTouch HMI Data Management Guide

The InTouch® HMI Data Management Guide describes how to work with InTouch data and connect your
application to the physical devices in your plant environment. This guide covers:

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 5
 AVEVA™ InTouch HMI Guide to Documentation
Chapter 1 – About Your InTouch Documentation

 Creating and managing tags

 Using dotfields to view or change tag properties
 Working with indirect tags, which are "pointers" to other tags
 Creating and using SuperTags, which are reusable templates that save you time when setting up your tag
structure
 Reducing tag counts in an application
 Working with I/O data
 Recording, displaying and accessing historical tag values
 Working with licensing

InTouch HMI Visualization Guide

The InTouch® HMI Visualization Guide describes how to create a graphical operator interface for an InTouch
application. This guide covers:
 Navigating in the WindowMaker development environment
 Creating and managing application windows
 Creating and editing simple or complex graphic objects
 Adding run-time functionality to graphic objects using animation links
 Embedding wizards and ActiveX controls

InTouch HMI SmartSymbols Guide

The InTouch® HMI SmartSymbols Guide describes how to create reusable templates for graphic symbols in the
InTouch HMI. This guide covers:
 Creating the reusable graphic symbols, called SmartSymbols
 Configuring SmartSymbols to use InTouch or ArchestrA data for animations
 Managing and organizing SmartSymbols

InTouch HMI and ArchestrA Integration Guide

The InTouch® HMI and ArchestrA® Integration Guide describes how you can use the ArchestrA Integrated
Development Environment (IDE) to manage InTouch applications so that you can use symbols you create in the
Industrial Graphic Editor. This guide covers:
 Creating and managing InTouch applications using the IDE
 Embedding graphically rich symbols you create using the Industrial Graphic Editor into InTouch windows
 Configuring animation links for Industrial Graphics
 Running managed applications

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 6
 AVEVA™ InTouch HMI Guide to Documentation
Chapter 1 – About Your InTouch Documentation

InTouch HMI Alarms and Events Guide

The InTouch® HMI Alarms and Events Guide describes the alarm and event functions in the InTouch HMI. This
guide covers:
 Configuring alarm conditions for tags
 Configuring event recording for tags
 Querying for alarm data
 Defining and viewing alarm group hierarchies
 Viewing and acknowledging alarms at run time
 Controlling the alarm properties of tags using dotfields
 Printing alarms
 Recording and retrieving alarms to/from a database
 Maintaining the alarm database
 Analyzing alarm distribution across tags
 Configuring a redundant alarm system

InTouch HMI Scripting and Logic Guide

The InTouch® HMI Scripting and Logic Guide describes how to write scripts using the InTouch HMI to automate
common tasks and processes. This guide covers:
 Programming in the InTouch scripting language
 Triggering scripts
 Using the InTouch scripting language and functions
 Creating custom script functions
 Working with OLE objects and ActiveX controls
 Troubleshooting and debugging scripts

InTouch HMI Supplementary Components Guide

The InTouch® HMI Supplementary Components Guide describes how to extend the basic InTouch functionality
using supplementary components. This guide covers:
 Working with SQL databases from the InTouch HMI
 Managing recipes
 Trending data
 Using a library of pre-configured symbols, such as meters, valves, and pumps

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 7
 AVEVA™ InTouch HMI Guide to Documentation
Chapter 1 – About Your InTouch Documentation

InTouch HMI Tag Viewer Guide

The InTouch® HMI Tag Viewer Guide explains how to use the InTouch Tag Viewer utility. The Tag Viewer utility
provides run-time information about InTouch tags. This guide covers:
 Enabling and starting Tag Viewer
 Navigating in Tag Viewer and searching for tags
 Viewing tags and modifying tag properties
 Adding and managing watch windows

Finding the Information You Need

Depending on what you are looking for, there are various ways to quickly find the information you need.
The documentation set is available in two formats:
 Printable PDF, with each guide delivered as a separate PDF file
 Help, with all guides combined into one large help system
Both formats offer a table of contents, a complete master index, and search features that let you search all of
the information at one time.

Searching the Document Set

If you’re looking for information on a very specific term, such as a function or property name, use the search
feature. For general terms that are mentioned in the documents very often, using the index may be easier.
To search across all PDF documents
1. Open a PDF in Acrobat Reader.
2. Do any of the following:
a. On the Edit menu, click Search.
b. Press CTRL+SHIFT+F.
The Search PDF pane appears.
3. Type the word or phrase to search for.
4. Click All PDF Documents in and then select the folder that contains the InTouch PDFs. By default, this is
C:\Program Files (x86)\Wonderware\InTouch.
5. Click Search.
To search the online help
1. Click the Search tab.
2. Type the word(s) you are looking for in the text box.
3. Click List Topics.

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 8
 AVEVA™ InTouch HMI Guide to Documentation
Chapter 1 – About Your InTouch Documentation

Using the Index

If you’re looking for information on a term that is mentioned in the documents very often, it may be easier to
find the topic in the index rather than searching for it. The index only lists occurrences where the term is really
relevant. Also, it often mentions the context in which the term is used. That way, you don’t need to review a
large number of search results to find the particular occurrence and context that you’re interested in.
Each PDF guide has its own index. Also, the Help has an index, so you can easily find terms that are mentioned
throughout the documentation.

Context-Sensitive Help on Script Functions and ActiveX Properties

If you’re looking for help on a specific script function, you can access it directly from the QuickScript Editor in
WindowMaker. A similar help feature is available for the properties of ActiveX controls that are supplied with
the InTouch HMI.
To view help for a function in the QuickScript Editor
1. In the bottom right corner of the QuickScript Editor, click Help. A list of functions appears.
2. If you can’t see the function you’re interested in, click Next Page at the bottom of the list to go to the next
page.
3. Click the name of the required function. The corresponding help topic appears.
To view help on a specific ActiveX property
1. In WindowMaker, place an instance of the ActiveX control on a window.
2. Double-click the instance to open its properties dialog box.
3. Click the Properties tab.
4. In the Property column, click the cell that contains the name of the property you’re interested in.
5. Press F1. The corresponding help topic appears.

Other Resources for Information

In addition to the InTouch documentation set, you can find InTouch-related information on the Technical
Support web site, such as:
 Knowledge base articles
 Technical notes and articles
 User discussion forums

© 2021 AVEVA Group plc and its subsidiaries. All rights reserved. Page 9