Wonderware
Guide to InTouch HMI Documentation
8/29/12
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 Invensys Systems, Inc. No copyright or patent liability is assumed with respect to the use of the information contained herein. Although every precaution has been taken in the preparation of this documentation, the publisher and the author assume no responsibility for errors or omissions. Neither is any liability assumed for damages resulting from the use of the information contained herein. The information in this documentation is subject to change without notice and does not represent a commitment on the part of Invensys Systems, Inc. The software described in this documentation is furnished under a license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of these agreements.
2007, 2012 by Invensys Systems, Inc. All rights reserved.
Invensys Systems, Inc. 26561 Rancho Parkway South Lake Forest, CA 92630 U.S.A. (949) 727-3200 [Link] For comments or suggestions about the product documentation, send an e-mail message to ProductDocumentationComments@[Link].
All terms mentioned in this documentation that are known to be trademarks or service marks have been appropriately capitalized. Invensys Systems, Inc. cannot attest to the accuracy of this information. Use of a term in this documentation should not be regarded as affecting the validity of any trademark or service mark. Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DT Analyst, Factelligence, FactoryFocus, FactoryOffice, FactorySuite, FactorySuite A2, InBatch, InControl, IndustrialRAD, IndustrialSQL Server, InTouch, MaintenanceSuite, MuniSuite, QI Analyst, SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager, WindowMaker, WindowViewer, Wonderware, Wonderware Factelligence, and Wonderware Logger are trademarks of Invensys plc, its subsidiaries and affiliates. All other brands may be trademarks of their respective owners.
Contents
Chapter 1
About Your InTouch Documentation ................ 5
Getting an Overview of InTouch Features and Concepts .............. 5 About the InTouch Documentation Set .......................................... 6 InTouch HMI Concepts and Capabilities Guide .......................... 7 InTouch HMI Application Management and Extension Guide ........................................................................ 8 InTouch HMI Data Management Guide ...................................... 8 InTouch HMI Visualization Guide ............................................... 9 InTouch HMI SmartSymbols Guide ............................................. 9 InTouch HMI and ArchestrA Integration Guide ......................... 9 InTouch HMI Alarms and Events Guide ................................... 10 InTouch HMI Scripting and Logic Guide ................................... 10 InTouch HMI Supplementary Components Guide .................... 11 InTouch HMI Tag Viewer Guide ................................................ 11 Finding the Information You Need ............................................... 11 Searching the Document Set ...................................................... 12 Using the Index ........................................................................... 12 Context-Sensitive Help on Script Functions and ActiveX Properties .................................................................. 13 Other Resources for Information ................................................... 13
Guide to InTouch HMI Documentation
Contents
Guide to InTouch HMI Documentation
About Your InTouch Documentation
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 6. Weve included some helpful hints on how to find the information youre looking for, both in the PDF documents and in the online help. For more information, see "Finding the Information You Need" on page 11.
Getting an Overview of InTouch Features and Concepts
As a development environment, the InTouch HMI provides you with many flexible and powerful features. To give you an overview of everything the InTouch HMI can do, we ve created the InTouch HMI Concepts and Capabilities Guide. This guide describes all of the softwares features and main concepts without going too deep into the technical and procedural details. As your first step in exploring the InTouch HMI, we suggest that you read that guide in its entirety. After you have a basic understanding of the features and concepts, you can create a practice application to try out some of the features youre interested in.
Guide to InTouch HMI Documentation
About Your InTouch Documentation
Detailed steps about on how to perform specific development tasks are available in the rest of the guides. Each topic in the InTouch HMI Concepts and Capabilities Guide has cross-references that guide you to this information. Weve also provided a few other ways to find the information youre interested in. For more information, see "Finding the Information You Need" on page 11.
About the InTouch Documentation Set
The information in the InTouch documentation set is organized using a task-based approach. This means that the information isnt 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 Concepts and Capabilities Guide describes all
of the features and main concepts in the InTouch HMI without going too deep into the technical and procedural details.
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.
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.
Guide to InTouch HMI Documentation
About the InTouch Documentation Set 7
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 Concepts and Capabilities Guide
The InTouch HMI Concepts and Capabilities Guide describes all of the features and main concepts in the InTouch HMI. This guide covers:
Working with the main InTouch software components Working with the InTouch HMI and the ArchestrA IDE Creating, managing, and running different types of InTouch
applications
Creating graphics in WindowMaker or the ArchestrA Symbol
Editor
Working with local tags and remote reference tags Using alarms and events Writing scripts Exporting and importing InTouch applications or specific elements Configuring security
Guide to InTouch HMI Documentation
About Your InTouch Documentation
Using supplementary components, such as for recipe management,
SQL connectivity, and statistical process control
Integrating the InTouch HMI with other Wonderware
applications, such as Wonderware Application Server, the Wonderware Historian, Wonderware Information Server and Wonderware client tools. Read the InTouch HMI Concepts and Capabilities Guide first to get a quick overview of everything that the InTouch HMI can do. Each topic contains cross-references to detailed information in the other guides.
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 applications display language at run time Using the InTouch HMI on a Tablet PC Setting up a multi-monitor system Customizing your application using the [Link] 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:
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
Guide to InTouch HMI Documentation
About the InTouch Documentation Set 9
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 ArchestrA Symbol Editor. This guide covers:
Creating and managing InTouch applications using the ArchestrA
IDE
Embedding graphically rich symbols you create using the
ArchestrA IDE Symbol Editor into InTouch windows
Configuring animation links for ArchestrA Symbols Running managed applications
Guide to InTouch HMI Documentation
10
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
Guide to InTouch HMI Documentation
Finding the Information You Need 11
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 Monitoring manufacturing quality using statistical process control Managing recipes Trending data Using a library of pre-configured symbols, such as meters, valves,
and pumps
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.
Guide to InTouch HMI Documentation
12
About Your InTouch Documentation
Searching the Document Set
If youre 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 2
Open a PDF in Acrobat Reader. Do any of the following:
a b
On the Edit menu, click Search. Press CTRL+SHIFT+F.
The Search PDF pane appears.
3 4
Type the word or phrase to search for. Click All PDF Documents in and then select the folder that contains the InTouch PDFs. By default, this is C:\Program Files\Wonderware\InTouch. Click Search.
To search the online help 1 2 3
Click the Search tab. Type the word(s) you are looking for in the text box. Click List Topics.
Using the Index
If youre 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 dont need to review a large number of search results to find the particular occurrence and context that youre 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.
Guide to InTouch HMI Documentation
Other Resources for Information 13
Context-Sensitive Help on Script Functions and ActiveX Properties
If youre 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 2 3
In the bottom right corner of the QuickScript Editor, click Help. A list of functions appears. If you cant see the function youre interested in, click Next Page at the bottom of the list to go to the next page. Click the name of the required function. The corresponding help topic appears.
To view help on a specific ActiveX property 1 2 3 4 5
In WindowMaker, place an instance of the ActiveX control on a window. Double-click the instance to open its properties dialog box. Click the Properties tab. In the Property column, click the cell that contains the name of the property youre interested in. 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 Wonderware Technical Support web site, such as:
Knowledge base articles Technical notes and articles User discussion forums
Guide to InTouch HMI Documentation
14
About Your InTouch Documentation
Guide to InTouch HMI Documentation
