0% found this document useful (0 votes)
162 views994 pages

RS View Complete Course Manual

Uploaded by

Orel Suarez
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
162 views994 pages

RS View Complete Course Manual

Uploaded by

Orel Suarez
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 994

User’s Guide

Supervisory Edition
Distributed HMI for Enterprise Solutions

User’s Guide

Doc ID VIEWSE-UM001A-EN-E
Contacting Technical Support Telephone—440-646-5800
Rockwell Software Technical Support Fax—440-646-5801
World Wide Web Support Library—www.software.rockwell.com, or
support.rockwellautomation.com
Copyright Notice E2001 Rockwell Software Inc., a Rockwell Automation Company. All rights reserved.
Printed in the United States of America.
Portions copyrighted by the Allen-Bradley Company, LLC, a Rockwell Automation
Company.
This manual and any accompanying Rockwell Software products are copyrighted by
Rockwell Software Inc. Any reproduction and/or distribution without prior written
consent from Rockwell Software Inc. is strictly prohibited. Please refer to the license
agreement for details.
VBA and DCOM, Copyright 1996, 1997 Microsoft Corporation. All rights reserved.

Trademark Notices WINtelligent Series is a registered trademark. The Rockwell Software logo, RSAssistant,
RSBatch, RSData, RSEmulate 5, RSEmulate 500, RSGuardian, RSHarmony, RSKeys,
RSLinx, RSLogix 5, RSLogix 500, RSPower, RSPowerCFG, RSPowerRUN, RSServer32,
RSServer, RSServerToolkit, RSSql, RSToolbox, RSTrainer, RSTrend, RSTune, RSView32,
RSView32 Resource Kit, RSView, RSWire, A.I. Series, Advanced Interface (A.I.) Series,
AdvanceDDE, ControlGuardian, ControlView, INTERCHANGE, Object Smart Path,
Packed DDE, WINtelligent, WINtelligent EMULATE 5, WINtelligent EMULATE 500,
WINtelligent LOGIC 5, WINtelligent VIEW, WINtelligent RECIPE, WINtelligent
VISION, WINtelligent VISION2, and RSTools are trademarks of Rockwell Software Inc.
PLC, PLC-2, PLC-3, and PLC-5 are registered trademarks, and Data Highway Plus, DH+,
DHII, DTL, Network DTL, Pyramid Integrator, PanelBuilder, PanelView, PLC-5/250,
PLC-5/20E, PLC-5/40E, PLC-5/80E, SLC, SLC 5/01, SLC 5/02, SLC 5/03, SLC 5/04,
SLC 5/05, SLC 500, ControlLogix 5550, and SoftLogix are trademarks of the Allen-Bradley
Company, Inc.
AutoCAD is a registered trademark of Autodesk, Inc. dBASE IV is a registered trademark
of Borland International, Inc. Ethernet is a registered trademark of Digital Equipment
Corporation, Intel, and Xerox Corporation. IBM is a registered trademark, and AIX,
PowerPC, Power Series, and RISC System/6000 are trademarks of International Business
Machines Corporation. Microsoft, MS-DOS, Visual Basic, and Windows are registered
trademarks, and ActiveX, Microsoft Access, Visual FoxPro, and Windows NT are
trademarks of the Microsoft Corporation. Modicon is a registered trademark of Groupe
Schneider. OPC is a trademark of the OPC Foundation. Seagate Crystal Reports is a
trademark of Seagate Technology, Inc. or one of its subsidiaries. TrueType is a trademark of
Apple Computer, Inc. UNIX is a registered trademark in the United States and other
countries, licensed exclusively through X/Open Company Limited. Visio is a registered
trademark of Visio Corporation. Sybase is a registered trademark of Sybase Inc. Oracle is
a registered trademark of Oracle Corporation.
All other trademarks are the property of their respective holders and are hereby
acknowledged.

Warranty This Rockwell Software product is warranted in accord with the product license. The
product’s performance will be affected by system configuration, the application being
performed, operator control and other related factors. The product’s implementation may
vary among users.
This manual is as up-to-date as possible at the time of printing; however, the accompanying
software may have changed since that time. Rockwell Software reserves the right to change
any information contained in this manual or the software at any time without prior notice.
The instructions in this manual do not claim to cover all the details of variations in the
equipment, procedure, or process described, nor to provide directions for meeting every
possible contingency during installation, operation, or maintenance.
Doc ID VIEWSE-UM001A-EN-E
December 2001
Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P- 1
About the documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-1
Technical support services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-2
Try the user’s guides and Help first . . . . . . . . . . . . . . . . . . . . . . . . P-2
Information on the Internet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-2
Contacting Rockwell Software Technical Support . . . . . . . . . . . . P-4

Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1- 1
The main parts of RSView Supervisory Edition . . . . . . . . . . . . . . . . . 1-1
Features in brief . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
The RSView Enterprise tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
The Rockwell Software utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Quick Start steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Start with a plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Step 1 H Set up the FactoryTalk Directory . . . . . . . . . . . . . . . . . 1-6
Step 2 H Create and organize an application . . . . . . . . . . . . . . . . 1-7
Step 3 H Add an HMI server to your application . . . . . . . . . . . . . 1-7
Step 4 H Plan how you will access data . . . . . . . . . . . . . . . . . . . . 1-7
Step 5 H Set up communications for data server tags . . . . . . . . . 1-8
Step 6 H Set up communications for HMI tags . . . . . . . . . . . . . . . 1-8
Step 7 H Create HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Step 8 H Create graphic displays, trends, and alarm summaries 1-10
Step 9 H Set up logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Step 10 H Secure your system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Step 11 H Customize and integrate RSView with
other applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11

Exploring RSView Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2- 1


Starting RSView Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Opening an application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Running the samples application . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

Contents ■ i
Exploring the RSView Studio main window . . . . . . . . . . . . . . . . . . . 2-5
The menu bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
The toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
The Application Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
The workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
The activity bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
The status bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Showing and hiding items in the main window . . . . . . . . . . . . . . 2-8
Working in the Application Explorer . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Undocking the Application Explorer . . . . . . . . . . . . . . . . . . . . . . 2-9
Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Adding components to an application . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Renaming, removing, and deleting components . . . . . . . . . . . . . . . . . 2-17
Renaming a component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Removing a component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
Deleting a component and file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
Naming components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
Techniques for working in editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Using the shortcut menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Using the Browse button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Entering tag names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Using RSView commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Using expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
Selecting a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
Setting up the printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
Selecting a network printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24
Printing at runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24

Planning an application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3- 1
The planning process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Understanding the process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Collecting data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Planning communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Designing an HMI tag database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Collect information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Organize HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

ii ■ RSView Supervisory Edition User’s Guide


Planning alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Planning graphic displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Develop a hierarchy of displays . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Create a template to ensure consistency . . . . . . . . . . . . . . . . . . . . 3-6
Using trends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Designing a secure system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Customizing the system, and integrating with other applications . . 3-8
Using data from other applications . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Customizing the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Designing a multi-user system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10

Working with applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4- 1


Key concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
HMI server, HMI project, and HMI client . . . . . . . . . . . . . . . . . . . . . . 4-1
The FactoryTalk Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
More about areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Absolute and relative references . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Basic steps for developing an application . . . . . . . . . . . . . . . . . . . 4-6
Activities when deploying an application . . . . . . . . . . . . . . . . . . . 4-7
Setting up the FactoryTalk Directory . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Creating an application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Deleting an application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Structuring an application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Using areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Adding HMI servers and data servers . . . . . . . . . . . . . . . . . . . . . . . 4-11
Adding and removing areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Adding, copying, removing, and deleting HMI servers . . . . . . . . . . . . 4-13
Setting up an HMI server’s properties . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

Setting up communications for data server tags . . . . . . . . 5- 1


About data servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Using data servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Adding data servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Setting up general properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Setting up data server redundancy . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Setting up advanced properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Removing data servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

Contents ■ iii
Setting up communications for HMI tags . . . . . . . . . . . . . . . . 6- 1
Where to find information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
About OPC communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Overview of OPC communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Creating an OPC node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Changing node information at run time . . . . . . . . . . . . . . . . . . . . . . . 6-11
Scanning for new tag values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12

Working with tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7- 1


Tags and the HMI tag database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Data server tags, HMI tags, and their attributes . . . . . . . . . . . . . . . 7-1
Basic steps for using tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
When to use data server tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Eliminate duplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Access to complex data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Steps for using data server tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
When to use HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Data manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Storing values in RSView’s memory . . . . . . . . . . . . . . . . . . . . . . . 7-7
Steps for using HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Browsing for tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Browsing for off-line tags from RSLinx . . . . . . . . . . . . . . . . . . . . . . . 7-10
Browsing for off-line tags from other OPC servers . . . . . . . . . . . . . . . 7-10
Using the Tag Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Working with folders in the Tag Browser . . . . . . . . . . . . . . . . . . . . . . 7-12
Showing server names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
Adding folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Finding the home area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Refreshing the list of folders and tags . . . . . . . . . . . . . . . . . . . . . . 7-14
Working with tags in the Tag Browser . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Displaying tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Showing or hiding tag descriptions . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Selecting tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Using the selected tags list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16

iv ■ RSView Supervisory Edition User’s Guide


Displaying tag properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Filtering tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Creating, editing, and importing HMI tags . . . . . . . . . . . . . . . . . . . 7-19
Using tag references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Absolute references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
Relative references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
The home area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
Logging tag values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21

Creating HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8- 1


HMI tag types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Data sources for HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Organizing HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Naming HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Using folders to group HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
The Tags editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Using the Accept and Discard buttons . . . . . . . . . . . . . . . . . . . . . 8-5
Using the form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
Using the query box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Using the folder hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Creating a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7
Opening a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Adding tags to a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Nesting a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Duplicating a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
Deleting a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
Using the spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Moving through the spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Resizing columns and rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Adding a tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Duplicating a tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
Editing a tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
Deleting a tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
Setting up tag type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13
Setting up an analog tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13
Setting up a digital tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
Setting up a string tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17

Contents ■ v
Specifying a data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Specifying device as the data source . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Specifying memory as the data source . . . . . . . . . . . . . . . . . . . . . . 8-20
Other methods for creating HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . 8-20
Creating tags in a third-party application . . . . . . . . . . . . . . . . . . . 8-21
Creating tags as needed in other RSView editors . . . . . . . . . . . . . 8-21
Importing tags from a PLC database . . . . . . . . . . . . . . . . . . . . . . . . 8-21
Using the Tag Import and Export Wizard . . . . . . . . . . . . . . . . . . . 8-24
Adding alarms to HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
Getting HMI tag values from servers . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25

Creating derived tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9- 1


How to use derived tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
How to use multiple derived tag components . . . . . . . . . . . . . . . . . . 9-2
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
The Derived Tags editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Using the Check Syntax button . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Using the Accept and Discard buttons . . . . . . . . . . . . . . . . . . . . . 9-3
Setting the maximum update rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Creating derived tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Editing derived tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
Starting and stopping derived tag processing . . . . . . . . . . . . . . . . . . . 9-7
Ways to start derived tag processing . . . . . . . . . . . . . . . . . . . . . . . 9-7
Ways to stop derived tag processing . . . . . . . . . . . . . . . . . . . . . . . 9-8

Setting up alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10- 1


Summary of features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Key concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Alarms for analog HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Alarms for digital HMI tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
Alarm severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
Alarm messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
Alarm log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
Alarm displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
Alarm system tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
Alarm acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
Alarm suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
Alarm functions in expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14
Acknowledge bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16

vi ■ RSView Supervisory Edition User’s Guide


Handshake bit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17
Switching handshaking on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17
Alarm events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21
The Alarm Setup editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22
Setting up alarm trigger thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22
Setting up alarm severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23
Setting up alarm messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26
Types of messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-26
Defining the content of the message . . . . . . . . . . . . . . . . . . . . . . . 10-26
Adding remarks to the alarm log file at run time . . . . . . . . . . . . . . . . 10-30
Specifying alarm conditions for analog and digital tags . . . . . . . . . . 10-31
When to set up alarms for tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-32
Setting up alarms for analog tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-32
Setting up alarm thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33
Setting up alarm messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35
Setting up advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-36
Setting up alarms for digital tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38
Setting up alarm states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39
Setting up alarm messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41
Setting up advanced features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42
Setting up alarm logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-44
Specifying where to store alarm log files . . . . . . . . . . . . . . . . . . . . . . . 10-46
Creating log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47
Monitoring disk space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-47
Managing log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48
Creating files periodically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-49
Creating files on demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-49
Never creating new files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-50
Deleting log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-50
Logging to a central database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-52
Exporting alarm log files manually to ODBC format . . . . . . . . . . . . . . 10-54
Editing alarm log setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-55
Specifying the security settings of the alarm log program files . . . . . 10-56
About alarm log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-57
How log files are named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-57
Viewing alarm log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-58

Contents ■ vii
Using the alarm log viewer at run time . . . . . . . . . . . . . . . . . . . . . 10-59
Creating an alarm summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-60
Creating an alarm summary object . . . . . . . . . . . . . . . . . . . . . . . . 10-60
The parts of an alarm summary . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-61
Inserting headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-62
Choosing fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-63
Choosing colors and blink styles . . . . . . . . . . . . . . . . . . . . . . . . . . 10-64
Formatting buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-65
Choosing data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-69
Filtering data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-70
Sorting data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-75
Running commands, macros, or custom
programs in response to alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-76
Using alarm data with commands . . . . . . . . . . . . . . . . . . . . . . . . . 10-79
Viewing the area name in tag names . . . . . . . . . . . . . . . . . . . . . . . 10-82
Suppressing alarm printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-82
Using AlarmOn and AlarmPrintOff in the correct order . . . . . . 10-83
Suppressing alarm monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-83
Suppressing alarm monitoring for tags . . . . . . . . . . . . . . . . . . . . . 10-84
Viewing suppressed tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-84
Using the Suppressed List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-85
More RSView commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-85
Starting and stopping alarm monitoring . . . . . . . . . . . . . . . . . . . . . . . 10-86
Ways to start alarm monitoring at the HMI server . . . . . . . . . . . . . 10-86
Ways to stop alarm monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-87

Setting up activity logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11- 1


Which activities can be logged? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
The Activity Log Setup editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Specifying where to store activity log files . . . . . . . . . . . . . . . . . . . . . 11-3
Creating log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
Monitoring disk space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
Creating files periodically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
Creating files on demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
Never creating new files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
Deleting log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
About activity log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
How log files are named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8

viii ■ RSView Supervisory Edition User’s Guide


Specifying which activities are logged . . . . . . . . . . . . . . . . . . . . . . . . . 11-10
Logging to a central database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
Specifying the security settings of the activity log service . . . . . . . . 11-13
Exporting activity log files manually to ODBC format . . . . . . . . . . . . 11-14
Editing activity log setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15
Using the activity bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
Hiding, showing, and moving the activity bar . . . . . . . . . . . . . . . 11-17
Messages in the activity bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
Using the Activity Log Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
Using the activity log viewer at run time . . . . . . . . . . . . . . . . . . . 11-20
Tracking system usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20

Setting up data logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12- 1


What is a model? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
How to use multiple data log models . . . . . . . . . . . . . . . . . . . . . . 12-1
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
About data log storage formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
The log file sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
How log file sets are named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
The ODBC database storage format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
How ODBC tables are named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
Using an existing ODBC data source . . . . . . . . . . . . . . . . . . . . . . . . 12-5
Creating a new ODBC data source . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
The Data Log Setup editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
Setting up a model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
Setting up logging paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12
Switching logging paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12
Specifying log paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
Specifying the security settings of the data log program file and related ser-
vices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-18
Using the DataLogSwitchBack command to switch logging paths . 12-20
Using the DataLogMergeToPrimary command to move secondary files to
the primary path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-21
Creating file sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
Monitoring disk space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
Creating files periodically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-23
Creating files at specified times . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-24
Creating files when a particular event occurs . . . . . . . . . . . . . . . . 12-25

Contents ■ ix
Never creating new files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-25
Using the DataLogNewFile command to create files . . . . . . . . . . . . 12-26
Deleting ODBC database records and file sets . . . . . . . . . . . . . . . . . . . 12-27
Specifying when to log data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-30
Logging periodically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-31
Logging on change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-31
Logging on demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-32
Using the DataLogSnapshot command . . . . . . . . . . . . . . . . . . . . . 12-33
Combining logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-34
Providing operators with a way to log on demand . . . . . . . . . . . 12-34
Choosing the data to be logged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-35
Editing the data log model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-36
Changing log paths using the RSView Administration Console 12-36
Making run-time changes without editing the data log model . . . . . 12-37
Changing the log rate for periodic logging . . . . . . . . . . . . . . . . . . 12-38
Changing the log file identifier string . . . . . . . . . . . . . . . . . . . . . . 12-38
Displaying historical data in a trend . . . . . . . . . . . . . . . . . . . . . . . . . . 12-39
Starting and stopping data logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-39
Ways to start data logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-39
Ways to stop data logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-40

Setting up events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13- 1


How to use multiple event components . . . . . . . . . . . . . . . . . . . . . . . 13-1
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
The Events editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
Using the Accept and Discard buttons . . . . . . . . . . . . . . . . . . . . . 13-3
Using the Check Syntax button . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Setting the maximum update rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Creating events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
Editing events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6
Starting and stopping event processing . . . . . . . . . . . . . . . . . . . . . . . . 13-7
Ways to start event processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
Ways to stop event processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8

Adding security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14- 1


Set up users, codes, and secure access . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Before you begin, make lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Finding your way around . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4

x ■ RSView Supervisory Edition User’s Guide


Setting up user accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Setting up default access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Ensuring you always have access . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Adding users or groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Removing users or groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Assigning security codes to users or groups . . . . . . . . . . . . . . . . . . . . 14-8
Login and logout macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Securing commands and macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Security codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
The Unspecified_Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
Setting up security by inclusion . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11
Setting up security by exclusion . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
Assigning security to a graphic display . . . . . . . . . . . . . . . . . . . . . . . . 14-13
Assigning security to an OLE object . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14
Assigning security to an HMI tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15
Preventing users from modifying an application . . . . . . . . . . . . . . . . 14-16
Locking users into the RSView SE Client environment . . . . . . . . . . 14-17
Logging in at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
Logging out at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18
Changing passwords at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18

Creating graphic displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15- 1


About graphic displays and graphic objects . . . . . . . . . . . . . . . . . . . . 15-1
The Graphic Displays editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2
The editor’s main components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2
Mastering basic techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
Using the shortcut menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-3
Switching between Edit Display and Test Display modes . . . . . 15-4
Using the toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-5
Selecting a drawing tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6
Selecting colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7
Selecting and deselecting objects . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7
Using the grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8
Using the Rotate tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8
Zooming in and out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10
Correcting mistakes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
Setting up the display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
Creating default display settings . . . . . . . . . . . . . . . . . . . . . . . . . . 15-12

Contents ■ xi
Using the Display Settings dialog box . . . . . . . . . . . . . . . . . . . . . . 15-13
Setting up display properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-14
Specifying the display type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-15
Allowing multiple running copies . . . . . . . . . . . . . . . . . . . . . . . . . 15-16
Specifying caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-17
Setting up the title bar and other display attributes . . . . . . . . . . . 15-18
Preventing scroll bars on the main window . . . . . . . . . . . . . . . . . 15-20
Specifying display size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-21
Specifying how displays are resized . . . . . . . . . . . . . . . . . . . . . . . . 15-22
Specifying display position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-23
Specifying a security code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-23
Specifying background color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-23
Setting up display behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-24
Specifying startup and shutdown commands . . . . . . . . . . . . . . . . 15-25
Specifying colors for input fields. . . . . . . . . . . . . . . . . . . . . . . . . . . 15-26
Specifying the behavior of interactive objects . . . . . . . . . . . . . . . . 15-26
Specifying the behavior of objects with input focus . . . . . . . . . . 15-27
Displaying the on-screen keyboard . . . . . . . . . . . . . . . . . . . . . . . . 15-28
Displaying graphics more quickly . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-30
Removing displays from the cache . . . . . . . . . . . . . . . . . . . . . . . . . 15-30
Types of graphic objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-31
Creating drawing objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-32
Creating text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-32
Choosing a font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-32
Font substitution at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-35
Adding an image to a graphic display . . . . . . . . . . . . . . . . . . . . . . 15-35
Pasting images into graphic displays . . . . . . . . . . . . . . . . . . . . . . . 15-36
Placing images in graphic displays . . . . . . . . . . . . . . . . . . . . . . . . . 15-36
Adding images to your application . . . . . . . . . . . . . . . . . . . . . . . . 15-40
Creating a panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-41
Drawing a rounded rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-43
Drawing a rectangle or square . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-44
Drawing an ellipse or circle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-44
Drawing a line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-45
Drawing a polyline or polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-45
Drawing a freehand object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-46
Drawing an arc or wedge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-46
Changing the properties of drawing objects . . . . . . . . . . . . . . . . . . . . 15-48
Reshaping drawing objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-50
Creating objects that use data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-51

xii ■ RSView Supervisory Edition User’s Guide


Objects described in other chapters . . . . . . . . . . . . . . . . . . . . . . . . 15-51
Using tag names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-52
Using tag placeholders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-52
Replacing tag placeholders using a parameter file . . . . . . . . . . . . 15-54
Replacing tag placeholders using parameters to the
Display command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-56
How to use push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-58
Setting up push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-60
How to use the States tab for push buttons . . . . . . . . . . . . . . . . . 15-61
How to use the Connections tab for push buttons . . . . . . . . . . . 15-63
How the Value tag works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-64
How the Indicator tag works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-65
Creating push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-65
Creating Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-66
Setting up the button’s appearance, and how it works
at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-67
Setting up the button’s actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-68
Setting up what the button looks like when it is not pressed . . . 15-70
Setting up what the button looks like when it is pressed . . . . . . . 15-72
Editing a button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-72
Reshaping a button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-73
Creating momentary push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-73
Setting up the appearance and action of the
momentary push button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-75
Setting up what the momentary push button does
when it is pressed and released . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-78
Connecting the momentary push button to data . . . . . . . . . . . . . 15-83
Creating maintained push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-83
Setting up the appearance of the maintained push button,
and how it changes state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-85
Setting up what the maintained push button does
when it is pressed and released . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-87
Connecting the maintained push button to data . . . . . . . . . . . . . 15-92
Creating latched push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-93
Setting up the appearance of the latched push button,
and how to unlatch it . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-95
Setting up what the latched push button does
when it is latched and unlatched . . . . . . . . . . . . . . . . . . . . . . . . . . 15-97
Connecting the latched push button to data . . . . . . . . . . . . . . . . . 15-102
Creating multistate push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-103
Setting up the appearance of the multistate push button,
and how it changes state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-105

Contents ■ xiii
Setting up what the multistate push button does when it is pressed and
released . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-108
Setting up whether the multistate push button repeats
when held down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-112
Connecting the multistate push button to data . . . . . . . . . . . . . . 15-113
Creating interlocked push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-114
Setting up the appearance and value of the
interlocked push button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-116
Setting up the appearance of the interlocked push button
when it is pressed and released . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-118
Connecting the interlocked push button to data . . . . . . . . . . . . . 15-122
Creating ramp push buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-123
Setting up the appearance of the ramp push button,
and how it works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-125
Setting up the text that appears on the ramp push button . . . . . . 15-128
Setting up whether the ramp push button repeats
when held down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-131
Connecting the ramp push button to data . . . . . . . . . . . . . . . . . . . 15-132
Creating numeric or string fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-132
Creating numeric display fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-133
Creating string display fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-134
Creating numeric or string input fields . . . . . . . . . . . . . . . . . . . . . 15-136
Using input fields at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-142
Updating tag values continuously . . . . . . . . . . . . . . . . . . . . . . . . . 15-142
Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-143
RSView commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-144
Using the on-screen keyboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-144
How to use indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-146
How to use the States tab for indicators . . . . . . . . . . . . . . . . . . . . 15-147
How to use the Connections tab for indicators . . . . . . . . . . . . . . 15-148
Creating multistate indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-148
Setting up the appearance of the multistate indicator,
and its number of states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-150
Setting up how the multistate indicator’s appearance
changes to match its value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-151
Connecting the multistate indicator to data . . . . . . . . . . . . . . . . . 15-155
Creating symbol indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-156
Setting up the appearance of the symbol indicator,
and its number of states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-158
Setting up how the symbol indicator changes appearance
when its value changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-159
Connecting the symbol indicator to data . . . . . . . . . . . . . . . . . . . 15-161

xiv ■ RSView Supervisory Edition User’s Guide


Creating list indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-162
Setting up the appearance of the list indicator,
and its number of states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-164
Setting up how the list indicator’s appearance
changes when its value changes . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-166
Connecting the list indicator to data . . . . . . . . . . . . . . . . . . . . . . . 15-168
How to use gauges and graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-168
How to use the Connections tab for gauges and graphs . . . . . . . 15-171
Creating gauges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-172
Setting up the appearance of the gauge . . . . . . . . . . . . . . . . . . . . . 15-173
Setting up how the gauge works . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-175
Connecting the gauge to data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-177
Creating bar graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-177
Setting up the appearance of the bar graph . . . . . . . . . . . . . . . . . . 15-179
Connecting the bar graph to data . . . . . . . . . . . . . . . . . . . . . . . . . . 15-181
Creating scales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-181
Setting up the appearance of the scale . . . . . . . . . . . . . . . . . . . . . . 15-183
How to use keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-185
Creating keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-187
Setting up the appearance of the key . . . . . . . . . . . . . . . . . . . . . . . 15-189
Adding text or an image to the key . . . . . . . . . . . . . . . . . . . . . . . . 15-192
Setting up whether the key repeats when held down . . . . . . . . . . 15-196
Creating advanced objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-197
Objects described in other chapters . . . . . . . . . . . . . . . . . . . . . . . . 15-197
Creating arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-198
How to use control list selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-200
How to use the States tab for control list selectors . . . . . . . . . . . 15-201
How to use the Connections tab for control list selectors . . . . . 15-202
Creating control list selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-205
Setting up the appearance of the control list selector . . . . . . . . . . 15-207
Setting up the control list selector’s value and appearance . . . . . 15-210
Setting up the control list selector to work with an Enter key . . 15-212
Connecting the control list selector to data . . . . . . . . . . . . . . . . . 15-213
Creating tag labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-214
How to use display list selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-216
Creating display list selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-217
Setting up the appearance of the display list selector . . . . . . . . . . 15-219
Setting up which displays appear in the display list selector . . . . 15-222
How to use local message displays . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-224

Contents ■ xv
Creating local message displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-225
Setting up the appearance of the local message display . . . . . . . . 15-227
Connecting the local message display to data . . . . . . . . . . . . . . . . 15-229
Creating recipe fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-230
Creating a recipe file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-231
Using a recipe at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-234
Creating time and date displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-237
Setting up the appearance of the time and date display . . . . . . . . 15-238
Using local messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-240
Basic steps for setting up local messages . . . . . . . . . . . . . . . . . . . . 15-240
Creating local messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-244
Creating local messages using a spreadsheet application . . . . . . . 15-245
Creating and editing OLE objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-247
Other methods for inserting OLE objects . . . . . . . . . . . . . . . . . . . . 15-248
Converting OLE objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-249
Creating and editing ActiveX objects . . . . . . . . . . . . . . . . . . . . . . . . . 15-251
Making ActiveX objects interact with RSView . . . . . . . . . . . . . . 15-253
Using VBA code to make ActiveX objects interact
with RSView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-254
Using the ActiveX Toolbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-254
Deploying ActiveX components automatically at run time . . . . . . . 15-256
Replacing text associated with objects . . . . . . . . . . . . . . . . . . . . . . . . 15-256
Using the Property Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-258
Setting up properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-259
Assigning tags and expressions to objects . . . . . . . . . . . . . . . . . . . 15-262
Naming graphic objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-264
Adding ToolTips to objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-264
Working with objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-266
Selecting and deselecting objects . . . . . . . . . . . . . . . . . . . . . . . . . . 15-266
Using the Object Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-268
Moving objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-270
Copying objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-271
Duplicating objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-273
Resizing objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-274
Arranging objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-275
Grouping and ungrouping objects . . . . . . . . . . . . . . . . . . . . . . . . . 15-276
Editing grouped objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-277
Stacking objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-278
Aligning objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-279

xvi ■ RSView Supervisory Edition User’s Guide


Spacing objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-283
Flipping objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-284
Applying colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-285
Applying pattern styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-286
Selecting pattern styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-286
Applying pattern styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-287
How colors and patterns work . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-287
Changing line properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-288
Creating a background for your display . . . . . . . . . . . . . . . . . . . . . . . 15-289
Importing graphic files from third-party applications . . . . . . . . . . . . 15-290
Converting imported objects to RSView native objects . . . . . . . 15-291
Using bitmaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-292
When could a bitmap help? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-293
Using graphic libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-294
Location of library files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-294
Printing displays at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-296

Animating graphic objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16- 1


Types of animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1
Using the Animation dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-3
Using the Animation dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . 16-4
Using Object Smart Path to set animation visually . . . . . . . . . . . 16-6
Testing animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-7
Using tag names and tag placeholders . . . . . . . . . . . . . . . . . . . . . . . . . 16-7
Tag names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Tag placeholders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Using commands and macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-8
Using expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-9
Setting the range of tag values for animating the object . . . . . . . . . . 16-9
Limiting the range of values used for animation . . . . . . . . . . . . . 16-10
Defining a range of motion for the object . . . . . . . . . . . . . . . . . . . . . . 16-11
Objects that do not have a range of motion . . . . . . . . . . . . . . . . . 16-11
Using OSP (Object Smart Path) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-11
Setting up visibility animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-14
Setting up color animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-15
Using the colors and thresholds list . . . . . . . . . . . . . . . . . . . . . . . . 16-16
Setting up fill animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-22

Contents ■ xvii
Setting up horizontal position animation . . . . . . . . . . . . . . . . . . . . . . 16-24
Setting up vertical position animation . . . . . . . . . . . . . . . . . . . . . . . . . 16-26
Setting up width animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-28
Setting up height animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-30
Setting up rotation animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-32
How rotation animation works . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-32
Setting up touch animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-36
Setting up horizontal slider animation . . . . . . . . . . . . . . . . . . . . . . . . 16-38
Setting up vertical slider animation . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-40
Setting up OLE verb animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-42
Attaching other types of animation to OLE objects . . . . . . . . . . . 16-43
Animating ActiveX controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-43
Naming an ActiveX object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-44
Connecting tags to an ActiveX object’s properties . . . . . . . . . . . . . . 16-45
Connecting tags to an object’s methods . . . . . . . . . . . . . . . . . . . . . . . 16-46
Viewing an object’s methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-47
Using the Invoke command to call a method . . . . . . . . . . . . . . . . 16-47
Connecting tags to an ActiveX object’s events . . . . . . . . . . . . . . . . 16-49
Using VBA code to make ActiveX objects interact
with RSView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-50
Associating objects and displays with keys . . . . . . . . . . . . . . . . . . . . 16-50
Creating object keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-51
Using index numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-54
How tab index numbers work . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-54
Checking an object’s index number . . . . . . . . . . . . . . . . . . . . . . . . 16-55
Changing index numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-55
Creating a tab sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-57
Using the Current [Tag] parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-58
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-58
Three examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-59
Creating display keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-65
Editing display and object keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-67
Modifying a key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-67
Removing a key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-68
Removing all keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-68
Viewing the key list at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-69
Disabling the key list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-70

xviii ■ RSView Supervisory Edition User’s Guide


Applying animation to groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-70
Checking the animation on objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-70
Checking animation using the menu or the
Animation dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-71
Finding an object that is animated by a tag . . . . . . . . . . . . . . . . . . 16-72
Changing the animation on objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-73
Copying or duplicating objects with animation . . . . . . . . . . . . . . . . . 16-73
Copying animation without copying objects . . . . . . . . . . . . . . . . . . . 16-74

Setting up trends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17- 1


What is a trend? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
The parts of a trend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3
Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3
x-axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3
x-axis legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4
y-axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4
y-axis legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4
Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-5
Legends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-5
Pen icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-6
TrendX Properties dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-6
Pen markers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-7
Value Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8
Main concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8
Plotting tag limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8
Displaying data in a trend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-9
Comparing pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-10
Trend chart types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-15
Standard Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-15
XY Plot Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-16
Isolated graphing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-17
Choosing trend colors, fonts, lines, and markers . . . . . . . . . . . . . . . . 17-18
Changing the trend highlight color . . . . . . . . . . . . . . . . . . . . . . . . 17-18
Changing the trend chart background color . . . . . . . . . . . . . . . . . 17-19
Changing the trend object background . . . . . . . . . . . . . . . . . . . . . 17-20
Testing the trend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-21
Summary of steps for creating a trend . . . . . . . . . . . . . . . . . . . . . . . . . 17-21
Creating a trend object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-22
Setting up a Trend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-23

Contents ■ xix
Setting up the appearance of a trend . . . . . . . . . . . . . . . . . . . . . . . . . . 17-23
Selecting a chart style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-25
Setting up the chart update method . . . . . . . . . . . . . . . . . . . . . . . . 17-26
Setting up the chart display options . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-28
Displaying a current value legend . . . . . . . . . . . . . . . . . . . . . . . . . 17-30
Displaying a line legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-31
Determining how the trend chart is filled with data . . . . . . . . . . 17-33
Adding pens to the trend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-35
Adding a pen from a data log model . . . . . . . . . . . . . . . . . . . . . . . 17-36
Deleting a pen from the trend . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-38
Setting up pen attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-38
Editing multiple pens simultaneously . . . . . . . . . . . . . . . . . . . . . . 17-44
Setting up the horizontal axis (x-axis) . . . . . . . . . . . . . . . . . . . . . . . . . 17-45
Setting up the X-Axis display options . . . . . . . . . . . . . . . . . . . . . . 17-46
Setting up the vertical axis (y-axis) . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-48
Defining the range of numbers on the vertical axis . . . . . . . . . . . 17-48
Setting up the Y-Axis display options . . . . . . . . . . . . . . . . . . . . . . 17-50
Setting up a vertical scale for multiple pens . . . . . . . . . . . . . . . . . 17-52
Comparing real-time and historical data . . . . . . . . . . . . . . . . . . . . . . . 17-53
Setting up snapshots and overlays . . . . . . . . . . . . . . . . . . . . . . . . . 17-54
Changing the attributes of a snapshot pen . . . . . . . . . . . . . . . . . . 17-55
Setting up overlay attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-56
Creating a trend template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-58
Creating and saving a new template . . . . . . . . . . . . . . . . . . . . . . . 17-59
Loading a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-60
Deleting a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-60
Loading a template during run time . . . . . . . . . . . . . . . . . . . . . . . 17-61
Setting up the trend’s run-time behavior . . . . . . . . . . . . . . . . . . . . . . . 17-62
Changing the trend’s appearance at run time . . . . . . . . . . . . . . . . 17-62
Setting up chart behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-63
Setting up shortcut menu options . . . . . . . . . . . . . . . . . . . . . . . . . 17-63
Using the Trends graphic library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-65
Using the trend at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-66
Collecting data in the background during run time . . . . . . . . . . . 17-66
Selecting pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-67
Opening TrendX tabs at run time . . . . . . . . . . . . . . . . . . . . . . . . . 17-67
Using the shortcut menu at run time . . . . . . . . . . . . . . . . . . . . . . . 17-68
Scrolling options at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-68
Using the value bar at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-68

xx ■ RSView Supervisory Edition User’s Guide


Using zoom at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-69
Using pan at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-70
Using the arrow keys at run time . . . . . . . . . . . . . . . . . . . . . . . . . . 17-70
Printing the trend chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-71
Using overlays at run time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-71
Fixing run-time errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-71

Creating expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18- 1


About expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
Expression components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
Where you can use expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
Using expressions in a command . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
Creating expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
Expression buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-3
Cutting, copying, and pasting expressions . . . . . . . . . . . . . . . . . . . . . 18-4
Formatting expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-5
Using tag names and tag placeholders . . . . . . . . . . . . . . . . . . . . . . . . . 18-6
Using area names with tag names . . . . . . . . . . . . . . . . . . . . . . . . . . 18-7
Using tag placeholders instead of tag names . . . . . . . . . . . . . . . . . 18-7
Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-8
Arithmetic operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-8
String operands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-9
Relational operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-10
How string operands are evaluated . . . . . . . . . . . . . . . . . . . . . . . . 18-10
Logical operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-11
Bitwise operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-12
Built-in functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-14
Tag functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-14
Time functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-17
File functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-21
Math functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-21
Security functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-22
Evaluation order of operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-23
If – then – else . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-25
Nested if – then – else structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-27

Contents ■ xxi
Setting up navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19- 1
Developing a hierarchy of displays . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1
Ways of moving among displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-2
Commands for moving among displays . . . . . . . . . . . . . . . . . . . . 19-3
Reducing display call-up time . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-4
Where to use RSView commands . . . . . . . . . . . . . . . . . . . . . . . . . . 19-4
Examples of navigation methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-5
The tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-7
Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-7
Creating macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-7
Using parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-10
Nesting macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-11
Creating a macro that runs when an HMI server starts . . . . . . . . . 19-12
Creating symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-12
Important guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-13
Key definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-14
General rules about precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-15
Precedence and the F1 key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-16
Precedence and embedded ActiveX objects . . . . . . . . . . . . . . . . . 19-16
Precedence and embedded OLE objects . . . . . . . . . . . . . . . . . . . . . 19-17
Reserved keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-17
Creating client keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-19
Running client key components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-22

The ODBC database schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20- 1


Activity log table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
Alarm log table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-2
Data log tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-4

Using the SE Client object model and display code . . . . . 21- 1


About the RSView SE Client object model . . . . . . . . . . . . . . . . . . . . 21-1
The VBA integrated development environment . . . . . . . . . . . . . . . . . . 21-2
Opening the IDE window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-3
Parts of the IDE window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-4
Quick Start steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-5
Step 1 H Start with a graphic display . . . . . . . . . . . . . . . . . . . . . . 21-5
Step 2 H Create your VBA code . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-5
How VBA code runs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-6

xxii ■ RSView Supervisory Edition User’s Guide


About procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-6
The RSView SE Client Object Model . . . . . . . . . . . . . . . . . . . . . . . . . 21-6
Viewing the objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-8
Getting Help with RSView SE Client objects . . . . . . . . . . . . . . . 21-9
Opening Help from the Object Browser . . . . . . . . . . . . . . . . . . . 21-10
Opening Help from the Code Window . . . . . . . . . . . . . . . . . . . . . 21-11
Opening Help from the RSView Help Contents window . . . . . 21-11
Using VBA Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-12
VBA documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-12

Deploying and administering applications . . . . . . . . . . . . . . . 22- 1


Deploying your application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-2
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-2
Setting up the FactoryTalk Directory . . . . . . . . . . . . . . . . . . . . . . . . . 22-4
Specifying HMI server startup components . . . . . . . . . . . . . . . . . . . . . 22-5
Moving HMI server files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-7
Setting up HMI server properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-8
Starting and stopping an HMI server’s
components manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-11
Setting data server properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-12
Setting up RSView SE Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-12
Opening RSView SE Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-14
Opening the RSView SE Client automatically
when Windows starts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-15
Opening multiple clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-15
How server components start and stop . . . . . . . . . . . . . . . . . . . . . 22-16
Specifying time, date, and number formats . . . . . . . . . . . . . . . . . . . . . 22-16
Administering your application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-17
Monitoring disk space on the HMI server . . . . . . . . . . . . . . . . . . . . . . . 22-19

RSView commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A- 1
Using RSView commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Where to use commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
How to use commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Using placeholders in commands . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
Where commands are executed . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5
Commands that are not executed in test display mode . . . . . . . . A-7
Absolute and relative references . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7

Contents ■ xxiii
How relative references are resolved . . . . . . . . . . . . . . . . . . . . . . . A-8
Using the command line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9
Using the Command Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10
Building a command string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
The RSView commands, organized alphabetically . . . . . . . . . . . . . . A-14

System tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B- 1
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4

Setting up direct driver communications for HMI tags . . C- 1


Overview of direct driver communications . . . . . . . . . . . . . . . . . . . . C-1
Communication channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Communication device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Communication driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Node (control device) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
Setting up direct driver communication to programmable controllers C-3
Setting up communications without hardware or software . . . . . C-4
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4
Setting up RSLinx drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5
Using the drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5
Selecting a driver in RSView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6
Setting up channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6
Changing the channel configuration . . . . . . . . . . . . . . . . . . . . . . . C-11
Switching communication drivers at run time . . . . . . . . . . . . . . . . . . C-11
Commands for switching drivers . . . . . . . . . . . . . . . . . . . . . . . . . . C-11
Switching drivers automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . C-12
Switching drivers manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-12
Creating a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13
Changing node information at run time . . . . . . . . . . . . . . . . . . . . . . . C-17
Scanning for new tag values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-17
RSView scan classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-18
Guidelines for setting up scan classes . . . . . . . . . . . . . . . . . . . . . . C-18
Monitoring communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-20

Setting up DDE communications for HMI tags . . . . . . . . . . . D- 1


Where to find information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

xxiv ■ RSView Supervisory Edition User’s Guide


About DDE communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
Overview of DDE communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-4
Creating a DDE node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-4
Changing node information at run time . . . . . . . . . . . . . . . . . . . . . . . D-7
Scanning for new tag values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-8

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I- 9

Contents ■ xxv
P Preface
Thank you for choosing RSViewt Enterprise Supervisory Edition.
RSView Supervisory Edition is a member of the RSView
Enterprise Series family of products. It is an integrated package for
developing and running multi-user, distributed-server
human-machine interface applications. RSView Supervisory Edition
is designed for automated process or machine monitoring, and
supervisory control.

Designed for use with Microsoftr Windowsr 2000, RSView


Supervisory Edition gives you all the tools you need to create
effective monitoring and supervisory control applications.

About the documentation

The RSView documentation set includes:

Release Notes: Information you should read before you begin


installing or working with the software.

RSView Supervisory Edition Installation Guide: A guide to


installing the various components of RSView Supervisory Edition.

RSView Supervisory Edition User’s Guide: Comprehensive


information about RSView Supervisory Edition, procedures for
creating and running a supervisory-level automation application,
and reference information.

Help: Online procedures and reference information.

Preface ■ P--1
Preface
Technical support services

You have many options for finding information about how to use
RSView, or how to solve problems with RSView.

Try the user’s guides and Help first

The RSView user’s guides and Help provide comprehensive


information about typical uses of RSView. Chances are, your
question is answered in the documentation.

To find the answer, use the table of contents and the index in the
user’s guides and Help.

You can also perform a full-text search on both the Help and the
PDF versions of the user’s guides. For information about using Help
and the user’s guides, see Chapter 3, “Getting the information you
need” in the RSView Supervisory Edition Installation Guide.

Information on the Internet

If you can’t find the answer to your question or problem in the


user’s guides or Help, you can also find information on the
World Wide Web.

The Rockwell Software support web sites

http://www.software.rockwell.com
http://support.rockwellautomation.com

The Rockwell Software support web sites include comprehensive


searchable databases of support information for all Rockwell
Automation and Rockwell Software products.

P--2 ■ RSView Supervisory Edition User’s Guide


Accessing support pages on the Internet

To access Rockwell Software’s support pages on the Internet from


within RSView, click Help, Rockwell Software on the Web, and
then click the name of the web page you want to view.

To use Rockwell Software on the Web, you must have a web


browser installed on your computer, and you must have an active
Internet connection.

The RSView Forum

http://www.rsviewforum.com

The RSView Forum is a web site for users like you. The RSView
Forum offers:

an RSView frequently-asked questions (FAQ) list, for information


about how to solve the problems our technical support teams
encounter most often

discussion groups, for exchanging tips and questions with other


RSView users

design resources, to help you put together graphic displays, VBA


code samples for extending the functionality of RSView, and
ready-made ActiveX objects you can use in your own RSView
applications

information about what’s new, including product


announcements, new articles and information provided by
Rockwell Software

Preface ■ P--3
Preface
Contacting Rockwell Software Technical
Support

If you can’t find the answer to your question using any of the
resources suggested above, contact Rockwell Software Technical
Support at:

Telephone: 440–646–5800

Fax: 440–646–5801

World Wide Web Support web site:


http://www.software.rockwell.com
http://support.rockwellautomation.com

Support staff are available Monday to Friday from 8 AM to 5 PM


local time (North America only), except during holidays.

When you call

When you call, you should be at your computer and ready to give
the following information:

the product serial number

You’ll find this number on the Activation disk label and in the
Help About dialog box in RSView Studio.

the product version number

the type of hardware you are using

the exact wording of any messages that appeared on your screen

a description of what happened and what you were doing when


the problem occurred

a description of how you tried to solve the problem

You may also be required to provide information about the RSView


add-ons and updates that are installed on your computer.

P--4 ■ RSView Supervisory Edition User’s Guide


To view the list of installed add--ons and updates

1. In RSView Studio, click Help, and then click About RSView


Studio.

2. To view the list of installed add-ons, click Add-ons.

3. To view the list of installed updates, click Updates.

Preface ■ P--5
1
Chapter

Getting started
This chapter introduces RSView Supervisory Edition, and describes:

the main parts of RSView Supervisory Edition

the features of RSView Supervisory Edition in brief

the RSView Enterprise tools

how to get started using RSView Studio

For information about installing RSView, see the


RSView Supervisory Edition Installation Guide.

The main parts of RSView Supervisory Edition


RSView Supervisory Edition consists of several pieces of software
you can use to build powerful automation applications. Depending
on the particular software package(s) you purchased and installed,
you might have one or more of these pieces of software:

RSView Studio is configuration software for developing and testing


machine- and supervisory-level human-machine interface (HMI)
applications.

For information about developing machine-level HMI applications,


see the RSView Machine Edition User’s Guide.

RSView Studio contains editors for creating a complete


human-machine interface application, and contains software for
testing the applications you create. Use the editors to create
applications that are as simple or as sophisticated as you need.

Getting started ■ 1--1


Preface
When you have finished developing your application, use RSView
SE Client to view and interact with your application.

Use the Graphic Displays


editor to create graphical
displays of your process.

RSView SE Client is software for viewing and interacting with


supervisory-level applications developed using RSView Studio.

RSView Administration Console is software for administering


RSView Supervisory Edition applications after they have been
deployed. RSView Administration Console contains a sub-set of
the RSView Studio editors, so you can make minor changes to an
application, without the need for installing RSView Studio.

RSView SE Server stores HMI project components (for example,


graphic displays), and serves these components to clients. The
server also contains a database of tags, and performs alarm
detection, and historical data management (logging).

The RSView SE Server has no user interface. Once installed, it runs


as a set of ‘headless’ Windows services that supply information to
clients when they request it.

FactoryTalkt
t Directory is software that supplies a directory of
services (for example, RSView SE Servers, or OPC servers) and

1--2 ■ RSView Supervisory Edition User’s Guide


names (for example, areas, tags, graphic displays, log models, and so
on) to any RSView Supervisory Edition computer on the network.

Features in brief
With RSView Supervisory Edition, you can:

distribute the parts of your application in a way that mirrors


your plant or process. Your distributed application can contain
several servers, distributed across multiple computers on your
network. Multiple client users can access this application
simultaneously from anywhere on your network.

create and edit graphic displays with sophisticated


object-oriented graphics and animation. Simple drag-and-drop
and cut-and-paste techniques simplify application configuration.

use graphics from the graphic libraries, or import files from


other drawing packages such as Corel DRAW!t, and
Adobe® Photoshop®

use the ActiveX and OLE container capabilities of RSView to


take advantage of advanced technology. For example, embed
Visual Basic® ActiveX Controls, or other ActiveX components
in graphic displays to extend the capabilities of RSView.

use the RSView SE Client Object Model and VBA to share data
with other Windows programs such as Microsoft Access and
Microsoft SQL Server, interoperate with other Windows
programs such as Microsoft Excel, and customize and extend
RSView to fit your unique needs

develop your application quickly using RSView productivity


tools such as the Command Wizard, Tag Browser, and Object
Smart Patht (OSP)

avoid entering information twice. Import an Allen-Bradley PLC


or SLC database with the PLC Database Browser. Take advantage
of RSView’s direct tag referencing abilities, to make direct use of
tags that reside in controllers or devices.

Getting started ■ 1--3


Preface
use the RSView alarm notification capability to monitor process
incidents with multiple levels of severity. Create multiple alarm
summaries to provide specific alarm data rather than viewing the
alarms for the entire system.

create trends that show process variables plotted against time.


Display real-time or historical data with up to 100 pens (tags) in
each trend.

log data simultaneously to multiple log files or remote ODBC


databases, to provide various records of production data. Bring
the ODBC logged data directly into other third-party programs
such as Microsoft Access and Seagate Crystal Reportst without
converting files.

lock operators into the RSView SE Client by disabling Windows


keys

The RSView Enterprise tools


Depending on the particular software package(s) you installed, you
might have one or more of the following tools installed.

Tag Import and Export Wizard is software for importing or


exporting the RSView SE Server’s tag database.

DeskLock is software that prevents Windows users from exiting the


RSView SE Client program.

RSView SE Administration Console is software for administering


RSView Supervisory Edition applications after they have been
deployed.

SE Alarm Log Setup is software for setting up RSView alarm


logging.

SE Activity Log Viewer Help is information about using the


SE Activity Log Viewer.

SE Activity Log Viewer is software for viewing the contents of


activity log file sets.

1--4 ■ RSView Supervisory Edition User’s Guide


SE Alarm Log Viewer Help is information about using the
SE Alarm Log Viewer.

SE Alarm Log Viewer is software for viewing the contents of alarm


log file sets.

SE Activity Log Setup is software for setting up activity logging


for RSView Supervisory Edition.

The Rockwell Software utilities


Depending on the particular software package(s) you installed, you
may have one or more of these utilities installed:

Activation Help is information about how to use Rockwell


Software activation keys.

Move Activation is software for moving activation keys to and


from an activation disk.

Reset Activation is software for resetting activation keys on the


Activation floppy disk when there is a problem with activation.

Specify FactoryTalk Directory Location is software for specifying


which computer on your network contains the FactoryTalk
Directory service.

Support Services Help is information about how to obtain


technical support for your Rockwell Software products.

Getting started ■ 1--5


Preface
Quick Start steps

The following steps explain how to get up and running with


RSView. Before you can complete step 5 you must complete steps 2
and 3 at a minimum. The other steps can be completed in any order.

Start with a plan

Before you start working with RSView, it is advisable to plan your


application. For tips and information about how to plan an
application, see Chapter 3, Planning an application.

Step 1 H Set up the FactoryTalk Directory

The FactoryTalk Directory is software that allows the parts of a


distributed application to find each other on the network.

You must decide which computer on your network will be the


FactoryTalk Directory, and then you must install the FactoryTalk
Directory software on that computer. For details about installing
software, see the RSView Supervisory Edition Installation Guide.

After you install RSView Supervisory Edition, and before you


create an application, you must specify the name of the computer
on which the FactoryTalk Directory is installed.

Use the utility called Specify FactoryTalk Directory Location to set


the name of the computer on which the FactoryTalk Directory is
installed. You must use the Specify FactoryTalk Directory Location
utility on every computer on the network you want to have access
to your applications.

For details, see “Setting up the FactoryTalk Directory” on


page 22-4.

1--6 ■ RSView Supervisory Edition User’s Guide


Step 2 H Create and organize an application

Create the application that you will use. An application can consist
of one or more areas, one HMI server per area, one or more data
servers, and all the components you create for operators and
supervisors to use at run time (for example, graphic displays,
alarms, data logging).

For details, see Chapter 4, Working with applications.

Step 3 H Add an HMI server to your


application

The HMI server responsible for storing project components (for


example, graphic displays), and serving these components to clients.
The server also contains a database of tags, and performs alarm
detection, and historical data management (logging).

For details, see Chapter 4, Working with applications.

Step 4 H Plan how you will access data

This step is necessary so you can complete steps 5 and 6.

To access values in a programmable controller or device, you need


to use tags.

RSView conforms to the OPC Data Access (DA) 2.0 specification for
information exchange among automation or control applications,
field systems or devices, and business or office applications.

RSView provides two ways to access values in programmable


controllers or other devices:

direct access to the basic set of properties of all


OPC-DA-compliant tags. In RSView, you set up a data server, so
you can access these tags directly. The data server provides a

Getting started ■ 1--7


Preface
route to the physical devices on your network, so you can see
the values in those devices.

access to an extended set of properties through a special kind of


tag called an HMI tag. These tags have additional properties for
alarms, security, and data manipulation. You access these tags by
setting up an HMI server in RSView. The HMI server’s Tags editor
allows you to create HMI tags, and map them to physical
addresses, or OPC-DA tags in the devices on your network.

For details, see Chapter 7, Working with tags.

Step 5 H Set up communications for data


server tags

For direct access to the OPC-DA-compliant tags that reside in


devices, set up a data server.

For details, see Chapter 5, Setting up communications for data


server tags.

Step 6 H Set up communications for


HMI tags

To use HMI tags, establish communications between the RSView


SE Server and the hardware and devices you are using.

For communications with local and remote devices, RSView


uses OPC connections. OPC (OLE for process control) allows RSView
to act as a client to other OPC servers.

To set up OPC communications, create an OPC node. For details, see


Chapter 6, Setting up communications for HMI tags.

1--8 ■ RSView Supervisory Edition User’s Guide


To support legacy applications, RSView also provides:

direct driver connections for communicating with most


Allen-Bradley and SoftLogix 5 devices. RSView uses the drivers
in RSLinxt.

To set up direct driver communications, set up a channel and


node and, optionally, a scan class. For details, see Appendix C,
Setting up direct driver communications for HMI tags.

standard or high-speed AdvanceDDEt (dynamic data exchange)


data formats to communicate with DDE servers such as the
Rockwell Software RSServert products or other third-party DDE
servers

To set up DDE communications, set up a DDE node. For details,


see Appendix D, Setting up DDE communications for HMI tags.

Step 7 H Create HMI tags

If necessary, create HMI tags in any combination of ways:

create tags as needed from the Tag Browser

create a complete tag database in the Tags editor

import an existing Allen-Bradley PLC or SLC database using the


PLC Database Browser

import an existing HMI tag database using the Tag Import and
Export Wizard

For details, see Chapter 7, Working with tags, and


Chapter 8, Creating HMI tags.

Getting started ■ 1--9


Preface
Step 8 H Create graphic displays, trends,
and alarm summaries

Create graphic displays that represent your process. Build your


graphic displays in a variety of ways:

use the RSView drawing tools to create graphic objects and text.
You can create simple objects such as ellipses and rectangles, or
create more complex objects such as trends and alarm
summaries. You can also embed ActiveX objects.

drag and drop ready-made objects from the RSView libraries


into a display

import objects or entire images that have already been created in


other drawing packages such as CorelDRAW

Create graphic displays, trends, and alarm summaries in the


Graphic Display editor.

For details, see Chapter 15, Creating graphic displays.

Step 9 H Set up logging

Set up activity, alarm, and data logging to have a permanent record


of what is happening when your system is running.

Set up activity logging in the Activity Log Setup editor. Set up


alarm logging in the Alarm Log Setup editor. Set up data logging in
the Data Log Models editor.

All logged information is stored in a proprietary format for faster


performance, but can be exported to an ODBC-compliant database
while online, and then viewed with any ODBC-compliant reporting
or analysis software, such as Microsoft Excel, or Seagate Crystal
Reports. For data logging, you can also use the ODBC storage format
to store data directly in an ODBC-compliant database.

1--10 ■ RSView Supervisory Edition User’s Guide


For details, see:

Chapter 10, Setting up alarms

Chapter 11, Setting up activity logging

Chapter 12, Setting up data logging

Step 10 H Secure your system

Set up security at the:

application level so you control which users or groups of users


have access to which features in your application

user level so you lock users into the RSView SE Client. To set
up user-level security, use the DeskLock Tool, included in the
Tools folder.

For details, see Chapter 14, Adding security.

Step 11 H Customize and integrate RSView


with other applications

Use the RSView SE Client object model with Visual Basic for
Applications (VBA) code in graphic displays to customize and
extend the capabilities of RSView. Some ways you might do this
include:

Using data with other applications If you regularly require


RSView data for use in programs such as Microsoft Excel, or
PowerPoint®, consider using the RSView SE Client object
model and VBA display code to integrate these applications with
RSView.

Validating operator input To validate operator input, use the


RSView SE Client object model with VBA. In VBA, create your
own pop-up dialog boxes for data entry. Use VBA logic to

Getting started ■ 1--11


Preface
validate the operator’s input, for example to ensure that the
value an operator enters in a numeric input field falls within
10 % of the value of another numeric input field.

Designing intuitive graphic displays Use the RSView


SE Client object model to populate VBA form objects with data,
for use in graphic displays. For example, use list boxes or combo
boxes in graphic displays to allow operators to select options
such as recipe items.

Manipulating the RSView SE Client window. Write VBA code


to arrange graphic displays based on the size of the RSView SE
Client window. This allows you to adapt your application
dynamically to various screen desktop sizes and resolutions.

Sending custom messages to the activity log file. Send


specific messages to the activity log window and activity log file,
to notify the operator of problems with VBA code.

Securing the system. The RSView SE Client Object Model


allows you to obtain security information about who is using
the system, and to use the security information and events to
control access to the system. For example, you can restrict a
user’s access to a graphic display on a secured computer by
creating code that displays the graphic display only when the
user is logged in with a particular user name.

For details, see Chapter 21, Using the SE Client object model and
display code.

1--12 ■ RSView Supervisory Edition User’s Guide


2
Chapter

Exploring
RSView Studio
This chapter introduces you to RSView Studio, briefly describing
how it works, and what it looks like. Find out about:

key concepts and terms that are used throughout the


documentation

key features for working with RSView

Starting RSView Studio

When you start RSView Studio you need to specify the type of
application you want to create. This is known as the product type.

To start RSView Studio and select a product type:

1. Do one of the following:

click the Start button, point to Programs, and then click


RSView Studio

click the Start button, point to Programs, Rockwell


Software, RSView Enterprise, and then click RSView Studio

When you start RSView Studio, the Product Type Selection


dialog box appears automatically.

Exploring RSView Studio ■ 2--1


Preface
If the Product Type Selection dialog box is not open, do one of
the following:

click the New Application button on the toolbar

New Application click the File menu, and then click New Application

2. In the Product Type Selection dialog box, select the type of


application you want to create.

To create a distributed, supervisory-level application, do one of


the following:

double-click the Supervisory Edition Distributed icon

click the Supervisory Edition Distributed icon and then click


Continue

2--2 ■ RSView Supervisory Edition User’s Guide


Opening an application

To familiarize yourself with the RSView Studio development


environment, you can open the sample application. You’ll find it in
the Existing tab of the New/Open Supervisory Edition Distributed
Application dialog box.

To open an existing application:

1. On the toolbar, click the Open Application tool, or on the File


menu, click Open Application.
Open Application tool

2. In the New/Open Supervisory Edition Distributed Application


dialog box, click the name of the application you want to open,
and then click Open.

The application appears in the Application Explorer.

Exploring RSView Studio ■ 2--3


Preface
To open an application you used recently:

" On the File menu, point to Recent Files, and then click the
name of the application you want to open.

Running the samples application

To run the Samples application on the RSView SE Client, you must


complete the following steps:

1. In RSView Studio, add a valid user to the User Accounts editor.


For details about adding users, see “Setting up user accounts,”
on page 14-4.

2. Run the Samples Water RSView SE Client configuration file.

To do this, click the Windows Start button, point to Programs,


Rockwell Software, RSView Enterprise, and then click Samples
Water.

2--4 ■ RSView Supervisory Edition User’s Guide


Exploring the RSView Studio main window
Once you have opened an application, you will see the RSView
Studio main window.

Menu bar
Toolbar

Application
Explorer

Workspace

Activity bar
Status bar

The menu bar

The menu bar contains the menu items for the active window. Each
editor has its own set of menus.

The toolbar

The toolbar contains buttons for commonly-used menu items so


you can quickly access the items without opening the menus. When

Exploring RSView Studio ■ 2--5


Preface
you point to a button on the toolbar, the name of the button is
displayed in a tooltip.

Standard toolbar
Graphics toolbar
Objects toolbar

All of the editors use the Standard toolbar. The Graphic Displays
and Graphic Libraries editors have additional toolbars.

The Application Explorer

The Application Explorer contains the editors for creating and


editing your application. For more information about the
Application Explorer, see page 2-9.

The workspace

The workspace is the blank area of the RSView Studio window, to


which you can drag and drop icons from the Application Explorer
to launch editors. For details, see “Working in the Application
Explorer” on page 2-9.

The activity bar

The activity bar shows system activities. You can specify the types
of activities to display in the activity bar, you can resize it, move it,
and clear the messages in it.

Use the Activity Log Setup editor to select the activity categories
you want to log to the Activity Bar. For details, see page 11-10.

Moving the activity bar

You can detach (undock) the activity bar from the main window,
and then move the bar anywhere on the screen.

2--6 ■ RSView Supervisory Edition User’s Guide


To undock the activity bar, drag the grab bars at the bottom left of
the activity bar. If you can’t see the grab bars, drag the top edge of
the activity bar to make it a bit larger.

To detach the
activity bar, drag
the grab bars.

To prevent the activity bar from docking automatically while you


move it across the screen, hold down the Ctrl key on the keyboard
while you move the activity bar.

When the activity bar is undocked, you can make it any size you
want, for example to view more than one message at a time. To
resize the bar, drag an edge or corner until the bar is the size you
want.

To clear the most recent message in the activity bar, click Clear. To
clear all the messages in the activity bar, click Clear All.

Messages in the activity bar

The types of messages that appear in the activity bar depend on


what is specified in the Activity Log Setup editor.

Activity messages are preceded by a blue, yellow, or red icon. Blue


indicates information, yellow indicates a warning, and red indicates
an error.

For information about specifying the types of activities to display


in the activity bar, see page 11-10.

Exploring RSView Studio ■ 2--7


Preface
The status bar

The status bar provides different kinds of information depending on


where the pointer is and what RSView is doing. It can provide
information about:

the active window or selected tool

For example, if you position the pointer over the Open button,
the following message appears in the status bar:

a selected graphics object

For example, if you select an object in the graphics display


editor, information about the object (such as its position on the
display, size, and name) appears in the status bar:

Showing and hiding items in the main


window

You can display or hide all the items in the main window (except
the menu bar) by using the items on the View menu. If there is a
check mark beside the item, it is visible. If there is no check mark,
the item is hidden.

The status bar and


Standard toolbar are
visible. The activity bar and
Application Explorer are
hidden. Workbook Mode
is off.

2--8 ■ RSView Supervisory Edition User’s Guide


Working in the Application Explorer
The Application Explorer is the main tool for working with
RSView Studio. The Application Explorer contains the editors you
use to set up your application.

Application name
Workspace
Click the – symbol to
close a folder

Click the + symbol to see


the list of components
for an editor

Components are listed


below the editor’s icon

Undocking the Application Explorer

You can undock the Application Explorer and move it in a number


of ways:

click the title bar and then drag the window. To prevent the
Application Explorer from docking automatically while you
move it across the screen, hold down the Ctrl key on the
keyboard while you move the Application Explorer.

double-click the title bar to float the explorer in the middle of


the main window, and then drag it to a new position

right-click the title bar, and then click a new docking location:
floating, or MDI (Multiple Document Interface) Child

Exploring RSView Studio ■ 2--9


Preface
If you click MDI Child, the explorer becomes a window. You
can move, minimize, maximize, or restore the explorer window,
but only within the main window. You cannot move the
explorer outside the main window.

You can resize the Application Explorer by dragging its edges.

The parts of the Application Explorer are described on the pages


that follow.

Folders

The Application Explorer uses folders to organize editors. To open


or close a folder, do one of the following:

click the + symbol beside the folder’s icon

double-click the folder

click the folder, and then press Enter to either open or close the
folder depending on its current state

2--10 ■ RSView Supervisory Edition User’s Guide


Editors

Editors are for creating or setting up application components. To


open an editor, do one of the following:

drag the editor’s icon from the Application Explorer to the


workspace

right-click the editor’s icon to open the shortcut menu, and then
click New or Show

Right-- click to
view the
shortcut menu

If you can use the editor to create multiple components, the


shortcut menu contains New. If the editor can open only a single
component, the shortcut menu contains Show.

The following table describes each editor.

Use this editor To

Activity Log Setup Specify the type of system activity you want to log
and where, when, and how you want it logged.

The settings you configure using this editor apply


only to the computer you are using.

To access this editor, click the Tools menu in RSView


Studio.

Alarm Log Setup Specify the type of alarm activity you want to log
and where, when, and how you want it logged.

The settings you configure using this editor apply


only to the computer you are using.

To access this editor, click the Tools menu in RSView


Studio.

Exploring RSView Studio ■ 2--11


Preface

Use this editor To

User Accounts Add Windows users to your application and assign


them security codes to limit their access to an
application.

Secured Commands Assign security codes to commands and macros.

Startup Specify what will run when an RSView SE Server


starts.

Command Line Open a command line for entering RSView


commands.

Channels Specify channels for direct driver communication


with devices. You must set up channels before you
set up nodes for direct driver devices. Channels are
for use with HMI tags only.

Nodes Assign names and define attributes for the direct


driver devices, OPC servers, or DDE servers that
RSView will communicate with. Nodes are for use
with HMI tags only.

Scan Classes Set up the rate for scanning tags that communicate
with direct driver devices. Scan classes are for use
with HMI tags only.

Tags Create HMI tags, and set up alarms.

Displays Create graphic displays.

Libraries Drag and drop objects from the graphic libraries into
your graphic displays.

Images Add images that you would like to use repeatedly in


graphic displays to your application.

Parameters Create a parameter file for use with graphic displays


containing tag placeholders, so you can use the same
graphic displays with different tags.

Recipes Create a recipe file for use with graphic displays


containing a recipe field.

2--12 ■ RSView Supervisory Edition User’s Guide


Use this editor To

Trend Templates Rename, remove, and copy existing trend templates.


Use trend templates to create preconfigured trend
objects for use in graphic displays.

Trend Snapshots Rename, remove, and copy existing trend snapshots.


Save trend snapshots for use as overlays with
real-time trends.

Local Messages Create the local message files containing trigger


values and the corresponding messages.

Alarm Setup Set up where, when, and how you want alarm
messages logged.

Suppressed List Display a list of tags for which alarm notification is


suppressed.

Derived Tags Create tags whose values are derived from other tags
and functions.

Events Create events, which are expressions that trigger


commands or macros.

Macro Create macros to run a series of RSView commands.

Client Keys Remap your RSView SE Client keyboard to run


RSView commands.

Data Log Models Create data log models, specifying where, when, and
how you want selected tag values logged.

Exploring RSView Studio ■ 2--13


Preface
Components

The Application Explorer manages components, not files.


A component is a reference to a physical file, located in a folder
under the application directory.

These components
were created using the
Graphic Displays editor.

Displaying components

To display components for a particular editor, do one of the


following:

click the + sign beside the editor’s icon

double-click the editor

Any components created with the editor appear below the editor in
the tree.

2--14 ■ RSView Supervisory Edition User’s Guide


Opening components

To open a component, do one of the following:

double-click the component

drag the component’s icon into the editor’s window

right-click the component to open the shortcut menu, and then


click Open

Right-click to view
the shortcut menu.

For information about renaming, removing, and deleting


components, see page 2-17.

Adding components to an application


You can add a component to an application in two ways:

by dragging and dropping the component’s file from the


Windows Explorer to the Application Explorer window, or

using the shortcut menu in the Application Explorer

When you add a component in the Application Explorer using the


Add Component into Project option, you are creating a copy of the
file in the application.

Exploring RSView Studio ■ 2--15


Preface
To add a component using drag and drop:

" Using the Windows Explorer, locate the file of the component
you want to add to your application, and then drag the file to
the Application Explorer.

The component automatically appears below the editor that can


be used to edit it.

To add a component using the shortcut menu:

1. Right-click the editor that was used to create the component


you want to copy. For example, to add a graphic display
component, right-click the Graphic Displays editor.

2. On the shortcut menu, click Add Component into Project.

3. In the dialog box, find the component you want to add or


update, and then click it.

To select consecutive components, click the first component,


and then shift-click the last component you want to select. To
select multiple, individual components, Ctrl-click each one.

4. Click Open. The components appear under the editor in the


Application Explorer.

2--16 ■ RSView Supervisory Edition User’s Guide


Renaming, removing, and deleting components
Use the items on the shortcut menu to rename, remove, and delete
components. The Remove item removes a component from the
Application Explorer. The Delete item removes a component and
deletes its associated file from disk.

Renaming a component

Renaming a component changes the physical file name.

To rename a component:

" In the Application Explorer, right-click the component, click


Rename, and then type the new name for the component.

If you change the name of a file that is referenced by another


application, the component (reference to the file) cannot be opened.
You must remove the component, and then add the component into
the project once again.

To restore the reference to the file:

1. Right-click the component and then click Remove.

2. Right-click the editor used to create the component, for example


the Graphic Displays editor. On the shortcut menu, click Add
Component Into Project.

3. Select the file that the component represents, and then click
Open.

Exploring RSView Studio ■ 2--17


Preface
To rename a component:

1. Right-click the component and then click Rename.

2. In the To box, type the new name.

3. Click OK.

Removing a component

If you no longer want to use a particular component in an


application, you can remove the component (file reference) from
the application using the Remove item on the shortcut menu.

Removing a component removes the component from the


Application Explorer. It does not delete the physical file that the
component references.

To remove a component:

" Right-click the component and then click Remove.

Deleting a component and file

If you no longer want to use a particular file in any application, you


can delete the component and its associated file using the Delete
item on the shortcut menu. Deleting a component deletes both the
file reference and the physical file from disk.

2--18 ■ RSView Supervisory Edition User’s Guide


To delete a component and file:

" Right-click the component and then click Delete.

Naming components

When you name a component in RSView Studio, the file name for
the component is created automatically on disk.

Component names become part of the file names on disk. The


maximum number of characters for a component varies, depending
on where that component’s file is saved on disk.

RSView supports long file names. File names, including the path,
can be up to 200 characters long.

For example, the following path and file name contains 111
characters. The component name (the name of the graphic display)
is only 15 characters long, but can be as long as 111 characters:

C:\Documents and Settings\All Users\Documents\


RSView Enterprise\SE\HMI Projects\Bakery1\
Gfx\Bakery Overview.gfx

Component names can contain spaces. When using component


names with spaces in commands, you do not need to enclose the
component names in double quotes ( “ ” ), except when using the /P
parameter with the Display command.

Names that conflict with commands or macros

To avoid problems when issuing commands and macros, do not use


command names to name macro components. For example, assume
you want to name a macro Display. To avoid confusion with the
Display command, name the macro DisplayScreen instead.

For details about commands, see Appendix A, RSView commands.

Exploring RSView Studio ■ 2--19


Preface
Techniques for working in editors
When developing an application, you will use many different
editors, but they have many similar features and often require
similar information. Knowing how to use these features saves time.

Using the shortcut menus

The Application Explorer and the Graphic Displays editor use


shortcut menus. To open a shortcut menu, right-click the mouse.

Using the Browse button

The Browse button appears beside data-entry fields. You can type
information into the fields, or you can click the Browse button to
Browse button open a list containing valid entries for the field.

Entering tag names

Many editors require a tag name. Tags are stored in devices, data
servers, and in the HMI tag database. Their names are used in other
parts of RSView. You do not have to create tags before you work in
other editors.

To supply a tag name, use any of these methods:

type the name of a tag. You do not have to create the tag to use
the tag name, but be sure to create the tag later or errors will be
reported at runtime.

click the Browse button or Tags button, whichever is available,


to open the Tag Browser, where you can select, or create a tag
Browse button
For detailed information about tags, see Chapter 7, Working with
tags.

2--20 ■ RSView Supervisory Edition User’s Guide


Using RSView commands

Many editors require an RSView command. Commands allow you


to control RSView at runtime. Most commands accept parameters
for added precision and control. You can also create a list of
RSView commands in a macro and use the macro name in places
where multiple commands are required.

Using the Command Wizard

The Command Wizard helps you select and build commands.

When you click a


category here . . .

. . . the commands for


that category are listed
here.

To resize the list boxes,


drag this bar to the left or
right.

When you click a


command in the list, the
command syntax is
displayed here.

To open the Wizard, do one of the following:

click the Browse button beside any action field or in the


command line
Browse button
double-click in an action field or, in the Macro editor, in any
area of the window

click the Commands item on the Edit menu

For detailed information about RSView commands, see


Appendix A, RSView commands.

Exploring RSView Studio ■ 2--21


Preface
Using expressions

Many editors use expressions to compute values based on tags and


functions. Expressions can be complex logical expressions, or they
can be tag names.

For detailed information about expressions, see Chapter 18,


Creating expressions.

Printing
Each RSView editor has a Print item on its File menu.

To print selections:

1. Select the item you want to print. The item can be a record in an
editor’s spreadsheet or it can be an object in a graphic display.

2. On the File menu, click Print.

3. Under Print Range, click Selection.

4. Click OK.

To print the entire contents of the window:

1. On the File menu, click Print.

2. Under Print Range, click All.

3. Click OK.

2--22 ■ RSView Supervisory Edition User’s Guide


Selecting a printer

You must install a printer before you can select it. For information
about installing a printer, see your Windows documentation.

IMPORTANT The Print Setup menu item in RSView Studio applies to


your development computer only. If you’ll be using a
different computer to run your application, you must
set up a printer for that computer, otherwise you will
not be able to print at runtime.

The settings in the Print Setup dialog box do not affect


runtime log printing set up in the Activity Log Setup
and Alarm Setup editors.

To select a printer:

1. On the File menu in any RSView editor, click Print Setup.

2. If you don’t want to use the default printer, specify another


printer.

3. Choose the appropriate orientation and paper options.

4. Click OK.

Exploring RSView Studio ■ 2--23


Preface
Setting up the printer

For detailed information about changing printer options, refer to


your Windows documentation.

Selecting a network printer

RSView can print to a network printer. For detailed information


about setting up network printers, refer to your Windows
documentation.

Printing at runtime

You can also print graphic displays at runtime using the


PrintDisplay command. You must provide the operator with a way
to issue the command when you create the display. For example,
create a button object, display key, or client key with the
PrintDisplay command as the press action. For more information
about creating graphic displays, see Chapter 15, Creating graphic
displays.

When you use the PrintDisplay command RSView prints the entire
display, even if parts are covered by other displays. You can also use
the ScreenPrint command to print an image of whatever shows on
the monitor. For more information about these commands see
Appendix A, RSView commands.

2--24 ■ RSView Supervisory Edition User’s Guide


3
Chapter

Planning an application

The planning process


A well-designed application requires planning. To help you plan,
this chapter provides guidelines for:

understanding the process you’re automating

collecting data

designing an HMI tag database

planning alarms

designing graphic displays

using trends

designing a secure system

customizing the system and integrating with other applications

Planning an application ■ 3--1


Preface
Understanding the process

Gather information from a variety of sources so you have a


complete and detailed understanding of the process you’re
automating.

Specifically, you should:

talk to operators and other experts who are going to use the
system. Find out what information they need to optimize plant
operations.

talk to management and MIS (Management Information Systems)


staff to find out what information they need to support planning
decisions

break up each section of the process into its constituent parts

determine what type of communications you’ll be using—direct


driver, OPC, or DDE communications

determine which process variables need to be accessed and


identify their locations in the programmable controllers

Collecting data

When planning data collection, design your system so only essential


data is collected. Limiting data collection is important because
collection activities require substantial processing power and
generate a lot of traffic on the communication channel or network.

Keep data collection requirements in mind when designing the


layout of the programmable controller data tables and the tag
database. Ideally, tag addresses should reference contiguous blocks
of programmable controller data tables to reduce network traffic
and optimize system response.

3--2 ■ RSView Supervisory Edition User’s Guide


Planning communications
When planning communications, decide how you want to access
physical addresses and values located in devices in your plant.

To access variables in devices directly, you will need to set up a data


server to communicate with the devices on your network. For
details, see Chapter 5, Setting up communications for data server
tags.

For certain special purposes, you will need to set up an HMI tag
database. HMI tags provide extended capabilities, such as:

triggering alarms when tag values cross a specified threshold

scaling or offsetting a value before sending it to a programmable


controller or device

security features, to prevent unauthorized changes to a tag’s


value

flexible addressing. With HMI tags you don’t need to hard-code


physical addresses or device-specific variable names in your
application. This means you can re-use your application with
other controller devices, by changing the physical addresses to
which tag names are mapped.

To set up communications for HMI tags, you will need to create a


node. For details, see Chapter 6, Setting up communications for
HMI tags.

Planning an application ■ 3--3


Preface
Designing an HMI tag database
If you choose to create one, take the time to plan your HMI tag
database. A good design helps reduce the time required for
maintenance, and can improve programmable controller-to-RSView
response time.

Collect information

Before you begin creating the HMI tag database, collect the
following information:

flowcharts of your processes (or process and instrument


diagrams)

list of programmable controller data table or register addresses


your project will be accessing

alarm requirements (for more detail, see “Planning alarms” on


the next page)

Organize HMI tags

Before creating HMI tags:

develop naming conventions for HMI tags, choosing names that


are familiar and logical to everyone. This makes troubleshooting
easier.

group related HMI tags

Group HMI tags in the way that makes most sense for your
application. For example, group all similar devices or group
related areas of the plant floor.

When creating HMI tags, place related tags into folders. For
greater organization, create nested folders.

3--4 ■ RSView Supervisory Edition User’s Guide


Planning alarms
Before setting up alarms, plan:

what conditions will trigger alarms

how operators will be notified of those alarms

what information you want alarm messages to contain

what actions will occur in response to those alarms

which alarms will require additional actions that you can supply
using a macro

Planning graphic displays


When planning displays, determine the best way for users to
navigate through your displays and develop a template to establish
a common look and feel for your displays.

Develop a hierarchy of displays

A hierarchy is a series of graphic displays that provide progressively


more detail as users move through them. A hierarchy should meet
the needs of the various users, including managers, supervisors, and
operators.

Well-organized graphic displays present information clearly and


consistently and guide users through the system. Before designing
individual graphic displays, plan an overall display hierarchy and
plan how users will navigate through the hierarchy.

Planning an application ■ 3--5


Preface
Create a template to ensure consistency

It is possible to keep a consistent appearance among all the displays


in a project by presenting the same pieces of information in the
same place on each display. To ensure uniformity, develop a display
with common elements that acts as a template. Each time you
develop a new display, start with a copy of the template.

For example, the template could contain:

company logo

title

date and time

navigational buttons

When designing displays, practising good visual design principles


helps users and increases their efficiency. Aim for these important
design principles:

Consistency

Be consistent in your use of symbols and color.

Be consistent with button labels and button placement.

When you design several displays, place the same kinds of


buttons in the same positions. For example, if you have a Start
button in a certain position in one display, don’t put a Stop
button in the same position in the next display.

Clarity

Use symbols that are easily recognizable. For example, use the
conventional ISA symbols for tanks and valves.

Don’t overload the screen with information.

3--6 ■ RSView Supervisory Edition User’s Guide


Use standard, clear terminology, and avoid abbreviations or
acronyms that the user might not understand.

Use colors with recognizable meanings. For example, in the


Western world the colors red and green often mean stop and
start. Keep color meanings consistent by assigning red only to
Stop buttons, and green only to Start buttons.

Some people are color blind to red and green so don’t rely on
color alone to establish meaning.

Use high-contrast color combinations, such as yellow on blue or


dark text on light-colored backgrounds.

Usability

If you’re designing for a touch screen, don’t place important


buttons where they’ll be blocked by a pop-up window. The user
can’t press a covered button. Also, ensure that buttons are large
enough and spaced far enough apart for users to touch them
easily, even when wearing work gloves.

Ensure there is always a clear way to move between displays.

Using trends

When planning trends, consider how they will be used. For


example, will the trend be used to:

analyze process trends

monitor production efficiency

archive process variables to ensure compliance with government


regulations

Planning an application ■ 3--7


Preface
Based on such considerations, you can determine:

which tags need to be plotted on the same trend

which tags need to be plotted from a data log model

which tags need to be plotted against time or against another tag

Designing a secure system

When deciding on your security requirements, consider if you


should:

restrict access to every project component to prevent accidental


changes, or is limited access enough?

restrict access to certain parts of the plant

have everyone log on

Based on these considerations, you can set up security for


individual users or groups of users. For example, you might want to
set up groups of users, such as a manager group and an operator
group.

Customizing the system, and integrating with other


applications

Using data from other applications

If you regularly require data from programs such as Microsoft


Excel, or Microsoft SQL Server, consider using the RSView
SE Client object model and display code with VBA to integrate these
applications with RSView.

3--8 ■ RSView Supervisory Edition User’s Guide


Customizing the system

Adding custom alarm events

You can write your own alarm detection algorithms using PLC logic,
and then create events in RSView to respond to the algorithms.

Validating operator input

To validate operator input, use the RSView SE Client object model


with VBA. In VBA, create your own pop-up dialog boxes for data
entry. Use VBA logic to validate the operator’s input, for example to
ensure that the value an operator enters in a numeric input field
falls within 10 % of the value of another numeric input field.

Creating custom operator forms

Use the RSView SE Client object model to populate VBA form


objects with data, for use in graphic displays. For example, use list
boxes or combo boxes in graphic displays to allow operators to
select options such as recipe items.

Manipulating the RSView SE Client window

Write VBA code to arrange graphic displays based on the size of the
RSView SE Client window. This allows you to adapt your
application dynamically to various screen desktop sizes and
resolutions.

Sending custom messages to the activity log file

Send specific messages to the activity log window and activity log
file, to notify the operator of problems with VBA code.

Securing the system

The RSView Object Model allows you to obtain security


information about who is using the system, and to use the security

Planning an application ■ 3--9


Preface
information and events to control access to the system. For
example, you can restrict a user’s access to a graphic display on a
secured computer by creating code that displays the graphic display
on a workstation with a specific computer name, only when the
user is logged in with a particular user name.

Designing a multi- user system


When an application is run by multiple users, behavior which is
appropriate in a single-user environment might not be appropriate
in a multi-user environment.

For example, if a graphic display that is running on several clients


contains a shutdown macro that stops a derived tags file, when the
display is closed on one client, the shutdown macro will stop the
derived tags file. This would affect the display on the other clients
because the derived tags file resides at the server.

Design your application with these kinds of contingencies in mind.

3--10 ■ RSView Supervisory Edition User’s Guide


4
Chapter

Working with
applications
This chapter describes:

the FactoryTalk Directory, and how to set it up

applications and components

adding, renaming, removing, and deleting components

printing from editors

Key concepts

HMI server, HMI project, and HMI client

HMI servers are software programs that supply information to


clients when they request it. HMI servers have no user interface.
Once installed, they run as a set of Windows services. HMI servers
store HMI project components (for example, graphic displays), and
serve these components to clients. Each HMI server also manages a
database of tags, and performs alarm detection, and historical data
management (logging).

HMI projects contain displays, log models, alarms, HMI tags and
other services. HMI projects are loaded on HMI servers.

HMI clients are software programs that obtain information from, or


write information to HMI servers. RSView Studio, the RSView
Administration Console, and the RSView SE Client are all
HMI clients.

Working with applications ■ 4--1


Preface
The FactoryTalk Directory

The FactoryTalk Directory is software that allows the parts of a


distributed application to find each other on the network.

For example, to access the HMI projects on HMI servers in the


application, HMI clients use the FactoryTalk Directory to find out
which computers on the network are hosting HMI servers.

The FactoryTalk Directory can contain multiple applications,


allowing you to have multiple automation systems on the same
network. This could be useful if you want to develop one
application, while another is in active operation. Or, different
applications can be in operation simultaneously, each controlling a
different facility within your corporate network.

All the computers participating in a particular application share a


common FactoryTalk Directory located on a network server.

Application

An application includes:

a list of Windows users and their access codes (called privileges)


for accessing the application and its contents

HMI servers

Each RSView Supervisory Edition application must contain at


least one HMI server.

areas, that allow the application to be organized and sub-divided


into logical or physical divisions. You can also use areas to
separate servers that contain the same names, for example two
HMI servers running projects that contain the same set of displays
or tags.

4--2 ■ RSView Supervisory Edition User’s Guide


data servers, that allow HMI clients to access information in
programmable controllers, devices, and other data servers
without HMI tags that comply with the OPC-DA 2.0 specification

Examples of the information provided by data servers are:

temperature values from sensors

text strings to determine the order in which graphic displays


are shown to operators

a gateway to tag databases that exist in programmable


controllers themselves

Data servers also allow clients to locate a standby, redundant


computer that hosts another data server for use in the event that
the primary data server goes out of service.

Every vendor’s OPC data server is different. Some contain tag


databases of their own, like the tag database in an HMI server,
while others simply reference the tag databases that exist in
controllers themselves, as is the case with RSLinx and
ControlLogix.

More about areas

The use of areas is optional.

Areas allow you to divide an application into manageably-sized,


logical parts, or to organize the application in a way that makes
sense for the process you are controlling. An area might represent a
portion or stage of a process, or a region within the process facility.

For example, an automotive plant might be divided into areas called


Press and Fabrication, Body Shop, Paint Shop, Engine and
Transmission. A bakery might be divided into areas called
Ingredients, Mixing, Baking, and Packaging.

Alternatively, a plant with identical production lines might be


divided into areas called Line 1, Line 2, Line 3, and so on. This

Working with applications ■ 4--3


Preface
would allow you to add new, identical production lines to the
application by copying HMI server projects into new areas.

Each area can contain one or more sub-areas, and one or more data
servers. Each area or sub-area can contain only one HMI server.

The application root area

All applications have one system-defined area called the application


root area. The application root area has the same name as the
application, and contains the User Accounts and Secured
Commands lists.

You can use the application root area like any other area, for
example to contain an HMI server, or one or more data servers.

The home area

The home area is the area in which an application component is


located. When you refer to an application component, but don’t
specify the area in which the component is located, RSView uses
the home area to locate the component.

For example, if two graphic displays are located in different areas,


each has a different home area.

In this example, the graphic display called Ingredients is in an area


called Mixing. The graphic display’s home area is Mixing.

The graphic display called Laminating is in an area called


Packaging. The graphic display’s home area is Packaging.

4--4 ■ RSView Supervisory Edition User’s Guide


Absolute and relative references

When you refer to an application component, for example a graphic


display, you create a reference to the component.

There are two kinds of references:

Absolute references point directly at a specific component by


referring to the component’s name and the path to it. Absolute
references are a way of referring to a specific component in a
specific area.

For example, an absolute reference to a display called Detail in an


area called AssemblyLineNorth is /AssemblyLineNorth::Detail.

Relative references point at a component relative to the current


server or area.

How to use absolute and relative references

Assume the display called Detail, mentioned above, contains an


absolute reference to a tag called /AssemblyLineNorth::Speed, and
a relative reference to a tag called Temp.

If you copy the Detail display to an area called AssemblyLineSouth


the display will still use the tag /AssemblyLineNorth::Speed
because you referred to it using an absolute reference. However, the
tag called Temp will now refer to /AssemblyLineSouth::Temp
because you referred to the Temp tag using a relative reference.

Use absolute references when you want to ensure that the same
component is used, regardless of where it is referenced from.

Relative references are useful if your component names are all the
same, but they are in different areas. This might be the case if you
expect to clone identical areas, for example to represent identical
production lines in your plant. For details about how to use areas in
structuring an application, see page 4-10.

Use absolute or relative references when building commands, or


when connecting graphic objects to tags.

Working with applications ■ 4--5


Preface
Syntax

Precede area names with a forward slash ( / ). Also separate area


names from other area names, with a forward slash.

Separate area names from component names with two colons ( :: ).

Example: Using the Display command with absolute and


relative references

Assume that a graphic display called Overview appears if the


operator presses a button on a graphic display.

To show the graphic display called Overview, use the Display


command as follows:

to refer to the display called Overview in the area called Baking,


type Display /Baking::Overview

to refer to the display called Overview in the area called


Packaging, type Display /Packaging::Overview

to refer to the display called Overview in the area from which


the Display command was issued, type Display Overview. This
is a relative reference.

More information and examples

For information about using absolute and relative references with


tags, see page 7-19.

For information about using absolute and relative references with


commands, see page A-7.

Basic steps for developing an application

For an overview of the basic steps you need to complete to develop


an application, see “Quick Start steps” on page 1-6.

4--6 ■ RSView Supervisory Edition User’s Guide


Activities when deploying an application

For an overview of the activites you need to perform to deploy an


application, see page 22-2.

Setting up the FactoryTalk Directory


The FactoryTalk Directory is software that allows the parts of a
distributed application to find each other on the network. For
details about setting up the FactoryTalk Directory, see page 22-4.

Creating an application
To begin working in RSView, create an application.

To create an application:

1. Start RSView Studio.

For details, see page 2-1.

When you start RSView Studio, the Product Type Selection


dialog box appears automatically.

If the Product Type Selection dialog box is not open, do one of


the following:

click the New Application button on the toolbar

New Application click the File menu, and then click New Application

Working with applications ■ 4--7


Preface

2. In the Product Type Selection dialog box, select the type of


application you want to create.

To create a distributed, supervisory-level application, do one of


the following:

double-click the Supervisory Edition Distributed icon

click the Supervisory Edition Distributed icon and then click


Continue

4--8 ■ RSView Supervisory Edition User’s Guide


The application
name can be up to
32 characters long.
Type a description for
the application. You
can use the description
to identify a contact
person to anyone who
modifies or maintains
the application.

3. In the New/Open Supervisory Edition Application dialog box,


type a name and description for the application.

After you create a new application, the Application Explorer


appears displaying the name of the application.

Deleting an application

You cannot delete a distributed application that is in use. To delete


an application, ensure that all users disconnect from the application
first.

When you delete an application, the application becomes invisible


to computers on the network, preventing them from connecting
to it.

The HMI projects and data servers you have set up in your
application are not automatically deleted when you delete an
application. For details about deleting an HMI server’s files, see
page 4-14. For details about removing a data server, to delete its
cache files, see page 5-7.

Working with applications ■ 4--9


Preface
To delete an application:

1. Make a list of the names of the HMI servers in the application.


You will need this list if you want to delete the HMI servers’ files
(step 6, below).

2. If the Application Explorer’s menu is not visible, click the


Application Explorer.

3. On the File menu, click Open Application.

4. In the New/Open Supervisory Edition Distributed Application


dialog box, click the Existing tab.

5. Click the application you want to delete, and then click Delete.

6. To delete the application’s HMI servers, see page 4-14.

Structuring an application
To determine a structure for your application, review your
application plan. For tips about planning applications, see
Chapter 3, Planning an application.

Using areas

A review of your application plan will help you decide how to use
areas in your application. For example, you can:

separate identical production lines into different areas. If you


add another production line to your plant in the future, you can
clone a representation of the new production line by copying
and then modifying an existing area.

separate dissimilar production lines into different areas. This


allows you to organize the components of your plant by their
function, making your process easier to organize and manage.
For example, this allows operators to view and acknowledge
multiple alarms in their area only.

4--10 ■ RSView Supervisory Edition User’s Guide


Adding HMI servers and data servers

Each area in your application can not contain more than one HMI
server. Each area can contain more than one data server.

If you want to provide redundant operation for data servers at run


time, you must install each data server on a separate computer.

Adding HMI servers or data servers for load balancing

After deploying your application, over time the processor (CPU) on


the computer running the HMI server or data server might become
over-utilized. This might happen because of an increase in the size
of the HMI project, together with an increase in the number of
clients connecting to the HMI server or data server.

If this happens, you should add another HMI server or data server,
installed on a different computer, and then move some of the
components in the HMI project to the new HMI server, or some of the
OPC servers to the new data server. This distributes the processing
load across computers more effectively, providing better
performance.

Each computer on which the RSView SE Server is installed can


have no more than five HMI servers running on it. If your
application needs more than five HMI servers, install them on more
than one computer.

Your application cannot contain more than ten HMI servers.

Using HMI servers and data servers to limit down--time

You can use multiple HMI servers or data servers to represent the
physical areas in your facility.

For example, if your facility manufactures beverages, you might


assign one HMI server, or one or more data servers to each area, for
example, Mixing, Blending, Bottling, and Packaging. For each of

Working with applications ■ 4--11


Preface
the four areas, you could install the RSView SE Server software on
each of four computers. Then, copy all the HMI server projects to all
of the computers, but run only one HMI server on each computer. If
any one computer fails, you can run a second HMI server on any of
the remaining computers.

This example could also be applied to data servers.

Adding data servers for redundant operation

You can set up redundant data servers to enable your application to


use a standby data server in the event that the primary data server
goes out of service.

You must set up redundancy separately for each data server in your
application.

For details about adding data servers to your application, see


page 5-3.

Adding and removing areas


You cannot copy areas.

To add an area:

1. In the Application Explorer, do one of the following:

right-click the application root, or right-click an area name,


and then click New Area

click the File menu, point to New, and then click Area

2. On the shortcut menu, click New Area.

3. In the New Area dialog box, type a name for the area. You can
also type a description for the area.

4. Click OK

4--12 ■ RSView Supervisory Edition User’s Guide


To remove an area:

" Right-click the area you want to remove, and then click
Remove.

HMI servers and data servers located in the area are not deleted.

Adding, copying, removing, and deleting


HMI servers
Each area can contain only one HMI server.

Each computer on which the RSView SE Server is installed can


have no more than five HMI servers running on it. If your
application needs more than five HMI servers, install them on more
than one computer.

Your application cannot contain more than ten HMI servers.

To add an HMI server:

1. In the Application Explorer, right-click the application root, or


right-click an area name, and then click New HMI Server.

2. The Add HMI Server wizard appears. To add an HMI server,


follow the instructions on the screen.

To copy an HMI server:

1. In the Application Explorer, right-click the application root, or


right-click an area name, and then click New HMI Server.

2. In the Add HMI Server Wizard dialog box, click Create a new
HMI project from an existing project, and then click Next.

This option copies an existing HMI server.

3. Follow the instructions on the screen.

Working with applications ■ 4--13


Preface
To remove an HMI server:

" Right-click the HMI server you want to remove, and then click
Remove.

The Remove option removes the HMI server from the


application. It does not delete the HMI server’s files.

To delete an HMI server’s project files:

1. Disconnect all clients from theHMI server. A client is any of the


following: RSView Studio, the RSView Administration Console,
or the RSView SE Client.

2. Use the Windows Explorer to browse to the following folder on


the computer on which the RSView SE Server is installed:

\Documents and Settings\All Users\RSView Enterprise\


SE\HMI projects

3. Delete the folder that has the same name as the HMI server whose
project files you want to delete.

Setting up an HMI server’s properties


After you have added an HMI server, you can change its properties,
including:

specifying the name of the computer on which the HMI server is


located

specifying when the HMI server is loaded

starting or stopping components manually

viewing the HMI server’s name, project file path, number of


existing graphic displays or the maximum number of graphic
displays allowed

You must set up the HMI server properties separately for each HMI
server in your application. For details, see page 22-8.

4--14 ■ RSView Supervisory Edition User’s Guide


5
Chapter

Setting up
communications for
data server tags
This chapter describes:

what data servers are

how to add and set up data servers in your application

how to remove data servers from your application

About data servers


A data server provides client computers with data such as:

programmable controller values

OPC tags, and their value or status information

named variables in a ControlLogix processor

For some of the things you might need to do in your application,


you can use data server tags, and for others you must use HMI tags.
If your application uses only HMI tags, you do not need to set up
communications for data server tags.

For information about the differences between data server tags and
HMI tags, see page 7-1.

For information about setting up communications for HMI tags, see


Chapter 6.

Setting up communications for data server tags ■ 5--1


Preface
Using data servers

Use multiple data servers to:

communicate with more than one type of controller


simultaneously, for example a Rockwell Automation Controller
(such as ControlLogix), a Modicon controller, and a Siemens
controller

Because some OPC servers can communicate with multiple types


of controllers simultaneously, you might not need a separate
data server for each controller. To determine whether you need
to create additional data servers for each controller, see the
documentation for your OPC server.

balance the processing load for exchanging data. If CPU usage is


high on a computer on which one data server is running, you
should create another data server on another computer to
balance the processing load.

balance the memory load for tag values. If the computer on


which a data server is running, runs out of memory, you should
create another data server on another computer to provide more
memory for tag values.

provide data-access redundancy. To do this, set up a second OPC


server on another computer. On the primary data server, change
the settings in the Redundancy tab of the Data Server Properties
dialog box, to point clients at the secondary server if the
primary one fails.

5--2 ■ RSView Supervisory Edition User’s Guide


Adding data servers
You can add more than one data server to an area.

To add a data server:

1. In the Application Explorer, do one of the following:

right-click the application root, or right-click an area name,


and then click New Data Server

click the File menu, point to New, and then click


Data Server

2. In the Data Server Name dialog box, type a name for the data
server and then press Enter.

The name of the data server cannot include dashes or


hyphens ( – ).

Setting up communications for data server tags ■ 5--3


Preface

3. In the Data Server Properties dialog box, fill in the fields on


each tab, as described in the sections that follow. When you are
finished, click OK.

Setting up general properties

On the General tab, type a description for the data server, and
specify the name of the computer running the OPC server.

Description Type a description for the OPC server. For example,


use this box to describe a component’s location, or to identify a
contact person or number in the event of failure.

Computer that will run the OPC server Type the name of the
computer running the OPC server. To browse for the name of the
computer, click the Browse button.

5--4 ■ RSView Supervisory Edition User’s Guide


OPC server name (Prog ID) Type the programmatic ID of the OPC
server. To browse for the programmatic ID, click the Browse button.

Setting up data server redundancy

To ensure uninterrupted access to data if the primary data server


fails, set up a redundant data server.

On the Redundancy tab, specify the name of the redundant data


server, and specify whether RSView should switch back to the
primary data server if it becomes available again.

Provide redundancy using a secondary server Select this check


box to enable data server redundancy. Clear this check box to
disable data server redundancy.

Computer running secondary server Type the name of the


computer running the secondary data server. To browse for the
name of the computer, click the Browse button.

Switch back options To prevent RSView from switching back to


the primary data server when it becomes available again, click
Continue using the secondary server even when the primary server
becomes available again.

Setting up communications for data server tags ■ 5--5


Preface
To make RSView switch back to the primary data server when the
primary server becomes available again, click Switchback to the
primary server when it becomes available.

Setting up advanced properties

On the Advanced tab, set up a cache for tags on the data server.
A cache allows you to view tag names when you are not connected
to the data server.

Include extended information in the server cache file Select this


check box to make available additional infomation about tags, for
example, their data types, when you are not connected to the data
server.

To create a data server cache:

1. In the Application Explorer, right-click the data server, and then


click Properties on the shortcut menu.

2. Click the Advanced tab.

3. Click the Create cache button.

4. Click OK.

5--6 ■ RSView Supervisory Edition User’s Guide


To synchronize a data server’s cache:

If tags are added, modified, or deleted on the data server, you must
synchronize the cache manually.

You can synchronize a data server’s cache only after you have
created one.

1. In the Application Explorer, right-click the data server, and then


click Properties on the shortcut menu.

2. Click the Advanced tab.

3. Click the Synchronize button.

4. Click OK.

Removing data servers

To remove a data server:

" Right-click the data server you want to remove, and then click
Remove.

When you remove a data server, you also delete its cache files.

Setting up communications for data server tags ■ 5--7


6
Chapter

Setting up
communications for
HMI tags

This chapter describes:

where to find information about setting up communications for


HMI tags

how OPC communications work with HMI tags

how to create OPC nodes

how to change node information at run time

how to scan for new tag values

For some of the things you might need to do in your application,


you must use HMI tags, and for others you can use data server tags.
If your application uses only data server tags, you do not need to
set up communications for HMI tags.

For information about the differences between HMI tags and data
server tags , see page 7-1.

For information about setting up communications for data server


tags, see Chapter 5.

Setting up communications for HMI tags ■ 6--1


Preface
Where to find information
To obtain values from HMI tags, you must set up communications.
RSView supports OPC connections, for communicating with a wide
range of local and remote devices. For details, see the topics in this
chapter.

To support legacy applications, RSView also supports direct-driver


and DDE communications.

For details about setting up direct driver communications for HMI


tags, see Appendix C.

For details about setting up DDE communications for HMI tags, see
Appendix D.

About OPC communications


OPC is OLE for Process Control, used to connect RSView to
communication devices via vendor-specific OPC servers. RSView
supports the OPC-DA 2.0 specification.

OPC servers provide a way to connect an RSView SE Server’s HMI


tags (the OPC client) to:

Allen-Bradley controller devices, using RSLinx as an OPC server

For details, see the topics in this chapter.

third-party controller devices, such as Siemens or Modiconr,


using third-party OPC servers

For details, see the topics in this chapter.

6--2 ■ RSView Supervisory Edition User’s Guide


Overview of OPC communications
The following illustration shows the different ways RSView can use
OPC for communications.

RSView SE Server’s
HMI tags
Computer running RSView SE Server

RSView OPC client module

Third-party Third-party
application RSLinx OPC server
with OPC
server
support

Network or
third-- party
OPC network link via DCOM PLC network
communication
link
Remote Remote Remote Allen-- Bradley Non-- Allen-- Bradley
computer— computer— computer— programmable device
RSLinx RSView32 3rd-- party controller
Gateway OPC server OPC server
(OPC server)

Setting up communications for HMI tags ■ 6--3


Preface
Summary of steps
The instructions below summarize the steps for setting up an
RSView SE Server’s HMI tags to receive values from an OPC server.

1. Start the OPC server.

2. Start RSView Studio, and then create or open an application.

3. Add an area, and then create an HMI server in the area.

4. In the Nodes editor, create nodes for each OPC server and/or
topic you want to communicate with. In the node’s Data Source
field, click OPC Server.

For details, see “Creating an OPC node” below.

5. In the Tags editor, create tags, select Device as the data source,
and assign the nodes that you have created.

For details, see Chapter 7, Working with tags.

Creating an OPC node


An OPC node allows you to assign a logical name, server name, and
update rate for each OPC server you want to communicate with. The
OPC node name can then be used in HMI tags.

To create an OPC node:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Nodes editor by doing one of the following:

double-click the Nodes icon

right-click the Nodes icon and then click Show

6--4 ■ RSView Supervisory Edition User’s Guide


3. Create a node by filling in the following information:

Data Source

Click OPC Server.

The Tags editor does not check addressing syntax for


programmable controllers that communicate through an OPC
server. If the syntax is invalid, an error will appear at run time.

For details about the Direct Driver data source, see


Appendix C, Setting up direct driver communications for HMI
tags. For details about the DDE server data source, see “Creating
a DDE node” on page D-4.

Name

Type a name of your choice to represent the OPC node. The


name can be up to 40 characters long and can have upper and

Setting up communications for HMI tags ■ 6--5


Preface
lower case letters, numbers, dashes, and underscores. Spaces are
not permitted.

Enabled

Normally nodes are enabled, allowing collection of values from


the device. However, during setup or troubleshooting you might
want to disable a node to prevent communication timeouts or
invalid data. When a node is disabled, tag values can still be read
and written, but the values are read from and written to the
value table instead of the device.

When a tag uses a disabled node at run time, the tag’s state will
change from valid to disabled. You can see the tag’s state when
viewing data that was logged to an ODBC database.

To disable nodes, clear the Enabled check box.

You can also enable and disable nodes at run time, using the
NodeEnable and NodeDisable commands. For more
information see Appendix A, RSView commands.

Server

Either select a server from the list, or fill in the server fields
manually. You can fill in the fields for an OPC server that has not
been installed yet and install the server later.

To select a server from the list, click the browse button beside
the Name field and then select a server from the list of registered
Browse button servers. RSView fills in the remaining Server fields.

To use an RSView32 station as your OPC server, select


RSI.RSViewOPCTagServer. For the server type, click Remote,
and then specify the Server Computer Name or Address as
described below.

6--6 ■ RSView Supervisory Edition User’s Guide


Name

Type the name of the OPC server that RSView will communicate
with, typically in this format:

<Vendor>.<DriverName>.<Version>

If the OPC server is RSLinx, you don’t need to specify a version


number. For RSLinx, you don’t need to specify the vendor name
either.

Remote Computer Name or Address

Select this check box if the OPC server is not running on the same
computer as the HMI server.

Server Computer Name or Address

If the OPC server is remote, type the server computer’s name or


address, or click the Browse button and then select a server
Browse button computer from the list.

You can use these formats to specify the name or address:

Use this syntax For this format Example

\\ComputerName UNC \\DTB1


(Universal Naming Convention)

ComputerName.Domain.com DNS (Domain Name System) DTB1.NET2.COM

xxx.xx.xxx.xxx Raw TCP/IP address 134.87.167.148

Setting up communications for HMI tags ■ 6--7


Preface
Access Path

What you type in this field depends on your OPC server:

For communications with an RSLinx OPC server, the access


path is the name of a DDE/OPC topic in RSLinx. You can
either specify the access path in the Nodes editor, or you can
specify the DDE/OPC topic as part of the tag’s address when
you create the tag using the Tags editor.

If you are using RSLinx and you want to switch between


PLCs for node redundancy using the NodeSwitch command,
you must specify the access path in the Nodes editor. The
access path is the name of a DDE/OPC topic in RSLinx. In
RSLinx, each DDE/OPC topic represents a different
programmable controller.

If you are communicating with RSView32 using OPC, the


access path is the name of the project loaded in RSView32.

For communications with other OPC servers, the access path


may be optional. For information about the syntax for the
access path, see your OPC server documentation.

Update Rate

Specify the fastest rate at which the OPC server sends data to the
OPC client. The default is every 1 second.

The rate that the OPC server uses may be slower than the rate
you specify. Type 0 to specify that the server use the fastest
possible rate.

IMPORTANT An update rate of 0 is rarely necessary, and may affect


system performance adversely, because the network
may be flooded with traffic.

If the OPC server’s access path is a DDE/OPC topic, the update rate
should not be faster than the topic poll rate.

6--8 ■ RSView Supervisory Edition User’s Guide


4. To save the node configuration, click Accept.

5. When you are finished setting up nodes, click Close.

Example: Setting up an OPC node

The following example describes how to create a node to connect to


an OPC server using RSLinx.

Server Name

Click RSLinx OPC Server, or RSLinx Remote OPC Server.

If the OPC server is

local, in the Name box, type RSLinx OPC Server, or click the
Browse button to select it from a list.
Browse button
remote, in the Name box, type RSLinx Remote OPC Server, or
click the Browse button to select it from a list. Select the
Remote Computer Name or Address check box, and then type
the name of the remote computer, or click the Browse button to
select it from a list.

You don’t need to specify a vendor or version number.

Access Path

The access path is the DDE/OPC topic name in RSLinx. In this


example, we leave the Access Path blank, to allow the OPC Address
Browser to appear in the Tags editor.

Setting up communications for HMI tags ■ 6--9


Preface
The figure below shows the node set up in the Nodes editor.

The server
name appears
in the
spreadsheet’s
Station or
Server column.

Some columns do not apply to


OPC nodes, and are left blank.

Once you have created the node, assign it to a tag in the Tags editor.
The address tells RSView where in the node to get the data.

Address

[PLC_FLOC1]Motor1.Temp[0]
The ControlLogix processor called PLC_FLOC1 has been previously
set up as a DDE/OPC topic in RSLinx; Motor1.Temp[0] is the address.

If you include the Access Path when setting up the node, you can
enter the tag’s address as Motor1.Temp[0].

6--10 ■ RSView Supervisory Edition User’s Guide


The figure below shows the tag set up in the Tag editor.

Changing node information at run time


To change an OPC node’s server name and access path at run time,
use the NodeSwitch command. This command allows you to set up
node-level redundancy. That is, if the server that a node is pointing
to fails, you can immediately switch to another server.

NodeSwitch <node name> <parameter>

<node name> The name of the node that you want to change to
another server.

<parameter> is <\\computer name\server name[|access


path]> For OPC servers, the computer name, server name, and
access path (if in use) for the OPC server you want to switch to.
Separate the access path from the server name with the | character.

When you use the NodeSwitch command to change a node’s server


information, the change appears in the Nodes editor’s spreadsheet.
If the Nodes editor is open when you use the command, the change
will not appear until you close, and then re-open the editor.

For more information about the NodeSwitch command, see


Appendix A, RSView commands, or see Help.

Setting up communications for HMI tags ■ 6--11


Preface
You can also enable and disable nodes at run time, using the
NodeEnable and NodeDisable commands. For more information
see Appendix A, RSView commands.

Scanning for new tag values


When an RSView SE Server that contains HMI tags is running, it
must periodically update its tag values in the value table.

For applications using OPC, values are updated by the OPC server at
the rate specified in the server product. The update rate you specify
in the Nodes editor is the requested data rate. The OPC server uses
this rate to determine the fastest rate at which to notify your
RSView application (the OPC client) of tag value changes, if there
are any changes. For more details about setting the poll rate, see
your OPC server’s documentation.

The maximum tag update rate set up in the Display Settings dialog
box should not be faster than the OPC update rate. For details about
setting the maximum tag update rate in the Display Settings dialog
box, see page 15-20.

Scan class rates have no effect on OPC communications. They affect


only direct driver communications.

6--12 ■ RSView Supervisory Edition User’s Guide


7
Chapter

Working with tags


This chapter provides general information about working with all
kinds of tags. This chapter describes:

tags and the HMI tag database

when to use data server tags

when to use HMI tags

how to browse for tags

how to obtain tag values in your application, for example in


graphic displays

how to log tag values

Tags and the HMI tag database


A tag is a logical name for a variable in a device or in local memory
(RAM). For example, a tag can represent a process variable in a
programmable controller.

Data server tags, HMI tags, and their


attributes

RSView conforms to the OPC Data Access (DA) 2.0 specification for
information exchange among automation or control applications,
field systems or devices, and business or office applications.

Working with tags ■ 7--1


Preface
RSView provides direct access to the basic set of attributes of all
OPC-DA-compliant tags. The OPC-DA specification calls these tags
‘data items’. In RSView, you access OPC-DA-compliant tags through
a data server. In the RSView documentation, the tags you access
through a data server are called data server tags.

In addition, RSView provides a tag with additional properties, for


alarms, security, and data manipulation. This type of tag is called an
HMI tag.

The tags that you create in the Tags editor in RSView are called
HMI tags, but your application can also use other kinds of tags, such
as those found in ControlLogix processors, or tags from other
OPC-compliant devices.

Limits

Graphic displays can contain a maximum of 1,000 animations that


reference tags (HMI tags and data server tags).

Each HMI server in your application can have up to 40,000 HMI tags
that have alarms. Of these alarm tags, 10,000 can be analog HMI tags.

Use tags to access FactoryTalk Live data

To animate graphic displays, monitor alarms, log data, and for


several other uses, you need to obtain values from, or provide
values to devices or other software programs.

With access to FactoryTalk Live data, you can obtain information


about what your process is doing; for example, to be notified of
alarm conditions, or to monitor equipment or processes.

Access to FactoryTalk Live data also allows you to provide


information to control your process; for example, to open or close a
valve, or to start or stop a production line.

7--2 ■ RSView Supervisory Edition User’s Guide


Basic steps for using tags

To use tags, follow these basic steps:

1. If the tag does not already exist, create the tag:

To use a data server tag, you must first create it in the OPC
server or processor. For example, in a ControlLogix
processor, create the tag using your RSLogix 5000
programming software.

To use an HMI tag, you must first create it in the HMI


Tags editor.

2. Browse for, or type, the name of the tag anywhere you want to
connect an object to ‘live’ data at run time.

For example, to make a push button change a tag value when it


is pressed, connect the push button to a tag by typing the tag
name in the appropriate box in the push button’s Properties
dialog box.

Browsing for tags

If you don’t know the names of tags, you can browse for them. You
can browse while online and connected to a device, or you can
browse for tags from an offline file, for example a PLC program file.

To browse for tags, use the tag browser. For details, see page 7-8.

Using tag names that don’t exist

You can type the name of a tag that doesn’t yet exist. If you do this,
ensure that you spell every instance of the tag name consistently,
and that you when you do create the tag, you spell it the same way
you did when you referred to it.

Working with tags ■ 7--3


Preface
When to use data server tags
For some of the things you might need to do in your application,
you might not want to use HMI tags. Use tags located in devices
instead, for example, tags located in an OPC-DA server’s database.

Eliminate duplication

Using data server tags allows you to add, modify, or delete tags in a
device without having to duplicate the changes in RSView’s HMI tag
database.

Access to complex data

Some devices, for example ControlLogix processors, support


complex data types such as arrays and structures. Your controller
might have structures that contain hundreds of member elements.

Referencing tag values directly eliminates the need for:

creating one HMI tag for each member

creating additional HMI tags every time you create a new


instance of a data structure in your controller

Steps for using data server tags


To use data server tags, you must complete three basic steps:

1. Create the tag in the OPC server, or processor.

For information about creating tags in OPC-DA servers that have


their own tag database, see the documentation provided with the
OPC-DA server.

For information about creating tags in a ControlLogix


processor, see the documentation for your device programming
software.

7--4 ■ RSView Supervisory Edition User’s Guide


2. Create a data server, if your application doesn’t already have
one.

3. In graphic displays, data logging, or anywhere else you want to


access a tag’s value, map an object to a tag. At run time, the tag’s
value is passed to the object.

When to use HMI tags

You must use HMI tags (that is, you cannot use data server tags) for
any of the following things you might need to do in your
application.

Alarms

An alarm occurs when something goes wrong. It can signal that a


device or process has ceased operating within acceptable,
predefined limits or it can indicate breakdown, wear, or a process
malfunction.

In RSView, HMI tags provide the only method for triggering an


alarm when a tag has a certain value.

For more information about alarms, see Chapter 10, Setting up


alarms.

Security

You can assign a security code only to an HMI tag.

To prevent users from changing a value in a device, create an HMI


tag for the device’s address, and then assign security to the tag.

For information about assigning security codes to tags, see


Chapter 14, Adding security.

Working with tags ■ 7--5


Preface
Data manipulation

You must use HMI tags if the data server you are using does not
provide for:

scaling or offsetting a value

setting minimum or maximum limits on a value (that is,


providing a range of values)

Scale and offset

The scale and offset modify the ‘raw data’ that comes from and
goes to the programmable controller before it is saved in the
computer’s memory (called the value table). The scale and offset
also modify the value specified in RSView before it is written to the
programmable controller.

The scale is a multiplication factor—the value from the PLC is


multiplied by the scale.

The offset is a fixed value—after the value from the PLC is


multiplied by the scale, the offset amount is added.

Minimum and maximum

Tags allow you to set a minimum and maximum values that can be
written to the programmable controller or server.

These values do not affect what is read from the programmable


controller or server.

For example, if you specify a minimum of 0 and a maximum of 100,


RSView would be able to read a value of 200 from a PLC and store it
in the value table, but would not be able to write this value to
the PLC.

For information about minimum and maximum, and scale and


offset, see page 8-14.

7--6 ■ RSView Supervisory Edition User’s Guide


Storing values in RSView’s memory

A memory tag can be used to store values without the need for an
attached or accessible device.

For example, you might need to store a value in memory:

to store result of a calculation

temporarily, for example, a counter or index

to maintain information about the system’s current state, for


example which graphic display was last displayed

and so on. For information about creating memory HMI tags, see
Chapter 8, Creating HMI tags.

Steps for using HMI tags


To use HMI tags, you must complete three basic steps:

1. Create an HMI server, if your application doesn’t already have


one. Each HMI server contains one tag database.

2. In the tag database, map each tag name to an OPC tag, or device
address.

3. In graphic displays, alarm summaries, or anywhere else you


want to access a tag’s value, map an object to a tag. At run time,
the tag’s value is passed to the object.

Working with tags ■ 7--7


Preface
Browsing for tags

You don’t have to remember the path and name of a tag to use it in
your application. Whenever you need to use a tag, you can make
the Tag Browser appear by clicking the Browse button, or Tag
button.

The Tag Browser has two modes: one for selecting a single tag, and
one for selecting multiple tags. Depending on whether a single tag
or multiple tags are expected, when you click the Browse or Tag
button the single-selection tag browser appears, as shown above, or
the multiple-selection Tag Browser appears, as shown on page 7-16.

The Tag Browser for multiple selections lets you add tags to a list,
and then edit the list before you click OK.

7--8 ■ RSView Supervisory Edition User’s Guide


In the Tag Browser, you can:

select a tag by double-clicking it, or by highlighting it and then


clicking OK

edit an HMI tag by right-clicking it, and then clicking Edit HMI
Tag. The Tag Editor dialog box opens so you can edit the tag’s
definition.

create a new HMI tag by opening a folder that contains an HMI


server, right-clicking a blank area of the browser’s Contents
pane, and then clicking New HMI Tag. The New HMI Tag dialog
box opens so you can set up the tag.

create a new folder if the selected folder contains an HMI server.


To do this, right-click a blank area of the browser’s Folder pane,
and then click New HMI Tag Folder. The New HMI Tag Folder
dialog box opens so you can create the folder.

import tags from a PLC or SLC database and copy them into the
RSView tag database if the selected folder contains an HMI
server. To do this, right-click a blank area of the browser’s right
pane, and then click Import PLC Tags. The PLC Database
Browser opens so you can specify the tags you want to import.

Working with tags ■ 7--9


Preface
Browsing for off- line tags from RSLinx
For each RSLinx OPC/DDE topic in your application, an Offline and
an Online folder is displayed in the Tag Browser.

You can use the Offline folder to browse tags in a PLC program
stored on disk. If the OPC/DDE topic in RSLinx has access to
symbols, you can browse for them in the Offline folder, in the Tag
Browser. For details about adding symbols to the OPC/DDE topic in
RSLinx, see RSLinx Help.

Tags that are available


when you are not
connected to the
controller, are located in
the Offline folder.

Tags that are available


when you are connected
to the controller, are
located in the Online
folder.

Browsing for off- line tags from other OPC servers


To browse for off-line tags from OPC servers other than RSLinx, set
up a data server cache. When you are not connected to the device,
the cached tags appear in the same folders in the tag browser as the
online tags. The offline tags are not located in a different folder, as
with RSLinx.

For details about setting up and managing a data server’s cache files,
see “Setting up advanced properties” on page 5-6.

7--10 ■ RSView Supervisory Edition User’s Guide


Using the Tag Browser
When you click a Browse or Tag button, the Tag Browser opens.1.

Root folder

Area folder

Folders pane

Tags pane

For a better view of the


folders or tags, drag this
bar to the left or the right.

The Tag Browser window is divided into two panes. The left pane
shows the folder hierarchy for the tags in the application. The right
pane displays the tags in the folder you select in the left pane.

The parts of the Tag Browser are described on the pages that follow.

Working with tags ■ 7--11


Preface
Working with folders in the Tag Browser

Tags in your application are organized by folders. To open or close


a folder, do one of the following:

double-click the folder

click the folder and then press Enter to either open or close the
folder depending on its current state

click the + or – icon

Folders represent the layout of your application:

The root folder shows the name of the application.

Area folders show the names of areas in your application.

Showing server names

By default, the folder pane shows folders, but not the servers they
belong to. You can show the names of servers in the application.
To display server names, right-click a blank area of the folders pane
and then click Show Server Names.

The folders list with


server names hidden.

The folders list with


server names shown.

7--12 ■ RSView Supervisory Edition User’s Guide


Adding folders

You can add folders to HMI servers only. When you click the icon of
a folder that does not contain an HMI server, you cannot add folders.

To add a folder:

1. To make it easy to see where you can add folders, right-click the
Folders pane and then click Show Server Names.

You can only add folders


to HMI servers.

2. Right-click a folder belonging to an HMI server, and then click


New Folder. The New Folder dialog box appears.

3. In the Name box, type the folder name.

4. Click OK.

Working with tags ■ 7--13


Preface
Finding the home area

To locate the tags in the home area, right-click a blank area of the
folder pane, and then click Go To Home Area. The home area is
selected automatically. For more information about the home area,
see page 7-20.

If you click Show Server


Names on the shortcut
menu, the home area
appears in bold type.

Refreshing the list of folders and tags

If you have the Tag Browser open, and you or another user on the
network add a tag, the new tag does not appear in the Tag Browser
automatically.

To refresh the list of tags in the Tag Browser, right-click a folder in


the Folders list, and then click Refresh folder, or Refresh all folders.

If your application contains many data servers, refreshing all folders


can take some time.

Working with tags in the Tag Browser


Tags appear in the right pane of the Tag Browser.

Displaying tags

To display tags, select a folder. Any tags in the folder appear in the
right pane of the Tag Browser. If multiple servers use the same tag
name, the server name automatically appears with the tag name.

7--14 ■ RSView Supervisory Edition User’s Guide


Showing or hiding tag descriptions

By default, the Tag Browser does not show tag descriptions.


To show or hide tag descriptions, right-click a blank area of the
right pane, and then click Show Description.

Selecting tags

To select tags, do one of the following:

to select a single tag, double-click the item.

to select consecutive tags, click the first item, press and hold
down the Shift key, click the last tag, and then click OK.

to select tags that are not consecutive, click the first item, press
and hold down the Ctrl key, and then click each item. When
you are finished selecting items, click OK.

To select all the tags in the list, right-click the tags pane, and then
click Add Item(s) to List.

Working with tags ■ 7--15


Preface
Using the selected tags list

The selected tags list shows the list of tags you have selected. If
multiple servers use the same tag name, the server name
automatically appears with the tag name.

You can copy items from


this list to the clipboard by
highlighting them, and
then pressing Ctrl-- C.

To add tags to the list:

1. Click the folder that contains the tags you want to add to the
list.

2. Select the tags you want to add to the list.

3. Click Add Tag(s) to List.

7--16 ■ RSView Supervisory Edition User’s Guide


To remove selected items from the list:

You can remove items from the list before you click OK.

" Highlight the item or items you want to remove, and then do
one of the following:

click the Remove button.

right-click to open the shortcut menu, and then click


Remove.

To remove all the items from the list:

To clear the list, you do not have to highlight tag names first.

" Do one of the following:

click the Clear button.

right-click to open the shortcut menu, and then click Clear.

Displaying tag properties

To display tag properties, right-click a tag, and then click


Properties.

The Tag Properties dialog box shows information about the tag.
The properties are a snapshot, and do not update in real time. You
cannot display the properties of multiple tags at the same time.

Working with tags ■ 7--17


Preface
Filtering tags

To display only tags whose names match a pattern, type the pattern
in the Tag Filter box, and then press Enter.

To create the filter, you can use these wildcards:

This wildcard Does this

? Matches any single character.

* Matches any number of characters.

The Tag Filter box lists the last 10 filters you applied.

Type the tag filter here.


To clear the filter, click
<None> in the list.

Removing a tag filter

To remove a tag filter, in the Tag Filter list, click ‹None›.

7--18 ■ RSView Supervisory Edition User’s Guide


Creating, editing, and importing HMI tags

The shortcut menu in the Tag Browser’s right pane includes three
menu items for manipulating HMI tags:

New HMI Tag allows you to create a new HMI tag.

IMPORTANT HMI tags are always added to the home area, not the
area you select in the Folders pane. For information
about the home area, see page 7-20.

Edit HMI Tag allows you to edit an existing HMI tag.

Import PLC Tags allows you to import a tag from another


database.

For information about creating and editing HMI tags, see Chapter 8,
Creating HMI tags. For information about importing tags from a PLC
database, see page 8-21.

Using tag references


When you refer to a tag, you create a reference to the tag. For
example, you might refer to a tag called FanRunning to obtain its
value for animating a graphical representation of a fan in a graphic
display.

The tag browser composes references to tags for you automatically.


You can also create references to tags manually, by typing the tag
name.

There are two ways to refer to a tag. You can create an absolute
reference, or a relative reference.

Working with tags ■ 7--19


Preface
Absolute references

Absolute references point directly at a specific tag by referring to


the tag’s name and the path to it. Absolute references are a way of
referring to a specific tag in a specific area.

For example, /Cooling/Fans::Extractor is a reference to an extractor


fan in the Fans subarea of the Cooling area.

Use absolute references when you want to ensure you are referring
to a specific tag in a specific location, or when all your tag names
are unique.

Relative references

Relative references point at a tag relative to the current server or


area.

For example, Extractor is a reference to an extractor fan in the


current area.

Relative references are useful if your tag names are all the same, but
they are in different areas. This might be the case if you expect to
clone identical areas, for example to represent identical production
lines in your plant. For details about how to use areas, see
page 4-10.

The home area

The home area is the area in which a component (for example, a


graphic display) is located.

For example, if you are creating a graphic display in the Cooling


area, and add a relative reference to a tag (for example, FanStart),
RSView looks for the tag in the home area of the graphic display
(Cooling). If the tag does not belong to a data server or HMI server
in the home area, an error will occur when the display runs.

7--20 ■ RSView Supervisory Edition User’s Guide


If the tags you are selecting are in the home area, the Tag Browser
automatically uses relative references. If the tags are not in the
home area, the Tag Browser uses absolute references.

If you click Show Server


Names on the shortcut
menu, the home area
appears in bold type.

Logging tag values

Any tag value can be logged. To set up logging, use the Data Log
Setup editor. For details, see Chapter 12, Setting up data logging.

Working with tags ■ 7--21


8
Chapter

Creating HMI tags


This chapter describes:

the different types of HMI tags

the importance of organizing tags

how to create analog, digital, and string tags in the Tags editor

HMI tag types

An RSView server contains the following types of HMI tags:

Tag Type of data stored

Analog Range of values.

These tags can represent variable states such as temperature or


the position of rotary controls.

Digital 0 or 1.

These tags can represent devices that can only be on or off,


such as switches, contacts, and relays.

Creating HMI tags ■ 8--1


Preface

Tag Type of data stored

String ASCII string, series of characters, or whole words (maximum of


82 characters).

These tags can represent devices that use text, such as a bar
code scanner which uses an alphanumeric product code.

System Information generated while the system is running, including


alarm information, communication status, system time and
date, and so on.

RSView creates system tags when it creates an HMI project.


The system tags are stored in the folder called ‘System’ in the
tag database. You cannot edit system tags. You can use system
tags anywhere you would use any other type of tag.

Data sources for HMI tags

When defining an analog, digital, or string HMI tag, you must


specify a data source. The data source determines whether the HMI
tag receives its values externally or internally.

Device

An HMI tag with Device as its data source receives its data from a
source external to RSView. The data can come from a driver for a
programmable controller (called a direct driver), or from an OPC or
DDE server.

Memory

An HMI tag with Memory as its data source receives its data from
the RSView internal value table. A memory tag can be used to store
values internally.

8--2 ■ RSView Supervisory Edition User’s Guide


Organizing HMI tags

Organizing tags makes database creation faster and simpler. To


organize tags:

establish naming conventions

Naming conventions enable you and operators to use wildcards


most effectively when searching for and displaying tags during
development and runtime.

use folders to group related tags

Naming HMI tags

Tag names can be up to 40 characters long. If you create a folder,


the folder name becomes part of the tag name.

The tag name can contain the following characters:

A to Z

0 to 9

underscore ( _ ) and dash ( – )

The tag name can be mixed case. Tag names preserve upper and
lower case for readability but are not case sensitive. For example,
the tag name MixerValve1 is the same as mixervalve1.

When a tag name starts with a number or contains a dash, enclose


the name in braces { } when you use it in an expression, for
example, {N33-0}. Also use braces when using wildcards to
represent multiple tags in an expression, for example, {alarm*}. For
more information about using tags in expressions see Chapter 18,
Creating expressions.

Creating HMI tags ■ 8--3


Preface
Using folders to group HMI tags

To organize tags, create a folder, and then include tags that are
related to one another. To separate the folder name from the rest of
the tag name, use a backslash ( \ ). For example, tags in the folder
called Pump would start with Pump\.

For greater organization, you can nest folders. For example, if your
plant is divided into zones, you can organize the tag database first
by zone, then by machines in the zone, and finally by devices in
each machine. The result might be Area1\Machine1\Pump.

The Tags editor


Each HMI server in your application contains its own HMI tag
database. You can edit each one of these tag databases either locally
(on the same computer) or remotely (from a different computer).

To open the Tags editor:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Tags editor by doing one of the following:

double-click the Tags icon

right-click the Tags icon and then click Show

drag the Tags icon to the workspace

8--4 ■ RSView Supervisory Edition User’s Guide


The Tags editor has the following parts: form, query box, folder
hierarchy, and spreadsheet. Each part is described on the following
pages.

Form

Query Box

Folder Hierarchy

Spreadsheet

Using the Accept and Discard buttons

When you enter information, the Prev and Next buttons change to
Accept and Discard buttons. Click Accept to save tag and alarm
information. Click Discard to cancel changes to a tag.

Using the form


Use the form to create a tag.

In the upper part of the form, define the basic characteristics of the
tag, such as tag name, type, security, and specifics related to the tag
type.

Creating HMI tags ■ 8--5


Preface
In the lower part of the form, define the data source (where the
tag’s values will come from).

Select the Alarm check box to define alarm conditions for an analog
or digital tag. To edit alarms once they have been defined, click the
Alarm button.

Using the query box


Use the query box to select the tags you want displayed in the
spreadsheet. This allows you to edit tags in different folders
without browsing the folder hierarchy. You can:

select a single tag by typing the tag name

select multiple tags by typing wildcards. The wildcards are:

This character Does this

? Matches any single character.

* Matches any number of characters, including the


backslash ( \ ) character.

Use this wildcard by itself to display all the tags in


the tag database.

When you search for tags, remember that the backslash in a folder
name counts as one character in the tag name.

Using the folder hierarchy


The hierarchy and spreadsheet work together. The hierarchy shows
the tag folders, and the spreadsheet shows the tags within the
folders.

A folder icon called root is always present in the hierarchy window,


at the top of the folder hierarchy. This folder contains all the tag

8--6 ■ RSView Supervisory Edition User’s Guide


folders you and RSView create. For example, the system folder
holds the system tags that come with RSView. For a complete list of
the system tags, click the system folder to display its contents, or
see Appendix B, System tags.

You can nest folders. If a folder icon has a plus ( + ) sign on it, the
folder contains one or more folders. If the folder’s icon is blank, it
does not contain any other folders.

This folder contains one or more folders.

This folder does not contain another folder.

Creating a folder

1. On the Edit menu, click New Folder, or on the toolbar, click the
Create Folder button.
Create Folder

2. In the New Folder dialog box, type the folder name.

3. Click OK.

The new folder appears in the hierarchy.

Creating HMI tags ■ 8--7


Preface
Opening a folder

When you open a folder, its contents are displayed in the


spreadsheet.

To open a folder, do one of the following:

double-click the folder

click the folder, and then press Enter

To open multiple folders:

1. Select the folders by doing one of the following:

click a folder and then drag the mouse up or down

click a folder and then Shift-click other folders immediately


above or below the first selected folder

click a folder and then Ctrl-click other folders anywhere in


the hierarchy

2. Press Enter.

The tags in the selected folders are displayed in the spreadsheet.

Adding tags to a folder

Once you have created a folder, you can add tags to it.

1. Select a folder in the folder hierarchy.

The folder name is displayed in the Name box of the form.

2. After the backslash ( \ ), type the new tag name.

8--8 ■ RSView Supervisory Edition User’s Guide


Nesting a folder

1. Select a folder in the folder hierarchy.

2. On the Edit menu, click New Folder, or on the toolbar, click the
Create Folder button.
Create Folder
3. In the New Folder dialog box, type a backslash ( \ ) followed by
the new folder name.

4. Click OK.

When you nest folders, remember that the backslash in a folder


name counts as one character in the tag name.

To view a series of nested folders, resize the hierarchy box. To


resize it, place the cursor over the right border of the box until it
changes to a double arrow. Drag the border to the required size.

Creating HMI tags ■ 8--9


Preface
Duplicating a folder

When you duplicate a folder, all the tags in the folder are
automatically given the new folder name. If the folder contains
folders, those folders are also duplicated.

IMPORTANT Be sure to click Duplicate Folder rather than Duplicate.


Duplicate only duplicates individual tags.

To duplicate a folder and its tags:

1. Click the folder in the hierarchy.

Duplicate Tag Folder 2. On the Edit menu, click Duplicate Folder on the Edit menu, or
on the toolbar, click the Duplicate Tag Folder button.

3. In the To box, type the new folder name.

4. Click OK.

Deleting a folder

1. Select one or more folders in the hierarchy.

Delete Folder
2. On the Edit menu, click Delete Folder, or on the toolbar, click
the Delete Folder button.

8--10 ■ RSView Supervisory Edition User’s Guide


Using the spreadsheet
Use the spreadsheet to view tags. Use the query box or folder
hierarchy to select the tags you want to view.

Moving through the spreadsheet

To scroll through the spreadsheet rows, do one of the following:

use the Prev or Next buttons in the form area

use the up arrow and down arrow keys

use the scroll bars on the spreadsheet

To select a row, click anywhere in the row or click the row number.

Resizing columns and rows

To resize a column or row:

1. Place the cursor over the division between the column or row, in
the top or side border. When positioned correctly, the cursor
changes to a double arrow.

2. Drag the column or row to the required size.

Adding a tag

To add a tag, do one of the following:

click the New button in the forms area. This inserts a new row
above the highlighted row.

on the Edit menu, click Insert Row, or on the toolbar, click the
Insert Row button. This inserts a new row above the highlighted
Insert Row row.

Creating HMI tags ■ 8--11


Preface
Duplicating a tag

1. Select the tag you want to duplicate.

2. On the Edit menu, click Duplicate, or on the toolbar, click the


Duplicate button.
Duplicate
A new row is inserted below the highlighted row. The new row
contains all the same information except the tag name.

3. In the Tag Name box, type the name for the new tag.

4. Click Accept.

Editing a tag

You can edit all parts of a tag except the tag name and tag type.

1. Select the tag you want to edit.

The details of the tag appear in the form area.

2. Edit any details except the tag name or type.

Deleting a tag

Delete tags carefully. Once you click the Delete button, the tag is
deleted. There is no confirmation message, and you cannot undo
the deletion.

1. Select the tag you want to delete.

Delete 2. On the Edit menu, click Delete, or on the toolbar, click the
Delete button.

8--12 ■ RSView Supervisory Edition User’s Guide


Setting up tag type
The topics below describe how to complete the fields for analog,
digital, and string tag types. For a description of how to complete
the Data Source fields, see “Specifying a data source” on
page 8-18.3.

Setting up an analog tag

1. If the tag is part of a folder, select the folder in the folder


hierarchy. The folder name appears in the Name field and is the
first part of the tag name.

2. Type a tag name. If the tag is part of a folder, type the name after
the backslash ( \ ).

3. In the Type list, click Analog.

4. Fill in the fields as outlined below:

Security To restrict access to this tag, select a security code. If


access is restricted, operators cannot change a tag value without
the proper security code. For detailed information about
security, see Chapter 14, Adding security.

Description Type a description of the tag, up to 128 characters


long.

Creating HMI tags ■ 8--13


Preface
Minimum and Maximum Type the minimum and maximum
values that can be written to the programmable controller or
server. These values do not affect what is read from the
programmable controller or server. For example, if you specify a
minimum of 0 and a maximum of 100, RSView would be able to
read a value of 200 from a PLC and store it in the value table, but
would not be able to write this value to the PLC.

The range between the minimum and maximum values cannot


exceed the maximum floating point value (3.402823E 38 ).

Scale and Offset Type a number. For the scale, do not use 0.
To disable the scale, type 1. To disable the offset, type 0.

The scale and offset modify the ‘raw data’ that comes from and
goes to the programmable controller before it is saved in the
value table. The scale and offset also modify the value specified
in RSView before it is written to the programmable controller.

The scale is a multiplication factor—the value from the PLC is


multiplied by the scale.

The offset is a fixed value—after the value from the PLC is


multiplied by the scale, the offset amount is added.

This formula shows the relationship between the PLC value and
the amount stored in the RSView value table:

RSView value = (PLC value × scale) + offset

IMPORTANT Values from the programmable controller are first


scaled, and then added to the offset. When a value is
written to the programmable controller, the process is
reversed: the offset is subtracted, and then the scale is
used for division. This ensures that the correct,
unchanged value is sent to the programmable
controller.

Units Type a text label, for display only, up to 20 characters


long. This specifies how the tag value is measured (for example,
gallon, PSI, min, sec).

8--14 ■ RSView Supervisory Edition User’s Guide


Data Type The data types are:

Data type Description Range

Default Depends on the data source and node See below.


type:

If Device is the data source, for direct


driver nodes RSView matches the data
format specified by the address, for
example, N7:0 = Integer, F8:0 = Floating
Point.

Do not use Default for OPC or DDE


nodes, as this might produce unexpected
results.

If Memory is the data source, Default is


Floating Point.

Unsigned Integer Unsigned 16-bit integer 0 to 65,535

Integer Signed 16-bit integer –32,768 to 32,767

Long Integer Signed 32-bit integer –2,147,483,648 to 2,147,483,647

Floating Point Single-precision (32-bit) floating point –3.402823 E +38 to –1.175494 E –38,
0,
1.175494 E –38 to 3.402823 E +38

Byte Unsigned 8-bit integer 0 to 255

3-Digit BCD 3-digit binary-coded decimal 0 to 999

4-Digit BCD 4-digit binary-coded decimal 0 to 9,999

For tags with Device as the data source, select the data type that
matches the format of the data stored in the programmable
controller or Windows application. If you are using direct driver
nodes, use the Default data type to match the data format
specified by the address automatically.

If you are using OPC or DDE nodes, do not use the Default data
type because the default might not be as expected.

Creating HMI tags ■ 8--15


Preface
For tags with Memory as the data source, select the data type
that matches the format of the data you will store in the tag.
Choosing Default is the same as choosing Floating Point.

IMPORTANT For a tag with a Long Integer data type, if the


minimum, maximum, scale, offset, or initial value is
used with a decimal point, RSView stores the value in
floating point format. This means that the maximum
value for the tag is 16,777,216, which is the maximum
integer value for single-precision floating point
numbers.

Setting up a digital tag

1. If the tag is part of a folder, select the folder in the folder


hierarchy. The folder name appears in the Name field and is the
first part of the tag name.

2. Type a tag name. If the tag is part of a folder, type the name after
the backslash ( \ ).

3. In the Type list, click Digital.

4. Fill in the fields as outlined below:

Security To restrict access to this tag, select a security code. If


access is restricted, operators cannot change a tag value without

8--16 ■ RSView Supervisory Edition User’s Guide


the proper security code. For detailed information about
security, see Chapter 14, Adding security.

Description Type a description of this tag, up to 128 characters


long.

Off Label and On Label Type text up to 20 characters long that


describes the off state (value = 0) and on state (value = 1) of the
tag. The off and on labels must be different. One or the other,
but not both, can be blank.

Setting up a string tag

1. If the tag is part of a folder, select the folder in the folder


hierarchy. The folder name appears in the Name field and is the
first part of the tag name.

2. Type a tag name. If the tag is part of a folder, type the name after
the backslash ( \ ).

3. In the Type list, click String.

4. Fill in the fields as outlined below:

Security To restrict access to this tag, select a security code. If


access is restricted, operators cannot change a tag value without
the proper security code. For details, see Chapter 14, Adding
security.

Creating HMI tags ■ 8--17


Preface
Description Type a description of this tag, up to 128 characters
long.

Length Type a number between 1 and 82 to specify the length


of the string tag in characters. RSView will accept only a length
that is a multiple of the size of the Allen-Bradley programmable
controller data element you are addressing.

Specifying a data source


The following topics describe how to complete the Data Source
fields. For details about setting up analog, digital, and string tag
types, see “Setting up tag type” on page 8-13.

Specifying device as the data source

An HMI tag with device as its data source receives its data from a
source external to RSView. The data can come from: 5. 6.

Allen-Bradley or SoftLogix 5 programmable controllers through


RSLinx direct drivers. This feature is provided to support legacy
applications only.

programmable controllers through an OPC or DDE server

another Windows program through an OPC or DDE server

8--18 ■ RSView Supervisory Edition User’s Guide


To specify device as the data source:

1. Click Device.

2. Supply a node name by doing one of the following:

type a node name

to add a new node, double-click in the Node Name box

to select a node from a list, click the Browse button

Browse button 3. If you are connecting a legacy application to Allen-Bradley or


SoftLogix 5 devices through direct drivers, select a scan class.

For more information about scan classes, see page C-18.

4. In the Address box, do one of the following:

specify the physical memory location in the programmable


controller. The syntax of the address depends on the
programmable controller.

specify the name of the tag in the OPC server or specify the
DDE item

If you are using an OPC node, click the Browse button to


select the OPC tag address.

If you are using a DDE node, the DDE item name and format
depend on the DDE server and are not validated by RSView.

For information about addressing syntax, see your OPC or


DDE server documentation.

Creating HMI tags ■ 8--19


Preface
For more information about setting up OPC communications for
tags, see Chapter 6, Setting up communications for HMI tags.

For more information about setting up DDE communications for


tags, see Appendix D, Setting up DDE communications for HMI
tags.

Specifying memory as the data source

1. Click Memory.

2. In the Initial Value box, type the tag’s starting value.

When you first load an HMI project, a memory tag has the value
defined in the Initial Value box. To ensure that a memory tag
uses a particular value when the project starts, use the Set or =
(Equal) commands in a startup macro to specify the tag’s value.
The value of a memory tag can also be set using derived tags,
events, or graphic objects.

Other methods for creating HMI tags

In addition to creating tags in the Tags editor as described earlier in


this chapter, you can:

create tags in a third-party application and import them into


RSView

create tags from the Tag Browser

import tags from a PLC or SLC database

8--20 ■ RSView Supervisory Edition User’s Guide


Creating tags in a third-party application

You can use a third-party spreadsheet editor such as Microsoft


Excel to create your tags, and then import the tags into RSView
using the HMI Tag Import and Export Wizard. The wizard is in the
RSView Tools folder, or in RSView Studio on the Tools menu.

When you import tags, they are merged with tags already in the tag
database and any tags with the same name are updated with the new
information.

For more information about the Wizard, see “Using the Tag Import
and Export Wizard” on page 8-24.

Creating tags as needed in other


RSView editors

Any editor that uses tags has access to the tag database.

To create tags using the Tag Browser:

1. Click the Browse button or the Tags button, whichever is


available, to open the Tag Browser.
Browse button
2. In the Tag Browser, open the folder in which you want to create
the tag, right-click a blank area of the Contents pane, and then
click New HMI Tag.
Tags button
The Tag Editor dialog box opens so you can set up the tag.

Importing tags from a PLC database

To import tags from a PLC database, use the Import PLC Tags dialog
box. To open the Import PLC Tags dialog box:

in the Tag Browser, right-click a blank area of the Contents


pane, and then click Import PLC Tags
DB Browser button in
the Tags editor
in the Tags editor, click the DB Browser button on the toolbar

Creating HMI tags ■ 8--21


Preface
Use the Import PLC Tags dialog box to import tags selectively from
an Allen-Bradley PLC database into the RSView HMI tag database.
Tags imported in this way are copied into the database—they are
not shared with the source database. This means changes to tags in
RSView do not affect the database from which they have been
imported and vice versa.

You can import tags from any of these databases:

legacy PLC databases, created using WINtelligent LOGIC 5t or


A.I. 5,t with file extension .dsc

RSLogix 5/500, saved as an external database, with file extension


.ctd

RSLogix 5 internal database, with file extension .rsp

RSLogix 500 internal database, with file extension .rss

Use the filter to search for


a particular tag or set of
tags.

You cannot use wildcards


or filter beyond a slash.
For example, a filter
containing N7/1 will not
show N7/10, N7/11, and
so on.

8--22 ■ RSView Supervisory Edition User’s Guide


For PLC and SLC addresses, the Import PLC Tags dialog box shows
only addresses that are used in the symbol or address list of the PLC
programming software.

To import tags from a PLC database:

1. Specify the data source for the tag by typing the node name and
scan class if the node type is direct driver.

2. In the PLC Database box, type the name and path for the
database you want to import tags from, or click the Browse
button to locate and select the database you want to import tags
from.

The addresses and symbols from the selected database are


displayed in the box below the Filter data entry field.

3. To filter the tag list so that only certain addresses or symbols are
displayed, type a character string, then click Search. If you want
to search on names only, click Symbols so that only symbol
names are displayed. If an address does not have a symbol name
it will not be displayed.

Use the filter if the address or symbol list is too big to display
entirely.

4. Highlight the symbol, or symbols you want to import.

5. In the Put Tags into Folder box, type a folder name if you want
the tags to be in a folder. If the folder does not already exist in
the tag database it will be created.

6. Click OK.

The selected symbols are added to the tag database for the
current application, and are displayed in the tag list. If you have
already imported a particular symbol, you are prompted to
change its name if you want to import it again.

Creating HMI tags ■ 8--23


Preface
Using the Tag Import and Export Wizard

You can also import PLC or SLC databases into RSView using the Tag
Import and Export Wizard.

To use the wizard:

" Do one of the following:

in the Application Explorer, click the Tools menu, and then


click Tag Import and Export Wizard

click the Windows Start button, point to Programs,


Rockwell Software, RSView Enterprise, Tools, and then click
Tag Import and Export Wizard

If you need help while using the wizard, click the Help button.

Adding alarms to HMI tags


Analog and digital tags can have alarms associated with them. At
runtime, RSView scans the tag values in the tag database and
compares them to the limits you set for the tags. If a tag value
crosses a limit, an alarm is triggered.

When a tag has an alarm set up for it, an X appears in the Alm
column of the Tags editor’s spreadsheet, and the Alarm button in
the editor’s form is highlighted (enabled).

For details about alarms, see Chapter 10, Setting up alarms.

8--24 ■ RSView Supervisory Edition User’s Guide


Getting HMI tag values from servers
To get HMI tag values from an OPC or DDE server, you must set up an
OPC or DDE node and then use that node name when creating a tag.

For details about creating an OPC node, see page 6-4.

For details about creating a DDE node, see page D-4.

For details about creating tags, see Chapter 7, Working with tags.

Creating HMI tags ■ 8--25


9
Chapter

Creating derived tags


A derived tag is a tag whose value is the result of an expression. The
expression can be made up of mathematical operations, tag values
from the value table, if – then – else logic, and other special
functions.

Derived tag calculations are performed at the HMI server.

You should not write to derived tags, because the derived tag is
only evaluated when the expression changes. For example, if the
derived tag called Tag3 has the expression of Tag1 + Tag2, and if
you set Tag3 = 0, the value of Tag3 becomes zero, and will only be
updated when the value of Tag1 or Tag2 changes.

How to use derived tags


Here is an example of how a derived tag can be used. Suppose there
are five weight sensors on a conveyor belt. The tag database
contains one tag for each sensor, so the weight at each point on the
conveyor belt is monitored. If the weight at any point is excessive,
RSView triggers an alarm.

However, what happens if no individual sensor detects an excessive


weight, but the total of all five sensors is too high? In this case, you
could set up a derived tag to sum the weights of all five sensors and
store the result in the value table. Then, if this total is too high,
RSView can trigger an alarm.

Creating derived tags ■ 9--1


Preface
How to use multiple derived tag components
You can create multiple derived tag components. At runtime, up to
20 derived tag components containing a maximum of 1,000 tags can
run simultaneously.

Use multiple derived tag components to group derived tags that


need to be evaluated at different rates

Summary of steps
The main steps for setting up derived tags are:

set the maximum update rate for the the derived tag component
in the Derived Tag Setup dialog box

create the derived tags in the Derived Tags editor

The Derived Tags editor

To open the Derived Tags editor:

1. In the Application Explorer, open the Logic and Control folder.

2. Open the Derived Tags editor by doing one of the following:

drag the Derived Tags editor from the Application Explorer


to the workspace

right-click the Derived Tags editor and then click New

9--2 ■ RSView Supervisory Edition User’s Guide


Using the Check Syntax button

The Check Syntax button verifies that the expression you typed
uses correct syntax.

You can check the syntax of your expression at any time by clicking
the Check Syntax button. If the syntax is invalid, an error appears
next to the Check Syntax button.

The syntax of the expression is also checked automatically when


you click the Accept or Discard buttons.

Using the Accept and Discard buttons

When you enter information in the editor, the Prev and Next
buttons change to Accept and Discard. Click Accept to save
information. Click Discard to discard information.

Creating derived tags ■ 9--3


Preface
Setting the maximum update rate

The maximum update rate is the fastest rate at which the value of
any derived tag in the derived tag component is updated.
Expressions containing derived tags are evaluated only when the
value of a tag or function in the expression changes.

You must set the maximum update rate separately for each derived
tag component.

The maximum update rate also determines the fastest rate at which
data servers send changes in tag values.

Set the update rate as fast as, or faster than, the rate at which the
values of tags used in the expressions change, unless it is desirable
to miss changes in tag values.

To set the maximum update rate for the derived tag


component:

1. On the menu bar, click Setup and then click Derived Tag Setup.

2. In the Derived Tag Setup dialog box, type a brief description of


the derived tag component. This description is for your
information only—it does not appear anywhere else.

For example, if you were creating a derived tag component for a


certain area of your plant, you might type ‘West Wing Assembly
Line’ in the Description box to identify the area.

9--4 ■ RSView Supervisory Edition User’s Guide


3. In the Maximum Update Rate list, click an update rate. For
example, if you click 0.25, no derived tag will be evaluated faster
than every quarter of a second.

4. Click OK.

Creating derived tags

To create derived tags, use the Derived Tags editor. The following
illustration shows a derived tag component.

IMPORTANT Do not create derived tags that depend on the results of


other derived tags.

Creating derived tags ■ 9--5


Preface
To create a derived tag:

1. In the Tag Name box, type the name of the tag that will hold the
derived tag value. You can also browse for the tag name using
Browse button the Browse button.

You can use any tag as a derived tag. The tag must exist, for
example in a programmable controller, or data server, before
you can use it as a derived tag.

IMPORTANT Limit the use of tags that reference devices. If the


system is continuously writing the derived value to a
device, the communication network can be flooded
with traffic. Also, if writing occurs too often, the
buffer for the communication channel can overflow
and generate communication errors.

2. In the Description box, type a brief description of the derived


tag. This description is for your information only—it does not
appear anywhere else.

3. In the Expression box, type the expression that will determine


the derived tag’s value.

For more information about expressions, see Chapter 18,


Creating expressions.

4. Click Accept.

5. Repeat Steps 1 through 4 to create more derived tags.

To move to a new record in the spreadsheet, click the Next


button.

9--6 ■ RSView Supervisory Edition User’s Guide


Editing derived tags
You can edit derived tags during development, or in the RSView
Administration Console.

To edit a derived tag:

1. Open the derived tag component you want to edit.

2. Use the Prev and Next buttons to move among derived tags.
Make the required changes.

3. Click Accept to save the changes.

If you change the derived tag component at runtime, the changes do


not take effect until you stop running the component and then start
it again.

Starting and stopping derived tag processing


There are many ways to start and stop derived tag processing.
Choose the way that works best for your application.

For a complete list of RSView commands and their command


syntax, see Appendix A, RSView commands, or see Help.

Ways to start derived tag processing

In the Startup editor, select the Derived Tags check box and then
click the name of a derived tag component. The derived tag
component starts the next time the HMI server runs, or when the
HMI server’s components are started manually.

In the Macros editor, create a macro that contains the command,


DerivedOn <component>. In the Startup editor, select this
macro in the Startup Macro list.

Creating derived tags ■ 9--7


Preface
In the Graphic Displays editor, create a button and then specify
the DerivedOn <component> command as the button’s press
action. When the button is pressed, derived tag processing starts.

In the Graphic Displays editor, create a graphic object and then


attach touch animation with the DerivedOn <component>
command as the object’s action. When the object is touched,
derived tag processing starts.

In the Events editor, specify the DerivedOn <component>


command as the action for an event.

At the command line in RSView Studio, or the RSView


Administration Console, type DerivedOn <component> and
then press Enter.

Ways to stop derived tag processing

To stop all the components that are running on the HMI server,
including data log models, event components, derived tag
components, and alarm monitoring, stop the components running
on the HMI server manually. For details, see page 22-11.

To stop a single derived tag component, use any of the methods


below:

In the Graphic Displays editor, create a button and then specify


the DerivedOff <component> command as the button’s press
action. When the button is pressed, derived tag processing stops.

In the Graphic Displays editor, create a graphic object and then


attach touch animation with the DerivedOff <component>
command as the object’s action. When the object is touched,
derived tag processing stops.

In the Events editor, specify the DerivedOff <component>


command as the action for an event.

At the command line in RSView Studio, or the RSView


Administration Console, type DerivedOff <component> and
then press Enter.

9--8 ■ RSView Supervisory Edition User’s Guide


10
Chapter

Setting up alarms
In RSView Studio, you can set up a complete alarm system. Alarms
are an important part of most plant control applications because an
operator must know the instant something goes wrong. It is often
equally important to have a record of the alarm and whether the
alarm was acknowledged.

Alarm monitoring occurs at the HMI server. If alarms are detected,


they are annunciated at the RSView SE Client, where operators can
view and acknowledge them.

IMPORTANT You can monitor only HMI tags for alarms. You cannot
monitor data server tags for alarms.

Summary of features
With the RSView alarm system, you can:

monitor any analog and digital HMI tag for alarms (to a
maximum of 40,000 tags per HMI server)

display the last 2,000 alarm transactions from each HMI server, in
an alarm summary

define up to eight different severity levels to distinguish alarms


visually

use system default messages or create unique messages to


describe an alarm

log messages to a file, to a printer, or to both

Setting up alarms ■ 10--1


Preface
suppress alarms for maintenance and tuning purposes

associate a command or macro with an alarm to provide custom


handling of the alarm

share alarm information with other RSView components

set up global alarm monitoring

use the AlarmEvent command to respond to your own alarm


detection algorithms for annunciation, logging, printing, and for
display in alarm summaries

Key concepts
An alarm occurs when something goes wrong. It can signal that a
device or process has ceased operating within acceptable,
predefined limits or it can indicate breakdown, wear, or a process
malfunction.

Set up a system of alarms in the Tags editor by linking alarms to


tags you want monitored. When the tag values are updated in the
RSView SE Server’s HMI tag value table, they are compared to the
limits you assigned when you set up the alarm. If a tag value
exceeds the limits you specified, an alarm of a preset severity is
triggered.

Alarms for analog HMI tags

An analog tag can trigger a number of alarms when it crosses


various predefined threshold levels (unlike a digital tag, which is
either on or off ).

10--2 ■ RSView Supervisory Edition User’s Guide


Thresholds

When defining an analog tag, you can assign up to eight alarm


thresholds with different levels of alarm severity to indicate the
alarm’s importance. The lowest threshold is one and the highest is
eight. You do not have to use all eight thresholds for a tag, but the
ones you use must be set up in ascending order. For example, you
can assign thresholds one, two, and eight as long as you assign them
in that order.

Thresholds can be increasing—monitoring for a rising value that


crosses the threshold, or decreasing—monitoring for a falling value
that crosses the threshold. The following illustration shows a tag
with both increasing and decreasing thresholds. In this example, the
deadband setting is zero.

In the following example, the illustration shows the changing values


of a tag monitoring a motor’s revolutions per minute (rpm). With
the threshold settings illustrated, the motor must run between
2,000 rpm and 3,000 rpm, or an alarm is triggered. In the
illustration, an X shows when the tag goes into alarm and an
O shows when the tag goes out of alarm.

Setting up alarms ■ 10--3


Preface

Example: Alarm thresholds

Alarm
Threshold severity
values Thresholds level

5,000 6 1
XX *
4,000 5 4
Increasing
X X*
3,000 4 8
X O Safe
2,000 3 zone
X O 8

Decreasing 1,000 2 6

1 1 4
time
Thresholds must
be set up in * These alarms are triggered only if the check
ascending order. box ‘Generate alarms when approaching
normal operating range’ is selected in the
Alarm Setup dialog box.

If the motor speed It triggers an alarm of this severity

exceeds 3,000 rpm 8

exceeds 4,000 rpm 4

exceeds 5,000 rpm 1

falls below 5,000 rpm * 4

falls below 4,000 rpm * 8

falls below 2,000 rpm 8

10--4 ■ RSView Supervisory Edition User’s Guide


If the motor speed It triggers an alarm of this severity

falls below 1,000 rpm 6

falls below 1 rpm 4

* These alarms are triggered only if the check box ‘Generate alarms when
approaching normal operating range’ is selected in the Alarm Setup dialog box.

You can specify whether or not to generate alarms when an analog


tag value is moving back to normal operating range and recrosses
the alarm trigger threshold. If you choose to generate alarms when
the motor is moving back towards normal operating range, an alarm
would be triggered when the motor speed falls below 5,000 rpm
and 4,000 rpm, and when it rises above 1 rpm and 1,000 rpm. If you
don’t want to generate these alarms, make sure the check box
‘Generate alarms when approaching normal operating range’ is
deselected in the Setup tab of the Alarm Setup editor.

Variable thresholds

Threshold values can be constant or variable. The above example


uses constant thresholds. A variable threshold can change, because
its value is taken from another tag value, not a constant number.
You define a variable threshold by naming a tag in the appropriate
field in the editor. That tag’s value is the threshold for the alarm; as
the tag changes, the threshold changes.

Variable thresholds require more system resources than constant


thresholds. This is due to the continuous scanning of threshold
values and to the processing necessary to detect alarm faults.

Alarm faults

A variable threshold must not become higher than the threshold


above it or lower than the threshold below it. If this happens, an
alarm fault is generated for the monitored tag. To correct an alarm
fault, you must change the variable threshold so it does not overlap

Setting up alarms ■ 10--5


Preface
either of its neighbors. This can become complex when the
neighboring thresholds are themselves variable, because these
boundaries are determined dynamically at run time.

When an alarm fault is generated, the following actions occur:

the tag’s alarm status stays where it was before the alarm fault
was generated

an alarm fault is reported to all alarm reporting devices you have


set up, such as the alarm log file and the printer

the alarm fault status bit for the tag is set in the value table. This
notifies other applications that an alarm fault has been generated

the Alarm Type column in the alarm summary states that the tag
is in ‘Alarm Fault’

When the faulty thresholds return to their normal operating range,


the alarm fault condition is cleared. The out-of-alarm-fault status is
generated and logged, and alarms for the tag resume normal
operation.

Deadband

With certain kinds of measured values, such as line pressure, tag


values can fluctuate rapidly above and below a critical threshold.
Where such conditions exist, you can create a deadband as a buffer
to prevent the fluctuations from triggering and retriggering
unnecessary alarms. 4.

If the threshold is increasing—monitoring rising values—the


deadband range lies below the threshold. If the threshold is
decreasing—monitoring falling values—the deadband lies above the
threshold.

The following illustration shows an increasing threshold of


4,000 rpm with a deadband value of 500 rpm. In this example, the

10--6 ■ RSView Supervisory Edition User’s Guide


rpm would have to fall to 3,500, and then rise above 4,000 rpm
before it would retrigger the alarm.

rpm
In alarm
In alarm again
5,000

Threshold 4,000
Deadband
3,500
3,000
Out of
2,000 alarm

1,000

0 n
time

IMPORTANT Use the deadband carefully in safety-critical


applications. In the above example, the variable would
have to fluctuate by more than 500 rpm before
retriggering an alarm.

A deadband range may be absolute, as illustrated, or it may be a


percentage of the minimum/maximum range for a tag. If the
deadband in the illustration were two percent, its range would be
two percent of 5,000 rpm, or 100 rpm.

If a buffer is not required, the deadband must be set up as zero.


With a deadband of zero, alarms will be triggered as soon as the tag
value crosses any of its thresholds.

Setting up alarms ■ 10--7


Preface
Alarms for digital HMI tags

Digital tags are either on or off. Therefore, alarms for digital tags do
not have thresholds. They have alarm states. 5.

This alarm state Does this

On Triggers an alarm when a tag has a value of 1.

Off Triggers an alarm when a tag has a value of 0.

Any Change * Triggers an alarm when a tag value changes from


0 to 1 or from 1 to 0.

Changes to On * Triggers an alarm only when a tag value changes


from 0 to 1.

Changes to Off * Triggers an alarm only when a tag value changes


from 1 to 0.

IMPORTANT The * indicates change-of-state types. These types are


considered out of alarm immediately after the change of
state.

Alarm severity

Alarms can range in severity from one to eight to indicate different


levels of importance. One is most severe, eight is least severe. For
example, a level-four alarm might warn that a vat is half full of
liquid, while a level-one alarm indicates that the vat is about to
overflow. Both alarms monitor the same tag but have different
severity levels.

When you set up alarm severity, you specify what severity levels
mean and what actions they will trigger. Severity determines the
destination of alarm messages. It also determines the color of the
text in the alarm summary and the order in which alarms are
displayed in an alarm banner.

10--8 ■ RSView Supervisory Edition User’s Guide


Alarm messages

Alarm messages report information about alarms. There are three


types of messages:

In Alarm message: generated when a tag goes into alarm

Out of Alarm message: generated when a tag goes out of alarm

Acknowledged message: generated when an operator


acknowledges an alarm

For each message, you can use the default message or create your
own message, and you can selectively route alarm messages to a log
file and/or printer.

Alarm log file

The alarm log file records alarm incidents that occur. You can set up
how often, if ever, you want log files created and deleted.

Optionally, using the AlarmLogSendToODBC command, you can


export the alarm log file to an ODBC database while online. For
more information, see page A-24.

In RSView, you can view the alarm log file using the Alarm Log
Viewer.

If you export alarm log data to an external, ODBC-compliant


database, you can use third-party applications to view the records
in the database. The application must be ODBC compliant, for
example, you can use Microsoft Excel, Microsoft Access,t or
Microsoft Visual Basic.

Setting up alarms ■ 10--9


Preface
Alarm displays

Alarm information can be displayed in:

the alarm log viewer

an alarm summary

graphic objects and displays

When alarms are generated, they are recorded in two places: the
alarm log file, and the computer’s memory. The alarm log viewer
displays the records in the alarm log file. The alarm summary
displays the records in the computer’s memory.

Alarm log viewer

The alarm log viewer displays the contents of the alarm log file. The
contents of this file depend on how you set up severities in the
Alarm Setup editor. By default, the log file will have a record for
each of the following alarm incidents:

when a tag goes into alarm

when a tag goes out of alarm

when an alarm is acknowledged

when a tag with an alarm is suppressed

when an alarm fault is generated

Set up your application so only essential alarm information is


logged. Alarm logging uses system resources and can slow overall
system performance.

Alarm summary

The alarm summary displays the alarm information recorded in the


computer’s memory. The summary is configurable, so you can
determine what, and how, alarm information is displayed.

10--10 ■ RSView Supervisory Edition User’s Guide


The alarm summary can display alarms from more than one HMI
server. Each HMI server maintains a list of up to 2,000 alarms. As
new alarms occur, they appear at the top of the list. When the list of
alarms at the HMI server becomes full, one alarm is dropped from
the bottom of the list for each new alarm that appears at the top.
Alarms are also dropped when they are out of alarm and
acknowledged. When alarms are dropped, they are removed from
memory. When the AlarmOff command is issued, the contents of
the alarm summary are erased.

AlarmOff is just one of the RSView commands used with alarms.


For details about this command and others, see Appendix A,
RSView commands, or see Help.

In the alarm summary, you can set up each alarm incident to be a


different color. For example, you might choose to set up
low-severity alarms as blue, medium-severity as yellow, and
high-severity as red. When the alarm is displayed, operators can tell
its severity at a glance.

Create an alarm summary in the Graphic Displays editor.

Graphic objects and displays

You can customize graphic displays to show specific information


about alarms. RSView makes all alarm status information available
to graphic displays through a set of system tags (see the next page).
Use these tags with numeric and string display objects. Attach
visibility and color animation to affect the appearance of the
objects.

The Alarm Information graphic library contains graphic objects


you can drag and drop into your display. For example, to include an
alarm banner in a display, drag and drop the banner from the Alarm
Information graphic library. Use the graphic objects as they are, or
edit them to suit your needs.

Setting up alarms ■ 10--11


Preface
Alarm system tags

System tags are created and updated by RSView. You can use these
tags anywhere a tag name is required.

The system tags for alarms are:

This tag Type Displays this information

system\AlarmBanner String The most recent, most severe alarm. If an alarm of an


equal or higher severity occurs, it replaces the first
alarm, whether or not the previous alarm has been
acknowledged.

system\AlarmMostRecentDate String The date of the most recent, most severe alarm.

system\AlarmMostRecentLabel String The threshold label of the tag of the most recent,
most severe alarm.

system\AlarmMostRecentSeverity Analog The severity of the most recent, most severe alarm
(1 to 8).

system\AlarmMostRecentTagDesc String The description of the tag of the most recent, most
severe alarm.

system\AlarmMostRecentTagname String The name of the tag of the most recent, most
severe alarm.

system\AlarmMostRecentTime String The time of the most recent, most severe alarm.

system\AlarmMostRecentUnits String The units of the most recent, most severe alarm.

system\AlarmStatus String The number of unacknowledged and suppressed


alarms.

system\AlarmSummaryItems Analog The number of alarm transactions in an unfiltered


alarm summary.

system\AlarmSummaryItemsUnacked Analog The number of unacknowledged alarms in an


unfiltered alarm summary.

system\AlarmSuppressedCount Analog The number of tags with alarm suppression


turned on.

10--12 ■ RSView Supervisory Edition User’s Guide


Alarm acknowledgment

If an alarm appears in the alarm summary or some other alarm


display, an operator can acknowledge the alarm. Acknowledging an
alarm does not correct the condition causing the alarm, but
indicates that an operator is aware of the alarm.

A tag, not an alarm, is acknowledged. A single tag might have


caused several alarms. For example, a tag representing temperature
might have triggered Warm, Hot, and Overheat alarms by the time
it is acknowledged. The tag could also have gone in and out of
alarm several times before being acknowledged.

One acknowledgment is all that is required for all previous and


current alarms for a tag, so alarm log files often show fewer
acknowledgments than alarms.

To acknowledge alarms, operators can:

click the Acknowledge or Acknowledge All button in the alarm


summary

use the RSView Acknowledge command by itself, or with


parameters to name a tag or group of tags

use the RSView AcknowledgeAll command

Unless an alarm is acknowledged, it remains outstanding until the


system is shut down, the alarm summary is full, or alarm
monitoring is turned off.

Alarm suppression

You can suppress alarm monitoring for tags. This is useful for
testing or for performing repairs or maintenance on a piece of
equipment.

To suppress alarm monitoring for tags, use the RSView SuppressOn


command. To view a list of the tags not being monitored, use the
Suppressed List. You can also turn monitoring back on from this
list.

Setting up alarms ■ 10--13


Preface
Alarm functions in expressions

When a tag goes into alarm, or an alarm event occurs, certain


information about the alarm is recorded in the value table together
with the value of the tag or alarm event. Using expressions,
information about alarms can be retrieved on a tag-by-tag basis. For
information about alarm events, see page 10-18.

IMPORTANT If your graphic display requires more than 20 alarm


functions, for performance reasons, you should use
these alarm functions in derived tags instead.

For example, if the system detects that a tag is in alarm, it sets an


internal alarm bit, and then resets the bit when the tag is out of
alarm. The following expression checks if a tag is in alarm:

ALM_IN_ALARM (tag)

where tag is the name of the tag you want to check for alarms.
When a tag is in alarm, the expression result is 1. When a tag is out
of alarm, the expression result is 0.

One way to use this expression is to animate the visibility of a


graphic object in a display. When the tag goes into alarm, the
ALM_IN_ALARM expression is set to 1, making the object visible. This
is an effective way to draw the operator’s attention to the alarm.

The following expression checks if an alarm has ever been


acknowledged:

ALM_ACK (tag)

The expression ALM_ACK returns 1 if an alarm has been


acknowledged. If a tag goes out of alarm without being
acknowledged, the expression returns 0.

When alarm monitoring starts and a tag has never been in alarm, the
ALM_ACK expression returns 1 by default. To reverse this default
behavior, create the registry key Alarm Initially Acked on the
computer running the HMI server. Once you have created the key,

10--14 ■ RSView Supervisory Edition User’s Guide


change its string value to False. The key is located at
HKEY_LOCAL_MACHINE\Software\Rockwell Software\
RSView Enterprise\2.0\Alarm Server

To create or change the key, use the Windows Regedit utility. For
details about using Regedit, click Help in the Registry Editor
window.

ALM_ALLACKED (tag*)

The expression ALM_ALLACKED (tag*) returns 1 if all tags that match


the pattern have been acknowledged. If any of the tags have not
been acknowledged, the expression returns 0.

Other functions are also used with expressions to monitor alarms.


For more information, see Chapter 18, Creating expressions.

Using wildcards in alarm expressions

For built-in alarm functions, you can use wildcards in the


expression to retrieve information about multiple tags at once.

This wildcard Does this

* Matches any number of characters, including the


backslash ( \ ) character.

? Matches any single character.

For example, the following expression checks if any of a group of


tags is in alarm:

ALM_IN_ALARM (alarm*)

where alarm* represents all tags whose names begin with “alarm.”
If one or more of these tags are in alarm, the expression result is 1.
If all of the tags are out of alarm, the expression result is 0.

Using wildcards in alarm expressions may affect performance if the


pattern matches a large number of tags. For a list of the alarm
functions, see “Tag functions” on page 18-14.

Setting up alarms ■ 10--15


Preface
Acknowledge bit

An acknowledge bit is a digital tag that can be used for two


things: 6.

to acknowledge an alarm, or

to monitor the acknowledged state of an alarm

When you set up an acknowledge bit for a tag, the HMI server
monitors the value of the acknowledge bit, and automatically
acknowledges the alarm when the value of the acknowledge bit
changes from 0 to 1. This is called a remote acknowledge, and a
RmAck (Remote Acknowledge) transaction is logged to the alarm
log file.

When an operator acknowledges an alarm, the acknowledge bit is


set to 1. If the Auto Reset feature is enabled, the HMI server resets
the acknowledge bit to 0 when the tag goes back into alarm.

IMPORTANT Because an HMI server monitors the value of each


acknowledge bit tag, using many acknowledge bits can
incur substantial system overhead.

IMPORTANT The acknowledge bit must be set up as a digital tag in


the tag database.

To set up an acknowledge bit:

1. In the Tags editor, click an analog or digital tag for which you
have set up an alarm.

2. Open the Alarm editor by clicking the Alarm button.

3. Click the Advanced tab.

4. In the Acknowledge Bit box, type the name of a tag or click the
Browse button to browse for the tag you want to use as the
Browse button acknowledge bit.

10--16 ■ RSView Supervisory Edition User’s Guide


Handshake bit

A handshake bit is a digital tag that can be used to monitor the


status of an alarm.

When you set up a handshake bit for a tag, the HMI server sets the
handshake bit to 1 when the tag goes into alarm. If the Auto Reset
feature is enabled, the HMI server sets the handshake bit to 0 when
the tag goes out of alarm.

IMPORTANT The handshake bit must be set up as a digital tag in the


tag database.

To set up a handshake bit:

1. In the Tags editor, click an analog or digital tag for which you
have set up an alarm.

2. Open the Alarm editor by clicking the Alarm button.

3. Click the Advanced tab.

4. In the Handshake Bit box, type the name of a tag or click the
Browse button to browse for the tag you want to use as the
Browse button handshake bit.

Switching handshaking on

By default, handshaking is off. To switch handshaking on, do one of


the following:

use the /H parameter with the AlarmOn command

use the HandshakeOn command

For detailed information about commands, see Appendix A,


RSView commands, or see Help.

Setting up alarms ■ 10--17


Preface
Alarm events

You can customize and extend the RSView alarm monitoring


system by writing your own alarm-detection algorithms using PLC
ladder logic, custom programs, or any other appropriate tools. You
can then add alarm events to the the RSView alarm subsystem, to
respond to your alarm-detection algorithms for annunciation,
logging, printing, and for display in alarm summaries.

By using a tag name for an alarm event, you can customize the
alarm features of the tag. For example, you can use alarm events to
specify an alarm’s time stamp. Because alarms are scanned in the
background, alarms that are generated rapidly might appear out of
sequence in RSView, because they might all be scanned at the same
time, and therefore given the same time stamp. If the sequence in
which alarms are generated is important, you might want to record
accurate time stamps for the alarms by buffering the alarms in the
PLC, and then using alarm events to record them with accurate time
stamps in RSView.

You can also use alarm events to provide a tag with more than eight
thresholds.

To create an alarm event, use the AlarmEvent command.

How event-based alarms work

Alarm events let you create alarms, even without setting up tags in
the tag database. Event-based alarms work just like tag-based
alarms. They appear in alarm summaries, they can be used with
alarm system tags, and they can be logged to disk or printer.

You can filter event-based alarms the same way you filter tag-based
alarms in alarm summaries. You can acknowledge event-based
alarms, either individually, or with wildcards, using the
Acknowledge command. You cannot suppress event-based alarms.

As with tag-based alarms, you can use alarm events with alarm
functions in expressions.

10--18 ■ RSView Supervisory Edition User’s Guide


You can time-stamp event-based alarms with the current time, or
by specifying a date and time, either in RSView or in your own
alarm-detection algorithms.

Alarm events are not processed until the AlarmOn command is


issued, and alarm events are no longer processed after the AlarmOff
command is issued.

Differences between event-based alarms and


tag-based alarms

You cannot specify thresholds for analog alarm events. All


analog alarm events have a value of zero.

You cannot specify alarm labels for event-based alarms. That is,
you cannot use the IntoAlarm and OutOfAlarm labels for
digital tag-based alarms, or the threshold labels for analog
tag-based alarms.

Alarm events have no acknowledge and handshake bits.

The Identify feature is not available to event-based alarms, to


run a command, macro, or custom program.

Event-based alarms are not retentive across application starts or


stops.

Naming alarm events

A name must be associated with each alarm event. The event name
can, but need not be, a tag defined in the tag database. An alarm
event name cannot be an alarm tag in the database.

Alarm event names can be up to 40 characters long. The alarm


event name can contain the following characters:

A to Z

0 to 9

underscore ( _ ) and dash ( – )

Setting up alarms ■ 10--19


Preface
The alarm event name can be mixed case. Alarm event names
preserve upper and lower case for readability but are not case
sensitive. For example, the alarm event name HopperOverflow is
the same as hopperoverflow.

When an alarm event name starts with a number or contains a dash,


enclose the name in braces { } when you use it in an expression, for
example, {N33–0}. Also use braces when using wildcards to
represent multiple alarm events in an expression, for example,
{alarm*}.

Using event types

Use the AlarmEvent command to create into-alarm and


out-of-alarm events. Multiple into-alarm events can be processed
for the same event name before an out-of-alarm event is received.
Use the InAndOutOfAlarm event type for change-of-state alarms.
An out-of-alarm event is ignored if no into-alarm events
preceded it.

How event-based alarms are logged

Event-based alarms appear in the alarm log file in the order in


which the alarm transactions were logged. If you specify a time
stamp for alarm events, alarm transactions could appear out of
order in the alarm log.

For detailed information about the AlarmEvent command, see


Appendix A, RSView commands, or see Help.

10--20 ■ RSView Supervisory Edition User’s Guide


Summary of steps

The main steps involved in setting up alarms are described below.


You do not have to complete the steps in this order.

1. Set up the general features of all alarms in the Alarm Setup


editor.

To do this:

a. set up alarm severities. For each severity, you can specify the
destination of alarm messages. You can also specify how to
annunciate the alarm.

b. set up user messages. When alarms occur, messages are sent


to the alarm log file and/or the printer. If you want to create
a message that will become the default message instead of
using the system default message, you can do that here.

2. Set up the alarm log file.

The alarm log file is a record of alarm incidents. You can specify
where you want the alarm log file stored, and when—if
ever—you want log files created and deleted. You can also
specify whether to generate alarms when an analog tag value is
moving back to normal operating range and recrosses the alarm
trigger threshold. If you don’t want to generate these alarms,
ensure that the check box for the option is deselected in the
Setup tab of the Alarm Setup editor.

3. For each HMI tag you want to monitor, specify the alarm
conditions in the Tags editor. You can define alarms for analog
and digital tags, but not for string tags.

4. Set up ways to display alarm information. You can set up alarm


summaries or create graphic objects.

5. Choose methods for starting and stopping alarm monitoring.

Setting up alarms ■ 10--21


Preface
The Alarm Setup editor

To open the Alarm Setup editor:

1. In the Application Explorer, open the Alarms folder.

2. Open the Alarm Setup editor by doing one of the following:

double-click Alarm Setup

right-click Alarm Setup and then click Open

Set up alarm severities.

Create alarm messages


to replace the system
default messages.

Setting up alarm trigger thresholds


If you want RSView to generate alarms when an analog tag value is
moving back to normal operating range and recrosses the alarm
trigger threshold, select the check box Generate alarms when
approaching normal operating range. For an example, see
page 10-4.

This option applies to all analog alarm tags in the HMI project.

10--22 ■ RSView Supervisory Edition User’s Guide


Setting up alarm severity
For each alarm severity and alarm incident, you can set up logging
destinations. You can also specify how you want alarms of a
particular severity to be annunciated. 3.

To set up alarm severity:

1. In the Alarm Setup editor, click the Severities tab.

Alarm severities

Alarm incidents

2. Click an alarm severity or an incident.

Setting up alarms ■ 10--23


Preface
3. Select a check box for the destination at which you want to log
the alarms. You can log to the alarm log file, to a printer, or to
both. Alarm severities and incidents are logged as follows:

Alarm What is logged

Severity 1 through 8 In Alarm messages are logged

Out of Alarm Out of Alarm messages are logged for any


severity that has been set up to log In Alarm
messages

Acknowledged Acknowledged messages are logged for any


severity that has been set up to log In Alarm
messages

Fault All Fault messages are logged

Suppression All Suppression messages are logged

If you want alarms logged to a printer, click the Printers button


to display a list of available printers. To select a printer, it must
already be set up on your computer. For information about
setting up a printer, see your Windows documentation.

IMPORTANT You can use only continuous-feed printers, such as


dot-matrix printers. Page printers, such as laser
printers, are not supported.

4. For each alarm severity, specify how you want the alarm to be
annunciated.

Internal Bell

The internal bell is a sound produced by the computer running


the RSView SE Server. To use the internal bell, select the
Internal Bell check box.

The sound for the internal bell can come from your computer’s
speaker or from a sound card.

10--24 ■ RSView Supervisory Edition User’s Guide


To set up the sound, open the Windows Control Panel and then
double-click Sounds and Multimedia to open the Sounds and
Multimedia Properties dialog box. In the Events list, click
Exclamation, and then assign a sound file (.wav) to the
Exclamation event.

When an alarm occurs, the assigned sound is repeated once per


second. When the alarm is acknowledged or silenced, the sound
is stopped. Because the sound is played repeatedly, assign only
short sounds to the Exclamation event.

You can choose from the sounds that come with Windows, or
you can install additional sound files. For information about
installing drivers and assigning sounds, see your Windows
documentation.

External Bell

The external bell is a sound produced by a horn or some other


audio device. To set up the external bell, select the check box
and then specify the name of an HMI tag that is linked to an
audio device. This HMI tag must be located on the same HMI
server as the Alarm Setup editor.

The specified tag should refer to a bit in the programmable


controller. When an alarm occurs, the bit is set, and the logic in
the programmable controller turns on the audio device. When
the alarm is acknowledged or silenced, the bit in the
programmable controller is reset, and then the logic in the
programmable controller turns off the audio device.

5. Click OK.

Setting up alarms ■ 10--25


Preface
Setting up alarm messages
Alarm messages report information about alarms. There are several
types of messages. You can define the content of each message, or
you can use the system defaults.1

Alarm messages appear in the description field of the alarm log file
only. You cannot display them in alarm summaries.

Types of messages

The types of messages are:

In Alarm message: generated when an analog tag’s alarm


threshold has been crossed, or when a digital tag has changed
state

Out of Alarm message: generated when a tag is no longer in


alarm

Acknowledged message: generated when an alarm has been


acknowledged

Defining the content of the message

When defining the content of a message, use any combination of


system default messages, user default messages, and custom
messages.

System default messages

The system default messages are a series of placeholders. At run


time, these placeholders are replaced with information about the
alarm that has been triggered.

To use the default messages for all alarms and alarm events, do not
change anything. The default messages are used automatically.

10--26 ■ RSView Supervisory Edition User’s Guide


Alarm events use system messages if you don’t specify a log
message string using the /L parameter with the AlarmEvent
command.

These are the placeholders:23

This placeholder Is replaced with the

\C Current value of the tag in alarm.

\D Date when the message is sent.

\L Alarm label specified in the Alarm Label field of the


Analog Alarm and Digital Alarm editors.

\N Tag name of the tag in alarm.

\S Tag description of the tag in alarm.

\T Time when the message is sent.

\U Units specified in the Units field, in the Tags editor.

\V Threshold value that was crossed.

IMPORTANT \C, \L, \U, and \V do not contain any information when
used in alarm Acknowledged messages.

To specify the width of a column, type a number between the


backslash and the letter (see the following example). This allows
you to create columns of equal width.

Setting up alarms ■ 10--27


Preface

Example: Message placeholders

An out-of-alarm message like this:

\11D \8T Tag \10N is out of alarm.

is displayed like this:

01/22/01 11:45:02 Tag PUMP3 is out of alarm.


01/22/01 11:47:23 Tag PUMP4 is out of alarm.
01/22/01 11:48:14 Tag PUMP5 is out of alarm.

Do not give placeholders too much space, or your messages might


not fit in the alarm log file. In the example above, the tag name has
10 spaces (\10N).

User default messages

The user default messages are messages you create to replace the
system default messages.

To create user default messages:

1. In the Alarm Setup editor, click the User Msgs tab.

2. Type a message in some or all of the message boxes.

Your message can say whatever you want, and can use both
words and placeholders. For a list of placeholders, see
page 10-27.

10--28 ■ RSView Supervisory Edition User’s Guide


To create a user-- default
message, type a message
in the appropriate box.

To select the user message as the default message, click the User
Defaults button when you are setting up analog and digital alarms.

Custom messages

Custom messages apply on a per-tag basis.

To create a custom message, type any message you want. For more
information see:

“Setting up alarms for analog tags” on page 10-32

“Setting up alarms for digital tags” on page 10-38

Your message can say whatever you want and can use both words
and placeholders. For a list of placeholders, see page 10-27.

Setting up alarms ■ 10--29


Preface
Adding remarks to the alarm log file at run time
Using the AlarmLogRemark command, you can add information to
the alarm log file at run time.

Alarm log remarks can also be printed. You cannot display alarm
log remarks in alarm summaries.

The AlarmLogRemark command has parameters that let you add a


text comment, the alarm severity, and the tag name to the alarm log
file. Other parameters let you prompt the operator for the text part
of the remark at run time, and log the remark to a printer as well as
to the alarm log file.

Using the /P
parameter with the
AlarmLogRemark
command, you can
prompt the operator
for an alarm log
remark at run time.

At run time, only one Alarm Log Remark dialog box is displayed at
a time, and the operator must respond to the dialog box before the
next one is displayed.

Alarm logging must be on before you can use the


AlarmLogRemark command. To start alarm logging, issue the
AlarmLogOn command. For details about the AlarmLogRemark
command, see Appendix A, RSView commands, or see Help.

10--30 ■ RSView Supervisory Edition User’s Guide


Specifying alarm conditions for analog
and digital tags
For each analog and digital tag that will be monitored for alarms,
specify the alarm conditions in any of the following ways:

by setting up alarm tags in the Tags editor. For more


information about using the Tags editor to set up alarms, see the
topics in this section.

by importing tags into the tag database using the Tag Import and
Export Wizard. For more information about using the Tag
Import and Export Wizard, see page 8-24.

To open the Tags editor:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Tags editor by doing one of the following:

double-click the Tags icon

right-click the Tags icon and then click Open

drag the Tags icon to the workspace

To add an
alarm to a tag,
select this
check box.
When a tag
has an alarm,
an X appears
in this column.

Setting up alarms ■ 10--31


Preface
When to set up alarms for tags

You can set up an alarm for a tag when you create the tag or later.

To set up an alarm for an existing tag, click the tag in the Tag
Database spreadsheet, and then click the Alarm check box. Click
the Alarm button to open the Analog Alarm or Digital Alarm
dialog box.

Setting up alarms for analog tags


To set up alarms for analog tags, follow these main steps: 3.

set up the alarm threshold, and then choose the message that
will appear if the threshold is crossed

set up the messages that are sent when a tag goes out of alarm
and when an operator acknowledges an alarm

set up advanced features, such as deadband and handshake

10--32 ■ RSView Supervisory Edition User’s Guide


Setting up alarm thresholds

1. Click the Alarm Thresholds tab.

To set up an alarm
threshold, first click a
threshold in this list.

2. Click a threshold.

You do not have to set up all eight thresholds, but the ones you
do use, you must set up in ascending order. For example, you
can set up thresholds 1, 2, 5, and 8, as long as you set them up in
that order.

Setting up alarms ■ 10--33


Preface
3. Fill in the fields as follows:

Threshold

To define a constant threshold, type a number. To define a


variable threshold, specify a tag name.

IMPORTANT At run time, a variable threshold must not become


higher than the threshold above it or lower than the
threshold below it, or an alarm fault will be generated
for the tag.

Increasing/Decreasing

To monitor for a rising value that passes the threshold, click


Increasing. To monitor for a falling value that passes the
threshold, click Decreasing.

Alarm Label

Type a description for the alarm, up to 21 characters long. This


description is displayed in the alarm summary, and in the alarm
banner.

Severity

Select a severity level. Severity 1 is most severe, Severity 8 is


least severe.

Severities are set up in the Alarm Setup editor. For details, see
“Setting up alarm severity” on page 10-23.

10--34 ■ RSView Supervisory Edition User’s Guide


In Alarm Messages

Select the message you want when the tag goes into alarm.

If you click Custom Message, type the message in the File


and/or Printer boxes. You can use both words and placeholders.

For detailed information about messages, see “Setting up alarm


messages” on page 10-26.

4. To set up additional thresholds, click another threshold and then


fill in each field.

When you click another threshold, the information you set up


for the previous threshold is saved.

Setting up alarm messages

1. Click the Alarm Messages tab.

Setting up alarms ■ 10--35


Preface
2. Select the file and printer messages for when a tag goes out of
alarm, and for when an operator acknowledges an alarm.

If you click Custom Message, type the message in the File


and/or Printer boxes. You can use both words and placeholders.

For detailed information about messages, see “Setting up alarm


messages” on page 10-26.

Setting up advanced features

1. Click the Advanced tab.

10--36 ■ RSView Supervisory Edition User’s Guide


2. Fill in the fields as follows:

Alarm Identification

Type a command, macro file name, or click the Browse button


to open the Command Wizard.
Browse button
This command or macro runs when you highlight the alarm in
the alarm summary and then click Alarm Identify on the menu.
The command or macro also runs when you use the Identify
command, whether or not the tag is in alarm.

Out of Alarm Label

Type a message, up to 21 characters long, that will be displayed


in the alarm summary when the tag is no longer in alarm. This
message can also appear in the alarm banner, if the banner is set
up to display it.

Deadband

Click Absolute or Percentage, and then type a value.

The deadband is a buffer zone on the edge of an alarm


threshold. For more information, see “Deadband” on
page 10-6.

Alarm Acknowledge

In the Acknowledge Bit box, type the name of a tag or click the
Browse button to browse for the tag you want to use as the
acknowledge bit.

When an operator acknowledges the alarm, the acknowledge bit


is set to 1 and the HMI server logs an alarm acknowledgment.

When the HMI server detects the acknowledge bit changing


from 0 to 1, the HMI server acknowedges all alarms for tags

Setting up alarms ■ 10--37


Preface
associated with this acknowledge bit, and logs a remote
acknowledgement message to the alarm log file. The bit is set
only once per acknowledgement.

To have the acknowledge bit reset (set back to 0) automatically


when the tag goes back into alarm, select the Auto Reset check
box. Otherwise the acknowledge bit must be reset manually.

For more information, see “Acknowledge bit” on page 10-16.

Alarm Handshake

In the Handshake Bit box, type the name of a tag or click the
Browse button to browse for the tag you want to use as the
Browse button handshake bit.

When a tag goes into alarm, the handshake bit is set to 1.

To have the handshake bit reset (set back to 0) automatically


when the tag goes out of alarm, select the Auto Reset check box.
Otherwise the handshake bit must be reset manually.

For more information, see “Handshake bit” on page 10-17.

By default, alarm handshaking is off. To start alarm


handshaking, issue the AlarmOn /H, or HandshakeOn
command.

Setting up alarms for digital tags


To set up alarms for digital tags, follow these main steps:

set up alarm states

set up the messages that are sent when a tag goes out of alarm
and when an operator acknowledges an alarm

set up advanced features, such as handshake

10--38 ■ RSView Supervisory Edition User’s Guide


Setting up alarm states

1. Click the Alarm States tab.

2. Fill in the fields as follows:

Alarm Type

Select a type.

For a description of types, see “Alarms for digital HMI tags” on


page 10-8.

Alarm Label

Type a description of the alarm up to 21 characters long. This


description is displayed in the alarm summary and alarm banner.

Setting up alarms ■ 10--39


Preface
Severity

Select a severity level. Severity 1 is most severe, Severity 8 is


least severe.

Severities are set up in the Alarm Setup editor. For details, see
“Setting up alarm severity” on page 10-23.

In Alarm Messages

Select the message you want when a tag changes state and goes
into alarm.

If you click Custom Message, type the message in the File


and/or Printer boxes. You can use both words and placeholders.

For detailed information about messages, see “Setting up alarm


messages” on page 10-26.

10--40 ■ RSView Supervisory Edition User’s Guide


Setting up alarm messages

1. Click the Alarm Messages tab.

2. Select the the file and printer messages for when a tag goes out
of alarm, and for when an operator acknowledges an alarm.

If you click Custom Message, type the message into the File
and/or Printer boxes. You can use both words and placeholders.

For detailed information about messages, see “Setting up alarm


messages” on page 10-26.

Setting up alarms ■ 10--41


Preface
Setting up advanced features

1. Click the Advanced tab.

2. Fill in the fields as follows:

Alarm Identification

Type a command, macro file name, or click the Browse button


to open the Command Wizard.
Browse button

This command or macro runs when you highlight the alarm in


the alarm summary and then click Alarm Identify on the menu.
The command or macro also runs when you use the Identify
command, whether or not the tag is in alarm.

10--42 ■ RSView Supervisory Edition User’s Guide


Out of Alarm Label

Type a message, up to 21 characters long, that will be displayed


in the alarm summary when the tag is no longer in alarm. This
message can also appear in the alarm banner, if the banner is set
up to display it.

Alarm Acknowledge

In the Acknowledge Bit box, type the name of a tag, or click the
Browse button to browse for the tag you want to use as the
acknowledge bit.

When an operator acknowledges the alarm, the acknowledge bit


is set to 1 and the HMI server logs an alarm acknowledgment.

When the HMI server detects the acknowledge bit changing


from 0 to 1, the HMI server acknowedges all alarms for tags
associated with this acknowledge bit, and logs a remote
acknowledgement message to the alarm log file. The bit is set
only once per acknowledgement.

To have the acknowledge bit reset (set back to 0) automatically


when the tag goes back into alarm, select the Auto Reset check
box. Otherwise the acknowledge bit must be reset manually.

For more information, see “Acknowledge bit” on page 10-16.

Alarm Handshake

In the Handshake Bit box, type the name of a tag, or click the
Browse button to browse for the tag you want to use as the
Browse button handshake bit.

When a tag goes into alarm, the handshake bit is set to 1.

To have the handshake bit reset (set back to 0) automatically


when the tag goes out of alarm, select the Auto Reset check box.
Otherwise the handshake bit must be reset manually.

Setting up alarms ■ 10--43


Preface
The handshake bit cannot be reset automatically for tags with a
change-of-state alarm type (Any Change, Changes to On, or
Changes to Off).

For more information, see “Handshake bit” on page 10-17.

By default, alarm handshaking is off. To start alarm


handshaking, issue the AlarmOn /H, or HandshakeOn
command.

Setting up alarm logging

Use the Alarm Log Setup program in the RSView Tools folder to
specify:

where to store alarm log files

when alarm log files are created or deleted

whether to log alarm data to a central, ODBC-compliant database.


This step is optional.

IMPORTANT You must run the Alarm Log Setup program on the
same computer as the HMI server that is monitoring tags
for alarms. If you run the Alarm Log Setup program on
a computer that does not contain an HMI server set up to
monitor tags for alarms, the settings will have no effect.

The alarm log files generated on one computer do not


contain data for RSView SE Servers running on other
computers. You must set up alarm log files separately for
each computer on which RSView SE Servers are
running.

If there is more than one HMI server on a single


computer, the alarm log file will contain entries from
both HMI servers.

10--44 ■ RSView Supervisory Edition User’s Guide


To open the Alarm Log Setup editor:

" Do one of the following:

click the Start button, point to Programs, Rockwell


Software, RSView Enterprise, Tools, and then click
SE Alarm Log Setup

for convenience, you can also access the Alarm Log Setup
tool from the Tools menu in RSView Studio, or the RSView
Administration Console. On the Tools menu, click Alarm
Log Setup.

For information about


how to use the Alarm Log
Setup tool, click Help.

Setting up alarms ■ 10--45


Preface
Specifying where to store alarm log files

To specify where to store log files:

1. In the Alarm Log Setup editor, click the Logging tab.

By default, alarm log files are stored in the path


\Documents and Settings\All Users\Documents\RSView Enterprise\SE\AlarmLog

2. If you want to change where the log files are stored, specify a
new path.

When log files are created, they are stored in the folder you
specify here.

3. Click OK.

4. If the log path is not located on the same computer as the HMI
server, you must change the security account under which the
alarm log program files run. For details, see “Specifying the
security settings of the alarm log program files” on page 10-56.

10--46 ■ RSView Supervisory Edition User’s Guide


Creating log files
You can set up your application to create new log files periodically,
or you can prevent new files from being created.

In each 24-hour period, up to 26 new files can be created. If you


attempt to create a 27th file, RSView continues logging data to the
26th file. At midnight, the sequence starts again with the first new
file for the new day.

Log files are saved in the directory you specify on the Logging tab.

For more information about log files, also see:

“About alarm log files” on page 10-57

“Viewing alarm log files” on page 10-58

the schema for the ODBC alarm log table on page 20-2

Monitoring disk space

If your computer’s hard disk is full, alarm logging stops and no


more log files are created. For information about monitoring disk
space on computers running HMI servers, see page 22-19.

Setting up alarms ■ 10--47


Preface
Managing log files
On the File Management tab, specify when new files are created,
and when log files are deleted.

To specify when to start new files:

1. In the Alarm Setup editor, click the File Management tab.

2. Under Start New Files, click an option to specify when you


want to have new files created. For details, see the topics on the
pages that follow.

10--48 ■ RSView Supervisory Edition User’s Guide


Creating files periodically

Click Periodic, and then click a time period. A new file is created
after the specified interval has elapsed.

For this period The new file is created

Hourly Approximately on the hour

Daily Each day, approximately at midnight

Weekly Each Sunday, approximately at midnight

Monthly On the first day of each month, approximately at


midnight

Creating files on demand

To create a new log file immediately, use the AlarmLogNewFile


command.

Setting up alarms ■ 10--49


Preface
To create a new file immediately:

1. In a graphic display, create a button the operator can press at run


time to create a new file. For details about creating buttons, see
page 15-66.

2. In the button’s Press Action box, type AlarmLogNewFile.

When the operator presses the button at run time, a new alarm
log file is created at the HMI server, and all subsequent messages
are logged to the new file.

Never creating new files

Click Never. Logged data is added to a single file.

To manage disk space if a log file grows too large, stop alarm
monitoring, delete the alarm log file, and then restart alarm
monitoring.

You cannot delete an alarm log file while RSView is monitoring


alarms.

For details about how to monitor disk space on computers running


HMI servers, see page 22-19.

Deleting log files

You can delete log files after a specified period or once a specified
number of files have been created. If you never want files deleted,
leave the check boxes under Delete Oldest Files blank.

Alarm log files are deleted only when a new file is created. So, if
your application creates a new file each day and deletes the oldest

10--50 ■ RSView Supervisory Edition User’s Guide


file every third day, your project will have files for the three
previous days’ data, as well as a file for the current day.

To specify when to delete files:

1. In the Alarm Setup editor, click the File Management tab.

2. Under Delete Oldest Files, select one or both check boxes and
then type a number to specify when to delete the log files. If you
select both check boxes, files are deleted after the maximum
time or after the maximum number of files is reached, whichever
happens first. If you do not want files deleted, leave the check
boxes under Delete Oldest Files blank.

Setting up alarms ■ 10--51


Preface

After Maximum Time

Files are deleted after the maximum time has expired. For
example, if two days is the specified time, files are deleted at
midnight of the third day, so you always have data for the
current day and the two previous days.

After Maximum Files

The oldest log file is deleted after the specified maximum has
been reached. The files currently being logged to are not
included in this number. For example, if you type 10, you will
have a maximum of 11 alarm log files at any time—10 old ones
and the current one. When a new set is started, the oldest file is
deleted.

If you have set up File Management to delete the oldest files when a
new one is started, and you are exporting data to an ODBC database,
make sure you export the data before the oldest file is deleted.

Logging to a central database

In addition to logging to file sets, you can optionally set up RSView


to log data to a central, ODBC-compliant database.

Central logging works by periodically exporting the contents of the


alarm log file to an ODBC-compliant database. RSView supports the

10--52 ■ RSView Supervisory Edition User’s Guide


following ODBC-compliant databases: Microsoft Access, Sybase
SQL Server, Oracle, and Microsoft SQL Server.

If you have set up file management to delete the oldest files when a
new set is started, and you are exporting data to an ODBC database,
make sure you export the data before the oldest files are deleted.

For information about the contents of the alarm log ODBC tables,
see page 20-2.

To log data to a central database:

1. In the Alarm Log Setup editor, click the Central Logging tab.

2. Select the check box, Enable periodic central logging.

3. To specify a logging interval, type a number and then select a


time unit.

The file sets are exported to the ODBC-compliant database at this


interval.

Setting up alarms ■ 10--53


Preface
4. Specify the name of the ODBC data source. To browse for the
data source name, click the Browse button.

5. Specify the target table in the


ODBC-compliant database.
To browse for the target table, click the Browse button.

If the target table does not exist, and if you have a connection to
the database, you can create the target table. Type the target
table name and then click Create Table.

6. If theODBC database and HMI server are not located on the same
computer, you must enter a User ID and password to connect to
the database. Click the Login Required checkbox and then type
your user ID and password.

7. Click OK.

8. If the ODBC database is not located on the same computer as the


HMI server, you must change the security account under which
the alarm log program files run. For details, see “Specifying the
security settings of the alarm log program files” on page 10-56.

9. To start exporting the contents of the alarm log file to an ODBC


database at run time, issue the AlarmLogSendToODBC or
AlarmLogNewFile commands. You can add one of these
commands to a startup macro for the HMI server.

For information about the contents of the alarm log ODBC tables,
see page 20-2.

Exporting alarm log files manually to ODBC format

Using the command, AlarmLogSendToODBC, you can export


logged activities manually from the alarm log file to an
ODBC-compliant database.

If the table in the database to which you are attempting to export


data is not ODBC compliant, the export will fail. If an ODBC-
compliant table does not exist, RSView will try to create it.

10--54 ■ RSView Supervisory Edition User’s Guide


When you export data to an ODBC table, RSView keeps track of the
data that was exported in a control file called Alarm.exp. This file is
located in the log path where the .dat files are stored. The next time
you export data, only the newest data is exported. If the control file
is deleted, all the alarm log data in the .dat files are exported when
you issue the export command.

If you have set up file management to delete the oldest files when a
new set is started, and you are exporting data to an ODBC-compliant
database, make sure you export the data before the oldest files are
deleted.

Example: Exporting alarm log files to ODBC format


on demand

To export the contents of the alarm log files to an ODBC- compliant


database on demand, create a button in a graphic display. The
button’s press action should be the AlarmLogSendToODBC
command.

When the operator presses the button, the contents of the alarm log
file are exported to the ODBC database.

The AlarmLogSendToODBC command exports only the records


added to the alarm log files since the last export.

For information about the contents of the alarm log ODBC tables,
see page 20-2.

Editing alarm log setup


You can edit the alarm log setup during development or runtime,
using the Alarm Log Setup editor.

If you change the alarm log setup at runtime, the changes do not
take effect until you stop alarm logging and then restart it.

Setting up alarms ■ 10--55


Preface
To edit the alarm log setup:

1. Open the Alarm Log Setup editor by doing one of the


following:

click the Start button, point to Programs, Rockwell


Software, RSView Enterprise, Tools, and then click
SE Alarm Log Setup

for convenience, you can also access the Alarm Log Setup
tool from the Tools menu in RSView Studio, or the RSView
Administration Console. On the Tools menu, click Alarm
Log Setup.

2. Make the required changes.

3. Save the changes.

Specifying the security settings of the alarm


log program files
If you are logging to a network drive, network share, or ODBC
database that is not located on the same computer as the HMI server,
you must change the Windows security settings of the alarm log
program files.

To change the security account of the alarm log


program files:

1. On the computer on which you want to run alarm monitoring,


click the Windows Start button, and then click Run.

2. In the Open box, type dcomcnfg, and then press Enter.

3. If DCOM Configuration Warning messages appear, click No for


each one.

4. In the Distributed COM Configuration Properties dialog box,


click the Applications tab.

10--56 ■ RSView Supervisory Edition User’s Guide


5. In the Applications list, click RsAlmLogExpService Class and
then click Properties.

6. In the RsAlmLogExpService Class Properties dialog box, click


the Identity tab.

7. Click This user, and then type the name and password of a user
that has access to the network share or database.

8. Click OK.

9. In the Applications list, click RsAlmLogService Class and then


click Properties.

10. In the RsAlmLogService Class Properties dialog box, click the


Identity tab.

11. Click This user, and then type the name and password of a user
that has access to the network share or database

12. Click OK.

About alarm log files


Alarm information is stored in file sets, in proprietary format.

How log files are named

When a log file is created, it is named automatically. The name is


based on the date the file was created and the type of data it
contains. The format for the name is YYYYMMDDnz.dat, where: 4

YYYY are the four digits of the year

MM is the month

DD is the day

Setting up alarms ■ 10--57


Preface
n is the sequence letter (‘a’, ‘b’, ‘c’, and so on). This letter
indicates the sequence in which the files were created. You can
have up to 26 files (‘a’ to ‘z’) per day. At midnight, the sequence
starts at ‘a’ again.

z is the file type: ‘ l ’ (lowercase L) is for alarm

If you are using short file names, or if the path where the log files
are stored does not support long file names, the format for the name
is YYMMDDnz.dat, where YY are the last two digits of the year.

Example: Log file name

The log file named 20011015bl.dat was created in the year 2001,
month 10, and day 15. The ‘b’ indicates that this is the second file
created that day. The ‘l’ (lowercase L) indicates that this is an alarm
log file.

Viewing alarm log files

The Alarm Log Viewer displays the contents of alarm log files.

The contents of the alarm log files depend on how you set up alarm
severities in the Alarm Setup editor. 5

For information about the contents of the alarm log ODBC tables,
see page 20-2.

You can choose to display the contents of alarm log files stored
either on the local computer, or on a remote computer, and you can
select the number of log files to be displayed in the alarm log
viewer. Each alarm log file is displayed in a separate tab in the
alarm log viewer.

10--58 ■ RSView Supervisory Edition User’s Guide


To open the alarm log viewer:

" Do one of the following:

in RSView Studio or the RSView Administration Console,


click the Tools menu, and then click Alarm Log Viewer

click the Windows Start button, point to Programs,


Rockwell Software, RSView Enterprise, Tools, and then click
SE Alarm Log Viewer

For information about setting up and using the alarm log viewer see
the alarm log viewer Help.

To open the alarm log viewer Help:

" Click the Start button, point to Programs, Rockwell Software,


RSView Enterprise, Tools, and then click SE Alarm Log Viewer
Help.

Using the alarm log viewer at run time

To display the alarm log viewer at run time:

1. In a graphic display, create a button operators can use to open


the alarm log viewer.

2. For the button’s press action, type the following command:

AppStart “C:\Program Files\Rockwell Software\


RSView Enterprise\AlarmLogViewer.exe”

You must include the quotation marks, because there are spaces
in the parameter.

At run time, the viewer may appear behind the RSView SE Client
window. This is the result of operating system rules. You can either
bring the viewer to the front manually, or you can work around this
problem programmatically. For details about a programmatic
work-around, see technical note P9029 in the Rockwell Software
Support Library.

Setting up alarms ■ 10--59


Preface
Creating an alarm summary
The alarm summary displays the active alarms recorded in an HMI
server. To set up an alarm summary, specify the servers from which
you want data displayed, what data you want displayed, and then
create the format in which you want the data to appear.

At run time, operators can use the alarm summary to view and
interact with the alarms.

Creating an alarm summary object

An alarm summary object can be part of a graphic display or it can


fill the entire graphic display. You can use the pre-built alarm
summary, called Alarm Information, in the graphics library, or you
can create your own alarm summary object.

To create your own alarm summary:

1. Open a graphic display.

2. On the Objects menu, click Advanced Objects, and then click


Alarm Summary. The cursor changes to the Alarm Summary
tool:

3. Drag the mouse to create a box approximately the size you want
for the alarm summary.

When you release the mouse, an empty alarm summary window


appears. The menu bar changes to display the menus for the
Alarm Summary editor.

4. Set up the appearance of the alarm summary object as described


on the following pages.

You can edit the alarm summary object as you would any other
graphic object. You can move it, resize it, and so on. You can

10--60 ■ RSView Supervisory Edition User’s Guide


also use this object in other graphic displays by dragging it from
one display and dropping it in another.

For detailed information about graphic objects, see Chapter 15,


Creating graphic displays.

5. When you are finished, save the graphic display.

The parts of an alarm summary

The alarm summary is a table for displaying information. You


decide how many columns you want the table to have, how wide
the columns will be, and what information the columns will
contain.

A new alarm summary looks like this:

Header area: Use the


commands on the Insert
menu to insert headings
here.

Divider: Use the mouse to


move the divider up and
down.

Body area: The area where


alarm information is
displayed at run time.

Button bar: Use the


commands on the Format
menu to specify what
buttons are included and
where the bar is located.

Setting up alarms ■ 10--61


Preface
Inserting headings

The Insert menu contains the items that can appear in the summary.
To add a heading for an item, click the item on the Insert menu.
You can add as many items as you want and place them in any
order you want.

IMPORTANT The alarm summary can include an operator’s name.


When a tag goes into alarm, this column shows the name
of the Windows system account. When a user
acknowledges an alarm, the Operator Name field
changes to the name of the user who acknowledged the
alarm.

When you click an item on the Insert


menu, two boxes appear in the alarm
summary. Drag the boxes to position
them. When you release the mouse
button, the item name appears.

To reposition an item, drag it with the mouse.

To resize an item, click the item and then drag a handle with the
mouse.

When you move or resize the box above the line, or the one
below the line, you move or resize its twin as well.

10--62 ■ RSView Supervisory Edition User’s Guide


To edit the the text in a box, double-click the box. The Modify
Text dialog box appears. Type the new text in the To box, and
then click OK.

Choosing fonts

The header and body fonts can be different. For example, you
might choose a larger font for the header and a smaller font for the
body. To change a font, click the Format menu and then click Font.

The fonts listed here


depend on which fonts
you have installed in
Windows.

Choose the font, style, and size you want. When you are finished,
click OK.

To increase the size of the header area so a large font is more easily
displayed, drag the divider down.

Setting up alarms ■ 10--63


Preface
Choosing colors and blink styles

You can set up the color of:

Severity 1 through 8 messages

Out of Alarm and Fault State messages

Header, body, and button areas

You can set up the blink style of:

Severity 1 through 8 messages

Out of Alarm and Fault State messages

To set up colors:

1. On the Format menu, click Colors.

If you click Blink here . . .

. . . the blink colors appear


to the right of the solid
colors, here.

2. Click an item in the list on the left.

3. Click a color box to open the color palette, and then click a
color in the palette.

10--64 ■ RSView Supervisory Edition User’s Guide


4. To set up the blink style for an item’s state, click Blink and then
select the blink colors.

5. If you use the blink option for any item’s state, type a blink rate
in the Blink Rate box. The blink rate applies to all items that use
the blink option in this alarm summary.

Text and Background are the colors the message initially appears
in. If you click Blink, the default blink colors are the text and
background colors reversed.

Highlight Text and Highlight Background are the colors the


message changes to when it is selected. If you click Blink, the
default colors are the highlight text and highlight background
colors reversed.

6. When you are finished, click OK.

Formatting buttons

You can specify which buttons you want on the button bar and
where you want the bar located.

To add buttons to the button bar:

1. On the Format menu, click Buttons.

2. In the Buttons dialog box, select or clear the check boxes that
correspond to the buttons you want to add to, or remove from,
the alarm summary.

The table on the pages that follow describes what the buttons
do.

Setting up alarms ■ 10--65


Preface
If you select the Execute check box, the Execute Command
dialog box appears. For information about using the Execute
button, see page 10-79.

3. Click OK.

This button Does this

Ack Current Marks the highlighted alarm as acknowledged. If a bell is


associated with the alarm, acknowledging the alarm turns off
the bell. If the tag has gone out of alarm, the tag is removed
from the alarm summary when the alarm is acknowledged.

Ack Page Marks all alarms on the screen as acknowledged. If a bell is


associated with an alarm, acknowledging the alarm turns off
the bell. If a tag has gone out of alarm, the tag is removed
from the alarm summary when the alarm is acknowledged.

Ack All Marks all alarms in the alarm summary as acknowledged. If


a bell is associated with an alarm, acknowledging the alarm
turns off the bell. If a tag has gone out of alarm, the tag is
removed from the alarm summary when the alarm is
acknowledged.

10--66 ■ RSView Supervisory Edition User’s Guide


This button Does this

Silence If the highlighted alarm is set up to set off the internal bell,
Current Silence Current silences the computer’s sound.

If the highlighted alarm is set up to set off the external bell,


Silence Current resets the associated bit in the
programmable controller.

Silence Page If any alarms on the screen are set up to set off the internal
bell, Silence Page silences the computer’s sound.

If any alarms on the screen are set up to set off the external
bell, Silence Page resets the associated bits in the
programmable controller.

Silence All If any alarms in the alarm summary are set up to set off the
internal bell, Silence All silences the computer’s sound.

If any alarms in the alarm summary are set up to set off the
external bell, Silence All resets the associated bits in the
programmable controller.

Execute Runs a command, or macro, if one was assigned to the


Execute button. You can pass parameters from the
highlighted alarm (for example the tag name) to the
command, or macro.

Identify Runs a command or macro for the alarm, if one was created
and then entered in the Alarm Identification box on the
Advanced tab in the Analog Alarm or Digital Alarm editor.

Filter Opens the Filter dialog box, so alarm information can


temporarily be filtered out of the alarm summary.

Sort Opens the Sort dialog box, so alarm information can


temporarily be sorted.

In addition to providing Filter and Sort buttons that the operator


can use at run time, you can filter or sort alarms permanently at
design time. The result of the design-time filter or sort operation is
retained each time the summary is activated at run time. For more
information see “Choosing data” on page 10-69.

Setting up alarms ■ 10--67


Preface
Changing the button text

To change the text that is displayed on any of the buttons in an


alarm summary, double-click the button, and then type the new
button text in the Text box.

To change the keyboard accelerator key that is used to activate the


button from the keyboard at run time, type an ampersand character
( & ) in front of the character you want to use as the accelerator
key. For example, to use Alt-X to activate the Execute button, type
E&xecute in the text box.

Positioning the button bar

To specify the location of the button bar, click Button Bar Position
on the Format menu, and then click a location. In the following
illustration, the button bar is on the left.

10--68 ■ RSView Supervisory Edition User’s Guide


Choosing data

Use the Filter and Sort items on the Data menu to specify which
alarm information is displayed.

Use Filter to filter in information—that is, to specify information


you do want displayed in the alarm summary. Anything you don’t
specify in the filter is not displayed in the alarm summary at run
time.

Use Sort to specify the order in which alarm information is


displayed.

Alarm information can also be filtered and sorted at run time, but
changes are not saved.

To ensure that tag names are displayed with the names of the areas
they belong to, click Display full tag name.

Setting up alarms ■ 10--69


Preface
Filtering data

IMPORTANT Use Filter to filter in information—that is, to specify


information you do want displayed in the alarm
summary. Anything you don’t specify in the filter is not
displayed in the alarm summary at run time.

1. On the Data menu, click Filter.

2. In the Filter dialog box, select the check boxes that correspond
to the items you want to exclude from the alarm summary.

You can use


wildcards or tag
placeholders in
the alarm
summary filter.
To browse for area
names, click Areas.
To browse for tag names,
click Tags.

Area and Tag Names

Type or select the tag names you want to appear in the alarm
summary. To include tags from a specific area only, type the area
name.

IMPORTANT You cannot use wildcards in area names.

10--70 ■ RSView Supervisory Edition User’s Guide


By default, the Area and Tag Names box contains * which means all
tags are displayed from the home area (the area in which the
graphic display is located). For details about the home area, see
page 4-4.

To ensure that tag names are displayed with the names of the areas
they belong to, click the Data menu, and then click Display full tag
name.

Enter each area or tag name on a separate line. You can use
wildcards to select tags.

These are the wildcards:

This wildcard Does this

* Matches any number of characters, including the


backslash ( \ ) character.

? Matches any single character.

~ When placed before a tag name, excludes the tag. When


placed before an area or folder name, excludes the tags
in the area or folder.

Examples: Using area and tag names in filters

To collect all alarm transactions from the area called Powertrain,


type:

/Powertrain::*
or
/Powertrain

To collect alarm transactions from the current area for the tag name
Coolant_East, type:

Coolant_East

Setting up alarms ■ 10--71


Preface
To collect alarm transactions from the current area for all tags
whose names begin with Coolant, type:

Coolant*

To collect alarms from specific areas for tag names that match a
pattern, you can type:

/Powertrain::Coolant*
/Press::FlowValve*

To collect alarms from more than one HMI server, you can type:

/Powertrain::*
/Press::*

You can also use the Areas and Tags buttons to browse for area or
tag names rather than typing them.

Tag placeholders

You can also use tag placeholders to specify the area or tag names
you want to appear in the alarm summary.

A tag placeholder is the cross-hatch character ( # ) followed by a


number from 1 to 500. The placeholder can also contain wildcards
and folder names. For more information, see “Using tag
placeholders” on page 15-52.

Examples: Using tag placeholders with area names

To display alarm transactions from an area whose name you want


to specify at run time using a parameter file or on the command
line, type one of the following:

/#1::*
or
/Area1/#1/Area3::*

10--72 ■ RSView Supervisory Edition User’s Guide


To display alarm transactions from a specific area for a tag whose
name you want to specify at run time, type:

Area::#1

To display alarm transactions for all tags in a specific area and


folder, type:

Area::Folder/#1/*

In the example shown above, the placeholder #1 allows you to


substitute a folder name at run time.

Resolving tag placeholders at run time

If you use tag placeholders, at run time you must specify the tag or
folder name each placeholder represents, either by using a
parameter file or by specifying the tag or folder names as
parameters to the Display command. If you use a parameter file, it
can contain wildcards.

Example: Using a parameter file to replace tag placeholders

The parameter file called Beans specifies which tags to use for the
placeholders in a display:

#1 = bean_weight
#2 = bean_level
#3 = bean_temp

To run the display called Canning with the Beans parameter file,
type:

Display Canning /PBeans

Setting up alarms ■ 10--73


Preface
For more information, see “Replacing tag placeholders using a
parameter file” on page 15-54 and “Replacing tag placeholders
using parameters to the Display command” on page 15-56.

Tag Type

Only the tag types that are checked, appear in the alarm summary.
To include all alarms, leave both Analog and Digital checked.

Alarm States

If you want a message to appear in the alarm summary when an


alarm is in fault or when a tag goes out of alarm, leave both Faults
and Out of Alarm checked.

If you leave the Out of Alarm state unchecked, the alarm summary
item changes color when the tag goes out of alarm. Tags that are out
of alarm remain in the alarm summary until they are acknowledged.

If you want to see only the tags that are in alarm in the summary,
click Only show tags currently In Alarm. Digital change of state
alarms and InAndOutOfAlarm events are not displayed in the
alarm summary when you select this check box.

Alarm Severities

To include alarms of all severities, leave all boxes checked. To


exclude an alarm severity, clear its check box.

Out of alarm messages do not have severities, so if you select the


Out of Alarm option all out of alarm messages will be shown
whether or not you show the InAlarm message for a given severity.

10--74 ■ RSView Supervisory Edition User’s Guide


Sorting data

To sort data, click the Data menu and then click Sort. You can
specify four levels of sorting.

By default, alarm information is sorted first by date and time, then


by severity, then by area name, and finally by tag name.

This means that alarms are presented chronologically. If two or


more alarms have the same time and date, these alarms are
presented in order of severity. If any alarms have the same time and
date and the same severity, they are then presented by tag name.

You can sort data whether it is filtered or unfiltered.

Setting up alarms ■ 10--75


Preface
Running commands, macros, or custom
programs in response to alarms

Using the Execute and Identify buttons in an alarm summary, you


can run a command, macro, or custom program to respond to tags’
alarm conditions.

Use the Execute button to run a command, macro, or custom


program that applies to all alarms in the summary, for example to
create a custom alarm report for analyzing plant maintenance
efficiency.

Use the Identify button to run a command, macro, or custom


program that applies only to the tag for the highlighted alarm. The
Identify button can run a different command, macro, or custom
program for each tag, for example to run a different help file for
each tag’s alarm conditions.

About the Execute button

With the Execute button, you can specify a command or macro that
operators can run with reference to the highlighted alarm in an
alarm summary. The Execute command can be appended with tag
information derived from the highlighted alarm—for example the
tag name, alarm type, severity, value, date and time, and the tag
type.

Use the execute feature to apply a common command, macro, or


custom program to the alarm that is selected in the alarm summary.
For example, you can run a custom program to add entries to a
custom alarm report for selected alarms in an alarm summary, and
you can pass arguments from the highlighted alarm to the custom
program.

10--76 ■ RSView Supervisory Edition User’s Guide


To set up the Execute button:

1. Double-click the alarm summary to edit it.

2. On the Data menu, click Execute. This opens the Execute


Command dialog box.

3. In the Execute Command Text box, type a command or macro,


and then select one or more parameters to append to the
command or macro.

For details about using alarm data with commands, see


page 10-79.

By default, the Execute button is not included in an alarm


summary. The Execute button is added when a command is
assigned to the button. For information about adding buttons to the
button bar in an alarm summary, see page 10-65.

To run the command, macro, or custom program:

" At run time, with data populating the alarm summary, do one of
the following:

double-click an alarm in the list

highlight an alarm in the list and then click Execute

For more information about using the Execute button in an alarm


summary, and for an example, see “Using alarm data with
commands” on page 10-79.

About the Identify button

With the Identify button, you can specify a command or macro that
operators can run when a tag is in alarm. Use this button to provide
information about an alarm. For example, use the Display
command to open a display that contains instructions about how to
handle a motor that is running too fast.

Setting up alarms ■ 10--77


Preface
To set up the Identify button:

1. In the Tags editor, click an analog or digital tag for which you
have set up an alarm.

2. Open the Alarm editor by clicking the Alarm button.

3. Click the Advanced tab.

4. In the Alarm Identification box, type a command or macro.

For details about setting up the Identify button for analog tags,
see “Alarm Identification” on page 10-37.

For details about setting up Identify button for digital tags, see
“Alarm Identification” on page 10-42.

To run the Identify command:

" At run time, with data populating the alarm summary, highlight
an alarm in the list and then click Identify.

When you use the Identify command, the command or macro


runs whether or not the tag is in alarm.

For detailed information about the Identify command and other


RSView commands, see Appendix A, RSView commands, or see
Help.

For detailed information about macros, see Chapter 19, Setting up


navigation.

10--78 ■ RSView Supervisory Edition User’s Guide


Using alarm data with commands

Use the Execute item on the Data menu to execute a command


(whether an RSView command, an RSView macro, or a custom
program), and to append parameters to the command. At run time,
the parameters are derived from the highlighted alarm in the alarm
summary.

For example, to log an entry in the activity log file with


information about a particular entry in the alarm summary, use the
Remark command. To include details about the highlighted alarm,
for example, the alarm’s severity or the tag’s value, check the
corresponding boxes in the list of parameters.

Using parameters

Parameters are appended to the command in the same order in


which the parameters appear in the dialog box. You can substitute

Setting up alarms ■ 10--79


Preface
parameters into any position within a command by passing the
parameters to a macro. For details about using parameters with
macros, see page 19-10.

Parameters are separated by a space, unless you click Separate


Parameters with commas.

IMPORTANT A space is not automatically appended to the end of the


command text. If you are using parameters and require a
space between the end of the command, macro, or
custom program and the first parameter, be sure to
include the space at the end of the command text.

Severity and value are shown only for alarms of type IntoAlarm.
For alarm types OutOfAlarm and IntoFault, the severity is 0.

Adding area names to parameters

To include the area name in the parameters passed to the command


for the Execute button, select the Insert Area name check box.

If you select the Insert Area name check box, the Area name
appears automatically between the first and second word you type
in the Execute Command Text box. Because you cannot change the
position of the area name, be sure the command shown at the
bottom of the dialog box is syntactically correct before you
click OK.

Alternatively, use a macro to substitute the parameters into any


position within the command.

If you select the Tag name check box, to pass tag names as
arguments to the Execute command text, the tag names always
include the area name, whether or not areas are displayed in the
alarm summary.

At run time, the area name is the area of the alarm that is
highlighted in the alarm summary.

10--80 ■ RSView Supervisory Edition User’s Guide


Example: Using the AlarmLogRemark command with the
Execute button

You can use the Execute button to prompt the user at run time to
add a remark to the alarm log file.

To do this, add the command AlarmLogRemark /P /T to the


Execute button in the alarm summary, and then click the Tagname
parameter. At run time, the following happens:

the /P parameter displays a dialog box to prompt the operator


for a remark

the /T parameter logs a string in the Tagname column of the


alarm log file

the Tagname parameter records the name of the highlighted tag


in the alarm summary in the Tagname column of the alarm log
file

Setting up alarms ■ 10--81


Preface
You cannot change the order in which parameters are passed to the
command line for the alarm summary Execute button. To use the
alarm summary Execute button with the AlarmLogRemark
command, and have the tag name added correctly to the /T
argument, you must ensure that the argument (/T) appears last on
the command line:

For details about using the AlarmLogRemark command, see


“Adding remarks to the alarm log file at run time” on page 10-30,
and see Appendix A, RSView commands, or see Help.

Using the Execute button to run a custom program

If you set up the Execute button to run a custom program, and you
copy the alarm summary from one application to another
application, you must ensure that the custom program is available
in the new application, otherwise the Execute button will not run
the program.

Viewing the area name in tag names

In an alarm summary, you can display tag names with the names of
the areas they belong to.

To do this, click the Data menu, and then click Display full tag
name.

Suppressing alarm printing

To suppress alarm printing for all tags, use the AlarmPrintOff


command. To re-enable printing of alarms, use the AlarmPrintOn
command.

10--82 ■ RSView Supervisory Edition User’s Guide


Using AlarmOn and AlarmPrintOff in the
correct order

AlarmOn normally logs alarms to both the alarm log file and the
printer. However, the order in which you issue the AlarmOn and
AlarmPrintOff commands affects what happens at run time:

if you issue the AlarmOn command before you issue the


AlarmPrintOff command, alarm monitoring starts. Alarms are
logged to the alarm log file and the printer until you issue the
AlarmPrintOff command.

if you issue the AlarmPrintOff command and then issue the


AlarmOn command, alarms are logged to the alarm log file, but
not to the printer

The AlarmPrintOff and AlarmPrintOn commands are not retained


across RSView sessions. If you issue the AlarmPrintOff command
before AlarmOn, alarms will not print to the printer. But if you
shut down RSView, restart it, and then issue the AlarmOn
command, alarms will be logged to alarm log file and the printer
until you issue the AlarmPrintOff command.

Suppressing alarm monitoring

You can suppress alarm monitoring for tags. This is useful for
testing or performing repairs or maintenance on equipment.

To suppress alarm monitoring for tags, use the SuppressOn


command. To suppress all alarms for the specified tags, issue the
SuppressOn command before the AlarmOn command.

To view a list of the tags not being monitored, use the Suppressed
List. You can also turn monitoring back on from this list.

The SuppressOn command is not retained after an AlarmOff


command is issued. The Suppressed List is therefore empty after the
AlarmOff command is issued.

Setting up alarms ■ 10--83


Preface
Suppressing alarm monitoring for tags

1. Open the command line.

2. Type the following RSView command and press Enter:

SuppressOn <tag name>

To suppress more than one tag, use a wildcard. The wildcards


are:

This wildcard Does this

* Matches any number of characters, including the


backslash ( \ ) character.

? Matches any single character.

Viewing suppressed tags

The Suppressed List shows which tags are suppressed—that is,


which tags are not being monitored for alarms.

To open the Suppressed List:

1. In the Application Explorer, open the Alarms folder.

2. Open the Suppressed List editor by doing one of the following:

double-click the Suppressed List icon

right-click the Suppressed List icon and then click Open

drag the Suppressed List icon to the workspace

10--84 ■ RSView Supervisory Edition User’s Guide


Using the Suppressed List

Use the Suppressed List to see which tags are not being monitored
for alarms and to turn alarm monitoring back on.

Click a tag name and Click All Off to turn off


then click Suppress Off suppression for all tags.
to turn off suppression
for that tag.

More RSView commands

You can also use RSView commands to turn off suppression and to
open the Suppressed List. For details, see Appendix A, RSView
commands, or see Help.

Setting up alarms ■ 10--85


Preface
Starting and stopping alarm monitoring
There are many ways to start and stop alarm monitoring. Choose
the way that works best for your application.

For a complete list of RSView commands and their command


syntax, see Appendix A, RSView commands, or see Help.

Ways to start alarm monitoring at the


HMI server

IMPORTANT If the HMI server performing alarm monitoring is not in


the home area, you must specify the area name with the
AlarmOn command in the examples below. For details
about using the AlarmOn command, see Appendix A,
RSView Commands.

In the Startup editor, select the Alarming check box. Alarm


monitoring starts the next time the HMI server runs, or when the
HMI server’s components are started manually.

In the Macros editor, create a macro that contains the command,


AlarmOn. In the Startup editor, select this macro in the Startup
Macro list.

In the Graphic Displays editor, create a button object. In the


Button Properties dialog box, click the Action tab. In the Press
action box, type the AlarmOn command. When the button is
pressed, alarm monitoring starts.

In the Graphic Displays editor, create a graphic object. On the


Animation menu, click Touch to open the Animation dialog
box. In the Action box, type the AlarmOn command. When the
object is touched, alarm monitoring starts.

In the Events editor, type the AlarmOn command in the Action


box for an event.

At the command line in RSView Studio, or the RSView


Administration Console, type AlarmOn and then press Enter.

10--86 ■ RSView Supervisory Edition User’s Guide


Ways to stop alarm monitoring

To stop all the components that are running on the HMI server,
including data log models, event components, derived tag
components, and alarm monitoring, stop the components running
on the HMI server manually. For details, see page 22-11.

To stop alarm monitoring only, use any of the methods below:

IMPORTANT If the HMI server performing alarm monitoring is not in


the home area, you must specify the area name with the
AlarmOff command in the examples below. For details
about using the AlarmOff command, see Appendix A,
RSView Commands.

In the Graphic Displays editor, create a button object. In the


Button Properties dialog box, click the Action tab. In the Press
action box, type AlarmOff command. When the button is
pressed, alarm monitoring stops.

In the Graphic Displays editor, create a graphic object, and then


attach touch animation with the AlarmOff command as the
action. When the object is touched, alarm monitoring stops.

In the Events editor, type the AlarmOff command in the Action


box for an event.

At the command line in RSView Studio, or the RSView


Administration Console, type AlarmOff and then press Enter.

Setting up alarms ■ 10--87


11
Chapter

Setting up
activity logging
Activity log records information about various types of system
activity, for example errors, and operator activity. The information
can be:

viewed with the Activity Log Viewer

archived for future processing or analysis

exported to ODBC format while online. This enables analysis of


the data in third-party, ODBC-compliant tools such as Microsoft
Excel, and Seagate Crystal Reports.

Which activities can be logged?

You can log some or all of the following types of system activity:

command and macro usage

operator comments

system messages and errors

errors from the communication network

tag read and write activity

Setting up activity logging ■ 11--1


Preface
Summary of steps
By default, RSView is set up to log activities. You can change the
default settings and specify:

where to store activity log files

when to create and delete log files

which activities to log

whether to log activities to a central, ODBC-compliant database

IMPORTANT You must run the Activity Log Setup program on the
every computer on which you want to log activities.

Activities for all the RSView software programs running


on the computer are logged to the log files on that
computer.

The Activity Log Setup editor

To open the Activity Log Setup editor:

1. Open the Activity Log Setup editor by doing one of the


following:

in RSView Studio or in the RSView Administration Console,


click the Tools menu, and then click Activity Log Setup

click the Start button, point to Programs, Rockwell


Software, RSView Enterprise, Tools, and then click
SE Activity Log Setup

11--2 ■ RSView Supervisory Edition User’s Guide


Specify the path to the
log file, and select a
printer.

Specify when log files


are created and
deleted.

Specify which activities


are logged.

Optionally, set up
logging to a central
database.

Specifying where to store activity log files

To specify where to store log files:

1. In the Activity Log Setup editor, click the Logging tab.

By default, activity log files are stored in the path


\Documents and Settings\All Users\Documents\Rockwell\ActivityLog

Setting up activity logging ■ 11--3


Preface
2. If you want to change where the log files are stored, type a new
path.

When log files are created, they will be stored in the directory
specified here.

3. If the log path is not located on the same computer on which the
system activity is generated, you must change the security
account under which the activity log service runs. For details,
see “Specifying the security settings of the activity log service”
on page 11-13.

4. If you want activity log files to be named using the DOS


eight-character file name and three-character extension format,
click to clear the Use long file names check box.

If the path where the log files are stored supports long file
names, the date stamp part of the log file name includes a
four-digit year.

5. If you want activities logged to a printer, click the Printer


button to display a list of available printers.

Only printers already set up on your system are available for


printing. For information about installing a printer, see your
Windows documentation.

IMPORTANT You can use only continuous-feed printers, such as


dot-matrix printers. Page printers, such as laser
printers, are not supported.

6. Click OK.

Creating log files


You can set up your application to create new log files periodically,
or you can prevent new files from being created. 61

You can create up to 26 new files in each 24-hour period. If you


attempt to create a 27th file, RSView continues logging data to the

11--4 ■ RSView Supervisory Edition User’s Guide


26th file. For log files with both long and short file names, the
sequence starts again at midnight, with the first new file for the new
day. Log files are saved in the directory you specify on the Setup
tab.

For more information about activity log files, see “About activity
log files” on page 11-8.

Monitoring disk space

If your computer’s hard disk is full, activity logging stops and no


more log files are created. For information about monitoring disk
space on computers running HMI servers, see page 22-19.

To specify when to start new files:

1. In the Activity Log Setup editor, click the File Management tab.

2. Under Start New Files, click an option to specify when you


want to have new files created. See the topics below for
information about the different times.

Setting up activity logging ■ 11--5


Preface
Creating files periodically

Click Periodic, and then click a time period. A new file is created
after the specified interval has elapsed.

For this period The new file is created

Hourly Approximately on the hour

Daily Each day approximately at midnight

Weekly Each Sunday approximately at midnight

Monthly On the first day of each month approximately at


midnight

Creating files on demand

To create a new log file immediately, use the ActivityLogNewFile


command.

To create a new file immediately:

" At the Command Line, type ActivityLogNewFile and then


press Enter.

When you press Enter, a new activity log file is created on the
local computer, and all subsequent messages are logged to the
new file.

Never creating new files

Click Never. Logged data is added to a single file.

11--6 ■ RSView Supervisory Edition User’s Guide


Managing disk space

To manage disk space if a log file grows too large, stop activity
logging, delete the activity log file, and then restart activity logging.
You cannot delete a log file while activities are being logged. For
information about monitoring disk space on computers running HMI
servers, see page 22-19.

Deleting log files


You can delete old log files after a specified period, or once a
specified number of files has been created. If you never want files
deleted, leave the check boxes under Delete Oldest Files blank.

Activity log files are deleted only when a new file is created. So, if
your application creates a new file each day and deletes the oldest
file every third day, your application will have files for the three
previous days’ data as well as a file for the current day.

To specify when to delete files:

1. In the Activity Log Setup editor, click the File Management tab.

2. Under Delete Oldest Files, select one or both check boxes and
then type a number to specify when to delete the log files.

If you select both check boxes, files are deleted after the
maximum time or after the maximum number of files is reached,
whichever happens first.

If you do not want files deleted, leave the check boxes under
Delete Oldest Files blank.

Setting up activity logging ■ 11--7


Preface

After Maximum Time Files are deleted after the maximum time
has expired. For example, if two days is the specified time, files
are deleted at midnight of the third day so you always have the
two previous days’ data and the current day’s data.

After Maximum Files The oldest log file is deleted after the
specified maximum has been reached. The files to which
RSView is currently logging are not included in this number.
For example, if you specify 10, you will have a maximum of 11
activity log files at any time—10 old ones and the current one.
When a new file is started, the oldest file set is deleted.

About activity log files

How log files are named

When a log file is created, it is named automatically. The name is


based on the date the file was created and the type of data it
contains. The format for the name is YYYYMMDDnz.dat, where: 3.

YYYY are the four digits of the year

MM is the month

11--8 ■ RSView Supervisory Edition User’s Guide


DD is the day

n is the sequence letter (‘a’, ‘b’, ‘c’, and so on). This letter
indicates the sequence files were created in. You can have up to
26 files (‘a’ to ‘z’) per day. At midnight, the sequence starts at ‘a’
again.

z is the file type: ‘i’ is for activity

If the path where the log files are stored does not support long file
names, the format for the name is YYMMDDnz.dat, where YY are the
last two digits of the year.

Example: Log file name

The activity log file named 010423bi.dat was created in the


year 2001, month 4, and day 23. The b indicates that this is the
second file created that day. The i indicates that this is an activity
log file.

Setting up activity logging ■ 11--9


Preface
Specifying which activities are logged

To specify which types of activity are logged:

1. In the Activity Log Setup editor, click the Categories tab.

2. In the Select Category list, click a category:

This activity
category Logs

Commands The execution of a command.

Subsystem Subsystems such as security logins and data


logging.

ActiveX events if the event has been set up to do


so in the ActiveX Control Events dialog box.

Remarks Remarks entered using the Remark command.

Communications Communication errors.

11--10 ■ RSView Supervisory Edition User’s Guide


This activity
category Logs

Tag Read Any tag read (not read errors).

Tag reads can be done by uploading data into


numeric and string input fields in a graphic
display. Normal scanning is not logged as a
tag read.

Tag Write Any tag write (not write errors).

Tag writes are done by the = (Equal), Ramp, Set,


and Toggle commands, as well as by
downloading data from numeric input, and
string input fields in a graphic display.

Custom 1 through Custom messages from VBA subroutines.


Custom 4

3. To specify where you want the activity logged, select the


appropriate check boxes. You can log to the activity bar, log file,
and printer.

For more information about the activity bar, see “Using the
activity bar” on page 11-16. For more information about log
files, see “Creating log files” on page 11-4.

4. For each category you want to log, complete steps 2 and 3.

Logging to a central database

In addition to logging to a log file, you can optionally set up


RSView to log data to a central, ODBC-compliant database.

Central logging works by periodically exporting the contents of the


activity log file to an ODBC-compliant database. RSView supports
the following ODBC-compliant databases: Microsoft Access, Sybase
SQL Server, Oracle, and Microsoft SQL Server.

Setting up activity logging ■ 11--11


Preface
If you have set up file management to delete the oldest files when a
new set is started, and you are exporting data to an ODBC database,
make sure you export the data before the oldest files are deleted.

For information about the contents of the activity log ODBC tables,
see page 20-1.

To log data to a central database:

1. In the Activity Log Setup editor, click the Central Logging tab.

2. Select the Enable central logging check box.

3. To specify a logging interval, type a number and then select a


time unit.

The activity log file is exported to the ODBC-compliant database


at this interval.

4. Specify the name of the ODBC data source. To browse for the
data source name, click the Browse button.

11--12 ■ RSView Supervisory Edition User’s Guide


5. Specify the target table in the
ODBC-compliant database.
To browse for the target table, click the Browse button.

If the target table does not exist, and if you have a connection to
the database, you can create the target table. Type the target
table name and then click Create Table.

6. If the database and HMI server are not located on the same
ODBC
computer, you must enter a User ID and password to connect to
the database. Click the Login Required checkbox and then type
your user ID and password.

7. Click OK.

8. If theODBC database is not located on the same computer as the


network drive, network share, or ODBC database, you must
change the security account under which the activity log service
runs. For details, see below.

Specifying the security settings of the activity


log service
If you are logging to a network drive, network share, or ODBC
database that is not located on the same computer on which the
system activity is generated, you must change the Windows security
settings of the activity log service.

To change the security account of the activity log service:

1. On the computer where system activity is generated, click the


Windows Start button, point to Settings, and then click Control
Panel.

2. In Control Panel, double-click Administrative Tools. In


Administrative Tools, double-click Services.

3. In the list of services, right-click Rockwell HMI Activity Logger.


On the shortcut menu, click Properties.

Setting up activity logging ■ 11--13


Preface
4. In the Rockwell HMI Activity Logger Properties dialog box,
click the Log On tab.

5. Under Log on as, click This account and then type the name and
password of a user that has access to the network share or
database.

6. Click OK.

7. With the Rockwell HMI Activity Logger service highlighted in


the Services dialog box, do one of the following:

Stop Service tool


on the toolbar, click the Stop Service tool

on the Action menu click Stop

8. With the Rockwell HMI Activity Logger service highlighted in


the Services dialog box, do one of the following:

Start Service tool


on the toolbar, click the Start Service tool

on the Action menu click Start

Exporting activity log files manually to ODBC format


Using the command, ActivityLogSendToODBC, you can export
logged activities manually from the activity log file to an
ODBC-compliant database.

If the table in the database to which you are attempting to export


data is not ODBC compliant, the export will fail. If an ODBC-
compliant table does not exist, RSView will try to create it.

When you export data to an ODBC table, RSView keeps track of the
data that was exported in a control file called Activity.exp. This file
is located in the log path where the .dat files are stored. The next
time you export data, only the newest data is exported. If the
control file is deleted, all the activity log data in the .dat files are
exported when you issue the export command.

11--14 ■ RSView Supervisory Edition User’s Guide


If you have set up file management to delete the oldest files when a
new set is started, and you are exporting data to an ODBC-compliant
database, make sure you export the data before the oldest files are
deleted.

Example: Exporting activity log files to ODBC format


on demand

To export the contents of the activity log files to an ODBC-


compliant database on demand, create a button in a graphic display.
The button’s press action should be the ActivityLogSendToODBC
command.

When the operator presses the button, the contents of the activity
log file are exported to the ODBC database.

The ActivityLogSendToODBC command exports only the records


added to the activity log files since the last export.

For information about the contents of the activity log ODBC tables,
see page 20-1.

Editing activity log setup


You can edit the activity log setup during development or at run
time, using the Activity Log Setup editor.

If you change the activity log setup at runtime, the changes do not
take effect until you stop activity logging and then restart it.

Setting up activity logging ■ 11--15


Preface
To edit the activity log setup:

1. Open the Activity Log Setup editor by doing one of the


following:

in RSView Studio or in the RSView Administration Console,


click the Tools menu, and then click Activity Log Setup

click the Start button, point to Programs, Rockwell


Software, RSView Enterprise, Tools, and then click
SE Activity Log Setup

2. Make the required changes.

3. Save the changes.

Using the activity bar


To keep track of what is happening when an application is running,
use the activity bar.

To log activities to the activity bar, the Activity Bar check boxes
must be selected in the Categories tab of the Activity Log Setup
editor. For details, see page 11-10.

11--16 ■ RSView Supervisory Edition User’s Guide


Hiding, showing, and moving the activity bar

When RSView first starts, the activity bar is visible and is docked
above the status bar in the RSView main window.

Activity bar
Status bar

Hiding and showing the activity bar

To show or hide the activity bar, click Activity Bar on the View
menu for the Application Explorer. When Activity Bar has a check
mark beside it, the activity bar is visible.

Moving the activity bar

You can detach (undock) the activity bar from the main window,
and then move the bar anywhere on the screen.

Setting up activity logging ■ 11--17


Preface
To undock the activity bar, drag the grab bars at the bottom left of
the activity bar. If you can’t see the grab bars, drag the top edge of
the activity bar to make it a bit larger.

To detach the
activity bar, drag
the grab bars.

To prevent the activity bar from docking automatically while you


move it across the screen, hold down the Ctrl key on the keyboard
while you move the activity bar.

Resizing the activity bar

When the activity bar is undocked, you can make it any size you
want, for example to view more than one message at a time. To
resize the bar, drag an edge or corner until the bar is the size you
want.

Messages in the activity bar

The types of messages that appear in the activity bar depend on


what is set up in the Categories tab of the Activity Log Setup
editor.

Activity messages are preceded by a blue, yellow, or red icon. Blue


indicates information, yellow indicates a warning, and red indicates
an error. The following illustration shows a warning, and an
information message:

An ellipsis
indicates that the
message has been
truncated. Resize
the activity bar to
view the whole
message.

To clear messages, click the Clear or Clear All button. Clear


removes the the top message. Clear All removes all the messages.

11--18 ■ RSView Supervisory Edition User’s Guide


Clearing a message in the activity bar does not delete the message
from the activity log file.

Using the Activity Log Viewer


The Activity Log Viewer displays the contents of activity log files.

By default, the Activity Log Viewer displays the severity, date and
time, category, description and user name fields from the activity
log files.

To open the activity log viewer:

" Do one of the following:

in RSView Studio, or the RSView Administration Console,


click the Tools menu, and then click Activity Log Viewer

click the Windows Start button, point to Programs,


Rockwell Software, RSView Enterprise, Tools, and then click
SE Activity Log Viewer

For information about setting up and using the activity log viewer
see the activity log viewer Help.

To open the activity log viewer Help:

" Click the Start button, point to Programs, Rockwell Software,


RSView Enterprise, Tools, and then click SE Activity Log
Viewer Help.

Setting up activity logging ■ 11--19


Preface
Using the activity log viewer at run time

To display the activity log viewer at run time:

1. In a graphic display, create a button operators can use to open


the activity log viewer.

2. For the button’s press action, type the following command:

AppStart “C:\Program Files\Rockwell Software\RSView


Enterprise\ActivityLogViewer.exe”

You must include the quotation marks, because there are spaces
in the parameter.

At run time, the viewer may appear behind the RSView SE Client
window. This is the result of operating system rules. You can either
bring the viewer to the front manually, or you can work around this
problem programmatically. For details about a programmatic
work-around, see technical note P9029 in the Rockwell Software
Support Library.

Tracking system usage

If you have set up security for your application, you can use the
activity log file to track what users are doing on the system. When
an activity is logged, the ID of the current user is also logged. 3.

11--20 ■ RSView Supervisory Edition User’s Guide


12
Chapter

Setting up data logging


Data log is an RSView component that collects and stores tag
values. You specify which tag values to collect, when to collect
them, and where to store them by defining a data log model.

The data that is collected can be stored in an internal file set, or in


an ODBC-compliant (Open Database Connectivity) database.

You can display the data in trends, archive it for future use, or
analyze it using any ODBC-compatible reporting software, such as
Microsoft Excel, or Seagate Crystal Reportst.

What is a model?

A data log model defines which tags to log data for, when to log the
data, and where to log the data. In the model you also specify the
format of the log files (file set, or ODBC) and when to create and
delete the files.

How to use multiple data log models

At run time, up to 20 models can run simultaneously on each


RSView SE Server. Use multiple data log models to:

store related information in separate file sets

log groups of tags at different rates

log groups of tags based on events

Setting up data logging ■ 12--1


Preface
Summary of steps
To set up a data log model, specify:

what format to use

where to store data log data (primary and secondary paths)

when to create and delete log data

what actions will trigger logging

which tags to log data for

what to call the model

About data log storage formats


Logged data is stored in either an internal file set, providing faster
performance for historical trends, or in an ODBC-compliant database
of your choice. 4.

If you use a file set, tag values are stored in proprietary-format files.
You cannot view the contents of these file sets, except in trends.

If you log tag values to an ODBC-compliant database, you can view


the data in trends, and you can use third-party, ODBC-compliant
tools to analyze and create reports from the data. If the ODBC
database becomes inaccessible, RSView logs the data to backup files
in proprietary format.

If you need to use data in multiple formats, define multiple data log
models for the same tags.

12--2 ■ RSView Supervisory Edition User’s Guide


The log file sets

How log file sets are named

When a log file set is created, it is named automatically. The name is


based on the date the file was created and the type of data it
contains.

RSView names the log file sets using long file names. The maximum
length of a log file set’s name, including its path, is 200 characters.
File sets are named using the following format for the file name:

YYYY MM DD NNNN <Log File Identifier String> <(type)>.dat

YYYY is the year

MM is the month

DD is the day

NNNN is the sequential file identifier. This number indicates the


sequence files were created in. You can have up to 9999 file sets
per day. At midnight, the sequence starts at 0000 again.

<Log File Identifier String> is a text string you can specify to


help identify the log file. The maximum string length is 20
characters.

<(type)> is the file type. The type is enclosed in parentheses.


There are three file types: Tagname, Float (for analog and digital
tag values), and String.

Setting up data logging ■ 12--3


Preface

Example: Long file name

The log file named 2001 10 30 0004 Oven Temperatures (Float).dat


was created in the year 2001, month 10, and day 30. The 0004
indicates that this is the fourth file set created that day. Oven
Temperatures is the log file identifier string, which the user defined
to help identify the data. (Float) indicates that this file contains
analog or digital values.

The ODBC database storage format


Use the ODBC database storage format to store your data in an ODBC
data source such as Microsoft Access or Microsoft SQL Server. The
ODBC format stores data in up to three tables:

Tag table (optional)—stores tag names in an index so they can be


referenced using a 2- or 4-byte numeric field (rather than a
40-byte character field) in the float and string tables

Float table—stores analog and digital tag values

String table (optional)—stores string tag values

For a detailed description of contents of the tables, see page 20-4.

ODBC backup files are stored as binary files with the extension .obf.
You cannot view the contents of the .obf files.

How ODBC tables are named

The ODBC tables are created with the default names TagTable,
FloatTable, and StringTable. However, you can edit these names
before creating the tables, or specify different tables to use, in the
Data Log Setup dialog box.

If you specify a backup path for an ODBC model, RSView names the
backup log files as described on page 12-3.

12--4 ■ RSView Supervisory Edition User’s Guide


Using an existing ODBC data source

You can log data to an existing ODBC data source, but its tables must
contain fields that are formatted for the RSView data log. There are
two ways to prepare tables for data logging to an existing database:

set up the RSView data log fields in the existing ODBC tables
before setting up your data log model

create new tables automatically or manually in the existing


database in the Data Log Setup dialog box

To use the tables in an existing ODBC data source:

1. Add fields for the data log data to the tables in the ODBC
database. See the example on page 12-10 for information about
the steps you need to complete to add fields to an existing table.

The section “Data log tables” on page 20-4 describes the order
and type of fields needed to log data to an ODBC database. Edit
the tables as described in the documentation for the ODBC
database you are using.

2. Set up your data log model, as described in “Setting up a model”


on page 12-7. Specify the existing ODBC database as the ODBC
Data Source, and then specify the tables you edited.

To create new tables in an existing ODBC data source:

1. Specify the name of the existing ODBC data source in the ODBC
Data Source field of the Data Log Setup editor. For more
information, see “Setting up a model” on page 12-7.

2. Click Create Tables. RSView automatically creates new data log


tables in the existing database. You can also create tables
manually, as described in the example on page 12-10.

3. Set up the rest of your data log model, as described in “Setting


up a model” on page 12-7.

Setting up data logging ■ 12--5


Preface
Creating a new ODBC data source

You can also create a new ODBC data source when you set up your
data log model, as described in “Setting up a model” on page 12-7.
RSView can create the ODBC tables automatically, or you can create
the tables manually.

The Data Log Setup editor

To open the Data Log Setup editor:

1. In the Application Explorer, open the Data Log folder.

2. Open the Data Log Models editor by doing one of the


following:

double-click the Data Log Models icon

right-click the Data Log Models icon and then click New

Set up general aspects


of the model.

Specify the paths to


which to log the data.

Specify when you want


log data created and
deleted.

Specify how and when


logging should occur.

Specify which tags to


log data for.

12--6 ■ RSView Supervisory Edition User’s Guide


Setting up a model
1. In the Data Log Setup editor, click the Setup tab.

2. Type a description of the model. This is for your information


only.

3. Type a log file identifier string, up to 20 characters long.

This text string forms part of the file name for the data log files.
Data log files are named using long file names. For more
information about how log file sets are named, see page 12-3.

If you choose the ODBC storage format in step 4, long file names
apply to the backup files only.

You can change the log file identifier string at run time, as
described on page 12-38. However, the run-time change affects
the current data log session only. When you stop and restart the
model RSView uses the string you set up here.

4. Click a file storage format.

The file set stores tag values in a proprietary format for fast
performance.

The ODBC format logs tag values to tables in an ODBC database.


For more information about ODBC tables see “The ODBC database
storage format” on page 12-4. If you choose this format, go to
step 6.

5. If you choose file set and are logging string tags, you must
specify the number of characters used to log the string.

Number of characters in string Type the number of characters


to be logged for all string tags in the model.

Setting up data logging ■ 12--7


Preface

6. If you chose the ODBC storage format in step 4, specify the ODBC
data source.

Type the path and file name of an existing ODBC data source. If
the data source does not yet exist, use the ODBC Data Source
Administrator to create it.

To open the ODBC Data Source Administrator, double-click


Data Sources (ODBC) in the Administrative Tools folder in the
Windows Control Panel.

For details about using the ODBC Data Source Administrator,


click Help in the ODBC Data Source Administrator window.

7. Specify one or more ODBC tables. For a description of each


table’s purpose, see “The ODBC database storage format” on
page 12-4.

If you are creating a new database, you can create the tables
automatically at the data source you specified. To do this,
type the table names in the table boxes, and then click Create

12--8 ■ RSView Supervisory Edition User’s Guide


Tables. Delete the name in a table box if you don’t want to
create that table.

If RSView cannot create the tables automatically, you must


create the tables manually. Follow the instructions in the
example on the next page.

If RSView cannot create an index automatically, a message


informs you that you must create it manually. For
information about creating the database tables manually, see
the example on the next page.

To select a table from the existing tables in the database, click


the Browse button and then select a table in the Select ODBC
Browse button Table dialog box. To view the order, type, length, and
precision of the fields in the table, click the table to select it,
and then click Details.

If you don’t specify a table name for the tag table, the tag
name is used instead of a tag index in the float and string
tables. This uses more database space than using a separate
tag table.

When you save the data log model, RSView informs you if
the fields in a selected table are not in the order or of the
type required to log data. In this case you must edit the table
as described in the documentation for the ODBC database you
are using. For information about the order and type of fields
needed to log data to an ODBC database, see page 20-4.

8. If theODBC database and HMI server are not located on the same
computer, you must enter a User ID and password to connect to
the database. Click the Login Required checkbox and then type
your user ID and password.

9. If the ODBC database is not located on the same computer as the


HMI server, you must change the security account under which
the data log program file runs, and you must change the access
permissions for related logging services. For details, see
“Specifying the security settings of the data log program file and
related services” on page 12-18.

Setting up data logging ■ 12--9


Preface

Example: Setting up ODBC database tables manually

This example shows how to create ODBC database tables manually in


a Microsoft SQL Server database, using Microsoft Query. You can
install Microsoft Query from the Microsoft Office CD-ROM.

To set up the ODBC data tables:

To log in and create the tables, you must have access to the
SQL Server.

1. In the folder \Program Files\Microsoft Office\Office10,


double-click Msqry32.exe.

2. On the File menu, click Table Definition.

3. In the Select Data Source dialog box, specify the data source you
created, and then click OK. If required, enter your login ID and
password.

4. In the Select Table dialog box, click New.

5. To set up the first field in a table called TagTable, enter the


following information:

Table Name: TagTable


Field Name: TagName
Type: char
Length: 40

6. Click Add.

12--10 ■ RSView Supervisory Edition User’s Guide


7. To set up the second field in the table, enter the following
information:

Field Name: TagIndex


Type: smallint

In the Type field, click the type that most closely matches the
SQL Data Type for the field you are adding, as listed in the
tables on pages 20-4 to 20-6.

8. To set up the third field in the table, enter the following


information:

Field Name: TagType


Type: smallint

9. To set up the fourth field in the table, enter the following


information:

Field Name: TagDataType


Type: smallint

10. Click Create.

11. To add the FloatTable and StringTable, repeat steps 5 through 8.


For information about the field types and lengths, see page 20-4.

If you want to edit a table that already exists, log in, click the table
name, and then click View. The order of the data log fields must
match the order listed in the tables on pages 20-4 to 20-6. If you
add the data log fields to an existing table, the data log fields must
appear first in the table. However, you can use different names for
the data log fields.

Setting up data logging ■ 12--11


Preface
To add an index for the FloatTable and StringTable:

1. In the Select Table dialog box, select FloatTable, and then click
Index.

2. In the Index Name box, type FloatTableIndex.

3. In the Index Fields field select DateAndTime (or the name you
assigned to the first field in the FloatTable).

4. Click Add, and then click Close.

5. Repeat steps 1 through 4 for the StringTable. When you are


finished, click Close.

Setting up an index for these tables enhances logging performance.

Setting up logging paths

Switching logging paths

RSView allows you to specify a secondary or backup path to log


data to if the primary path for file sets or the ODBC database
becomes unavailable. The primary path or ODBC database could
become unavailable because of network failures, or because of lack
of disk space on the primary path or where the ODBC database is
located.

If the primary path or ODBC database becomes unavailable, RSView


begins to store the data in a buffer. The buffer can hold up to 64 Kb
of data. When the buffer fills, or when the maximum amount of
time to buffer data has elapsed, if the primary path or ODBC
database is still unavailable RSView switches to the secondary or
backup path.

RSView checks periodically to determine whether the primary file


path or ODBC database has become available again. If the primary
path or ODBC database has become available, RSView switches back
automatically.

12--12 ■ RSView Supervisory Edition User’s Guide


RSView also checks the status of the primary path or ODBC database
if the secondary or backup path becomes unavailable, and will
switch back if possible. If both paths are unavailable, RSView
buffers the data. If the buffer fills and both paths are still
unavailable, RSView empties the buffer (the data in the buffer is
lost) and begins storing new data in the buffer. RSView continues
checking both paths until one becomes available.

If the data log file is locked, data is buffered for the time specified
for Maximum Time To Buffer in the Advanced Configuration
dialog box, and then a new set of files is created on the primary
path. If the secondary path is not set up, the data is buffered for
10 minutes (the default value for maximum time). If the maximum
time is set to 0, a new file is started immediately.

If the model is logging to the secondary path and the file is locked,
the behavior is the same: the data is buffered, and then a new file is
created when the specified time period has elapsed.

You can also switch back to the primary path or ODBC database
manually, using the DataLogSwitchBack command (see page 12-20)
or the DataLogMergeToPrimary command (see page 12-21).

For models that use the file set, RSView creates a new file set each
time the logging path changes.

Specifying log paths

You can specify the primary and secondary file paths for a file set,
and the ODBC backup file path by editing the data log model in the
RSView Studio Application Explorer, as described next.

You can also change the log paths at run time using the RSView
Administration Console, as described on page 12-36.

Setting up data logging ■ 12--13


Preface
To specify primary and secondary paths for a file set, and
the ODBC backup file path:

1. In the Data Log Setup editor, click the Paths tab. If you are
using the ODBC storage format, go to step 3.

2. If you are using file sets, specify the primary path where you
want to store the data log files.

Relative To Project Location

Stores the log files in the project folder. RSView creates a folder
called Dlglog and a subfolder with the same name as the model
name and then stores the files there.

Absolute Path

Allows you to specify a particular path. If the path you type


does not exist, RSView will create it. The first time data logging

12--14 ■ RSView Supervisory Edition User’s Guide


runs, RSView creates a subfolder with the same name as the
model name and stores the files there.

If the ODBC database is not located on the same computer as the


HMI server, you must change the security account under which
the data log program file runs, and you must change the access
permissions for related logging services. For details, see
“Specifying the security settings of the data log program file and
related services” on page 12-18.

3. To allow RSView to switch to a secondary file set or a backup


path if the primary path or ODBC database becomes unavailable,
click Enable ODBC Backup Path. For more information, see
“Switching logging paths” on page 12-12.

Relative To Project Location

Stores the secondary path or backup log files in the project


folder. RSView creates a folder called Dlglog and a subfolder
with the same name as the model name and stores the files there.

Setting up data logging ■ 12--15


Preface
For file sets, if you used this default path as your primary path,
specify a different path for the secondary path.

Absolute Path

Allows you to specify a particular path. If the path you type


does not exist, RSView will create it. The first time data logging
runs, RSView creates a subfolder with the same name as the
model name and stores the files there.

If the ODBC database is not located on the same computer as the


HMI server, you must change the security account under which
the data log program file runs, and you must change the access
permissions for related logging services. For details, see
“Specifying the security settings of the data log program file and
related services” on page 12-18.

4. If you choose to use a secondary or backup path, click


Advanced. Specify the parameters to use when switching
between the primary path or ODBC database and the secondary
or backup path.

Maximum time to buffer data before attempting


switchover (minutes)

If you specify 0, RSView switches over immediately and no data


is buffered.

12--16 ■ RSView Supervisory Edition User’s Guide


The buffer can hold up to 64 Kb of data. If the buffer fills before
the specified time, and the primary path is still unavailable,
RSView switches to the secondary path.

If the primary path becomes available before the maximum


time, RSView logs the data in the buffer to the primary path and
continues to use the primary path.

The amount of time RSView buffers the data may vary slightly
from the time you specify, depending on the log rate for
periodic models or the frequency with which tag values change
for on-event models.

How often to retry primary for automatic switchback


(minutes)

If you specify 0, RSView does not switch back automatically. To


switch logging back to the primary path, the operator must issue
the DataLogSwitchBack or DataLogMergeToPrimary
command.

In all other cases, RSView checks whether the primary path has
become available after the specified time has elapsed.

Minimum free disk space required for auto


switchback (MB)

For data log models that use file sets, specify a high enough
value to prevent RSView from switching between paths
frequently because of low disk space on the primary path.

The needs of your application might vary considerably from the


default value of 10 MB , depending on the frequency, and amount
of data you expect to log. If you use the ODBC storage format,
this option is not available.

RSView does not use this value to trigger a switch to the


secondary path. The value is used only to determine whether to
switch back to the primary path automatically after the time to
retry has elapsed.

Setting up data logging ■ 12--17


Preface
Specifying the security settings of the data
log program file and related services
If you are logging to a network drive or ODBC database that is not
located on the same computer as the HMI server, you must change
the security account under which the data log program file runs,
and you must change the access permissions for related logging
services.

To change the security account of the data log program file:

1. On the computer on which you want to run a data log model,


click the Windows Start button, and then click Run.

2. In the Open box, type dcomcnfg, and then press Enter.

3. If DCOM Configuration Warning messages appear, click No for


each one.

4. In the Distributed COM Configuration Properties dialog box,


click the Applications tab.

5. In the Applications list, click Datalog Server Class and then


click Properties.

6. In the Datalog Server Class Properties dialog box, click the


Identity tab.

7. Click This user, and then type the name and password of a user
that has access to the network share or database.

8. Click OK.

To change the access permissions for services related to


data logging:

1. On the computer on which you want to run a data log model,


click the Windows Start button, and then click Run.

2. In the Open box, type dcomcnfg, and then press Enter.

12--18 ■ RSView Supervisory Edition User’s Guide


3. If DCOM Configuration Warning messages appear, click No for
each one.

4. In the Distributed COM Configuration Properties dialog box,


click the Applications tab.

5. In the Applications list, click Rockwell Application Services and


then click Properties.

6. In the Rockwell Application Services Properties dialog box,


click the Security tab.

7. Under Use custom access permissions, click the Edit button.

8. In the Registry Value Permissions dialog box, click the Add


button.

9. In the Add Users and Groups dialog box, click the name of the
same user you assigned to the security account of the data log
program file in step 7 on page 12-18.

10. Click OK to close all dialog boxes except the Distributed COM
Configuration Properties.

11. Repeat steps 5 through 10 for the following services:

Rockwell Directory Multiplexer

RsActLogService Class

HMIServerFramework Class

TagSrvManager Class

12. Click OK to close the Distributed COM Configuration Properties


dialog box.

Setting up data logging ■ 12--19


Preface
Using the DataLogSwitchBack command to switch
logging paths
You can switch back to the primary path manually using the
DataLogSwitchBack <component> command or the
DataLogSwitchBack * command.

The DataLogSwitchBack <component> command switches logging


for the specified data log model. The DataLogSwitchBack *
command switches logging for all data log models that are currently
running. You can use these commands anywhere you can enter an
RSView command or macro. For example, type the command as
the action for an event.

These commands perform a switchback only if the model is


running, RSView is logging data to the secondary or backup path,
and the primary path or ODBC database is available. For file sets,
RSView creates a new set of files when it switches back to the
primary path.

In order to prevent an adverse effect on performance, data is not


moved from the secondary or backup path when you switch back
to the primary path or ODBC database. You must move it manually
using the DataLogMergeToPrimary command.

RSView also switches back to the primary path or ODBC database


when you use the DataLogMergeToPrimary command. You cannot
switch manually from the primary path or ODBC database to the
secondary or backup path.

You can give operators ways to issue these commands at run time.
For example, you can create a button object and use the
DataLogSwitchBack <component> command as the press action.

12--20 ■ RSView Supervisory Edition User’s Guide


Using the DataLogMergeToPrimary command to
move secondary files to the primary path
When you begin writing to, or reading from a data log model,
RSView sends a message to the activity log if there are files on the
secondary or backup path. You must move data manually from the
secondary or backup path to the primary path or ODBC database
using the DataLogMergeToPrimary <component> command or
DataLogMergeToPrimary * command.

The DataLogMergeToPrimary <component> command moves data


for the specified data log model, whether or not the model is
running. The DataLogMergeToPrimary * command moves data for
all data log models that are currently running. You can use these
commands anywhere you can type an RSView command or macro.

If a model is running when you issue these commands, RSView also


performs a switchback to the primary path or ODBC database for the
specified model or all running models. If a model uses file sets,
RSView moves all files on the secondary path (including the current
file set) to the primary path, begins a new file set on the primary
path, and then continues logging to the new file set. If a model uses
the ODBC format, RSView merges the data in the ODBC backup files
into the ODBC database, and then continues logging to the ODBC
database.

To restore the secondary or backup data, give operators a way to


issue the DataLogMergeToPrimary <component> command or the
DataLogMergeToPrimary * command at run time. For example,
you can create a button object and use the command as the press
action.

Setting up data logging ■ 12--21


Preface
Creating file sets
If your data log model uses the ODBC format, data is added
continually to the same database, and this section does not apply. If
your data log model uses file sets, RSView logs the data to sets of
files. You can set up your application to create new file sets, over
these time intervals:

periodically

at specified times

when a particular event occurs

never

Log files are saved in the folder you specify on the Paths tab.

Monitoring disk space

If the hard disk space for the primary path is full, data logging
switches to the secondary path, if enabled, until space becomes
available on the primary path. If you do not set up a secondary
path, when the primary path runs out of disk space data logging
stops and no more log files are created.

To prevent loss of data, you can monitor disk space. For details
about monitoring disk space on computers running HMI servers, see
page 22-19.

12--22 ■ RSView Supervisory Edition User’s Guide


To specify when to start new file sets:

1. In the Data Log Setup editor, click the File Management tab.

2. Under Start New Files, click an option to specify when you


want new files created. For information about the different
options, see the topics that follow.

Creating files periodically

Click Periodic, and then click a time period. A new file is created
after the specified interval has elapsed.

For this period The new file is created

Hourly Approximately on the hour

Daily Each day approximately at midnight

Weekly Each Sunday approximately at midnight

Monthly On the first day of each month approximately at


midnight

Setting up data logging ■ 12--23


Preface
Creating files at specified times

Click At Specified Times, and then type a time or list of times when
you want data to be logged to a new file. Start a new line for each
new time and allow at least five minutes between start times.

Use any of the following to specify time:

Time Format

Day Sun, Mon, Tue, Wed, Thu, Fri, or Sat

Date 1 to 31

If you specify 31, the months that do not have 31 days will
not have new log files.

Hour 00: to 23:

Minute :00 to :59

You can combine hours and minutes with a day or date.

Example: Creating a new file

To have a new file start every Wednesday at 2:00 A.M. and every
Friday at 2:00 P.M., type the following start times:

12--24 ■ RSView Supervisory Edition User’s Guide


Creating files when a particular event
occurs

1. Click On Event.

2. In the Expression box, type the expression that will trigger


creation of a new file. For details about expressions, see
Chapter 18, Creating expressions.

Example: Creating a new file for a new shift

You can set up your project so it creates a new log file at the end of
a shift or batch process. For example, create a tag called NextShift.
In the Data Log Setup editor, click On Event, and then in the
expression box, type NextShift.

When the tag evaluates to true, a new data log file is created to store
the data from the new shift.

Never creating new files

Click Never. Logged data is added to a single file.

To manage disk space if a log file grows too large, stop data logging,
move or delete the data log file, and then restart data logging. You

Setting up data logging ■ 12--25


Preface
cannot delete a log file while data is being logged to it. For details
about monitoring disk space on computers running HMI servers, see
page 22-19.

Using the DataLogNewFile command to create files

You can also create new ODBC backup files and new file sets using
the commands DataLogNewFile <component> or
DataLogNewFile *.

The DataLogNewFile <component> command creates a new file set


for the specified data log model. The DataLogNewFile * command
creates a new file set for all data log models that are currently
running. You can use these commands anywhere you can type an
RSView command or macro.

If your data log model uses the ODBC format, these commands
create a new set of backup files if RSView is logging to the backup
path when the command is issued. If RSView is logging to the ODBC
database, RSView logs an End Snapshot and then a Begin Snapshot
when you issue these commands.

If your data log model uses file sets, these commands start a new
file set regardless of when new files have been set up to start in the
Data Log Setup editor. The new file set is created in the same path
that RSView is currently logging to.

These commands record two snapshots of data: an End Record in


the old file, and a Begin Record in the new file. If you use the
DataLogNewFile <component> command or the
DataLogNewFile * command, it is not necessary to use the
DataLogSnapshot command as well.

You can give operators ways to issue the DataLogNewFile


command at run time. For example, you can create a button object
and use the command as the press action. When an operator presses
the button, the command is issued, a new file is created, and data is
logged to that file.

12--26 ■ RSView Supervisory Edition User’s Guide


Deleting ODBC database records and file sets
If your data log model uses the ODBC database format, you can
purge old records from the database using standard relational
database tools or SQL queries. You can also set up RSView to delete
(purge) records in the ODBC database after a specified time.

If your data log model uses file sets, you can delete file sets after a
specified period or once a specified number of file sets has been
created. If you never want file sets deleted, leave the check boxes
under Delete Oldest Files blank.

Data log file sets are deleted only when a new file set is created. So,
if your project creates a new file set each day and deletes the oldest
file set every third day, your project will have file sets for the three
previous days’ data, as well as a file set for the current day.

To specify when to delete file sets or ODBC database data:

1. In the Data Log Setup editor, click the File Management tab. If
you are using the ODBC storage format, go to step 3.

2. If you are using file sets, under Delete Oldest Files, select one or
both check boxes, and then type a number to specify when to
delete the file sets. If you select both check boxes, files sets are
deleted after the maximum time or after the maximum number

Setting up data logging ■ 12--27


Preface
of files is reached, whichever happens first. If you do not want
files deleted, leave the check boxes blank under Delete Oldest
Files.

After Maximum Time

File sets are deleted after the maximum time has expired. For
example, if two days is the specified time, file sets are deleted at
midnight of the third day, so you always have data for the
previous two days and the current day.

After Maximum Files

The oldest log file set is deleted when the specified maximum is
reached. The files currently being logged to are not included in
this number. For example, if you specify 10, you will have a
maximum of 11 data log file sets at any time—10 old ones and
the current set. When a new set is started, the oldest file set is
deleted.

These options apply to file sets on the primary path only, not to
the files on the secondary path. RSView deletes files on the
secondary path only when the DataLogMergeToPrimary
command is issued.

When you have finished specifying options for deleting file sets,
go to “Specifying when to log data” on page 12-30.

12--28 ■ RSView Supervisory Edition User’s Guide


3. If you are using the storage format, under Purge Oldest
ODBC

Records in ODBC Database, select the After Maximum Time


check box. Type a number to specify when to delete the records,
and then select whether the number is measured in days, weeks,
or months.

If you do not want records deleted, leave the check box blank.

This option purges records from the ODBC database only, not
from the backup files. RSView deletes ODBC backup files only
when the DataLogMergeToPrimary command is issued.

Setting up data logging ■ 12--29


Preface
Specifying when to log data

You can set up logging so tag values are logged:

periodically (periodic logging)

only when a tag’s value changes (on-change logging)

when a particular event occurs and triggers the


DataLogSnapshot command (on-demand logging)

DataLogSnapshot <component> is the RSView command for


logging data for a single data log model on demand, where
<component> is the name of the data log model. Use the
DataLogSnapshot * command to log a snapshot of the data for
all data log models that are currently running.

You can combine types of logging. For more information, see


“Combining logging” on page 12-34.

To specify what should trigger logging:

1. In the Data Log Setup editor, click the Log Triggers tab.

2. To specify a log trigger, click an option, and then fill in any


additional information. For more information about the
different types of log triggers, see the topics below.

12--30 ■ RSView Supervisory Edition User’s Guide


Logging periodically

Periodic logging takes a snapshot of all tag values at a particular


point in time.

To log periodically:

1. Click Periodic.

2. In the Interval field, type a time, and then click a time unit to
specify how often tag values will be logged. All tags in the
model will be logged each time this interval expires.

Do not set the interval faster than the scan class rate, or OPC
update rate, or you will log redundant data. For information
about scan classes, see “Scanning for new tag values” on
page C-17. For information about update rates see “Scanning for
new tag values” on page 6-12.

You can change the periodic log rate at run time, as described on
page 12-38. However, the run-time change affects the current
data log session only. When you stop and restart the model,
RSView uses the log rate you set up here.

Logging on change

On-change logging is used to log only tags whose values have


changed, when the change occurs.

To log on change:

1. Click On Change.

2. In the Maximum Update Rate list, click the fastest rate at which
data servers should send changes in tag values. Use a larger value
to prevent rapid tag changes from overloading the HMI server.

Setting up data logging ■ 12--31


Preface
3. In the Change Percentage box, type the percentage of the tag’s
min/max range by which the tag value must change in order to
be logged.

Zero means all changes are logged.

If the tag does not have a minimum or maximum attribute (a


Low EU and High EU property), for example a data server tag in
ControlLogix, all changes are logged.

4. In the Heartbeat field, type a time, and then click a time unit to
specify how often tag values will be logged even if no change
has occurred. If you do not want to use the heartbeat, type 0.

The heartbeat ensures that the data in the log file is current. The
heartbeat is also a good way to ensure that data logging is
working and acquiring valid data.

Logging on demand

Logging on demand means that data is logged for a model only


when the DataLogSnapshot command is issued. When the
DataLogSnapshot command is executed, values for all tags in the
specified model or models are logged.

To log on demand:

1. Click On Demand.

2. Run the model or models for which data will be logged. To run
a model, select the model in the Startup editor or issue the
DataLogOn <component> command where component is the
name of the data log model.

3. Issue the DataLogSnapshot command, as described next.

12--32 ■ RSView Supervisory Edition User’s Guide


Using the DataLogSnapshot command

You can record tag values using the DataLogSnapshot <component>


command or the DataLogSnapshot * command.

The DataLogSnapshot <component> command records tag values


for all tags in the specified model at the instant the command is
executed.

The DataLogSnapshot * command records tag values for all tags in


all running models at the instant the command is executed.

You can use these commands anywhere you can enter an RSView
command or macro. For example, enter the command as the action
for an event.

Operators can also use these commands at run time. For details, see
“Providing operators with a way to log on demand” on page 12-34.

Example: Creating an event for on- demand logging

To create an event that will trigger logging when an alarm occurs:

1. Click the On Demand log trigger.

2. Open the Event editor. Create an expression such as:

If alm_in_alarm(motor_fault) and new_batch_started then 1


else 0

3. In the Event editor’s Action field, type DataLogSnapshot


<component> where file is the name of the data log model.

When the tag called motor_fault goes into alarm, and the tag called
new_batch_started is 1, the DataLogSnapshot <component>
command runs. All tags in the model will then be logged (not just
the tag in alarm).

Setting up data logging ■ 12--33


Preface
Combining logging

You can combine periodic or on-change logging with on-demand


logging. This allows data to be captured at particular times, as well
as when a particular event occurs. 4.

To combine logging:

1. In the Data Log Setup editor, click the Periodic or On Change


log trigger.

2. Type the DataLogSnapshot <component> command, or type the


DataLogSnapshot * command anywhere you can use a macro or
command.

Providing operators with a way


to log on demand

At run time, operators might need to take a snapshot of data. To do


this, they need a way to issue the DataLogSnapshot <component>
command or the DataLogSnapshot * command. You can provide
operators with a method for taking a snapshot by: 3.

creating a button object and using the command as the press


action—operators can then press the button to take a data log
snapshot

creating a display key or client key and using the command as


the press action—operators can then press a key to take a data
log snapshot

12--34 ■ RSView Supervisory Edition User’s Guide


Choosing the data to be logged
Log models can contain up to 10,000 tags.

To specify tags:

1. In the Data Log Setup editor, click the Tags in Model tab.

2. In the Tag(s) to Add box, specify the tags that will be logged. To
do this, do one of the following:

type the tag names, separating multiple tag names by a space


or a comma

use the Browse button to open the Tag Browser, and then
select the tags. To select multiple tags, Shift-click to select
Browse button consecutive tags, or Ctrl-click to select individual tags..

3. Click the Add button. The tags listed in the Tag(s) to Add box
appear in the Tags in Model field.

To remove a tag from the Tags in Model box, click a tag, and
then click Remove. To remove multiple tags, Shift-click the tags

Setting up data logging ■ 12--35


Preface
and then click Remove. To remove all the tags, click Remove
All. Tags that you remove appear in the Tag(s) to Add box.
Delete the tags you want to remove from the Tag(s) to Add box
before you click OK.

Editing the data log model

You can edit a model during development or run time. If you


change a model at run time, the changes will not take effect until
you stop data logging and then restart it.

To edit the data log model:

1. In the Application Explorer, open the data log model you want
to change.

2. Make the required changes.

3. Save the changes.

IMPORTANT If you delete a tag from a data log model, and the tag is
also used in a trend object, be sure to remove all
references to the deleted tag from the trend object.

Changing log paths using the


RSView Administration Console

You can change the log paths after an application has been deployed
by using the RSView Administration Console (you don’t need to
use RSView Studio). You can change the primary and secondary
paths for file sets, and the backup path for ODBC data log models.

You cannot change the ODBC database using the Administration


Console.

12--36 ■ RSView Supervisory Edition User’s Guide


To edit the log paths:

1. In the Application Explorer, open the Data Log folder.

2. Open the Data Log Model in which you want to change the log
path.

3. Edit the path as described in “Specifying log paths” on


page 12-13.

Making run- time changes without


editing the data log model
You can change the following data log parameters at run time
without editing the data log model:

the log rate for periodic logging, using the DataLogChangeRate


command

the log file identifier string, using the DataLogRenameFile


command

Use these commands anywhere you can enter an RSView command


or macro. For example, in RSView Studio, or the RSView
Administration Console, type the command directly at the
command line.

These run-time changes take effect immediately, but are lost if you
shut down the application and then restart it (the changes are not
retentive).

Setting up data logging ■ 12--37


Preface
Changing the log rate for periodic logging

You can change the rate at which periodic logging occurs at run
time using the command:

DataLogChangeRate <component> <value> [unit]

where

<component> is the name of the data log model

<value> is the numeric portion of the time interval for the log
rate. For example, if you want to log data every 20 seconds, the
value is 20.

[unit] is the time unit of the log rate: hundredths, tenths,


seconds, minutes, hours, or days. If you omit the unit parameter,
the default is seconds.

The change to the logging rate applies during the current logging
session only. When you stop and restart logging, RSView uses the
logging rate you specified in the the data log model.

Changing the log file identifier string

You can change the identifier string that forms part of the file name
in log file sets. The log file identifier string is also used in the names
of ODBC backup files. To change the string, use the command
DataLogRenameFile <component> <LogFileIDString>, where

<component> is the name of the data log model

<LogFileIDString> is the log file identifier string, up to


20 characters long

The change to the log file identifier string applies during the current
logging session only. When you stop and restart logging, RSView
uses the log file identifier string you specified in the the data log
model.

12--38 ■ RSView Supervisory Edition User’s Guide


Displaying historical data in a trend
You can display historical data in a trend by assigning a tag from a
data log model to a pen.

For more information about trends, see Chapter 17, Setting


up trends.

Starting and stopping data logging


There are many ways to start and stop data logging. Choose the
way that works best for your project.

For a complete list of RSView commands and their command


syntax, see Appendix A, RSView commands, or see Help.

Ways to start data logging

In the descriptions below, <component> represents the name of the


data log model.

In the Startup editor, select the Data Logging check box, and
then select a data log model. The data log model runs the next
time the HMI server runs, or when the HMI server’s components
are started manually. If you want to start more than one data log
model for an application, include the DataLogOn <component>
command in a startup macro.

In the Macros editor, create a macro that contains the command,


DataLogOn <component>. In the Startup editor, select this
macro in the Startup Macro list.

In the Graphic Displays editor, open the Display Settings dialog


box, and then click the Behavior tab. In the Startup box, type
the DataLogOn <component> command.

In the Graphic Displays editor, create a button object. In the


Button Properties dialog box, click the Action tab. In the Press

Setting up data logging ■ 12--39


Preface
action box, type the DataLogOn <component> command. When
the button is pressed, data logging starts for the specified model.

In the Graphic Displays editor, create a graphic object. On the


Animation menu, click Touch to open the Animation dialog
box. In the Action box, type the DataLogOn <component>
command. When the object is touched, data logging starts for
the specified model.

In the Events editor, type the DataLogOn <component>


command in the Action box for an event.

At the command line in RSView Studio, or the RSView


Administration Console, type DataLogOn <component> and
then press Enter.

Ways to stop data logging

To stop all the components that are running on the HMI server,
including data log models, event components, derived tag
components, and alarm monitoring, stop the components running
on the HMI server manually. For details, see page 22-11.

To stop a single data log model, use the DataLogOff <component>


command where <component> is the name of the data log model.
To stop all data log models, use the DataLogOff * command.

To stop data logging, you can also use any of the methods described
below:

In the Graphic Displays editor, create a button object, and then


specify the DataLogOff <component> command or the
DataLogOff * command as the button’s press action. When the
button is pressed, the specified command runs.

In the Graphic Displays editor, create a graphic object, and then


attach touch animation to the object. In the Action box, type the
DataLogOff <component> command or the DataLogOff *
command. When the object is touched, the specified command
runs.

12--40 ■ RSView Supervisory Edition User’s Guide


In the Events editor, specify the DataLogOff <component>
command or the DataLogOff * command as the action for an
event.

At the command line in RSView Studio, or the RSView


Administration Console, type DataLogOff <component> or
type DataLogOff * and then press Enter.

Setting up data logging ■ 12--41


13
Chapter

Setting up events
Events are expressions that trigger actions. Expressions are
equations containing tag values, mathematical operations,
if – then – else logic, and other built-in RSView functions. Actions
are RSView commands, symbols, or macros. An action could, for
example:

initiate a snapshot of tag values using the DataLogSnapshot


command

change a tag value using the Set command

IMPORTANT Events are detected on RSView SE Servers only.


Commands executed only at the RSView SE Client are
ignored when issued by an event expression.

For information about where commands are executed,


see page A-5.

This chapter describes how to use the Events editor to create


events. It does not describe the expressions used to produce the
event’s actual function. If you do not know how to use expressions,
see Chapter 18, Creating expressions.

How to use multiple event components


You can create multiple event components. At run time, each HMI
server can run up to 20 event components (containing a maximum
of 1,000 events each) simultaneously.

Use multiple event components to group events that need to be


evaluated at different rates.

Setting up events ■ 13--1


Preface
Summary of steps
The main steps for setting up events are:

set the maximum update rate for the event component in the
Events editor’s Event Setup dialog box

create the events in the Events editor

The Events editor

To open the Events editor:

1. In the Application Explorer, open the Logic and Control folder.

2. Open the Events editor by doing one of the following:

drag the Events icon from the Application Explorer to the


workspace

right-click the Events icon and then click New

13--2 ■ RSView Supervisory Edition User’s Guide


Using the Accept and Discard buttons

When you enter information in the editor, the Prev and Next
buttons change to Accept and Discard. Click Accept to save
information. Click Discard to discard information.

Using the Check Syntax button

The Check Syntax button verifies that the expression you typed
uses correct syntax. You can check the syntax of your expression at
any time by clicking the button.

The syntax of the expression is also checked automatically when


you click Accept or Discard.

If the syntax is invalid, an error appears next to the Check Syntax


button.

Setting the maximum update rate


The maximum update rate is the fastest rate at which event
expressions in the event component are evaluated.

You must set the maximum update rate separately for each event
component.

The maximum update rate also determines the fastest rate at which
data servers send changes in tag values.

Set the update rate as fast as, or faster than, the rate at which the
values of tags used in the expressions change, unless it is desirable
to miss changes in tag values.

Setting up events ■ 13--3


Preface
To set the maximum update rate for the event component:

1. On the menu bar, click Setup and then click Event Setup.

The Event Setup dialog box opens.

2. Type a brief description of the event component. This


description is for your information only—it doesn’t appear
anywhere else.

For example, if you were creating an event component for a


certain area of your plant, you might type something like “East
Wing Assembly Line” to identify the area.

3. In the Maximum Update Rate list, click an update rate. For


example, if you click 0.25, RSView evaluates the expressions that
contain tags with values that have changed every quarter of a
second.

If you’re using HMI tags, don’t specify a maximum update rate


faster than the scan class background period, DDE server polling
rate, or OPC server update rate.

4. Click OK.

13--4 ■ RSView Supervisory Edition User’s Guide


Creating events
An event consists of two parts: an expression and an action. When
the expression changes from false on the previous evaluation to true
on the current evaluation, the action is triggered.

The following illustration shows an event component.

To create an event:

1. In the Action box, type an RSView command, a macro, or a


symbol that will run when the expression goes from false to true
(but not from true to false).

IMPORTANT Do not create events that depend on other events.


Events are not processed sequentially.

For a complete list of RSView commands, see Appendix A,


RSView commands, or see Help.

Setting up events ■ 13--5


Preface
For more information about macros and symbols, see
Chapter 19, Setting up navigation.

2. To disable the event, click to clear the Enabled check box. When
the event component runs, this disabled event is not evaluated.

3. In the Description box, type a brief description to document the


event’s function. This description is for your information
only—it doesn’t appear anywhere else.

4. In the Expression box, create an expression to specify the


conditions that will trigger the action.

For more information about expressions, see Chapter 18,


Creating expressions.

5. Click Accept.

6. Repeat Steps 1 through 5 to create more events.

Use the Next button to move to a new record in the


spreadsheet.

Editing events

You can edit events during development or when you run the
application.

1. Open the event component you want to edit.

2. Use the Prev and Next buttons to move among events. Make the
required changes.

3. Save the changes.

If you change the event component while running the application,


the changes don’t take effect until you stop running the component
and then restart it.

13--6 ■ RSView Supervisory Edition User’s Guide


Starting and stopping event processing
There are many ways to start and stop event processing. Choose the
way that works best for your application.

For a complete list of RSView commands and their command


syntax, see Appendix A, RSView commands, or see Help.

Ways to start event processing

In the Startup editor, select the Event Detector check box and
then select an event component. The event component starts the
next time the HMI server runs, or when the HMI server’s
components are started manually.

In the Macros editor, create a macro that contains the command,


EventOn <component>. In the Startup editor, select this macro
in the Startup Macro list.

In the Graphic Displays editor, create a button object and then


specify the EventOn <component> command as the button’s
press action. When the button is pressed, event detection starts.

In the Graphic Displays editor, create a graphic object and then


attach touch animation using the EventOn <component>
command as the action. When the object is touched, event
detection starts.

In RSView Studio, or in the RSView Administration Console,


open the command line, type EventOn <component>, and then
press Enter.

Setting up events ■ 13--7


Preface
Ways to stop event processing

To stop all the components that are running on the HMI server,
including data log models, event components, derived tag
components, and alarm monitoring, stop the components running
on the HMI server manually. For details, see page 22-11.

To stop a single event component, use any of the methods below:

In the Graphic Displays editor, create a button object and then


specify the EventOff <component> command as the button’s
press action. When the button is pressed, event detection stops.

In the Graphic Displays editor, create a graphic object and then


attach touch animation using the EventOff <component>
command as the action. When the object is touched, event
detection stops.

In RSView Studio, or in the RSView Administration Console,


open the command line, type EventOff <component>, and then
press Enter.

13--8 ■ RSView Supervisory Edition User’s Guide


14
Chapter

Adding security
Add security to your application to prevent users from accessing
certain parts of the system.

This chapter describes the RSView security system, and outlines


how to:

set up user accounts

set up security codes

secure RSView commands, macros, graphic displays,


OLE objects, and tags

prevent users from modifying an application using RSView


Studio, or the RSView Administration Console

locking users into the RSView SE Client environment

Set up users, codes, and secure access


Complete these steps to add security to your application:

1. With the User Accounts editor:

add users or groups to the RSView user list from a Windows


network domain. You cannot add users or groups from
Windows Workgroups or local workstation domains.

For an example of how to use user groups, see page 14-2.

assign a security code (A through P) to each user or group

Adding security ■ 14--1


Preface
Security is based on a system of codes. You decide what the
security codes mean.

2. Assign security codes to commands, objects in graphic displays,


or HMI tags.

Only users with the specified security code can run the secured
commands, interact with the secured objects on a graphic
display, or write to secured HMI tags. In this way, the security
code determines the user or group’s level of access to the
system.

You can assign combinations of security codes (for example B,


D, and E) to users or groups, allowing each user or group to
access a different set of features.

IMPORTANT You cannot assign a security code to data server tags to


protect their values from being modified. To secure a
data server tag, map its address (for example, its
ControlLogix address) to an HMI tag, and then secure
the HMI tag. For information about creating HMI tags,
see Chapter 7, Working with tags.

3. Assign a security code to the application.

Only users with the specified security code can open the
application in RSView Studio, or the RSView Administration
Console.

Example: Assigning security codes

The following security codes are set up:

a graphic display named Boiler is assigned security code B

the DataLogOn command is assigned security code D

a tag named BoilerTemp is assigned security code E

the application is assigned security code P

14--2 ■ RSView Supervisory Edition User’s Guide


In the User Account editor, the following security codes are
assigned:

The Operators group is assigned security codes B and D

The Shift Supervisors group is assigned security codes


A through O

Gail is assigned all the security codes

The Guests group is assigned security code B

This means that:

users who belong to the Operators group can access the Boiler
graphic display and the DataLogOn command

users who belong to the Shift Supervisors group can access


everything, but they cannot open the application in RSView
Studio, or the RSView Administration Console

Gail has full access to the system, and can open the application
in RSView Studio, or the RSView Administration Console

users who log on to the system as Guest can access the Boiler
graphic display only

Adding security ■ 14--3


Preface
Before you begin, make lists
Before you begin, gather lists of your

users or groups of users requiring accounts

RSView commands and macros

For a complete list of RSView commands, see Appendix A,


RSView commands, or see Help.

graphic displays, OLE objects with verb animation, and tags

Finding your way around

For details,
To assign security codes to Use the see

users or groups User Accounts editor below

RSView commands and macros Secured Commands page 14-9


editor

graphic displays and OLE Graphic Displays editor page 14-13


objects with verb animation

HMI tags Tags editor page 14-15

an application Application Explorer page 14-16

Setting up user accounts


User and group accounts come from Windows. You cannot create
users or groups in RSView. You can only select Windows user
accounts, and then assign RSView security codes to them.

If you want to create new users, create the accounts in Windows.


For details about creating users and groups in Windows, see
Windows Help.

14--4 ■ RSView Supervisory Edition User’s Guide


The list of RSView users can be:

all the users or groups in a Windows domain, or

a subset of the users or groups in a Windows domain

This is the RSView User


Accounts editor. Using
this editor, you can add
existing users to the list of
users in RSView.

The main use for this


editor is to assign
RSView security codes to
Windows users.

Any users you don’t select for the RSView user list will not have
access to the parts of the application you have secured.

Once you have added users to the RSView user list, you will have
to specify security access for each user. Use the RSView User
Accounts editor to assign a set of security codes to each user or
group.

To open the User Accounts editor:

" In the Application Explorer, open the User Accounts editor by


doing one of the following:

double-click the User Accounts icon

right-click the User Accounts icon and then click Open

The names of user


groups are enclosed
in square brackets.

Adding security ■ 14--5


Preface
Setting up default access

You can assign a default set of security codes to all users or groups
you add to the RSView user list.

If you want to add many users or groups with the same level of
access, the default user codes are a handy way to eliminate the need
for setting up each user’s security codes manually.

You can modify a user account’s security codes after you have
added the user to the RSView user list.

To set up the default user codes:

1. On the Setup menu, click Default User Codes.

2. In the Security Codes area, select the check box for each
security code you want users to have access to by default.

3. Click OK.

Ensuring you always have access

When setting up accounts, first create a ‘super user’ account for the
system administrator, filling in the fields as specified below. Be sure
to select all security codes (A through P).

Adding users or groups

Before you can make use of user accounts in RSView, you must first
create the user accounts in your Windows domain. To do this, your
network must have at least one Windows server acting as a domain
controller. You cannot use Windows Workgroups, or local
workstation domains.

IMPORTANT All of the users participating in your distributed


application must be members of the same
Windows domain.

14--6 ■ RSView Supervisory Edition User’s Guide


To add user accounts from a Windows domain:

1. On the Setup menu, click Add User/Group, or click the Add


User/Group tool on the toolbar.

2. In the Windows Domain list, click the name of the domain from
which you want to add users.

3. In the Windows Users or Groups list, click the user or group


names you want to include in the RSView User Accounts list.

4. To move the selected names, click the Move button ( › ). To


move all the names, click the Move All button ( » ).

5. Click OK.

Removing users or groups

When you remove a user or group from the RSView user list, the
following items are deleted:

the user or group’s name is deleted from the RSView User


Accounts list. The user or group is not deleted from the
Windows domain.

the user or group’s security codes are deleted from the User
Accounts editor

If you remove users from the Windows domain, they are not
removed automatically from the RSView user list. You must
remove the users from the RSView user list manually.

Adding security ■ 14--7


Preface
To remove user accounts from the RSView user list:

1. On the Setup menu, click Add User/Group.

2. In the RSView User Accounts list, click the user name or group
name you want to delete.

3. Click the Remove button.

4. Repeat steps 2 and 3 for each user or group you want to remove.

5. When you are finished, click OK.

Assigning security codes to users or groups


1. In the User Accounts editor, click the name of the user or group
whose account you want to change.

2. If you like, type the name of a macro in the Login Macro and
Logout Macro fields.

These macros run each time this user logs in and out. For more
information about macros see “Login and logout macros” on
page 14-9.

14--8 ■ RSView Supervisory Edition User’s Guide


3. In the Security Codes area, select the check box for each
security code you want this user to have access to.

4. Click Accept.

5. Repeat steps 1 through 4 for each user.

6. To save the user account configuration, click Close.

Login and logout macros


Each person with a user account can have a login and logout macro.

Any macro component can be a login or logout macro and the


component can contain any RSView command. For example, a
login macro could contain a command to bring up a graphic display
for an area of the plant. A logout macro could contain commands
to redefine sensitive keys. 7.

For the login and logout macros to be executed, they must be in the
same area as the area from which the Login or Logout command
was executed.

For more information about macros, see “Creating macros” on


page 19-7.

Securing commands and macros


In the Secured Commands editor, you create a list of RSView
commands and macros and then assign a security code to each item
in the list.

To open the Secured Commands editor:

1. In the Application Explorer, open the Secured Commands


editor by doing one of the following:

double-click the Secured Commands icon

right-click the Secured Commands icon and then click Open

Adding security ■ 14--9


Preface

Security codes

RSView has 17 security codes: an asterisk ( * ) and the letters


A through P. The asterisk is for unlimited access, and the letters are
for limited access.

The letters are not hierarchical—all letters provide the same level of
security. You do not have to use all of the security codes, nor do
you have to assign the codes in a particular order. For example, you
can choose to use only the codes D and P, and you can assign P
before you assign D.

The Unspecified_Command

The first record in the spreadsheet is called Unspecified_Command.


Any commands or macros that are not listed in the spreadsheet use
the security code selected for the Unspecified_Command.

You can change the security code for the Unspecified_Command.


Initially, it is an asterisk ( * ), which means unlimited access.

If you leave it as an asterisk, you have to list all RSView commands


and macros you want to secure. This is referred to as security by
inclusion.

14--10 ■ RSView Supervisory Edition User’s Guide


If you change the default to a letter, you have to list only those
commands you want users who are assigned this code to have
access to. This is referred to as security by exclusion.

Setting up security by inclusion

Security by inclusion means all RSView commands and all macros


requiring security are listed in the Security Codes editor.

1. For Unspecified_Command, leave the security code as *.

2. In the Command box, type the command or macro you want to


assign security to.

If you assign security to the Login and Logout commands, be


sure to give all users, including Unspecified_Command, access
to these commands. Otherwise, users might be locked in or out
of the system. It is recommended that Login and Logout keep
the * security code.

3. In the Security Code list, select a code for the command or


macro.

4. If you like, type a descriptive remark in the Description field.

5. Repeat steps 2 through 4 for each command and macro.

6. To save the configuration, click Close.

Adding security ■ 14--11


Preface
Setting up security by exclusion

Security by exclusion means only the RSView commands and


macros you want users who are assigned this code to have access to
are listed in the Security Codes editor.

1. For Unspecified_Command, change the security code to any


letter.

2. In the Command box, type a command or macro you want


users who are assigned this code to have access to.

Ensure you include the Login and Logout commands and assign
them the * security code.

3. In the Security Code list, select a code for the command or


macro.

4. If you like, type a descriptive remark in the Description field.

5. Repeat steps 2 through 4 for each command and macro.

6. To save the configuration, click Close.

14--12 ■ RSView Supervisory Edition User’s Guide


Assigning security to a graphic display
Security is assigned to a graphic display in the Graphic Displays
editor. You can assign security while you are creating a graphic
display, or you can assign it later.

To assign security to a graphic display:

1. In the Graphic Displays editor, open Display Settings by doing


one of the following:

on the Edit menu, click Display Settings

right-click the mouse button and then click Display Settings

Click a security
code.

2. In the Security Code list, click a security code.

3. Click OK.

Adding security ■ 14--13


Preface
Assigning security to an OLE object
Security is assigned to a graphic object with OLE verb animation in
the Graphic Displays editor.

IMPORTANT Once an OLE object is activated, there is no security


within the associated application. Therefore, the only
way to secure the application is to assign security to the
OLE object.

To assign security to an OLE object:

1. Open the Graphic Displays editor.

2. Select the OLE object you want to secure.

3. Open the Animation dialog box by doing one of the following:

click an item on the Animation menu

on the View menu, click Animation

on the context menu, click Animation and then click an item

Click a security
code.

4. Click the OLE Verb tab.

14--14 ■ RSView Supervisory Edition User’s Guide


5. In the OLE Verb list, click the verb you want to secure.

6. In the Security list, click a security code.

7. Click Apply.

Assigning security to an HMI tag

Assign security to an HMI tag to restrict write access to the tag. This
prevents users who do not have the tag’s security code from
changing the tag’s value. You can assign security to HMI tags only.
You cannot assign security to data server tags. Assign a security
code to an HMI tag in the Tags editor.

To assign security to a tag:

1. Open the Tags editor.

2. Select the tag that requires security.

Click a security
code.

3. In the Security list, click a security code.

4. Click Accept.

Adding security ■ 14--15


Preface
Preventing users from modifying an application

You can secure an entire application, so that only those users who
have the required security code can open the application in RSView
Studio or the RSView Administration Console.

To secure an application:

1. In the Application Explorer, right-click the Application name


and then click Properties.

2. In the Security code list, click a security code.

Click a security
code.

3. Click OK.

14--16 ■ RSView Supervisory Edition User’s Guide


Locking users into the RSView SE Client
environment

To prevent users from going outside the RSView SE Client


environment, do one or more of the following:

Remove title bars or minimize and maximize buttons from


graphic displays. To do this, right-click the graphic display, and
then click Display Settings. In the Display Settings dialog box,
deselect the Title bar, Minimize button, and Maximize button
check boxes. For details, see page 15-18.

Disable access to the operating system as follows:

Prevent users from switching to other applications. To do


this, set up the RSView SE Client using the RSView
SE Client Wizard.

For details about running the RSView SE Client Wizard, see


Chapter 22, Deploying and administering applications.

Prevent users from accessing the desktop. To do this, use the


DeskLock tool in the RSView Tools program folder. For
details about using the DeskLock tool, see DeskLock Help.

Logging in at run time

When the RSView SE Client opens, it attempts to log the current


Windows user into the client. If the current user is not in the
application’s list of user accounts, the Login dialog box appears.

Adding security ■ 14--17


Preface
To allow different users to log in when an RSView SE Client opens,
ensure you include a way for users to issue the Login command.
For example, include a button that executes the Login command on
the initial display.

To force all users to log in when an RSView SE Client opens,


ensure that the Windows user is not in the application’s list of user
accounts.

Logging out at run time


To allow users to log out at run time, include a way for them to
issue the Logout command. For example, create a button and use
the Logout command as the press action.

You can also set up an RSView SE Client to log out automatically


after a specified period of inactivity. For details, see Help for the
SE Client wizard.

When a user logs out, the following sequence of events occurs:

1. The user’s logout macro executes.

2. All displays are closed (including cached displays).

3. The user is logged out.

4. If the RSView SE Client is licensed, it releases the license,


allowing the license to be used for other RSView SE Clients.

5. The login dialog box is displayed.

Changing passwords at run time


If you want operators to be able to change their passwords, include
a way for them to access the operating system.

For details about changing passwords, see Windows Help.

14--18 ■ RSView Supervisory Edition User’s Guide


15
Chapter

Creating
graphic displays
This chapter describes the Graphic Displays editor and outlines
how to:

set up the drawing environment

draw, edit, and arrange graphic objects

use objects from the Graphic Library editor

About graphic displays and graphic objects


A graphic display represents the operator’s view of plant activity.
The display can show system or process data and provide operators
with a way to write values to an external device such as a
programmable controller. Operators can also print the display at
run time to create a visual record of tag values.

Each graphic display can contain up to 1000 references to


expressions or tags.

The components that make up a graphic display are called graphic


objects. Objects can be:

created in the Graphic Displays editor

dragged and dropped from a graphic library

copied and pasted from another Windows application

Creating graphic displays ■ 15--1


Preface
created by another Windows application and inserted in the
graphic display using OLE (Object Linking and Embedding)

ActiveXtobjects embedded in the graphic display

The Graphic Displays editor

To open the Graphic Displays editor:

1. In the Application Explorer, open the Graphics folder.

2. Open the Graphic Displays editor by doing one of the


following:

right-click the Displays icon and then click New

drag the Displays icon to the workspace

The editor’s main components

The illustration shows the main components of the Graphic


Displays editor.

The main components of the Graphic Displays editor are:

The toolbars contain buttons for commonly-used menu items. The


figure shows only three toolbars but there are several, including
toolbars for foreground and background colors, pattern styles, and
aligning objects.

You can hide or show toolbars using the View menu, and you can
move the toolbars anywhere on the screen.

For more information about toolbars, see page 15-5.

The drawing area is the area for creating graphic displays. Change
the background color of this area in the Display Settings dialog box.
For details, see page 15-23.

15--2 ■ RSView Supervisory Edition User’s Guide


The status bar describes the action performed by the selected
menu item or button. The status bar also displays the x and y
coordinates, and width and height, of the selected object.

Docked toolbar

Drawing area

Floating
toolbar

Status bar

Mastering basic techniques

When working on a graphic display, certain actions and techniques


are used frequently. Knowing how to perform these actions can
save you time.

Using the shortcut menu

No matter where you are in the Graphic Displays editor, you can
open a shortcut menu by clicking the right mouse button. The items
on the menu depend on the cursor’s location. For example, when

Creating graphic displays ■ 15--3


Preface
you right-click an object, the menu contains items relevant to that
object.

When you right-click


an object . . .
. . . the shortcut menu
opens. It contains menu
items for working with the
selected object.

Switching between Edit Display and


Test Display modes

To quickly test objects in a graphic display, use Test Display mode.


When you are finished testing, switch back to Edit Display mode to
Test Display continue editing. To switch between test and edit modes, use the
buttons on the toolbar or the items on the View menu.

If you want to use test mode and your graphic displays contain
Edit Display objects associated with tags, your system must be set up to
communicate with data servers, direct drivers, OPC servers, or DDE
servers.

IMPORTANT Test mode is not the same as running the display. It does
not change the appearance or position of the display as
set up in the Display Settings dialog box.

15--4 ■ RSView Supervisory Edition User’s Guide


Using the toolbars

The toolbars are a convenient way to perform an action. You can: 3.

hide or show them using the items on the View menu. If there is
a check mark beside the toolbar name, the toolbar is visible. If
there is no check mark, the toolbar is hidden.

drag them anywhere on the screen

dock them to an edge of the window (except the ActiveX


Toolbox)

A toolbar that is
docked.

Toolbars that are


floating.

Creating graphic displays ■ 15--5


Preface
Selecting a drawing tool

The Objects toolbar contains tools for creating, selecting, and


rotating objects. The tools are also available on the Objects menu.

Objects toolbar Objects menu

Before you can draw an object, you must select the appropriate
tool.

To select a drawing tool, click the tool in the toolbox or on the


Objects menu. When you click a tool, the pointer changes to show
which tool is active.

Freehand tool Text tool

15--6 ■ RSView Supervisory Edition User’s Guide


To deselect a drawing tool:

" Do one of the following:

click the Select tool

click another drawing tool

Selecting colors

The color palettes contain the colors you can assign to objects. To
show and hide the color palettes, click them on the View menu.
You can also select colors using the color items on the Attributes
menu. You can select colors before you draw an object, or you can
apply them to an existing object.

Use the Foreground Color palette to select a color for the outline of
an object, for text, or for hollow objects.

Use the Background Color palette to select a color for the inside of
an object or for solid objects.

Selecting and deselecting objects

To work with an object, you must first select it. For details about
the various ways you can select objects, see page 15-266.

Creating graphic displays ■ 15--7


Preface
Using the grid

To size and position objects precisely, use the grid items on the
View menu. You can change the grid settings any time during the
drawing process.

Select this check box to


make the grid visible.
Select this check box to Set the spacing of
make the grid active. the grid points in
pixels.
Select a color for the
grid points.

The grid can be active or passive. If you turn on Snap to Grid, the
grid is active, and all the objects you draw or position are pulled to
the closest grid point. This makes it easy to align and size objects. If
you turn off Snap to Grid, the grid is passive, and does not affect
your drawing or the position of your objects.

Turn off the grid either to draw or position an element between the
grid lines. Turn on the grid and the next object you draw or place
will automatically be aligned with the grid. Turning on the grid
does not affect the placement of existing objects.

You can click Show Grid and Snap On on the View menu.

Using the Rotate tool

Use this tool to rotate an object or group of objects around an


anchor point.
Rotate tool
You can also use the Rotate tool when attaching rotation animation
to a graphic object. For details about rotation animation, see
“Setting up rotation animation” on page 16-32.

You cannot rotate OLE objects, ActiveX objects, bitmaps, and text.

15--8 ■ RSView Supervisory Edition User’s Guide


To rotate an object:

1. Click the Rotate tool.

2. Click the mouse button. A small circle with a crosshair appears.


This is the anchor point that is used as the center of rotation. To
move the center of rotation, drag the crosshair.

You can place the crosshair inside an object.

Or you can place it outside an object.

3. Place the pointer on an edge of the object, and then drag the
object to rotate it.

To rotate the object in five-degree increments, press Ctrl while


you drag.

4. When the object is in the desired position, release the mouse


button.

Creating graphic displays ■ 15--9


Preface
Zooming in and out

To magnify or reduce your view of a graphic display, use Zoom In


or Zoom Out. Zoom In magnifies objects, Zoom Out reduces
Zoom In magnification.

Youc can also zoom the graphic display to fit the size of the
window.
Zoom Out

To zoom in on objects:

1. Select the objects you want to zoom in on.

2. Do one of the following:

on the View menu, click Zoom In

on the toolbar, click the Zoom In tool

To zoom out:

Do one of the following:

on the View menu, click Zoom Out

on the toolbar, click the Zoom Out tool

on the View menu, click Cancel Zoom

To fit the graphic display inside the window:

1. Click the graphic display.

2. On the View menu, click Zoom to fit.

When the graphic display is resized, the relative sizes of each of the
objects in the display (also called the aspect ratio), is not
maintained.

15--10 ■ RSView Supervisory Edition User’s Guide


To cancel Zoom to fit:

" On the View menu, click Cancel Zoom.

Correcting mistakes

If you change your mind about something you did, undo the action.
If you change your mind again, redo the action.
Undo

To undo an action:
Redo
" On the Edit menu, click Undo, or on the toolbar, click the
Undo button.

To redo an action:

" On the Edit menu, click Redo, or on the toolbar, click the Redo
button.

Setting up the display

To set up a graphic display, use the Display Settings dialog box.

To open the Display Settings dialog box:

" Do one of the following:

on the Edit menu, click Display Settings

right-click an empty area of the display, and then click


Display Settings on the shortcut menu

Creating graphic displays ■ 15--11


Preface
The Display Settings
dialog box contains
many options for setting
up the appearance of a
graphic display.

You can edit these


options any time while
you are drawing.

You can save the settings for the current graphic display, or you can
save the settings as the default for all new graphic displays.

To save the settings for the current display, click OK.

Creating default display settings

To create your own default display settings, click Set as Default.


When you create a new graphic display, it will use the display
settings you have set up.

Set as Default does not save the settings for the current display.
To save the settings for the current display, you must also click OK.

15--12 ■ RSView Supervisory Edition User’s Guide


Using the Display Settings dialog box

The Display Settings dialog box has two tabs: Properties and
Behavior.

Use the Properties tab to specify these display options:

display type

multiple running copies

caching

title bar and other display attributes

size, resizing, and position

security

background color

Use the Behavior tab to specify these display options:

startup and shutdown commands

input field colors

behavior of interactive objects

behavior of objects with input focus

on-screen keyboard

These options are described in the sections that follow.

Creating graphic displays ■ 15--13


Preface
Setting up display properties

The Properties tab lets


you set up the
appearance, security,
and performance of a
graphic display.

On the properties tab you can:

specify how the display interacts with other displays

allow multiple copies of the display to run simultaneously on


the same client

specify how displays are cached

specify what buttons and text appear in the title bar, how often
the display is updated, and other display attributes

specify the display’s size and position, and whether it can be


resized at run time

set up security for the display

specify the display’s background color

15--14 ■ RSView Supervisory Edition User’s Guide


Specifying the display type

Replace

Replace is the default display type. Use this option if you want the
graphic display to replace other open graphic displays when it
opens. The RSView SE Client closes any graphic display that the
newly-opened display overlaps. This way you don’t need to issue
separate commands to close the other displays.

Overlay

Use this option if the graphic display doesn’t need to replace others
or appear on top. The display will layer with other displays,
overlapping some and being overlapped by others as the focus
changes between multiple displays.

Overlay displays always appear behind On Top displays, and are


replaced by Replace displays. Use Overlay with care, because
keeping multiple displays open can affect system performance
adversely.

Keep at Back

Select this check box if you always want this graphic display at the
back. However, we recommend that you use the On Top display
type to control the layering of displays. To use Keep at Back, you
must click the Overlay option.

On Top

Use this option to keep the graphic display on top at all times. It
remains on top even if another display has focus. However, if more

Creating graphic displays ■ 15--15


Preface
than one graphic display of the On Top type is open at once, the
display that appears on top is the one that has focus, or that had the
most recent focus.

You can use the PullForward, PushBack, and SetFocus commands


to cycle through multiple On Top and Overlay screens on the
RSView SE Client at run time.

Allowing multiple running copies

Use this option with displays of type Overlay or On Top. Select


this check box to allow more than one copy of the graphic to be
displayed at run time. When this option is not selected, running
displays are brought to the foreground when they are called via the
Display command, rather than a new copy being loaded.

You can also run multiple copies without checking this option, by
using the Display command with different parameter files for each
copy of the display. For example, to display two copies of the same
graphic in different places on the screen you could use these
commands:

Display PID /PLevel1 /Q1

Display PID /PLevel2 /Q2

PID is the name of a graphic display, and Level1 and Level2 are
parameter files. /Q1 positions the first display at the top-right
corner of the screen. /Q2 positions the second display at the
top-left corner of the screen.

For details about parameter files, see “Replacing tag placeholders


using a parameter file” on page 15-54.

If multiple copies or several separate displays are running and one is


hidden behind another, use the SetFocus command to bring the
hidden display forward. For details, see Appendix A, RSView
commands, or see Help.

Graphic displays of type On Top are always at the front, regardless


of which display has focus.

15--16 ■ RSView Supervisory Edition User’s Guide


Specifying caching

Cache After Displaying

Click Yes to load the graphic display into the display cache when it
is displayed for the first time. Placing the graphic display in the
cache makes the graphic display appear more quickly every
subsequent time, because it does not have to be read from disk. You
can have up to 40 graphic displays in the cache. Use this option for
large or complex displays only, to minimize the use of system
resources.

Click No if you don’t want the RSView SE Client to load the


display into the display cache. 3.

IMPORTANT Cached displays consume memory. Once Windows


consumes all physical memory, it is forced to swap to
disk, which slows all system activities.

Always Updating

Select this check box to keep the cached display up to date. For
example, select this check box to update trend data continuously for
the display, even when the display is not visible. You can also use
this option to execute VBA code in the background.

IMPORTANT Always updating a cached display can cause added


communications overhead because data is retrieved for
tags whose values might not be needed.

The Always Updating option affects the behavior of the display’s


startup and shutdown commands. For more information, see
“Specifying startup and shutdown commands” on page 15-25.

Creating graphic displays ■ 15--17


Preface
Setting up the title bar and other
display attributes

Title Bar

To have a title bar appear on the graphic display at run time, select
the Title Bar check box.

If the Title Bar check box is not selected, the check boxes for the
System Menu, Minimize button, and Maximize button are not
available (because these items all appear on the title bar).

You can also type a title for the graphic display, which will appear
in the title bar at run time in place of the component name. The
title can be anything you want and can include spaces. You cannot
type a title if the Title Bar check box is not selected.

To be able to move the graphic display’s position on the screen at


run time, you must select the Title Bar check box.

15--18 ■ RSView Supervisory Edition User’s Guide


The following illustration shows the window style options available
if you select the Title Bar check box. To include an item, select the
appropriate check box. Otherwise, leave the check box blank.

Maximize button
Title
Minimize button

Title bar

System menu box Close button


(comes with System menu box)

Size to Main Window at Runtime

If you select this check box, the graphic display will be the size of
the RSView SE Client main window when the display starts
running. The graphic display is panned or scaled, depending on
which option is selected under When Resized. For more
information, see page 15-22.

RSView graphics are resolution independent. This means that no


matter what resolution you use to create your graphic displays,
they are automatically resized to fit the monitor on which they are
displayed at run time.

Show Last Acquired Value

Select this check box to show a graphic display with the last known
value for each HMI tag in the display until current values arrive from
the programmable controller. In many applications, selecting this
option will help display graphics more quickly.

IMPORTANT The last acquired value can be displayed for HMI tags
only. For other kinds of tags, the last value cannot be
retained.

If you do not select this option, objects with values that have not
yet been updated will appear in outline form. The outline indicates
that data is not current, or is in error.

Creating graphic displays ■ 15--19


Preface
Selecting Show Last Acquired Value might not affect a graphic
display the first time the display starts because the HMI tags used in
the display might not be initialized and so might not have any
values. To indicate that there are no tag values, the objects appear in
outline form. Once the HMI tags have been initialized and tag values
arrive, the objects appear in their normal form.

This option does not affect objects with HMI tags that are in error. If
an object has a tag that is in error, the object will appear in outline
form.

Maximum tag update rate

The maximum update is the fastest rate at which data servers send
changes in tag values to the graphic display.

Set the update rate as fast as, or faster than, the rate at which the
values of tags used in the expressions change, unless it is desirable
to miss changes in tag values.

The default update rate is 0.5 seconds. This means that data servers
will not send updates to tag values faster than twice every second.

Preventing scroll bars on the main window

If a graphic display is larger than the RSView SE Client main


window, scroll bars will appear on the main window and will
remain there even if subsequent displays are smaller than the main
window.

To prevent scroll bars from appearing, all graphic displays must be


smaller than the working area in the RSView SE Client main
window. Keep in mind that the size of the working area depends on
several factors: the size you make the window, the monitor’s
display resolution, whether the display’s title bar is visible, and
whether the activity bar is shown.

To minimize the need for scroll bars, the RSView SE Client tries to
position all graphic displays within the working area of the RSView

15--20 ■ RSView Supervisory Edition User’s Guide


SE Client main window, unless explicitly overridden by the /X and
/Y parameters of the Display command.

To ensure the RSView SE Client main window never has scroll


bars, select the Size to Main Window at Runtime option for large
displays. Do not select this option for smaller graphic displays that
are not meant to fill the screen. However, be sure to position the
smaller displays so they are completely visible, otherwise scroll bars
might appear.

Specifying display size

To set the display size, do one of the following:

click Use Current Size. When you save the graphic display, the
size of the window at that time becomes the default size.

click Specify Size in Pixels, and then type a value in the Width
box and the Height box

The window size and position you specify here can be overridden
by the RSView Display command. The Display command accepts
size and position parameters, which override the Display Settings
options. For more information about the Display command, see
Appendix A, RSView commands, or see Help.

Creating graphic displays ■ 15--21


Preface
Specifying how displays are resized

Allow Display to be Resized

If you want a window that can be resized using the mouse, select
this check box. This option works with the pan and scale options.

If you do not select the check box, the graphic display cannot be
resized at run time.

When Resized

Click Pan to resize the display so objects retain their original size
when the display size changes. For example, if the display was
resized to one quarter its original size, only one quarter of the
display would be visible. In this case scroll bars appear for viewing
the rest of the display.

Click Scale to resize the display so objects in the display are


magnified or reduced, to maintain their size in relation to the
display size. For example, if the display was resized to one quarter
its original size, the entire display would be visible—but it would
all be one quarter its original size.

15--22 ■ RSView Supervisory Edition User’s Guide


Specifying display position

To set the display position, do one of the following:

click Use Current Position. When you save the graphic display,
the position of the window at that time becomes the default
position.

click Specify Position in Pixels and then type values in the X and
Y boxes. These boxes specify the position of the window in
relation to the top-left corner of the RSView main window. The
x-value positions the window from the left edge of the main
window and the y-value positions the window from the top of
the main window.

The window size and position you specify here can be overridden
by the RSView Display command. The Display command accepts
size and position parameters, which override the Display Settings
options. For more information about the Display command, see
Appendix A, RSView commands, or see Help.

Specifying a security code

To restrict access to the graphic display, select a security code. For


detailed information about security, see Chapter 14, Adding
security.

Specifying background color

To select a background color, click the Background Color box, and


then click a color in the palette. 4.

Creating graphic displays ■ 15--23


Preface
Setting up display behavior
The Behavior tab
lets you set up how
objects in the
graphic display
behave at run time.

On the Behavior tab, you can specify:

startup and shutdown commands

colors for input fields

behavior of interactive objects

behavior of objects with input focus

launching an on-screen keyboard, for systems that don’t have a


hardware keyboard attached to them at run time

15--24 ■ RSView Supervisory Edition User’s Guide


Specifying startup and shutdown commands

Type commands or
macros in the Startup and
Shutdown boxes, or click
the ... (Browse) buttons to
open the Command
Wizard, and then select
the commands or macros.

To run RSView commands or macros each time this graphic display


starts or stops, specify the commands or macros.

The startup command runs before the graphic opens, so commands


such as UploadAll or RecipeRestore will not work in a startup
macro.

The shutdown command runs after the display closes, so commands


such as DownloadAll or RecipeSave will not work in a shutdown
macro.

If you use the Always Updating option with the Cache After
Displaying option, the startup command is executed when the
display is loaded into the cache. The shutdown command is
executed only when the cache is flushed (using the FlushCache
command) or when you stop the application.

If you do not use the Always Updating option, the startup and
shutdown commands work normally, as described above.

For a complete list of RSView commands, see Appendix A, RSView


commands, or see Help.

Creating graphic displays ■ 15--25


Preface
Specifying colors for input fields5.

Input fields are created with the Numeric Input, String Input, and
Recipe drawing tools. At run time, operators can use these fields to
read values from or write values to the programmable controller. To
open the color palette click a colored box, and then click a color.

Text color is the color of the text in the input field. Background
color is the background color of the input field.

When choosing colors for the input fields, be sure to choose colors
that will stand out from the background color of the display.
Choose different colors for when the field is selected, so the
operator can tell that the field is highlighted.

Specifying the behavior of interactive


objects

Interactive objects are those that the operator can interact with at
run time, using a mouse, keyboard, or touch screen. For example, a
button that has a press action is interactive.

You can create a tab sequence for interactive objects that use index
numbers. For details, see “Creating a tab sequence” on page 16-57.

15--26 ■ RSView Supervisory Edition User’s Guide


Beep on Press

Select this check box if you want the computer to beep when a
button object or an object with touch animation is clicked.

Highlight When Cursor Passes Over It

Select this check box to turn on the highlight for interactive objects.
Click the colored box to open the color palette and then choose the
highlight color. At run time, when the mouse cursor is over an
interactive object, the object will be highlighted.

When choosing a highlight color, be sure to choose a color that


stands out from the display’s background color.

Specifying the behavior of objects with


input focus

When an object has input focus—that is, the object is ready to


accept keyboard or mouse input—the object will have a highlight
box. You can enable or disable this highlight box, and select the
color of the box.

When choosing a highlight color, be sure to choose a color that


stands out from the display’s background color.

Creating graphic displays ■ 15--27


Preface
The following illustration shows the two types of highlight:

This object is an
interactive object, but it is
not the object with input
focus.

This object is the one with


focus—as indicated by
the cursor. The highlight
box is a different color
than the highlight box for
the interactive object.

An object can have both types of highlight at one time.

Displaying the on-screen keyboard

Select this option to display a keyboard on the screen at run time


for numeric input, string input, and recipe fields in the graphic
display. The keyboard appears only when an operator selects one of
these fields for input. The on-screen keyboard is typically used with
systems that do not have a hardware keyboard, such as systems that
use touch screens only.

This field is selected for input.

When the operator clicks or touches the selected field, or presses


Enter on a hardware keyboard, the on-screen keyboard appears.

15--28 ■ RSView Supervisory Edition User’s Guide


The keyboard for string input and recipe fields allows alphanumeric
entry.

The keypad for numeric input fields allows numeric entry only.

Creating graphic displays ■ 15--29


Preface
Displaying graphics more quickly

Graphic displays appear more quickly if they have been stored in


the display cache. You can place up to 40 graphic displays in the
cache.

To cache displays:

click the Cache After Displaying option in the Display Settings


dialog box. For details, see page 15-17.

use the [cache] parameter with the Display command. The


[cache] parameter loads a graphic display into the cache without
displaying it. The [cache] parameter has two options: /Z and
/ZA. For example, the command Display Bakery /Z loads the
graphic display called Bakery into the cache but does not
display it. When the graphic is called up, it is displayed quickly.
The command Display Bakery /ZA loads the display into the
cache and continually updates the values in the display. For
details about the Display command, see Appendix A, RSView
commands, or see Help.

Removing displays from the cache

To remove all graphic displays from the display cache, use the
FlushCache command. To remove a specific graphic display from
the display cache, use the FlushCache <file> command. Graphic
displays are also removed from the cache when an RSView
SE Client is closed.

If a display uses the Always Updating option with the Cache After
Displaying option, the display’s shutdown command is executed
when you issue a FlushCache command, or when you close the
application. For details about the FlushCache command, see
Appendix A, RSView commands, or see Help.

15--30 ■ RSView Supervisory Edition User’s Guide


Types of graphic objects
You can create the following types of objects:

Drawing objects: geometric and freehand objects, images,


panels, and text. These objects are the only ones that do not
require data configuration.

Push buttons: objects that are typically used to start or stop


processes or actions.

Numeric and string: objects for entering or viewing numbers or


text in a graphic display.

Indicator: objects that allow an operator to make a selection


from a number of possible choices, all of which are visible at
once.

Gauge and graph: objects that show the range of values, and
relationships between variables.

Key: objects that represent keys on a keyboard, and are for use
with touch screens.

Advanced: objects, such as trends and alarm summaries, that


allow you to view and analyze the data in your system.

OLE objects: objects such as spreadsheets, charts, or text


produced by other Windows applications. The types of OLE
objects that are available depend on the software installed on
your system.

ActiveX objects (formerly called OLE custom controls or OCX’s):


control objects such as gauges, sliders, and buttons, and objects
you create yourself using a tool like Visual Basic. These objects
allow an external action, such as a mouse click, to initiate an
action within RSView. The ActiveX objects that are available
depend on the software installed on your system.

Most objects, including OLE objects, can have animation attached to


them. For more information, see Chapter 16, Animating graphic
objects.

Creating graphic displays ■ 15--31


Preface
Creating drawing objects
To draw simple objects—for example, lines, rectangles, and
ellipses—use the drawing tools on the Objects toolbar, or on the
Objects menu.

Once you have selected a drawing tool, there are two ways to draw
objects: dragging, or clicking end points. Some objects, such as
rectangles, ellipses, and arcs, can be drawn only by dragging.
Others, such as polylines and polygons, can be drawn only by
clicking end points.

Creating text

Text tool 1. Click the Text tool.

The pointer becomes an I-beam ( ).

2. Type the text.

Once the Text tool is selected, you can create more than one text
object. To do so, move to an empty spot in the drawing area,
click, and then type the text.

To edit text, select the text object and then double-click it. The
I-beam appears. To delete characters, use the Backspace and
Delete keys.

You cannot rotate text.

Choosing a font

You can choose a font before or after you create text. You can
change the font of any object, including display and input objects.

When choosing a font, style, size, and color for text on the screen,
keep the following design principles in mind:

If possible, choose a font that was deliberately designed for


on-screen viewing. Examples include Arial, Arial Narrow, Nina,

15--32 ■ RSView Supervisory Edition User’s Guide


Trebuchet MS, and Verdana. You can download these, and more
fonts free of charge, from the Microsoft Typography web site.

Choose only one or two fonts, and use them for all the graphic
displays in your application.

Choose a font size that most operators can read easily. Test the
font size, and adapt it to the screen resolution you expect
operators to be viewing at run time.

If you are short of screen space, rather than reducing the font
size, keep the size the same, but use a condensed font that fits
more characters per line, for example, Arial Narrow.

Sans-serif typefaces are easier to read at small sizes and lower


resolutions on the screen than serif typefaces. For example, for
normal text, use Arial rather than Times New Roman.

At normal text sizes, roman type is easier to read than italics.

Use high-contrast color combinations, such as yellow on blue,


rather than low-contrast combinations like black on green.

Use colors with recognizable meanings. For example, in the


Western world the colors red and green often mean stop and
start. Keep color meanings consistent by assigning red only to
Stop buttons, and green only to Start buttons.

Some people are color blind to red and green so don’t rely on
color alone to establish meaning.

Ensure that the fonts you choose for your graphic displays are
installed on all the computers on which you intend to run the
graphic displays. If a font is not installed, Windows substitutes
one that is installed, possibly with unsatisfactory results.

For more design suggestions, see Chapter 3, Planning an


application, and the sample files included with RSView Studio.

Creating graphic displays ■ 15--33


Preface
To change the text font:

1. Click the Text tool and then type the text.

2. Select the text object or objects you want to format.

3. Open the Text Properties dialog box by doing one of the


following:

right-click the text and then click Properties on the shortcut


menu

on the Edit menu, click Properties

4. Select the font style, size, and color you want.

IMPORTANT You can select any font you have installed, but
TrueTypet, OpenTypet, or Type 1 fonts are
recommended. These fonts can be resized with
graphic scaling.

5. Click OK.

You can also choose a font color using the Foreground Color
palette.

For access to a wider


range of font settings,
click here.

15--34 ■ RSView Supervisory Edition User’s Guide


Font substitution at run time

At run time, if the computer on which the RSView SE Client is


running does not have the fonts you used when setting up the
display, Windows will substitute fonts.

Adding an image to a graphic display

RSView can read .bmp files in their native format, without


requiring their conversion. For information about importing
graphic files in formats other than .bmp, see “Importing graphic
files from third-party applications” on page 15-290.

For information about choosing graphic file formats for best


performance, and for more information about bitmap files, see
“Using bitmaps” on page 15-292.

There are three ways to add an image to a graphic display. You can:

paste an image you copied from another application to the


Windows Clipboard. For information about pasting images, see
“Pasting images into graphic displays”, below.

place an image you want to use repeatedly in several displays.


For information about placing images in graphic displays, see
page 15-36.

import an image that is not in the Windows .bmp bitmap


format. When you import an image, RSView converts .gif, .tif,
.pcx, and .jpg images to the Windows .bmp format. Vector
images in .dxf and .wmf formats are converted to native RSView
graphic objects. For information about importing images, see
“Importing graphic files from third-party applications” on
page 15-290.

Creating graphic displays ■ 15--35


Preface
Pasting images into graphic displays

To add an image you copied to the Windows Clipboard from


another application, use Paste Special to paste the image into a
graphic display.

Images you copy, you can only paste into graphic displays for as
long as they remain on the Windows clipboard—that is, until you
next cut or copy something.

To paste an image into a graphic display:

1. Copy the image onto the Windows clipboard.

2. Click the graphic display into which you want to paste the
image.

3. On the Edit menu, click Paste Special.

4. In the Paste Special dialog box, click the Bitmap format.

For best performance, do not use the Device Independent


Bitmap format.

5. Click OK.

Placing images in graphic displays


Image tool
To add an image you want to use repeatedly in several displays, add
the image to your application using either the Image tool or by
adding images to the Images list in the Application Explorer.

Use the image tool to place bitmap images in your displays. If the
image you want to place in a graphic display is not a bitmap image,
you must use image editing software to convert it to the Windows
bitmap format (*.bmp) before you can place it in a graphic display.

15--36 ■ RSView Supervisory Edition User’s Guide


To place an image in a display, you must add the image to your
application. You can add an image to your application:

when you place it in a graphic display, or

before you place it in a graphic display

For information about adding images in the Image Browser or


Application Explorer without simultaneously placing them in
graphic displays, see “Adding images to your application” on
page 15-40.

If the image is monochrome (1 bit per pixel, 2 colors), you can


change its color, background color, transparency, and you can make
it blink at run time.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

To place an image in a display:

1. In the Graphics Display editor, do one of the following:

click the Objects menu, point to Drawing, and then click


Image

in the toolbar, click the image tool


Image tool

2. Drag the mouse diagonally until the image is the size you want.

3. Double-click the image to set it up.

Creating graphic displays ■ 15--37


Preface

To select an image, click


the Browse button.

4. In the Image Properties dialog box, type the name of the image
file you want to use, or click the Browse button to browse for
the image.

To browse for an image using the Image Browser, click the


Browse button.
Browse button

If the image you want is


not in the list on the left,
click Add to select an
image file from disk.

You can only select


bitmap image files
(*.bmp).

5. Click an image in the list on the left, and then click OK.

15--38 ■ RSView Supervisory Edition User’s Guide


6. Change the image settings:

Image back style The image can be solid or transparent.

Click Solid to cover the background. Click Transparent to allow


the background to show through.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will
become transparent when you change the Image back style to
Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot
change the color of grayscale or color images.

Image back color Click the colored square to open the color
palette, and then click a color for the background of a
monochrome image. You cannot change the background color
of grayscale or color images.

Image blink Select the check box to make a monochrome


image blink at run time. Clear the check box to prevent the
image from blinking at run time. You cannot make grayscale or
color images blink.

7. When you are finished, click OK.

Creating graphic displays ■ 15--39


Preface
Adding images to your application

Images that you add to your application, you can add to graphic
displays over and over again. If you modify the image, the modified
image appears automatically in all the graphic displays that use the
image.

When you add an image using the Image Browser, the image also
appears in the Application Explorer automatically, and vice versa.

To add an image using the Image Browser:

1. In the Image Browser, click Add.

2. In the Open dialog box, select the folder in which the image you
want is located.

3. Click the image file, and then click Open.

To add an an image using the Application Explorer:

1. In the Application Explorer, right-click Images, and then click


Add Component Into Project.

2. In the Open dialog box, select the folder in which the image you
want is located.

3. Click the image file, and then click Open.

15--40 ■ RSView Supervisory Edition User’s Guide


Creating a panel

Use the panel tool to draw rectangles and squares that have borders.

Panel tool Panels are useful for color-coding areas of a graphic display that
contain similar information. For example, if you have numeric
input and display objects for A and B on the same display, you can
color code them to help the operator distinguish the A’s from
the B’s.

You can set up panel objects to blink at run time. The panel object
does not support animation, so you cannot make it blink or move in
response to a tag’s value.

To create a panel:

1. In the Graphics Display editor, do one of the following:

click the Objects menu, point to Drawing, and then click


Panel

click the Panel tool in the toolbox

2. Drag the mouse diagonally until the panel is the size you want.

To draw a square panel, press Ctrl while you drag the mouse.

3. Double-click the panel to set it up.

Creating graphic displays ■ 15--41


Preface

4. In the Panel Properties dialog box, specify how you want the
panel to look.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change


the thickness of the panel’s border. Border width is measured in
pixels.

Back style The panel can be solid or transparent. Click Solid to


cover the background. Click Transparent to allow the
background to show through.

Pattern style The panel’s background can have a pattern. Click


a pattern in the list, or click None to remove the pattern. If the
Back style is Transparent, the pattern is not visible.

Border uses back color Select the check box if you want the
panel’s border to have the same color as the panel’s background.

Clear the check box if you want the panel’s border to have a
different color than the background, and then choose a Border
color. For details, see below.

15--42 ■ RSView Supervisory Edition User’s Guide


Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Back color Click the color box to open the palette, and then
click a color for the panel’s background.

Border color Click the color box to open the palette, and then
click a color for the panel’s border.

You can only change the border color if you clear the Border
uses back color check box.

Blink Select the check box to make the panel blink at run time.
Clear the check box to prevent the panel from blinking at run
time.

5. When you are finished, click OK.

Drawing a rounded rectangle

Rounded rectangle tool Use the Rounded Rectangle tool to draw a rectangle with rounded
corners.

1. Click the Rounded Rectangle tool.

2. Drag the drawing tool diagonally until the object is the size you
want.

You can change a rounded rectangle into a right-angle rectangle


by using the small black box that appears inside the rounded
rectangle. Place the pointer on the box and drag the drawing
tool until the rectangle is the desired shape.

For details about changing a rounded rectangle’s properties see


“Changing the properties of drawing objects” on page 15-48.

Creating graphic displays ■ 15--43


Preface
Drawing a rectangle or square

Rectangle tool Use the Rectangle tool to draw a rectangle or square.

1. Click the Rectangle tool.

2. To draw a rectangle, drag the drawing tool diagonally until the


object is the size you want.

To draw a square, press Ctrl while you drag the mouse.

For details about changing the properties of a rectangle or square,


see “Changing the properties of drawing objects” on page 15-48.

Drawing an ellipse or circle

Ellipse tool Use the Ellipse tool to draw an ellipse or circle.

1. Click the Ellipse tool.

2. To draw an ellipse, drag the drawing tool diagonally until the


object is the size you want.

To draw a circle, press Ctrl while you drag the mouse.

For details about changing the properties of an ellipse or circle, see


“Changing the properties of drawing objects” on page 15-48.

15--44 ■ RSView Supervisory Edition User’s Guide


Drawing a line

Line tool Use the Line tool to draw straight lines in any direction.

1. Click the Line tool.

2. Drag from the beginning point to the end point.

To draw horizontal or vertical lines (not diagonal lines), hold


down Ctrl while you drag the mouse.

You can also use the Snap to Grid option to draw straight lines.

You can change the style and width of lines using Line Properties
dialog box. For details, see page 15-288.

Drawing a polyline or polygon

Polyline tool A polyline is a series of connected line segments. A polygon is a


closed polyline shape.

Polygon tool

Polyline Hollow Polygon Filled Polygon

1. Click the Polyline or Polygon tool.

2. Drag the drawing tool to create the first segment of the object.
Release the mouse button.

To draw horizontal or vertical lines (not diagonal lines), hold


down Ctrl while you drag the mouse.

Creating graphic displays ■ 15--45


Preface
3. Move the drawing tool to where you want the angle of the
polyline or polygon to be and then click the left mouse button.

Repeat this step until you have completed the object.

4. To finish drawing, click the Select tool.

For details about changing the properties of a polyline or polygon,


see “Changing the properties of drawing objects” on page 15-48.

Drawing a freehand object

Freehand tool Drawing freehand is similar to drawing with a pen on paper.

1. Click the Freehand tool.

2. Drag the drawing tool to create the shape you want.

For details about changing the properties of a freehand object, see


“Changing the properties of drawing objects” on page 15-48.

Drawing an arc or wedge


Arc tool
Arcs and wedges are drawn in two steps: first you create an ellipse
or circle, and then you reshape the ellipse or circle.

Wedge tool To draw the arc or wedge in 45-degree increments, hold down Ctrl
while you draw.

Arc Hollow Wedge Filled Wedge

15--46 ■ RSView Supervisory Edition User’s Guide


To draw an arc or wedge:

1. Click the Arc or Wedge tool.

2. Drag to draw a circle. Release the mouse button.

When you release the mouse button, a set of handles appears so


you can reshape the circle.

3. Click a handle, and drag the mouse to ‘cut out’ part of the circle.

You can also use the Arc and Wedge tools to reshape any arc,
ellipse, or wedge.

For details about changing the properties of an arc or wedge, see


“Changing the properties of drawing objects”, next.

Creating graphic displays ■ 15--47


Preface
Changing the properties of drawing objects

You can change the properties of any of the drawing objects in


several ways:

in the object’s Properties dialog box. For details, see the topics
in this section.

in the Property Panel. For details about using the Property


Panel, see page 15-258.

using the toolbars for Foreground and Background color, and


Pattern style. For details, see the topics starting on page 15-285.

To open an object’s Properties dialog box:

1. Select the object. For details about the ways you can select
objects, see page 15-266.

2. Right-click the object, and then click Properties on the shortcut


menu.

All of the drawing objects


except the Text, Image,
and Panel objects have
the same properties. Line
objects have no pattern.

15--48 ■ RSView Supervisory Edition User’s Guide


3. In the object’s Properties dialog box, specify how you want the
object to look.

Line style Click a style for the line. Line styles are available
only when the line width is 1.

The styles are:

Solid

Dash

Dot

Dash-Dot

Dash-Dot-Dot

Fore color Click the color box to open the palette, and then
click a color for the object’s foreground.

Line width Type a number between 1 and 32767 to change the


thickness of the line. Line width is measured in pixels.

Back style The object can be solid or transparent. Click Solid


to cover the background. Click Transparent to allow the
background to show through.

Back color Click the color box to open the palette, and then
click a color for the object’s background.

Pattern style The object’s background can have a pattern.


Click a pattern in the list, or click None to remove the pattern.
If the Back style is Transparent, the pattern is not visible.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

4. When you are finished, click OK.

Creating graphic displays ■ 15--49


Preface
Reshaping drawing objects
You can easily reshape any drawing object.

To reshape lines, rectangles, polylines, and polygons:

1. Place the pointer on the object you want to reshape and then
double-click the object, or right-click the object and then click
Edit.

The cursor changes to the Polygon tool.

2. Move the cursor over any line in the object.

A handle with a cross-hair appears.

3. Drag the handle until the object is the desired shape.

To maintain the aspect ratio of any object while resizing, grab a


corner handle, press Shift, and then drag the mouse.

To reshape arcs, ellipses, and wedges:

1. Place the pointer on the object you want to reshape and then
double-click, or right-click and then click Edit Object.

The cursor changes to the Arc or Wedge tool, and handles


appear on the object.

2. Place the pointer on one of the handles. A cross-hair appears.

3. Drag the handle until the object is the desired shape.

15--50 ■ RSView Supervisory Edition User’s Guide


Creating objects that use data

Objects that use data are called interactive objects, because the
operator can interact with them at run time using a mouse,
keyboard, or touch screen. For example, a button that has a press
action, or a numeric input object are both interactive.

To create interactive objects, use the drawing tools on the Objects


Use these items on the toolbar, or the items other than Drawing objects on the Objects
Objects menu to create menu.
objects that can be
supplied with data at run The basic steps are:
time.

1. Click a drawing tool, and then drag the cursor to create a box
approximately the size you want the object to be.

2. For some objects you will need to double-click the object to set
it up. For other objects, a properties dialog box appears
automatically.

3. Set up the object by entering the required information.

Most interactive objects display information about a tag.


Therefore, as part of configuration, you must supply a tag name
or tag placeholder.

Objects described in other chapters

Detailed information about setting up some of the interactive


objects is located in other chapters. The following table lists where
you can find the information:

To set up this object See

Alarm Summary page 10-60

Trend Chapter 17, Setting up trends

Creating graphic displays ■ 15--51


Preface
Using tag names

At run time, interactive objects obtain data from tags. When


creating interactive objects, you must specify the name of the tag
that supplies the object with data at run time. 4.

To supply a tag name:

" Do one of the following:

type a tag name in a Tag Name box or in an Expression box

click the Browse button and then click a tag name in the list

Browse button

Using tag placeholders

Tag placeholders can save you time by providing a way for you to
use a single graphic display for several similar operations. 5.

For example, imagine you are creating displays for a plant that cans
corn and beans. The machinery used in both processes is identical.
Instead of drawing two displays and then specifying corn-related
tags in one display and bean-related tags in another, you can create
one display and not specify any tag names. Where a tag name is
required, type a tag placeholder instead.

When the display runs, the placeholders must be replaced with tag
names. This can be done in two ways: with a parameter file, or by
specifying the tag names as parameters to the Display command.

15--52 ■ RSView Supervisory Edition User’s Guide


Creating a tag placeholder

A tag placeholder is the cross-hatch character ( # ) followed by a


number from 1 to 500, as shown in the following example:

If you are using an HMI tag, you can also add a folder name to the
placeholder. For example, #1\PV is a valid placeholder and requires
only one parameter (the folder name).

For tag placeholders in alarm summary objects, you can use


wildcards in the placeholder. For example, #1\PV* is a valid
placeholder.

Creating graphic displays ■ 15--53


Preface
Replacing tag placeholders using a
parameter file

A parameter file contains one entry for each unique placeholder in a


graphic display. When you run a display, you add to the Display
command the /P parameter and the name of the parameter file.6.

For details about the Display command, see Appendix A, RSView


commands, or see Help.

To create a parameter file:

1. Open the Parameters editor.

2. Type one entry for each unique placeholder in the graphic


display, associating the placeholder with a tag name. For
example:

#1 = bean_weight
#2 = bean_level
#3 = bean_temp

3. Save the file with a meaningful name (for example, Beans).

For tag placeholders in alarm summary objects only, you can use
wildcards in the parameter file. For example, #1 = bean_* is a valid
parameter entry. The alarm summary would display any alarms
associated with tags beginning with bean_.

You cannot use wildcards in placeholders for any objects other than
alarm summaries.

15--54 ■ RSView Supervisory Edition User’s Guide


To run a parameter file:

" Type the following command in a macro, or anywhere else you


can use an RSView command:

Display <component> [/Pcomponent]

where:

<component> is the name of the graphic display.

[/Pcomponent] is the parameter component containing the tags


to be substituted into the display.

Example: Replacing tag placeholders using a parameter


component

To run the display called Canning with the parameter component


called Beans, type:

Display Canning /PBeans

Creating graphic displays ■ 15--55


Preface
Replacing tag placeholders using
parameters to the Display command

When you run a graphic display, instead of using a parameter


component you can replace tag placeholders using the /T parameter
with the Display command.

To replace tag placeholders using the Display command:

" Type the following command in a macro or anywhere else you


can use an RSView command:

Display <component> /T[tag_name]

where:

<component> is the name of the graphic display component.

/T[tag_name] is the name of one or more tags to be substituted


for placeholders in the graphic display. If you are specifying the
names of HMI tags, you can also include their folder names.
Separate multiple tag names with commas; do not use spaces.

For tag placeholders in alarm summary objects only, you can use
wildcards when you specify tag names on the command line.

Example 1: Replacing tag placeholders by listing tag names

To run the display called Canning with the tags Pea_Weight,


Pea_Level, and Pea_Temp, type:

Display Canning /TPea_Weight,Pea_Level,Pea_Temp

15--56 ■ RSView Supervisory Edition User’s Guide


Example 2: Replacing tag placeholders by using a folder name

In the following example, the tag database contains these tags:

Corn\Weight Bean\Weight

Corn\Level Bean\Level

Corn\Temp Bean\Temp

Anywhere a tag name is required, the placeholder #1 is used for the


folder name. That is, all objects that use these tags would be set up
using the folder placeholder and the tag name: #1\Weight, #1\Level,
or #1\Temp.

To run the display called Canning with the folder containing corn
tags, type:

Display Canning /TCorn

To run the display called Canning with the folder containing bean
tags, type:

Display Canning /TBean

Creating graphic displays ■ 15--57


Preface
How to use push buttons

Push buttons start or stop processes or actions by changing tag


values.

IMPORTANT Never use push buttons for emergency stops.


Emergency stop buttons must always be hard-wired.

You can create different kinds of push buttons, depending on your


needs:

Buttons can run RSView commands, or they can work like


momentary push buttons.

Momentary push buttons change a tag to one value when the


button is pressed, and another value when the button is released.
Momentary push buttons work like the Pulse button on a food
processor, but with an indicator light to signal whether the motor is
running or stopped. The machine is on only while the button is
held down. When the button is released, the machine turns off.
Momentary push buttons are useful for jogging a motor, and they
can be set up to start and stop a machine or process.

Maintained push buttons toggle between two values. This type of


button is useful for changing a setting within a machine or process,
but not for starting the machine or process. For example, use the

15--58 ■ RSView Supervisory Edition User’s Guide


maintained push button for changing modes, such as Auto to
Manual, or Metric to Imperial.

Latched push buttons latch in the on position, and must be


unlatched by another button or process to return to the off
position. This type of button is useful for starting a machine or
process.

Multistate push buttons allow an operator to cycle through


multiple options consecutively, using a single button. The current
state of a process or operation is displayed on the button by a
different color, caption, or image for each state.

Interlocked push buttons work in groups, and share the same tag.
The buttons work together like the preset station selector buttons
on a car radio: pressing one button cancels another. Although
interlocked push buttons work as a group, you add them to the
display one at a time.

Ramp push buttons increase or decrease the value of a tag by either


an integer or floating point value. You can use two ramp buttons
together to create an increase/decrease control, for example for the
speed of a motor.

Creating graphic displays ■ 15--59


Preface
Setting up push buttons

Once you have created a push button, you need to set it up using its
Properties dialog box. You can open a push button’s Properties
dialog box at any time by double-clicking the push button.

In the Properties dialog box, the various features of push buttons


are organized in tabs. Most push buttons have at least three tabs: a
General tab, a States tab, and a Connections tab.

The General tab contains basic settings for the button, such as its
shape, the size of its border, and whether it is solid or transparent.

15--60 ■ RSView Supervisory Edition User’s Guide


The States tab contains settings for what the button does, and how
its appearance changes, for example when the button is pressed or
released.

The Connections tab contains the tags or expressions the button is


connected to. Some buttons write to tags, and some read tag values.
Some do both.

How to use the States tab for push buttons

You define a button’s action, and set up its appearance for each
state on the States tab of the button’s Properties dialog box.

Creating graphic displays ■ 15--61


Preface
Most buttons have three states:

State 0, the default state

State 1, a state triggered by pressing the button, or by a changing


tag value

an error state, in which the button is receiving invalid data

Exceptions

Button push buttons have no states. They have Press and


Release actions, an Up Appearance and a Down Appearance.
For details about setting up a Button push button, see
page 15-66.

Ramp push buttons have no states; they can only ramp a value
up or down.

Interlocked push buttons have no error state.

Multistate push buttons have two states by default, but you can
add more states, to add up to 255 functions to the button.

15--62 ■ RSView Supervisory Edition User’s Guide


How to use the Connections tab for
push buttons

To connect with a device such as a programmable controller, push


buttons use tags. You set up these tags on the Connections tab of
the button’s Properties dialog box.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Most push buttons have two tags for sending and receiving data:

the Value tag triggers the button’s action, for example starts a
machine or process. The Value tag is similar to the contact on a
hard-wired push button.

the Indicator tag changes the button’s appearance, depending on


its state, providing visual feedback to the operator. For example,
the Indicator tag can show that the motor the button is
connected to, is running or stopped. The Indicator tag is similar
to a light-emitting diode (LED) on a hard-wired push button.

Exceptions

Button push buttons have no Value or Indicator tags. Instead of


a Value tag, they have Press and Release actions. Instead of an
Indicator tag, they have an Up Appearance, and a Down
Appearance. For details about setting up a Button push button,
see page 15-66.

Latched push buttons have an additional tag called the


handshake tag. Use the handshake tag to unlatch the Latched
push button. For details, see page 15-102.

Creating graphic displays ■ 15--63


Preface
The Ramp push button has no Indicator tag, because it has no
states, and can only ramp a tag’s value up or down. The Ramp
push button’s appearance never changes.

Interlocked push buttons have no Indicator tag, because they


perform a single function only, and cannot indicate the status of
a machine or process. Their appearance never changes.

How the Value tag works

The Value tag can be changed in two ways:

when the operator presses the button

when another process changes the tag’s value in the


programmable controller. If this happens, the button might
behave in ways you might not immediately expect.

For example, a maintained push button toggles a tag’s value. If


the tag’s value is zero, when the operator presses the button the
tag’s value changes to 1.

If another process changes the tag’s value back to zero, the next
time the operator presses the button, the tag’s value changes to 1
again, instead of changing to zero.

For most push buttons, the Value tag is a read-write tag. There are
two exceptions:

the Value tag of momentary push buttons is a write-only tag.


The button cannot change its state based on a change to the
value of this tag.

Button push buttons have no Value tags. Instead, they have an


Action tag. Button push buttons work like Momentary push
buttons, so their Action tag is a write-only tag.

15--64 ■ RSView Supervisory Edition User’s Guide


How the Indicator tag works

The Indicator tag changes the button’s appearance, for example


from green to red, or from the word ‘Start’ to ‘Stop’. However, the
value of the Indicator tag does not necessarily change when the
operator presses the button.

For example, a hard-wired push button’s LED shows whether a


motor is running or not, not whether the button is pressed or not.
This is advantageous because the button can show that a machine or
process did not start or stop, even though the operator pressed the
corresponding button.

If you assign the same tag name to the Value tag and to the
Indicator tag, the button’s appearance will change when the
operator presses the button. If you assign different tag names to the
Value and Indicator tags, the button’s appearance will change only
when the value of the Indicator tag changes.

For those buttons that have an Indicator tag, the tag is always a
read tag.

Creating push buttons


To create push buttons, use the items on the Objects menu, or their
equivalents in the Objects toolbar. To show the objects toolbar,
click the View menu, point to Toolbars, and then click Objects.

Creating graphic displays ■ 15--65


Preface
Creating Buttons
Use the Button tool to create push buttons that work like standard
Windows buttons. You can attach RSView commands to the
buttons so they trigger actions when pressed and released.
Button tool
You can apply visibility, color, horizontal and vertical slider,
horizontal and vertical position, width, and height animation to the
button.

To create a button:

1. Click the Button tool.

2. Drag the mouse to draw a button the size you want, and then
release the mouse button.

3. Fill in the fields on each tab to set up the button’s appearance


and what it does, as described in the sections that follow. When
you are finished, click OK.

15--66 ■ RSView Supervisory Edition User’s Guide


Setting up the button’s appearance, and how
it works at run time

1. In the General tab, click a button style.

3D, Recessed, and Raised styles can be used only for


rectangular-shaped buttons. The Beveled style supports
rectangular and polygonal shapes. If you change a 3D, recessed,
or raised button to another shape, or if you rotate it, the button
automatically changes to beveled.

The highlight and shadow colors on the beveled button use the
current system settings.

To reshape a button, click to select it, click the Polygon tool and
then move or add vertices as you would for any other polygonal
shape.

2. To prevent the cursor from moving off the button until the
button’s release action is carried out, select the Capture cursor
check box. Use this feature when you need to ensure that a
button’s release action is carried out.

If the Capture cursor check box is not selected, the button will
behave like a standard Windows button, allowing the user to
‘cancel’ the button’s release action by holding the mouse button
down while moving the cursor off the button.

3. If you want the button to be highlighted when it has focus,


select the check box, Highlight when object has focus.

IMPORTANT The check box, Disable Highlight When Object has


Focus, on the Behavior tab of the Display Settings
dialog box, overrides this Highlight setting.

4. In the Tab index box, either leave the default value or type a
new value. Index numbers determine the tab sequence for
interactive objects such as buttons and input fields and are also
used in recipe components. For details, see “Using index
numbers” on page 16-54.

Creating graphic displays ■ 15--67


Preface
Setting up the button’s actions

On the action tab, click an action in the list, and then specify what
happens when the action occurs.:

Set tag to 1 Sets the specified tag to 1 when the button is released
(mouse down = no action, mouse up = Set <tag name> to 1).

Set tag to 0 Sets the specified tag to 0 when the button is released
(mouse down = no action, mouse up = Set <tag name> to 0).

Toggle tag value Sets the specified tag to 0 or 1 depending on its


current state. If the tag’s value is 0, the tag is set to 1 when the
button is pressed. If the tag’s value is any non-zero value, the tag is
set to 0 when the button is pressed.

15--68 ■ RSView Supervisory Edition User’s Guide


Set tag to 1 on press and to 0 on release Sets the specified tag
to 1 when the button is pressed (mouse button is pressed and held
down), and sets the tag to 0 when the button is released (mouse
button is released).

Set tag to 0 on press and to 1 on release Sets the specified tag


to 0 when the button is pressed (mouse button is pressed and held
down), and sets the tag to 1 when the button is released (mouse
button is released).

Run command Runs the specified RSView command or macro. In


the Press action box, Repeat action box, or Release action box, type
Browse button an RSView command or macro, or click the Browse button to open
the Command Wizard.

You must specify either a press or release action; both are not
required. If you specify a repeat action, the action is repeated at the
rate specified in the Repeat rate box, for as long as the mouse
button is held down.

Pressing the Enter key does not cause a repeat action to be executed
because Windows interprets this as a series of press actions, so the
repeat action is not carried out. The Enter key works for the press
and release actions only.

Creating graphic displays ■ 15--69


Preface
Setting up what the button looks like when
it is not pressed

On the Up Appearance tab, specify what the button looks like


when it is not pressed.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Pattern style Click a pattern style for the button. If the Back style
is Transparent, the pattern is not visible.

Fore, Back, and Pattern color Click the corresponding color box
to open the palette, and then click a color in the palette.

15--70 ■ RSView Supervisory Edition User’s Guide


Caption Type a caption for the button. To change the caption’s
font or size, click a font or size in the corresponding list.

To change the font’s attributes, such as boldface, italic, or underline,


click the corresponding button.

Image settings You can reference or import a bitmap (.bmp) or


icon (.ico) image that appears at the center of the button. If you add
a caption to the button, it appears on top of the image.

An image you reference is not saved with the graphic display. You
should reference images that are large in size, but stored on the
same computer as the graphic display.

An image you import is saved with the graphic display. You should
import small images, or images on other computers on the network.
If you import images that reside on other computers on the
network, they don’t have to be sent across the network every time
the graphic display is opened. This helps reduce network traffic.

To scale the image to fit the surface of the button, select the Scale
image check box. To keep the image at its original size, leave the
Scale image check box cleared.

If the button is a polygon, the caption and imported bitmap image


are clipped at the rectangular extents of the button.

Creating graphic displays ■ 15--71


Preface
Setting up what the button looks like when
it is pressed

On the Down Appearance tab, specify what the button looks like
when it is pressed.

If you want the button to appear the same when it is pressed as


when it is not pressed, click Same as “Up Appearance”. If you want
a different appearance for the button, choose different options. For
details about the options, see “Up Appearance,” above.

Editing a button

To edit a button, double-click the button to open the Button


Properties dialog box.

For details about the button’s properties, see the topics starting on
page 15-67.

15--72 ■ RSView Supervisory Edition User’s Guide


Reshaping a button

If you reshape or rotate a button, the button type always changes to


beveled. Only beveled buttons can be a polygon (or
non-rectangular) shape.

To reshape a button, click the button to select it, and then click the
Polygon tool. Move or add vertices as you would with any
polygon. For details about reshaping polygons, see page 15-50.

Creating momentary push buttons

For some important definitions, and to understand how push


buttons work, see “How to use push buttons” on page 15-58.

Use the momentary push button tool to create a button that starts a
process or action. When pressed, momentary push buttons change a
tag to one value, and when released, they change a tag to another
Momentary push button
tool
value.

The momentary push button’s states can perform one of three kinds
of actions:

change the Value tag to 1 when the button is pressed, and to


zero when the button is released. This kind of button is called
normally open, because its released state is off. Pressing the
button completes the circuit.

change the Value tag to zero when the button is pressed, and to
1 when the button is released. This kind of button is called
normally closed, because its released state is on. Pressing the
button breaks the circuit.

change the Value tag to a value you specify. You assign these
values to the button’s press and release actions. For example, 50
when released, and 100 when pressed.

Creating graphic displays ■ 15--73


Preface
To create a momentary push button:

1. Click the momentary push button tool.

2. Drag the mouse to draw a button the size you want.


Momentary push button
tool
3. Double-click the button to set it up.

4. In the Momentary Push Button Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--74 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance and action of the
momentary push button

On the General tab, specify what the momentary push button looks
like at run time, and what type of action the button performs.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the button’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
button’s border to have the same color as the button’s background.

Clear the check box if you want the button’s border to have a
different color than the button’s background, and then choose a
Border color on the States tab. For details, see below.

Highlight color Click the color box to open the palette, and then
click a color for the border that appears around the button when it
is selected. If the button does not have a border, the highlight color
is not visible when the button is pressed.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Shape Click a shape for the button.

Creating graphic displays ■ 15--75


Preface

Button action Click Normally open to change the button’s tag to


1 when the button is pressed, and zero when the button is released.

Click Normally closed to change the button’s tag to zero when the
button is pressed, and 1 when the button is released.

Click Value to specify values for each of the button’s states. Type
values in the States tab, described on page 15-79.

Hold time The amount of time the button remains pressed before
the Release action takes effect, even if the operator releases the
button sooner.

The hold time should reflect network traffic. Increasing the hold
time prevents a very quick object press from being missed by the
programmable controller. If you are using a memory HMI tag, click
the shortest hold time.

The operator cannot press the button again until the hold time has
expired. If a display change occurs before the hold time has expired,
the value for the released state is sent immediately to the tag.

15--76 ■ RSView Supervisory Edition User’s Guide


Horizontal margin The number of pixels for the horizontal touch
margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Audio Select this check box to beep the computer’s internal speaker
when the operator presses the button.

If the computer running the display does not have an internal


speaker, pressing the button does not trigger a beep.

Creating graphic displays ■ 15--77


Preface
Setting up what the momentary push button
does when it is pressed and released

On the States tab, specify what the button does when it is pressed
and released.

The button’s error state is displayed at run time when:

the Value tag is unassigned

the Value tag does not match one of the state values you set up

the Indicator tag does not match one of the state values you
set up

Select state Click a state, and then set up the state on the
right-hand side.

15--78 ■ RSView Supervisory Edition User’s Guide


Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value The value to which the button changes the Value tag when
the selected state is in effect. When the Indicator tag changes to this
value, the button’s appearance changes to the settings you specify
for the state.

If you clicked Value for the button action on the General tab, you
can type a value for the state in this box. You cannot type a value
for the button’s error state.

If you clicked Normally open for the button action on the General
tab, state 0 has a value of 0, and state 1 has a value of 1. You cannot
change these values.

If you clicked Normally closed for the button action on the


General tab,, state 0 has a value of 1, and state 1 has a value of 0.
You cannot change these values.

Back color Click the color box to open the palette, and then click
a color for the button’s background.

Border color Click the color box to open the palette, and then
click a color for the button’s border.

Creating graphic displays ■ 15--79


Preface
Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Caption Type the text you want to appear on the button. If you
don’t want any text on the button, leave the Caption box blank.

Caption back style Click Solid to cover the button’s background


(such as a graphic image) with the text. Click Transparent to allow
the button’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

15--80 ■ RSView Supervisory Edition User’s Guide


Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the text is centered vertically and
horizontally on the button.

Image Type the name of the image file you want to display on the
button, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the button’s background


behind the image. Click Transparent to allow the button’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

Creating graphic displays ■ 15--81


Preface
Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

Image blink Select the check box to make a monochrome image


blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear this check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image is shaped to fit


inside the circle or ellipse.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the image is centered vertically and
horizontally on the button.

15--82 ■ RSView Supervisory Edition User’s Guide


Connecting the momentary push button
to data

On the Connections tab, specify the tags or expression with which


button exchanges data.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse for a
tag. The Value tag triggers the button’s action. For example, the tag
that, when set to 1, starts a motor.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag that shows whether a motor is running.

If you assign this tag, the button does not display the pressed state
until it receives a response from the Indicator tag. Set up the
controller to change the Indicator tag’s value when it has read the
Value tag’s value.

Creating maintained push buttons


For some important definitions, and to understand how push
buttons work, see “How to use push buttons” on page 15-58.

Use the maintained push button tool to create a button that changes
a setting in a machine or process. Maintained push buttons are not
Maintained push button
useful for starting or stopping a machine or process.
tool

Creating graphic displays ■ 15--83


Preface
When pressed and released the first time, the maintained push
button changes a tag to one value. When pressed and released a
second time, the button changes the tag to another value.

To create a maintained push button:

1. Click the maintained push button tool.

2. Drag the mouse to draw a button the size you want.

3. Double-click the button to set it up.

4. In the Maintained Push Button Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--84 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the maintained
push button, and how it changes state

On the General tab, specify what the button looks like at run time,
and how the button changes state.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the button’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
button’s border to have the same color as the button’s background.

Clear the check box if you want the button’s border to have a
different color than the button’s background, and then choose a
Border color on the States tab. For details, see below.

Highlight color Click the color box to open the palette, and then
click a color for the border that appears around the button when it
is selected. If the button does not have a border, the highlight color
is not visible when the button is pressed.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Shape Click a shape for the button.

Creating graphic displays ■ 15--85


Preface

Next state based on Click Current state to toggle the button’s


state relative to its current state. For example, if the button’s
current state is zero, its next state is 1. If the button’s current state
is 1, its next state is zero.

Click Value control to toggle the button’s state relative to the Value
tag. If the operator presses the button, changing its state to 1, and
then the Value tag changes the button’s state to zero, the next time
the operator presses the button, the button’s state will be 1.

Horizontal margin The number of pixels for the horizontal touch


margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

15--86 ■ RSView Supervisory Edition User’s Guide


If the button’s shape is a Circle or Ellipse, the touch margin applies
to a rectangular area that encloses the button.

Audio Select this check box to beep the computer’s internal speaker
when the operator presses the button. If the computer running the
display does not have an internal speaker, pressing the button does
not trigger a beep.

Setting up what the maintained push button


does when it is pressed and released

On the States tab, specify what the button does when it is pressed
and released.

Creating graphic displays ■ 15--87


Preface
The button’s error state is displayed at run time when:

the Value tag is unassigned

the Value tag does not match one of the state values you set up
when the display that contains the maintained push button
opens

the Indicator tag does not match one of the state values you
set up

Select state Click a state, and then set up the state on the
right-hand side.

Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value The value to which the button changes the Value tag when
the selected state is in effect. When the Indicator tag changes to this
value, the button’s appearance changes to the settings you specify
for the state.

Back color Click the color box to open the palette, and then click
a color for the button’s background.

Border color Click the color box to open the palette, and then
click a color for the button’s border.

15--88 ■ RSView Supervisory Edition User’s Guide


Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Caption Type the text you want to appear on the button. If you
don’t want any text on the button, leave the Caption box blank.

Caption back style Click Solid to cover the button’s background


(such as a graphic image) with the text. Click Transparent to allow
the button’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Creating graphic displays ■ 15--89


Preface
Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the text is centered vertically and
horizontally on the button.

Image Type the name of the image file you want to display on the
button, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the button’s background


behind the image. Click Transparent to allow the button’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

15--90 ■ RSView Supervisory Edition User’s Guide


Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

Image blink Select the check box to make a monochrome image


blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

If the button’s shape is a Circle or Ellipse, the image covers a


rectangular area that encloses the button.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear this check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image is shaped to fit


inside the circle or ellipse.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the image is centered vertically and
horizontally on the button.

Creating graphic displays ■ 15--91


Preface
Connecting the maintained push button
to data

On the Connections tab, specify the tags or expression with which


the button exchanges data.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse for a
tag. The Value tag triggers the button’s action. For example, the tag
that, when set to 1, changes to Auto mode.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag that shows whether a machine is in automatic or manual mode.

If you assign this tag, the button does not display the pressed state
until it receives a response from the Indicator tag. Set up the
controller to change the Indicator tag’s value when it has read the
Value tag’s value.

15--92 ■ RSView Supervisory Edition User’s Guide


Creating latched push buttons
For some important definitions, and to understand how push
buttons work, see “How to use push buttons” on page 15-58.

Use the latched push button tool to create a button that latches in
the on position, and must be unlatched by another button or
Latched push button
tool
process to return to the off position.

Latched push buttons work like momentary buttons, except that


the tag doesn’t change to the button’s release value until the button
is unlatched by another button or process. This type of button is
useful for starting a machine or process.

When the operator presses a latched push button, it changes a tag to


one value, and remains at that value until the operator presses
another button to change the handshake tag to a different value.

To create a latched push button:

1. Click the latched push button tool.

2. Drag the mouse to draw a button the size you want.

3. Double-click the button to set it up.

Creating graphic displays ■ 15--93


Preface

4. In the Latched Push Button Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--94 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the latched
push button, and how to unlatch it

On the General tab, specify what the button looks like at run time,
and how to unlatch it.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the button’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
button’s border to have the same color as the button’s background.

Clear the check box if you want the button’s border to have a
different color than the button’s background, and then choose a
Border color on the States tab. For details, see below.

Highlight color Click the color box to open the palette, and then
click a color for the border that appears around the button when it
is selected. If the button does not have a border, the highlight color
is not visible when the button is pressed.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Shape Click a shape for the button.

Creating graphic displays ■ 15--95


Preface

Latch reset type To unlatch the push button when the Handshake
tag has a non-zero value, click Non-zero Value.

To unlatch the push button when the Handshake tag changes from
a zero to a non-zero value, click Zero to non-zero transition.

Be sure to assign values to states 0 (unlatched) and 1 (latched) on


the States tab, and assign a Handshake tag on the Connections tab.

Horizontal margin The number of pixels for the horizontal touch


margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

15--96 ■ RSView Supervisory Edition User’s Guide


Audio Select this check box to beep the computer’s internal speaker
when the operator presses the button.

If the computer running the display does not have an internal


speaker, pressing the button does not trigger a beep.

Setting up what the latched push button


does when it is latched and unlatched

On the States tab, specify what the button does when it is latched
and unlatched.

Creating graphic displays ■ 15--97


Preface
The button’s error state is displayed at run time when:

the Value tag is unassigned

the Value tag does not match one of the state values you set up
when the display containing the latched push button first opens

the Indicator tag does not match one of the state values you
set up

Select state Click a state, and then set up the state on the
right-hand side.

Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value The value to which the button changes the Value tag when
the selected state is in effect. When the Indicator tag changes to this
value, the button’s appearance changes to the settings you specify
for the state.

Back color Click the color box to open the palette, and then click
a color for the button’s background.

Border color Click the color box to open the palette, and then
click a color for the button’s border.

15--98 ■ RSView Supervisory Edition User’s Guide


Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Caption Type the text you want to appear on the button. If you
don’t want any text on the button, leave the Caption box blank.

Caption back style Click Solid to cover the button’s background


(such as a graphic image) with the text. Click Transparent to allow
the button’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Creating graphic displays ■ 15--99


Preface
Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the text is centered vertically and
horizontally on the button.

Image Type the name of the image file you want to display on the
button, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the button’s background


behind the image. Click Transparent to allow the button’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

15--100 ■ RSView Supervisory Edition User’s Guide


Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

Image blink Select the check box to make a monochrome image


blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear this check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image is shaped to fit


inside the circle or ellipse.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the image is centered vertically and
horizontally on the button.

Creating graphic displays ■ 15--101


Preface
Connecting the latched push button to data

On the Connections tab, specify the tags or expressions with which


the button exchanges data.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse for a
tag. The Value tag triggers the button’s action. For example, the tag
that, when set to 1, starts a motor.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag can show whether a motor is running.

If you assign this tag, the button does not display the pressed state
until it receives a response from the Indicator tag. Set up the
controller to change the Indicator tag’s value when it has read the
Value tag’s value.

Handshake Type a tag name or expression, or click a Browse


button to browse for a tag, or compose an expression.

To unlatch the button, the Handshake tag works with the Latched
Reset Type setting (on the General tab, see page 15-96).

Depending on which item you clicked in the Latched Reset Type


list, the Handshake tag unlatches the button either when the
Handshake tag has a non-zero value, or when the Handshake tag
changes from a zero to a non-zero value.

15--102 ■ RSView Supervisory Edition User’s Guide


Creating multistate push buttons
For some important definitions, and to understand how push
buttons work, see “How to use push buttons” on page 15-58.

Use the multistate push button tool to create a button that displays
and allows an operator to cycle through multiple options
Multistate push button consecutively. The multistate push button displays the current state
tool of a process or operation by showing a different color, caption, or
image to reflect different states.

Each time the operator presses the button, the tag changes to the
value for the next state. When the button is in its last state and the
operator presses the button, the button returns to its first state.

To create a multistate push button:

1. Click the multistate push button tool.

2. Drag the mouse to draw a button the size you want.

3. Double-click the button to set it up.

Creating graphic displays ■ 15--103


Preface

4. In the Multistate Push Button Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--104 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the multistate
push button, and how it changes state

On the General tab, specify what the button looks like, and how
the button changes state.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the button’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
button’s border to have the same color as the button’s background.

Clear the check box if you want the button’s border to have a
different color than the button’s background, and then choose a
Border color on the States tab. For details, see page 15-109.

Highlight color Click the color box to open the palette, and then
click a color for the border that appears around the button when it
is selected. If the button does not have a border, the highlight color
is not visible when the button is pressed.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Shape Click a shape for the button.

Creating graphic displays ■ 15--105


Preface

Number of states Click the number of states you want the button
to have.

Assign only as many states as you want to set up. If you don’t
assign values to all the states the button has, the operator must press
the button repeatedly through all the empty states before the first
state becomes available again.

Next state based on When the operator presses the button, the
next state that is displayed can be based on the current state, or on
the value of the Value tag.

Click Current state to use the current state as the basis for deciding
what the next state will be. Click Current state if you want the
button itself to determine what its next state will be.

Click Value control to use the Value tag as the basis for deciding
what the next state will be. Click Value control if you want other
devices to change the Value tag, and determine what the button’s
next state will be.

If the Value tag does not match one of the button’s state values, the
button changes to State 0, and changes the Value tag to the value of
State 0.

15--106 ■ RSView Supervisory Edition User’s Guide


Horizontal margin The number of pixels for the horizontal touch
margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Audio Select this check box to beep the computer’s internal speaker
when the operator presses the button.

If the computer running the display does not have an internal


speaker, pressing the button does not trigger a beep.

Creating graphic displays ■ 15--107


Preface
Setting up what the multistate push button
does when it is pressed and released

On the States tab, specify what the button does when it is pressed
and released.

The button’s error state is displayed at run time when:

the Value tag is unassigned

the Value tag does not match one of the state values you set up
when the display containing the multistate push button first
opens

the Indicator tag does not match one of the state values you
set up

Select state Click a state, and then set up the state on the
right-hand side.

15--108 ■ RSView Supervisory Edition User’s Guide


Insert state Click a state, and then click Insert state. The new
state always appears above the selected state.

Delete state Click the state you want to delete, and then click
Delete state.

Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value The value to which the button changes the Value tag when
the selected state is in effect. When the Indicator tag changes to this
value, the button’s appearance changes to the settings you specify
for the state.

Back color Click the color box to open the palette, and then click
a color for the button’s background.

Border color Click the color box to open the palette, and then
click a color for the button’s border.

Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Creating graphic displays ■ 15--109


Preface

Caption Type the text you want to appear on the button. If you
don’t want any text on the button, leave the Caption box blank.

Caption back style Click Solid to cover the button’s background


(such as a graphic image) with the text. Click Transparent to allow
the button’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

15--110 ■ RSView Supervisory Edition User’s Guide


Alignment Click a position in the grid, relative to the button. In
the default alignment position, the text is centered vertically and
horizontally on the button.

Image Type the name of the image file you want to display on the
button, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the button’s background


behind the image. Click Transparent to allow the button’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

Creating graphic displays ■ 15--111


Preface
Image blink Select the check box to make a monochrome image
blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear this check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image is shaped to fit


inside the circle or ellipse.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the image is centered vertically and
horizontally on the button.

Setting up whether the multistate push


button repeats when held down

On the Timing tab, set up whether or not you want the button to
repeat automatically when the operator presses and holds the
button down. You can also set up the rate at which the button
repeats.

Auto repeat rate Select the number of times per second a button
press is registered when the button goes into auto repeat mode. If
you don’t want the button to repeat automatically, click 0.

15--112 ■ RSView Supervisory Edition User’s Guide


Auto repeat delay Click the number of milliseconds the button
must remain pressed before auto repeat starts.

Connecting the multistate push button


to data

On the Connections tab, specify the tags or expression with which


the button exchanges data.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse for a
tag. The Value tag triggers the button’s action. For example, the tag
that switches among recipes.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag can show the speed of a conveyor belt.

If you assign this tag, the button does not display the pressed state
until it receives a response from the Indicator tag. Set up the
controller to change the Indicator tag’s value when it has read the
Value tag’s value.

Creating graphic displays ■ 15--113


Preface
Creating interlocked push buttons
For information about how push buttons work, see “How to use
push buttons” on page 15-58.

Use the Interlocked push button tool to create multiple buttons


that work together in groups, and share the same tag.
Interlocked push button
tool The buttons work together like the preset station selector buttons
on a car radio: pressing one button cancels another. Although
interlocked push buttons work as a group, you add them to the
display one at a time.

When the operator presses one of the interlocked push buttons, the
buttons’ Value tag changes to one value. When the operator presses
a different interlocked button, the buttons’ Value tag changes to
another value. All the buttons share the same Value tag.

To create an interlocked push button:

1. Click the interlocked push button tool.

2. Drag the mouse to draw a button the size you want.

3. Double-click the button to set it up.

15--114 ■ RSView Supervisory Edition User’s Guide


4. In the Interlocked Push Button Properties dialog box, fill in the
fields on each tab, as described in the sections that follow. When
you are finished, click OK.

Creating graphic displays ■ 15--115


Preface
Setting up the appearance and value of the
interlocked push button

On the General tab, specify the button’s appearance, and the value
to which it changes the tag it is connected to.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the button’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
button’s border to have the same color as the button’s background.

Clear the check box if you want the button’s border to have a
different color than the button’s background, and then choose a
Border color on the States tab. For details, see below.

Highlight color Click the color box to open the palette, and then
click a color for the border that appears around the button when it
is selected. If the button does not have a border, the highlight color
is not visible when the button is pressed.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Shape Click a shape for the button.

15--116 ■ RSView Supervisory Edition User’s Guide


Button value Type an integer value for the button. When the
operator presses the button, the button changes to State 1, and
changes the Value tag to this value.

Horizontal margin The number of pixels for the horizontal touch


margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Creating graphic displays ■ 15--117


Preface

Audio Select this check box to beep the computer’s internal speaker
when the operator presses the button.

If the computer running the display does not have an internal


speaker, pressing the button does not trigger a beep.

Setting up the appearance of the


interlocked push button when it is pressed
and released

On the States tab, specify what the button looks like when it is
pressed or released at run time.

15--118 ■ RSView Supervisory Edition User’s Guide


Select state Click a state, and then set up the state on the
right-hand side.

Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Back color Click the color box to open the palette, and then click
a color for the button’s background.

Border color Click the color box to open the palette, and then
click a color for the button’s border.

Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Creating graphic displays ■ 15--119


Preface

Caption Type the text you want to appear on the button. If you
don’t want any text on the button, leave the Caption box blank.

Caption back style Click Solid to cover the button’s background


(such as a graphic image) with the text. Click Transparent to allow
the button’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

15--120 ■ RSView Supervisory Edition User’s Guide


Alignment Click a position in the grid, relative to the button. In
the default alignment position, the text is centered vertically and
horizontally on the button.

Image Type the name of the image file you want to display on the
button, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the button’s background


behind the image. Click Transparent to allow the button’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

Creating graphic displays ■ 15--121


Preface
Image blink Select the check box to make a monochrome image
blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear this check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image is shaped to fit


inside the circle or ellipse.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the image is centered vertically and
horizontally on the button.

Connecting the interlocked push button


to data

On the Connections tab, specify the tag with which the button
exchanges data. Interlocked push buttons have no Indicator tag.

The arrow shows


whether the tag is a
read tag (arrow
points left), a write Type the tag name,
tag (arrow points or expression if
right), or a read applicable, here.
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse for a
tag. The Value tag triggers the button’s action. For example, the tag
that, when set to 1, changes to Auto mode.

15--122 ■ RSView Supervisory Edition User’s Guide


Creating ramp push buttons
For some important definitions, and to understand how push
buttons work, see “How to use push buttons” on page 15-58.

Use the ramp push button tool to create a button that the operator
can use to increase or decrease the value of a tag.
Ramp push button tool
Ramp push buttons can change a tag by either an integer or floating
point value. You can use two ramp buttons together to create an
increase/decrease control.

Each time the operator presses the button, the tag changes to the
next highest or next lowest value, depending on how you set up the
button.

Some data servers do not impose a minimum or maximum limit on


the value of a tag. As an alternative to using the Ramp command
with a button, use a ramp push button, and set the upper and lower
limits of the ramp push button to limit the range through which an
operator can ramp the value of a data server tag.

To create a ramp push button:

1. Click the ramp push button tool.

2. Drag the mouse to draw a button the size you want.

3. Double-click the button to set it up.

Creating graphic displays ■ 15--123


Preface

4. In the Ramp Push Button Properties dialog box, fill in the fields
on each tab, as described in the sections that follow. When you
are finished, click OK.

15--124 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the ramp push
button, and how it works

On the General tab, specify what the button looks like, and
whether the button ramps a value up or down.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the button’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
button’s border to have the same color as the button’s background.

Clear the check box if you want the button’s border to have a
different color than the button’s background, and then choose a
Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the button’s background.

Border color Click the color box to open the palette, and then
click a color for the button’s border.

Back style Click Solid to cover objects or the display background


behind the button. Click Transparent to allow objects or the display
background behind the button to show through.

Pattern style Click a pattern style for the button.

Creating graphic displays ■ 15--125


Preface
Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Highlight color Click the color box to open the palette, and then
click a color for the border that appears around the button when it
is selected. If the button does not have a border, the highlight color
is not visible when the button is pressed.

Shape Click a shape for the button.

Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Ramp up Click Ramp up to increase the value of the tag.

Upper limit This box appears only if you click Ramp up. Type the
upper limit for the tag’s value.

Ramp down Click Ramp down to decrease the value of the tag.

Lower limit This box appears only if you click Ramp down. Type
the lower limit for the tag’s value.

Ramp value Type the positive value by which the button increases
or decreases the tag’s value.

15--126 ■ RSView Supervisory Edition User’s Guide


Horizontal margin The number of pixels for the horizontal touch
margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the button press is not registered.

This is useful for buttons that are positioned close together.


A touch-insensitive border on each button helps ensure that an
adjacent button is not pressed by mistake.

If the button’s shape is a Circle or Ellipse, the touch margin applies


to a rectangular area that encloses the button.

Creating graphic displays ■ 15--127


Preface

Audio Select this check box to beep the computer’s internal speaker
when the operator presses the button.

If the computer running the display does not have an internal


speaker, pressing the button does not trigger a beep.

Setting up the text that appears on the ramp


push button

On the Label tab, specify what text or image appears on the button.

15--128 ■ RSView Supervisory Edition User’s Guide


Caption Type the text you want to appear on the button. If you
don’t want any text on the button, leave the Caption box blank.

Caption back style Click Solid to cover the button’s background


(such as a graphic image) with the text. Click Transparent to allow
the button’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

Creating graphic displays ■ 15--129


Preface
Alignment Click a position in the grid, relative to the button. In
the default alignment position, the text is centered vertically and
horizontally on the button.

Image Type the name of the image file you want to display on the
button, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the button’s background


behind the image. Click Transparent to allow the button’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

15--130 ■ RSView Supervisory Edition User’s Guide


Image blink Select the check box to make a monochrome image
blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear this check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image is shaped to fit


inside the circle or ellipse.

Alignment Click a position in the grid, relative to the button. In


the default alignment position, the image is centered vertically and
horizontally on the button.

Setting up whether the ramp push button


repeats when held down

On the Timing tab, set up whether or not you want the button to
repeat automatically when the operator presses and holds the
button down. You can also set up the rate at which the button
repeats.

Auto repeat rate Select the number of times per second a button
press is registered when the button goes into auto repeat mode. If
you don’t want the button to repeat automatically, click 0.

Creating graphic displays ■ 15--131


Preface
Auto repeat delay Click the number of milliseconds the button
must remain pressed before auto repeat starts.

Connecting the ramp push button to data

On the Connections tab, specify the tag with which the button
exchanges data. Ramp push buttons have no Indicator tag.

The arrow shows


whether the tag is a
read tag (arrow
points left), a write Type the tag name,
tag (arrow points or expression if
right), or a read applicable, here.
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse for a
tag. The Value tag triggers the button’s action. For example, the tag
that changes a motor’s speed.

Creating numeric or string fields


You can create different kinds of numeric and string fields,
depending on your needs:

Display fields show values in a graphic display. Use them when


you need to show a value that an operator does not need to modify.

Input fields allow an operator to enter or modify values. When the


input field is not being used by the operator to enter a value, you
can set it up to display a value, eliminating the need for a separate
display field.

15--132 ■ RSView Supervisory Edition User’s Guide


Creating numeric display fields

Use the Numeric Display tool to create fields that operators can use
to display the current value of an analog or digital tag or a value
Numeric Display tool based on an expression.

To create a Numeric Display field:

1. Click the Numeric Display tool.

2. Drag the mouse to draw the field.

3. Release the mouse button.

4. In the Numeric Display Properties dialog box, fill in the fields


as follows:

Expression Create an expression. At run time, the numeric


result of this expression is displayed in the Numeric Display
field. For details about expressions, see Chapter 18, Creating
expressions.

Field length Type a value for the maximum number of


characters that will be displayed in this field. Be sure the field is
long enough to accommodate the result of the expression.

Creating graphic displays ■ 15--133


Preface
Format Click a numeric base for the value.

Decimal places Type the number of places you want after the
decimal point. This number must be at least one less than the
field width.

Overflow You can make selections from this list only if you
clicked Floating Point in the Format list. Specify how you want
the floating point value displayed if it is too long for the field.
The value can be shown as an exponent, rounded up to fit in the
field, or replaced completely by asterisks.

Leading character Click Blanks to prefix decimal values with


only a period. Click Zeroes to prefix decimal values with a zero
and a period.

Justification Click Left, Center, or Right to align numbers in


the field.

5. Click OK.

Creating string display fields

Use the String Display tool to create fields that operators can use to
display the current value of a string tag.
String Display tool

To create a String Display field:

1. Click the String Display tool.

2. Drag the mouse to draw the field.

3. Release the mouse button.

4. In the String Display Properties dialog box, fill in the fields as


follows:

15--134 ■ RSView Supervisory Edition User’s Guide


Expression Create an expression. At run time, the string result
of this expression is displayed in the String Display field. For
details about expressions, see Chapter 18, Creating expressions.

Dimensions Type a value for the maximum number of


characters that will be displayed in this field. Be sure the field is
long enough to accommodate the result of the expression.

Justification Click Left, Center, or Right to align text in the


field.

Character offset Type a number between 0 and the length of


the field. This number determines the first character in the string
that will be displayed.

You can display an entire string (a character offset of zero) or


part of a string (a character offset greater than zero). You can
also display parts of the same string in different string display
fields.

For example, assume you have a string 12 characters long. The


first eight characters contain the tag address. The last four
characters contain the tag status. To display only the status,
specify a character offset of 8. The address part of the string will
not be displayed. To display the address in a separate field,

Creating graphic displays ■ 15--135


Preface
create another string display field, specify the same tag name
and specify a field width of 8 and an offset of 0.

5. Click OK.

Creating numeric or string input fields

Use the Numeric Input tool to create fields that operators can use
to enter data for tags that accept numeric values.
Numeric Input tool
Use the String Input tool to create fields that operators can use to
enter data for tags that accept text. When the display runs,
operators can use these fields to write values to the tags.
String Input tool
A display can contain up to 1000 input fields.

12345

Programmable
Controller

To download data, the operator types a number into


the input field, and then presses PgDn or Enter.

Numeric and string input fields can also be used to upload values
and display them in a graphic display.

12345

Programmable
Controller

To upload data and display it in the


input field, the operator presses PgUp.

15--136 ■ RSView Supervisory Edition User’s Guide


Operators can select any one of the input fields in the display and
read or write the values associated with that field, or they can read
or write all the values at once. You also have the option of setting
input fields so that tag values update continuously when the
operator is not using the field to input data.

An operator can also retrieve a series of values from a recipe file,


change them, write the changed values back to the programmable
controller and/or save them to a recipe file. For more information
about recipe files, see “Creating recipe fields” on page 15-230.

If an upload fails because of a communication error, question marks


appear in the numeric input fields.

Colors for input fields are set in the Display Settings dialog box.
For details, see “Specifying colors for input fields” on page 15-26.

Validating operator input using VBA

Use the Display object’s event called BeforeInputFieldDownload


to validate input fields before they are downloaded to the tag. For
details about the Display object, see Help.

To create a Numeric Input field:

1. Click the Numeric Input tool.

2. Drag the mouse to draw the field.

3. Release the mouse button.

Creating graphic displays ■ 15--137


Preface

4. In the Numeric Input Properties dialog box, fill in the fields as


follows:

Tag Type a tag name, or a placeholder for an analog or digital


tag. For details about placeholders, see “Using tag placeholders”
on page 15-52.

Tab index Either leave the default as it is, or type a number.


Index numbers determine the Tab sequence for interactive
objects such as input objects and buttons, and are also used in
recipe files. For details, see “Using index numbers” on
page 16-54.

Default data Type a value that will appear in the numeric input
field when the graphic is initially displayed.

Field length Type a value to specify the maximum number of


characters that will be displayed in this field. Be sure the field is
long enough to accommodate all the possible values for the tag.

Format Click a numeric base for the value.

Decimal places Type the number of places you want after the
decimal point. This number must be at least one less than the
field width.

15--138 ■ RSView Supervisory Edition User’s Guide


Overflow You can make selections from this list only if you
clicked Floating Point in the Format list. Specify how you want
the floating point value displayed if it is too long for the field.
The value can be shown as an exponent, rounded up to fit in the
field, or replaced completely by asterisks.

Justification Click Left, Center, or Right to align numbers in


the field.

Leading character Click Blanks to prefix decimal values with


only a period. Click Zeroes to prefix decimal values with a zero
and a period.

Continuously update Select this check box to have tag value


changes appear in the field when the operator is not using the
field to input data.

Discard input and resume updating when focus is lost When


the operator presses the Tab key, or selects another object on the
graphic display, the numeric input field loses focus.

Select this check box to discard whatever the operator types in


the field, if the operator selects another object before pressing
PgDn, Ctrl-PgDn, or Enter to download the value to the
programmable controller. The numeric input field then resumes
updating itself with values from the programmable controller.

Clear this check box if you want to force the operator to


complete his or her entry in this field before selecting or using
another object in the graphic display.

5. Click OK.

Creating graphic displays ■ 15--139


Preface
To create a String Input field:

1. Click the String Input tool.

2. Drag the mouse to draw the field.

3. Release the mouse button.

4. In the String Input Properties dialog box, fill in the fields as


follows:

Tag Type a tag name, or a placeholder for a string tag. For


details about placeholders, see “Using tag placeholders”
on page 15-52.

Tab index Either leave the default as it is, or type a number.


Index numbers determine the Tab sequence for interactive
objects such as input objects and buttons, and are also used in
recipe files. For details, see “Using index numbers” on
page 16-54.

Default data Type the text that appears in the string input field
when the graphic is initially displayed.

15--140 ■ RSView Supervisory Edition User’s Guide


Dimensions Type a value for the maximum number of
characters that will be displayed in this field. Be sure the field is
long enough to accommodate the string for the tag.

Justification Click Left, Center, or Right to align the text in


the field.

Continuously update Select this check box to update the field


with tag value changes when the operator is not using the field
to input data.

Discard input and resume updating when focus is lost When


the operator presses the Tab key, or selects another object on the
graphic display, the string input field loses focus.

Select this check box to discard whatever the operator types in


the field, if the operator selects another object before pressing
PgDn to download the value to the programmable controller.
The string input field then resumes updating itself with values
from the programmable controller.

Clear this check box if you want to force the operator to


complete his or her entry in this field before selecting or using
another object in the graphic display.

5. Click OK.

Creating graphic displays ■ 15--141


Preface
Using input fields at run time
At run time, operators can use input fields to retrieve data from and
send data to the value table so it can be accessed by the
programmable controller, external OPC server or DDE device, or by
RSView memory.

Updating tag values continuously

When a numeric or string input field is set to update continuously


and display tag values, its appearance changes to reflect which
mode the field is in:

when the field is displaying a value from the programmable


controller or server (display mode), the border around the field
is dotted

when a value has been entered in the field but not downloaded
yet (pending write mode), the border around the field is solid

when a field is ready to receive input (input mode), the border is


solid and the field is surrounded by a highlight box

This field is in
display mode.

This field is in
pending write
mode.

This field is in
input mode.

The operator can put the field into input mode by selecting the
field, uploading to the field, or restoring a recipe to the field. The
operator can set the field back to display mode by pressing the
Escape key.

15--142 ■ RSView Supervisory Edition User’s Guide


When you first open a display containing fields set to update
continuously, the first non-updating field in the index sequence has
focus by default. If all fields in the display are set to update
continuously, no field has focus until the operator selects a field.

If an upload fails because of a communication error, question marks


appear in the numeric input fields.

Keys

Operators can use the following keys to retrieve data from and send
data to the value table. You can re-assign these actions to other keys
or assign them to button objects.

PgDn: downloads the contents of all input fields that are in


pending write mode in the active graphic display to the value
table

Ctrl-PgDn: downloads the contents of a selected input field to


the value table

Enter: downloads the contents of a selected input field to the


value table, unless the display was invoked using the
/E parameter, which disables the Enter key.

If the display has been set up to use the on-screen keyboard,


pressing Enter brings up the on-screen keyboard.

PgUp: uploads all values from the value table and then displays
them in the input fields

Ctrl-PgUp: uploads a value from the value table for the selected
input field

Tab: moves among input fields

Creating graphic displays ■ 15--143


Preface
RSView commands

Operators can use these commands to retrieve data from and send
data to the value table:

Download: downloads the contents of the selected input field to


the value table

DownloadAll: downloads the contents of all input fields that are


in pending write mode to the value table

Upload: uploads a value from the value table and displays it in


the selected input field

UploadAll: uploads all the values from the value table and
displays them in the input fields

If you want operators to use these commands, assign them to


buttons in the graphic display.

For detailed information about commands, see Appendix A,


RSView commands, or see Help.

Using the on-screen keyboard

You can set up your displays so that operators can use an on-screen
keyboard for input entry in numeric, string, and recipe input fields.

15--144 ■ RSView Supervisory Edition User’s Guide


The characters the operator types using the on-screen keyboard
appear in the selected input field when the operator presses the
Download or Update Field button on the on-screen keyboard, or
when the operator presses Enter on a hardware keyboard.

This button Does this

Update Field Closes the on-screen keyboard and stores the new value
on screen, for later download.

Download For numeric and string input fields, closes the on-screen
keyboard and downloads the value or text the operator
typed.

For recipe fields, closes the on-screen keyboard, opens


the Recipe dialog box, and inserts in the Recipe File
field the text the operator typed.

Cancel Discards the operator’s changes and closes the


on-screen keyboard.

For information about setting up displays to use the on-screen


keyboard see “Displaying the on-screen keyboard” on page 15-28.

Creating graphic displays ■ 15--145


Preface
How to use indicators
Indicators display the status of processes or operations by showing
different colors, captions, images, or options to reflect different
states.

You can create different kinds of indicators, depending on your


needs:

Multistate indicators display the current state of a process or


operation by showing a different color, caption, or image to reflect
different states.

Symbol indicators display a symbol that changes to match the state


of a process or operation. This allows the operator to see the status
of a process or operation at a glance.

List indicators display a list of states for a process or operation, and


highlight the current state. Each state is represented by a caption in
the list. This type of indicator is useful if you want operators to
view the current state, but also see the other possible states. For
sequential processes, the list can inform the operator about what
happens next.

15--146 ■ RSView Supervisory Edition User’s Guide


How to use the States tab for indicators

Indicators change their appearance based on their states. You set up


an indicator’s appearance for each state on the States tab of the
indicator’s Properties dialog box.

Most indicators have several states, and an error state. The error
state occurs when the indicator is receiving invalid data.

The List indicator has no error state. If the value of the Indicator
tag does not match any of the available states, none of the states is
highlighted.

Creating graphic displays ■ 15--147


Preface
How to use the Connections tab
for indicators

To connect with a device such as a programmable controller,


indicators use a tag or expression called the Indicator tag or
indicator expression. You set up the Indicator tag or expression on
the Connections tab of the indicator’s Properties dialog box.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to an
Indicator tag.

The tag or expression changes the indicator’s appearance for each of


the indicator’s states, providing visual feedback to the operator. For
example, the Indicator tag can show that a process is running or
stopped. The Indicator tag is similar to a pilot light on a hard-wired
panel.

Creating multistate indicators

For some important definitions, and to understand how indicators


work, see “How to use indicators” on page 15-146.

Use the multistate indicator tool to create an indicator that displays


the current state of a process or operation by showing a different
Multistate Indicator tool color, caption, or image for each state.

You specify the state values of the multistate indicator. At run time,
the indicator displays the state whose value matches the Indicator
tag’s value.

15--148 ■ RSView Supervisory Edition User’s Guide


To create a multistate indicator:

1. Click the multistate indicator tool.

Multistate Indicator tool 2. Drag the mouse to draw an indicator the size you want.

3. Double-click the indicator to set it up.

4. In the Multistate Indicator Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

Creating graphic displays ■ 15--149


Preface
Setting up the appearance of the multistate
indicator, and its number of states

On the General tab, specify what the indicator looks like, and the
number of states for the indicator.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the indicator’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
indicator’s border to have the same color as the indicator’s
background.

Clear the check box if you want the indicator’s border to have a
different color than the indicator’s background, and then choose a
Border color on the States tab. For details, see below.

Back style Click Solid to cover objects or the display background


behind the indicator. Click Transparent to allow objects or the
display background behind the indicator to show through.

Shape Click a shape for the indicator.

15--150 ■ RSView Supervisory Edition User’s Guide


Number of states Click the number of states you want the
indicator to have.

Setting up how the multistate indicator’s


appearance changes to match its value

On the States tab, specify how the indicator’s appearance changes


when its tag or expression’s value changes.

Creating graphic displays ■ 15--151


Preface
The indicator’s error state is displayed at run time when:

the Indicator tag is unassigned

the Indicator tag does not match one of the state values you
set up

Select state Click a state, and then set up the state on the
right-hand side.

Insert state Click a state, and then click Insert state. The new
state always appears above the selected state.

Delete state Click the state you want to delete, and then click
Delete state.

Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value Type the integer value for each state. When the Indicator tag
changes to this value, the indicator’s appearance changes to the
settings you specify for the state.

Back color Click the color box to open the palette, and then click
a color for the indicator’s background.

Border color Click the color box to open the palette, and then
click a color for the indicator’s border.

15--152 ■ RSView Supervisory Edition User’s Guide


Blink Select the check box to make the indicator blink at run time.
Clear the check box to prevent the indicator from blinking at run
time.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Caption Type the text you want to appear on the indicator. If you
don’t want any text on the indicator, leave the Caption box blank.

Caption back style Click Solid to cover the indicator’s


background (such as a graphic image) with the text. Click
Transparent to allow the indicator’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Creating graphic displays ■ 15--153


Preface
Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

Alignment Click a position in the grid for the text, relative to the
indicator. In the default alignment position, the text is centered
vertically and horizontally on the indicator.

Image Type the name of the image file you want to display on the
indicator, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the indicator’s background


behind the image. Click Transparent to allow the indicator’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

15--154 ■ RSView Supervisory Edition User’s Guide


Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

Image blink Select the check box to make a monochrome image


blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the button. Clear the check box to crop the image to the area of
the button.

If the button’s shape is a Circle or Ellipse, the image covers a


rectangular area that encloses the indicator.

Alignment Click a position in the grid for the image, relative to the
indicator. In the default alignment position, the image is centered
vertically and horizontally on the indicator.

Connecting the multistate indicator to data

On the Connections tab, specify the tag or expression from which


the indicator receives data.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to an
Indicator tag.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag that shows whether a particular recipe is selected.

Creating graphic displays ■ 15--155


Preface
Creating symbol indicators
For some important definitions, and to understand how indicators
work, see “How to use indicators” on page 15-146.

Use the symbol indicator tool to create an indicator that displays a


monochrome image that changes color to match the state of a
Symbol Indicator tool process or operation. This allows the operator to see the status of a
process or operation at a glance.

You specify the state values, and the image you want displayed for
each state. At run time, the indicator displays the state that matches
the Indicator tag or expression’s value.

To create a symbol indicator:

1. Click the symbol indicator tool.

2. Drag the mouse to draw an indicator the size you want.

3. Double-click the indicator to set it up.

15--156 ■ RSView Supervisory Edition User’s Guide


4. In the Symbol Indicator Properties dialog box, fill in the fields
on each tab, as described in the sections that follow. When you
are finished, click OK.

Creating graphic displays ■ 15--157


Preface
Setting up the appearance of the symbol
indicator, and its number of states

On the General tab, specify what the indicator looks like at run
time, and the number of states for the indicator.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the indicator’s border. Border width is measured in
pixels.

Shape Click a shape for the indicator.

Number of states Click the number of states you want the


indicator to have.

Image Type the name of the monochrome image file you want to
display on the indicator, or click the Browse button to browse for
the image.

Browse button If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

15--158 ■ RSView Supervisory Edition User’s Guide


Setting up how the symbol indicator
changes appearance when its value
changes

On the States tab, specify how the indicator’s appearance changes


when its tag or expression’s value changes.

The indicator’s error state is displayed at run time when:

the Indicator tag is unassigned

the Indicator tag does not match one of the state values you
set up

Select state Click a state, and then set up the state on the
right-hand side.

Insert state Click a state, and then click Insert state. The new
state always appears above the selected state.

Delete state Click the state you want to delete, and then click
Delete state.

Creating graphic displays ■ 15--159


Preface
Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value Type the integer value for each state. When the Indicator tag
changes to this value, the indicator’s appearance changes to the
settings you specify for the state.

Border color Click the color box to open the palette, and then
click a color for the indicator’s border.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

15--160 ■ RSView Supervisory Edition User’s Guide


Image back style Click Solid to cover the indicator’s background
behind the image. Click Transparent to allow the indicator’s
background to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image blink Select the check box to make a monochrome image


blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Connecting the symbol indicator to data

On the Connections tab, specify the tag or expression from which


the indicator receives data.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to an
Indicator tag.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag that shows the state of a pump.

Creating graphic displays ■ 15--161


Preface
Creating list indicators
For some important definitions, and to understand how indicators
work, see “How to use indicators” on page 15-146.

Use the list indicator tool to create an indicator that displays a list
of states for a process or operation, and highlights the current state.
List Indicator tool
Each state is represented by a caption in the list. This type of
indicator is useful if you want operators to view the current state,
but also see the other possible states.

For sequential processes, the list can inform the operator about
what happens next.

You specify the state values of the list indicator. At run time, the
indicator highlights the state whose value matches the Indicator
tag’s value.

To create a list indicator:

1. Click the list indicator tool.

2. Drag the mouse to draw an indicator the size you want.

3. Double-click the indicator to set it up.

15--162 ■ RSView Supervisory Edition User’s Guide


4. In the List Indicator Properties dialog box, fill in the fields on
each tab, as described in the sections that follow. When you are
finished, click OK.

Creating graphic displays ■ 15--163


Preface
Setting up the appearance of the list
indicator, and its number of states

On the General tab, specify what the indicator looks like at run
time, and the number of states for the indicator.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the indicator’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the
indicator’s border to have the same color as the indicator’s
background.

Clear the check box if you want the indicator’s border to have a
different color than the indicator’s background, and then choose a
Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the indicator’s background.

Border color Click the color box to open the palette, and then
click a color for the indicator’s border.

Pattern style Click a pattern style for the indicator.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

15--164 ■ RSView Supervisory Edition User’s Guide


Selection fore color Click the color box to open the palette, and
then click a color for the foreground of a selected item in the list.

Selection back color Click the color box to open the palette, and
then click a color for the background of a selected item in the list.

Blink Select the check box to make the indicator blink at run time.
Clear the check box to prevent the indicator from blinking at run
time.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption truncate Click Word to cut off captions that exceed the
maximum length at the beginning of the word. Click Character to
cut off captions that exceed the maximum length, even in the
middle of a word.

The maximum caption length depends on the width of the indicator


and the font size.

When a caption has been truncated, an asterisk ( * ) appears on the


right of the caption to indicate that text is missing

Number of states Click the number of states you want the


indicator to have.

Creating graphic displays ■ 15--165


Preface
Setting up how the list indicator’s
appearance changes when its value
changes

On the States tab, specify how the indicator’s appearance changes


when its tag or expression’s value changes.

Select state Click a state, and then set up the state on the
right-hand side.

Insert state Click a state, and then click Insert state. The new
state always appears above the selected state.

Delete state Click the state you want to delete, and then click
Delete state.

15--166 ■ RSView Supervisory Edition User’s Guide


Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value Type the integer value for each state. When the Indicator tag
changes to this value, the indicator’s appearance changes to match
the settings you specify for the state.

Caption Type the text you want to appear on the indicator. If you
don’t want any text on the indicator, leave the Caption box blank.

Caption back style Click Solid to cover the indicator’s


background (such as a graphic image) with the text. Click
Transparent to allow the indicator’s background to show through.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Creating graphic displays ■ 15--167


Preface
Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Alignment Click a position in the grid for the text, relative to the
indicator. In the default alignment position, the text is centered
horizontally on the indicator.

Connecting the list indicator to data

On the Connections tab, specify the tag or expression from which


the indicator receives data.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to an
Indicator tag.

Indicator Type a tag name or expression, or click a Browse button


to browse for a tag, or compose an expression. The Indicator tag
provides visual feedback to the button of its state. For example, the
tag that shows whether a particular recipe is selected.

How to use gauges and graphs


Gauges and graphs display graphical representations of numeric
values.

Gauges make it easy to see limits

Gauges display numeric values in dial format. They are useful for
displaying a value in relation to its lower and upper limits.

15--168 ■ RSView Supervisory Edition User’s Guide


For example, a temperature gauge shows the current temperature in
relation to its minimum and maximum extremes. By looking at the
position of the needle on the gauge (pointing left, up, or right), the
operator can tell at a glance whether the temperature is nearer its
lower limit, nearer the middle, or nearer its upper limit.

Gauges are used instead of numeric displays when it’s important for
the operator to recognize an abnormal condition instantly, either
from far away when the scale on the gauge isn’t visible, or before
the operator has had the opportunity to determine the exact reading
on the gauge. This characteristic of gauges is one of the reasons why
they are used in automobile instrumentation.

Thresholds change a gauge’s fill color

As the needle sweeps higher on a gauge, the gauge can fill the area
below it with a color. The gauge can change its fill color to help an
operator recognize abnormal conditions. The change in color
happens when the tag value crosses a threshold you set up for the
gauge. For example:

if the temperature of an oven is lower than required for a recipe,


the gauge can show the temperature in blue

if the temperature is in the correct range for the recipe, the


gauge can show the temperature in green

if the temperature is higher than the recipe will allow, the gauge
can show the temperature in red

If you want to use colored fills on a gauge, to show abnormal


conditions, make sure enough of the fill is visible when the
abnormal condition occurs, so that the operator recognizes the
condition.

IMPORTANT Some people are color blind to red and green, so don’t
rely on color alone to establish meaning.

Creating graphic displays ■ 15--169


Preface
Graphs make it easy to compare values

Graphs display numeric values in bar graph format. They are useful
for allowing comparisons between multiple values, or for
representing the fill levels of tanks for which a reading on a vertical
scale is usually appropriate.

For example, one bar graph can show the required level of a tank of
ingredients for a recipe, and a second bar graph can show the actual
level of the tank. The first graph changes to represent the required
level for each recipe, and the second graph changes as the actual
level in the tank rises or drops.

Graphs are used instead of numeric displays when it’s important for
the operator to analyze the relationships between numeric values.
It’s easier for the operator to see that one graph is at a lower level
than the other, or that one’s fill is green and the other’s red, than it
is to subtract one numeric value from another.

Thresholds change a bar graph’s fill color

As it fills, a graph can change its fill color to help an operator


recognize abnormal conditions. The change in color happens when
the tag value crosses a threshold you set up for the graph. For
example:

if the level of the tank of ingredients is lower than the recipe


requires, the graph can show the tank’s level in red

if the recipe will empty the tank, the graph can show the level in
yellow

if the level is higher than the level the recipe requires, the graph
can show the level in green

If you want to use a red fill on a bar graph to show abnormal


conditions, make sure enough of the red fill is visible when the

15--170 ■ RSView Supervisory Edition User’s Guide


abnormal condition occurs, so that the operator recognizes the
condition.

IMPORTANT Some people are color blind to red and green, so don’t
rely on color alone to establish meaning.

Use bar graphs with scales to show limits

Unlike gauges, bar graphs do not have integrated scales. You can
show values on a bar graph using a scale and text.

Scales consist of major ticks, represented by long lines, and minor


ticks, represented by short lines. To indicate the values of major or
minor ticks, use text objects.

How to use the Connections tab for gauges


and graphs

To connect with a device such as a programmable controller, gauges


and graphs use a tag or expression called the Indicator tag or
indicator expression. You set up the Indicator tag or expression on
the Connections tab of the indicator’s Properties dialog box.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to a bar
graph’s tag.

The tag or expression changes the gauge or graph’s appearance,


providing visual feedback to the operator. For example, the
Indicator tag can show that a machine is overheating, or that a tank
is empty.

Scales cannot change their appearance at run time, and therefore


cannot be connected to tags or expressions.

Creating graphic displays ■ 15--171


Preface
Creating gauges

For some important definitions, and to understand how gauges


work, see “How to use gauges and graphs” on page 15-168.

Use the gauge tool to represent a numeric value using a needle on a


dial.
Gauge tool
You specify the maximum and minimum values of the gauge, and
the tag to which the gauge is connected. At run time, the gauge
indicates the value of the tag in relation to the gauge’s minimum
and maximum values.

To create a gauge:

1. Click the gauge tool.

2. Drag the mouse to draw a gauge the size you want.

3. Double-click the gauge to set it up.

15--172 ■ RSView Supervisory Edition User’s Guide


4. In the Gauge Properties dialog box, fill in the fields on each tab,
as described in the sections that follow. When you are finished,
click OK.

Setting up the appearance of the gauge

On the General tab, specify what the gauge looks like at run time.

Back style Click Solid to cover objects or the display background


behind the gauge. Click Transparent to allow objects or the display
background behind the gauge to show through.

Back color Click the color box to open the palette, and then click
a color for the gauge’s background.

Fill color Click the color box to open the palette, and then click a
color for the filled part of the gauge. The filled part represents a
numeric value, and is displayed against the gauge’s background. If
you use thresholds, this color is used until the graph’s value reaches
the first threshold.

Line style Click a line style for the gauge’s scale. If you want a line
style other than solid, the line width must be 1 pixel.

Line width Type a number between 1 and 32767 to change the line
thickness of the gauge’s scale. Line width is measured in pixels.

Creating graphic displays ■ 15--173


Preface
Needle color Click the color box to open the palette, and then
click a color for the gauge’s needle.

Fore color Click the color box to open the palette, and then click a
color for the gauge’s scale.

Sweep style Click Point to point the needle at the scale as the
needle sweeps over the gauge. Click fill to fill the area below the
needle with color as the needle sweeps over the gauge.

Needle width Type a number between 1 and 32767 to change the


thickness of the gauge’s needle. Needle width is measured in pixels.

Major ticks Click the number of major ticks you want on the
gauge’s scale.

Minor ticks Click the number of minor ticks you want on the
gauge’s scale. Minor ticks are spaced evenly between the major
ticks.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

15--174 ■ RSView Supervisory Edition User’s Guide


Setting up how the gauge works

On the Display tab, specify how the gauge displays its values at run
time.

Minimum value Type the minimum value you want displayed on


the gauge. If the Value tag is at or below this value, the needle is at
the left end of the dial.

Maximum value Type the maximum value you want displayed on


the gauge. If the Value tag is at or above this value, needle is at the
right end of the dial.

Creating graphic displays ■ 15--175


Preface

Show legend Select this check box to show a legend on the gauge.
Clear this check box to remove the legend from the gauge.

Digits after decimal Click the number of digits you want


displayed after the decimal point, in numeric labels on the gauge’s
scale.

Legend color Click the color box to open the palette, and then
click a color for the numbers on the gauge’s scale.

Number of thresholds Click the number of thresholds you want


the gauge to have, or click 0 if you don’t want to use thresholds.

Threshold type Click Value to set up thresholds for absolute


values. Click Percentage to set up thresholds for percentages of the
gauge’s total range.

Threshold 1 value, and Threshold 2 value Type an absolute value,


or a percentage, depending on the threshold type. When the tag
crosses this value, the fill color changes, and/or the gauge begins to
blink.

Fill color Click the color box to open the palette, and then click a
color for the filled part of the gauge. The filled part represents a
numeric value, and is displayed against the gauge’s background.

15--176 ■ RSView Supervisory Edition User’s Guide


Blink Select the check box to make the gauge blink at run time.
Clear the check box to prevent the gauge from blinking at run time.

Connecting the gauge to data

On the Connections tab, specify the tag from which the gauge
receives data.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to a
gauge’s tag.

Value Type a tag name, or click a Browse button to browse for a


tag. The Value tag changes the position of the needle on the gauge.

Creating bar graphs


For some important definitions, and to understand how bar graphs
work, see “How to use gauges and graphs” on page 15-168.

Use the bar graph tool to create a graph that represents a numeric
value by filling and emptying as the value rises and falls.
Bar Graph tool
You specify the maximum and minimum values of the bar graph,
and the tag to which the graph is connected. At run time, the graph
shows the value of the tag in relation to the graph’s minimum and
maximum values.

Creating graphic displays ■ 15--177


Preface
To create a bar graph:

1. Click the bar graph tool.

Bar Graph tool 2. Drag the mouse to draw a bar graph the size you want.

3. Double-click the bar graph to set it up.

4. In the Bar Graph Properties dialog box, fill in the fields on each
tab, as described in the sections that follow. When you are
finished, click OK.

15--178 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the bar graph

On the General tab, specify what the bar graph looks like at run
time.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the bar graph’s border. Border width is measured in
pixels.

Border uses back color Select the check box if you want the bar
graph’s border to have the same color as the bar graph’s
background.

Clear the check box if you want the bar graph’s border to have a
different color than the bar graph’s background, and then choose a
Border color on the States tab. For details, see below.

Back style Click Solid to cover objects or the display background


behind the bar graph. Click Transparent to allow objects or the
display background behind the bar graph to show through.

Back color Click the color box to open the palette, and then click
a color for the bar graph’s background.

Border color Click the color box to open the palette, and then
click a color for the bar graph’s border.

Fill color Click the color box to open the palette, and then click a
color for the filled part of the graph. The filled part represents a
numeric value, and is displayed against the graph’s background. If

Creating graphic displays ■ 15--179


Preface
you use thresholds, this color is used until the graph’s value reaches
the first threshold.

Minimum value Type the minimum value you want displayed on


the graph. If the Value tag is at or below this value, the graph is
empty.

Maximum value Type the maximum value you want displayed on


the graph. If the Value tag is at or above this value, the graph is
filled.

Fill direction Click the direction in which you want the graph to
fill.

Number of thresholds Click the number of thresholds you want


the graph to have, or click 0 if you don’t want to use thresholds.

Threshold type Click Value to set up thresholds for constant


values. Click Percentage to set up thresholds for percentages of the
graph’s total range.

Threshold 1 value, Threshold 2 value Type an absolute value, or a


percentage, depending on the threshold type. When the tag crosses
this value, the fill color changes, and/or the graph begins to blink.

15--180 ■ RSView Supervisory Edition User’s Guide


Fill color Click the color box to open the palette, and then click a
color for the filled part of the graph. The filled part represents a
numeric value, and is displayed against the graph’s background.

Blink Select the check box to make the bar graph blink at run time.
Clear the check box to prevent the bar graph from blinking at run
time.

Connecting the bar graph to data

On the Connections tab, specify the tag from which the bar graph
receives data.

The arrow shows


that the tag is a
read tag. You Type the tag name
cannot write a or expression here.
value to an bar
graph’s tag.

Value Type a tag name, or click a Browse button to browse for a


tag. The Value tag changes the fill level on the bar graph. For
example, the Value tag can show the temperature in an oven.

Creating scales
Use the scale tool to create a scale for a bar graph.

Scale tool You specify the appearance of the scale. To place values on the scale
as a legend, use text objects. Because the scale doesn’t change at run
time, you cannot connect it to any tags.

Creating graphic displays ■ 15--181


Preface
To create a scale:

1. Click the scale tool.

Scale tool 2. Drag the mouse to draw a scale the size you want.

3. Double-click the scale to set it up.

4. In the Scale Properties dialog box, fill in the fields on each tab,
as described in the sections that follow. When you are finished,
click OK.

15--182 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the scale

On the General tab, specify what the scale looks like at run time.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the scale’s border. Border width is measured in pixels.

Border uses back color Select the check box if you want the
scale’s border to have the same color as the scale’s background.

Clear the check box if you want the scale’s border to have a
different color than the scale’s background, and then choose a
Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the scale’s background.

Border color Click the color box to open the palette, and then
click a color for the scale’s border.

Line style Click a line style for the scale. If you want a line style
other than solid, the line width must be 1 pixel.

Line width Type a number between 1 and 32767 to change the line
thickness of the scale. Line width is measured in pixels.

Fore color Click the color box to open the palette, and then click a
color for the scale.

Creating graphic displays ■ 15--183


Preface
Blink Select the check box to make the scale blink at run time.
Clear the check box to prevent the scale from blinking at run time.

Back style Click Solid to cover objects or the display background


behind the scale. Click Transparent to allow objects or the display
background behind the scale to show through.

Tick direction Click the direction in which you want the ticks to
face. For example, if you are positioning the scale to the right of a
vertical bar graph, click right.

Major ticks Click the number of major ticks you want on the
scale.

Minor ticks Click the number of minor ticks you want on the
gauge’s scale. Minor ticks are spaced evenly between the major
ticks.

15--184 ■ RSView Supervisory Edition User’s Guide


How to use keys
In RSView graphic displays, the term ‘key’ can mean three things:

Keys are graphic objects you place on a display to simulate the


functions of keyboard keys. This type of key can only be used
with three other graphic objects:

control list selectors

display list selectors

trends.

For details about using keys, see the topics in this section.

Key animation links an object or display to a keyboard key or


mouse button so operators can perform an action by pressing
the key or mouse button. For details about using key animation
see “Associating objects and displays with keys” on page 16-50.

The on-- screen keyboard allows touch screen users to type


numbers or text in input objects without the need for a
keyboard attached to the computer. You can enable the
on-screen keyboard by selecting the check box Display
on-screen keyboard, on the Behavior tab of the Display Settings
dialog box. For details, see page 15-28.

Creating graphic displays ■ 15--185


Preface
Using the Key objects

For control list selectors, display list selectors, or trends, you can
create different keys, depending on your needs:

Backspace moves back to the previously-highlighted item.

End moves to the bottom of the page that is currently displayed.

Enter selects the currently-highlighted item.

Home moves to the top of the page that is currently displayed.

Move Left moves the cursor or highlight to the left.

Move Right moves to the right.

Move Down moves down one item in the list.

Move Up moves up one item in the list.

Page Down moves down one page in the list.

Page Up moves up one page in the list.

15--186 ■ RSView Supervisory Edition User’s Guide


Keys can work with the object that has focus

If your graphic display contains more than one control list selector,
display list selector, or trend, or if your graphic display contains
one of each, you can use the same set of keys to control each object.
You don’t need to create a separate set of keys for each one.

To link one set of keys to several objects, create the keys, and then
set up the keys to send their press action to the object with focus.
For details, see the “Send press to” option on page 15-191.

Creating keys

You create and set up all of the keys in the same way, except that
the Move Up, Move Down, Page Up, and Page Down buttons can
be set up to auto repeat. The other keys have no auto repeat
function.

For some basic definitions, and to understand how keys work, see
“How to use keys” on page 15-185.

You can set up any combination of keys in a graphic display that


contains a list object or trend. Create and then set up each key
separately.

To create a key:

1. Click the tool for the kind of key you want to create.

Home Move Up

End Move right Page Up

Backspace Move Left Page Down

Enter Move Down

Creating graphic displays ■ 15--187


Preface
2. Drag the mouse to draw a key the size you want.

3. Double-click the key to set it up.

4. In the key’s Properties dialog box, fill in the fields on each tab,
as described in the sections that follow. When you are finished,
click OK.

15--188 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the key

On the General tab, specify what the key looks like at run time.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the key’s border. Border width is measured in pixels.

Border uses back color Select the check box if you want the key’s
border to have the same color as the key’s background.

Clear the check box if you want the key’s border to have a different
color than the key’s background, and then choose a Border color.
For details, see below.

Back color Click the color box to open the palette, and then click
a color for the key’s background.

Border color Click the color box to open the palette, and then
click a color for the key’s border.

Back style Click Solid to cover objects or the display background


behind the key. Click Transparent to allow objects or the display
background behind the key to show through.

Pattern style Click a pattern style for the key.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Highlight color Click the color box to open the palette, and then
click a color for the key when it is selected.

Creating graphic displays ■ 15--189


Preface
Blink Select the check box to make the key blink at run time. Clear
the check box to prevent the key from blinking at run time.

Shape Click a shape for the key.

Horizontal margin The number of pixels for the horizontal touch


margin. The horizontal margin is a touch-insensitive margin inside
the object’s left and right edges. If the operator presses the
touch-insensitive margin, the key press is not registered.

This is useful for keys that are positioned close together.


A touch-insensitive border on each key helps ensure that an
adjacent key is not pressed by mistake.

If the key’s shape is a Circle or Ellipse, the touch margin applies to


a rectangular area that encloses the key.

Vertical margin The number of pixels for the vertical touch


margin. The vertical margin is a touch-insensitive margin inside the
object’s top and bottom edges. If the operator presses the
touch-insensitive margin, the key press is not registered.

This is useful for keys that are positioned close together.


A touch-insensitive border on each key helps ensure that an
adjacent key is not pressed by mistake.

If the key’s shape is a Circle or Ellipse, the touch margin applies to


a rectangular area that encloses the key.

15--190 ■ RSView Supervisory Edition User’s Guide


Audio Select this check box to beep the computer’s internal speaker
when the operator presses the key.

If the computer running the display does not have an internal


speaker, pressing the key does not trigger a beep.

Send press to Click Object With Focus to send the key’s press
action to the object that is selected on the display. For example, if a
rectangle object is selected, pressing the Move Up key sends the
Move Up command to the rectangle.

Click Linked Object to send the button’s press action to the object
to which the key is linked. For example, if the key is linked to a
control list selector, pressing the Move Up key sends the Move Up
command to the control list selector.

Linked object Click the Browse button, and then click the object
you want to link the key to.

Creating graphic displays ■ 15--191


Preface
Adding text or an image to the key

On the Label tab, specify what text or image appears on the key.

15--192 ■ RSView Supervisory Edition User’s Guide


Caption Type the text you want to appear on the key. If you don’t
want any text on the key, leave the Caption box blank.

Caption back style Click Solid to cover the key’s background


(such as a graphic image) with the text. Click Transparent to allow
the key’s background to show through.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the caption. Clear this check box
to truncate words that are too long for the width of the caption.

Creating graphic displays ■ 15--193


Preface
Alignment Click a position in the grid, relative to the key. In the
default alignment position, the text is centered vertically and
horizontally on the key.

Image Type the name of the image file you want to display on the
key, or click the Browse button to browse for the image.

If you click the Browse button, the Image Browser appears. Click
an image in the list on the left, and then click OK.

Image back style Click Solid to cover the key’s background


behind the image. Click Transparent to allow the key’s background
to show through the image.

For monochrome images, any area of the image that is not black
becomes transparent when you change the Image back style to
Transparent.

For color images, any area of the image that is black will become
transparent when you change the Image back style to Transparent.

Image color Click the colored square to open the color palette,
and then click a color for a monochrome image. You cannot change
the color of grayscale or color images.

Image back color Click the colored square to open the color
palette, and then click a color for the background of a monochrome
image. You cannot change the background color of grayscale or
color images.

15--194 ■ RSView Supervisory Edition User’s Guide


Image blink Select the check box to make a monochrome image
blink at run time. Clear the check box to prevent the image from
blinking at run time. You cannot make grayscale or color images
blink.

Image scaled Select the check box to scale the image to fit the area
of the key. Clear this check box to crop the image to the area of the
key.

If the key’s shape is a Circle or Ellipse, the image covers a


rectangular area that encloses the key.

Alignment Click a position in the grid, relative to the key. In the


default alignment position, the image is centered vertically and
horizontally on the key.

Creating graphic displays ■ 15--195


Preface
Setting up whether the key repeats when
held down

The Timing tab appears only for the Move Up, Move Down, Page
Up, and Page Down keys.

On the Timing tab, set up whether or not you want the key to
repeat automatically when the operator presses and holds the key
down. You can also set up the rate at which the key repeats.

Auto repeat rate Select the number of times per second a key
press is registered when the key goes into auto repeat mode. If you
don’t want the key to repeat automatically, click 0.

Auto repeat delay Click the number of milliseconds the key must
remain pressed before auto repeat starts.

15--196 ■ RSView Supervisory Edition User’s Guide


Creating advanced objects
The Objects menu includes an Advanced submenu, from which you
can create the objects shown below:

Objects described in other chapters

Detailed information about setting up certain advanced objects is


located in other chapters. The following table lists where you can
find the information:

To set up this object See

Alarm Summary page 10-60

Trend Chapter 17, Setting up trends

Creating graphic displays ■ 15--197


Preface
Creating arrows
Use the Arrow tool to create arrows that move, based on the results
of an expression. Arrows can move vertically or horizontally.
Arrow tool
Vertical arrows move up or down in relation to a tag’s Low EU (or,
for HMI tags, minimum) and High EU (or, for HMI tags, maximum)
values. Horizontal arrows move left and right in relation to the
minimum and maximum values.

For vertical arrows, if the value is less than or equal to the


minimum value, the arrow is at the bottom. If the value is equal to
or greater than the maximum value, the arrow is at the top.

For horizontal arrows, if the value is less than or equal to the


minimum value, the arrow is at the left. If the value is equal to or
greater than the maximum value, the arrow is at the right.

To create an arrow:

1. Click the Arrow tool.

2. To draw a rectangle for a vertical arrow, drag the mouse


vertically.

To draw a rectangle for a horizontal arrow, drag the mouse


horizontally.

3. Release the mouse button.

15--198 ■ RSView Supervisory Edition User’s Guide


4. Fill in the fields as follows:

Expression Create an expression. At run time, the numeric


result of the expression positions the arrow. For details about
expressions, see Chapter 18, Creating expressions.

Range To use the minimum and maximum values for the first
HMI tag in the expression, clear the Specify check box. To specify
minimum and maximum values, select the Specify box, and then
type values in the Min and Max boxes.

Direction Click Vertical or Horizontal. This is the direction in


which the arrow moves at run time.

5. Click OK.

Creating graphic displays ■ 15--199


Preface
How to use control list selectors
Control list selectors allow an operator to scroll through a list of
states for a process and select one of the states. A highlight in the
list shows the current state.

A control list selector can show several states at the same time, but
only one state can be selected at a time. As the operator scrolls
through the list, each successive state is selected automatically. If
you want the operator to confirm the selection of a particular state
before the state’s is written to the programmable controller, include
an Enter key with the control list selector.

Control list selectors work with:

key objects. These are graphic objects that duplicate the


functions of keyboard keys. Use them with touch-screen
terminals. For details, see “Creating keys” on page 15-187.

the arrow keys and Enter on a terminal’s keypad

the arrow keys and Enter on a keyboard

The operator presses the keys to scroll up or down the list, or to


make selections from the list. The keys can be set up to work with
the control list selector that has focus, or with a specific control list
selector. For details about how keys work, see “How to use keys”
on page 15-185.

15--200 ■ RSView Supervisory Edition User’s Guide


How to use the States tab for
control list selectors

Control list selectors perform their actions and change their


appearance based on their states. For each state, you define a
control list selector’s action, and set up the text that appears in the
list.

Set up the states on the States tab of the control list selector’s
Properties dialog box.

You can set up 255 states for a control list selector. This provides
the operator with up to 255 selections in the list.

Creating graphic displays ■ 15--201


Preface
How to use the Connections tab for
control list selectors

To connect with a device such as a programmable controller,


control list selectors use tags or expressions. You set up these tags
or expressions on the Connections tab of the Properties dialog box.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Control list selectors have three tags for sending and receiving data:

the Value tag triggers the control list selector’s action, for
example setting a motor’s speed to low, medium, or high

the Enter tag allows the controller to confirm a selection after


Value tag is written. The Enter tag is set for as long as is
specified on the Timing tab.

the Enter handshake tag or expression resets the Enter tag,


using the Handshake reset type option specified on the Timing
tab

15--202 ■ RSView Supervisory Edition User’s Guide


How the Value tag works

The Value tag can be changed in three ways:

when the operator selects the next item in the list

if the control list selector requires that a selection be confirmed


using the Enter key, the Value tag changes when the operator
presses the Enter key

when another process changes the tag’s value in the


programmable controller

For example, a control list selector changes a tag’s value. If the


tag’s value is zero, when the operator selects the next state the
tag’s value changes to the value for the next state, for example 1.

If another process changes the tag’s value to 2, the next time the
operator selects the next state, the tag’s value changes to 3.

How Enter--key handshaking works

When the operator presses the control list selector’s Enter key, the
highlighted state’s value is written to the programmable controller
or device.

Use Enter-key handshaking to hold the value of the tag at the


programmable controller or device for a specific period of time, to
ensure the value is read before the control list selector overwrites
the value with a new value.

Creating graphic displays ■ 15--203


Preface
How the handshaking tags and settings interact

When the operator presses the control list selector’s Enter key, the
following happens:

1. The timer for the Enter key control delay option begins timing.
When the time is up, the Enter tag is set to 1.

If the Handshake reset type is set to Non-zero value, the Enter


Handshake tag must be 0 when the Enter key control delay
expires in order to set the Enter tag to 1.

2. The timers start for the Enter key handshake time, and Enter
key hold time.

3. If the Enter Handshake tag is assigned, the Enter tag remains set
until the Enter key handshake time expires or until it is reset by
the Enter Handshake control, whichever happens first.

If the Enter Handshake control is not assigned, the Enter


control remains set until the Enter key hold time expires.

4. The Enter tag is reset to 0.

If the Enter tag is not assigned, no handshaking takes place.

How the Handshake reset type option works

The Enter Handshake tag resets the Enter tag like this:

Non-zero value resets the Enter tag when the Enter Handshake
tag is a non-zero value.

Zero to non-zero transition resets the Enter tag when the Enter
Handshake tag changes from zero to a non-zero value.

In either case, if the Enter key handshake time expires before the
Enter Handshake tag resets the Enter tag, an error appears in the
activity log.

15--204 ■ RSView Supervisory Edition User’s Guide


Using objects in the graphic display

Before the Enter tag is reset to 0 the operator can provide input
to other objects in the graphic display.

If the operator presses the Enter key for an object whose Enter
tag has not yet been reset (using a key, or external keyboard or
keypad), an error appears in the activity log.

Graphic display changes

If the graphic display is closed, the Enter tag is reset to 0 and any
handshake timing is also reset.

Creating control list selectors


For some important definitions, and to understand how control list
selectors work, see “How to use control list selectors” on
page 15-200.

Use the control list selector tool to create a list that displays and
allows an operator to cycle through multiple options consecutively.
Control List Selector tool The control list selector displays the current state of a process or
operation by highlighting the state.

Each time the operator presses a key, the control list selector’s
highlight changes position, and the Value tag changes to the value
for the next state. When the control list selector is in its last state
and the operator presses the key, the control list selector returns to
its first state.

To create a control list selector:

1. Click the control list selector tool.

2. Drag the mouse to draw a control list selector the size you want.

3. Double-click the control list selector to set it up.

Creating graphic displays ■ 15--205


Preface

4. In the Control List Selector Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--206 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the
control list selector

On the General tab, specify what the control list selector looks like
at run time.

Border style list Click a border style in the list, or click None to
remove the border.

Border width list Type a number between 1 and 32767 to change


the thickness of the control list selector’s border. Border width is
measured in pixels.

Border uses back color Select the check box if you want the
control list selector’s border to have the same color as the control
list selector’s background.

Clear the check box if you want the control list selector’s border to
have a different color than the control list selector’s background,
and then choose a Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the control list selector’s background.

Border color Click the color box to open the palette, and then
click a color for the control list selector’s border.

Pattern style Click a pattern style for the button.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Creating graphic displays ■ 15--207


Preface
Selection fore color Click the color box to open the palette, and
then click a color for the foreground of a selected item in the list.

Selection back color Click the color box to open the palette, and
then click a color for the background of a selected item in the list.

Blink Select the check box to make the button blink at run time.
Clear the check box to prevent the button from blinking at run
time.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption truncate Click Word to cut off captions that exceed the
maximum length at the beginning of the word. Click Character to
cut off captions that exceed the maximum length, even in the
middle of a word.

The maximum caption length depends on the width of the indicator


and the font size.

When a caption has been truncated, an asterisk ( * ) appears on the


right of the caption to indicate that text is missing

Number of states Click the number of states you want the


indicator to have.

15--208 ■ RSView Supervisory Edition User’s Guide


Write on enter Select this check box to send the control list
selector’s state value to the programmable controller when the
operator presses Enter.

Clear this check box to send the state value as soon as the operator
selects a new state.

Tab index Either leave the default value or type a new value. Index
numbers determine the tab sequence among control list selectors.
For details about tab sequences, see “Using index numbers” on
page 16-54.

Key navigation Select this check box to allow the operator to


navigate to the control list selector and give it focus using the
keyboard.

Creating graphic displays ■ 15--209


Preface
Setting up the control list selector’s value
and appearance

On the States tab, set up the value and appearance for each state.
The value defines the control list selector’s action, by changing the
Value tag to the value you specify when the selected state is in
effect.

Select state Click a state, and then set up the state on the
right-hand side.

Insert state Click a state, and then click Insert state. The new
state always appears above the selected state.

Delete state Click the state you want to delete, and then click
Delete state.

15--210 ■ RSView Supervisory Edition User’s Guide


Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Value Type the integer value for each state. The Value tag
changes to this value when the selected state is in effect.

Caption Type the text you want to appear in the list for this
state.

Caption back style Click Solid to cover the control list


selector’s background color with the caption’s background
color. Click Transparent to hide the caption’s background color.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Caption back color Click the color box to open the palette,
and then click a color for the caption’s background.

The caption’s background color is only visible on items in the


list that are not highlighed, and if the Caption back style is
Solid.

Creating graphic displays ■ 15--211


Preface
Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from
blinking at run time.

Alignment Click a position in the grid, relative to the control


list selector. In the default alignment position, the text aligned
on the left side of the control list selector.

Setting up the control list selector to work


with an Enter key

On the Timing tab, set up the timing and handshake settings for the
Enter key.

Enter key control delay Select the delay between the time the
Enter key is pressed and the Enter tag is set to 1. Set up the Enter
tag on the Connections tab.

Enter key hold time Select the amount of time the Enter tag
remains at a value of 1. This setting only applies if the Enter tag is
set up, and the Enter handshake tag is not set up on the
Connections tab.

15--212 ■ RSView Supervisory Edition User’s Guide


Enter key handshake time Select the maximum amount of time
the Enter tag remains at a value of 1. This setting only applies if the
Enter tag and Enter handshake tag are both set up on the
Connections tab.

Handshake reset type Click Non-zero value to reset the Enter tag
when the Enter handshake tag is a non-zero value. Click Zero to
non-zero transition to reset the Enter tag when the Enter
handshake tag changes from zero to a non-zero value.

Connecting the control list selector to data

On the Connections tab, specify the tags or expression with which


the control list selector exchanges data.

The arrow shows


whether the tag is a
read tag (arrow Type the tag name,
points left), a write or expression if
tag (arrow points applicable, here.
right), or a read
and write tag
(double-- headed
arrow).

Value Type a tag name, or click the Browse button to browse


for a tag. The Value tag triggers the state’s action. For example,
the tag that switches among recipes.

Enter Type a tag name, or click the Browse button to browse


for a tag. The Enter tag accepts values of 0 or 1 only. The tag
determines how long the Enter key press is registered. No
further values can be entered at the selector while the Enter tag
is set to 1. For details about how the Enter tag works, see
page 15-202.

Enter handshake Type a tag name or expression, or click a


Browse button to browse for a tag, or compose an expression.

Creating graphic displays ■ 15--213


Preface
The Enter handshake tag or expression resets the Enter tag,
using the Handshake reset type option specified on the Timing
tab.

Use this tag or expression for Enter key handshaking if you


want to reset the Enter tag when a value in the programmable
controller changes.

Creating tag labels

Use the Tag Label tool to create fields that display different types of
tag information at run time.
Tag Label tool
Because of their extended properties, HMI tags have equivalent
labels, but with different names than other types of tags. The
equivalents for HMI tags are shown in the shaded columns in the
table below:

Is the same For this


as this HMI HMI tag
This tag label tag label type And displays

Low EU Minimum Analog A tag’s minimum value

High EU Maximum Analog A tag’s maximum value

Contact Value Status Digital The current status of a tag. When the tag value
is 1, ‘On Label’ is displayed. When the tag
value is 0, ‘Off Label’ is displayed.

Engineering Units (EU) Units Analog A tag’s Units label

Tag Name Name All types A tag’s name

Tag Description Description All types A tag’s description

Contact Open Label Off Label Digital A tag’s Off label

Contact Close Label On Label Digital A tag’s On label

15--214 ■ RSView Supervisory Edition User’s Guide


To create a tag label:

1. Click the Tag Label tool.

2. Drag the mouse to draw the tag label field. When the tag label is
the size you want, release the mouse button.

To select a tag name,


click the Browse button.

3. Fill in the fields as follows:

Tag Specify a tag name or tag placeholder.

For information about tag placeholders, see “Using tag


placeholders” on page 15-52.

Property Click a property. For information about the various


properties, see the table on page 15-214.

Field length Type a value for the maximum number of


characters that are displayed in this field. Be sure the field is
long enough to accommodate the label. The maximum field
width depends on the type of label you are creating.

Justification Click Left, Center, or Right to specify how the


values will be aligned within the field.

4. Click OK.

Creating graphic displays ■ 15--215


Preface
How to use display list selectors

Display list selectors show a list of graphic displays in the


application. An operator can scroll through the list of displays, and
then select one to display it.

Display list selectors work with graphic displays located in the


home area only. For details about the home area, see page 4-4.

Understanding the States tab for display list selectors

You can decide how many, and which displays are shown in the list.
You can assign each state in the display list selector to a different
graphic display. You can label each state using either the name of
the graphic display, or any caption you type for the state.

15--216 ■ RSView Supervisory Edition User’s Guide


Creating display list selectors
For some important definitions, and to understand how display list
selectors work, see “How to use display list selectors” on
page 15-216.

Use the display list selector tool to create list of displays in the
application. Each graphic display is represented by a different state
Display List Selector tool in the display list selector.

You specify the graphic displays associated with each state. At run
time, the operator selects a graphic display by highlighting the state
in the list, and then pressing a key to select the state.

To create a display list selector:

1. Click the display list selector tool.

2. Drag the mouse to draw an display list selector the size you
want.

3. Double-click the display list selector to set it up.

Creating graphic displays ■ 15--217


Preface

4. In the Display List Selector Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--218 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the
display list selector

On the General tab, specify what the display list selector looks like
at run time.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the display list selector’s border. Border width is
measured in pixels.

Border uses back color Select the check box if you want the
display list selector’s border to have the same color as the display
list selector’s background.

Clear the check box if you want the display list selector’s border to
have a different color than the display list selector’s background,
and then choose a Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the display list selector’s background.

Border color Click the color box to open the palette, and then
click a color for the display list selector’s border.

Pattern style Click a pattern style for the display list selector.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Creating graphic displays ■ 15--219


Preface
Selection back color Click the color box to open the palette, and
then click a color for the background of a selected item in the list.

Selection fore color Click the color box to open the palette, and
then click a color for the foreground of a selected item in the list.

Blink Select the check box to make the display list selector blink at
run time. Clear the check box to prevent the display list selector
from blinking at run time.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Caption truncate Click Word to cut off captions that exceed the
maximum length at the beginning of the word. Click Character to
cut off captions that exceed the maximum length, even in the
middle of a word.

The maximum caption length depends on the width of the display


list selector and the font size.

When a caption has been truncated, an asterisk ( * ) appears on the


right of the caption to indicate that text is missing

Number of states Click the number of states you want the display
list selector to have.

15--220 ■ RSView Supervisory Edition User’s Guide


Key navigation Select this check box to allow the operator to
navigate to the display list selector and give it focus using the
keyboard.

Tab index Either leave the default value or type a new value. Index
numbers determine the tab sequence among objects in a graphic
display. For details about tab sequences, see “Using index numbers”
on page 16-54.

Creating graphic displays ■ 15--221


Preface
Setting up which displays appear in the
display list selector

On the States tab, specify what graphic display appears in each of


the display list selector’s states, and how each graphic display is
named.

Select state Click a state, and then set up the state on the
right-hand side.

Insert state Click a state, and then click Insert state. The new
state always appears above the selected state.

Delete state Click the state you want to delete, and then click
Delete state.

15--222 ■ RSView Supervisory Edition User’s Guide


Copy and Paste To copy settings from one state to another:

1. Click the state whose settings you want to copy.

2. Click the Copy button.

3. Click the state to which you want to paste the settings.

4. Click the Paste button.

Display Type the name of the graphic display for the selected state.
To browse for a graphic display, click the Browse button.

Use display name Select this check box to use the name of the
graphic display as the caption for the state. Clear this check box to
type a different caption for the state.

Caption Type the text you want to appear as the name of the
graphic display in the display list selector.

Caption back style Click Solid to cover the display list selector’s
background with the text. Click Transparent to allow the display
list selector’s background to show through.

Caption color Click the color box to open the palette, and then
click a color for the caption’s text.

Creating graphic displays ■ 15--223


Preface
Caption back color Click the color box to open the palette, and
then click a color for the caption’s background.

The caption’s background color is only visible if the Caption back


style is Solid.

Alignment Click a position in the grid for the text, relative to the
display list selector. In the default alignment position, the text is
centered horizontally on the display list selector.

Caption blink Select the check box to make the caption blink at
run time. Clear the check box to prevent the caption from blinking
at run time.

How to use local message displays


For information about how local messages work, see “Using local
messages” on page 15-240.

Use local message displays to provide the operator with


information about what to do next, or with information about a
process. At run time, the local message display shows one message
at a time.

To use local messages, create a local message display in a graphic


display, and then assign a local message file to the local message
display.

In the local message file, type a message, and then assign a trigger
value to the message. At run time, when the local message display’s
Value tag matches the trigger value in the local message file, the
corresponding message is displayed.

15--224 ■ RSView Supervisory Edition User’s Guide


What is displayed at run time

If the Value tag is unassigned, the display is filled with question


marks ( ? ).

The Value tag is rounded to the nearest integer. If the value does
not match any of the trigger values in the specified message file,
the display is filled with question marks ( ? ).

If the message is too long to fit in the list, the last displayed
character is replaced with an asterisk ( * ).

When the Value tag’s value is 0, the display is cleared.

Creating local message displays


For some important definitions, and to understand how local
message displays work, see “How to use local message displays” on
page 15-224.

Use the local message displays tool to create an area in a graphic


display where messages are displayed. Local message displays are
Local Message Display useful for providing the operator with information about what to
tool do next, or with information about a process.

You specify the messages in a local message file, and then set up the
local message display to show the messages when the local message
display’s Value tag matches a trigger value in the local message file.

To create a local message display:

1. Create a local message file. For details, see “Using local


messages” on page 15-240.

2. Click the local message display tool.

3. Drag the mouse to draw a local message display the size you
want.

4. Double-click the local message display to set it up.

Creating graphic displays ■ 15--225


Preface

5. In the Local Message Display Properties dialog box, fill in the


fields on each tab, as described in the sections that follow. When
you are finished, click OK.

15--226 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the
local message display

On the General tab, specify what the local message display looks
like at run time.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the local message display’s border. Border width is
measured in pixels.

Border uses back color Select the check box if you want the local
message display’s border to have the same color as the local
message display’s background.

Clear the check box if you want the local message display’s border
to have a different color than the local message display’s
background, and then choose a Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the local message display’s background.

Border color Click the color box to open the palette, and then
click a color for the local message display’s border.

Back style Click Solid to cover objects or the display background


behind the local message display. Click Transparent to allow objects
or the display background behind the local message display to show
through.

Creating graphic displays ■ 15--227


Preface
Pattern style Click a pattern style for the local message display.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Fore color Click the color box to open the palette, and then click a
color for the foreground of the local message display.

Blink Select the check box to make the local message display blink
at run time. Clear the check box to prevent the local message
display from blinking at run time.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the local message display. Clear
this check box to truncate words that are too long for the width of
the local message display.

The maximum number of characters displayed in the local message


display depends on the size of the local message display, and the
font.

Alignment Click a position in the grid, relative to the local message


display. In the default alignment position, the text is centered
vertically and horizontally on the local message display.

15--228 ■ RSView Supervisory Edition User’s Guide


Message file Type the name of the message file you want to use
for this local message display. Click the Browse button to browse
for the file instead of typing its name.

Connecting the local message display


to data

On the Connections tab, specify the tag or expression the local


message display is connected to.

The arrow shows


that the tag or
expression is read Type the tag name
only. You cannot or expression here.
write a value to the
tag or expression.

Value Type a tag name or expression, or click a Browse button to


browse for a tag, or compose an expression. The Value tag
determines which message in the message file is displayed in the
local message display. For example, if the Value tag is 1, the local
message display shows the message whose trigger value is 1 in the
local message file.

If no message exists for the trigger value, the local message display
is filled with question marks ( ? ).

Creating graphic displays ■ 15--229


Preface
Creating recipe fields
Use the Recipe tool to create a field that operators can use to
specify the name of a recipe file containing tag values for all the
Recipe tool numeric and string input fields in a graphic display. 6.

With a recipe field, operators can load all the values from a recipe
file into the numeric and string input fields in one keystroke rather
than having to enter values one by one. Operators can then write all
these values to the programmable controller with another
keystroke.

IMPORTANT Each graphic display can have only one recipe field.

To create a recipe field:

1. Click the Recipe tool.

2. Drag the mouse to draw the field.

3. Release the mouse button.

4. In the Default recipe name box, type the name of the recipe file
to and from which values will be saved and restored. Do not
include a file extension.

5. In the Field length box, type a value to specify the maximum


number of characters that can be displayed in the recipe field.

15--230 ■ RSView Supervisory Edition User’s Guide


6. Click Left, Center, or Right to specify how the recipe file name
will be aligned within the field.

7. Click OK.

Creating a recipe file


A recipe file contains tag values for all the numeric and string input
fields in a graphic display. The recipe file uses index numbers to
specify which tag value goes into which input field.

RSView automatically assigns index numbers to input objects and


button objects as you create them. To check the index number for
an object, double-click the object to open its configuration dialog
box, and then check the number in the Index field.

For details about index numbers, see “Using index numbers” on


page 16-54.

Two ways to create a recipe file

You can create a recipe file with the Recipe editor or, at run time,
you can create a recipe file by specifying a file name in the recipe
field and then saving values to that file.

To create a recipe file with the Recipe editor:

1. Open the Recipe editor.

2. Type one entry per line. Type one entry for each input field in
the display. You can have up to 500 entries.

An entry is the index number, a comma, and the value you want
to load into the input field, with no spaces. Index numbers must
start at one and increase by one.

If you want, you can include the tag name, preceded by an


exclamation mark ( ! ), as a comment. Tag names are

Creating graphic displays ■ 15--231


Preface
automatically added to the file when values are written to
the file.

3. Save the file.

To create a recipe file at run time:

1. At development time, in a graphic display, create an input field


for each value the recipe is to contain.

2. Create a recipe field for the display.

3. Save the graphic display.

4. At run time, type values in the input fields.

5. Type a file name in the recipe field and press Enter. The recipe
dialog box opens with the name in the recipe file field.

If the display has been set up to use the on-screen keyboard,


pressing Enter brings up the on-screen keyboard. Pressing the
Download button on the on-screen keyboard opens the Recipe
dialog box, where you can save the recipe file.

6. To save the values in the input fields and at the same time create
a recipe file, click Save.

A recipe file is created, and appears in the Recipes list in the


Application Explorer.

15--232 ■ RSView Supervisory Edition User’s Guide


Example: Creating a recipe file at run time

The following display was used to create a recipe file for


chocolate-chip cookies:

Numeric input fields

String input field

Recipe field

This is the recipe file that was created:

Index number
Value
Tag name

Creating graphic displays ■ 15--233


Preface
Using a recipe at run time
At run time, operators can restore values from a recipe file into
input fields and send those values to the programmable controller
or server. Operators can also upload values from a programmable
controller or server into input fields, and then save those values to a
recipe file.

If an upload fails because of a communication error, question marks


appear in the numeric input fields.

To move to a recipe field, users can do any one of the following:

use the mouse. Double-click the recipe field to open the Recipe
dialog box and save or restore the recipe file.

press Ctrl-R to move to the field and then press Enter to restore
the contents of the recipe file.

If the display has been set up to use the on-screen keyboard,


selecting the recipe field and pressing Enter brings up the
on-screen keyboard. Pressing the Download button on the
on-screen keyboard opens the Recipe dialog box, where you can
restore the contents of the recipe file.

press Ctrl-W to move to the field and then press Enter to save
the recipe file.

If the display has been set up to use the on-screen keyboard,


pressing Enter brings up the on-screen keyboard. Pressing the
Download button on the on-screen keyboard opens the Recipe
dialog box, where you can save the recipe file.

15--234 ■ RSView Supervisory Edition User’s Guide


To download recipe values to a programmable controller
or server:

1. Restore the values from a recipe file as follows:

a. In the recipe field, type the name of a recipe file and press
Enter, or click in the recipe field and press Enter. The Recipe
dialog box opens.

If the display has been set up to use the on-screen keyboard,


selecting the recipe field and then pressing Enter displays the
on-screen keyboard. Use the on-screen keyboard to type the
name of a recipe file, and then press the Download button on
the keyboard. The Recipe dialog box opens.

b. If you didn’t type a name, select a file from which to restore


values.

c. Click Restore.

2. Download the values in the input fields by pressing PgDn, or by


using the RSView Download or DownloadAll command.

You can also restore the values from a recipe file using the RSView
RecipeRestore command. For details, see Appendix A, RSView
commands, or see Help.

Creating graphic displays ■ 15--235


Preface
To save recipe values from a programmable controller
or server:

1. Upload the values to the input fields by pressing PgUp, or by


using the RSView Upload or UploadAll command.

2. Save the values to the recipe file as follows:

a. In the recipe field, type the name of a recipe file and press
Enter, or click in the recipe field and press Enter. The Recipe
dialog box opens.

If the display has been set up to use the on-screen keyboard,


selecting the recipe field and pressing Enter brings up the
on-screen keyboard. Type the name of a recipe file using the
on-screen keyboard and press the Download button on the
keyboard. The Recipe dialog box opens.

b. If you didn’t type a name, select a file to which values will be


saved.

c. Click Save.

You can also save the values from a recipe file using the RSView
RecipeSave command. For details, see Appendix A, RSView
commands, or see Help.

15--236 ■ RSView Supervisory Edition User’s Guide


Creating time and date displays
A time and date display shows the current time and date in a
graphic display. Use the time and date display tool to create a box
Time and Date Display that shows the time and date in a graphic display. You specify the
tool appearance of the time and date display, and the format in which
the time and date appear.

To create a time and date display:

1. Click the time and date display tool.

2. Drag the mouse to draw a box size you want for the time and
date display.

3. Double-click the time and date display to set it up.

4. In the Time and Date Display Properties dialog box, fill in the
fields on each tab, as described in the sections that follow. When
you are finished, click OK.

Creating graphic displays ■ 15--237


Preface
Setting up the appearance of the
time and date display

On the General tab, specify what the time and date display looks
like at run time.

Border style Click a border style in the list, or click None to


remove the border.

Border width Type a number between 1 and 32767 to change the


thickness of the local message display’s border. Border width is
measured in pixels.

Border uses back color Select the check box if you want the local
message display’s border to have the same color as the local
message display’s background.

Clear the check box if you want the local message display’s border
to have a different color than the local message display’s
background, and then choose a Border color. For details, see below.

Back color Click the color box to open the palette, and then click
a color for the local message display’s background.

Border color Click the color box to open the palette, and then
click a color for the local message display’s border.

Back style Click Solid to cover objects or the display background


behind the local message display. Click Transparent to allow objects
or the display background behind the local message display to show
through.

15--238 ■ RSView Supervisory Edition User’s Guide


Pattern style Click a pattern style for the local message display.

Pattern color Click the color box to open the palette, and then
click a color for the pattern.

Fore color Click the color box to open the palette, and then click a
color for the foreground of the local message display.

Blink Select the check box to make the local message display blink
at run time. Clear the check box to prevent the local message
display from blinking at run time.

Font, size, and style Click a font for the caption in the font list.
Type or click a size for the font in the size box. Click B to make the
font bold, click I to make the font italic, click U to underline the
text.

For design guidelines and ideas about choosing fonts, see


page 15-32.

Word wrap Select this check box to wrap words to the next line if
they are too long for the width of the local message display. Clear
this check box to truncate words that are too long for the width of
the local message display.

The maximum number of characters displayed in the local message


display depends on the size of the local message display, and the
font.

Alignment Click a position in the grid, relative to the local message


display. In the default alignment position, the text is centered
vertically and horizontally on the local message display.

Creating graphic displays ■ 15--239


Preface

Time and date format Click the format in which you want the
time and date displayed.

Using local messages

Use local messages to give the operator information about the


status of devices and processes. For example, you might use local
messages to describe the status of a device whose condition cannot
be represented graphically with accuracy, or you might instruct the
operator in how to deal with a particular situation that has arisen.

You create messages in the Local Messages editor, and then display
them in local message displays, which you create in the graphic
display editor.

You can use multiple local message displays in your application,


and you can link each local message display to a different local
message file. Or, you can use the same local message file for
multiple local message displays.

For information about local message displays, see “How to use


local message displays” on page 15-224.

Basic steps for setting up local messages

As your application is running, information about the state of


various processes is continually exchanged between programmable
controllers and devices in your plant.

For example, your application might be monitoring whether a valve


is open or closed, or the temperature in a boiler.

15--240 ■ RSView Supervisory Edition User’s Guide


To set up local messages, follow these basic steps:

1. Determine which tags are associated with the machines or


processes you want to monitor.

For example, the tag that shows whether the valve is open or
closed, or the tag that shows the temperature in the boiler.

2. Determine what the values for those tags you want to use to
trigger local messages.

For example, trigger a ‘Valve open’ message when the valve’s tag
is 1 (to represent ‘open’), or trigger a ‘Low Temperature’
message when the value of the boiler’s temperature tag is 120 (to
represent 120°F or 49°C).

3. In the Local Messages editor or in a spreadsheet application,


create the local message file. This text file must include both the
trigger value and the corresponding message. You can only
assign one message to each trigger value in a local message file.

4. In a graphic display, create a local message display. Assign a


local message file and a Value tag to each local message display.
When the Value tag matches a trigger value in the local message
file, the correponding message is displayed in the local message
display.

The following example shows how local messages work.

Creating graphic displays ■ 15--241


Preface

Example: Displaying local messages

This example shows how to notify the operator of the status of a


hoist.

1. Create an analog tag called Hoist_Status. This tag points at an


address in a programmable controller that is linked to a sensor
on the hoist. The tag has five possible values:

When the hoist is The tag’s value is

At bottom 1

Raising 2

Stopped between the top and bottom 3

Lowering 4

At top 5

2. In the Local Messages editor, create these messages with trigger


values that match the values of the Hoist_Status tag:

Trigger value Message

1 The hoist is ready to rise.

2 The hoist is raising the pallet.

3 The hoist has stopped.

4 The hoist is lowering the pallet.

5 The hoist is finished rising.

Save the message file with the name “Hoist status.”

3. In the Graphic Displays editor, create a local message display.

15--242 ■ RSView Supervisory Edition User’s Guide


4. In the object’s Properties dialog box, click the General tab, and
then select the Hoist status message file.

5. Click the Connections tab, and then type Hoist_Status in the


Value tag box.

At run time, when the operator views the graphic display


containing the local message display object, the status of the hoist is
displayed.

Trigger values cannot be zero

The trigger value can be any non-zero integer value (positive or


negative). Trigger values do not need to be contiguous, but they
must be unique for each message. For example, you could use
trigger values of 1, 2, and 3, or values of 10, 20, and 30.

Because trigger values cannot be 0, if you use a digital HMI tag, you
can only use the value 1 to trigger a message. If you use an analog
tag or an expression, you can use any non-zero integer or floating
point value to trigger a message. Floating point values are rounded
to the nearest integer.

When the Value control’s value is 0, the local message display is


cleared.

Creating graphic displays ■ 15--243


Preface
Creating local messages

Use the Local Messages editor to create one or more files of local
messages. Each file is stored in the editor’s folder. You can open and
work on multiple message files at the same time.

You can define up to 10,000 messages in each message file.

To create local messages:

1. Open the Local Messages editor.

2. For each message, specify:

Trigger value Type a non-zero integer value. When the Value


tag or expression changes to this value, the corresponding
message appears in the local message display. This column
cannot be blank.

For more information about trigger values, see “Trigger values


cannot be zero” on page 15-243.

Message Type the message, up to 256 characters. To start a new


line, type \n and then type the rest of the message.

3. To create additional messages, repeat steps 1 and 2.

4. To sort the messages by trigger value, select the rows you want
to sort, right-click any of the selected rows, and then click Sort.

15--244 ■ RSView Supervisory Edition User’s Guide


5. To save the message file, on the File menu click Save. In the
Enter Component Name box, type a name for the file, and then
click OK.

6. Click Close.

To delete a message:

" Click any cell in the row you want to delete, and then press
Delete. To delete multiple messages, shift-click the cells.

Creating local messages using a


spreadsheet application

You can use an application such as Microsoft Excel to create local


messages, and then you can copy the messages into the Local
Messages editor.

Creating graphic displays ■ 15--245


Preface
To create messages in a spreadsheet application:

" Create one message per row, as follows:

in column A, type the trigger value

in column B, type the message

Type the messages in the order you want them to appear in the
Local Messages editor.

To copy the messages into the Local Messages editor:

1. In the spreadsheet application, select the cells for the trigger


values and messages to copy, and then press Ctrl-C (or
right-click the selected cells and then click Copy).

2. In the Local Messages editor, click in the Trigger value column


for the first message and then press Ctrl-V (or right-click in the
column and then click Paste).

The cell contents from the spreadsheet application are pasted


into the local messages editor.

15--246 ■ RSView Supervisory Edition User’s Guide


Creating and editing OLE objects

OLE is an acronym for Object Linking and Embedding. OLE objects


are objects created in other Windows applications and linked to or
embedded in an RSView graphic display. RSView is an OLE client
application, which means it cannot be embedded in other Windows
applications.

The main difference between linking and embedding is where data


is stored. Linked objects are stored in the source file. The graphic
display stores only the location of the source file and displays a
representation of the linked data. Embedded objects become part of
a graphic display.

This difference means that:

linking pastes the object into the graphic display and retains
links to the source file in addition to allowing it to be edited. If
the source file is changed, the object in the display is changed.

When you double-click a linked object to edit it, its application


comes up in another window. The object’s source file is active.

If you move your application, remember to move, copy, or


update the link for the source file to the new location.

embedding pastes the object into the graphic display and allows
it to be edited. If the source file is changed, the object in the
display is not affected.

When you double-click an embedded object to edit it, the


Graphic Displays editor’s toolbar is replaced by the
application’s toolbar. A border appears around the object to
indicate that it can be edited. This is called in-place editing.

If you move your application, embedded objects are


automatically moved with the application.

Creating graphic displays ■ 15--247


Preface
To create an OLE object:

1. Click OLE Objects on the Objects menu or click the button on


the Objects toolbar.
OLE Tool
2. Draw a box the size you want for the object.

3. Click Create New to create and embed a new object.

Click Create from File to insert an existing file. To create a link


to the source file, click Link. To embed the file, do not click
Link.

4. Select an object type or file.

5. If you want the embedded object displayed as an icon, click


Display As Icon.

6. Click OK.

Other methods for inserting OLE objects

You can also insert OLE objects by copying the information from
the source file onto the clipboard and then clicking Paste Special.

15--248 ■ RSView Supervisory Edition User’s Guide


Converting OLE objects

The reasons to convert an object are:

to change any type of embedded vector-based object into a


polygon that is more readily manipulated 7.

to reduce the size of a graphic display file

Embedding an object in a graphic display increases the size of


the graphic file because the embedded object includes
information about its source application. This lets you
double-click the object and edit it using the source application.
To reduce the size of the graphic file, convert the object to an
RSView graphic object. You can no longer use its source
application to edit the object, but you can still use the editing
tools in the Graphic Displays editor to work with the object.

To convert an object:

1. Do one of the following:

select the object and cut it to the clipboard

copy the object from its source application to the clipboard

2. On the Edit menu, click Paste Special. The Paste Special dialog
box opens.

3. Click Paste or Paste Link.

Creating graphic displays ■ 15--249


Preface

Paste copies the contents of the clipboard into the active


graphic but does not link to the source application. This is an
embedded object.

Paste Link copies the contents of the clipboard into the active
graphic and links it to the source application. This is a linked
object. This option is not available if the object comes from an
application that does not support OLE linking.

4. Click the file format in which you want to paste the object into
RSView.

The items in the As box change, depending on the type of object


you copied, and depending on where you are pasting the object.
In this example, you can paste the object as an embedded Excel
worksheet, as a graphic image, or as text.

5. Click OK.

15--250 ■ RSView Supervisory Edition User’s Guide


Creating and editing ActiveX objects
An ActiveX object is a software component that is supplied
independently from RSView through products such as Microsoft
Office XP, Visual Basic, and many other third-party applications.

An ActiveX object provides features that can be accessed through


the object’s properties, events, and methods. By embedding an
ActiveX object in an RSView graphic display and then assigning
properties or specifying handlers for the object’s events, the object
can interact with RSView. Information is passed between an
ActiveX object and RSView using RSView tags.

For example, you can embed the Microsoft Forms ActiveX objects
in RSView graphic displays. If you attach an RSView tag to an
ActiveX object’s Value property, the object’s behavior changes as
the tag’s value changes.

RSView supports the use of windowed ActiveX controls only. You


cannot use windowless ActiveX controls.

When exchanging data with tags, use the same data type

To pass information between an ActiveX object and RSView, the


ActiveX object must supply information in the same format as the
tags with which the information is exchanged.

For example, if the ActiveX object is connected to an HMI tag, the


ActiveX object must provide information that is compatible with
the analog, digital, or string format of the tag. RSView does not
support pointer parameters in an ActiveX object.

Creating graphic displays ■ 15--251


Preface
ActiveX properties, methods, and events

An ActiveX object has three types of attributes:

Properties are named characteristics and values of an object such


as shape, color, position, or number.

Events are actions triggered by the ActiveX object in response


to an external action on the object, such as a mouse click.

In RSView you can use events to change the value of a tag, or to


run an RSView command or macro. When the event occurs, the
command or macro runs. To use the ActiveX object to change a
tag’s value, associate the tag with one of the object’s event
parameters.

Methods are functions implemented in the ActiveX object that


allow external actions to change the object’s appearance,
behavior, or properties.

A call to a method might be made in response to events from


other controls and could trigger other events. You can use the
RSView Invoke command as the external event that calls a
method.

To create an ActiveX object:

1. Do one of the following:

ActiveX Control on the Objects toolbar, click the ActiveX Control tool

on the Objects menu, click ActiveX Control

If you have set up tools in the ActiveX Toolbox, as described on


page 15-254, click the tool in the toolbox, draw a box the size
you want for the object, and skip the rest of these steps.

2. Draw a box the size you want for the object.

15--252 ■ RSView Supervisory Edition User’s Guide


3. Click the object you want to add to your graphic display. The
list of objects depends on what software you have installed.

If some objects you have installed do not appear in the list, the
objects might not be registered. To register them, click Register,
and then locate the objects you want to add.

To remove an object from the list, click the object and then click
Deregister.

4. Click OK.

Making ActiveX objects interact with


RSView

To enable an ActiveX object to interact with RSView you can:

connect an object’s properties to tags. To do this, use the


Property Panel. For details, see “Assigning tags and expressions
to objects” on page 15-262.

connect an object’s methods to tags. To do this, use the Invoke


command. For details, see “Connecting tags to an ActiveX
object’s methods” on page 16-46.

connect an object’s events to tags. To do this, use the ActiveX


Control Events dialog box. For details, see “Connecting tags to
an ActiveX object’s events” on page 16-49.

Creating graphic displays ■ 15--253


Preface
Using VBA code to make ActiveX objects
interact with RSView

You can also use VBA code to make an ActiveX object’s properties,
methods, and events interact with RSView. For details about
opening the VBA IDE in the context of a selected object, see
“Opening the IDE window” on page 21-3.

Using the ActiveX Toolbox

You can use the ActiveX Toolbox to set up tools for the ActiveX
objects you use frequently. This toolbox cannot be docked.

By default, the ActiveX Toolbox contains some of the Forms 2.0


ActiveX controls that are installed with VBA.

To add tools to the ActiveX Toolbox:

1. If the toolbox is not open, click ActiveX Toolbox on the View


menu.

2. Right-click the tab you want to add tools to, and then click
Additional Controls.

3. In the list of installed controls, click the tools you want to add,
and then click OK.

You can use up to 10 tabs in the toolbox, to group related tools. The
number of tabs you can view simultaneously depends on the length
of the tab names.

To add tabs to the ActiveX Toolbox:

1. Right-click a tab in the toolbox.

2. On the shortcut menu, click New Page.

RSView creates a new page with the name ‘New Page.’ To give
the page a new name, rename it as described next.

15--254 ■ RSView Supervisory Edition User’s Guide


To rename or remove tabs in the ActiveX Toolbox:

1. Right-click the tab you want to rename or remove.

2. On the shortcut menu, click Rename or Delete Page.

3. If you are renaming the page, type a name in the Caption box.

You can also type descriptive text in the Control Tip Text box.
This text becomes a ToolTip, and appears when the operator
positions the cursor over the tab at run time.

When you click Delete Page, the tab that has focus is deleted, even
if the tab is not visible. When a tab has focus (is selected) a dotted
line appears around the label’s text.

This tab is
selected.

To remove tools from the ActiveX Toolbox:

1. Right-click the tool you want to remove.

2. On the shortcut menu, click Delete Item.

To add an object to a graphic display using the ActiveX


toolbox:

1. In the ActiveX Toolbox, click the icon for the object you want
to add.

2. Draw a box the size you want for the object.

When you release the mouse button, the object appears in the
graphic display.

Creating graphic displays ■ 15--255


Preface
Deploying ActiveX components automatically
at run time
RSView SE Clients can automatically install the correct versions of
ActiveX controls used in graphic displays.

To deploy ActiveX controls automatically, you must create .cab


files for the ActiveX controls using the program CABARC.exe located
in the folder \Documents and Settings\All Users\
Documents\RSView Enterprise\ActiveX Control Setup , in the
same folder where you installed RSView. Use the CABARC.exe
program on the computer that is running the HMI server.

For information about creating .cab files, see the text file,
CreatingCabFiles.txt in the ActiveX Control Setup folder. The text
file contains examples for creating .cab files, and information about
the naming conventions that must be used.

If you open a graphic display containing ActiveX objects that are


not installed, the graphic display runs, but a shaded rectangle
appears in place of the ActiveX object.

Replacing text associated with objects


You can replace any text string used to set up the graphic objects in
your display by using tag substitution. For example, tag names,
RSView commands, and expressions used to animate a graphic
object are all text strings that you can replace using tag substitution.

Tag substitution does not work for text objects you create using the
Text tool.

15--256 ■ RSView Supervisory Edition User’s Guide


To replace text:

1. Select an object or group of objects. To select all the objects in


the display, click Select All on the Edit menu.

2. On the Edit menu, click Tag Substitution.

3. In the Search for list, type the text you want to search for, or
click one of the items in the list.

4. In the Replace with list, type the replacement text, or click one
of the items in the list.

The text can be part or all of:

a tag name (without wildcards)

a folder name (without wildcards)

the text in an expression

an RSView command

5. Click Replace.

If the Confirm Replacements check box is not selected, all


occurrences of the text in the Search for field are automatically
replaced with the text in the Replace with field.

If the Confirm Replacements check box is selected, the Confirm


Replacement dialog box opens, showing where the text is used.

Creating graphic displays ■ 15--257


Preface

To replace the text, click Replace or click Replace All. To move


to the next selected object that uses the text string, click Next.

6. When all replacements are finished, click Close.

Using the Property Panel


Use the Property Panel to modify the properties of graphic objects,
and assign tags and expressions to objects.

The Property Panel is especially useful for making changes to the


properties of multiple objects at the same time.

To open the Property Panel:

" Do one of the following:

on the Graphics toolbar, click the Edit Object Properties


tool
Edit Object Properties
tool
on the View menu, click Property Panel

right-click an object, and then click Property Panel

right-click an empty area of the display, and then click


Property Panel

You can keep the Property Panel open as you work in the Graphic
Displays editor. You can drag the panel’s borders to make the
Property Panel larger or smaller.

15--258 ■ RSView Supervisory Edition User’s Guide


Click this button for
help with the selected
property.

Scroll to see more


properties . . .

. . . or drag this bar up


This box describes the or down to see more
selected property and properties, or more of
indicates the type of data the description.
the property uses.

Setting up properties

Use the Properties tab to set up the properties of the selected object
or objects.

To set up an object’s properties:

1. Select one or more objects.

2. Click the Properties tab if it is not already selected.

3. To select the property, click the property’s row.

If the property has a list of values associated with it, press Enter
or double-click the property’s row to change the property’s

Creating graphic displays ■ 15--259


Preface
value to the next available value. To select a particular value,
click a value in the list.

If the property has a dialog box (such as the Font dialog box)
associated with it, double-click the row, or click the Browse
Browse button button to open the dialog box.

If you can set up the selected object using a Properties dialog


box, a property called (Custom) appears in the first or second
row of the grid. Double-click the row, or click the Browse
button to open the object’s Properties dialog box.

15--260 ■ RSView Supervisory Edition User’s Guide


4. Type the new value for the property, select one from the list, or
make selections from the dialog box.

5. Press Enter or click another cell in the grid to save the change.
The selected object is updated with the new property value and
its appearance in the display changes, if appropriate.

Viewing properties for multiple objects

If multiple objects are selected, you can specify which properties


you want to display in the Property Panel:

to view all the properties of all the selected objects, click All
Properties

to view only the properties that are common to the selected


objects, click Shared Properties

Viewing properties for grouped objects

If a group of objects is selected, click the Include Grouped Objects


button to view and edit the properties of the individual objects
within the group.

If a group of objects is
selected, this box shows
Multiple Selection. If only To view only properties
one object is selected, that are shared among all
this box shows the selected objects, click
object’s name and type. Shared Properties.

If a group of objects is
selected, click the Include
Grouped Objects button
to edit the properties of
the objects within the
group.

Creating graphic displays ■ 15--261


Preface
Assigning tags and expressions to objects

Use the Connections tab to assign tags or expressions to the


selected object. If multiple objects are selected, the tab is blank
because you can assign tags or expressions to only one object at a
time.

How values are updated

The arrows indicate the direction in which the data flows between
the tag or expression and the object:

a right arrow indicates that the object sends values to the tag or
expression. The tag is a write tag.

a left arrow indicates that the tag or expression sends values to


the object. The tag is a read tag.

a double arrow indicates that the data flows in both directions.


The tag is a read-write tag.

Type a tag name or


expression in this
column.

The arrows show the


direction in which data
flows between the object
and the tag or expression.
This box describes the
selected connection and
indicates the type of data
it uses.

15--262 ■ RSView Supervisory Edition User’s Guide


To assign tags or expressions to an object:

1. Click an object to select it.

2. Click the Connections tab if it is not already selected.

3. Click the row to which you want to assign a tag or expression.

4. Type a tag name or expression. You can assign an expression


only if the Browse button is available in the Exprn column.
Browse button
To open the Tags dialog box and select a tag, click the Browse
button in the Tag column. For information about browsing for
tags, see page 7-8.

To open the Expression editor and use it to create an expression,


click the Browse button in the Exprn column. For information
about expressions, see Chapter 18, Creating expressions.

5. To save the tag or expression you typed, press Enter or click


another row.

For more information about assigning tags and expressions to


objects, see “Using tag placeholders” on page 15-52.

To delete a tag or expression:

" Click the row that contains the tag you want to delete, and then
press Delete.

Creating graphic displays ■ 15--263


Preface
Naming graphic objects

All objects have a default name. Once you have drawn a graphic
object, you can change its name.

The object’s name is used when logging events for the object. The
object’s name is also used with commands (for example, when using
the Invoke command to call a method, you must specify the name
of the object in which the method is implemented).

The object’s name also appears in the Object Explorer. For details
about using the Object Explorer, see page 15-268.

Adding ToolTips to objects

You do not have to give an object a name to give it a ToolTip


description.

ToolTips appear at run time when you bring the cursor to rest over
an object for a few seconds, if the object is not inactive (that is,
dimmed or grayed out).

To name an object, and type a ToolTip description:

1. Select one object.

2. Right-click the object, and then click Property Panel.

3. To name the object, in the Property Panel, click the (Name)


property, and then enter a name for the object. Each object in a
graphic display must have a unique name. Object names are case
sensitive.

The first character of the name must be a letter, but subsequent


characters can use numbers or the underscore character ( _ ).

15--264 ■ RSView Supervisory Edition User’s Guide


When you type a
name here . . .

. . . the object’s
name changes
here.

When you type text


here . . .

. . . a ToolTip
appears for the
object at run time.

4. If required, click the ToolTipText property, and then enter a


description for the object.

Creating graphic displays ■ 15--265


Preface
Working with objects
Once you have drawn an object, you can select the object and edit
it. You can:

move objects

copy objects

duplicate objects

resize objects (except text objects)

Selecting and deselecting objects

To work with an object, you must first select it. You can use the
Select tool or the Object Explorer to select objects.

For information about using the Object Explorer, see page 15-268.

To use the Select tool:

" Do one of the following:

Select tool on the Objects menu, click Select

on the Objects toolbar, click the Select tool

The mouse pointer changes to a single arrow.

15--266 ■ RSView Supervisory Edition User’s Guide


Selecting objects

To select Do this

An object or group of Do one of the following:


objects
G click the object or group

G in the Object Explorer, click the object


or group

An object within a group Do one of the following:


of objects
G double-click the group, and then click the
object

G in the Object Explorer, open the group,


and then click the object

Several objects Click the first object, and then Ctrl-click


additional objects.

All objects in part of a Click and drag diagonally to draw a selection


display border around the objects.

Ctrl-click objects outside the border to add


them to the selection.

All objects in the drawing On the Edit menu, click Select All, or press
area or in a group you are Ctrl-A on the keyboard.
editing

Deselecting objects

To deselect Do this

An object Ctrl-click the object.

Several objects Hold down Ctrl, and then drag a selection


border around the objects.

All selected objects Click in the drawing area, away from any
objects.

Creating graphic displays ■ 15--267


Preface
Using the Object Explorer

Use the Object Explorer to view a tree-list of all the objects in a


display. Grouped objects are listed as expandable items in the tree,
with a + icon.

Use the Object Explorer to select objects that are hidden behind
other objects in the display, without first bringing them to the front.
Objects are listed in front-to-back order.

When you click an object in the Object Explorer, selection handles


appear automatically around the object in the graphic display.

The Object Explorer does not show wallpaper objects, nor the
objects within ActiveX composite objects.

To open the Object Explorer:

" Do one of the following:

on the Graphics toolbar, click the Object Explorer tool

Object Explorer tool on the View menu, click Object Explorer

right-click an object, and then click Object Explorer

You can keep the Object Explorer open as you work in the Graphic
Displays editor.

To view the objects in a group:

" Do one of the following:

click the + icon next to the group name

double-click the group name

The list expands to show the objects and groups within the
group.

15--268 ■ RSView Supervisory Edition User’s Guide


If the list is already expanded, double-clicking the group name
collapses the group.

Click the + icon to view


the objects and grouped
objects within a group.

When you click an object


When you right-- click an
in the Object Explorer,
object in the Object
you automatically select
Explorer, the object’s
the object in the graphic
shortcut menu opens, just
display.
as if you right-- clicked the
object in the graphic
display.

Double--clicking objects in the Object Explorer

Double-clicking an object in the Object Explorer is the same as


double-clicking it in the display:

for interactive objects and drawing objects, double-clicking the


object in the Object Explorer opens the object’s Properties
dialog box

for ActiveX objects, the object’s behavior depends on the


vendor’s implementation

Creating graphic displays ■ 15--269


Preface
Moving objects

You can move objects using the mouse or the keyboard. The keys
give you fine positioning, allowing you to move objects in small
increments.

To drag objects:

1. Select one or more objects.

2. Place the pointer on an object (not on the edge or on the


handles).

3. Drag the objects to the desired position.

Select the object. Drag the object to the


desired position.

You can move several objects at once by selecting them all and then
dragging one of the selected objects.

To move objects in small increments:

1. Select one or more objects.

2. Hold down Shift while you press an arrow key. Holding Shift is
the same as pressing the left mouse button.

Use the plus ( + ) and minus ( – ) keys to increase or decrease,


per press, the distance moved by the arrow keys.

15--270 ■ RSView Supervisory Edition User’s Guide


Copying objects

To copy objects, you can:

drag and drop objects

copy and paste objects to and from the clipboard

Dragging and dropping objects

You can drag and drop objects between displays. This is


particularly useful for copying objects from a graphic library.

To drag objects between displays:

1. Select one or more objects.

2. Hold down the mouse button and drag the object.

3. When the object is where you want it, release the mouse button.

To drag objects in the same display:

1. Select one or more objects.

2. Drag the object, and then press Ctrl.

When you press Ctrl, a plus sign is added to the cursor.

3. When the object is where you want it, release the mouse button
and Ctrl key.

A new copy of the object is created.

Creating graphic displays ■ 15--271


Preface
Copying and pasting objects

You can cut, copy, or paste objects using the menu items on the
Edit menu or the buttons on the toolbar.

When an object is copied, any animation attached to the object is


also copied. If a group is copied, the new copy of the group can be
ungrouped to individual objects, just like the original.

Once you copy an object, you can paste it anywhere in the drawing
area of:

the same graphic display

a graphic display in the same or a different application

a graphic library in the same or a different application

To cut or copy objects:

1. Select one or more objects.

2. On the Edit menu, click Cut or Copy, or click the Cut or Copy
button on the toolbar.
Cut
to remove the original object, click Cut

Copy
to retain the original object, click Copy

To paste objects:

1. Click in the Graphic Displays editor.

2. On the Edit menu, click Paste, or click the Paste button on the
toolbar.
Paste

15--272 ■ RSView Supervisory Edition User’s Guide


To delete objects:

" Select one or more objects and then click Delete on the Edit
menu, or press Delete on the keyboard.

Duplicating objects

Unlike Cut and Copy, Duplicate does not use the clipboard.

1. Select one or more objects.

2. On the Edit menu, click Duplicate, or click the Duplicate


button on the toolbar.
Duplicate
The duplicated object is placed slightly offset from the original.

Select object Duplicate object Move object Duplicate again

Duplicate also duplicates actions. For example, if you duplicate an


object, move it, and then duplicate it again, the second Duplicate
will, in one step, duplicate and move the object. This is useful for
creating a series of objects with an equal distance between them.

Duplicate works until you deselect the object.

When an object is duplicated, any animation attached to the object


is also duplicated. If a group is duplicated, the new copy of the
group can be ungrouped to individual objects, just like the original.

Creating graphic displays ■ 15--273


Preface
Resizing objects

You can resize objects using the mouse or using the keyboard. The
keys let you resize objects in small increments.

When you select an object, handles appear around it. Use these
handles to resize the object.

Drag a side handle to change


either the width or height.

Drag a corner handle to change


both the width and height.

To resize an object by dragging the mouse:

1. Select the object.

2. Place the pointer on one of the handles.

A double arrow appears.

3. Drag the handle until the object is the desired size or shape.

For perfect circles and squares, hold down Ctrl while you drag a
corner handle.

15--274 ■ RSView Supervisory Edition User’s Guide


To maintain the object’s original proportions (width to height),
hold down Shift while you drag a corner handle.

When advanced objects, such as input fields, are resized, the


font is resized to fit the new boundary.

To resize an object in small increments using the keyboard:

1. Select the object.

2. Place the pointer on one of the handles.

A double arrow appears.

3. Hold down Shift and press an arrow key until the object is the
desired size or shape.

Arranging objects

You can arrange objects in a number of ways using the items on the
Arrange menu or the buttons on the toolbar. You can:

combine several objects into a group that behaves as a single


object

divide a grouped object into its component objects

stack objects by moving them in front of or behind other objects

align objects with each other

space objects horizontally or vertically

flip objects horizontally or vertically

Creating graphic displays ■ 15--275


Preface
Grouping and ungrouping objects

Grouping combines several objects into a single object so you can


manipulate them as a single object. You can attach animation to a
group, and any animation attached to individual objects in the
group remains active.

To group objects:

1. Select all the objects you want grouped.

2. On the Arrange menu, click Group, or click the Group button


on the toolbar.
Group
The handles around each object are replaced by a set of handles
around the group.

... ... ... ... ...


... ... ... ... ... ... ... ... ... ... ...
... ... ... ... ... ... ... ... ... ... ...

... ... ... ... ...

Drag the mouse to select the objects Group them

Deleting a group deletes all individual objects in the group.


Changing the color or pattern style of the group changes the color
or pattern style of all individual objects in the group.

To ungroup objects:

1. Select the objects you want to ungroup.

2. On the Arrange menu, click Ungroup, or click the Ungroup


button on the toolbar.
Ungroup

15--276 ■ RSView Supervisory Edition User’s Guide


The handles around the group are replaced with handles around
each object.

Select the group. Ungroup it.

Ungrouping deletes any animation attached to the group, because


the group no longer exists. However, animation attached to the
individual objects that were in the group remains active.

Editing grouped objects

You can edit grouped objects as you would individual objects. This
allows you to edit a group of objects without breaking the group,
which is particularly useful when you have animation attached to
groups. No

To edit grouped objects, double-click the grouped object.


A rope-like border appears around the group. Double-click inside
this box to access another group or to access the individual objects.

Double-click to select the


object. A rope-like border
appears. This border indicates
that this is a group.

Double-- click again. Handles


appear. The handles show the
individual objects within the
group.

Creating graphic displays ■ 15--277


Preface
When you double-click, you are in group edit mode. In this mode,
you can select individual objects in the group and modify them.
You can also add new objects to the group. To see what objects are
selected, either look at the status bar, or right-click to see the Edit
menu item on the shortcut menu. To stop editing, click outside of
the group.

Stacking objects

You can stack objects on top of each other. Objects are stacked in
the order they are created, with the most recently created object on
top. Change the stacking order with Send to Back and Bring to
Front.

Send to Back moves the selected object to the bottom of the stack.

Bring to Front moves the selected object to the top of the stack.

To bring an object to the front:

1. Select an object.

2. On the Arrange menu, click Bring to Front, or click the Bring to


Front button on the toolbar.
Bring to Front

Select the object from behind. Bring the object to front.

15--278 ■ RSView Supervisory Edition User’s Guide


To send an object to the back:

1. Select an object.

2. On the Arrange menu, click Send to Back, or click the Send to


Back button on the toolbar.
Send to Back

Select the object. Send the object to back.

To select the object at the back, place your pointer on the object,
click once, pause, and then click again. Do not double-click and do
not move the mouse.

Aligning objects

Objects can easily be aligned with each other and with the grid.
Align objects with each other when you want the tops, bottoms, or
sides to line up.

1. Select the objects you want to align.

2. Click the appropriate button or menu item:

This button or menu item Aligns selected objects with the

Align Left Left-most selected object

Align Center Horizontal center of all selected objects

Align Right Right-most selected object

Creating graphic displays ■ 15--279


Preface

This button or menu item Aligns selected objects with the

Align Top Top-most selected object

Align Middle Vertical center of all selected objects

Align Bottom Bottom-most selected object

Align Center Points Center of all selected objects

Align to Grid Grid

15--280 ■ RSView Supervisory Edition User’s Guide


Aligning objects left, right, and center

Select objects Align left

Select objects Align right

Select objects Align center

Creating graphic displays ■ 15--281


Preface
Aligning objects top, middle, and bottom

Align top

Align middle

Align bottom

15--282 ■ RSView Supervisory Edition User’s Guide


Spacing objects

With Space Vertical and Space Horizontal, objects are moved


vertically or horizontally to have the same amount of space from
the center point of each object.

1. Select the objects you want to space.

2. Click the appropriate button or menu item:

This button or menu item Does this

Places the centers of the selected objects


Space Horizontal
an equal distance apart horizontally.

Places the centers of the selected objects


Space Vertical
an equal distance apart vertically.

Centers are
separated by
an equal vertical
distance
Select objects Space vertically

Centers are
separated by an
equal horizontal
distance

Select objects Space horizontally

Creating graphic displays ■ 15--283


Preface
Flipping objects

Flipping an object creates a mirror image of that object. You can


flip most objects.

1. Select an object.

2. Click the appropriate button or menu item:

This button or menu item Flips selected objects

Flip Vertical Top to bottom (upside-down)

Flip Horizontal Left to right

Select object Flip vertical

Select object Flip horizontal

15--284 ■ RSView Supervisory Edition User’s Guide


Applying colors
You can define both foreground and background colors for an
object. The foreground color applies to the outline of an object.
The background color applies to the inside of an object.

To make objects blink, attach color animation to the objects. For


details, see page 16-15.

To apply colors before drawing:

1. On the Foreground Color or Background Color toolbar, click


the colors you want for the object’s foreground and
background.

2. Select a drawing tool and then draw the object.

To apply colors to existing objects:

1. Select one or more objects.

2. On the Foreground Color or Background Color toolbar, click


the colors you want for the object’s foreground and
background.

Creating graphic displays ■ 15--285


Preface
Applying pattern styles
Pattern styles apply to the interior of objects. Closed objects such
as rectangles, circles, polygons, text objects, and wedges are
completely filled. Open or partially open objects, such as polylines
or freehand objects, can also take a pattern style. The editor draws
an imaginary line from the start and end points, and then fills the
object as a closed object.

Hollow polyline object Filled polyline object

Selecting pattern styles

Pattern styles are available on the Pattern Styles toolbar. To see the
toolbar, click the View menu, point to toolbars, and then click
Pattern Styles.

15--286 ■ RSView Supervisory Edition User’s Guide


Applying pattern styles

You can apply pattern styles to objects before or after you draw
them.

To apply a pattern style before drawing:

1. Select a drawing tool.

2. On the Pattern Styles toolbar, select a pattern style.

3. Draw the object.

To apply a pattern style to an existing object:

1. Select one or more objects.

2. On the Pattern Styles toolbar, select a pattern style.

How colors and patterns work

Color is applied to graphic objects with patterns as follows:

the pattern is the selected foreground color

the background is the selected background color

An object’s pattern only appears if the object’s background style is


Solid. Objects with a transparent background have no pattern.

Creating graphic displays ■ 15--287


Preface
Changing line properties

You can select a line object and change its width and style.

1. Right-click the line or polyline object. On the shortcut menu,


click Properties.

2. In the Line Properties dialog box, specify the appearance of the


line.

Line style Click a style for the line. Line styles are available
only when the line width is 1.

The styles are:

Solid

Dash

Dot

Dash-Dot

Dash-Dot-Dot

15--288 ■ RSView Supervisory Edition User’s Guide


Fore color Click the color box to open the palette, and then
click a color for the object’s foreground.

Line width Type a number between 1 and 32767 to change the


thickness of the line. Line width is measured in pixels.

Back style The object can be solid or transparent. Click Solid


to cover the background. Click Transparent to allow the
background to show through.

Back color Click the color box to open the palette, and then
click a color for the object’s background.

3. When you are finished, click OK.

Line style uses both the foreground color and background color
attributes. Foreground color applies to the line, and background
color applies to the spaces in the line. For example, to obtain the
dash-dot line, choose black as the foreground color, and choose
white as the background color. Black is applied to the dots and
dashes and white is applied to the spaces between the dots and
dashes.

For trend objects, you can also customize line width and color
using the Pens tab of the TrendX Properties dialog box.

Creating a background for your display

You can create a background for your graphic display by converting


objects to wallpaper. When objects are converted to wallpaper, they
are locked into position and become an unchanging background for
the other objects in the display. This is useful for importing
photographs of your machine or process and overlaying them with
animated objects.

Converting objects that do not need to be selected or animated


speeds up animated displays. Converting bitmaps to wallpaper can
significantly improve the performance of a graphic display.

Creating graphic displays ■ 15--289


Preface
Objects that have been converted to wallpaper cannot be selected
or edited until you unlock the wallpaper. Also, any animation
attached to the objects is not in effect. However, animation is
restored when you unlock the wallpaper.

To convert objects to wallpaper:

1. Select one or more objects.

2. On the Edit menu, point to Wallpaper and then click Convert to


Wallpaper.

To unlock wallpaper:

On the Edit menu, select Wallpaper and click Unlock Wallpaper.


All objects that were previously converted to wallpaper will be
unlocked.

Importing graphic files from third-party applications


RSView can import the following types of files:

File extension Type of file

.wmf Windows metafiles

.bmp, .gif, .tif, .pcx Bitmap files

.dxf Auto CAD® files *

.jpg JPEG files

* RSView does not import AutoCAD 13 or later .dxf files. To import a graphic file
created in AutoCAD 13 or later, export the graphic file as a .wmf file in
AutoCAD, and then open the .wmf file in RSView.

Before importing files, set up your computer’s display settings to


display more than 256 colors to ensure that the colors of imported
objects appear the same as in the original.

15--290 ■ RSView Supervisory Edition User’s Guide


To import files:

1. In the Graphic Displays editor, click the Objects menu and then
click Import.

2. In your graphic display, draw a box approximately the size you


want the imported object to be.

3. In the Open dialog box, click the Files of type list, and then
click the type of file you want to import.

4. Select the directory and file you want to open.

5. Click Open.

6. If the Convert Object dialog box appears, click Yes to convert


the object to a native RSView object or click No to leave the
object in its original format.

Converting imported objects to


RSView native objects

Converting imported objects to native objects offers the following


advantages:

graphic files are smaller

objects are groups of objects rather than a single object. This


means you can edit the individual parts of the object, including
attaching animation to individual parts.

Creating graphic displays ■ 15--291


Preface
Using bitmaps
Bitmaps consume Windows resources, so when using bitmaps
follow these guidelines:

Use device-dependent bitmaps

Device-dependent bitmaps (.bmp files) display faster than


display-independent bitmaps (.dib files) because the RSView
Graphic Displays editor is optimized for device-dependent bitmaps.
Also, you can in-place edit device-dependent bitmaps using the
Microsoft Paint program.

Avoid unnecessary color depth

Create bitmaps in the lowest color depth possible. The more colors
you use, the more memory that is consumed:

16-color bitmaps consume 4 bits per pixel (½ byte per pixel)

256-color bitmaps consume 8 bits per pixel (1 byte per pixel)

24-bit bitmaps consume 24 bits per pixel (3 bytes per pixel)

If possible, use 16-color bitmaps. To change a higher-resolution


bitmap to 16-colors, open the bitmap in the Microsoft Paint
program and save the bitmap as a 16-color bitmap.

In 256-color systems, match palettes

In a 256-color system, if bitmaps use two different color palettes,


Windows must recalculate and redraw all bitmaps when window
focus changes. Redrawing the bitmaps causes delays and can make a
scanned image or photograph ‘sparkle’ or appear as a negative.

To match palettes, use a bitmap-oriented graphical tool that lets you


match palettes.

15--292 ■ RSView Supervisory Edition User’s Guide


Palette matching is an issue only for 256-color video adapters.
24-bit color systems do not match palettes and 16-color systems
dither colors (that is, alternate pixels of different colors to
approximate another color).

Do not use the Scale option

The Scale option in the Display Settings dialog box causes the
contents of a graphic display to change size to suit the size of the
graphic display’s window. To speed up the display of a graphic
containing bitmaps, choose Pan rather than Scale because bitmaps
take longer to draw when they are scaled to a size different from
their original size.

An OLE object can be a bitmap or a bitmap wrapped in a metafile.


These types of OLE objects will also draw more slowly when scaled.

Avoid large bitmaps

Graphic displays that contain large bitmaps consume memory and


can be very slow to display because of the delay in loading them
from disk.

You can change a bitmap to a native RSView object by converting


the bitmap to wallpaper, tracing over the bitmap with RSView
drawing objects, and then deleting the bitmap.

Avoid many bitmaps

Whenever possible, create graphic objects using the RSView


drawing objects.

When could a bitmap help?

Bitmaps generally make graphic displays slower. However, objects


with large amounts of detail, such as subtle shading, might draw

Creating graphic displays ■ 15--293


Preface
more quickly if converted to a bitmap because bitmaps take the
same amount of time to draw regardless of their complexity.

Using graphic libraries


RSView comes with a set of libraries that contain graphic objects
and displays. Many of the objects are preconfigured with
animation. You can:

look at the objects and displays to get ideas for your own
application

drag and drop objects from the libraries into your own displays

Use the objects as they are or change them to suit your needs.

Location of library files

By default, library files are stored in the folder:

\Documents and Settings\All Users\Documents\RSView


Enterprise\SE\Libraries

To change the folder where library files are located:

1. In RSView Studio, click the Tools menu, and then click Options.

2. In the Options dialog box, click the Browse button, and then
select the folder that contains the library files you want to use.
Browse button

15--294 ■ RSView Supervisory Edition User’s Guide


To open a graphic library:

1. In the Application Explorer, open the Graphics folder.

2. Double-click the Libraries icon to view the list of libraries.

3. To open a library, either drag its icon to the workspace, or


right-click it and then click Open.

To create a graphic library:

1. In the Application Explorer, open the Graphics folder.

2. Open the Graphic Libraries editor by doing one of the


following:

drag the Libraries icon to the workspace

right-click the Libraries icon and then click New

3. When you are finished creating the library, click Save or Save As
on the File menu and name the library.

The library name is added to the other names in the Application


Explorer.

Creating graphic displays ■ 15--295


Preface
To add a library to an application:

1. In the Application Explorer, open the Graphics folder.

2. Right-click the Libraries icon and then click Add Component


into Project.

3. In the Add Component into Project dialog box, select the


library file you want to add.

4. Click Open.

The library is displayed in the Application Explorer.

Printing displays at run time


Operators can print graphic displays at run time using the
PrintDisplay command. You must provide the operator with a way
to issue the command when you create the display. For example,
create a button object, display key, or client key with the
PrintDisplay command as the press action.

When you use the PrintDisplay command RSView prints the entire
display, even if parts are covered by other displays. You can also use
the ScreenPrint command to print an image of whatever shows on
the monitor. For more information about these commands see
Appendix A, RSView commands, or see Help.

15--296 ■ RSView Supervisory Edition User’s Guide


16
Chapter

Animating graphic
objects
This chapter describes the various types of animation you can
attach to graphic objects, and outlines how to:

use tag names, tag placeholders, expressions, and commands


when attaching animation

use Object Smart Patht (OSP) to define an object’s range of


motion quickly

attach object and display key animation

attach animation to OLE objects

attach animation to ActiveX objects

Types of animation
To animate objects in a graphic display, you must create the objects,
and then you can attach different kinds of animation to them. Once
you have created graphic objects, you can:

attach animation that links an object to a tag so the object’s


appearance changes to reflect changes in the tag’s value

attach key animation that links an object or display to a key or


mouse button so operators can perform an action by pressing a
key or mouse button

Animating graphic objects ■ 16--1


Preface
attach OLE verb animation to an OLE object so when the
expression evaluates to true, it activates an OLE object by
initiating one of the verbs (for example, edit or open) associated
with the object

attach animation to ActiveX objects so you can:

map tags to an ActiveX object’s properties so changes to the


object’s properties change the tag’s value and, in some cases,
changes to the tag’s value change the object’s properties

map commands to an ActiveX object’s events so commands


run based on the object’s events

map tags to event parameters

or

animate ActiveX objects using VBA code. This is a more complex


way of animating ActiveX controls, but more flexible.

All graphic objects can have animation

All graphic objects can have animation attached to them. Groups of


objects can also have animation attached.

You can attach as many types of animation to an object as you like.


For example, apply both width and height animation to an object to
give it the appearance of moving into or out of the display as it
shrinks and grows.

16--2 ■ RSView Supervisory Edition User’s Guide


Using the Animation dialog box
To attach animation, use the Animation dialog box.

To open the Animation dialog box use


any of these menus. From left to right:
the View menu, the Animation menu, and
the shortcut menu.

To open the Animation dialog box:

" Do one of the following:

click an object and then click Animation on the View menu

click an object, click Animation on the menu bar to open the


Animation menu, and then click a menu item

right-click an object to open the shortcut menu, click


Animation, and then click a menu item

To attach key animation, use the Object Key and Display Key
dialog boxes. For information about key animation, see
“Associating objects and displays with keys” on page 16-50.

Animating graphic objects ■ 16--3


Preface
Using the Animation dialog box

The Animation dialog box is a floating dialog box, which means


you can have it open all the time and can move it around the screen,
select other objects, and open other dialog boxes.

A check mark indicates that


Minimum and animation of this type is assigned
maximum values to the selected object.

Animation tabs

Expression area

Expression result.
The items in this
lower part of the
window change,
depending on the
type of animation.

Animation tabs

Click the tab for the type of animation you want to set up.

Expression area

Create one or more expressions either by typing them, clicking the


Expression button, or both. Multiple expressions are evaluated in
the order they are listed.

To supply a tag name for an expression, click the Tags button and
then click a name, or type the name. If you use multiple tags in an
expression, the first tag is used for the minimum and maximum
values if you do not specify these values.

16--4 ■ RSView Supervisory Edition User’s Guide


Enclose tag names that contain dashes or start with a number in
braces { } when you use them in an expression. This distinguishes
the characters in the tag name from the characters in the expression.
Also use braces when using wildcards ( * or ? ) to represent
multiple tags in an expression.

For more information about creating expressions, see Chapter 18,


Creating expressions.

Expression result

Specify how the object’s appearance should change based on the


result of the expression. The settings in this area change for
different types of animation.

For some types of animation, you have to specify a change of state.


For example, an object with visibility animation will switch
between visible and invisible.

For other types of animation, you have to specify a range of


motion. For example, an object will move from a fixed starting
point to a fixed end point. The range of motion is related to the
minimum and maximum values for the expression. The object
moves from the At Minimum position to the At Maximum position
as the expression value changes to the maximum value.

Minimum and Maximum Values

If you do not want to use the values set for the HMI tag, specify
minimum and maximum values. The minimum and maximum
values can be constants, or they can be set by the values of other
tags.

If a value falls outside the specified range, it is evaluated as either


the minimum or maximum value.

If you do not specify minimum and maximum values, RSView uses


the minimum and maximum values for the first HMI tag in the
expression. For details, see “Setting the range of tag values for
animating the object” on page 16-9.

Animating graphic objects ■ 16--5


Preface
Apply, Delete, and Close Buttons

These buttons do the following:

Apply: Validates and then applies the animation set up for the
selected object or group of objects. Clicking another tab is the
same as clicking Apply—the animation you have set up is
validated, and then applied to the object.

Delete: Deletes the animation for the selected object.

Close: Prompts you to apply your changes and then closes the
dialog box.

Using Object Smart Path to set animation


visually

Because the Animation dialog box stays open, you can go back and
forth between the dialog box and the graphic display. This makes it
easy to set the range of motion for an object because you do not
have to know how many pixels you want an object to move.
Instead, use the RSView Object Smart Path (OSP) feature.

For details, see “Defining a range of motion for the object” on


page 16-11.

16--6 ■ RSView Supervisory Edition User’s Guide


Testing animation
You can test the animation you have set up in a graphic display
quickly by switching to Test Display mode. When you are finished
Test Display mode testing, switch back to Edit Display mode to continue editing. To
switch between test and edit modes, use the buttons on the toolbar
or the items on the View menu.
Edit Display mode
If your graphic displays contain objects that are associated with
device tags, your system must be set up to communicate with
programmable controllers or servers in order for you to test
animation.

IMPORTANT Test Display mode is not the same as running the


display in the RSView SE Client. Test Display mode
does not change the appearance or position of the
display as set up in the Display Settings dialog box, and
you cannot switch among displays while in Test Display
mode.

Some commands are ignored when issued in Test


Display mode. For a complete list, see page A-7.

Before you deploy your application, always test it using


the RSView SE Client, to verify that everything works
the way you expect.

Using tag names and tag placeholders


When setting up animation for objects, you are linking objects to
tags, so you have to specify a tag name or tag placeholder.
Following is a brief description of how to use tag names and
placeholders. For more information, see “Using tag names” on
page 15-52.

Animating graphic objects ■ 16--7


Preface
Tag names

You can use tag names that already exist in a device or that you
have already added to the tag database, or you can use a new tag
name that you will add to a device or to the tag database later.

Tag placeholders

Tag placeholders allow you to create displays that can be used with
different tags. A placeholder is a cross-hatch character ( # )
followed by a number between 1 and 500. Tag names are
substituted for placeholders when the display is run. If you are
using HMI tags, you can also substitute folder names for part of the
tag name. For example, #1\#2\MotorValve. This allows the same
animation to be added to multiple objects where only the folder
name is different.

When setting up object keys, you can specify the [Tag] parameter as
a placeholder for a tag name or any character string. The [Tag]
parameter is used for object keys only. For more information about
this parameter, see “Using the Current [Tag] parameter” on
page 16-58.

Using commands and macros

Some types of animation, such as touch animation, require you to


specify an action. The action is an RSView command, or a macro.
The command or macro you use depends on what type of action
you want. For example, if you want the action to open another
graphic display, use the Display command.

This chapter does not provide detailed information about using


RSView commands or macros. For a complete list of commands
and their syntax, see Appendix A, RSView commands, or see Help.

For details about macros, see “Creating macros” on page 19-7.

16--8 ■ RSView Supervisory Edition User’s Guide


Using expressions
Many types of animation require an expression. You can use
expressions involving tag values, constants, mathematical equations,
and if – then – else program logic for animation. A tag name or tag
placeholder can be included as part of an expression, or it can stand
alone as the entire expression.

This chapter does not provide detailed information about creating


expressions. If you are not familiar with the expression language,
see Chapter 18, Creating expressions, before you begin.

Setting the range of tag values for


animating the object
Many types of animation require a minimum and maximum range
for an expression. These values determine the start and end points
for a range of motion. 5.

When setting up animation, do one of the following:

use the HMI tag’s minimum and maximum values—this is the


default. The values are taken from the minimum and maximum
range of values for the HMI tag.

Animating graphic objects ■ 16--9


Preface
specify minimum and maximum values by clicking Use
constant, and then typing minimum and maximum values

use other tags to define the minimum and maximum values. To


do this, click Read from tags, and then specify one tag for the
minimum value, and one tag for the maximum value. Use this
option when you want to use minimum and maximum values
you expect to change, or when passing parameters to data server
tags. The minimum and maximum values are read only the first
time animation is started for the object.

Limiting the range of values used for


animation

The minimum and maximum values specified for a tag limit the
range of values that can be written to the programmable controller
but do not limit the values that are read. Therefore, a tag’s actual
minimum and maximum values might be greater than those
specified for it. If so, you might want to limit the minimum and
maximum values when setting up an object.

16--10 ■ RSView Supervisory Edition User’s Guide


You can limit the range of values by specifying constants. For
example, if you specify a minimum of 0 and a maximum of 100, the
object will not react to values outside of this range. So, even if the
expression results in 200, the object does not change from its At
Maximum position.

If an expression uses more than one HMI tag, the first HMI tag in the
expression is used for the minimum and maximum values.

Defining a range of motion for the object

To define a range of motion for an object, do one of the following:

Move the objects in the Graphic Displays editor. This is called


OSP (Object Smart Path). For details, see below.

Type values in the At Minimum and At Maximum boxes6.

All motion is defined in pixels.

Objects that do not have a range of motion

Objects with visibility, color, and touch animation do not have a


range of motion, because these types of animation represent a
change of state, not a range.

Using OSP (Object Smart Path)

With OSP, you can easily set the range of motion for an object. The
following example shows how OSP works.

Animating graphic objects ■ 16--11


Preface

Example: Using OSP to define the range of motion for


horizontal slider animation

To define a range of motion for a slider object:

1. In the Graphic Displays editor, create a slider object or copy a


slider object from a library.

2. Open the Animation dialog box and then click the Horizontal
Slider tab.

3. In the Graphic Displays editor, right-click the slider button,


point to Animation, and then click Horizontal Slider.

4. In the Expression box, type a tag name.

5. In the Graphic Displays editor, drag the slider to the position


that indicates the lowest number in the range.

16--12 ■ RSView Supervisory Edition User’s Guide


In the Animation dialog box, set this position by clicking the At
Minimum check box.

6. In the Graphic Displays editor, drag the slider to the position


that indicates the highest number in the range.

In the Animation dialog box, set this position by clicking the At


Maximum check box.

7. To save the settings, click Apply.

When you finish setting up the slider, it returns to its starting


position.

Animating graphic objects ■ 16--13


Preface
Setting up visibility animation
With visibility animation, an object becomes visible or invisible
based on a tag value or the result of a logical expression.

If an object is invisible, no other animation attached to the object is


evaluated to prevent unnecessary processing.

To set up visibility animation:

1. Click the object.

2. In the Animation dialog box, click the Visibility tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines visibility. A value other than 0 evaluates to true.

4. If you want the object to be invisible when the tag or expression


value is true—that is, when it does not equal zero—click
Invisible.

If you want the object to be visible when the tag or expression


value is true—that is, when it does not equal zero—click Visible.

5. Click Apply.

16--14 ■ RSView Supervisory Edition User’s Guide


Setting up color animation
With color animation, an object changes color based on a tag value
or the result of a logical expression. Specify up to 16 color changes
(A to P) for any object. Colors can be solid or blinking. For each
color change, specify the value or threshold at which the color
changes, and specify the colors you want the object to change to.
At run time, when the value reaches or crosses the threshold, the
color changes.

Color animation does not affect string input, numeric input, or


recipe fields. Color for these fields is defined in the Display Settings
dialog box.

The list shows the


values and colors
for each threshold.

To return to the
default colors and
thresholds, click
this button.

Animating graphic objects ■ 16--15


Preface
Using the colors and thresholds list
Foreground color
Background color
The boxes show the foreground
and background colors for each
threshold. If you select white as
the foreground and background
color, the boxes will not be
visible over the white
background of the dialog box.
Threshold value A box containing two
Threshold colors shows the colors
the object will alternate
between when blinking.

To set up color animation:

1. Click the object.

2. In the Animation dialog box, click the Color tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines the color.

4. In the list box, select a threshold (A through P) for which you


will set up a value and colors. You can change the default values
and colors for thresholds A and B.

5. In the Value box, type the threshold value. When the expression
value reaches this threshold, the object’s color changes.

Enter threshold values in ascending order. That is, A must be


lower than B, and B must be lower than C, and so on.

To delete a value for a threshold (A through P), click the


threshold and then delete the value in the Value box. In the list,
the value is then replaced with “No Value.”

6. Click Solid or Blink to make the foreground and background


colors solid, or to make them blink.

16--16 ■ RSView Supervisory Edition User’s Guide


7. To select a foreground or background color, click the colored
box to open the color palette, and then click a color. Foreground
colors apply to the outline of the object and to text. Background
colors apply to the inside of the object.

Specify the solid color here.

Specify the blinking colors here.


When blinking, the object alternates
between these two colors.

Solid colors have only one foreground and one background


color.

Blinking colors have two foreground and two background


colors, which are the foreground and background colors the
object will alternate between when blinking. If you click blink,
the two colors must be different.

8. In the Blink Rate box, specify how many seconds each blink
cycle will be. For example, if you specify four seconds, the
object will be one color for two seconds and the other color for
two seconds.

9. Click Apply.

Animating graphic objects ■ 16--17


Preface

Example 1: Creating text that blinks

This example describes how to create text that blinks between two
colors. In this example, the expression is simply a constant value
that matches the value for the selected threshold.

For details about creating text and other graphic objects, see
page 15-32.

1. Using the Text tool, type the text.

2. Select the text.

3. Open the Animation dialog box, and then click the Color tab.
Attach color animation as follows:

In the Expression box, type 0.

Zero is the default value for threshold A.

In the list, click threshold A.

Leave the value in the Value box as 0.

For Foreground color, click Blink (only foreground color


affects text).

Click each color box to open the color palette and then click
a color.

4. Click Apply.

16--18 ■ RSView Supervisory Edition User’s Guide


Example 2: Creating an object that changes color as the fill
level changes

This example describes how to create a rectangle object that


changes color as the object’s fill level increases. This example uses a
tag called Hopper\FlourLevel. The tag has a range of 1 to 100.
When the flour level reaches 80, the rectangle blinks between gray
and yellow to warn the operator that the hopper is nearly full.
When the flour level reaches 95, the rectangle blinks between gray
and red.

1. Using the Rectangle tool, create a rectangle.

2. Click the rectangle to edit it.

3. Right-click the rectangle and then click Properties. In the Back


Style list, click Solid.

4. Using the Foreground Color and Background Color palettes,


make the rectangle gray.

Animating graphic objects ■ 16--19


Preface
5. Open the Animation dialog box, and then click the Fill tab.
Attach fill animation as follows:

In the Expression box, type Hopper\FlourLevel (this is the


tag that controls the fill level).

For Fill Direction, click Up.

Click Apply.

6. Click the Color tab. Attach color animation as follows:

Create the expression

In the Expression box, type Hopper\FlourLevel (the same


tag that was used in the Fill tab).

Set up the color for the normal state

In the thresholds and colors list, click A.

In the Value box, leave the value as 0.

For Foreground and Background colors, click Solid.

For Foreground and Background, open the color palettes,


and then click gray (the same gray used for the rectangle).

Set up the color for the first warning

In the thresholds and colors list, click B.

In the Value box, type 80.

16--20 ■ RSView Supervisory Edition User’s Guide


For Foreground and Background colors, click Blink.

For Foreground and Background, open the color palettes.


For the first color, click gray. For the second color, click
yellow.

Gray Yellow

Set up the color for the second warning

In the thresholds and colors list, click C.

In the Value box, type 95.

For Foreground and Background colors, click Blink.

For Foreground and Background, open the color palettes.


For the first color, click gray. For the second color, click red.

Gray Red

7. Click Apply.

Animating graphic objects ■ 16--21


Preface
Setting up fill animation

With fill animation, the level of fill in an object changes based on a


tag’s value in relation to its minimum and maximum values. The
object’s fill level is proportional to the value of the expression. For
example, if the value of the expression is halfway between the
minimum and maximum values, the object will be half full.

Fill animation does not affect string input, numeric input, or recipe
fields, nor does it affect arrow objects. It also does not affect hollow
objects or line objects even if those objects are grouped into a single
object.

To set up fill animation:

1. Click the object.

2. In the Animation dialog box, click the Fill tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines the fill levels.

16--22 ■ RSView Supervisory Edition User’s Guide


4. Specify a range of values for the expression:

to use the HMI tag’s range of values to determine the object’s


fill level, click Use tag’s min and max property values

to specify a range of values for changing the fill level of the


object, click Use constant, and then type a minimum and
maximum value. When the tag’s value falls within these
values, the object’s fill level changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Type At Minimum and At Maximum values for the fill


percentage levels.

6. Click a fill direction.

7. Select the Inside Only check box if you want the object’s
outline to remain constant so only the inside fill level varies.

8. Click Apply.

Animating graphic objects ■ 16--23


Preface
Setting up horizontal position animation
With horizontal position animation, an object moves horizontally
based on the result of an expression in relation to its minimum and
maximum values. The object’s horizontal position is proportional
to the value of the expression. For example, if the value of the
expression is halfway between its minimum and maximum values,
the object will be halfway between its minimum and maximum
pixel offset.

To set up horizontal position animation:

1. Click the object.

2. In the Animation dialog box, click the Horizontal Position tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines the horizontal position.

16--24 ■ RSView Supervisory Edition User’s Guide


4. Specify a range of values for the expression:

to use the HMI tag’s range of values to determine the object’s


horizontal position, click Use tag’s min and max property
values

to specify a range of values for changing the horizontal


position of the object, click Use constant, and then type a
minimum and maximum value. When the tag’s value falls
within these values, the object’s horizontal position changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the starting point for the object by dragging the object or by
typing a value, and then click the At Minimum check box.

6. Set the ending point for the object by dragging the object or by
typing a value, and then click the At Maximum check box.

7. Click Apply.

Animating graphic objects ■ 16--25


Preface
Setting up vertical position animation
With vertical position animation, an object moves vertically based
on the result of an expression in relation to its minimum and
maximum values. The object’s vertical position is proportional to
the value of the expression. For example, if the value of the
expression is halfway between its minimum and maximum values,
the object will be halfway between its minimum and maximum
offset.

To set up vertical position animation:

1. Click the object.

2. In the Animation dialog box, click the Vertical Position tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines the vertical position.

16--26 ■ RSView Supervisory Edition User’s Guide


4. Specify a range of values for the expression:

to use the HMI tag’s range of values to determine the object’s


vertical position, click Use tag’s min and max property
values

to specify a range of values for changing the vertical position


of the object, click Use constant, and then type a minimum
and maximum value. When the tag’s value falls within these
values, the object’s vertical position changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the starting point for the object by dragging the object or by
typing a value, and then click the At Minimum check box.

6. Set the ending point for the object by dragging the object or by
typing a value, and then click the At Maximum check box.

7. Click Apply.

Animating graphic objects ■ 16--27


Preface
Setting up width animation
With width animation, an object’s width changes based on a tag
value or the result of an expression. The object’s width is
proportional to the value of the expression. For example, if the
value of the expression is halfway between its minimum and
maximum values, the object will be half its full width.

To set up width animation:

1. Click the object.

When you first click the object, its width is 100 percent.

2. In the Animation dialog box, click the Width tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines the object’s width.

4. Specify a range of values for the expression:

to use the tag’s range of values to determine the object’s


width, click Use tag’s min and max property values

to specify a range of values for changing the width of the


object, click Use constant, and then type a minimum and

16--28 ■ RSView Supervisory Edition User’s Guide


maximum value. When the tag’s value falls within these
values, the object’s width changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the minimum width for the object by doing one of the
following:

click a handle on the left or right side of the object and drag
it to resize the object

type the width you want the object to be when the


expression evaluates to its minimum value

Select the At Minimum check box.

6. Set the maximum width for the object by doing one of the
following:

click a handle on the left or right side of the object and drag
it to resize the object

type the width you want the object to be when the


expression evaluates to its maximum value

Select the At Maximum check box.

7. Click an anchor point.

This is the part of the object that does not move. For example,
click Left if you do not want the left side of the object to move.
As the value of the expression changes, the object will grow to
or shrink from the right.

8. Click Apply.

Animating graphic objects ■ 16--29


Preface
Setting up height animation
With height animation, an object’s height changes based on a tag
value or the result of an expression. The object’s height is
proportional to the value of the expression. For example, if the
value of the expression is halfway between its minimum and
maximum values, the object will be half its full height.

To set up height animation:

1. Click the object.

When you first click the object, its height is 100 percent.

2. In the Animation dialog box, click the Height tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use tag name, the tag’s value
determines the object’s height.

4. Specify a range of values for the expression:

to use the HMI tag’s range of values to determine the object’s


height, click Use tag’s min and max property values

to specify a range of values for changing the height of the


object, click Use constant, and then type a minimum and

16--30 ■ RSView Supervisory Edition User’s Guide


maximum value. When the tag’s value falls within these
values, the object’s height changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the minimum height for the object by doing one of the
following:

click a handle on the top or bottom of the object and drag it


to resize the object

type the height you want the object to be when the


expression evaluates to its minimum value

Click the At Minimum check box.

6. Set the maximum height for the object by doing one of the
following:

click a handle on the top or bottom of the object and drag it


to resize the object

type the height you want the object to be when the


expression evaluates to its maximum value

Click the At Maximum check box.

7. Click an anchor point.This is the part of the object that does not
move. For example, click Top if you do not want the top of the
object to move. As the value of the expression changes, the
object will grow to, or shrink from, the bottom.

8. Click Apply.

Animating graphic objects ■ 16--31


Preface
Setting up rotation animation
With rotation animation, an object rotates around an anchor point,
based on the result of an expression in relation to its minimum and
maximum values. The degree of rotation is proportional to the
value of the expression. For example, if the value of the expression
is halfway between its minimum and maximum values, the object
will rotate half the specified amount. 9.

Text, advanced objects except arrows, OLE objects, ActiveX objects,


and bitmaps cannot be rotated.

How rotation animation works

To set up rotation animation, you must specify four things:

the tag or expression that will provide values to rotate the object

the range of values for the tag or expression (values outside the
range will not be used to rotate the object)

Object rotates when tag


values fall within this
range.

Object stops rotating


when tag values fall
within this range.

Tag values 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

16--32 ■ RSView Supervisory Edition User’s Guide


the degree of rotation for the object

the center, or axis, of rotation (for example, to rotate the object


around its center point, or around its top left corner). The center
of rotation can be inside or outside the object. If the center is
outside the object, the object moves in an arc.

With its center of rotation


inside the object at the
top-- left corner, this object
rotates from zero degrees
to 180 degrees as its tag
values change.

Tag values 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

With its center of rotation


outside the object at
the top-- left corner, this
object rotates in an arc
from zero degrees to 180
degrees as its tag values
change.

Tag values 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

To set up rotation animation:

1. Click the object.

2. In the Animation dialog box, click the Rotation tab.

Animating graphic objects ■ 16--33


Preface

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines the object’s rotation.

4. Specify a range of values for the expression:

to use the HMI tag’s range of values to rotate the object, click
Use tag’s min and max property values

to specify a range of values within which the object rotates,


click Use constant, and then type a minimum and maximum
value. When the tag’s value falls within these values, the
object rotates.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the center of rotation using one of the methods described


below. The center of rotation is the point around which the
object will rotate. This point can be inside or outside the object.
If it is outside, the object will appear as if it is moving in an arc.

16--34 ■ RSView Supervisory Edition User’s Guide


Using the preset center points

You can specify a point of rotation by typing coordinates, or


you can use one of the presets by clicking a position in the grid.

If you use the preset center points to define the center of


rotation, the object will rotate around the same point even if the
object is resized. For example, the top-left corner will always be
the center of rotation no matter what size the object is.

Specifying coordinates

The default coordinates 0,0 are the center of the object; all
coordinate values are relative to the center. To specify
coordinates, do one of the following:

using the mouse, drag the circle and crosshair to the desired
center of rotation, and then click the option button next to
The circle and
the box in which the coordinates are displayed
crosshair indicate the
object’s center of
rotation. type values in the coordinates box

6. Set the range of motion for the object.

To set the minimum:

This is the point at which the object’s rotation is at its


minimum. To set the minimim, do one of the following:

click the Rotate tool, and then drag the object to the desired
degree of rotation using the mouse
Rotate Tool
type the desired degree of rotation (this value is relative to
the object’s current position). For clockwise rotation, use a
positive number. For counterclockwise rotation, use a
negative number.

When you are finished, select the At Minimum check box.

Animating graphic objects ■ 16--35


Preface
To set the maximum:

This is the point at which the object’s rotation is at its


maximum. To set the maximum, do one of the following:

click the Rotate tool, and then drag the object to the desired
degree of rotation using the mouse

type the desired degree of rotation (this value is relative to


the object’s current position). For clockwise rotation, use a
positive number. For counterclockwise rotation, use a
negative number.

When you are finished, select the At Maximum check box.

7. Click Apply.

Setting up touch animation


With touch animation, you can specify press, repeat, and release
actions that are triggered when an operator touches an object with a
mouse or on a touch screen.

To highlight touch objects, use the options in the Display Settings


dialog box. You can make a highlight box appear around a touch
object when a cursor passes over the object. You can also make the
computer beep when a touch object is selected.

IMPORTANT If you want to create a momentary push button, create a


momentary push button object, or a button object with
a momentary push button action, rather than an object
with touch animation.

To set up touch animation:

1. Click the object.

2. In the Animation dialog box, click the Touch tab.

16--36 ■ RSView Supervisory Edition User’s Guide


3. In the Press Action box, type an RSView command or a macro.

Separate multiple commands or macros with a semi-colon ( ; ) or


place them on separate lines. Multiple commands are executed
in the order they are listed.

If you want repeat and release actions, type commands or


macros in these boxes as well. Press and release actions occur
when the object is pressed or released. Repeat actions occur at
the rate specified in the Repeat Rate box, and do not wait for the
press command to be completed.

4. If you specified a repeat action, specify a repeat rate. This is how


often the action is repeated while the object is pressed.

5. Click Apply.

Animating graphic objects ■ 16--37


Preface
Setting up horizontal slider animation
With horizontal slider animation, you can create a graphic object
that sets the value of a tag. To do this, define a path for the object
and then use the mouse to move the object horizontally. The pixel
position of the object is translated into values that are written to the
tag. An object can have both vertical and horizontal slider
animation.

To set up horizontal slider animation:

1. Click the object.

2. In the Animation dialog box, click the Horizontal Slider tab.

3. Type the name of the tag whose value will be determined by the
slider.

4. Specify a range of values for the tag:

to use the HMI tag’s range of values to determine the position


of the slider, click Use tag’s min and max property values

to specify a range of values for changing the position of the


slider, click Use constant, and then type a minimum and

16--38 ■ RSView Supervisory Edition User’s Guide


maximum value. When the tag’s value falls within these
values, the position of the slider changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the starting point for the slider object by dragging the object
or by typing a value, and then select the At Minimum check
box.

6. Set the ending point for the slider object by dragging the object
or by typing a value, and then select the At Maximum check
box.

7. Click Apply.

Animating graphic objects ■ 16--39


Preface
Setting up vertical slider animation
With vertical slider animation, you can create a graphic object that
sets the value of a tag. To do this, define a path for the object and
then use the mouse to move the object vertically. The pixel position
of the object is translated into values that are written to the tag. An
object can have both vertical and horizontal slider animation.

To set up vertical slider animation:

1. Click the object.

2. In the Animation dialog box, click the Vertical Slider tab.

3. Type the name of the tag whose value will be determined by the
slider.

4. Specify a range of values for the tag:

to use the HMI tag’s range of values to determine the position


of the slider, click Use tag’s min and max property values

to specify a range of values for changing the position of the


slider, click Use constant, and then type a minimum and

16--40 ■ RSView Supervisory Edition User’s Guide


maximum value. When the tag’s value falls within these
values, the position of the slider changes.

to obtain minimum and maximum values from tags, click


Read from tags, and then specify a tag for the minimum
value, and a tag for the maximum value. When animation
starts, the tags are read once to determine their values. The
values are not updated until animation is stopped and started
again.

5. Set the starting point for the slider object by dragging the object
or by typing a value, and then select the At Minimum check
box.

6. Set the ending point for the slider object by dragging the object
or by typing a value, and then select the At Maximum check
box.

7. Click Apply.

Animating graphic objects ■ 16--41


Preface
Setting up OLE verb animation
With OLE (Object Linking and Embedding) verb animation, you
can set up OLE objects to perform certain actions. When the
expression evaluates to true—that is, when the expression does not
equal zero—the specified OLE verb is activated. The verbs available
depend on the OLE object. Typical verbs include open, edit, and run.

To set up OLE verb animation:

1. Click the OLE object.

2. In the Animation dialog box, click the OLE Verb tab.

3. Create an expression. The expression can be a tag name or a


more complex expression. If you use a tag name, the tag’s value
determines when the OLE verb is activated. A value other than
zero evaluates to true.

4. Click the OLE Verb list to display the OLE verbs available for the
selected OLE object. Click a verb in the list.

5. Click a security code.

To restrict access to this object, assign the appropriate security


code. For example, you might want to restrict access so only a

16--42 ■ RSView Supervisory Edition User’s Guide


senior operator can edit an embedded spreadsheet. For more
information about security, see Chapter 14, Adding security.

6. Click Apply.

Attaching other types of animation to OLE


objects

You can attach many types of animation to OLE objects—just as you


can with other objects. And like other objects, the type of
animation you attach depends on the object. For example, you
could attach visibility animation to a spreadsheet and then create a
button that, when selected, would display or hide the spreadsheet.
This could be used to show or hide various shift reports or
management summaries contained in embedded spreadsheets or
database forms.

Animating ActiveX controls


To animate an ActiveX control in RSView means to connect the
ActiveX control’s properties, methods, or events to tags, so they
can receive or modify data at run time.

There are two ways you can animate an ActiveX object’s


properties, methods, and events with data from RSView:

in RSView Studio, using the Property Panel, the Invoke


command, and the Events and Methods items on the shortcut
menu. This is the simpler way, but less flexible.

in the Visual Basic Editor, using VBA code. This is the more
complex way, but more flexible.

A graphic display is like a Visual Basic form. When you insert


an ActiveX control in a graphic display, you can access the
ActiveX control’s methods, properties, and events using VBA
code. For an overview of how VBA code works in RSView, see

Animating graphic objects ■ 16--43


Preface
Chapter 21, Using the SE Client object model and display code.
For detailed information and code examples, see Help.

You can also change an ActiveX object’s properties without using


tags. If you choose this method, the object’s properties do not
change dynamically at run time. You make static changes to an
ActiveX object’s properties just as you do for any other graphic
object—on the Properties tab in the Property Panel. For more
information, see “Using the Property Panel” on page 15-258.

IMPORTANT The run-time behavior of ActiveX objects depends on


the vendor’s implementation. Before making your
application available to users, test ActiveX objects
thoroughly to ensure they behave as desired.

For details about how to create an ActiveX object, see “Creating


and editing ActiveX objects” on page 15-251.

Naming an ActiveX object

An ActiveX object’s name is used:

to identify the object when logging its events

with commands (for example, when using the Invoke command


to call a method, you must specify the name of the object in
which the method is implemented)

All objects have a default name. You can change the default name of
all objects, including ActiveX objects.

For information about naming graphic objects, see page 15-264.

For information about ActiveX events, see “Connecting tags to an


ActiveX object’s events” on page 16-49. For more information
about the Invoke command, see “Using the Invoke command to
call a method” on page 16-47.

16--44 ■ RSView Supervisory Edition User’s Guide


Connecting tags to an ActiveX object’s properties

Each ActiveX object has a set of properties. To view the object’s


properties, right-click the object, and then click Property Panel on
the shortcut menu.

The content of the property panel is determined by the application


that created the ActiveX object, not by RSView.

To link the Properties of an ActiveX object to tags:

1. Right-click the object. On the shortcut menu, click Property


Panel.

2. In the Property Panel, click the Connections tab.

3. On the Connections tab, assign to tags the properties you want


to change dynamically at run time.

This ActiveX check box


changes an oven’s
temperature control from
Automatic mode to
Manual mode when the
check box is cleared.

To do this, the ActiveX


control’s Value property is
assigned to the Auto tag
in the Oven folder.

Animating graphic objects ■ 16--45


Preface
The middle column indicates whether the property updates the
tag, or the tag updates the property:

a left arrow indicates the tag updates the property

a right arrow indicates the property updates the tag

a double arrow indicates the tag and property update each


other

4. In the Tag column, do one of the following:

Browse button type the name of the tag or expression you want to connect
to the property

click the Browse button in the Tag or Exprn column, and


then select a tag or expression for the property

Connecting tags to an object’s methods


A method is an action the object can perform. Methods are part of
the object.

You can:

view a list of the object’s methods

find documentation for the object’s methods

use the Invoke command to call the object’s methods

16--46 ■ RSView Supervisory Edition User’s Guide


Viewing an object’s methods

The Object Methods dialog box shows the methods implemented


for the selected object.

For more information


about the object and its
methods, click this button.

To view the description of a method:

1. Right-click the object. On the shortcut menu, click Methods.

2. In the Object Methods dialog box, click a method to view its


description.

Using the Invoke command to call a method

To call an object’s method, the object must have a name. For details
about naming ActiveX objects, see page 16-44.

Use the RSView Invoke command to call the method for the named
object.

Animating graphic objects ■ 16--47


Preface
With the Invoke command you can:

call an object’s method

assign the value returned by a method to a tag

set an object’s property to a tag value or a constant

set a tag to the value of an object property

To call an object’s method:

At the command line, or anywhere else you can type a command,


type:

Invoke display_name.object.method(parameter1,
parameter2, . . . )

display_name The name of the graphic display that contains the


object.

me Can be used instead of display_name. At run time it resolves to


the name of the graphic display that currently has focus.

object The name of the object as specified in the Object Name


dialog box.

method The name of a function or subroutine in the object. The


method is initiated by an external event such as the Invoke
command.

parameter The tag name or constant that the method will use.

The easiest way to create the string

display_name.object.method(parameter1, parameter2, . . . )

for the Invoke command is to use the Command Wizard.

16--48 ■ RSView Supervisory Edition User’s Guide


Connecting tags to an ActiveX object’s events
The ActiveX Control Events dialog box shows the events
associated with the selected ActiveX object and allows you to
specify RSView commands or macros that will run when the event
occurs at run time.

To connect RSView commands or macros to events:

1. Right-click the ActiveX object. On the shortcut menu, click


ActiveX Events.

To open the
Command Wizard,
click this button.

For more information


about the object and
its events, click this
button. Help for the
object is provided by
the object’s vendor.

2. Click the event you want to attach the command or macro to.

3. Type the command or macro name, or click the Browse button


to open the Command Wizard, and then click a command or
Browse button macro.

Separate multiple commands or macros with a semi-colon ( ; ) or


place them on separate lines. Multiple commands are executed
in the order they are listed.

4. To connect a tag to an event parameter, click an event parameter.

Animating graphic objects ■ 16--49


Preface
5. Type the tag name or click the Browse button to open the Tag
Browser, and then select a tag. The tag’s value is determined
when the ActiveX event occurs.

6. To log the event, click the check box Log event to activity log
file, and then if necessary, set up logging in the Activity Log
Setup editor.

ActiveX events are logged in the Subsystem category, and are


logged to whatever destination you specify (activity bar, log file,
or printer). For information about setting up activity categories,
see “Specifying which activities are logged” on page 11-10.

When an event is logged, the name of the ActiveX object is the


message that is logged. For details about naming an object, see
“Naming an ActiveX object” on page 16-44.

Using VBA code to make ActiveX objects


interact with RSView

You can also use VBA code to make an ActiveX object’s properties,
methods, and events interact with RSView. For details about
opening the VBA IDE in the context of a selected object, see
“Opening the IDE window” on page 21-3.

Associating objects and displays with keys


You can associate RSView commands with graphic objects in a
display using object keys, and with the display itself using display
keys.

A key is either a key on a keyboard or keypad, or a button on a


touch screen connected to the computer or monitor an operator
uses to interact with the RSView application at run time. Operators
can use these keys to perform actions such as moving between
screens, setting tag values, and so on. 7.

Object keys and display keys are different from client keys. Object
keys and display keys are active only while a particular object or

16--50 ■ RSView Supervisory Edition User’s Guide


display has input focus. Client keys are active at all times. Object
and display keys are discussed on the following pages. For details
about client keys, see page 19-19.

For details about the order of precedence among object, display,


and client keys, see page 19-15.

Creating object keys


Object keys associate graphic objects with keys. When an object
has input focus, an operator can use keys to interact with the object.

For detailed information about how keys work at run time, see
“Specifying the behavior of interactive objects” on page 15-26.

Example: Using object keys

Imagine you have a graphic display showing a tank with two valves.
The two valves control the flow in and out of the tank. Both valves
have been set up with object key animation as follows:

Valve 1 F2 = Open
F3 = Close

Valve 2 F2 = Open
F3 = Close

At run time, operators can select either valve, and then press F2 to
open it and press F3 to close it.

To create an object key:

1. Click an object.

2. On the Edit menu, click Object Keys.

Animating graphic objects ■ 16--51


Preface

3. Click Add.

4. In the Select key list, click a key. If desired, select one or both
modifiers.

Some keys are normally reserved for use by Windows and


RSView. For details about assigning reserved keys as object,
display, or client keys, see page 19-19.

5. Click OK.

The key you added appears in the Key list. If you selected a
modifier, the first letter of that modifier is also displayed. If you
create a label in the next step, it also appears in the key list.

The information in the Key list appears in the key list at run
time, so operators know which keys are associated with an
object and a display. For details about the key list, see “Viewing
the key list at run time” on page 16-69.

16--52 ■ RSView Supervisory Edition User’s Guide


6. In the Label box, if desired, type a label for the key.

7. In the Press Action box and, if desired, in the Release Action


box, type an RSView command or a macro. Separate multiple
commands or macros with a semi-colon ( ; ) or place them on
separate lines.

The command or macro is the action that will occur when the
key is pressed or released.

If you want the command to perform an action on a tag, include


a tag name or the Current [Tag] parameter. The Current [Tag]
parameter is a placeholder for a tag name or any character
string. For details about the Current [Tag] parameter, see “Using
the Current [Tag] parameter” on page 16-58.

8. If you want an action to repeat while the key is held down, type
the RSView command or macro name in the Repeat Action box.

The repeat action repeats at the rate specified in the Keyboard


properties in the Windows Control Panel.

9. If, at run time, you want a highlight box to appear around the
object when it has input focus, select the check box, Highlight
when object has focus. For details, see “Specifying the behavior
of interactive objects” on page 15-26.

10. Click OK.

For details about the Tab index box, see “Using index numbers”,
below. For details about the Current [Tag] box, see “Using the
Current [Tag] parameter” on page 16-58.

Animating graphic objects ■ 16--53


Preface
Using index numbers

RSView assigns index numbers to the following objects:

numeric and string input objects

button objects

objects with object key animation

As you create these objects, they automatically receive a tab index


number. The number increases by one for each object you create.

For example, if you create a numeric input object, then a button


object, and then a string input object, the objects will have the
index numbers 1, 2, and 3.

How tab index numbers work

Tab index numbers are used to:

determine a tab sequence for interactive objects

move among objects using the Position, NextPosition, and


PrevPosition commands at run time. For details about these
commands, see Appendix A, RSView commands, or see Help.

specify which tag value goes into which numeric or string input
field in a recipe file. For details about recipe files, see “Creating
a recipe file” on page 15-231.

16--54 ■ RSView Supervisory Edition User’s Guide


Checking an object’s index number

To check an object’s index number, do one of the following:

double-click the object and then check the number in the Tab
index box

right-click the object, click Property Panel, and then scroll


down to find the number in the TabIndex box

The selected
object has tab
index number 1.

Changing index numbers

Once you have created two or more objects with index numbers,
you can change the index numbers.

For example, if you have created four input fields, you can change
the order of their index numbers. You can change input field 4 to
index number 1. However, you cannot change input field 4 to index
number 5, because you have not created five input fields.

Animating graphic objects ■ 16--55


Preface
When you change an index number, other numbers are adjusted so
two objects do not have the same number and there are no gaps in
the numbering.

There are two ways to change an object’s index number: in the


object’s Properties dialog box, or in the Property Panel.

To change an index number in the object’s Properties dialog


box:

1. Do one of the following:

for a numeric or string input object, open the object’s


Properties dialog box by double-clicking the object

for a button object, open the object’s Properties dialog box


by double-clicking the object

for an object with object key animation, click the object and
then open the Object Keys dialog box

2. In the Index box, type a new number.

3. Click OK.

To change an index number in the Property Panel:

1. Right-click the object, and then click Property Panel.

2. In the TabIndex box, type a new number.

3. Click OK.

If you typed a number that is too high, RSView automatically


adjusts the index number to use the highest available number.

If you type a number that is already in use, RSView renumbers the


other objects in the display. This changes the tab sequence.

16--56 ■ RSView Supervisory Edition User’s Guide


Creating a tab sequence

A tab sequence is the order in which users can move through a


series of objects using the Tab key.

To create a tab sequence, use index numbers. For details about


using index numbers, see page 16-54. 4.

To move through a tab sequence:

press Tab to move through the objects from the lowest index
number (1) to the highest index number.

press Shift-Tab to move through the objects from the highest


index number to the lowest index number (1).

Example: Creating a selection order

In the display below, pressing the Tab key moves users through the
objects in a left to right pattern.

The valves are objects


with object key animation.

The boxes are numeric


input fields.

The buttons are button


objects.

The circled numbers


above the objects show
each object’s index
number.

Animating graphic objects ■ 16--57


Preface
Using the Current [Tag] parameter
The Current [Tag] parameter is a placeholder for a tag name or any
character string. Use this parameter to create a command that is
object specific.

For example, if you want F2 to set the value of a selected object’s


tag to 0, you would set up a display key for F2, using the [tag]
parameter, and then set up object keys for each object on the screen,
specifying which tag to use for each object.

Summary of steps

1. Create a graphic object.

2. On the Animation menu, click Display Keys.

3. In the Display Keys dialog box, associate a key with an RSView


command. For details about creating display keys, see
page 16-66.

4. In the Press Action field, type an RSView command with [tag]


as the command parameter.

5. Select the graphic object.

6. On the Animation menu, click Object Keys.

7. In the Current [Tag] box, type a tag name or a character string.


Current [Tag] need not always be the name of a tag.

At run time, when the object is selected and the display key is
pressed, the contents of the Current [Tag] field replace [tag] in the
RSView command.

16--58 ■ RSView Supervisory Edition User’s Guide


Three examples

Example 1: Creating display-wide keys to open and close


valves

Imagine you have a graphic display containing 20 valves and you


want operators to be able to open and close all the valves with the
same two keys. Instead of specifying the tag name for each valve,
use the [tag] parameter with display keys.

1. In the Display Keys dialog box, assign two display keys. For the
press action, type Set [tag].

Animating graphic objects ■ 16--59


Preface
2. In the Object Keys dialog box, type the tag name in the Current
[tag] field for each valve object.

Type the tag name here.

At run time, the operator can select any valve object, and then press
F2 to open the valve and F3 to close it.

16--60 ■ RSView Supervisory Edition User’s Guide


Example 2: Opening object-specific Help

Imagine you have a graphic display containing various graphic


objects that represent plant-floor equipment. If something goes
wrong with a piece of equipment, you want operators to be able to
select the appropriate object and then display a Help file that
suggests steps for correcting the situation.

1. In the Display Keys dialog box, create a display key. For details,
see page 16-66. In the Press Action box, type Help [tag].

Animating graphic objects ■ 16--61


Preface
2. In the Object Keys dialog box, type the appropriate Help file
name in the Current [tag] field for each equipment object.

Type the name of the


Help file here.

At run time, when an operator selects any equipment object and


presses F4, the help file for that piece of equipment is displayed.

16--62 ■ RSView Supervisory Edition User’s Guide


Example 3: Opening an object-specific alarm summary

Imagine you want to have alarm information available for a specific


machine. If something goes wrong and causes an alarm, you want
the operator to be able to display an alarm summary for that
machine.

To display the alarm summary for the machine, the operator can
position the cursor over any object related to that machine in a
graphic display, and then press a Display Key.

1. Create an alarm summary that uses a filter containing only the


alarms for the machine. The filter must contain a tag placeholder
(for example, #1).

For information about creating an alarm summary, see


page 10-60.

2. In the Display Keys dialog box, assign a display key. In the


Press Action box, type Display AlmSumm /t[tag].

Animating graphic objects ■ 16--63


Preface
3. In the Object Keys dialog box, type the name of the machine
you want to specify in the alarm summary filter.

At run time, the value of [tag] in the Display Keys, replaces #1


in the Alarm Summary filter, and then displays alarms for the
selected machine only.

Type the name of the


machine whose alarms
you want to view in the
alarm summary.

16--64 ■ RSView Supervisory Edition User’s Guide


Creating display keys
Display keys work like object keys, except that instead of
associating a key with an object, the key is associated with a whole
graphic display. This means that an object in the graphic display
does not have to be selected before the key will respond when
pressed.

Using the keys, operators can interact with the graphic displays at
run time.

Example: Using a display key

Suppose you want the Home key to display a main menu display.
To do this, create a display key. In the Press Action box, type:

Display Main Menu

Whenever an operator presses Home, the active graphic display


closes and the Main Menu display opens.

If the Main Menu display is of the Overlay display type, you must
use the Abort command to close the active display.

For details about how keys and other interactive objects work at
run time, see “Specifying the behavior of interactive objects” on
page 15-26.

Animating graphic objects ■ 16--65


Preface
To create a display key:

1. On the Edit menu, click Display Keys.

2. Click Add.

3. In the Key list, click a key and, if desired, select one or both
modifiers.

Some keys are reserved for use by Windows and RSView.


Reserved keys do not appear in the Key list.

4. Click OK.

The key you added appears in the Key list. If you selected a
modifier, the first letter of that modifier is also displayed. If you
create a label in the next step, it also appears in the key list.

The information in the Key list appears in the key list at run
time, so operators know which keys are associated with an

16--66 ■ RSView Supervisory Edition User’s Guide


object and a display. For details about the key list, see “Viewing
the key list at run time” on page 16-69.

5. In the label box, if desired, type a label for the key.

6. In the Press Action box and, if desired, in the Release Action


and Repeat Action boxes, type an RSView command or a macro,
Browse button or click the Browse button to open the Command Wizard.

The command or macro is the action that will occur when the
key is pressed, pressed and held, or released. Separate multiple
commands or macros with a semi-colon ( ; ), or place them on
separate lines.

If you want the command to perform an action on a tag, include


a tag name or the [tag] parameter. For details about the [tag]
parameter, see “Using the Current [Tag] parameter” on
page 16-58.

7. Click OK.

Editing display and object keys


Editing display and object keys is the same except that for object
keys you must first click an object.

Modifying a key

1. On the Edit menu do one of the following:

to modify display keys, click Display Keys

to modify object keys, click an object or select a group of


objects, and then click Object Keys

2. In the Key list, click the key you want to modify.

3. Click the Modify button.

4. Make the necessary changes, and then click OK.

Animating graphic objects ■ 16--67


Preface
Removing a key

1. On the Edit menu do one of the following:

to remove display keys, click Display Keys

to remove object keys, click an object or select a group of


objects, and then click Object Keys

2. In the Key list, click the key you want to remove.

3. Click the Remove button, and then click OK.

Removing all keys

1. On the Edit menu do one of the following:

to remove display keys, click Display Keys

to remove object keys, click an object or select a group of


objects, and then click Object Keys

2. Click the Remove All button, and then click OK.

16--68 ■ RSView Supervisory Edition User’s Guide


Viewing the key list at run time

At run time, users can use the key list to see which keys are
associated with an object and display, and to see what actions the
keys will perform. 3.

Label

Modifiers

Key

The key list displays the keys listed in the Key list in the Object
Keys and Display Keys dialog boxes. All object keys are displayed
first in the list, and then all display keys. The key list does not
separate the two types of keys because this distinction does not
matter to operators—they only need to know what action will
occur when they press a key.

To display a key list at run time:

1. Position the cursor over an object with key animation.

2. Click the left mouse button.

The key list is displayed. It lists keys associated with this object
and all keys associated with this display.

Animating graphic objects ■ 16--69


Preface
Disabling the key list

To disable the key list, use the /O parameter with the Display
command. For details, see Appendix A, RSView commands, or see
Help.

Applying animation to groups


You can apply animation to objects and then group those objects
and apply animation to the group. When the display is running,
animation is evaluated from the inside out: animation is evaluated
first for the individual objects, and then for the group of objects as a
whole.

To apply animation to objects within groups, use the group edit


feature. For details about editing grouped objects, see page 15-277.

Checking the animation on objects


Use the Animation menu or the Animation dialog box to see what
type of animation a graphic object or grouped object has. To see
what type of animation objects within a group have, use the group
edit feature. For details about editing grouped objects, see
page 15-277.

You can also use the Tag Substitution dialog box to find which
object in a graphic display is animated by a particular tag. For
details, see page 16-72.

16--70 ■ RSView Supervisory Edition User’s Guide


Checking animation using the menu or the
Animation dialog box

To view the animation on an object using the menu:

1. Click an object.

2. View the animation by doing one of the following:

click the Animation menu, and then see which items have a
check mark

right-click the object to display the shortcut menu, point to


Animation, and then see which items have a check mark

The object has


visibility animation.

Animating graphic objects ■ 16--71


Preface
To view the animation on an object using the Animation
dialog box:

1. Click an object.

2. On the View menu, click Animation.

When the Animation dialog box opens, see which items have a
check mark.

Finding an object that is animated by a tag

Use the Tag Substitution dialog box to find which object in a


graphic display is animated by a particular tag.

To find which object uses a particular tag:

1. Open a graphic display.

2. On the View menu, click Object Explorer.

3. Select all of the objects in the graphic display.

4. On the Edit menu, click Tag Substitution.

5. In the Search for list, type or select the name of the tag.

6. In the Replace with list, type or select the name of the same tag.

7. If the confirm replacements check box is not selected, click to


select it.

8. Click Replace.

The name of the object appears in the Usage box, and is selected
in the Object Explorer.

9. If the tag is used in multiple objects, click the Next button to


find the next object that uses the tag.

10. When you are finished, in the Tag Substitution dialog box, click
Cancel.

16--72 ■ RSView Supervisory Edition User’s Guide


Changing the animation on objects
You can change the animation attached to a group of objects or to
individual objects within the group. To access objects within a
group, use the group edit feature. For details about editing grouped
objects, see page 15-277.

To change the animation on objects:

1. Select one or more objects.

2. Open the Animation dialog box.

3. Make the required changes.

4. Click Apply.

Copying or duplicating objects with animation


You can copy or duplicate objects that have animation attached to
them. When you do, the animation attached to the objects is also
copied or duplicated.

If you copy or duplicate a group, the copy of the group can be


ungrouped to individual objects, just like the original.

For information about copying and duplicating objects, see


pages 15-271 and 15-273.

Animating graphic objects ■ 16--73


Preface
To copy objects with animation:

1. Select the objects.

2. Do one of the following:

use the copy and paste commands on the Edit menu or


toolbar, or use Ctrl-C to copy and Ctrl-V to paste

in the same display, drag the object and then press Ctrl and
drop the object

between displays, drag and drop objects

To duplicate objects with animation:

1. Select the objects.

2. On the Edit menu, click Duplicate.

Copying animation without copying objects


If you have attached animation to an object, you can copy the
animation and paste it onto another object. If the object has more
than one type of animation, all animation is copied and pasted.

You cannot use RSView animation with ActiveX controls.

To copy and paste animation:

1. Click the object that has the animation you want to copy.

2. On the Edit menu, click Copy Animation.

3. Select the object(s) that you want to copy the animation to.

4. On the Edit menu, click Paste Animation.

16--74 ■ RSView Supervisory Edition User’s Guide


17
Chapter

Setting up trends
This chapter describes trends, and outlines how to:

create and set up a trend object

overlay trends to compare real-time and historical tag values

use objects from the Trends graphic library

What is a trend?

A trend is a visual representation (chart) of real-time or historical


tag values. The trend object provides operators with a way of
tracking plant activity as it is happening.

You can:

plot data for as many as 100 tags on one trend

use shading to emphasize a comparison between two pens

create a trend that is part of a graphic display or acts as the


entire graphic display

plot data over time, or plot one pen against another in an x-y
plot chart to show the relationship between them

display isolated or non-isolated graphs. Isolated graphing places


each pen in a separate band of the chart. With non-isolated
graphing, pen values can overlap

Setting up trends ■ 17--1


Preface
This illustration shows two trends that have been added to a
graphic display.

17--2 ■ RSView Supervisory Edition User’s Guide


The parts of a trend

The illustration below shows a standard trend chart, with two pens
and a three-minute time span. For more information about plot
types, see page 17-40.

Chart title
Trend
border
Chart
Pen icon
y-- axis

y-- axis Pens


legend
Pen icon

x-axis

x-axis
Scrolling
legend
mechanism

Line legend and current value


legend in the ‘bottom’ position

Chart

The chart is bounded by the y-axis on the left and the x-axis on the
bottom. The chart contains the plotted trend data (shown using pen
lines and pen markers), as well as grid lines.

x- axis

The x-axis is the bottom horizontal edge of the chart. It is also


known as the horizontal axis or time axis.

Setting up trends ■ 17--3


Preface
x- axis legend

For standard charts, the x-axis legend indicates the time span
covered by the trend. For x-y plot charts, the x-axis legend shows
the scale (range) of values for the pen selected to serve as the x-axis
pen.

You can set up the trend to omit the x-axis legend. The number of
timestamps shown depends on the size of the trend object and the
number of vertical grid lines.

The x-axis legend can also be used during run time to open the
X-Axis Property tab. See “Opening TrendX tabs at run time” on
page 17-67.

y- axis

The y-axis is the left vertical edge of the chart. It is also known as
the vertical axis.

y- axis legend

The y-axis legend show the scale (range) of values for the pens. You
can set up the trend to omit the y-axis legend.

The minimum and maximum values for the scale can:

be determined automatically (using the best fit for the current


data)

be derived from a pen’s minimum and maximum values

use a constant value

or be controlled by tags.

You can set up the trend so that all pens use the same scale, or all
pens use individual ranges for each pen. When the operator clicks

17--4 ■ RSView Supervisory Edition User’s Guide


each pen in the line legend, the vertical axis changes to the new
pen’s range.

For example, if Pen 1 has a minimum value of 10 and a maximum


value of 100, the range on the vertical axis is 10 to 100 when the pen
is selected. If Pen 2 has a minimum of –10 and a maximum of 50,
the range on the vertical axis changes to –10 to 50 when the
operator selects the next pen in the line legend.

The y-axis legend can also be used during run time to open the
Y-Axis Properties tab or to pan data. See “Opening TrendX tabs at
run time” on page 17-67.

Pens

Pens are the lines or symbols used to represent values. Pens can be
different colors, widths and symbols so operators can distinguish
one pen from another easily. The pen values can be tags you are
monitoring, expressions that manipulate tag values, or constants.

Legends

There are two kinds of trend legends in RSView.

The line legend shows the color, name, description, minimum value
and maximum values for each pen line shown on the trend chart.

The current value legend shows the pen icon, current pen value, and
current time for each pen line shown on the trend chart.

The position of the line legend determines where the current value
legend appears on the chart. When the position of the line legend is
set to “Left,” the line legend appears on the left-hand side of the
trend chart and the current value legend appears on the right-hand
side. When the position of the line legend is set to “Bottom,” the
current value legend appears as a column in the line legend. For
more information about positioning the line legend, see
“Displaying a line legend” on page 17-31.

Setting up trends ■ 17--5


Preface
Pen icons

Pen icons appear at the right edge of the chart, if you choose to
display them.

At run time, if a pen’s current value is within the range shown on


the vertical axis, the icon is displayed. The icon’s position indicates
the pen’s most recently recorded value, even if the trend is paused,
or if the most recent value has not yet been plotted.

TrendX Properties dialog box

The TrendX Properties dialog box contains eight tabs for setting up
the appearance and content of the trend. By filling in the fields on
these tabs, you specify what kind of data the trend will plot, and
how the data will look. For more information about the TrendX
Properties dialog box, see “Setting up the appearance of a trend” on
page 17-23.

17--6 ■ RSView Supervisory Edition User’s Guide


Pen markers

Pen markers are symbols that indicate data points. A data point is
the exact position of a value plotted on a trend chart. If data is
plotted frequently, the markers might not appear as distinct,
separate symbols, as shown in the trend chart below.

You can use pen markers to show when data is sampled. For
example, when the trend is updated On change using the deadband
or heartbeat, the pen marker indicates when the trend is updated.

You can also use pen markers to read pen values more easily during
runtime by placing the value bar directly over a pen marker.

A ‘Boxed’ pen marker

An ‘Up triangle’
pen marker

Setting up trends ■ 17--7


Preface
Value Bar

The value bar is a vertical marker that details the value of each pen
at the selected position on the trend chart. You can position the
value bar by clicking anywhere on the trend chart during run time.

The value bar

Main concepts

Plotting tag limits

Use horizontal lines to provide an orientation for your tag data. For
example, if you define values that are the limits within which a tag
should operate, and display horizontal lines in your trend to
indicate the limits, when a tag crosses one of these limits the tag’s
alarm condition is obvious on the trend. Both pens must use the
same minimum and maximum values.

17--8 ■ RSView Supervisory Edition User’s Guide


There are two ways to plot a value so that it appears as a horizontal
line across the full width of the chart:

On the Pens tab, add a pen with a constant value.

When values for the pen have been plotted across the full width
of the chart, the pen appears as a solid horizontal line.

On the Pens tab, add a pen with a tag or expression that will
determine the position of the pen line. In the Type column of
the Pens attribute spreadsheet , choose Full Width.

As soon as the trend is displayed, the pen appears as a horizontal


line across the full width of the chart.

The pen’s vertical position is determined by the tag, expression, or


constant’s value. If the value changes, the position changes.

Displaying data in a trend

The data displayed in a trend can come from two sources. A data
server collects real-time data for the trend. Historical data comes
from a data log model’s set of files.

You can plot historical data from a data log model in the HMI server
you are running, or you can plot data from a different HMI server,
either on the same computer or on another computer in the
application. Displaying data from a different HMI project is called
remote trending. For more information about data log models, see
Chapter 12, Setting up data logging.

When the trend chart is paused, pen data is saved in the data buffer.
The buffer contains up to 32,767 tag values per pen. A tag value is
saved to the buffer whenever the value changes. When the buffer is
full, the oldest value is overwritten with a new value. You can also
use the buffer to collect data for the trend when trend is not visible
on the graphic display. For information about charting data when

Setting up trends ■ 17--9


Preface
the trend is not visible in the graphic display, see “Collecting data in
the background during run time” on page 17-66.

You can also layer a trend with a snapshot of previously charted


data. This is called an overlay. An overlay compares charted data to
a snapshot, and is useful if you want to compare data from a
particular shift or batch process.

The overlay pen

Currently-- plotting pen

Currently-- plotting pen

The overlay pen

Comparing pens

You can set up a trend so that certain parts of it are shaded to


emphasize a comparison between two pens. At least two pens must
be set up before you can use shading.

For example, you can set up Pen 1 to show a tag’s value and Pen 2
to show a constant value that is an alarm threshold. When Pen 2 is
the upper boundary for Pen 1, the shading will highlight where the
tag’s value exceeds the alarm threshold by filling in the area
between the two pens with Pen 1’s line color.

17--10 ■ RSView Supervisory Edition User’s Guide


Set up shading on the Pens tab in the TrendX Properties Dialog
box.

IMPORTANT Shading is determined by the position of lines on the


screen—not by the actual tag values—because each tag
has its own vertical axis. This is important if you have
specified different minimum and maximum values for
the pens.

The figure below calls attention to tag values in alarm. The


difference between the tag’s value and the tag’s alarm level is
shaded.

Shading between
pen values
Upper-- bound pen

Lower-- bound pen

Setting up trends ■ 17--11


Preface

Example: Shading with three pens

The upper pen, Pen 2, has a constant value of 75 and the lower pen,
Pen 3, has a constant value of 25. Pen 1 represents the tag called
VIN_LEVEL. The trend is shaded whenever Pen 1 goes above Pen 2 or
below Pen 3. A plot for this trend looks like this:

Pen 1
Pen 2

Pen 3

40064

To produce the shading shown above, the following settings were


used:

Tag Name or
Pen Constant Value Shading

Upper Bound Lower Bound

Pen 1 VIN_LEVEL Pen 2 Pen 3

Pen 2 75

Pen 3 25

17--12 ■ RSView Supervisory Edition User’s Guide


Example: Shading with two pens

Whenever Pen 1 goes above Pen 2, the trend is shaded like this:

Pen 1

Color 1

Pen 2

42603

To produce the shading shown above, the following settings were


used:

Pen Tag Name Shading

Upper Bound Lower Bound

Pen 1 VIN_LEVEL Pen 2

Pen 2 OIL_LEVEL

Setting up trends ■ 17--13


Preface

Example: Shading between two pens

Whenever Pen 1 goes above or below Pen 2, the trend is shaded like
this:

Pen 1

Color 1

Pen 2

40065

To produce the shading shown above, the following settings were


used:

Pen Tag Name Shading

Upper Bound Lower Bound

Pen 1 VIN_LEVEL Pen 2 Pen 2

Pen 2 OIL_LEVEL

17--14 ■ RSView Supervisory Edition User’s Guide


Trend chart types

Standard Chart

A standard chart plots tag values against time.

In a standard chart, the


y-- axis shows tag
values . . .

. . . and the x-- axis legend


shows time values.

Setting up trends ■ 17--15


Preface
XY Plot Chart

An x-y plot chart plots one (or more) tag’s values against another
tag.

In an x-- y plot, the y-- axis


shows tag values . . .

. . . and the x-- axis legend


shows tag values.

The x-axis legend displays the range for the X-axis pen. The time
period covered by the chart is at the upper left.

17--16 ■ RSView Supervisory Edition User’s Guide


Isolated graphing

For charts with multiple pens, you can allow the pen values to
overlap, or you can isolate each pen in its own horizontal band on
the chart.

This is an example of isolated graphing, with 0% isolation between


each pen’s band:

In this illustration each pen uses its own scale. You can use the same
scale for all pens.

With isolated graphing, a grid line is automatically placed above


each pen’s band.

Setting up trends ■ 17--17


Preface
Choosing trend colors, fonts, lines, and markers
The following table summarizes where to specify colors, fonts,
lines, and markers for a trend in the TrendX Properties dialog box.

And then use this


To specify this Click this tab box or column

Chart background color Display Background color

x-axis legend text color Display Text color

Text font, style, and size Display Font (button)

Pen line, pen marker, pen icon, Pens Color


and y-axis legend text color

Pen line width Pens Width

Pen line style Pens Style

Pen marker Pens Marker

Vertical grid line color X-Axis Grid color

Horizontal grid line color Y-Axis Grid color

You can also specify these settings in the Properties tab of the
Property Panel.

Changing the trend highlight color

The chart title, y-axis legend, x-axis legend and line legend use the
highlight color for the graphic display, specified in the Behavior tab
of the Display Settings dialog box.

17--18 ■ RSView Supervisory Edition User’s Guide


Changing the trend chart background color

The default background color of the trend chart is black. To change


it, click the Background color on the Display tab and then click a
color from the palette.

This is an example of a
chart with background
color.

Setting up trends ■ 17--19


Preface
Changing the trend object background

The space behind and around the trend chart and legends is the
background of the trend object. The color and style settings for the
background can be changed using the WindowStyle and
WindowColor options on the Property Panel.

The shaded area is the


background of the
trend object.

There are three options for the WindowStyle property:

Default uses the opaque WindowStyle and RSView’s ambient


color settings.

Opaque uses the WindowStyle color

Transparent allows other objects to be seen when they are


located behind the trend object. This setting may slow the
drawing of the trend.

17--20 ■ RSView Supervisory Edition User’s Guide


To display the trend object background color:

1. In the Property Panel, click WindowColor.

2. Select a window color from the list.

3. Click WindowStyle and then click Opaque from the list.

For information about using the Property Panel, see page 15-258.

Testing the trend


To test the trend, use Test Display mode. If communications are
active and there is data for the tags, the pens plot values in the
trend. When you are finished testing, switch back to edit mode to
continue editing.

To switch between test and edit modes:

" On the View menu, click Test Display or Edit Display, or click
the Test Display or Edit Display tools.
Test Display tool

IMPORTANT Test mode is not the same as running the display. Test
mode does not change the appearance or position of
the display, as set up in the Display Settings dialog
Edit Display tool box.

Summary of steps for creating a trend

There are two basic steps for creating a trend:

1. Create a trend object in a graphic display.

2. Set up the trend in the TrendX Properties dialog box.

Setting up trends ■ 17--21


Preface
Creating a trend object

Instead of creating a trend from scratch, you can use the trend in
the Trends graphic library. For more information, see “Using the
Trends graphic library” on page 17-65.

To create a trend object:

1. In the Graphics folder, right-click Displays and then click New.

2. Choose the Trend drawing tool by doing one of the following:

click the Objects menu, point to Advanced Objects, and then


click Trend

click the trend tool in the Objects toolbar

Trend tool
The cursor changes to the trend drawing tool:

3. Drag the mouse to create a box approximately the size you want
for the trend.

4. Double-click the trend to open the TrendX Properties dialog


box.

5. Set up the trend as described on the following pages.

Once you have set up the trend, you can edit it as you would any
other graphic object. You can move it, resize it, attach animation to
it, and so on. You can also use this object in other graphic displays
by dragging it from one display and dropping it into another.

For detailed information about graphic objects, see Chapter 15,


Creating graphic displays.

17--22 ■ RSView Supervisory Edition User’s Guide


Setting up a Trend
Use the TrendX Properties dialog box to set up the trend.

To open the TrendX Properties dialog box:

" Do one of the following:

double-click the trend

right-click the trend to display the shortcut menu, and then


click Properties

click the trend, click the Edit menu, and then click
Properties

Setting up the appearance of a trend

On the General tab,


set up the chart title,
data server type, chart
style, and chart update
mode.

Setting up trends ■ 17--23


Preface
Display chart title

Click the Display chart title check box and then type the title text
(up to 80 characters). The chart title also displays the current date at
the top of the trend chart.

Data Server

The data server determines where the data for the trend is acquired.
Select the type of data server to provide data to the trend:

None acquires TrendX real-time values using the TrendX object


model. If no server is defined in the object model, data is
acquired from RSView. For more information about using the
TrendX Object Model, see Help.

Real-- time data server acquires data from tags and data log
models

Display progress bar while loading historical data

Click this box to display a progress bar with a Cancel button while
data is being loaded into the Trend. Providing this option allows
operators to cancel a request for data. The progress bar does not
appear if the data loads faster than 1 second.

17--24 ■ RSView Supervisory Edition User’s Guide


Selecting a chart style

A trend can be plotted against time or against a selected pen.

Standard

Click Standard to plot each pen against time (with time on the
horizontal axis).

XY Plot

Click XY Plot to create a trend with a pen that serves as the x-axis.
This option is available only when one or more pens have been set
up on the Pens tab.

X--Axis pen

Select the pen for the x-axis in an x-y plot.

Setting up trends ■ 17--25


Preface
Setting up the chart update method

Manual

This option is only available when the data server is set to None. It
does not apply when using the real-time data server.

Click Manual to update data faster than once every 50 milliseconds,


or if you need to maintain control over data timestamps. A data
timestamp is the time associated with a data point, for example,
when the data was sampled. Control over timestamps can be useful
if the data is recorded in blocks by another system.

Automatic

Click Automatic to update data at regular time intervals. Use the


Refresh rate option to determine the interval.

Refresh Rate

Type a number and then click a time unit to determine how often
the trend updates data. The refresh rate range is 50 milliseconds to
596 hours.

IMPORTANT Do not make the refresh rate faster than the rate at
which data is updated in the data server, OPC server, or
DDE server.

17--26 ■ RSView Supervisory Edition User’s Guide


On Change

Click On Change to update the data when a value changes. This


mode is useful for data that changes infrequently. Use the heartbeat
or deadband option to determine when data is updated.

Heartbeat

A heartbeat is a regular, timed update of data. Type a number in the


field to specify how often data is updated even if no change has
occurred, and then click a time unit. If you do not want to use the
heartbeat, type 0.

Deadband

A deadband is an update of data determined by the amount of


change between one value and the next. Type a number to specify
the percentage by which a value must change before the trend chart
is updated. If you want to update the chart whenever the value
changes, type 0.

Setting up trends ■ 17--27


Preface
Setting up the chart display options

Use the Display tab to


set up the appearance
of the trend at run time.

Time format

Specify how the trend displays time:

Use system time format—displays time using the time format


specified in the Windows Control Panel, in the Regional
Options dialog box.

24-hour format

AM/PM format

Chart radix

Specify the numeric base format (decimal, hexadecimal, or octal)


for displaying numeric values in the trend labels. If you select the

17--28 ■ RSView Supervisory Edition User’s Guide


x-y plot chart style, this setting affects the labels on the y-axis,
x-axis, current value legend, and value bar.

Hexadecimal and octal numeric base formats do not use decimals.


Therefore, if the number of decimal places specified in the Y-Axis
tab is set to anything other than 0, that setting overrides the radix
selection, and all numbers are displayed as decimals.

Data point connection

Specify how data points on the trend are connected:

Connect points—data points are connected with a line.

Show discontinuity—plot lines are disconnected between the


start and end of a discontinuity in data. A discontinuity in data
indicates a communication error, or a break in a model’s data
logging.

Show only markers—a marker is displayed for each data point.


Lines do not connect the data points, so if a pen doesn’t have a
marker assigned to it (in the Pens tab), the pen does not appear
in the trend.

Display milliseconds

If you select the standard chart style, click this box to display
milliseconds in the time labels on the x-axis. Click the Display scale
check box on the X-Axis tab to display time labels.

Display value bar

To view details about a specific point in the trend, use the value bar.
At its position on the trend chart, the value bar displays each pen’s
value, date and time. For more information about the value bar, see
“Using the value bar at run time” on page 17-68.

Setting up trends ■ 17--29


Preface
Background color

Click the background color box and then click a color in the
palette.

The chart border is always black. For information about setting the
background color for the other areas in the trend, see page 17-18.

Text color

Click the text color box and then click a color in the palette.

The labels on the vertical axis use the color of the first pen, unless
you click the “Each pen on independent scale” option (in the
Y-Axis tab). If you click “Each pen on independent scale,” the label
color matches the pen whose range is currently displayed on the
vertical axis.

Font

Click this button to change the type style of the text in the trend.

Displaying a current value legend

The current value legend can be displayed to the right of the Trend
chart or as part of the line legend. The line legend includes the
current value legend when it is set to appear at the bottom of the
trend chart. When the line legend is displayed to the left of the
trend, the current value legend is displayed to the right of the trend.

Current time
Current pen value
Pen icon
Pen line color

17--30 ■ RSView Supervisory Edition User’s Guide


Display pen values

Click this box to display pen values in the current value legend.

Display time

Click this box to display the time when data was last collected in
the current value legend.

Display pen icons

Click this box to display the pen icons in the current value legend.
The pen icons show the current value of the tag. When the chart is
paused, the pen icon continues to chart the current value of the tag,
and therefore could be in a different position than the end of the
pen line in the chart.

Displaying a line legend

Pen caption Current Min/Max Engineering


value legend values Units

The line legend shows the details of a pen line, including the line
color, tag name, and the minimum and maximum values.

Setting up trends ■ 17--31


Preface

Display Line Legend

Click this box to display a legend for each pen line. If you choose
to display a legend, specify a position and the number of pens to
include in the line legend.

Position

Specify a position for the line legend:

Bottom—the line legend and the current value legend appear at


the bottom of the chart

Left—legend appears to the left of the chart

Max viewable

Type a number from 1 to 100 for the maximum number of pens


shown in the line legend when it is displayed at the bottom of the
trend.

Display mix/max values

Click this box to display the minimum and maximum values for
each pen in the line legend. The minimum and maximum values are
set on the Pens tab. For more information about setting minimum
and maximum values, see “Setting up pen attributes” on page 17-38.

17--32 ■ RSView Supervisory Edition User’s Guide


Pen caption

Specify the type of pen caption to be displayed:

Long tag name displays the full path and tag name for each pen.

Short tag name displays only the tag name, without the path.

Description displays the tag description set up on the Pens tab.

Maximum pen caption length

Specify the maximum number of characters that can appear in the


pen caption, up to 80 characters.

Determining how the trend chart is filled


with data

Allow scrolling

Check this box to update the trend continuously with new data at
run time. If you clear this option, data is not plotted on the trend,
instead, the data buffer fills with trend data until the buffer limit is

Setting up trends ■ 17--33


Preface
reached. The chart will not update until the operator toggles the
scroll mode manually (using the Pause button).

If you allow scrolling, specify a scroll mode:

Continuous Scroll—as the trend data is plotted, the chart scrolls


from right to left for each new data update.

Half Screen Scroll—as the trend data is plotted, the chart scrolls
half a screen at a time. Pens scroll from the left to the right,
starting at the left of the chart. When the pens reach the
right-hand side of the chart, the chart scrolls half a screen and
the pens begin plotting values again in the center of the chart.

Full Screen Scroll—as the trend data is plotted, the chart scrolls
a full screen at a time. Pens scroll from the left to the right,
starting at the left of the chart. When the pens reach the
right-hand side of the chart, the entire chart scrolls and the pens
begin plotting values again at the left-hand side.

Display Scrolling Mechanism

Click this box to display VCR-style buttons for scrolling the chart
manually.

The buttons allow operators to scroll backward and forward


through data and to toggle between pausing and resuming
automatic scrolling. For more information, see “Scrolling options at
run time” on page 17-68.

Buffer for extra data

The trend buffer collects and stores pen values. The operator can
view these pen values by using the VCR-style buttons to scroll
through the data manually.

Type the number of extra data points outside of the display area to
store for each pen.

The maximum buffer size is 32,767 data points per pen.

17--34 ■ RSView Supervisory Edition User’s Guide


Scrolling is faster when pen values are stored in a buffer. However,
a larger buffer size also requires more system resources.

Adding pens to the trend

The Pens tab lets you set


up the appearance, tag
and expressions for a pen
or multiple pens.

To add pens to the trend:

1. On the Pens tab, click Add pen.

2. The Expression Editor dialog box allows you to add either an


expression or a tag to the trend. For more information about
using the Expression Editor, see Chapter 18, Creating
expressions, or see Help.

to show a tag value, click Tags and then specify or type a tag
name in the Tag Browser

to show a constant value—such as a tag’s alarm level—type a


value in the Expression box

Setting up trends ■ 17--35


Preface
to define an expression, use the buttons in the Expression
Editor

to define the pen’s tag at run time, type a tag placeholder in


the Expression box

A tag placeholder is the cross-hatch character ( # ) followed


by a number from 1 to 500. For details about placeholders,
see “Using tag placeholders” on page 15-52.

3. Click OK. The new pen is added to the Pen Attributes


spreadsheet.

Adding a pen from a data log model

Before you can add a pen from a data log model to the trend, a data
log model must be created. For more information about creating
data log models, see Chapter 12, Setting up data logging.

17--36 ■ RSView Supervisory Edition User’s Guide


To add a pen to the trend from a data log model:

1. On the Pens tab, click Add Pen(s) from Model.

2. Click the browse button to select an area.

3. Specify a data log model from the Model list. The pens available
to select from the data log model are listed in the box.

4. Click the pen you want to add and then click Add. To add all of
the pens in the model, click Add all.

To select multiple pens, do one of the following:

click the first pen you want to select, press and hold down
the Shift key, and then click the last pen you want to select

click and then drag the mouse across the numbers of the pens
you want to select

or, to select pens that are not consecutive, click the first pen
you want to select, press and hold down the Ctrl key, and
then click each pen you want to select

5. The pens that will be added to the trend are listed in the Tags to
monitor box.

6. If you made a mistake and do not want to add one or all of the
pens listed in the tags to monitor box, click the pen and then
click Remove, or click Remove all.

7. When the Tags to monitor box lists the pens you want to add to
the trend, click OK.

Setting up trends ■ 17--37


Preface
Deleting a pen from the trend

1. Click the pen you want to delete from the Pens Attribute
spreadsheet.

To select multiple pens, do one of the following:

click the first pen you want to select, press and hold down
the Shift key, and then click the last pen you want to select

click and then drag the mouse across the numbers of the pens
you want to select

or, to select pens that are not consecutive, click the first pen
you want to select, press and hold down the Ctrl key, and
then click each pen you want to select

2. Click Delete pen(s)

Setting up pen attributes

The Pen Attributes box is a spreadsheet where you can set up the
individual attributes for each pen. The pen attributes define how
the tag is represented on the run time chart. To see all of the
available attributes, use the scroll bar at the bottom of the box.

Line Number

This column identifies the line number of the pen. Up to 100 pens
can be added to a trend. To select a pen, click the line number.

Tag/Expr.

This column displays the expression or the name of the tag you
specified when you added the pen. At run time, the line drawn in
the trend chart by this pen is determined by the value of the tag or
expression. Click the browse button to edit the expression or tag
name.

17--38 ■ RSView Supervisory Edition User’s Guide


Model

Click the browse button to select a data log model for a pen. For
more information about data log models, see Chapter 12, Setting up
data logging.

Color

Click the color column and then click a color in the palette. Do not
choose the same color as the background of the trend object.

Visible

By default, all pens in a trend are visible. However, too many pens
on one display can be difficult to read.

Click in the Visible column to toggle the visibility of the pen. When
Visible is set to Off, the pen is masked in the chart (i.e. not
displayed).

Width

The pen width affects the thickness of the pen line and the markers.

Click in the column and then specify a pen width from the
drop-down list box. If you specify a width other than 1, you cannot
change the line style setting.

Setting up trends ■ 17--39


Preface
Type

Click in the column and then specify how the trend line is plotted
on the chart:

This item Does this

Analog Draws a straight line between two points, which


suggests a gradual change from the first point to the
second point. For example:


Digital Draws a line along the time axis at the first value then,
when the value changes, draws a vertical line to the
second value. For example:


Full Width Draws the most recent value for a tag horizontally
across the trend. For example, if the most recent value
for a tag is 75, draws a line across the trend at 75. When
the value changes, redraws the line at the new value.

You can use full width to display values that act as high
and low setpoints.

17--40 ■ RSView Supervisory Edition User’s Guide


Style

Click this column and then specify a line type. You can select from
one of five styles, shown below.

The styles are:

Solid

Dash

Dot

Dash-Dot

Dash-Dot-Dot

Marker

Click a plot symbol for each data point from the list. If you use the
“Show only markers” option (specified in the Display tab), only
pens for which you specify a plot symbol are displayed in the trend.

The marker appears at each data point. You can select from none,
boxed, up triangle, down triangle, letters, characters, or the line
number of the pen.

Name Symbol

Boxed j

Up Triangle

Down Triangle

Letters A, a, B, b

Keyboard Characters <:!@#(

Line Number 1, 2, 3

If a pen displays new data frequently, for example every few


seconds, the markers might appear to form a solid line.

Setting up trends ■ 17--41


Preface
Min/Max

Click in these columns and then type a value to change the tag’s
minimum and maximum range as set up in the Minimum and
Maximum fields on the Y-axis tab. To have the same range on the
vertical axis, specify the same minimum and maximum values for all
pens.

If you specify the “Preset minimum/maximum value” option (in


the Y-Axis tab), type the minimum and maximum values for the
pens.

The minimum and maximum values, together with the scaling


options you specify in the Y-Axis tab, determine the range of the
trend’s vertical axis. Tag values outside this range do not appear on
the chart.

Eng. Units

Click this box and then type the name of the engineering unit that
the pen represents. For example, rpm, gallons, fps, or degrees. The
engineering units will be displayed as part of the line legend.

Description

Click this box and type a text description of the tag if you want a
pen caption in the line legend.

Lower Bound

The lower bound setting determines when shading will occur


between two pens. When you specify a lower bound pen for the
pen you are defining, the area between the two pens is shaded when
they cross. Click this cell and specify the lower bound pen from the
drop-down list box. For information about using shading, see
“Comparing pens” on page 17-10.

17--42 ■ RSView Supervisory Edition User’s Guide


Upper Bound

The upper bound setting determines when shading will occur


between two pens. When you specify an upper bound pen for the
pen you are defining, the area between the two pens is shaded when
they cross. Click this cell and specify the upper bound pen from the
drop-down list box. For information about using shading, see
“Comparing pens” on page 17-10.

Link Data

Select this check box to read the tag’s minimum, maximum,


description, and engineering units properties every time the trend is
displayed. This allows changes to these properties to be propagated
to the trend.

If you enable this option, the minimum, maximum, description, and


engineering units fields in the spreadsheet do not change. If the
tag’s minimum and maximum values are not available, three
question marks ( ??? ) appear in the columns.

If you disable this option, the minimum, maximum, description,


and engineering units fields are initially populated with values from
the tag’s properties, if these properties exist for the tag. After they
are populated initially, you must update them manually.

For digital tags, 0 is used for the minimum, and 1 is used for the
maximum. For analog tags, specify the minimum and maximum
values in the data server’s tag editor.

Setting up trends ■ 17--43


Preface
Editing multiple pens simultaneously

Use the Multiple Pen Edits spreadsheet to edit more than one pen
at the same time.

To edit multiple pens at the same time:

1. Select the pens you want to edit. To do this, you can:

click the first pen you want to select, press and hold down
the Shift key, and then click the last pen you want to select

click and then drag the mouse across the numbers of the pens
you want to select

or, to select pens that are not consecutive, click the first pen
you want to select, press and hold down the Ctrl key, and
then click each pen you want to select

2. In the Multiple Pen Edits spreadsheet, specify the new attributes


for the pens.

If you make a mistake and want to redo the changes you have
made, click Clear Selections to empty the Multiple Pen Edits
spreadsheet.

3. When you are satisfied with your changes, click Apply to


Selected Pens.

17--44 ■ RSView Supervisory Edition User’s Guide


Setting up the horizontal axis (x- axis)

For a standard chart, the horizontal axis represents time; for an


x-y plot chart, the horizontal axis represents the x-axis pen values.
The settings in this tab apply to both types of charts.

Use the X-- Axis tab to set


up the run-- time chart’s
horizontal axis.

Start date and Start time

When Allow scrolling is selected, the start date and time are
disabled. To change the start date or time, clear the Allow scrolling
check box on the Display tab.

Specify the starting date and time for the trend. To select a date,
click the Start date list, and then click a date on the calendar.

The Start date and Start time settings determine when the trend
begins to collect and chart data. The start time is shown on the
left-hand side of the x-axis. As the chart scrolls with new data, the
time is updated on the horizontal axis label.

Setting up trends ■ 17--45


Preface
If the trend is plotting current values only and it is first displayed
after the specified time, the current time is used as the starting
point.

If the trend is plotting historical data, and if the data log model is
running at the specified start time, data is displayed from the
starting time onwards. Otherwise, the earliest available data (after
the start time) is displayed. Once the chart scrolls to the current
time, values are taken from the buffer, not the data log file.

Time span

Type a time, and then select a time unit, to determine the time span
of data the trend displays at run time.

For a standard chart, the time span defines the horizontal scale. For
an x-y plot chart, the minimum and maximum values of the selected
pen (specified in the Pens tab) define the horizontal scale, and the
time span defines the number of data points plotted.

Setting up the X- Axis display options

Display scale

Check this box to display the x-axis legend at the bottom of the
trend.

For a standard chart, the legend shows the start and end times of
the pen values currently charted in the trend. If there is room,
intermediate times are shown below each vertical grid line.

17--46 ■ RSView Supervisory Edition User’s Guide


For an x-y plot chart, the legend shows the minimum and
maximum values of the pen selected for the x-axis. If there is room,
intermediate values are shown as well.

Display date on scale

Check this box to display the date of each time stamp.

Display grid lines

Check this box to display vertical grid lines on the trend chart.

Major grid lines/Minor grid lines

Type the number of major and minor lines to display on the chart.
You can display up to 30 major lines, and up to 10 minor lines
between each major line. The major lines are solid, and the minor
lines are dashed.

Grid color

If you choose to display grid lines, click the grid color box and then
click a color on the palette. The grid line color will change to the
color you have selected.

Setting up trends ■ 17--47


Preface
Setting up the vertical axis (y- axis)

Use the Y-- Axis tab to set


up the run-- time chart’s
vertical axis.

Defining the range of numbers on the


vertical axis

The pen scale determines the range of numbers on the vertical axis.
Each pen can have a different scale. When you select a pen by
clicking it in the line legend, the minimum and maximum values
change to reflect the scale of the selected pen.

For example, if Tag1 has a minimum value of 10 and a maximum


value of 100, the range on the vertical axis will be 10 to 100 when
the Tag1 pen is selected. If Tag2 has a minimum of –10 and a
maximum of 50, the range on the vertical axis will change to –10 to
50 when the Tag2 pen is selected.

If you want all pens in the trend to use the same range on the
vertical axis, use the custom minimum and maximum fields
described below.

17--48 ■ RSView Supervisory Edition User’s Guide


Minimum/maximum value options

Specify the method for determining the minimum and maximum


values for the vertical axis:

Automatic—the lowest data reading serves as the minimum


value and the highest data reading serves as the maximum. As
the trend acquires new data, the y-axis will rescale to fit the new
values.

Preset—the minimum and maximum pen values you set up in


the Pens tab serve as the scale of the y-axis. The scale does not
change.

The scale options you specify in this tab determine which pen’s
minimum and maximum values are used as the preset values.
For more information, see “Setting up a vertical scale for
multiple pens” on page 17-52.

Custom—allows you to specify a constant, tag or expression for


the minimum and maximum values.

To set up a constant minimum or maximum value:

1. On the Y-Axis tab, click Custom.

2. Click Actual minimum value or Actual maximum value.

3. Type a value in the Actual minimum value or Actual maximum


value box.

4. Click Apply.

Setting up trends ■ 17--49


Preface
To set up a tag or expression as a minimum or
maximum value:

1. On the Y-Axis tab, click Custom.

2. Click Minimum value tag/expr. or Maximum value tag/expr.

3. Click the Browse button and enter an expression or select a tag


from the Expression Editor. For more information about adding
a tag or expression using the Expression Editor, see “Adding
pens to the trend” on page 17-35.

4. Click Apply.

Setting up the Y- Axis display options

Isolated graphing

Select the Isolated graphing check box to place each pen in a


separate band on the chart. To allow pens to overlap, clear the
isolated graphing check box.

17--50 ■ RSView Supervisory Edition User’s Guide


If you specify isolated graphing, you cannot display horizontal grid
lines. Instead, a horizontal line appears above each band. For more
information about isolated graphing, see page 17-17.

% isolation

This option is only available when you specify Isolated graphing.

Type a number between 0 and 10 for the percentage of the chart


height that will separate each pen in the trend. A 0% isolation will
display the pen bands closely together, and a 10% isolation will
display the pen bands farther apart.

Display scale

Check this box to display y-axis labels to the left of the trend.

To display decimals in the labels, type a number in the Decimal


places box. If you type a number other than 0, this setting overrides
the Chart Radix setting in the Display tab, and all numbers are
displayed as decimals.

Display grid lines

Check this box to display horizontal grid lines on the chart.

Major grid lines/Minor grid lines

Type the number of major and minor lines to display on the trend
chart. You can display up to 30 major lines, and up to 10 minor
lines between each major line. The major lines are solid, and the
minor lines are dashed.

Setting up trends ■ 17--51


Preface
Grid color

If you display grid lines, click the Grid color box and then click a
color on the palette.

If you use isolated graphing, this color is used for the horizontal
lines between bands.

Setting up a vertical scale for multiple pens

You cannot set up a vertical scale for multiple pens if you specify
Custom minimum and maximum values. Set up Automatic and
Preset minimum and maximum values on the Pens tab, as described
on page 17-42.

Specify how multiple pens with different minimum and maximum


ranges scale together on the chart.

All pens on same scale

Click All pens on same scale to display one scale for all pens,
determined by the lowest minimum and highest maximum values of
all pens.

Each pen on independent scale

Click Each pen on independent scale to scale each pen


independently using the pen’s minimum and maximum values as
the range. The vertical axis displays only one pen’s range at a time.

The operator can view each pen’s y-axis legend using the line
legend. When the operator clicks a pen in the line legend, the

17--52 ■ RSView Supervisory Edition User’s Guide


vertical axis changes to the new pen’s range. The color of the y-axis
legend changes to the color of the selected pen.

Scale using pen

Click Scale using pen to use the same scale for all pens, based on the
minimum and maximum values for the specified pen. Click the
browse button to specify a tag to use for the scale.

Scale as percentage

Check this box to display the y-axis values as a percentage of the


minimum and maximum range. The y-axis legend displays the
percentage range, from 0 to 100%.

Comparing real- time and historical data

Compare real-time and historical data by setting up an overlay on


the Overlays tab. You can:

add snapshots to the Trend as an overlay

set the position or time at which each overlay is attached to the


chart

determine whether an overlay is shown or hidden on the run


time chart

remove overlays from the Trend

and delete snapshots from RSView.

All of the overlays you add to the Trend can be available for
operators to display at run time. Set up run-time options on the
Runtime tab.

Setting up trends ■ 17--53


Preface

Use the Overlays tab to


add, remove or delete
snapshots of historical
data to compare with
real-- time data.

Setting up snapshots and overlays

Before you can add a snapshot to a trend and set it up as an overlay,


you must first create a snapshot.

To create a snapshot:

1. Either test the RSView Studio trend display or click Launch


SE Client on the Tools menu.

2. Right-click the trend to open the shortcut menu and then click
Create Snapshot

3. Type a name for the snapshot and click OK.

17--54 ■ RSView Supervisory Edition User’s Guide


To add a snapshot to the trend as an overlay:

1. On the Overlays tab, click Add.

2. Select a snapshot from the Component browser and then click


OK.

All of the snapshots that you add to the Trend can be available for
operators to show or to hide on the trend chart from the shortcut
menu at run time (set up run-time options on the Runtime tab).

To remove an overlay:

1. On the Overlays tab, click the overlay you want to remove.

2. Click Remove. The overlay will be removed from the Trend and
unavailable to the operator at run time.

The snapshot is not deleted, but is no longer available as an overlay


on the run time chart.

To delete a snapshot:

You cannot delete a snapshot until you remove it from the trend.

1. Open the Overlays tab and then click Delete snapshot.

2. Select a snapshot from the Component browser and then click


OK. The snapshot is deleted immediately.

Changing the attributes of a snapshot pen

When a snapshot is added to a trend as an overlay, the pens from


the snapshot are automatically added to the Pens tab on the TrendX
dialog box. To change the settings for a pen from an overlay, see
“Setting up pen attributes” on page 17-38.

Setting up trends ■ 17--55


Preface
Setting up overlay attributes

Overlay settings, including the position of the overlay, can be


changed during run time. For more information about changing the
overlay at run time, see “Using overlays at run time” on page 17-71.

Name

This column lists the snapshot names currently available for use as
overlays in the Trend.

Anchor

The anchor determines how the overlay is aligned to real-time data


on the trend chart. The overlay can be anchored by position or by
time. Click a cell in the Anchor column to toggle between Position
and Time settings.

Position–aligns the earliest data in the snapshot to the run time


chart based on a percentage you set in the Offset (%) column.

The position of the overlay depends on the normal view of the


Trend chart. If you zoom the chart data, the x and y ranges of
the data in the snapshot change to match those of the run time
chart. If you pan the data, the run-time data moves with the
overlay data in the snapshot—the starting point of the overlay
data remains fixed in the chart.

Time–the snapshot starts at the time you specify in the Start


column.

The overlay data in the snapshot scrolls with the data in the run
time chart, based on the chart’s refresh rate. Set the refresh rate
on the General tab. If you pan or zoom the data in the chart, the
overlay data held in the snapshot also pans or zooms.

17--56 ■ RSView Supervisory Edition User’s Guide


Start

This column is not available if you choose to anchor the overlay by


position.

Click in this column to set a starting time for overlays anchored by


time. You can also double-click the Start column to open the Start
Time dialog box.

Offset (%)

This column is not available if you choose to anchor the overlay by


time.

Type a percentage to define how far from the left edge of a run time
chart an overlay is anchored, in terms of the total width of the
chart.

For example, if you anchor an overlay by position and specify an


offset value of 25%, the earliest data held in the snapshot begins
overlaying at a quarter of the chart width.

To anchor the overlay at the left edge of the run time chart, set the
offset to 0.

Visible

Click the visible column to toggle between On and Off. To display


the data in the snapshot immediately when the chart opens in run
time, set Visible to On. During run time, operators can show or
hide each overlay from the shortcut menu.

Settings on the Runtime tab control an operator’s ability to show or


hide overlays during run time. The Visible setting on the Pens tab
can also affect the visibility of any pen in an overlay.

First Pen/Last Pen

Adding a snapshot adds all of the pens contained within that


snapshot to the list of pens available in the Trend. To see a list of the

Setting up trends ■ 17--57


Preface
available pens, click the Pens tab. The numbers in the first pen and
last pen columns identify the first and last pens in the snapshot and
correspond with the pen numbers on the pens tab.

For example, a Trend contains 5 pens, numbered 1 though 5. If we


add a snapshot that contains 3 pens, the First Pen column identifies
the first pen as 6 and the Last Pen column identifies the last pen as
8. On the Pens tab, the 3 pens from the snapshot hold positions 6,
7, and 8 in the Pen Attributes spreadsheet. You can set up these
pens just as you can set up any other pen in the trend.

Creating a trend template


Use a trend template to:

apply a consistent appearance to trend charts

create a set of different views for the same data

or to return to a standard display after experimenting with


display options.

17--58 ■ RSView Supervisory Edition User’s Guide


Creating and saving a new template

1. Use the General, Display, Pens, X-Axis and Y-Axis tabs to set
up the display options and pen attributes you want to capture in
a template.

Use the Template tab to


set up display options
and then save them as a
template.

2. On the template tab, click the display options you want to apply
to a trend chart when the template is loaded.

On the left side of the options box, click a property tab to select
it. On the right side of the box, select the specific options
available from that tab to load with the template. Clear the
check boxes for those options that you do not want loaded with
the template.

To check or clear all of the options for a tab, click the Check All
or Uncheck All button. To return to the system default settings,
click the Default button.

Setting up trends ■ 17--59


Preface
To check or clear all the options on all the tabs, select the All
options check box at the bottom of the left panel, and then click
the Check All or Uncheck All button.

3. Click Save Template.

4. In the Component name dialog, type the name of the template


box and then click OK.

The new template is saved immediately.

Loading a template

1. Click the Template tab and then click Load template.

2. Select a template from the Component browser and then


click OK.

The template is loaded immediately.

Deleting a template

1. Click the Template tab and then click Delete template.

2. Select a template from the Component browser and then


click OK

The template is deleted immediately.

IMPORTANT Template commands take effect immediately, and cannot


be cancelled.

17--60 ■ RSView Supervisory Edition User’s Guide


Loading a template during run time

You can use the Invoke command to load a template during


runtime.

Example: switching between two templates at run time using


the Invoke command

1. Set up a template with isolated graphing called Isolated.tem.

2. Set up a template with non-isolated graphing called


Non-Isolated.tem

3. In the trend graphic display, create a button to load the isolated


graphing template with the following command:

Invoke Me.TrendX1.LoadTemplate (”C:\Documents and


Settings\All Users\Documents\RSView Enterprise\SE\HMI
Projects\Mixing\Trend\Isolated.tem”)

4. In the trend graphic display, create a button to load the


non-isolated graphing template with the following command:

Invoke Me.TrendX1.LoadTemplate (”C:\Documents and


Settings\All Users\Documents\RSView Enterprise\SE\HMI
Projects\Mixing\Trend\Non-Isolated.tem”)

where “Mixing” is the name of the HMI server.

5. Use the buttons at run time to switch between the two


templates.

Setting up trends ■ 17--61


Preface
Setting up the trend’s run- time behavior
You can use the Runtime tab to set the trend options that are
available to operators at run time. To prevent operators from
changing these options, the Runtime tab is not available at run time.

Change graphic!!

Changing the trend’s appearance at run time

Select the check box for each tab to which operators will have
access at run time.

17--62 ■ RSView Supervisory Edition User’s Guide


Setting up chart behavior

Allow editing legend properties

Select this check box to allow operators to edit the TrendX tabs by
double-clicking highlighted parts of the trend at run time. This
allows operators to change trend display settings during run time.
Only those tabs selected in the Display property pages option will
open.

For example, you cannot open the Pens tab at run time by
double-clicking the line legend when Allow editing legend
properties is cleared on the Runtime tab.

Allow Pan/Zoom

Select this check box to allow operators to zoom and pan on the
run-time chart. For more information about using zoom and pan,
see page 17-69.

Setting up shortcut menu options

Use these settings to determine what access operators have to the


shortcut menu.

Setting up trends ■ 17--63


Preface
Allow pause/resume scrolling

Select this check box to allow operators to pause and resume


automatic scrolling from the shortcut menu.

Allow Show/Hide value bar

Select this check box to allow operators to show and hide the value
bar from the shortcut menu. This option will allow operators to
show the value bar even if you have cleared the value bar check box
on the Display tab.

Allow Snapshot creation

Select this check box to allow operators to create and name


snapshots for use as overlays.

Allow overlay options

Select this check box to allow operators to select snapshots and then
add them to the Trend as overlays, and to show and hide selected
overlays.

Allow print

Select this check box to allow operators to print the trend chart.

17--64 ■ RSView Supervisory Edition User’s Guide


Using the Trends graphic library
The Trends graphic library contains a real-time trend and objects
for controlling the trend. You can use the trend and objects as they
are, or you can edit them to suit your needs. To use the objects,
drag and drop them into your graphic display.

To use the Trends graphic library:

1. In the Application Explorer, open the Graphics folder.

2. Open the Libraries folder.

The graphic library files are displayed below the Libraries


Folder.

3. Right-click TrendX and then click Open.

4. Drag and drop one or more trend objects into your display.

Setting up trends ■ 17--65


Preface
Using the trend at run time
Run time options are selected on the Runtime tab of the TrendX
Properties dialog box. For more information about the Runtime
tab, see “Setting up the trend’s run-time behavior” on page 17-62.

Collecting data in the background during


run time

Real-time trends collect data only while the trend is displayed. This
means that a trend will not contain any data when the graphic
display opens. To ensure a trend contains data when you start it,
you can either use a data log model or keep the trend updating in
the background by loading data into the data buffer using a startup
macro. For more information about the Startup editor, see
Chapter 22, Deploying and administering applications.

Example: Ensuring a real- time trend has data

1. Create a startup macro that includes this command:

Display Trend1 /ZA

where Trend1 is the name of the display containing the real-time


trend, and /ZA is the parameter for loading the display into the
data buffer (but not making it visible), continually updating the
display even when it is not visible.

The display is loaded when you start the HMI project and
remains in the cache until you use the FlushCache command or
stop running the project.

2. When you want the real-time trend to become visible, specify


the following command:

Display Trend1

Trend1 will then be displayed and will contain data.

17--66 ■ RSView Supervisory Edition User’s Guide


Selecting pens

To display details about a pen, select the pen by clicking it in the


line legend. When the pen is selected, the vertical scale changes to
reflect the range of values for the pen.

The y-- axis legend shows


the minimum and
maximum range for
a pen . . .

. . . when you click the


pen line in the
line legend.

Opening TrendX tabs at run time

Select the Allow editing properties check box, and the appropriate
tabs on the Runtime tab to allow the operator to double-click
elements of the trend and open the tabs.

Double-- clicking this


part of the trend Opens this tab

Chart title Chart title window

y-axis legend Y-Axis tab

x-axis legend X-Axis tab

Line legend Pens tab

Setting up trends ■ 17--67


Preface
Using the shortcut menu at run time

Right-click the trend at run time to open the shortcut menu.

Scrolling options at run time

You can draw your own buttons and objects for viewing a trend’s
data, or you can use the objects in the Trends graphic library. For
information about the graphic library, see “Using the Trends
graphic library” on page 17-65.

A set of VCR-style buttons are created with the trend. These buttons
allow the operator to view different areas of charted data. To show
the VCR-style buttons at run time, click Display scrolling
mechanism on the Display tab .

Oldest data Backward Backward Pause Forward Forward Most


1 time ½ time ½ time 1 time current
span span span span data

Using the value bar at run time

The value bar is a vertical marker that details the value of each pen
at the position you select on the trend chart.

To show the value bar, click the trend where you want the value bar
to appear. The value bar appears at the point you clicked. To hide
the value bar, click the vertical axis. You can also show or hide the
value bar using the shortcut menu.

17--68 ■ RSView Supervisory Edition User’s Guide


The value bar changes color automatically so that it is visible for all
background colors.

A tilde (~) appears before a value in the value bar if the value is an
approximation. The approximation occurs because there is no value
for the given pen at the exact time stamp of the value bar. The value
displayed is based on the nearest available reading.

The value bar

Using zoom at run time

To zoom, you can:

Right-click and drag the y-axis to zoom vertically

Right-click and drag the x-axis to zoom horizontally

Left-click and drag on the chart to zoom into the banded area.

To restore the original view of the trend chart, right-click to open


the shortcut menu and select Undo Zoom/Pan.

Setting up trends ■ 17--69


Preface
Using pan at run time

To pan, the trend chart must be paused using either the pause
button at the bottom of the trend or the shortcut menu Scroll
option. You can:

Left-click and drag the y-axis to pan vertically

Left-click and drag the x-axis to pan horizontally.

To restore the original view of the trend chart, right-click to open


the shortcut menu and select Undo Zoom/Pan.

Using the arrow keys at run time

You can use the arrow keys at run time to perform some of the
same functions as the mouse and VCR-style buttons.

Press and hold And then press


this key this arrow key To do this

(none) Left Move back half a timespan

(none) Right Move forward half a timespan

(none) Up Pan 10% up

(none) Down Pan 10% down

Shift Left Move back a full timespan

Shift Right Move forward a full timespan

Shift Up or Down Switch to the next pen’s y-axis

Ctrl Left or Right Move the value bar to the next


data point

Ctrl Up or Down Pan 10% up or down

17--70 ■ RSView Supervisory Edition User’s Guide


Press and hold And then press
this key this arrow key To do this

Shift and Ctrl Left or Right Pause

Shift and Ctrl Up or Down Switch to the next pen’s y-axis

Printing the trend chart

To print a copy of the trend chart, right-click the trend and then
click Print Trend on the shortcut menu.

Using overlays at run time

Before you can use overlays at run time, a snapshot must be created
and the overlay must be set up on the Overlays tab. For more
information about Overlays, see “Comparing real-time and
historical data” on page 17-53.

Use the shortcut menu to align an overlay to the left of the trend,
relocate an overlay, show or hide an overlay or open the Overlays
tab.

Fixing run- time errors

If data for the trend is not available at run time due to


communication errors, a message is sent to the activity log.

For information about troubleshooting common trend problems,


see Help.

Setting up trends ■ 17--71


18
Chapter

Creating expressions
This chapter includes:

instructions for creating expressions

description of the components used for building expressions

About expressions
Sometimes the data you gather from devices is only meaningful
when you:

compare it to other values

combine it with other values

create a cause-effect relationship with other values

Expressions allow you to create mathematical or logical


combinations of data that return more meaningful values.

Expression components

Expressions can be built from:

tag values

constants

mathematical, relational, logical, and bitwise operators

Creating expressions ■ 18--1


Preface
built-in functions

if – then – else logic

Where you can use expressions


Expressions can be used in the following editors:

Graphic Displays: You can define an expression to control


various aspects of a graphic object’s appearance. You can also
display the value of an expression in numeric and string display
objects.

Derived Tags: You can define an expression and then specify the
name of a tag that will store the result of the expression.

Events: You can define an expression and then associate it with


an action. When the expression changes from false to true (from
zero to any non-zero value), the action (a command or macro)
runs.

Data Log Setup: When setting up file management, you can


choose to have a log file created when a particular event occurs.
One way of doing this is to create an expression.

Using expressions in a command

You can also use expressions in a command to set the value of a tag.
For details, see the Equal ( = ) command in Appendix A,
RSView commands, or see Help.

Creating expressions
All editors that can use expressions include an Expression field. In
some editors, you will also find:

expression buttons

an expression column

18--2 ■ RSView Supervisory Edition User’s Guide


The following illustration shows the items for creating an
expression in the Events editor.

Expression field

Expression buttons

Expression column

Expression buttons

These are the expression buttons:

This button Displays a list of This button Displays a list of

If – then – else operators Bitwise operators

Logical operators Built-in functions

Relational operators Tags in the tag browser

Arithmetic operators

Creating expressions ■ 18--3


Preface
Cutting, copying, and pasting expressions

You can cut, copy, or paste an expression or parts of an expression.


The method for performing these actions depends on whether the
expression is in a window or in a dialog box.

When you are working in a window, you can use the commands on
the Edit menu, the toolbar, or the keyboard. When you are working
in a dialog box, you can use only the keyboard because you cannot
access the menu bar or toolbar.

When you cut or copy an expression, a copy of it is placed on the


clipboard. Once it is on the clipboard, you can paste it into any
other Expression field or Expression column. You can also paste it
into a command line.

To cut or copy expressions in a window:

1. Select the expression in the form or in the spreadsheet.

2. Do one of the following:

Cut Copy on the Edit menu, click Cut or Copy

on the toolbar, click the Cut or Copy button

on the keyboard, press Ctrl-X or Ctrl-C

To paste expressions in a window:

1. Click where you want to paste the expression.

You can paste into the Expression field in the form or into the
Expression column in the spreadsheet.

18--4 ■ RSView Supervisory Edition User’s Guide


2. Do one of the following:

Paste on the Edit menu, click Paste

on the toolbar, click the Paste button

on the keyboard, press Ctrl-V

To cut or copy expressions in a dialog box:

1. Select the expression in the Expression field.

2. Press Ctrl-X or Ctrl-C.

To paste expressions in a dialog box:

1. Click in the Expression field where you want to paste the


expression.

2. Press Ctrl-V.

Formatting expressions
You can format expressions so they are easier to read. However, do
not let tag names, key words, function names, or function
arguments span more than one line.

When formatting expressions, you can use tabs, line returns, and
multiple spaces.

When you’re working in the Animation dialog box in the Graphic


Displays editor, type Ctrl-Tab to insert a tab in the expression.

Creating expressions ■ 18--5


Preface

Example: Formatting an expression

To format this if – then – else statement, you can align the “else”
with the appropriate “if” so the logic is easy to understand:

If (tag1 > tag2) Then 0


Else If (tag1 > tag3) Then 2
Else 4

Or you can condense it to the following:

If (tag1 > tag2) Then 0 Else If (tag1 > tag3) Then 2 Else 4

Using tag names and tag placeholders


A tag name can be included as part of an expression or can stand
alone as the entire expression.

To supply a tag name, do one of the following:

type a tag name

click the Tags button and then select a tag from the Tags list

Enclose tag names that contain dashes or start with a number in


braces { } when you use them in an expression. This distinguishes
the characters in the tag name from the characters in the expression.
Also use braces when using wildcards (* or ?) to represent multiple
tags in an expression.

18--6 ■ RSView Supervisory Edition User’s Guide


This character Does this

? Matches any single character.

* Matches any number of characters, including the


backslash ( \ ) character.

Use this wildcard by itself to display all the tags in the


tag database.

For detailed information about tags, see Chapter 7, Working with


tags.

Using area names with tag names

When referring to a tag in a different area, specify the area name as


an absolute or relative reference. For details about using absolute
and relative references with tag names, see “Using tag references”
on page 7-19.

Using tag placeholders instead of tag


names

The Graphic Displays editor can accept tag placeholders instead of


tag names. Placeholders allow you to use the same display with a
variety of tags.

You can use tag placeholders in the same way you use tag names.
A tag placeholder is the cross-hatch character ( # ) followed by a
number from 1 to 500. For detailed information about placeholders,
see Chapter 15, Creating graphic displays.

Creating expressions ■ 18--7


Preface
Constants
A constant can have any of the following formats:

integer (123)

floating point (123.45)

scientific notation (1.2345E2 )

string constant (“character string”)

the string “pi” (to represent the symbol π). RSView replaces the
string with its numeric value.

Arithmetic operators
Arithmetic operators calculate values based on two or more
numeric values. The arithmetic operators are:

Example
(For these examples,
Symbol Operator tag1 = 5 and tag2 = 7)

+ addition tag1 + tag2


returns a value of 12

– subtraction tag1 – tag2


returns a value of -2

* multiplication tag1 * tag2


returns a value of 35

/ division tag1 / tag2


returns a value of 0.7142857

18--8 ■ RSView Supervisory Edition User’s Guide


Example
(For these examples,
Symbol Operator tag1 = 5 and tag2 = 7)

MOD, % modulus tag2 MOD tag1


(remainder) returns a value of 2

The modulus operator is the remainder of one


number divided by another. For example, the
remainder of 13 divided by 5 is 3;
so 13 % 5 = 3.

Important: This operator is for integers


only, not floating point numbers.

** exponent tag1 ** tag2


returns a value of 78125

IMPORTANT Be sure that any tag value you use as a divisor cannot at
some point have a value of zero. Expressions that
attempt to divide a number by zero produce an error at
run time.

String operands

The + operator can be used to join string operands. For example,


the expression “hello” + “world” returns: helloworld.

Creating expressions ■ 18--9


Preface
Relational operators

Relational operators compare two numeric or string values to


provide a true or false result. If the statement is true, a value of 1 is
returned. If false, 0 is returned.

The relational operators are:

Symbol Operator Numeric Examples K String Examples k

K For the numeric examples, tag1 = 5 and tag2 = 7


k For the string examples, serial_no = ST009

EQ, == equal tag1 == tag2 serial_no == “ST011”


false false

NE, <> not equal tag1 <> tag2 serial_no <> “ST011”
true true

LT, < less than tag1 < tag2 serial_no < “ST011”
true true

GT, > greater than tag1 > tag2 serial_no > “ST011”
false false

LE, <= less than or equal to tag1 <= tag2 serial_no <= “ST011”
true true

GE, >= greater than or equal to tag1 >= tag2 serial_no >= “ST011”
false false

How string operands are evaluated

String operands are evaluated by case and by alphabetical order.


Lower case letters are greater than upper case letters. For example,
h is greater than H. Letters later in the alphabet are greater than
those earlier in the alphabet. For example, B is greater than A.

18--10 ■ RSView Supervisory Edition User’s Guide


Logical operators
Logical operators determine the validity of one or more statements.
There are three logical operators: AND, OR, and NOT. The operators
return a non-zero value if the expression is true, or a zero if the
expression is false.

The logical operators are:

Example
(For these examples,
Symbols Operator Action tag1 = 5 and tag2 = 7)

AND, && and Returns a 1 if the statements (tag1 < tag2) AND (tag1 == 5)
to the right and to the left of both statements are true; returns a 1
the operator are both true.

OR, || or Returns a 1 if either or both (tag1 > tag2) OR (tag1 == 5)


statements are true. tag1 == 5 is true; returns a 1

NOT negation Reverses the logical value of NOT (tag1 < tag2)
the statement it operates on. although tag1 < tag2 is true, NOT
reverses the logical value; returns a 0

IMPORTANT The parentheses are essential in the above expressions.


For more information, see “Evaluation order of
operators” on page 18-23.

Creating expressions ■ 18--11


Preface
Bitwise operators
Bitwise operators examine and manipulate individual bits within a
value.

IMPORTANT These operators are for integers only, not floating point
numbers.

Symbol Operator Action

& AND Compares two integers or integer tags on a bit-by-bit basis.

Returns an integer with a bit set to 1 if both the corresponding


bits in the original numbers are 1. Otherwise, the resulting bit
is 0.

| inclusive OR Compares two integers or tags on a bit-by-bit basis.

Returns an integer with a bit set to 1 if either or both of the


corresponding bits in the original numbers are 1. If both bits
are 0, the resulting bit is 0.

^ exclusive OR (XOR) Compares two integers or tags on a bit-by-bit basis.

Returns an integer with a bit set to 1 if the corresponding bits


in the original numbers differ. If both bits are 1 or both are 0,
the resulting bit is 0.

>> right shift Shifts the bits within an integer or tag to the right.

Shifts the bits within the left operand by the amount specified
in the right operand. The bit on the right disappears.

Either a 0 or a 1 is shifted in on the left, depending on whether


the left-most bit is a 0 or a 1. If the left-most bit is 0, a 0 is
shifted in. If the left-most bit is 1, a 1 is shifted in. In other
words, the sign of the number is preserved.

18--12 ■ RSView Supervisory Edition User’s Guide


Symbol Operator Action

<< left shift Shifts the bits within an integer or tag to the left.

Shifts the bits within the left operand by the amount specified
in the right operand. The bit on the left disappears and 0
always shifts in on the right.

~ complement Returns one’s complement; that is, it toggles the bits within an
integer or tag.

Reverses every bit within the number so every 1 bit becomes


a 0 and vice versa.

Example: Bitwise operators

For these examples tag1 = 5 (binary 0000 0000 0000 0101),


tag2 = 2 (binary 0000 0000 0000 0010)

tag1 & tag2


Returns 0 (binary 0000 0000 0000 0000)

tag1 | tag2
Returns 7 (binary 0000 0000 0000 0111)

tag1 ^ tag2
Returns 7 (binary 0000 0000 0000 0111)

tag1 >> 1
Returns 2 (binary 0000 0000 0000 0010)

tag1 << 1
Returns 10 (binary 0000 0000 0000 1010)

~ tag1
Returns –6 (binary 1111 1111 1111 1010)

Creating expressions ■ 18--13


Preface
Built-in functions
The types of built-in functions are:

tag

time

file

math

user

Many functions check for specific true and false conditions. They
return 1 if the condition is true, and 0 if the condition is false.

Tag functions

The following built-in functions examine the status of a tag (tag) or


multiple tags (tag*).

IMPORTANT If your graphic display requires more than 20 alarm


functions, for performance reasons you should use these
alarm functions in derived tags instead.

This function Returns

ALM_IN_ALARM(tag) 1 (true) if the tag or alarm event is in alarm.


or
If examining multiple tags, 1 (true) if one or more
ALM_IN_ALARM(tag*) of the tags or alarm events are in alarm.

ALM_ACK(tag) 1 (true) if the tag or alarm event’s alarm has been


or acknowledged.

ALM_ACK(tag*) If examining multiple tags or alarm events,


1 (true) if one or more of the tags’ or alarm
events’ alarms have been acknowledged.

18--14 ■ RSView Supervisory Edition User’s Guide


This function Returns

ALM_ALLACKED(tag*) If examining multiple tags, 1 (true) if all of the


tags’ alarms have been acknowledged.

ALM_SEVERITY(tag) The severity of the alarm—a value between 1


or and 8, or 0 if the tag or alarm event is not in
alarm.

ALM_SEVERITY(tag*) If examining multiple tags or alarm events, the


highest severity of the tags or alarm events that
are in alarm. For example, if the current alarms
have severities of 1, 3, and 6, this function returns
the value 1.

If you are using ALM_SEVERITY(*), use the system


tag called system\AlarmMostRecentSeverity
instead.

ALM_LEVEL(tag) The alarm level or threshold for an analog tag: a


or value between 1 and 8, or 0 if the tag is not in
alarm.

ALM_LEVEL(tag*) If examining multiple tags, the highest level of the


tags that are in alarm. For example, if the current
alarms are levels 2, 6, and 8, this function returns
the value 8.

ALM_SUPPRESS(tag) 1 (true) if the tag’s alarms are suppressed.


or
If examining multiple tags, 1 (true) if one or more
ALM_SUPPRESS(tag*) of the tags’ alarms are suppressed.

ALM_FAULT(tag) 1 (true) if there has been an alarm fault for the


or specified tag.

ALM_FAULT(tag*) If examining multiple tags, 1 (true) if there has


been an alarm fault for one or more of the tags.

Creating expressions ■ 18--15


Preface

This function Returns

COMM_ERR(tag) 1 (true) if the last read or write operation for the


specified tag indicated a communication failure.

You can examine the status of only one tag with


this function.

To examine multiple tags at once, use a wildcard in the expression


argument.

This wildcard Does this

* Matches any number of characters, including the


backslash ( \ ) character.

? Matches any single character.

Example: Tag functions

ALM_IN_ALARM(/Ingredients::vessel3\TIC3\pv*)

Returns 1 (true) if one or more tags in the specified folder have a


name beginning with the letters “pv” and are in alarm. Returns 0
(false) if none of the specified tags are in alarm.

In this example, the tags are in the area called Ingredients.

18--16 ■ RSView Supervisory Edition User’s Guide


Time functions

The following built-in functions examine system time. These


functions use the time or interval parameters.

These are the functions:

This function Returns

TIME(“time”) 1 (true) if the time specified is the current time.

BEFORE_TIME(“time”) 1 (true) if the expression is evaluated before the


specified time.

AFTER_TIME(“time”) 1 (true) if the expression is evaluated after the


specified time.

INTERVAL(“interval”) 1 (true) if the specified time interval has


elapsed—the interval timer starts running
when an event file starts running.

IMPORTANT The time and interval parameters must be enclosed in


quotes.

The time functions are described on the following pages.

The time parameter can include the following options:

day of week [Sun, Mon, Tue, Wed, Thu, Fri, or Sat]

month [Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep,
Oct, Nov, or Dec]

date [1 to 31]

year [1997 to 2100]

hour of day [00: to 23:]

minute [:00 to :59]

seconds [:00 to :59]

Creating expressions ■ 18--17


Preface
It does not matter in what order options are listed. You can include
any or all of these options; the more you include, the more specific
the time becomes.

Example: Specific time parameters

The following all represent the same date and time, and are valid
time parameters:

“mon aug 21 2000 17:00”

“mon aug 21 2000 17: :00”

“:00 aug 21 mon 2000 17:”

IMPORTANT The validity of the date is not checked. In the above


example if Aug 21 2000 is not a Monday, this error is
not detected.

Example: Less specific time parameters

Following are valid examples of time parameters:

“17:00”
means any day at 5:00 PM

“ :30 ”
means any hour, on the half hour

“ mon 17:”
means 5:00 PM each Monday

18--18 ■ RSView Supervisory Edition User’s Guide


The interval parameter has this format:

<number> <units>

where <units> is one of:

mil (millisecond)

sec (second)

min (minute)

hou (hour)

day (day)

wee (week)

mon (month)

yea (year)

Examples: Time and interval functions

TIME(“sun aug 20 2000 14:30”)

Returns 1 (true) if it is exactly 2:30 PM and 0 seconds, on Sunday,


August 20, 2000; otherwise returns 0 (false).

_____________________________

AFTER_TIME(“sun aug 20 2000 14:30”)

Returns 1 the first time the expression is evaluated after 2:30 PM on


Sunday, August 20, 2000.

_____________________________

Creating expressions ■ 18--19


Preface
BEFORE_TIME(“aug 20 2000”)

Returns 1 (true) the first time the expression is evaluated before


August 20, 2000.

_____________________________

INTERVAL(“1 min”)

Returns 1 (true) if a minute has elapsed since the expression last


returned a 1.

_____________________________

(tag1 > 500) and INTERVAL (“30 sec”)

Returns 1 (true) when tag1 > 500 on some 30-second interval since
the event file started running. (It does not mean 30 seconds after
tag1 > 500.)

18--20 ■ RSView Supervisory Edition User’s Guide


File functions

The following built-in functions check if a file exists and check the
amount of free disk space.

The file parameter is the path name, surrounded by quotes. The


drive parameter is the drive letter.

These are the functions:

This function Returns this value Example

FILE_EXISTS(“file”) 1 (true) if the specified FILE_EXISTS


file exists. “C:\Documents and Settings\All Users\Documents\
RSView Enterprise\SE\ActivityLog\Activity.exp”
returns 1 (true) if the file exists or 0 (false) if the file does
not exist.

Use this function to set a tag when a specified file has


been created or deleted.

FREE_BYTES(drive) The number of bytes FREE_BYTES(c)


free on the specified returns the number of bytes available on drive C, up to a
drive. maximum of 2.1 GB.

Use this function to display a message or trigger an


alarm when disk space is getting low.

If you want an expression containing these functions to be


evaluated more than once, assign the expression to an event rather
than to an object in a graphic display.

Math functions

These functions perform math on an expression:

This function Returns this value

SQRT (expression) The square root of the expression

LOG (expression) The natural log of the expression

Creating expressions ■ 18--21


Preface

This function Returns this value

LOG10 (expression) The base ten log of the expression

SIN (expression) The sine of the expression in radians

COS (expression) The cosine of the expression in radians

TAN (expression) The tangent of the expression in radians

ARCSIN (expression) The arc sine of the expression in radians

ARCCOS (expression) The arc cosine of the expression in radians

ARCTAN (expression) The arc tangent of the expression in radians

SIND (expression) The sine of the expression in degrees

COSD (expression) The cosine of the expression in degrees

TAND (expression) The tangent of the expression in degrees

ARCSIND (expression) The arc sine of the expression in degrees

ARCCOSD (expression) The arc cosine of the expression in degrees

ARCTAND (expression) The arc tangent of the expression in degrees

Security functions

These functions return information about users.

This function Returns this value Example

CurrentUserName The name of the current user. The CurrentUserName( )


user’s domain is not included. Returns the name of the current
user.

CurrentUserHasCode True if the user possesses the CurrentUserHasCode(A)


specified security code. Returns true for all users that have
security code A.

18--22 ■ RSView Supervisory Edition User’s Guide


Evaluation order of operators
Expressions with more than one operator are evaluated as follows:3.

operators in parentheses are evaluated first.

Therefore, to change the order of precedence, use parentheses.

the operator with the highest precedence is evaluated next

when two operators have equal precedence, they are evaluated


from left to right

Operators are evaluated in the following order:

Evaluation order Symbols

1 (highest) ()

2 NOT
~

3 *
/
MOD, %
**
AND, &&
&
>>
<<

4 +

OR, ||
|
^

5 (lowest) EQ, =
NE, <>
LT, <
GT, >
LE, <=
GE, >=

Creating expressions ■ 18--23


Preface

Example: Evaluation order

For these examples, tag1 = 5, tag2 = 7, and tag3 = 10.

_____________________________

(tag1 > tag2) AND (tag1 < tag3)

is evaluated in this sequence:

1. tag1 > tag2 = 0

2. tag1 < tag3 = 1

3. 0 AND 1=0

The expression evaluates to 0 (false).

_____________________________

tag1 > tag2 AND tag3

is evaluated in this sequence:

1. tag2 AND tag3 = 1

2. tag1 > 1 = 1

The expression evaluates to 1 (true).

_____________________________

18--24 ■ RSView Supervisory Edition User’s Guide


NOT tag1 AND tag2 > tag3 ** 2

is evaluated in this sequence:

1. NOT tag1 = 0

2. 0 AND tag2 = 0

3. tag3 ** 2 = 100

4. 0 > 100 = 0

The expression evaluates to 0 (false).

If – then – else
If – then – else expressions carry out an action conditionally or
branch actions depending on the statements in the expression. The
if – then – else statements enable the expression to perform
different actions in different situations and to repeat activities until
a condition changes.

To build conditional expressions, use the relational operators and


the logical operators.

The if – then – else structure is:

if statement then value1 else value2

If the statement is true then the expression returns value1; if the


statement is false then the expression returns value2. Keep in mind
that the statement is a mathematical equation and true means a
non-zero value, and false means zero.

Creating expressions ■ 18--25


Preface
The if – then – else structure is illustrated below.

enter

true
statement

false

value2 value1

exit

18--26 ■ RSView Supervisory Edition User’s Guide


Nested if – then – else structure

It is common to nest an if – then – else structure inside the ‘then’ or


‘else’ part of an if – then – else structure.

Example 1: Nested if – then – else

This expression:

if (statement1) then (value1)


else if (statement2) then (value2)
else (value3)

has this interpretation:

enter

true
statement1

false

true
statement2 value1

false

value3 value2

exit

Creating expressions ■ 18--27


Preface

Example 2: Nested if – then – else

This expression:

if (statement1) then
if (statement2) then (value1)
else (value2)
else (value3)

has this interpretation:

enter

true true
statement1 statement2 value1

false false

value3 value2

exit

18--28 ■ RSView Supervisory Edition User’s Guide


19
Chapter

Setting up navigation
An important part of the complete operator interface is the way
operators navigate through and interact with your application.
RSView gives you the tools for linking displays and creating an
overall application structure that is easy for operators to use.

This chapter provides:

examples and ideas for creating a hierarchy of displays

examples of how users can move among displays

procedures for linking displays

Developing a hierarchy of displays


A display hierarchy is a series of displays that provide progressively
more detail as users move through them. A hierarchy should meet
the needs of the various users, including managers, supervisors, and
operators.

A hierarchy could include:

an initial graphic display that serves as a menu

an overview of the plant, including links to displays located on


RSView SE Servers in areas around your enterprise

a comprehensive display of each process being monitored

process-specific displays

Setting up navigation ■ 19--1


Preface
management summary displays

trend displays of historical and real-time data

The following illustration shows a display hierarchy:

Main Menu
Graphic Display

Area 1 Area 2
Process-Wide Management
Process Process
Alarm Summary Summary
Overview Overview

Process 1 Process 2 Process 3 Process 4


Monitoring Monitoring Monitoring Monitoring

Process 1 Process 2 Process 3 Process 4


Trend Display Trend Display Trend Display Trend Display

Ways of moving among displays

To set up displays so operators can easily move among them, you


can:

create a keyboard-based application

create a mouse- or touch screen-based application

You can use one or both of these methods in your application.


Although the methods look different to the operator, they work
similarly—that is, they all initiate RSView commands.

19--2 ■ RSView Supervisory Edition User’s Guide


Commands for moving among displays

To open, close, and switch between displays, use the following


commands. They are executed at the RSView SE Client only.5.

RSView Command Function

Display Opens the specified graphic display.

If a display is already open and the display allows


multiple running copies (specified in the Display
Settings dialog box in the Graphic displays editor),
this command will open another display and make it
active. If the display is already open but does not
allow multiple running copies, this command
simply makes the display active.

If a display of type Replace overlaps any other


display(s) when it opens, the display(s) it overlaps
will be closed.

Displays of type Overlay open on top of any other


open displays without closing them.

Displays of type On Top remain on top of any


other open graphic displays.

Abort Use this command only for displays of type


Overlay or On Top. The Abort command closes the
active display or a specified display.

PullForward Pulls forward the specified display. If the specified


graphic display is of the Replace or Overlay type,
PullForward gives the specified display focus and
positions it behind any On Top display that is open.

PushBack Pushes the specified display behind other displays.


If the specified graphic display is of the On Top
type, PushBack positions the display behind any
other open On Top displays, and in front of any
open displays of the Replace or Overlay type.

Setting up navigation ■ 19--3


Preface
The PullForward and PushBack commands provide quick display
changes because displays are already up and running. However, be
aware that the more displays that are open, the more memory is
used.

The display type you choose gives you additional control over how
the operator navigates between displays. For example, use the
On Top option to keep a display on top at all times, even when
another display has focus. Or use the Replace option if you want a
display to replace all other open displays when it opens. For details
about assigning display type see “Specifying the display type” on
page 15-15.

Reducing display call-up time

You can reduce the time required to display a graphic by loading


the graphic into the display cache. You can:

load the graphic before it is displayed by using the Display


command with the /Z or /ZA parameter. For details, see
Appendix A, RSView commands, or see Help.

load the graphic when it is displayed for the first time by using
the Cache After Displaying option in the Display Settings
dialog box of the Graphic displays editor. For details, see
“Specifying caching” on page 15-17.

Where to use RSView commands

Commands can be used in the following places:

a field that requires you to enter an action

a macro

a command line. The command line is available in RSView


Studio, or the RSView Administration Console only. It is not
available in the RSView SE Client operators interact with at run
time.

19--4 ■ RSView Supervisory Edition User’s Guide


Many RSView commands accept parameters. For a complete list
and description of commands, see Appendix A, RSView commands,
or see Help.

Examples of navigation methods


Following are examples of various navigation methods:

Example: Keyboard operation

The following graphic display has been designed to act as a menu,


listing keys users can press to open different displays.

To create this display, the designer assigned various RSView


commands to keys using the three types of key definitions: object,
display, and client. In all cases, keys (not mouse buttons) were
defined to run commands.

Object key and display key animation are set up in the Graphic
displays editor. For details, see Chapter 16, Animating graphic

Setting up navigation ■ 19--5


Preface
objects. Client keys are created in the Client keys editor. For
details, see “Creating client keys” on page 19-19.

Example: Mouse/touch screen operation

The following graphic display contains buttons that users can click
with the mouse or press on a touch screen to call up detail displays.
This display presents information and acts as a menu.

To create the buttons, the designer used the Button drawing tool in
the Graphic displays editor. The buttons can be selected with a
mouse or with a touch screen. For details about how to create
buttons, see “Creating buttons” on page 15-66.

19--6 ■ RSView Supervisory Edition User’s Guide


The tools
To build a complete operator interface, use:

macros to replace a set of commands with a single command

symbols to replace long commands or commands with


parameters

key definitions to assign commands, symbols, macros, or a series


of replacement keystrokes to keys or mouse buttons

Precedence

At run time, components are evaluated in the following order:

symbols, commands, macros

object keys, display keys, client keys

For details about the order of precedence among object, display,


and client keys, see “General rules about precedence” on
page 19-15.

Creating macros
A macro is a series of commands stored in a macro component. The
name of the macro component is then used like a command, and
can be used anywhere a command can be used. When the
component name is entered, the macro runs, executing all the
commands in the component.

You can create macros to perform almost any action. For example,
a macro can:

open a group of windows and define their initial positions

define temporary key definitions

Setting up navigation ■ 19--7


Preface
close any open windows

set tag values

To create a macro:

1. In the Application Explorer, open the Logic and Control folder.

2. Open the Macros editor by doing one of the following:

double-click the Macros icon

drag the Macros icon from the Application Explorer to the


workspace

right-click the Macros icon and then click New

3. Type your macro commands and, if required, add command


parameters.

When entering commands, follow these guidelines:

Separate each identifier, specification, or string with a space


or a tab.

Start each command on a new line, or separate commands on


the same line with a semicolon ( ; ).

Precede comments with an exclamation mark ( ! ). The


comment lasts until the next semicolon ( ; ) or line break.

IMPORTANT Do not use dollar signs or percent signs in comments


in your macros. This causes errors at run time.

To replace a tag name with its current value when the macro
or command is evaluated, enclose the tag name in dollar
signs ( $ ) to create a placeholder in the command. When a
macro containing $tag$ executes, the tag values are
substituted first.

To indicate a percent in a macro, use two percent signs


( %% ) because a single percent sign indicates a parameter.

19--8 ■ RSView Supervisory Edition User’s Guide


For information about parameters, see “Using parameters” on
page 19-10. For more information about command syntax, see
“How to use commands” on page A-1.

For assistance while typing macro commands, double-click


anywhere in the Macros editor to open the Command Wizard.
For more information about using the Command Wizard, see
page A-10.

4. On the File menu, click Save As.

5. Type a component name. Remember, the component name is the


macro name so ensure the name does not conflict with symbols
or commands. If names conflict, only the symbol or command
will run.

At run time, operators can execute a macro anywhere they can


execute an RSView command. Ensure you include a way for
operators to execute commands or macros, for example by
specifying them as press actions for buttons.

Example: A macro called factory

Display /Ingredients::Overview

Display /Ingredients::Detail

/Ingredients::Valve23 = Open

When the macro called Factory runs, the graphic display called
Overview appears, then the graphic display Detail appears, then the
tag Valve23 is set to its open state. All are in the area called
Ingredients.

Setting up navigation ■ 19--9


Preface

Example: A macro using placeholders in commands

Display /$Tag1$::Process1

Display /$Tag1$::TrendDisplay$Tag2$

Valve23 = Open

Tag1 = Mixing, and Tag2 = 2. Tag1 is a string tag, Tag2 is an analog


tag. When the macro runs, RSView replaces the placeholders in the
commands with the tags’ current values.

The graphic display Process1 in the Mixing area appears, then the
graphic display TrendDisplay2 appears, also from the area called
Mixing, and finally, the tag Valve23 in the home area is set to its
open state. In this example, the home area is the area in which the
macro is executed.

You don’t need to put braces around tag names when using
placeholders in commands.

Using parameters

Macros can accept parameters. To specify a parameter in a macro,


type a percent ( % ) sign followed by a number. Up to nine
parameters are allowed.

To run the macro and parameters, specify the macro name followed
by the parameters. Separate multiple parameters with spaces.

IMPORTANT Do not use percent signs in comments in your macros.


This causes errors at run time.

For example, here is the same Factory macro with two parameters:

19--10 ■ RSView Supervisory Edition User’s Guide


Example: Factory macro with two parameters

Display Overview

Display %1

Valve23 = %2

To run the macro, type Factory Detail Open

The macro performs the same actions as in the original Factory


example because it substitutes “detail” wherever %1 appears in the
macro and substitutes “open” wherever %2 appears in the macro.

Nesting macros

You can insert a macro within another macro—this is called


nesting. You can have eight nesting levels in macros.

For example, a macro called Draw contains:

Display Overview

Display Detail

and a macro called Factory contains:

Draw

Valve23 = Open

Typing Factory performs the same actions as the original Factory


macro in the previous example.

Setting up navigation ■ 19--11


Preface
Creating a macro that runs when an HMI
server starts

If you have created an HMI server with components that must start
in a particular order, create a Startup macro. To make this macro
run when the HMI server starts, select this macro as the startup
macro in the Startup editor for the HMI server.

For more information about the Startup editor, see Chapter 22,
Deploying and administering applications.

Creating symbols

If you have long commands or commands with parameters that are


hard to remember or easy to mix up, you can rename those
commands with a single word called a symbol.

Symbols can be used anywhere a command can be used: in a field


that requires an action, in a macro, or at the command line.

You can define symbols in a macro or at the command line.


However, symbols are mainly an operational convenience when
using the system from the command line.

To define a symbol:

" At the command line or in a macro, type:

Define <symbol> <string>

<symbol> is the abbreviated command, without spaces

<string> is an existing command with or without parameters. It


can contain spaces and other symbols.

19--12 ■ RSView Supervisory Edition User’s Guide


Example: The Define command

Define Show Display Overview

The Define command

The symbol

The string

In this example, the command Display Overview is replaced with


the word Show.

Important guidelines

When creating symbols, keep the following in mind:

RSView does not check for security access on symbol names.


Therefore, be sure to put security on the underlying RSView
command. For more information, see Chapter 14, Adding
security.

A symbol and a macro should not have the same name. If they
do, the symbol runs instead of the macro.

The order of precedence is: symbol, command, macro.

Setting up navigation ■ 19--13


Preface
To clear a symbol:

" At the command line or in a macro, type one of the following:

This command Does this

Undefine <symbol> clears the symbol

<symbol> is the name of the


symbol you want to delete

Undefine * clears all defined symbols

Example: Undefining symbols

Undefine Show

Clears the symbol Show.

Key definitions
You can associate RSView commands with objects in a display
and/or with the entire display using object key animation, display
key animation, and touch animation. You can also associate
commands with keys that will be active at all times throughout the
system by creating client keys. At run time, operators use these
keys to interact with the system, for example to change displays or
set tag values.

Keys with repeat actions are ideal for such tasks as ‘ramping’ a tag’s
value.

19--14 ■ RSView Supervisory Edition User’s Guide


When deciding what type of key to create, use the following table
as a guide:

To Do this For details, see

Associate a key with a Attach object key Page 16-51


specific graphic object animation in the Graphic
(object key) displays editor

Associate a key with a Attach display key Page 16-65


specific graphic display animation in the Graphic
(display key) displays editor

Create a key that works Create a key definition Page 19-19


everywhere on a client component in the Client
(client key) keys editor

General rules about precedence

You can assign a single key to one or more of the three types of key
definitions—object, display, or client. For example, the F2 key can
open a valve when the valve object has input focus, or it can close a
popup display that has focus, or the F2 key can be a client key that
opens a graphic display containing an overview of your process.

When a graphic display is active and an object has input focus,


object keys have precedence over display keys and client keys.

When a graphic display is active, display keys have precedence over


client keys. This means that if you assigned the F2 key as a display
key in some graphic displays in your application, and you assigned
F2 as a client key in the same application, F2 will only work as a
client key if the current display does not have F2 assigned as a
display key as well.

When you design your system, pay particular attention to the keys
used by embedded objects. Object keys and display keys have
precedence over keys used by embedded objects (for example,
ActiveX, or OLE objects), except for OLE objects that are not part of
RSView (for example, an Excel worksheet), whose keys have

Setting up navigation ■ 19--15


Preface
precedence over object or display keys. For details, see the pages
that follow.

Precedence and the F1 key

When you are editing an RSView application, the F1 key always


launches context-sensitive Help.

At run time, if a graphic display has focus and a press, release, or


repeat action has been defined for the F1 key, F1 acts as a display,
object, or client key instead of launching Help.

Precedence and embedded ActiveX objects

When a graphic display is active and an embedded ActiveX object


has input focus, a key that triggers an action in the embedded object
will not trigger that action if the key has been defined as an object
or display key as well. When you press the key, the action of the
embedded ActiveX object will not be executed; the action of the
object key or display key will be triggered instead.

For example, you might have an ActiveX slider object to control


the speed of a motor, with the F2 key defined to increase the
motor’s speed, and the F3 key defined to decrease the motor’s
speed. If you have defined F2 as an object key to jog the motor’s
position, pressing F2 will never increase the motor’s speed—every
time an operator presses F2, the motor’s position will be jogged
instead.

If a key that triggers an action in an embedded ActiveX object has


been defined as a client key, pressing that key will trigger both the
action defined for the embedded object and the action defined for
the client key.

For example, if the F2 key for an ActiveX gauge object increases a


motor’s speed, and you have defined F2 as a client key to print the
current graphic display, each time the operator presses F2, the
motor’s speed will be increased, and the graphic display will be
printed.

19--16 ■ RSView Supervisory Edition User’s Guide


Precedence and embedded OLE objects

For embedded OLE objects (for example, an Excel worksheet), a key


that triggers an action in the embedded object will trigger only that
action, even if it has also been defined as an object or display key.
In this case, the action defined for the object or display will not be
triggered at all.

If a key that triggers an action in an embedded OLE object has been


defined as a client key, pressing that key will trigger both the action
defined for the embedded object and the action defined for the
client key.

Reserved keys

The following keys and key combinations are normally reserved for
use by Windows and RSView.

This reserved key Does this

+ on the numeric keypad Displays the Recipe dialog box, or saves the
recipe if Ctrl-W was pressed previously, or
restores the recipe if Ctrl-R was pressed
previously.

Enter If Enter is pressed when a button has focus, the


button’s press and release actions are executed.

If Enter is pressed when an input field has


focus, the field’s value is downloaded to the
PLC. If the input field is set up to display the
on-screen keyboard, pressing Enter displays the
on-screen keyboard.

If Enter is pressed when a recipe field has focus,


the Recipe dialog box is displayed. If Ctrl-W
was pressed previously, the recipe is saved. If
Ctrl-R was pressed previously, the recipe is
restored. If the recipe field is set up to display
the on-screen keyboard, pressing Enter displays
the on-screen keyboard.

Setting up navigation ■ 19--17


Preface

This reserved key Does this

Tab Moves focus to the object with the next highest


index number

Shift-Tab Moves focus to the object with the next lowest


index number

Ctrl-Up Arrow, Moves focus to an object in the direction in


Ctrl-Left Arrow, which the arrow points
Ctrl-Down Arrow,
Ctrl-Right Arrow

PgUp Uploads data into all input fields

Ctrl-PgUp Uploads data into the selected input field

PgDn Downloads data from all input fields

Ctrl-PgDn Downloads data from the selected input field

Ctrl-R Sets input focus to the recipe object, and


prepares for a recipe restore

Ctrl-W Sets input focus to the recipe object, and


prepares for a recipe save

Up Arrow, Moves the selection bar on the Object Key


Down Arrow menu

Left Arrow, Moves the cursor one position left or right


Right Arrow

Esc Closes the Object Key menu, or exits the input


mode of a continuously-updating input field

Backspace Deletes the character to the left of the cursor

Del Deletes the character to the right of the cursor

Shift-End-Delete Deletes all characters from the cursor position


to the end of the line

Home-Shift-End-Delete Deletes the contents of the input field

Ctrl-C or Ctrl-Ins Copies the selected items to the clipboard

19--18 ■ RSView Supervisory Edition User’s Guide


This reserved key Does this

Ctrl-X or Shift-Del Cuts the selected items and places them in the
clipboard

Ctrl-V or Shift-Ins Pastes the contents of the clipboard at the


current cursor position

Home Positions the cursor at the beginning of the data


entry field

Ctrl-F4, or Closes the active window


Ctrl-Shift-F4

Ctrl-F6 Moves focus to the next window

Ctrl-Shift-F6 Moves focus to the previous window

Precedence

If you define a press, release, or repeat action for a reserved key, to


use the key as an object or display key, the object or display key
function takes precedence, and the default, reserved function of that
key is disabled.

If you use a reserved key or key combination as a client key, the


key will perform both the actions of the client key you defined, as
well as the action of the reserved key. Because the results can be
unpredictable, defining client key actions for reserved keys is not
recommended.

Creating client keys

A client key is a key that has been assigned commands or macros.


At run time, when the key is pressed, the assigned action is
triggered. A client key is active at all times because it is not
associated with a particular graphic object or display. 6.

Setting up navigation ■ 19--19


Preface
To create a client key:

1. In the Application Explorer, open the Logic and Control folder.

2. Open the Client keys editor by doing one of the following:

double-click the Client keys icon

drag the Client keys icon from the Application Explorer to


the workspace

right-click the Client keys icon and then click New

Recapture screen

3. Click Add.

19--20 ■ RSView Supervisory Edition User’s Guide


4. Specify a key and, if desired, click one or both modifiers.

Some keys are reserved for use by Windows and RSView.


Reserved keys do not appear in the Key field in the Add Key
dialog box.

5. Click OK.

The key you add is displayed in the Key field. If you specified a
modifier, the first letter of that modifier is also displayed. If you
create a label in the next step, it will also be listed in this field.
As you continue to add keys, they will be listed here.

6. In the Label field, if you want, type a label for the key.

7. In the Press Action field and, if desired, in the Release Action


field, specify an RSView command or a macro.

To do this, type the command, or macro name, or click the


Browse button to open the Command Wizard, and then use the
Browse button wizard to compose the command.

The command or macro is the action that will occur when the
key is pressed or released. You can type multiple commands or
macros. If you do, separate them with a semi-colon ( ; ) or type
them on separate lines.

8. If you want an action to repeat while the key is held down, type
the RSView command or macro name in the Repeat Action
field.

The repeat action repeats at the rate specified in the Keyboard


properties of the Windows Control Panel.

9. To save the client key component, click OK.

Setting up navigation ■ 19--21


Preface
Running client key components

Use the RSView Key command to run client key components. Type
this command in a macro or anywhere else you can use an RSView
command.

IMPORTANT You cannot run more than one client-key component at


a time. If you try to run more than one component, the
components are not merged. Instead, the second
component overrides the first component.

To start running a client key component:

" Do one of the following:

use the RSView SE Client Wizard to specify the client key


component that will run when that RSView SE Client
configuration is run. For details, see Help for the RSView
SE Client Wizard.

at the command line or in a macro, type:

Key <component>

<component> is the name of the client key component

To stop running a client key component:

" At the command line or in a macro, type:

Key /R

/R removes the key definition

For a complete list of RSView commands and command syntax, see


Appendix A, RSView commands, or see Help.

19--22 ■ RSView Supervisory Edition User’s Guide


20
Chapter

The ODBC database


schemas
RSView produces three kinds of log files—activity, alarm, and data
log files—that can be stored in ODBC-compliant databases. This
chapter specifies the schemas for these databases.

Activity log table


Activity log data in ODBC format uses one table. For more
information about how the log files are named, see “The ODBC
database storage format” on page 12-4.

This column Contains SQL Data Type Length

TimeStmp The time and date data was logged, in coordinated SQL_TIMESTAMP Driver
universal time (UTC) format. dependent

MilliTime Millisecond time when data was logged. SQL_INTEGER 3

Dscrptn The description of the activity. SQL_VARCHAR, or 254


SQL_CHAR

MsgType This field is for internal use by RSView. A number SQL_SMALLINT, or 1


representing the type of activity: 0 for user, 1 for SQL_INTEGER
debug, 2 for trace.

Severity A number representing the severity of the activity: SQL_SMALLINT, or 1


0 for error, 1 for warning, 2 for information. SQL_INTEGER

Category The activity category. SQL_VARCHAR, or 20


SQL_CHAR

The ODBC database schemas ■ 20--1


Preface

This column Contains SQL Data Type Length

SrcArea The area in which the activity occurred. SQL_VARCHAR, or 80


SQL_CHAR

SrcComputr The name of the computer that initiated the SQL_VARCHAR, or 15


command or action that caused the activity. SQL_CHAR

User The name of the user (including domain name, if SQL_VARCHAR, or 38


there is one) that initiated the command or action SQL_CHAR
that caused the activity. If the activity was caused
by an HMI server, the user column contains
“System”.

SrcProduct The name of the product the activity belongs to. SQL_VARCHAR, or 20
SQL_CHAR

SrcSubsys The name of the subsystem that sent the activity SQL_VARCHAR, or 20
message. SQL_CHAR

SrcInstanc The name of the instance that logged the event. For SQL_VARCHAR, or 40
HMI servers, this column is the HMI server’s name. SQL_CHAR
For clients, this is the name of the client’s
configuration file. If not applicable, this column is
empty.

Alarm log table

Alarm log data in ODBC format uses one table. For more
information about how the log files are named, see “The ODBC
database storage format” on page 12-4.

This column Contains SQL Data Type Length

TimeStmp The time and date data was logged, in SQL_TIMESTAMP Driver
coordinated universal time (UTC) format. dependent

MilliTime Millisecond time when data was logged. SQL_INTEGER 3

TransType The type of alarm that was generated. SQL_VARCHAR, or 5


SQL_CHAR

20--2 ■ RSView Supervisory Edition User’s Guide


This column Contains SQL Data Type Length

TagName The name of the tag or alarm event that caused SQL_VARCHAR, or 40
the alarm. SQL_CHAR

TagValue The value of the tag at the time the alarm SQL_DOUBLE, or 20
occurred. SQL_INTEGER, or (10 decimal
SQL_SMALLINT places)

TagType The type of the tag in alarm: A for analog, D for SQL_VARCHAR, or 1
digital. SQL_CHAR

ThreshVal The threshold value. SQL_DOUBLE, or 20


SQL_FLOAT (10 decimal
places)

ThreshNum The threshold number. SQL_SMALLINT, or 1


SQL_INTEGER

ThreshLabl The threshold label. SQL_VARCHAR, or 21


SQL_CHAR

Severity The alarm severity. SQL_SMALLINT, or 1


SQL_INTEGER

User The name of the user (including domain name, if SQL_VARCHAR, or 38


there is one) that initiated the alarm transaction. SQL_CHAR
If the transaction was initiated by an HMI server,
the user column contains ‘System’.

AlarmType The number RSView assigns to the transaction SQL_SMALLINT, or 1


type. SQL_INTEGER

Dscrptn The message that is associated with the SQL_VARCHAR, or 132


transaction (alarm) type, the log message for the SQL_CHAR
alarm event, or the alarm log remark.

SrcComputr The name of the computer that initiated the SQL_VARCHAR, or 15


command or action that caused the alarm. SQL_CHAR

SrcArea The area in which the alarm occurred. SQL_VARCHAR, or 80


SQL_CHAR

If the ODBC database doesn’t support the SQL_TIMESTAMP data type,


then the data may be truncated. For example, the Oracle ODBC

The ODBC database schemas ■ 20--3


Preface
driver does not support the SQL_TIMESTAMP type. Use SQL_DATE
instead to store both the date and time without truncating the data
in Oracle.

Data log tables

Log data in ODBC format uses up to three tables. For more


information, see “The ODBC database storage format” on page 12-4.

Floating--point and string tables

Log tables for floating-point and string data are the same except
one contains analog and digital tag data and the other contains
string tag data.

This column Contains SQL Data Type Length

DateAnd The date and time the tag values were logged. SQL_TIMESTAMP Driver
Time dependent

Millitm The millisecond time the tag values were logged. SQL_SMALLINT, or 4
SQL_INTEGER

TagIndex, or The index number for the tag. The tag name that SQL_SMALLINT, or 2 or
corresponds to this number is listed in the tag SQL_INTEGER 4
name table.

TagName If the tag table isn’t used, the tag name appears in SQL_VARCHAR, or 40
this column. SQL_CHAR

Val The analog or digital value of the tag. SQL_DOUBLE, or 8 or


SQL_INTEGER, or 4 or
SQL_SMALLINT 2

The string value of the tag. SQL_VARCHAR, or 82


SQL_CHAR

20--4 ■ RSView Supervisory Edition User’s Guide


This column Contains SQL Data Type Length

Status Blank if communications are working properly. SQL_VARCHAR, or 1


SQL_CHAR
D if a node is disabled.

E if a communication error occurred while


RSView was trying to acquire the tag value.

S if the tag value is stale; that is, if the value has


been acquired before but has not been updated.

U if the tag is uninitialized.

Marker Bwhen the DataLogOn command was issued SQL_VARCHAR, or 1


and logging began. SQL_CHAR

E when the DataLogOff command was issued


and logging ended.

S when the DataLogSnapshot command was


issued.

The ODBC database schemas ■ 20--5


Preface
Tag table

This column Contains SQL Data Type Length

TagName The tag name. SQL_VARCHAR, or 40


SQL_CHAR

TagIndex The index number assigned to the tag name. SQL_SMALLINT, or 2


SQL_INTEGER

TagType The tag type: SQL_SMALLINT 1

2—analog tag
3—digital tag
4—string tag

TagDataType The tag data type: SQL_SMALLINT 2

0—long
1—float
2—string

20--6 ■ RSView Supervisory Edition User’s Guide


21
Chapter

Using the SE Client


object model and
display code

About the RSView SE Client object model


Use the RSView SE Client object model with Visual Basic for
Applications (VBA) code in graphic displays to customize and
extend the capabilities of the RSView SE Client. Some ways you
might do this include:

Using data with other applications If you regularly require


RSView data for use in programs such as Microsoft Excel, or
SQL Server, consider using the RSView SE Client object model
and display code with VBA to integrate these applications with
RSView.

Creating custom forms for operators You can use VBA to


create custom forms, for example as pop-up dialog boxes that
operators can interact with at run time. You can also use VBA
logic to validate the operator’s input, for example to ensure that
the value an operator enters in a numeric input field falls within
10 % of the value of another numeric input field.

Designing intuitive graphic displays Use the RSView


SE Client object model to populate ActiveX controls with data,
for use in graphic displays. For example, use list boxes or combo
boxes in graphic displays to allow operators to select options
such as recipe items.

Using the SE Client object model and display code ■ 21--1


Preface
Manipulating the RSView SE Client window. Write VBA code
to arrange graphic displays based on the size of the RSView SE
Client window. This allows you to adapt your application
dynamically to various screen desktop sizes and resolutions.

Sending custom messages to the activity log file. Send


specific messages to the activity log window and activity log file,
to record the operation conditions and events through VBA code.

Securing the system. The RSView SE Client Object Model


allows you to obtain security information about who is using
the system, and to use the security information and events to
control access to the system. For example, you can restrict a
user’s access to a graphic display on a secured computer by
creating code that displays the graphic display on a workstation
where the user is logged in with a particular security code.

The VBA integrated development environment


RSView graphic displays include Microsoft Visual Basic for
Applications (VBA). Use the VBA integrated development
environment (IDE) to create, test, and debug VBA procedures, and
then run these procedures in response to events triggered from
within RSView graphic displays.

This chapter provides a brief description of the IDE but does not
include detailed information about VBA—it is assumed that you are
familiar with the VBA environment and Visual Basic programming
language. This chapter highlights aspects of VBA that are unique to
RSView Studio, and describes how to use VBA from within RSView
graphic displays.

For information about how to access information about VBA, see


“Using VBA Help” on page 21-12.

21--2 ■ RSView Supervisory Edition User’s Guide


Opening the IDE window

To open the VBA IDE:

1. Open the graphic display for which you want to write VBA code.

2. Do one of the following:

in the Graphic Displays editor, click the View menu, and


then click Visual Basic Editor

click an object in a display. On the Edit menu, click VBA


Code. The code window opens in the context of the object
you clicked.

in the Graphic Displays editor, click the Edit menu, and then
click VBA Code. The code window opens in the context of
the graphic display.

right-click an open graphic display, and then click VBA Code


on the shortcut menu. The code window opens in the
context of the graphic display.

right-click an object in a display, and then click VBA Code on


the shortcut menu. The code window opens in the context of
the object you right-clicked.

Using the SE Client object model and display code ■ 21--3


Preface
Parts of the IDE window

The illustration below shows the main parts of the IDE window.
Each part is then described in more detail.

Project Explorer
Window

Properties
Window

Procedure or
Code Window

Project Explorer Window

For each graphic display, a VBA project with a default name of


DisplayCode is created. The Project Explorer shows the VBA project
for each graphic display that is open in the Graphic Displays editor.

Each project contains an RSView Studio Objects folder. This folder


contains a module called ThisDisplay, that represents the graphic
display. The module contains the code that interacts with objects on
the display. The module called ThisDisplay can contain any number
of procedures.

You can create additional VBA modules and user forms. To use the
procedures in these modules and to use the user forms, you must
call them from procedures that exist in the module called
ThisDisplay.

21--4 ■ RSView Supervisory Edition User’s Guide


Properties Window

This window lists the property settings for the code modules, class
modules, and the VBA user forms and the objects on those forms.
You cannot call forms directly from RSView. To use a form, call the
form from a procedure in the code module called ThisDisplay.

Procedure or Code Window

This window is where you write and edit your VBA procedures. In
ThisDisplay, any RSView SE Client objects that raise events are
listed in the drop-down list on the left-hand side of the window.
When an object is selected in the left-hand list, the object’s events
are listed in the right-hand drop-down list.

Quick Start steps

Step 1 ■ Start with a graphic display

Display code is saved with a graphic display. Before you can write
VBA code that manipulates graphic objects, you should have created
the graphic display and the graphic objects.

For details about creating graphic displays, see Chapter 15,


Creating graphic displays.

Step 2 ■ Create your VBA code

Using the Visual Basic programming language, create procedures in


the code window for the module called ThisDisplay.

For information about creating Visual Basic procedures, see VBA


Help. For information about accessing Help for VBA, see “Using
VBA Help” on page 21-12.

Using the SE Client object model and display code ■ 21--5


Preface
How VBA code runs

The VBA procedures you create are called in response to a display’s


events. When you open the RSView graphic display, the VBA
procedure starts automatically.

About procedures
A procedure is a named block of code that executes as a unit.
Examples of procedures are Visual Basic subroutines and functions.
The module called ThisDisplay contains any number of procedures
that are executed in response to a display’s events.

The procedures you create in the module called ThisDisplay can


call procedures in other user forms or modules.

The RSView SE Client Object Model


The RSView SE Client Object Model contains objects that
represent the features of the RSView SE Client. Using these objects,
you can interact with an RSView SE Client by writing code that is
run when an object event occurs.

VBAcan interact with the following objects in the RSView SE Client


Object Model:

ActiveXExtender The ActiveXExtender object merges properties


and methods that are implemented by RSView graphics with those
of an ActiveX object.

AlarmSummary Represents the RSView Alarm Summary object.

Application Represents the RSView SE Client container program.


Use this object to access the RSView graphic display collection.

Arc Represents the RSView arc object.

Arrow Represents the RSView arrow object.

21--6 ■ RSView Supervisory Edition User’s Guide


Button Represents the RSView button object.

Display Represents a graphic display.

Displays Contains a collection of Display objects.

Element Represents any object in a graphic display. This object


contains the base properties and methods for all RSView objects. Its
members are merged with specific members of each graphic object
to form the graphic object used in VBA.

Elements Represents a collection of Element objects.

Ellipse Represents the RSView ellipse object.

EmbeddedOLE EmbeddedOLE objects represent third-party


objects like Excel charts.

Freehand Represents the RSView freehand object.

Group Represents a set of objects that have been grouped together


on a display. To write VBA code that responds to a group’s events
you must create the group in a graphic display before you open the
VBA IDE. If you don’t create the group in a graphic display first, the
group object will not generate events, and code written for the
group will not respond to the group’s events at run time.

Line Represents the RSView line object.

NumericDisplay Represents the RSView numeric display object.

NumericInput Represents the RSView numeric input object.

Picture Represents the RSView bitmap object.

Polygon Represents the RSView polygon object.

Polyline Represents the RSView polyline object.

PolyPolygon Represents the RSView polypolygon object.

Using the SE Client object model and display code ■ 21--7


Preface
Recipe Represents the RSView Recipe object.

RoundedRectangle Represents the RSView rounded rectangle


object.

StringDisplay Represents the RSView string display object.

StringInput Represents the RSView string input object.

TagLabel Represents the RSView tag label object.

Text Represents the RSView Text object.

Wedge Represents the RSView wedge object.

Viewing the objects

Use the Object Browser to view the RSView SE Client objects in


the VBA IDE.

To open the Object Browser, do one of the following:

right-click anywhere in the Code window, and then click Object


Browser on the shortcut menu

on the View menu, click Object Browser

press F2

21--8 ■ RSView Supervisory Edition User’s Guide


To display only those
objects related to the
RSView SE Client, click
DisplayClient.

To view all RSView


SE Client constants,
properties, methods, and
events, click globals.

Select any object to view its


properties, methods, and
events.

To view the global object variables, click DisplayClient in the first


list.

Getting Help with RSView SE Client objects

RSView contains Help for every RSView SE Client object,


including a detailed description of the object’s properties, methods,
and events. To open Help, select an item in the Object Browser, and
then press the F1 key on the keyboard, or the ? button on the
toolbar.

Using the SE Client object model and display code ■ 21--9


Preface
Opening Help from the Object Browser

To open Help from the Object Browser:

1. Open the Object Browser.

2. In the list at the top of the Object Browser window, click


DisplayClient.

3. Under Classes or Members, highlight an item and then press the


F1 key on the keyboard, or the ? button on the toolbar.

To view the contents for the entire Help file for the RSView
SE Client Object Model:

1. Follow the steps above to open a Help topic.

2. In the Help window, click the Help Topics button.

21--10 ■ RSView Supervisory Edition User’s Guide


Opening Help from the Code Window

To open Help from the Code Window, in a line of code, highlight


an RSView object name or highlight an RSView object’s property
or method, and then press F1.

Opening Help from the RSView Help


Contents window

To open VBA code Help from RSView Help:

1. On the RSView menu bar, click Help, and then click Contents.

2. In the Contents window, do one of the following:

for an overview, double-click Creating VBA Display Code

for details about the objects, double-click Using the RSView


SE Client Object Model

Using the SE Client object model and display code ■ 21--11


Preface
Using VBA Help
VBA comes with its own Help. To access this Help, do any one of
the following in the VBA IDE:

click the Help menu, and then click a menu item

in any area of the IDE, press F1

VBA documentation

If you’re new to Visual Basic, you might want to look at the


following Microsoft publications:

Visual Basic Getting Started

Visual Basic Programmer’s Guide

21--12 ■ RSView Supervisory Edition User’s Guide


22
Chapter

Deploying and
administering
applications
Deploying applications

Once you have finished developing and testing your application,


you are ready to move it to the set of computers that will run your
application in a ‘live’ setting, for example, the plant floor. This
process is called deployment. There are several activities you must
perform to deploy your application.

This chapter describes how to:

set up the FactoryTalk Directory software

specify the startup settings, move the files, and set up properties
for each HMI server in your application

set up data server properties

set up and open RSView SE Clients

specify the correct time, date, and number formats for your
locale

These activities are described on the pages that follow.

Administering applications

After your application has been deployed, you might need to make
small changes to the application while it is in use. This process is

Deploying and administering applications ■ 22--1


Preface
called administration. You can make changes to your application
using either RSView Studio, or you can use the RSView
Administration Console.

This chapter describes:

how to start and use the RSView Administration Console

how to monitor disk space on HMI servers

For details about using the RSView Administration Console, see


“Administering your application” on page 22-17.

Deploying your application

Overview

Use this list of activities as the basis for a your own checklist, to
help you deploy your application.

Your own checklist might include activities that are not listed here,
for example, setting up database software, or OPC servers. Ensure
that you add these activities to your own checklist.

To deploy your application, you must do the following:

Set up the FactoryTalk Directory The FactoryTalk Directory


is software that allows the parts of a distributed application to
find each other on the network.

To set up the FactoryTalk Directory, you must install the


FactoryTalk Directory software on one of the computers on
your network, and then you must run the utility called Set
FactoryTalk Directory Location on all the other computers on
your network. Use the Set FactoryTalk Directory Location
utility to specify the name of the FactoryTalk Directory
computer.

If you are moving the FactoryTalk Directory from one


computer to another, you must also move the FactoryTalk

22--2 ■ RSView Supervisory Edition User’s Guide


directory files to the computer that will run the FactoryTalk
Directory software.

Specify the startup settings for each HMI server The startup
settings allow you to specify which parts of your application
start automatically when the HMI server starts.

You can specify the startup settings in the Startup editor for each
HMI server in RSView Studio only. You cannot specify or change
the startup settings in the RSView Administration Console.

Move HMI server files If you are moving HMI servers from one
set of computers to another, you must move the HMI servers’
files as well. To move or copy the files, use the Windows
Explorer.

Set up HMI server properties You must set up the following


properties for each HMI server in your application in the HMI
Server Properties dialog box:

specify the name of the computer on which the HMI server is


running

specify when the HMI server loads, for example, when the
computer starts up, or when the first client attempts to
connect to the server

start or stop the application’s components manually. This is


optional, and is useful for testing or troubleshooting.

Set up the data server properties If you have moved an OPC


server from one computer to another, you must change the name
of the computer on which the OPC server is installed.

Specify the computer name in the Data Server Properties dialog


box.

Set up the RSView SE Clients At run time, operators interact


with graphic displays on RSView SE Clients. You must specify
the application that each RSView SE Client connects to, and the
components the RSView SE Client loads when it connects to the

Deploying and administering applications ■ 22--3


Preface
application. For example, each RSView SE Client shows an
initial graphic display when the client opens.

To set up an RSView SE Client, run the RSView SE Client


wizard.

If you have already set up an RSView SE Client, you can copy


the client’s configuration file (.cli) from one computer to
another. You do not have to modify the client configuration file
after you have copied it.

IMPORTANT All of the users participating in your distributed


application must be members of the same Windows
domain.

Open the RSView SE Client and test your application To


open the RSView SE Client, double-click the client
configuration file.

Setting up the FactoryTalk Directory


The FactoryTalk Directory is software that allows the parts of a
distributed application to find each other on the network.

After you install RSView Supervisory Edition on a computer, and


before you run RSView Studio, the RSView Administration
Console, or the RSView SE Client, you must set the location of the
FactoryTalk Directory on that computer.

To set the location of the FactoryTalk directory:

1. Decide which computer on your network will be the


FactoryTalk Directory. For details about determining the system
requirements for the FactoryTalk Directory computer, see the
RSView Supervisory Edition Installation Guide.

2. Install the FactoryTalk Directory software. For details about


installing software, see the RSView Supervisory Edition
Installation Guide.

22--4 ■ RSView Supervisory Edition User’s Guide


3. On every other computer on the network that you want to have
access to your applications:

a. Click the Start button, and then point to Programs,


Rockwell Software, Utilities, and then click Specify
FactoryTalk Directory Location.

b. Specify the name of the computer that is the FactoryTalk


Directory, and then click OK.

c. Restart the computer.

To move applications from one FactoryTalk Directory to


another:

1. Copy the folder \Documents and Settings\All Users\


Application Data\Rockwell\RNAServer\Global from the
source computer to the target computer.

2. Click the Start button, and then point to Programs, Rockwell


Software, Utilities, and then click Specify FactoryTalk
Directory Location.

3. Select the new computer that will manage the FactoryTalk


directory and then click OK.

4. Restart the computer.

Specifying HMI server startup components


Use the Startup editor for an HMI server to specify what
components will run when the HMI server starts. The HMI server can
be started automatically when the operating system starts, or
manually. For details about starting the HMI server manually, see
page 22-11.

IMPORTANT You must specify startup settings separately for each


HMI server in your application.

Deploying and administering applications ■ 22--5


Preface
To specify the startup components for an HMI server:

1. In RSView Studio, open an HMI server’s System folder in the


Application Explorer.

2. Open the Startup editor by doing one of the following:

double-click the Startup icon

right-click the Startup icon and then click Open

IMPORTANT The order in which items appear in the Startup


editor is not the order in which items will run. If
you have created an HMI server that has components
that must start in a particular order, create a macro
that will run when the HMI server starts.

3. Select the check box for each item you want to run when the
HMI server runs. Where required, specify the file you want to
run.

Alarming Starts alarm monitoring. This is the same as using the


AlarmOn command.

Data Logging Starts running the specified data log model. This
is the same as using the DataLogOn command. Up to 20 data
log model files can run simultaneously, but only one can be
specified in the Startup editor. To run more files, list them in a
startup macro.

22--6 ■ RSView Supervisory Edition User’s Guide


Derived Tags Runs the specified derived tags file. This is the
same as using the DerivedOn <component> command. Up to 20
derived tag files can run simultaneously, but only one can be
specified in the Startup editor. To run more files, list them in a
startup macro.

Event Detector Runs the specified event component. This is


the same as using the EventOn <component> command. Up to
20 event components can run simultaneously, but only one
component can be specified in the Startup editor. To run more
files, list them in a startup macro.

Startup Macro Runs the specified macro. A startup macro


allows you to run a series of commands when the HMI server
runs. Any macro can be used as a startup macro.

Shutdown Macro Runs the specified macro when you click the
Stop All Running Components button in the HMI Server
Properties dialog box. Any macro can be used as a shutdown
macro. Closing any RSView SE Client will not run the
Shutdown macro.

4. Click OK.

Moving HMI server files


Before you move an HMI server to a new location, make sure the
RSView SE Server software is installed, and the FactoryTalk
Directory is set. For information about setting up, or changing the
FactoryTalk Directory, see page 22-4.

To move the HMI server’s files to a new location:

1. Copy or move theHMI server files from the following folder on


the source computer, to the same folder on the target computer:

\Documents and Settings\All Users\Documents\


RSView Enterprise\SE\HMI Projects

Deploying and administering applications ■ 22--7


Preface
2. Start RSView Studio, or the Administration Console and then
open the application. You can open the application locally or
remotely.

IMPORTANT The HMI server will fail to load if you deleted the HMI
project files. Even if this happens, you can still access
the HMI server’s properties.

3. Right-click the server and then click properties to open the


HMI

HMI Server Properties dialog box.

4. In the Computer box, type the name of the new computer or


click the browse button to select the new computer.

5. Click OK.

Setting up HMI server properties


You must set the properties of each HMI server in the application.

Use the HMI Server Properties dialog box to:

specify the name of the computer on which the HMI server is


running

specify when to load the HMI server

start or stop components manually

view the HMI server name, project file path, number of existing
graphic displays, and the maximum number of graphic displays
allowed on the HMI server

22--8 ■ RSView Supervisory Edition User’s Guide


To set up the properties of an HMI server:

1. In the Application Explorer in RSView Studio or the RSView


Administration Console, right-click the HMI server and then
click Properties.

2. In the HMI Server Properties dialog box, specify the HMI server
properties.

Name The name of the HMI server. This name is set when you
create the HMI server. You cannot change it.

Description Type a description (up to 204 characters long) for


the HMI server. This description is for your information only. It
does not appear anywhere else.

Computer The name of the computer at which the HMI server is


located. Type a computer name, or click the browse button to
Browse button select a computer name.

You cannot type the name of a computer on which the HMI


project does not exist. Before you can change the computer

Deploying and administering applications ■ 22--9


Preface
name in this box, you must copy the HMI project to the target
computer.

Project file (relative to server computer) The file path to the


HMIserver’s files. The path is set when you create an HMI server.
You cannot change it.

Number of displays The current number of graphic displays on


the HMI server. This number is for your information only.

Licensed Maximum The maximum number of graphic displays


allowed by your RSView SE Server license. This number is for
your information only.

Startup type Specify when you want the HMI server to load:

On demand The HMI server loads when the first client is


opened, and unloads when the last client is closed. A client
can be RSView Studio, the RSView Administration Console,
or the RSView SE Client. This is the only Startup type
option available for an unlicensed HMI server.

Load when operating system initializes The HMI server


loads when Windows starts, but the HMI server’s startup
components do not run.

The HMI server can only be unloaded by changing the Startup


type to On demand, and then closing all clients.

Run when operating system initializes The HMI server


loads when Windows starts, and the HMI server’s startup
components run. Because the HMI server runs as a service,
users do not have to log in to make the HMI server run.

The HMI server can only be unloaded by changing the Startup


type to On demand, and then closing all clients.

22--10 ■ RSView Supervisory Edition User’s Guide


Starting and stopping an HMI server’s
components manually

To start HMI server components manually:

1. In the Application Explorer in RSView Studio or the RSView


Administration Console, right-click the HMI server and then
click Properties.

2. In the HMI Server Properties dialog box, click Run Startup


Components. The components specified in the Startup editor
run.

To stop HMI server components manually

1. In the Application Explorer in RSView Studio or the RSView


Administration Console, right-click the HMI server and then
click Properties.

2. In the HMI Server Properties dialog box, click Stop All Running
Components. All components stop running, including alarms,
data log models, derived tag components, and event
components.

If a shutdown macro is specified in the Startup editor, clicking


Stop All Running Components runs the Shutdown macro.

Deploying and administering applications ■ 22--11


Preface
Setting data server properties
If you move a data server from one computer to another, you must
change the name of the computer specified in the Data Server
Properties dialog box.

To change the name of the computer on which the data


server is running:

1. In the Application Explorer in RSView Studio or the RSView


Administration Console, right-click the data server and then
click Properties.

2. In the box, Computer that will run the OPC server, type the
name of the computer on which the data server is installed, or
Browse button click the Browse button to select the computer name.

3. Click OK.

Setting up RSView SE Clients


The RSView SE Client provides a complete run-time environment
for the application.

With the RSView SE Client you can:

load, view, and interact with multiple graphic displays at a time,


that reside on any HMI server

perform alarm management

view trends

adjust set points

start and stop components on servers

provide a secured operator environment

22--12 ■ RSView Supervisory Edition User’s Guide


Set up the RSView SE Client using the RSView SE Client wizard.
The HMI server does not have to be running when you set up an
RSView SE Client, however, the HMI server must be loaded before
you can open an RSView SE Client.

The wizard creates a configuration file with the extension .cli. The
information in the file includes the name of the RSView application
to which the client can connect, the components that are started
when the connection is made, and the run-time behavior of the
client.

With the RSView SE Client wizard you can create a new client
configuration, or edit an existing one. You can also run a
configuration file from the first screen of the RSView SE Client
wizard, or you can remove a configuration file from the list of
available configurations.

To create a new RSView SE Client configuration file:

1. Start the RSView SE Client wizard. To do this, click the


Windows Start button, point to Programs, Rockwell Software,
RSView Enterprise, and then click RSView SE Client.

2. Follow the instructions on the screen.

If you need assistance while using the wizard, click Help.

To move RSView SE Client configuration files to another


computer:

1. Copy the .cli file from the source computer to the target
computer.

2. In RSView Studio, click the Tools menu, and then click Launch
SE Client.

3. In the Launch SE Client dialog box, click Browse, and then


locate the .cli file.

4. Click OK.

Deploying and administering applications ■ 22--13


Preface
Opening RSView SE Clients
To connect RSView SE Clients to RSView SE Servers, the server
computers and client computers must be members of the same
domain. The domain cannot be the local workstation domain.

For tips and troubleshooting suggestions to help you get


communications working between the client and server, see Help.

To open an RSView SE Client:

1. Make sure all HMI servers used by the application are loaded. For
more information about loading HMI servers, see “Setting up HMI
server properties” on page 22-8.

2. Do one of the following:

click the Windows Start button, point to Programs,


Rockwell Software, RSView Enterprise, and then click
RSView SE Client

in RSView Studio, click the Application Explorer, click the


Tools menu, and then click Launch SE Client

3. In the Launch RSView SE Client dialog box, specify the name


of the client configuration file, or click the Browse button to
Browse button locate the file if necessary, and then click OK.

To create a new RSView SE Client configuration file, click New.

When you launch an RSView SE Client the current Windows user


name and password are validated automatically against the user list
in the User Accounts editor.

If the login fails

If the current Windows user is not in the RSView User Accounts


list, the validation fails. A message is displayed, and you can then

22--14 ■ RSView Supervisory Edition User’s Guide


either cancel the attempt to run the RSView SE Client, or you can
log in manually. If you click Retry to log in manually, the RSView
Login dialog box appears.

Opening the RSView SE Client automatically


when Windows starts

To open the RSView SE Client automatically when


Windows starts:

1. Create a shortcut to the .cli file.

2. Move the shortcut to the Windows Start menu. For details about
adding shortcuts to the Start menu, see Windows Help.

Opening multiple clients

You can have more than one client window open on a single
computer. Multiple client windows allow you to connect to more
than one application from a single client computer.

To open several clients on one computer:

1. Run the RSView SE Client wizard.

2. For each application to which you want to connect, create a new


configuration file.

3. Make sure the HMI servers used by each application are loaded.

4. Open each RSView SE Client.

Deploying and administering applications ■ 22--15


Preface
How server components start and stop

Server components start after the HMI server loads. Opening


RSView SE Client will not run the Startup components. You can
start HMI server components manually using RSView Studio, or the
RSView Administration Console. For more information about
starting components manually, see page 22-11.

Server components stop when the HMI server is unloaded. Closing


the RSView SE Client will not stop components that are running
unless the RSView SE Client is the last client attached to the HMI
server, and the HMI server is set to load on demand.

You can stop all HMI server components manually using RSView
Studio, or the RSView Administration Console. For details, see
page 22-11.

Specifying time, date, and number formats

If your computer is not displaying the correct time, date, and


number formats, change the locale in the Windows Control Panel’s
Regional Options.

To change time, date, and number formats:

1. Click the Start button, point to Settings, and then click


Control Panel.

2. In the Control Panel window, double-click Regional Options.

The Regional Options dialog box opens.

3. In the Regional Options dialog box, click the General tab, and
then click the locale whose settings you want to use.

22--16 ■ RSView Supervisory Edition User’s Guide


4. Verify or customize the settings on the Numbers, Time, and
Date tabs.

5. Click OK.

For more information about using the Control Panel to set time,
date, and number formats, see your Windows documentation.

Administering your application


To make changes to an application after it is deployed, you can use
either:

RSView Studio, or

RSView Administration Console

The RSView Administration Console shuts down after 2 hours of


use, regardless of the activation keys you have installed.

To start the RSView Administration Console:

" Click Start, point to Programs, Rockwell Software, RSView


Enterprise, Tools, and then click RSView SE Administration
Console.

Deploying and administering applications ■ 22--17


Preface

With the RSView Administration Console you can:

add users to, or remove users from the system, using the User
Accounts editor

change an HMI server’s properties

change a data server’s properties

change which commands are secured, and which users can


access the commands, using the Secured Commands editor

run RSView commands from the Command Line

change direct-driver network setup using the Channels, Nodes,


and Scan Classes editors

change how alarms are logged and annunciated, using the Alarm
Setup editor

22--18 ■ RSView Supervisory Edition User’s Guide


add tags to, or remove tags from the Suppressed List, for testing
alarms

change the path of data log models

change what activities are logged, and how frequently, using the
Activity Log Setup editor on the Tools menu

change the location to which alarms are logged, and manage log
files, using the Alarm Log Setup editor on the Tools menu

import and export HMI tags using the Tag Import and Export
Wizard on the Tools menu

To find information about using these editors, see the chapters in


this manual.

Monitoring disk space on the HMI server


After you have deployed an RSView application, be sure that the
disk space on the computers running HMI servers does not fall below
20 MB.

To monitor disk space:

1. In theHMI server’s Events editor, create an event that uses the


free_bytes function to return number of free bytes available on
the HMI server’s hard disk.

2. Create a tag. If you want alarms when disk space drops below
preset levels above 20 MB, create an analog tag. If you want an
alarm only when disk space drops below 20 MB, create a digital
tag.

3. Create an alarm for the tag.

For more information about the free_bytes function, see


page 18-21. For information about events, see Chapter 13, Setting
up events.

Deploying and administering applications ■ 22--19


A
Appendix

RSView commands
This appendix describes:

where and how to use RSView commands

how to use the command line

RSView commands and their syntax

Using RSView commands

Where to use commands

You can use commands in the following places:

in a field that requires you to enter an action. For example, as


the press, release, or repeat action when you assign touch
animation to an object in a graphic display, or as the action for a
button

in a macro or symbol

in a command line

How to use commands

When entering commands, keep the following guidelines in mind:

Parameters enclosed in angle brackets < > are required.

Parameters enclosed in square brackets [ ] are optional.

RSView commands ■ A--1


Preface
Commands and parameters are not case sensitive.

Parameters do not have to be entered in the order they are listed.

Start each new command on a new line or separate commands


on the same line with a semicolon ( ; ).

Separate multiple parameters with a space.

Enclose long file names containing spaces with double quotes


when the file names are used as parameters. For example

Display PID /P“Temperature Loop 1”

Enclose area and component names that contain spaces, or are


ambiguous, in double quotes. An ambiguous area name is one
that is the same as another parameter for a command. For
example, AlarmOn “/H” would turn alarm monitoring on in
area ‘H’; whereas AlarmOn /H, would turn alarm monitoring
on with handshaking, in the current area.

The exclamation mark ( ! ) indicates the start of a comment.


Everything after the exclamation mark is ignored unless the
exclamation mark and what follows it are enclosed in double
quotes.

Many commands accept wildcards. The wildcards are:

* matches any number of characters, including the backslash


( \ ) and period ( . ) characters

? matches any single character

If a command accepts wildcards, this is noted in the description


of the command.

A--2 ■ RSView Supervisory Edition User’s Guide


Using placeholders in commands

To replace a tag name with its current value when the command is
evaluated, enclose the tag name in dollar signs ( $ ) to create a
placeholder in the command. If the placeholder is enclosed within
double quotes, or nested in the string value of another placeholder
in the command, RSView does not substitute the tag value.

The maximum number of characters for floating point tag values


is 17. If the value uses more than 17 characters, it will be
represented in scientific format. The maximum command length is
255. The command will be truncated if the substituted tag values
cause the command to exceed this length.

Example 1: A macro using placeholders in commands

Display Screen$Tag1$

Display $Tag3$$Tag2$

Valve23 = Open

When the macro runs, Tag1 = 1, Tag2 = 2, and Tag3 = Screen. These
are all string tags.

RSView replaces the placeholders in the commands with the tags’


current string values. The graphic display Screen1 appears, then the
graphic display Screen2 appears, then the tag Valve23 is set to its
open state.

You don’t need to put braces around tag names when using
placeholders in commands.

RSView commands ■ A--3


Preface

Example 2: Changing the value of a tag and tag placeholders

In this example, the initial value of Tag1 is zero. The value 4 is


assigned to Tag1, and the tag is then used in a macro. Type the
following text in a button’s press action:

Tag1 = 4 Set the value of Tag1 to 4.

Display_Detail Tag1 Execute the Display_Detail macro,


using Tag1 as a parameter.

In the Display_Detail macro, type the following:

Display Screen$%1$ Displays a graphic display whose


name is Screen plus the value of Tag1
(for example, Screen 4).

RSView replaces the placeholder in the command with the tag’s


current string value. The graphic display Screen4 appears.

Tag placeholders are evaluated before commands are executed. You


can ensure Tag1 evaluates to 4 by embedding the tag placeholder in
a macro, not in the button. If you include the tag placeholder in the
button, the tag placeholder evaluates before the value of the tag is
set to 4. $Tag1$ will therefore evaluate to zero (the tag’s initial
value), not 4.

You don’t need to put braces around tag names when using
placeholders in commands.

Precedence

Commands take precedence over macros. For example, if you have


a macro called Display the Display command will run whenever
you try to run the Activity macro.

A--4 ■ RSView Supervisory Edition User’s Guide


Where commands are executed

Some commands are executed at the server, some are executed at


the client, and some are executed wherever they were issued.

Commands executed at the RSView SE Server

Acknowledge DataLogMergeToPrimary EventOff

AcknowledgeAll DataLogNewFile EventOn

AlarmEvent DataLogOff HandShakeOff

AlarmLogNewFile DataLogOn HandShakeOn

AlarmLogOff DataLogRenameFile NodeDisable

AlarmLogOn DataLogSnapShot NodeEnable

AlarmLogSendTo ODBC DataLogSwitchBack NodeSwitch

AlarmOff DerivedOff Silence

AlarmOn DerivedOn SilenceAll

AlarmPrintOff DriverPrimary SuppressOff

AlarmPrintOn DriverSecondary SuppressOffAll

DataLogChangeRate DriverToggle SuppressOn

RSView commands ■ A--5


Preface
Commands executed at the RSView SE Client

The following commands are executed at the RSView SE Client.

Abort Invoke PullForward

Define Key PushBack

Display Login RecipeRestore

DisplayClientClose Logout RecipeSave

DisplayClientOpen NextPosition ScreenPrint

Download NextWindow SendKeys

DownloadAll Position SetFocus

FlushCache PrevPosition Undefine

Help PrevWindow Upload

Identify PrintDisplay UploadAll

Commands executed at the computer on which they


were issued

The following commands are executed wherever they are issued.


For example, if one of these commands is issued at the client, it is
executed at the client.

= (Equal) AppStart Remark

ActivityLogNewFile Beep Set

ActivityLogSendTo ODBC Pause Toggle

AlarmLogRemark PlayWave

AppAbort Ramp

A--6 ■ RSView Supervisory Edition User’s Guide


Commands that are not executed in test
display mode

The following commands are ignored when executed during test


display mode in RSView Studio.

Abort Key PrintDisplay

Display Login PullForward

DisplayClientClose Logout PushBack

DisplayClientOpen NextWindow SetFocus

FlushCache PrevWindow

Absolute and relative references

You can specify several command parameters using either absolute


or relative references. Relative references work like file names.
Absolute references work like file paths.

A relative reference is a reference to an application component,


excluding its path. The component’s path is determined from the
context in which the component’s name is specified.

An absolute reference is a reference to an application component,


including its path.

For example:

/MixingArea::IngredientDisplay is an absolute reference to a


graphic display called IngredientDisplay in the area called
MixingArea.

IngredientDisplay is a relative reference to a graphic display


called IngredientDisplay in the current area.

RSView commands ■ A--7


Preface
How relative references are resolved

Before RSView can perform an action on a component that was


specified using a relative reference, the relative reference must be
resolved. This means that RSView converts the relative reference to
an absolute reference.

For example, if the current area is called RecipesArea, the graphic


display specified using the relative reference IngredientDisplay, is
resolved to the absolute reference /RecipesArea::IngredientDisplay
before it can be used.

For commands, relative references are resolved in different ways,


depending on the type of parameters the command takes.

Commands that take tags as parameters

Commands that take tags as parameters are resolved as follows:

When the command is executed from a graphic display, the area


that contains the graphic display is used to resolve the relative
reference.

For example, if the command Display OverviewStats is executed


from the IngredientDisplay display in the area RecipesArea, the
area name RecipesArea is used to resolve the relative reference
in the command.

If the command is executed from the graphic display called


IngredientDisplay in the Mixing area, the Mixing area name is
used to resolve the relative reference in the command.

When the command is executed by an Events component, the


Alarm Identification command, or the Startup or Shutdown
macros, the area that contains the HMI server is used to resolve
the relative reference.

A--8 ■ RSView Supervisory Edition User’s Guide


Commands that take HMI project components as
parameters

When the command is executed from a graphic display, the area


that contains the graphic display is used to resolve the relative
reference.

Some commands are executed by a part of the system that runs in


the background. This background activity is managed by the HMI
server. For example, an Events component runs commands when
events occur. These systems resolve relative references using the
area in which the HMI server is located, because the HMI server
manages the background activity.

Using the command line


Use the command line during development, testing, and
maintenance. To open the Command Line, do one of the following
in the Application Explorer:

double-click the Command Line icon

right-click the Command Line icon and then click Show on the
shortcut menu

RSView commands ■ A--9


Preface
Using the Command Wizard
Use the Command Wizard to build command strings. The
Command Wizard lists all RSView commands and, where
applicable, lists the command’s parameters. The Wizard also lists
any macros that you have created.

To open the Command Wizard, do one of the following:

double-click in an action field or, in the Macro editor,


double-click anywhere in the editor

click the Browse button beside an action field or any field


requiring an RSView command
Browse button

This button opens the


Command Wizard.

in the Command Line editor, Security Codes editor, Events


editor, and Macro editor, click Commands on the Edit menu

A--10 ■ RSView Supervisory Edition User’s Guide


Building a command string

1. Open the Command Wizard.

When you click a


category here . . .

. . . the commands for


that category are listed
here.

To resize the list boxes,


drag this bar to the left or
right.

When you click a


command in the list, the
command syntax is
displayed here.

2. In the Command Categories list, click a folder.

To see the commands and macros you last used, click this folder:

To see all commands and macros, click this folder:

To see the commands that can be used for a particular part of the
system, click one of these folders:

RSView commands ■ A--11


Preface
3. Click a command in the Commands list.

To change the order in


which commands are
listed, click a column title.

To see all the information


for a command, use the
scroll bars.

Command Name lists the commands in the open folder.

Command Description describes the command’s function.

Command Syntax shows the command syntax. Angle brackets


< > indicate a required parameter. Square brackets [ ] indicate an
optional parameter.

4. Click Next to add parameters or click Finish. If a command has


parameters the Next button will be active. If a command doesn’t
have parameters, only the Finish button will be active.

A--12 ■ RSView Supervisory Edition User’s Guide


5. Choose parameters.

As you add parameters,


they are listed here.

6. When the command is complete, click Finish.

RSView commands ■ A--13


Preface
The RSView commands, organized alphabetically

= (Equal) [&]<tag_name> = <expression>

Writes the value resulting from an expression to a tag.

[&] Forces the command to be executed asynchronously, which


means that if the command is executed from a macro, the next
command in the macro will execute without waiting for the first
command to finish executing.

<tag_name> The name of the tag that will store the result of the
expression. The tag name can be an absolute or relative reference.
The tag name can include an area name.

<expression> A value, string, tag name, or a more complex


expression. Tag names can include area names.

Enclose tag names that contain dashes or start with a number in


braces { } when you use them in an expression. This distinguishes
the characters in the tag name from the characters in the expression.

Enclose strings in quotes. The string can contain any character, and
can include spaces.

Do not use braces for the tag name before the equal sign.

You cannot nest braces.

You can attach security to the = (Equal) command just as you can
for any RSView command. For more information about security,
see Chapter 14, Adding security.

For more information about expressions, see Chapter 18,


Creating expressions.

A--14 ■ RSView Supervisory Edition User’s Guide


Examples: The = (Equal) command

&Tag1 = Tag1 + 1
Evaluates the command asynchronously. Increases the value of Tag1
by 1.

Tag1 = Tag2
Sets the value of Tag1 to be the same as Tag2.

Tag1 = Tag2 + Tag3


Adds the values of Tag2 and Tag3 and stores the result in Tag1.

1Pump = {Industry-2} + {2Pump}


Adds the values of Industry-2 and 2Pump and stores the result in
1Pump. Braces surround Industry-2 because of the dash in the
name. Braces surround 2Pump because the name starts with a
number. No braces are used for 1Pump because this name is on the
left side of the equal sign.

Tag1 = if (Tag1 < Tag2) then 3 else 4


If Tag1 is less than Tag2, Tag1 is set to 3, but if Tag1 is equal to or
greater than Tag2, Tag1 is set to 4.

Tank1\Message = “Tank1 Overflow”


Writes the string Tank1 Overflow to the Tank1\Message tag.

RSView commands ■ A--15


Preface
Abort Abort [parameter]

Closes one or more graphic displays. Without a parameter, the


Abort command closes the graphic display that has focus.

[parameter] One of the following:

me Closes the graphic display from which the command is


issued.

display_name Closes the specified graphic display. The name of


the graphic display can include an area name.

* closes all graphic displays.

Ctrl-F4 also closes the active graphic display.

Examples: The Abort command

Abort
Without a parameter, closes the graphic display that has focus.

Abort me
Closes the graphic display from which the command is issued.

Abort /Mixing::Pumps
Closes the graphic display called Pumps in the area called Mixing.

Abort *
Closes all visible graphic displays. Cached displays are not closed.

A--16 ■ RSView Supervisory Edition User’s Guide


Acknowledge Acknowledge [tag_name]

Acknowledges an alarm or a group of alarms. This command gives


no indication that it has run but will display a message if not
executed properly.

If an acknowledge bit is associated with an alarm, acknowledging


the alarm sets the acknowledge bit.

[tag_name] The name of the tag to be acknowledged. This can be a


tag name, a name with wildcards, or the [tag] literal string. You can
specify the tag name using either an absolute or relative reference.
The tag name can include an area name.

If no tag is specified, this command acknowledges the most-severe,


most-recent unacknowledged alarm.

[tag] Specifying the word “tag” inside square brackets


acknowledges alarms for the tag associated with the highlighted
object in the active graphic display.

IMPORTANT If alarms are occurring rapidly, don’t run the


Acknowledge command without a tag name. The
Acknowledge command could acknowledge a new
alarm rather than the intended alarm.

Examples: The Acknowledge command

Acknowledge Hopper1\Flow
Acknowledges all outstanding alarms for the tag Hopper1\Flow.

Acknowledge Hopper1\*
Acknowledges all outstanding alarms for all tags in the folder called
Hopper1.

RSView commands ■ A--17


Preface
Acknowledge *
Acknowledges all outstanding alarms.

Acknowledge [tag]
Acknowledges the alarm for the tag associated with the highlighted
object in the active graphic display.

Acknowledge AcknowledgeAll [/area]


All
Acknowledges all alarms outstanding on an HMI server. This
command runs more quickly than Acknowledge *. It gives no
indication that it has run but will display a message if not executed
properly.

If an acknowledge bit is associated with an alarm, acknowledging


the alarm sets the acknowledge bit.

There is no limit to the number of tags that can be acknowledged


with this command.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

ActivityLog ActivityLogNewFile
NewFile
Creates a new activity log file.

This command lets you start a new activity log file on demand. All
subsequent activity messages are logged to the new file.

A--18 ■ RSView Supervisory Edition User’s Guide


ActivityLog ActivityLogSendToOdbc
SendToODBC
Exports activity log data from file sets to the ODBC database
specified in the Central Logging tab of the Activity Log Setup
editor.

AlarmEvent AlarmEvent [/area] <EventName> <EventType> [TagType]


[/VTagValue] [/SSeverity] [/H“Timestamp”] [/L“LogMessage”]

Creates an alarm event in an area containing an HMI server. Alarm


events are not processed unless the AlarmOn command is issued,
and alarm events stop being processed when the AlarmOff
command is issued.

You cannot specify the threshold for an alarm.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

<EventName> The name of the alarm event, up to 40 characters


long. The event name must follow the syntax of a tag name, and
can, but need not, be a tag name in the tag database. The alarm
event name cannot be the name of a tag for which alarms have been
set up.

RSView commands ■ A--19


Preface
<EventType> The type of alarm transaction, which must be one of
the following:

IntoAlarm or In Indicates that the tag has gone into alarm.

OutOfAlarm or Out Indicates that the tag has gone out of alarm.

InAndOut Of Alarm or InAndOut Indicates that an alarm has


occurred, but the tag is again immediately out of alarm, such as
a digital change-of-state alarm.

[TagType] The type of tag which must be one of:

/A Analog

/D Digital

If you don’t specify either /A or /D, the alarm is assumed to be


analog.

[/VTagValue] A floating-point value associated with the alarm


event. If the floating-point value is not specified, the tag value
is 0.0.

If the name of an alarm event is the name of a tag in the tag


database, the value specified by this parameter will not update the
tag’s value in the value table.

[/SSeverity] The alarm severity. The severity is an integer from


1 to 8. Alarm severity can be specified only for alarm events of type
IntoAlarm, or InAndOutOfAlarm. If a value is not specified, the
alarm severity is 1.

[/HTime-stamp] The time stamp associated with the alarm


transaction, in the format:<HH: MM: SS>[Date]:

<HH:MM:SS> The 24-hour military format for time. You must use
this format for indicating the time.

[Date] A date that can be specified in the same format as the


Windows date style set up for your computer. If you want to use a

A--20 ■ RSView Supervisory Edition User’s Guide


VBA program to set the date, you can use any date format that
conforms to the MFC class COleDateTime. If you do not specify a
date, the current date is used.

If you specify a time stamp for an alarm, the alarm may not appear
as the most recent alarm in the \system\AlarmBanner tag, even if it
was logged after an alarm with a more recent time stamp.

[/LLogMessage] The alarm message, up to 132 characters long, to


be logged to disk and/or printer. The log message can contain any
of the placeholders available to alarm messages. If you do not
specify a log message, the user default message is used.

AlarmLog AlarmLogNewFile [/area]


NewFile
Creates a new alarm log file in the path to which an HMI server is
currently logging.

This command lets you start a new alarm log file on demand. All
subsequent alarm messages are logged to the new file.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

RSView commands ■ A--21


Preface
AlarmLogOff AlarmLogOff [/area]

Stops an HMI server from logging alarms.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

AlarmLogOn AlarmLogOn [/area]

Starts alarm logging on an HMI server.

Alarm logging is on by default.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

A--22 ■ RSView Supervisory Edition User’s Guide


AlarmLog AlarmLogRemark [/area] [“Text”] [/P] [/Sn] [/R] [/Ttagname]
Remark
Adds the specified text string as a transaction in the alarm log file of
an HMI server.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

[“Text”] A text string, up to 132 characters long. The text can


contain the following placeholders:

\D the current date

\T the current time

\N the tag name. If the tag is in a local tag database, you can also
use the placeholders [\S] tag description and [\U] tag units.

[/P] Prompts the operator for a remark at run time by displaying a


dialog box containing a text box. The operator can type a remark
up to 132 characters long. The remark can also include the
placeholders shown above.

If both the Text parameter and the /P parameter are specified, the
contents of the Text parameter will appear in the text field at run
time, and the operator can modify or add to the contents of the Text
parameter before it is logged to the alarm log file. If the tag name
(/T parameter) is specified, the prompt dialog box will display the
tag name at run time, but the operator cannot change the tag name.

IMPORTANT Do not use this parameter with the AlarmLogRemark


command in events, or in the HMI server’s Startup or
Shutdown macro.

RSView commands ■ A--23


Preface
[/Sn] Associates an alarm severity with the remark. The severity is
an integer from 1 to 8. This value is shown in the Severity column
of the alarm log file. If the remark is logged to a printer, the alarm
severity determines which printer will print the remark.

If both the /P parameter and the /Sn parameter are specified, the
prompt dialog box will display the alarm severity at run time, but
the operator cannot change the severity.

[/R] Logs the remark to a printer as well as to the alarm log file. If
the alarm severity is not specified (/Sn parameter), the printer for
Severity 1 is used. If no printer is assigned to the specified severity,
the alarm log remark is not printed.

[/Ttagname] The string that is logged in the Tagname column of


the alarm log file. This string can be a tag name, the name of a
user-generated alarm event, or any other string that matches the
syntax of a tag name. You can use this parameter to correlate
remarks with specific alarm transactions for generating reports later.

AlarmLogSend AlarmLogSendToODBC [/area]


ToODBC
Exports alarm log data from file sets to the ODBC database specified
in the Central Logging tab of the Alarm Log Setup editor. Alarms
are exported from a single HMI server only. For details, see the area
parameter, below.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

A--24 ■ RSView Supervisory Edition User’s Guide


AlarmOff AlarmOff [/area]

Stops alarm monitoring on an HMI server. Once this command has


run, it displays a message indicating that alarm monitoring has
stopped.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

AlarmOn AlarmOn [/area] [/H]

Starts alarm monitoring on an HMI server. Once this command has


run, it displays a message indicating that alarm monitoring has
started.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

[/H] Turns on handshaking the moment alarm monitoring starts and


sets the handshake bit for any tags in alarm at that moment.

To have alarm monitoring start when an HMI server starts, open the
HMI server’s Startup editor, and then select the Alarming check box.

RSView commands ■ A--25


Preface
AlarmPrintOff AlarmPrintOff [/area]

Stops an HMI server from printing alarms.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

AlarmPrintOn AlarmPrintOn [/area]

Starts alarm printing on an HMI server.

Alarm printing is on by default.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

AppAbort AppAbort <application>

Closes the specified Windows application.

<application> The name of a Windows application exactly as it


appears in the application’s title bar.

A--26 ■ RSView Supervisory Edition User’s Guide


Example: The AppAbort command

If Notepad is open and contains an untitled file, the Notepad title


bar will read Untitled – Notepad. To close Notepad you must type
exactly what’s in the Notepad title bar as follows:

AppAbort Untitled - Notepad

AppStart AppStart <application>

Runs the specified application, which can be another Windows


application or an “application extender” you’ve programmed.

<application> The path and executable required to start the


program.

At run time, the application may appear behind the RSView


SE Client window. To make the application visible to an operator,
ensure the operator has a way of bringing the application to the
foreground, for example using Alt-Tab.

You can also work around this problem programmatically. For


details, see technical note P9029 in the Rockwell Software Support
Library.

Examples: The AppStart command

AppStart c:windows\notepad c:\autoexec.bat


Opens Notepad and displays the autoexec.bat file.

AppStart c:\Program Files\Plus!\Microsoft


Internet\Iexplore.exe
Opens Internet Explorer.

RSView commands ■ A--27


Preface
Beep Beep

Runs a wave file to produce a sound from the computer speaker.


The sound is a wave file assigned to the Default Beep in the
Windows Control Panel.

DataLog DataLogChangeRate <component> <value> [unit]


ChangeRate
Changes the periodic log rate. The change affects the current
logging session only, and won’t be retained if data logging is
stopped and restarted.

<component> The name of a data log model. The data log model
can be an absolute or relative reference. The data log model can
include an area name.

<value> The numeric portion of the time interval for the log rate.
For example, if you want to log data every 20 seconds, the value
is 20. The value must be an integer from 1 to 64,000.

[unit] The time unit of the log rate: hundredths, tenths, seconds,
minutes, hours, or days. If you omit the [unit] parameter, the
default is seconds.

DataLogMerge DataLogMergeToPrimary <parameter>


ToPrimary
Moves data from the secondary or backup path to the primary path
or ODBC database, for a specified model or for all models that are
currently running.

<parameter> One of the following:

<component> The name of a data log model. The data log


model can be an absolute or relative reference. The data log
model can include an area name.

* Moves data for all models that are currently running.

You can use the DataLogMergeToPrimary<component> command


whether or not the specified model is running. If a model is running

A--28 ■ RSView Supervisory Edition User’s Guide


when you issue the DataLogMergeToPrimary command, the HMI
server switches back to the primary path or ODBC database. If a
model uses file sets, the HMI server moves all files on the secondary
path (including the current file set) to the primary path, begins a
new file set on the primary path, and continues logging to the new
file set. If a model uses the ODBC format, the HMI server merges the
ODBC backup files into the ODBC database and continues logging to
the ODBC database.

DataLog DataLogNewFile <parameter>


NewFile
Creates a new data log file for the specified model or for all models,
on the path the HMI server is currently logging to (either the
primary path or the backup path). If the HMI server is logging to an
ODBC database, the HMI server logs an End snapshot and then a
Begin snapshot when you issue this command.

<parameter> One of the following:

<component> The name of a data log model. The data log


model can be an absolute or relative reference. The data log
model can include an area name.

/area::* Creates new files for all models that are currently
running.

Examples: The DataLogNewFile command

DataLogNewFile Daily
Creates a new set of data log files for the data log model called
Daily.

DataLogNewFile /Mixing::*
Creates a new set of data log files for all the data log models in the
area called Mixing. You cannot specify this parameter as /Mixing*.

RSView commands ■ A--29


Preface
DataLogOff DataLogOff <parameter>

Stops data logging for a specified model or stops data logging for all
models.

<parameter> One of the following:

<component> The name of a data log model. The data log


model can be an absolute or relative reference. The data log
model can include an area name.

/area::* Stops data logging for all models.

Examples: The DataLogOff command

DataLogOff Daily
Stops logging data for the model called Daily.

DataLogOff /Mixing::*
Stops logging data for all models in the area called Mixing. You
cannot specify this parameter as /Mixing*.

DataLogOn DataLogOn <component>

Starts data logging for the specified model.

<component> The name of a data log model. The data log model
can be an absolute or relative reference. The data log model can
include an area name.

To have data logging automatically start when a project starts, open


the Startup editor, click the Data Logging check box and specify a
component.

A--30 ■ RSView Supervisory Edition User’s Guide


DataLog DataLogRenameFile <component> <LogFileIDString>
RenameFile
Changes the log file identifier string that is used as part of the file
name for file sets and ODBC backup files. The change affects the
current logging session only, including the current set of log files.

<component> The name of a data log model. The data log model
can be an absolute or relative reference. The data log model can
include an area name.

<LogFileIDString> The log file identifier string, up to


20 characters.

DataLog DataLogSnapshot <parameter>


Snapshot
Logs one snapshot of data to the data log file, for the specified
model or all models.

<parameter> One of the following:

<component> The name of a data log model. The data log


model can be an absolute or relative reference. The data log
model can include an area name.

/area::* Logs a snapshot of data for all models that are running.

IMPORTANT The data log model must be running before the


DataLogSnapshot command is issued.

Examples: The DataLogSnapshot command

DataLogSnapshot Daily
Logs one snapshot of data in the Daily data log model to the data
log file.

DataLogSnapshot /Mixing::*
Logs one snapshot of data in all data log models in the area called
Mixing. You cannot specify this parameter as /Mixing*.

RSView commands ■ A--31


Preface
DataLog DataLogSwitchBack <parameter>
SwitchBack
Switches data logging back to the primary path or ODBC database
for the specified model or for all models. This command switches
data logging for a model only if the model is running, the HMI server
is logging data to the secondary or backup path, and the primary
path or ODBC database is available. For file sets, the HMI server
creates a new set of files when it switches back to the primary path.

<parameter> One of the following:

<component> The name of a data log model. The data log


model can be an absolute or relative reference. The data log
model can include an area name.

/area::* Switches data logging for all models that meet the
conditions outlined above.

Examples: The DataLogSwitchBack command

DataLogSwitchBack Daily
Switches data logging back to the primary path or ODBC database
for the data log model called Daily.

DataLogSwitchBack /Mixing::*
Switches data logging back to the primary path or ODBC database
for all data log models in the area called Mixing You cannot specify
this parameter as /Mixing*.

A--32 ■ RSView Supervisory Edition User’s Guide


Define Define <symbol> [string]

Creates a symbol. A symbol is an abbreviation for a command or a


command with parameters. The symbol can be used anywhere a
command can be used. You cannot nest symbols.

Symbol definitions are valid only during the current session; they
must be re-defined each time RSView is restarted. Symbols are
typically defined in a startup or login macro.

<symbol> The abbreviated command. It cannot contain spaces.

[string] An existing command with or without parameters. It can


contain spaces and other non-alphanumeric characters. Omitting
the [string] parameter deletes the symbol definition.

See also Undefine.

Examples: The Define command

Define Di Display
Creates the symbol Di for the command Display. Typing Di as a
command in any valid command syntax will have the same effect as
typing Display.

Define Show Display Overview /CC


Creates the symbol Show for the command Display Overview
/CC. Whenever Show is used, the graphic called Overview is
displayed in the center of the screen.

Define Di
Deletes the symbol Di.

RSView commands ■ A--33


Preface
DerivedOff DerivedOff <component>

Stops running the specified derived tag component.

<component> The name of a derived tag component. You can


specify the derived tag component using either an absolute or
relative reference. The derived tag component can include an area
name.

DerivedOn DerivedOn <component>

Starts running the specified derived tag component.

<component> The name of a derived tag component. You can


specify the derived tag component using either an absolute or
relative reference. The derived tag component can include an area
name.

To have a derived tag component start automatically when an HMI


server starts, open the HMI server’s Startup editor, select the Derived
Tags check box, and then specify a component.

Display Display <display_name> [/B] [/E] [/U] [/O] [cache]


[/Pcomponent] [/Ttag_name] [/Hnnn] [/Wnnn] [/Min] [/Max]
[position]

Runs the specified graphic display. Parameters specified here


override settings in the Display Settings dialog box in the Graphic
Displays editor.

If you are using the Cache After Displaying option in the Display
Settings dialog to cache displays, use the position parameters with
the Display command to ensure that displays open in the correct
position after caching. Otherwise, if a user moves a display at run
time, the new position is remembered by the cache option.

Do not cache more than 40 displays using the [cache] parameter


and/or the Cache After Displaying option.

A--34 ■ RSView Supervisory Edition User’s Guide


<display_name> The name of a graphic display. You can specify
the display name using either an absolute or relative reference. The
display name can include an area name.

[/B] Displays the specified graphic display in the background.

[/E] Disables the Enter key so it does not download values in


numeric input fields to the programmable controller or server,
unless the Display On-Screen Keyboard option is selected (in the
Behavior tab of the Display Settings dialog box).

[/U] Updates tag values in all input fields when the display first
opens.

[/O] Suppresses the display of the key list.

[cache] Specifies how to load the specified graphic display into the
display cache, as follows:

/Z Loads the specified graphic display into the cache (but does not
make it visible), so the display appears quickly when it is first used.

/ZA Loads the specified graphic display into the cache (but does not
make it visible) and continually updates the graphic display, even
when it is not visible. For example, use /ZA for a display that
contains a trend, so that the trend displays data for its entire time
range when you view it.

To remove all displays from the cache, use the FlushCache


command. To remove a particular display from the cache, use the
FlushCache [display] command.

[/Pcomponent] The name of the parameter component that


contains the tag names to be substituted for placeholders in the
display. If the display does not contain placeholders, do not use this
parameter.

If the parameter component’s name includes spaces, enclose the


component name in quotes, for example /P“Component with
spaces”.

RSView commands ■ A--35


Preface
[/Ttag_name] One or more tags, separated by commas and no
spaces, to be substituted for placeholders in the display. If the
display does not contain placeholders, do not use this parameter.

[/Hnnn] Specifies the height of the graphic display in pixels.

[/Wnnn] Specifies the width of the graphic display in pixels.

[/Min] Runs the graphic display minimized (as an icon).

[/Max] Runs the graphic display maximized (full-screen size).

[position] Specifies the position of the window as follows:

/Q1 top right corner

/Q2 top left corner

/Q3 bottom left corner

/Q4 bottom right corner

/CT centered in the top half

/CB centered in the bottom half

/CL centered on the left side

/CR centered on the right side

/CC centered in the screen

/Xnnn nnn pixels from the left edge

/Ynnn nnn pixels down from the top

Examples: The Display command

Display Sample
The graphic display called Sample is opened. It is positioned and
sized as specified in its Display Settings dialog box.

A--36 ■ RSView Supervisory Edition User’s Guide


Display Picture /PNames /CB
Positions the graphic display called Picture in the bottom half of
the screen, using the component called Names to replace tag
placeholders with tag names.

Display Picture /H300 /W400 /CC


Makes the graphic display called Picture 300 pixels high and 400
pixels wide, and positions the display in the center of the screen.

Example: Replacing tag placeholders in a graphic display

If a graphic display called Canning uses three tag placeholders, and


you want to substitute tags for canning corn, you would type:

Display Canning /Tcorn\off,corn\on,corn\weight


Placeholder #1 is replaced by the corn\off tag, placeholder #2 is
replaced by the corn\on tag, and placeholder #3 is replaced by the
corn\weight tag.

DisplayClient DisplayClientClose <file | Me | title>


Close
This command closes the specified RSView SE Client. It is executed
only at the RSView SE Client and is ignored if it is issued at the HMI
server.

<File> is the name of the RSView SE Client configuration file (.cli)


you want to close. The name can include the path to the file.

<Me> closes the RSView SE Client from which the command is


issued.

<Title> closes the RSView SE Client with the specified text in its
title bar.

RSView commands ■ A--37


Preface
DisplayClient DisplayClientOpen <file>
Open
This command opens the specified RSView SE Client. It is executed
only at the RSView SE Client and is ignored if it is issued at the HMI
server.

<File> is the name of the RSView SE Client configuration file (.cli)


you want to open. The name can include the path to the file.

Download Download

Writes the value in the selected input field of the active graphic
display to the programmable controller or server.

This command operates on the active graphic display. If no display


is active, this command is ignored.

Ctrl-PgDn also downloads the value in the selected input field.

The Enter key also downloads the value in the selected input field.
However, if the /E parameter is used with the Display command,
the Enter key is disabled, unless the Display On-Screen Keyboard
option is selected (in the Behavior tab of the Display Settings dialog
box). If the selected input field is a recipe field, pressing the Enter
key opens the Recipe dialog box.

DownloadAll DownloadAll

Writes the values in all input fields of the active graphic display to
the programmable controller or server.

This command operates on the active graphic display. If no display


is active, this command is ignored.

PgDn also downloads all the values in the input fields.

A--38 ■ RSView Supervisory Edition User’s Guide


DriverPrimary DriverPrimary <channel>

Switches from the secondary driver to the primary driver on the


specified channel.

<channel> The number of the channel (1 through 4) that is being


switched from its secondary to primary driver. The channel name
can be an absolute or relative reference. The channel name can
include an area name.

Driver DriverSecondary <channel>


Secondary
Switches from the primary driver to the secondary driver on the
specified channel.

<channel> The number of the channel (1 through 4) that is being


switched from its primary to secondary driver. The channel name
can be an absolute or relative reference. The channel name can
include an area name.

DriverToggle DriverToggle <channel>

Switches from the current driver to the one not being used on the
specified channel.

<channel> The number of the channel (1 through 4) that is being


switched from one driver to another. The channel name can be an
absolute or relative reference. The name of the channel can include
an area name.

EventOff EventOff <component>

Stops running the specified event component.

<component> The name of an event component. You can specify


the event component using either an absolute or relative reference.
The event component can include an area name.

RSView commands ■ A--39


Preface
EventOn EventOn <component>

Starts running the specified event component.

<component> The name of an event component. You can specify


the event component using either an absolute or relative reference.
The event component can include an area name.

To have an event component start automatically when an HMI server


starts, open the HMI server’s Startup editor, select the Event
Detector check box, and then specify a component name.

FlushCache FlushCache [display]

Without the parameter, unloads all graphic displays from the


display cache. With the parameter, unloads the specified graphic
display from the display cache.

[display] The name of a graphic display. You can specify the


graphic display name using either an absolute or relative reference.
The graphic display name can include an area name.

Displays can be added to the cache by using the [cache] parameter


with the Display command or by selecting the Cache After
Displaying option in the Display Settings dialog box of the Graphic
Displays editor. You can cache up to 40 graphic displays.

If a display uses the Always Updating option with the Cache After
Displaying option, the display’s shutdown command is executed
when you issue the FlushCache command.

A--40 ■ RSView Supervisory Edition User’s Guide


HandshakeOff HandshakeOff [/area]

Disables alarm handshaking, regardless of whether the individual


handshake bits are set up. This command gives no indication that it
has run but will display an error message if not executed properly.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

HandshakeOn HandshakeOn [/area]

Enables alarm handshaking. By default this setting is off.


Handshaking can be disabled with the HandshakeOff command.
This command gives no indication that it has run but will display a
message if not executed properly.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

IMPORTANT This command will not set the handshake bit for any tag
already in alarm when the command is executed.

RSView commands ■ A--41


Preface
Help Help [word] [/Ffile]

Displays a Windows Help file.

[word] A word you want to search for in the Help file. When you
specify a search word, the command will either:

open the Help file at a topic if the word uniquely identifies that
topic

open a list of related topics

[/Ffile] The name of a Windows Help file. The default Help file is
for RSView.

If no search word is specified, the command opens the RSView


Help file and displays the Contents topic.

Identify Identify [tag_name]

Runs the command or macro associated with the named tag,


whether or not the tag is in alarm. The command or macro is run at
the same location as the one from which the Identify command was
issued.

[tag_name] The name of the tag in alarm. The command or macro


associated with this tag will run. You can specify the tag name,
using either an absolute or relative reference. The tag name can
include an area name.

If no tag name is specified, the Identify command runs the


command or macro associated with the most recent, most severe
unacknowledged alarm.

A--42 ■ RSView Supervisory Edition User’s Guide


[tag] Specifying the word “tag” inside square brackets runs the
Identify command for the tag associated with the highlighted object
in the active graphic display.

IMPORTANT When many alarms are occurring rapidly, do not use the
Identify command without a tag name. A new alarm
could become the current alarm before the Identify
command runs, and the command or macro that runs
might not be the one expected.

Running the Identify command is not the same as acknowledging


an alarm.

Examples: The Identify command

Identify Hopper1\Divider
Runs the Identify command or macro for the tag Hopper1\Divider,
whether or not the tag is in alarm.

Identify [tag]
Runs the Identify command or macro for the selected tag in the
active graphic display.

Identify
Runs the Identify command or macro for the most recent, most
severe unacknowledged alarm.

Invoke Invoke <parameter>

Use this command to:

call an object’s method

assign the value returned by a method to a tag

set an object’s property to a tag value or a constant

set a tag to the value of an object’s property

RSView commands ■ A--43


Preface
The easiest way to specify the <parameter> string for the Invoke
command is to use the Command Wizard.

The syntax for this command has four variations:

display_name.object.method(parameter1, parameter2, . . .) calls


an object’s method.

display_name The name of the graphic display that contains the


ActiveX object. You can specify the display name using either
an absolute or relative reference. The display name can include
an area name.

me An alternative to using display_name. At run time it


resolves to the graphic display from which the command is
issued.

object The name of the ActiveX object as specified in the


Property Panel, in the Graphic Displays editor.

method The name of a method exposed by the ActiveX object.

parameter The tag name or constant that the method will use.
You must specify all of the parameters, even those that are
optional.

tag_name = display_name.object.method(parameter1,
parameter2, . . .) writes the value returned by a method to the
specified tag.

tag_name The name of the tag to which the value returned by


the method is written.

tag_name = display_name.object.property(tag_name or
constant) sets an object’s property to the specified tag’s value or to
a constant value.

tag_name = display_name.object.property sets the specified tag’s


value to the value of the object’s property.

A--44 ■ RSView Supervisory Edition User’s Guide


Key Key <parameter>

Starts or stops running the client key component.

<parameter> One of the following:

component The name of a client key component. You can


specify the component name using either an absolute or relative
reference. The component name can include an area name.

/R Stops running the client key component.

To have a client key component start automatically when an


RSView SE Client starts, use the RSView SE Client Wizard to
specify the client key component. For details, see Help for the
RSView SE Client Wizard.

Login Login [username] [password]

Logs users into the system. To log in, users must have an account in
the User Accounts editor.

[username] The user’s name as defined in the User Accounts


editor.

[password] The user’s password as defined in the Windows


domain. If this parameter is omitted, a window appears prompting
the user to enter the password.

Using this command with both parameters logs the user into the
system. Using this command with only one parameter displays the
login dialog box.

RSView commands ■ A--45


Preface
Logout Logout

When the logout command is issued, the following sequence of


events occurs:

1. The user’s logout macro executes.

2. All displays are closed (including cached displays).

3. The user is logged out.

4. If the RSView SE Client is licensed, it releases the license,


allowing the license to be used for other RSView SE Clients.

5. The login dialog box is displayed.

NextPosition NextPosition

Moves focus to the object with the next highest tab index number.

This command operates on the active graphic display. If no display


is active, this command is ignored.

Tab also moves focus to the object with the next highest index
number.

See also Position and PrevPosition.

NextWindow NextWindow

Moves focus to another open graphic display.

Ctrl-Tab and Ctrl-F6 also move focus to another open graphic


display.

See also PrevWindow.

A--46 ■ RSView Supervisory Edition User’s Guide


NodeDisable NodeDisable <node name>

Disables the specified node.

<node name> The name of the node you want to disable. The node
name can be an absolute or relative reference. The node name can
include an area name.

NodeEnable NodeEnable <node name>

Enables the specified node. The node name can be an absolute or


relative reference. The node name can include an area name.

<node name> The name of the node you want to enable.

NodeSwitch NodeSwitch <node name> <parameter>

Permanently changes a device node’s address, an OPC node’s


computer name, server name, and access path, or a DDE node’s
application and topic.

<node name> The name of the node that you want to switch to
another programmable controller address, server, or application.
The node name can be an absolute or relative reference. The node
name can include an area name.

<parameter> One of the following:

station For device nodes, the physical address for the


programmable controller you want to switch to.

\\computer name\servername[|accesspath]application
|topic For OPC servers, the computer name, server name, and
access path (if in use) for the OPC server you want to switch to.
Separate the access path from the server name with the |
character. For DDE servers, the application and topic, separated
by the | character, for the DDE server you want to switch to.

When you use the NodeSwitch command to change a node’s


address or server information, the change appears in the Node

RSView commands ■ A--47


Preface
editor’s spreadsheet. If the Node editor is open when you use the
command, the change won’t appear until you’ve refreshed the
display by closing and re-opening the editor.

Pause Pause <seconds>

Specifies a pause between the execution of two commands. You can


use this command in macros, from the command line, or as an
action for a button.

All commands or macros that follow the Pause command must not
be asynchronous (preceded by the & sign), otherwise the Pause
command has no effect.

<seconds> The number of seconds that will elapse between the


execution of the first and second command.

PlayWave PlayWave <file>

Plays the specified wave file.

<file> The complete path to the wave file, including the .wav
extension.

Position Position <n>

Moves focus to the object with the specified tab index number.

<n> The object’s index number.

These are the objects that use index numbers:

numeric and string input objects

buttons

objects to which you have assigned object keys

A--48 ■ RSView Supervisory Edition User’s Guide


The Position command operates on the active graphic display. If no
display is active, the Position command is ignored.

See also PrevPosition and NextPosition

PrevPosition PrevPosition

Moves focus to the object with the previous tab index number.

This command operates on the active graphic display. If no display


is active, this command is ignored.

Shift-Tab also moves focus to the object with the previous number.

See also Position and NextPosition.

PrevWindow PrevWindow

Moves focus to another open graphic display.

Ctrl-Shift-Tab and Ctrl-Shift-F6 also move focus to another open


graphic display.

See also NextWindow.

RSView commands ■ A--49


Preface
PrintDisplay PrintDisplay [parameter] [/Wait=tttt] [/U] [/Pcomponent]
[/Ttag_name]

Prints the specified graphic display to the default printer. If no


display is specified, prints the display that has focus.

[parameter] Specifies which graphic display to print, as follows:

display_name The name of a graphic display. You can specify


the display name using either an absolute or relative reference.
The display name can include an area name.

me The graphic display from which the command is issued.

[/Wait=tttt] Specifies the amount of time to wait before starting to


print, where tttt is the time in milliseconds. If you use the /U
parameter, specify enough time to allow for the upload of tag
values. If you do not specify a time, the default is 2000
milliseconds.

[/U] Initiates an update of tag values in all input fields before


starting to print. This parameter is not necessary with input fields
that are updated continuously.

[/Pcomponent] Specifies the name of a parameter component that


contains tag names to be substituted for placeholders in the display.

[/Ttag_name] Specifies one or more tag names to be substituted for


placeholders in the display. Separate multiple tag names with
commas; do not use spaces.

If the specified display is not currently visible, RSView prints the


display without making it visible. If this command is issued without
specifying a display, and no display has focus, RSView logs an error
to the activity log.

PrintDisplay prints the entire run-time display, even if parts are


covered by other displays. However, PrintDisplay does not
necessarily print ActiveX or OLE objects in their run-time state.

The ScreenPrint command prints an image of whatever shows on


the monitor. Use ScreenPrint to ensure that the display is printed

A--50 ■ RSView Supervisory Edition User’s Guide


showing all objects in their current, run-time state (provided they
are not covered by other displays).

PullForward PullForward <display_name>

Moves the specified graphic display in front of all other windows. If


the specified graphic display is of the Replace or Overlay type, and
a display of the On Top type is open, PullForward positions the
specified display behind the back-most On Top display and gives
the specified display focus.

<display_name> The name of an open graphic display. You can


specify the display name using either an absolute or relative
reference. The display name can include an area name.

If the specified display is of the Replace or Overlay types, and if no


other Replace or Overlay displays are open, nothing happens when
you issue this command.

PushBack PushBack <display_name>

Moves the specified graphic display behind all other windows. If


the specified graphic display is of the On Top type, PushBack
positions the display behind any other open On Top displays, and
in front of any open displays of the Replace or Overlay type.

<display_name> The name of an open graphic display. You can


specify the display name using either an absolute or relative
reference. The display name can include an area name.

If the specified display is of the On Top type, and if no other On


Top displays are open, nothing happens when you issue this
command.

RSView commands ■ A--51


Preface
Ramp Ramp [/V] <tag_name> <value>

Increases or decreases a tag’s value by a particular value or by the


value of another tag.

Use this command only with analog tags, or with data server tags
whose data type is not boolean or string.

[/V] Performs a read immediately after the write to verify that the
value was altered in the programmable controller or server.

This parameter is useful if the network is in poor condition or


susceptible to noise interference.

If the verification fails, the error message is logged to the activity


log, activity bar, or printer using the Tag Write category. Specify
where to send Tag Write errors using the Categories tab of the
Activity Log Setup editor.

<tag_name> The name of a tag. The tag name can be an absolute


or relative reference. The tag name can include an area name.

<value> The amount to add or subtract from the current value in


the programmable controller or server, as follows:

plus ( + ) or minus ( – ) a numeric value

plus ( + ) or minus ( – ) a percentage of a numeric value in the


form: +value%

plus ( + ) or minus ( – ) a tag

If Ramp calculates a value that is outside of the tag’s minimum and


maximum range, it will write the highest or lowest allowable value
to the programmable controller or server.

IMPORTANT If you use the Ramp command in a macro, you must use
two percent signs (%%) instead of one. A single percent
sign is used in a macro to indicate a parameter. For
example, to create a macro that increases the value of
tag1 by 75%, you would type: Ramp tag1 + 75%%

A--52 ■ RSView Supervisory Edition User’s Guide


Examples: The Ramp command

Ramp Hopper1\Level +50%


If the value of Hopper1\Level is 100, Min = -100 and Max = 900,
the command writes the value 600 to the programmable controller.

Ramp Hopper1\Level +75%


If Hopper1\Level is 900, Min = 0 and Max = 1000, the command
writes 1000 to the programmable controller because this is the
highest allowable value.

Ramp Hopper1\Level delta


If Hopper1\Level is 1000 and delta is -200, the command writes 800
to the programmable controller.

RecipeRestore RecipeRestore <component>

Reads the values from a recipe component into all input fields in
the active graphic display. This command is used with the Recipe
field.

<component> The name of the recipe component. You can specify


the recipe name using either an absolute or relative reference. The
recipe name can include an area name.

This command operates on the active graphic display. If no display


is active, this command is ignored.

RSView commands ■ A--53


Preface
RecipeSave RecipeSave <component>

Saves the values in all input fields of the active graphic display to a
recipe component. This command works with the Recipe field.

<component> The name of the component to which the values


will be saved. If a component of this name does not exist, it is
created. If a component of this name does exist, this command
prompts you to overwrite it. You can specify the recipe name using
either an absolute or relative reference. The recipe name can include
an area name.

This command operates on the active graphic display. If no display


is active, this command is ignored.

Remark Remark <comment>

Writes a text string to an activity log file, which is useful for


operators to store comments.

<comment> A string up to 132 characters long. The string can


contain any characters, including spaces. Enclose the exclamation
mark ( ! ) and the semi-colon ( ; ) in single or double quotes.

To log comments, the Remarks category must be selected in the


Activity Log Setup editor.

ScreenPrint ScreenPrint

Generates a screen print on the default printer specified in


Windows.

See also PrintDisplay.

A--54 ■ RSView Supervisory Edition User’s Guide


SendKeys SendKeys <“keystring”>

Sends the specified keystrokes to the active window.

<“keystring”> A list of keys. The quotes must be included.

The following syntax rules apply:

Use braces { } to enclose special keys, such as F3 or Enter; for


example, “{Enter}” sends Enter.

Use ^ to send a control key. For example, “^{F2}” sends


Ctrl-F2.

Use + to send a shift key. For example, “+{F3}” sends Shift-F3.

Use % to send an alt key. For example, “%A” sends Alt-A.

Special keys can be in upper and/or lower case letters. You can type
any of the following to represent the special keys on the keyboard:

Backspace, BkSp, BS Insert

End Left

Enter PgDn

Escape, Esc PgUp

Delete, Del PrtSc

Down Right

F1 to F12 Tab

Home Up

RSView commands ■ A--55


Preface
Set [&]Set [/V] <tag_name> <value | tag>

Writes a constant or another tag’s value to a tag.

IMPORTANT For direct driver communications, if a node has been


disabled, the Set command changes a tag’s value in the
value table, but not in the programmable controller.

[&] Forces the command to be executed asynchronously, which


means that if the command is executed from a macro, the next
command in the macro will execute without waiting for the first
command to finish executing.

[/V] Performs a read immediately after the write to verify that the
value was altered in the programmable controller or server.

This parameter is useful if the network is in poor condition or


susceptible to noise interference.

If the verification fails, the error message is logged to the activity


log, activity bars, or printer using the Tag Write category. Specify
where to send Tag Write errors using the Categories tab of the
Activity Log Setup editor.

<tag_name> The name of a tag. The tag name can be an absolute


or relative reference. The tag name can include an area name.

<value> One of the following:

For data server tags:

a numeric or string value corresponding with the tag’s data type

the name of another tag. The tag should be of a compatible data


type (for example, you cannot pass strings to numeric data
types).

A--56 ■ RSView Supervisory Edition User’s Guide


For analog tags:

a numeric value within the range specified by the tag’s minimum


and maximum values.

a percentage of the total min/max range. The formula is:


value = min + percentage/100 * (max – min)

the name of another analog or digital tag.

For digital tags:

a numeric value of 0 or 1.

a tag’s on or off label, as specified in the tag database. Setting a


digital tag to its on label writes the value 1, and setting the tag to
its off label writes the value 0.

the name of another analog or digital tag. If it is an analog tag


with a value that is not 0, the value 1 is written to the digital tag,
otherwise the value 0 is written.

For string tags:

a string enclosed in quotation marks. The string can contain any


character and can include spaces.

the name of another string tag.

Examples: The Set command

Set Hopper1\Flow 10
Hopper1\Flow is a tag. This command writes the value “10” to the
programmable controller or server.

Set Hopper1\Level 50%


Hopper1\Level is a tag with the minimum specified as -100 and the
maximum defined as 900. This command writes the value “400” to
the programmable controller or server.

RSView commands ■ A--57


Preface
Set Valve\23 open
Valve\23 is a digital tag with its on label set up as open. This
command uses the on label for the tag to write the value “1” to the
programmable controller or server.

Set Hopper1\Level Preset


Hopper1\Level is a tag and Preset is a tag with a value of “90.” This
command writes “90” to the programmable controller or server.

Set String\string1 “open”


String\string1 is a string tag. This command writes “open” to the
programmable controller or server.

Set Channel1.Device1.Pressure 33
Pressure is an analog tag in a data server. Channel1 is the network
the data server uses to connect to a device called Device1.

SetFocus SetFocus <display_name>

Sets the focus to a particular graphic display.

<display_name> The name of a graphic display. You can specify


the display name using either an absolute or relative reference. The
display name can include an area name.

Silence Silence <tag_name>

If the alarm for the specified tag is set up to use the internal bell,
this command silences the computer’s sound.

If the alarm for the specified tag is set up to use the external bell,
this command resets the tag associated with the external bell and
silences the associated audio device.

<tag_name> The name of a tag that is in alarm. You can use


wildcards. You can specify the tag name using either an absolute or
relative reference. The tag name can include an area name.

A--58 ■ RSView Supervisory Edition User’s Guide


SilenceAll SilenceAll [/area]

Silences the internal and external bells for all tags in alarm.

Using this command is faster than using the Silence command with
the asterisk ( * ) wildcard.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

SuppressOff SuppressOff <tag_name>

Restores alarm reporting for the specified suppressed alarm.

<tag_name> The name of a tag that no longer requires alarm


suppression. You can use wildcards. You can specify the tag name
using either an absolute or relative reference. The tag name can
include an area name.

RSView commands ■ A--59


Preface
SuppressOffAll SuppressOffAll [/area]

Restores alarm reporting for all suppressed alarms.

This command is faster than the SuppressOff * command.

[/area] A relative or absolute reference to an area that contains an


HMI server. If an area is not specified, or if a relative reference is
specified, the area is resolved as follows:

if the command is executed from a graphic display, the area that


contains the graphic display is used to resolve the reference

if the command is executed by a part of the system that runs on


an HMI server (for example, events), the area that contains the
HMI server is used to resolve the reference

SuppressOn SuppressOn <tag_name>

Suppresses reporting of alarms for the specified tag.

<tag_name> The name of a tag, or a wildcard. You can specify the


tag name using either an absolute or relative reference. The tag
name can include an area name.

This command is useful when equipment repairs or maintenance


would otherwise result in alarms being generated. All alarms for
each threshold of the monitored tag are suppressed. Alarm
suppression can take place before or after issuing the AlarmOn
command.

A--60 ■ RSView Supervisory Edition User’s Guide


Toggle Toggle [/V] <tag_name>

Reads the tag’s value and writes back a 1 or 0 as follows:

if the tag’s value is 0, Toggle changes it to 1

if the value is not 0, Toggle changes it to 0

[/V] Performs a read immediately after the write to verify that the
value was altered in the programmable controller or server.

This parameter is useful if the network is in poor condition or


susceptible to noise interference.

If the verification fails, the error message is logged to the activity


log, activity bars, or printer using the Tag Write category. Specify
where to send Tag Write errors using the Categories tab of the
Activity Log Setup editor.

<tag_name> The name of a tag, or the name of an analog or digital


HMI tag. The tag name can be an absolute or relative reference. The
tag name can include an area name.

Undefine Undefine <symbol>

Deletes a symbol definition that was created using the Define


command.

Example: The Undefine command

Undefine test
Deletes the definition for the symbol “test” that was previously
created with the Define command.

Undefine *
Deletes all symbol definitions.

See also Define.

RSView commands ■ A--61


Preface
Upload Upload

In a graphic display, reads a value from the programmable


controller or server and displays it in the selected input field.

This command operates on the active graphic display. If no display


is active, this command is ignored.

Ctrl-PgUp also uploads the value to the selected input field.

UploadAll UploadAll

In a graphic display, reads values from the programmable controller


or server and displays them in all the input fields.

This command operates on the active graphic display. If no display


is active, this command is ignored.

PgUp also uploads all the values to the input fields.

A--62 ■ RSView Supervisory Edition User’s Guide


B
Appendix

System tags
System tags are preconfigured HMI tags that are created and updated
by an HMI server.

Alarms
The following tags are updated with information about the alarms
in the HMI server:

Tag Name Type Contains information about

system\AlarmBanner String The most recent, most severe alarm. If an alarm


of an equal or higher severity occurs, it replaces
the first alarm, even if the previous alarm has not
been acknowledged.

system\AlarmMostRecentDate String The date of the most recent, most severe alarm.

system\AlarmMostRecentLabel String The threshold label of the tag of the most recent,
most severe alarm.

system\AlarmMostRecentSeverity Analog The severity of the most recent, most severe


alarm.

system\AlarmMostRecentTagDesc String The description of the tag of the most recent,


most severe alarm.

system\AlarmMostRecentTagname String The name of the tag of the most recent, most
severe alarm.

system\AlarmMostRecentTime String The time of the most recent, most severe alarm.

system\AlarmMostRecentUnits String The units of the most recent, most severe alarm.

system\AlarmStatus String The number of unacknowledged and suppressed


alarms.

System tags ■ B--1


Preface

Tag Name Type Contains information about

system\AlarmSummaryItems Analog The number of alarm transactions in an


unfiltered alarm summary.

system\AlarmSummaryItemsUnacked Analog The number of unacknowledged alarms in an


unfiltered alarm summary.

system\AlarmSuppressedCount Analog The number of tags with alarm suppression


turned on.

Communications

Device communications for HMI tags

The following tags contain communication information about HMI


tags. These tags are added to the system folder when you set up a
channel in the Channel editor. Each channel you set up will have
these four tags. The number on the end identifies the tags for each
channel. For example, system\ComErrorString1 is for channel 1.

To report communication errors, issue the ComStatusOn


command.

Tag Name Type Contains information about

system\ComErrorString1 String Most recent device error message.

system\ComErrorValue1 Analog Internal number of most recent


device error.

system\ComStatusString1 String Current status of device


communications. Will be the same
as system\ComErrorString1 if the
error condition still exists.

system\ComStatusValue1 Analog Internal number indicating current


status of device communications.
Will be the same as
system\ComErrorValue1 if the
error condition still exists.

B--2 ■ RSView Supervisory Edition User’s Guide


OPC client communications for HMI tags

The following tags contain OPC client communication information


about HMI tags. These tags are added to the system folder when you
set up an OPC node in the Node editor.

Tag Name Type Contains information about

system\ComErrorStringOPC String Most recent OPC error message.

system\ComErrorValueOPC Analog Internal number of most recent OPC error.

system\ComStatusStringOPC String Current status of OPC communications. Will be the same


as system\ComErrorStringOPC if the error condition still
exists.

system\ComStatusValueOPC Analog Internal number indicating current status of OPC


communications. Will be the same as
system\ComErrorValueOPC if the error condition still
exists.

DDE client communications

The following tags contain DDE client communication information.


These tags are added to the system folder when you set up a DDE
node in the Node editor.

Tag Name Type Contains information about

system\ComErrorStringDDE String Most recent DDE client error message.

system\ComErrorValueDDE Analog Internal number of most recent DDE client error.

system\ComStatusStringDDE String Current status of DDE client communications. Will be


the same as system\ComErrorStringDDE if the error
condition still exists.

system\ComStatusValueDDE Analog Internal number indicating current status of DDE client


communications. Will be the same as
system\ComErrorValueDDE if the error condition
still exists.

System tags ■ B--3


Preface
Time
The following tags contain time and date information in various
formats:

Tag Name Type Provides this data Read or write

system\Date String System date. Read only

system\DateAndTimeInteger Analog Number of seconds elapsed since Read only


midnight (00:00:00) January 1, 1970,
coordinated universal time (UTC).

system\DateAndTimeString String Complete date and time display Read only


For example:

Monday, December 11 2000 10:47:50 AM

system\DayOfMonth Analog Day of the month (1 to 31). Read only

system\DayOfWeek Analog Day of the week (1 to 7); Sunday = 1. Read only

system\DayOfYear Analog Day of the year (1 to 366). Read only

system\Hour Analog Hour of the day (0 to 23). Read and write

system\Minute Analog Minutes (0 to 59). Read and write

system\Month Analog Number for month. Read only

system\MonthString String Name of the month. Read only

system\Second Analog Seconds (0 to 59). Read and write

system\Time String System time. Read only

system\Year Analog The year (1980 to 2099). Read only

B--4 ■ RSView Supervisory Edition User’s Guide


C
Appendix

Setting up direct driver


communications for
HMI tags

RSView’s HMI tags can use a direct connection to the drivers in


RSLinxt to support connections to most Allen-Bradley devices, as
well as SoftLogixt 5 devices in legacy applications. This chapter
describes how to set up direct driver communications.

RSView also allows you to connect directly to most Allen-Bradley


and SoftLogix 5 devices using data servers. For details about setting
up data servers, see “Adding data servers” on page 5-3.

You can also use DDE (Dynamic Data Exchange) to connect to


third-party devices or servers, as described in Appendix D, Setting
up DDE communications for HMI tags.

Overview of direct driver communications

Communication through direct drivers involves:

channels

communication devices

communication driver software (RSLinx)

nodes (control devices)

Setting up direct driver communications for HMI tags ■ C--1


Preface
The following illustration shows an HMI server and its channel and
nodes.

HMI server
Communication
channel
Network

Nodes

Programmable controller Programmable controller

Communication channel

The communication channel is the connection from an HMI server to


the network the programmable controllers are attached to.

Communication device

The communication device connects the communication channel to


the computer. You can use internal devices, such as the
1784-KT /KTX , or you can use external devices connected through
the serial port.

Communication driver

The communication driver is the software that permits the


computer to communicate with the communication device. For

C--2 ■ RSView Supervisory Edition User’s Guide


communication with most Allen-Bradley programmable
controllers, use RSLinx.

For communication with SoftLogix 5 programmable controllers,


you must use an RSLinx driver.

Node (control device)

The node is a programmable controller attached to a data highway


or network. Once the HMI server is set up, it must periodically
update its value table. This is done by scanning its nodes.

Setting up direct driver communication to


programmable controllers
The instructions on the pages that follow summarize the steps for
connecting to Allen-Bradley or SoftLogix 5 devices.

IMPORTANT You cannot connect to an Allen-Bradley PLC-5/250 or


ControlLogix 5550 using direct drivers. To connect to
these types of programmable controllers, use OPC- or
DDE-based communications.

For details about OPC communications, see Chapter 5,


Setting up communications for data server tags, and
Chapter 6, Setting up communications for HMI tags.

For details about DDE communications, see


Appendix D, Setting up DDE communications for
HMI tags.

Setting up direct driver communications for HMI tags ■ C--3


Preface
Setting up communications without
hardware or software

You can set up communications in an HMI server, even if you do not


have one or both of the following:

RSLinx drivers installed

the appropriate communications hardware installed

To do so, follow the steps below, but skip step 1 and start with
step 2.

Summary of steps

Follow the steps below to set up direct driver communication with


Allen-Bradley or SoftLogix 5 programmable controllers.

1. Start RSLinx. Set up and then load the appropriate


communication driver.

2. Start RSView Studio, and then create or open an application.

3. Add an area, and then create an HMI server in the area.

4. In the Channels editor, select a channel and assign the


appropriate network type to it.

In the Primary Communication driver field, assign a driver to


the channel. If you do not have drivers loaded, click None
Loaded.

For details, see “Setting up channels” on page C-6.

5. In the Node editor, create nodes for each programmable


controller you want to communicate with.

For details, see “Creating a node” on page C-13.

6. If you want to change the default rate at which nodes are


scanned, open the Scan Class editor and then edit the scan
classes.

C--4 ■ RSView Supervisory Edition User’s Guide


For details, see “Scanning for new tag values” on page C-17.

7. In the Tags editor, create tags. For each tag, select Device as the
data source and assign the nodes and scan classes that you have
defined.

For details, see Chapter 7, Working with tags.

8. Monitor communications.

For details, see “Monitoring communications” on page C-20.

Setting up RSLinx drivers


RSLinx drivers provide a direct connection between HMI server tags
and Allen-Bradley or SoftLogix 5 programmable controllers. For
details about setting up any of the RSLinx drivers, see your driver
documentation.

You can also use RSLinx with OPC and DDE communications, as
described in Chapter 6, Setting up communications for HMI tags, and
Appendix D, Setting up DDE communications for HMI tags. You must
use an OPC or DDE connection to handle unsolicited messages and to
communicate with the PLC -5/250 or ControlLogix devices.

Using the drivers

To set up and use the RSLinx drivers with a direct connection, the
drivers must be installed on the same computer as the HMI server.
Once the drivers are set up, the HMI server automatically starts the
driver software whenever communication with a programmable
controller is required—for example, to test run a graphic display or
to run an application.

IMPORTANT You must use the version of RSLinx that came with
your RSView software. This version has been tested for
compatibility with RSView. Other versions may not
work correctly.

Setting up direct driver communications for HMI tags ■ C--5


Preface
Selecting a driver in RSView

To select a driver in an HMI server, the driver must first be set up in


RSLinx. All configured drivers appear in the Primary or Secondary
Communication Driver fields in the HMI server’s Channels editor.

If the Channels editor is open when you add a driver in RSLinx,


close the Driver list by clicking another part of the editor, and then
re-open the list.

Setting up channels
A channel is the connection between the HMI server and the
network the programmable controllers are attached to.

To set up a channel:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Channels editor by doing one of the following:

double-click the Channels icon

right-click the Channels icon and then click Show

C--6 ■ RSView Supervisory Edition User’s Guide


Define up to
four different
communication
channels.

Click here to
Specify the display the list
type of network of drivers for
you are using. the selected
network type.

When you
select a
network type,
these options
become active.

3. Click a channel and then fill in the following information:

Network Type

Using the following table as a guide, select a network type:

To Click

communicate with programmable controllers on a ControlNet


ControlNet network

communicate with programmable controllers on local DH


or remote DH networks

G communicate with programmable controllers on DH+


local or remote DH+t networks,
or

G communicate with SLCt controllers on remote


DH-485 networks, or

G connect to Channel 0 of an Enhanced PLCr

Setting up direct driver communications for HMI tags ■ C--7


Preface

To Click

G communicate with SLC controllers on local DH-485


DH-485 networks,
or

G connect to an SLC with an RS-232 port

G communicate with Ethernetr programmable TCP/IP


controllers directly connected to the TCP/IP
network,
or
G communicate with SoftLogix 5 controllers,
or

G communicate with SLC 5/05t controllers

communicate with programmable controllers through TCP/IP Bridge


the Ethernet interface of a Pyramid Integratort, or
RSLinx Gateway

G set up communications without using a channel, None Loaded


or

G clear a channel configuration

To set a configured channel’s network type to None Loaded,


first issue the ComStatusOff command. Because setting a
configured channel’s network type to None Loaded deletes all
the comstatus system tags from the tag database, you cannot set
a configured channel’s network type to None Loaded if the
ComStatusOn command has been issued.

IMPORTANT Of the four communication channels you can set up,


only one can be set up for TCP/IP. For example, you
cannot set up one channel for TCP/IP, and another for a
TCP/IP bridge.

To run a SoftLogix 5 controller with RSLinx and an HMI server,


set up the TCP/IP channel and use the SOFT 5 driver or the AB_ETH
driver.

C--8 ■ RSView Supervisory Edition User’s Guide


For the SOFT 5 driver, when setting up the SoftLogix 5 driver in
RSLinx, enter the IP address or UNC name of the SoftLogix 5
controller in the Internet Address Mapping table.

If the SoftLogix 5 controller is not running on the same


computer as RSLinx, the Windows user account that is running
RSLinx must be a member of the SoftLogix Administrators
group on the SoftLogix 5 computer.

For the AB_ETH driver, when setting up the Ethernet driver in


RSLinx, enter the IP address of the SoftLogix 5 controller in the
Internet Address Mapping table. You must also enable the
WinSock TCP/IP driver in SoftLogix 5.

Messages

Type a number between 1 and 10. This is the number of


messages an HMI server will send on a channel before requiring a
reply. These messages are stored in the buffers of the
programmable controllers on the channel (each controller has its
own buffer). If a buffer overflows at run time, a communication
error is generated. If this happens, reduce the number of
messages.

The Messages field applies to both the primary and secondary


communication drivers.

Setting up direct driver communications for HMI tags ■ C--9


Preface
Primary and Secondary Communication Drivers

The primary driver is the one your system will use most of the
time. By default, this driver is the active driver. The secondary
driver is a backup. Primary and secondary drivers must use the
same network type.

IMPORTANT Do not select a secondary communication driver for


TCP/IP, or TCP/IP Bridge channels. To create
communications redundancy, use a second Ethernet
card, and set up each card uniquely in Windows. Then
use the NodeSwitch command at run time to change
the IP number if communication errors are detected.

To specify a driver, select the appropriate driver from the list.


This list contains the drivers installed and running in RSLinx
that are valid for the selected network type.

To set up communications without the appropriate hardware or


software installed, select None Loaded as the driver.

For details about setting up drivers, see “Setting up RSLinx


drivers” on page C-5.

Active Driver

The active driver can be Primary, Secondary, or None. By


default, the Primary driver is active.

To disable a channel temporarily without removing its


configuration, click None.

At run time, users can switch between drivers if necessary. For


details, see “Switching communication drivers at run time”,
below.

4. When you finish setting up channels, click OK.

C--10 ■ RSView Supervisory Edition User’s Guide


Changing the channel configuration

To change the channel configuration once nodes have been


assigned—for example, to move an application from a computer
using DH+ to a computer using TCP/IP—create a new channel of the
correct type. Re-assign the channel number for each node, then
delete the original channel configuration.

Switching communication drivers at run time

If the primary network fails at run time, your system can switch to
a driver on a pre-defined secondary network. You can set up your
application so drivers switch automatically, or so operators
manually switch the drivers.

Commands for switching drivers

Use the following commands to switch drivers:

DriverPrimary <channel>

Switches from the secondary driver to the primary driver on the


specified channel.

<channel> The number of the channel (1 through 4) that is being


switched from its secondary to primary driver.

DriverSecondary <channel>

Switches from the primary driver to the secondary driver on the


specified channel.

<channel> The number of the channel (1 through 4) that is being


switched from its primary to secondary driver.

Setting up direct driver communications for HMI tags ■ C--11


Preface
DriverToggle <channel>

Switches from the current driver to the one not being used on the
specified channel.

<channel> The number of the channel (1 through 4) that is being


switched from one driver to another.

Switching drivers automatically

To switch drivers automatically, create an event in the Events


editor. In the Action field of the Events editor, type a driver
command as the action that will be triggered when an expression
results to true. In the Expression field, create an expression that will
trigger the action.

Example: An event for switching drivers

In the Events editor, set the following:

Action DriverToggle 1

Expression comm_err(tag1)

where tag1 is a tag that is set up with a node on channel 1.

When the expression evaluates to true, the action is triggered.

Switching drivers manually

To switch drivers manually, operators must have a way to issue a


driver command. For example, create a button, and then specify
one of the driver commands as the press action for the button.
When the operator clicks the button, the driver on the specified
channel is switched.

C--12 ■ RSView Supervisory Edition User’s Guide


Creating a node
A node allows you to assign a logical name and an address to each
programmable controller that an HMI server will communicate with.
Each programmable controller is then referred to throughout an
HMI server by this name. The node name carries all its configuration
information, so attributes such as type of programmable controller,
station number, and network type need not be repeated.

Before you can set up a device node, you must set up


communication channels. For details, see “Setting up channels” on
page C-6.

To create a node:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Nodes editor by doing one of the following:

double-click the Nodes icon

right-click the Nodes icon and then click Show

Setting up direct driver communications for HMI tags ■ C--13


Preface

3. For each node, fill in the following information:

Data Source

Click Direct Driver.

For details about OPC server data sources, see Chapter 6, Setting
up communications for HMI tags. For details about DDE server
data sources, see Appendix D, Setting up DDE communications
for HMI tags.

Name

Type a name of your choice up to 40 characters long. This name


represents the programmable controller. The name can have
upper and lower case letters, numbers, dashes, and underscores.
Spaces are not permitted.

C--14 ■ RSView Supervisory Edition User’s Guide


Enabled

Normally nodes are enabled, allowing collection of values from


the programmable controller. However, to prevent
communication timeouts or invalid data during setup or
troubleshooting, you might want to disable a node. When a
node is disabled, tag values can still be read and written, but the
values are read from and written to the value table instead of the
programmable controller.

When a tag uses a disabled node at run time, the tag’s state will
change from valid to disabled. A tag’s state can be seen by
viewing the tag in the tag monitor.

To disable nodes, clear the Enabled check box.

You can also enable and disable nodes at run time, using the
NodeEnable and NodeDisable commands. For more
information see Appendix A, RSView commands.

Channel

Select the channel number on which this node resides.

Station

Type the station address of the programmable controller.

If RSLinx is installed and running on your computer, click the


Browse button next to the Station field to open the RSWho
Browse button window that displays all active PLC stations for the selected
channel. When you select a station from the RSWho window,
the Station and Type fields are filled in automatically. RSView
substitutes PLC -5 (Enhanced) for all PLC -5r series device types.
Change the entry in the Type field to PLC -5 if you are using the
PLC -5/10, 5/12, 5/15, or 5/25.

For the SOFT 5 driver, enter the UNC name of the SoftLogix 5
controller without the backslashes. For example, if the UNC

Setting up direct driver communications for HMI tags ■ C--15


Preface
computer name is \\ORION , type ORION . The computer name
must be 8 characters or less.

For SoftLogix 5 controllers using the AB_ETH driver, enter the


controller’s IP address.

Type

Select the type of device you are using.

For this device type Select

PLC-2r PLC-2

PLC-3r PLC-3

PLC-5/10, PLC-5/12, PLC-5/15, PLC-5/25 PLC-5

PLC-5/11, PLC-5/20, PLC-5/30, PLC-5/40, PLC-5 (Enhanced)


PLC-5/60, PLC-5/80

SLC 5, SLC 5/01,t SLC 5/02,t SLC 5


SLC 5/03t (OS 300)

SLC 5/03 (OS 301), SLC 5/04,t SLC 5/05 SLC 5 (Enhanced)

SoftLogix 5 SoftLogix 5

To communicate with a SoftLogix 5 device you must use an


RSLinx driver and a TCP/IP channel.

Timeout

Type the number of seconds you want the HMI server to wait
before reporting a communication error. A timeout period of
three seconds is usually enough.

4. Click Accept to save the node configuration.

5. When you finish setting up nodes, click Close.

C--16 ■ RSView Supervisory Edition User’s Guide


Changing node information at run time

To permanently change a node’s station number at run time, use the


NodeSwitch command. This command allows you to set up
node-level redundancy. That is, if the programmable controller that
a node is pointing to fails, you can immediately switch to another
programmable controller.

NodeSwitch <node name> <station>

<node name> The name of the node that you want to change to
another programmable controller address.

<station> For device nodes, the physical address for the


programmable controller you want to change to.

When you use the NodeSwitch command to change a node’s


address, the change appears in the Node editor’s spreadsheet. If the
Node editor is open when you use the command, the change will
not appear until you have refreshed the display by closing and
re-opening the editor.

You can also enable and disable nodes at run time, using the
NodeEnable and NodeDisable commands. For more information
see Appendix A, RSView commands.

Scanning for new tag values

When your HMI servers are running, they must periodically update
their tag values in the value table. This is done by scanning.

For servers that contain HMI tags, and are communicating through
direct drivers, values are updated by scanning the programmable
controller address at the foreground and background scan rates
specified by the scan class.

Setting up direct driver communications for HMI tags ■ C--17


Preface
RSView scan classes

Any tag that communicates with Allen-Bradley or SoftLogix 5


programmable controllers through direct drivers must be assigned
to an RSView scan class. Each tag can then be assigned different
foreground and background scanning periods. In this way, you
determine how often a tag value is updated.

A scan class has two scan periods: the foreground period and the
background period. The foreground period applies to graphic
displays, derived tags, events, and data log. The background period
applies only to alarms.

If the same tag is used by both a foreground and background


component, the tag is scanned at the faster period. If a value is not
required by a foreground or background component, its address is
not scanned, greatly reducing system overhead.

Guidelines for setting up scan classes

Set foreground scan periods to be shorter than or equal to


background scan periods.

A scan period of zero means scan as quickly as possible. You can


set foreground scan periods to zero, but never set background
scan periods to zero. For foreground periods, using zero is not
recommended because this setting can result in so much traffic
that overall system communication slows down.

Set scan periods for optimal efficiency. Specify a frequent scan


rate for tags representing fast-moving devices and a less frequent
scan rate for tags representing devices that change less often.

This approach optimizes system performance, providing


high-speed scanning where required and using less frequent
scanning, which saves system resources, where acceptable.

Set the scan period to match the expected rate of change for the
tag’s data. For example, if you scan every five seconds for a

C--18 ■ RSView Supervisory Edition User’s Guide


change of state that occurs once an hour, the system is needlessly
burdened. Conversely, if you scan too slowly, the system cannot
monitor value changes that might occur between scans.

To set up a scan class:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Scan Class editor by doing one of the following:

double-click the Scan Class icon

right-click the Scan Class icon and then click Show

3. Click a scan class and then type values for the foreground and
background periods.

The period specifies, in seconds, how often the programmable


controller address is scanned when its value is required by a
component.

To specify a period, type a number. You can use fractional


seconds. For example, if you type .6 the address is scanned every
six tenths of a second.

Setting up direct driver communications for HMI tags ■ C--19


Preface
4. To save the settings for a scan class without closing the editor,
click another scan class.

5. When you are finished setting up scan classes, click OK.

Monitoring communications
Use any of the following methods to monitor communications:

In the Activity Log Setup editor, ensure communication errors,


warnings, and remarks are enabled and are set up to log to the
log file and activity bar. At run time, information appears in the
log file and activity bar, indicating any problems.

For HMI tags, use the system\com tags to receive a more detailed
error message. For a complete list of system\com tags, see
Appendix B, System tags.

C--20 ■ RSView Supervisory Edition User’s Guide


D
Appendix

Setting up DDE
communications for
HMI tags

Where to find information


To obtain values from HMI tags, you must set up communications.
To support legacy applications, RSView supports direct-driver and
DDE communications.

For details about setting up direct driver communications, see


Appendix C, Setting up direct driver communications for HMI tags.

For details about setting up DDE communications for HMI tags, see
the topics in this chapter.

About DDE communications


DDE connections allow you to communicate with a wide range of
local and remote devices.

DDE is Dynamic Data Exchange, used with external DDE servers


such as the Rockwell Software RSServert products, or other
third-party servers, to connect an HMI server to communication
devices.

If you will be connecting to communication devices using direct


drivers, see Appendix C, Setting up direct driver communications
for HMI tags.

Setting up DDE communications for HMI tags ■ D--1


Preface
DDE servers provide a way to connect an HMI server’s HMI tags (the
DDE client) to:

communication devices such as Siemens or Modicon

For details, see the topics in this chapter.

a third-party DDE server such as Microsoft Excel or Visual Basicr

D--2 ■ RSView Supervisory Edition User’s Guide


Overview of DDE communications
The following illustration shows the different ways an HMI server
can use DDE for communications.

RSView SE Server’s
HMI tags
Computer running RSView SE Server

RSView DDE client module

CF_Text or AdvanceDDEt CF_Text or


XLTable AdvanceDDE*

Third-party Third-party
RSServer
application, DDE server
such as
Microsoft
Excel

PLC network Network or


* The third-party server can communication
use AdvanceDDE format if link
the server uses the Rockwell
Software server toolkit.
Modicon, Other non--
GE, Siemens, Allen-- Bradley
or other device
programmable
controller

Setting up DDE communications for HMI tags ■ D--3


Preface
Summary of steps
The instructions below summarize the steps for setting up an HMI
server as a DDE client.

1. Start the DDE server.

2. Start RSView Studio, and then create or open an application


(the client).

3. Add an area, and then create an HMI server in the area.

4. In the Nodes editor, create nodes for each DDE server and/or
topic you want to communicate with. In the node’s Data Source
field, select DDE Server.

For details, see “Creating a DDE node,” below.

5. In the Tags editor, create tags and select Device as the data
source and assign the nodes that you have created.

For details, see Chapter 7, Working with tags.

Creating a DDE node


A DDE node allows you to assign a logical name for each DDE
application and topic you wish to communicate with. The DDE node
name can then be used throughout the HMI server.

To create a DDE node:

1. In the Application Explorer, open the HMI Tags folder.

2. Open the Nodes editor by doing one of the following:

double-click the Nodes icon

right-click the Nodes icon and then click Show

D--4 ■ RSView Supervisory Edition User’s Guide


3. Create a node by filling in the following information:

Data Source

Click DDE Server.

The Tags editor does not check addressing syntax for


programmable controllers that communicate through a DDE
server. If the syntax is invalid, an error will be generated at run
time.

For details about the OPC server data source, see “Creating an
OPC node” on page 6-4. For details about the Direct Driver data
source, see Appendix C, Setting up direct driver communications
for HMI tags.

Name

Type a name of your choice to represent the DDE node. The


name can be up to 40 characters long and can have upper and
lower case letters, numbers, dashes, and underscores. Spaces are
not permitted.

Enabled

Normally nodes are enabled, allowing collection of values from


the device. However, during setup or troubleshooting you might
want to disable a node to prevent communication timeouts or
invalid data. When a node is disabled, tag values can still be read
and written, but the values are read from and written to the
value table instead of the device.

When a tag uses a disabled node at run time, the tag’s state will
change from valid to disabled. A tag’s state can be seen by
viewing the tag in the tag monitor.

To disable nodes, clear the Enabled check box.

Setting up DDE communications for HMI tags ■ D--5


Preface
You can also enable and disable nodes at run time, using the
NodeEnable and NodeDisable commands. For more
information see Appendix A, RSView commands.

Application

Type the name of the DDE server or other Windows application


that the HMI server will communicate with. For example, if
Microsoft Excel is the server, type Excel.

Topic

Type the subject of the DDE communication. For example, if


Excel is the application, the topic is a particular Excel
spreadsheet.

4. Click Accept to save the node configuration.

5. When you are finished setting up nodes, click Close.

Example: Setting up a DDE node

The following example describes how to create a node to connect to


a GE programmable controller using the RSServer for GE Series 90
protocol.

Application

SNPWIN
The application name is the server’s name.

Topic

cpuid[@connection_ID][:poll_rate]
The topic name is made up of a CPU ID string, an optional
connection ID string (preceded by the @ character) and an optional
poll rate (preceded by the : character).

D--6 ■ RSView Supervisory Edition User’s Guide


The figure below shows how the node looks in the Nodes editor.
The CPU ID is CPU1, the connection ID is PORT5, and the poll rate
is 10.

The application and


topic appear in the
spreadsheet’s Station
or Server column,
separated by a
vertical bar.

Some columns do not apply to


DDE nodes, and are left blank.

Changing node information at run time


To change a DDE node’s application and topic at run time, use the
NodeSwitch command. This command allows you to set up
node-level redundancy. That is, if the server that a node is pointing
to fails, you can immediately switch to another server.

NodeSwitch <node name> <parameter>

<node name> The name of the node that you want to change to
another server.

<parameter> is <application|topic> For servers, the


DDE
application and topic, separated by the | character, for the DDE
server you want to switch to.

Setting up DDE communications for HMI tags ■ D--7


Preface
When you use the NodeSwitch command to change a node’s server
information, the change appears in the Nodes editor’s spreadsheet.
If the Nodes editor is open when you use the command, the change
will not appear until you close and re-open the editor.

For more information about the NodeSwitch command, see


Appendix A, RSView commands, or see Help.

You can also enable and disable nodes at run time, using the
NodeEnable and NodeDisable commands. For more information
see Appendix A, RSView commands.

Scanning for new tag values


When an HMI server containing tags is running, it must periodically
update its tag values in the value table.

For applications using DDE, values are updated by the server at the
rate specified in the server product. When the server detects a
change, it provides the changed value to RSView. For more details
about setting the poll rate, see your server documentation.

Scan class rates have no effect on DDE communications. They affect


only direct driver communications.

D--8 ■ RSView Supervisory Edition User’s Guide


Index

Symbols A
.bmp files, 15-- 290, 15-- 292 Abort command, 19-- 3, A-- 16
Access. See Microsoft Access
.cab files, 15-- 256
Acknowledge bit, 10-- 16, 10-- 37, 10-- 43
.clp files, 15-- 290
Acknowledge command, 10-- 13, A-- 17
.dat files AcknowledgeAll command, 10-- 13, A-- 18
activity log, 11-1, 11-8, 11-19 ActiveX events, 11-- 10, 16-- 49
data log, 12-1, 12-2 ActiveX methods, 16-- 47, 16-- 48, A-- 43
.dxf files, 15-- 290 ActiveX objects, 15-- 2, 15-- 31, 15-- 251
attaching control to, 16-2, 16-44
.gif files, 15-- 290
deploying automatically, 15-256
.jpg files, 15-- 290
editing, 16-45
.mgl files, 15-- 290 using with VBA, 15-254, 16-50
.obf files, 12-- 4 ActiveX properties, 16-- 45, A-- 43
.pcx files, 15-- 290 ActiveX Toolbox, 15-- 254
.tif files, 15-- 290 Activity bar, 2-- 6, 11-- 11
clearing messages on, 2-6
.wav files, 10-- 25, A-- 28, A-- 48
hiding, 2-8
.wmf files, 15-- 290
moving, 2-6
??? in input fields, 15-- 137, 15-- 143, 15-- 234
resizing, 2-6
[tag] parameter, using, 16-- 58 showing, 2-8
as placeholder, 16-8 Activity commands
for display keys, 16-67 ActivityLogNewFile, A-18
for object keys, 16-53 ActivityLogSendTo ODBC, A-19
to acknowledge alarms, A-17 Remark, 11-10, A-54
with the Identify command, A-43 Activity log files
and third-party applications, 11-1
= (Equal) command, A-- 14
creating, 11-4
and memory tags, 8-20
creating on demand, 11-6
deleting, 11-7
exporting to ODBC, 10-54, 11-14
Numbers logging destinations, 11-11
1784-KT/KTX, C-- 2 maximum number of files, 11-9

Index ■ I--1
naming, 11-8 Identify, 10-77, A-42
short file names, 11-4 setting up alarms with, 10-37, 10-42
storage format, ODBC, 20-1 Silence, A-58
Activity Log Setup editor, 11-- 2 SilenceAll, A-59
Activity Log Viewer, 11-- 19 SuppressOff, A-59
Help, 11-19 SuppressOffAll, A-60
Activity logging, 11-- 1 SuppressOn, 10-13, 10-84, A-60
access permissions for services, 11-13 Alarm deadband, 10-- 3, 10-- 6, 10-- 37
creating expressions, 18-2 Alarm events, 10-- 18
editing, 11-15 Alarm faults, 10-- 6
monitoring communications with, C-20 Alarm log files, 10-- 9, 10-- 44
adding remarks at run time, 10-30
specifying logged activities, 11-10
and third-party applications, 10-9
tracking users, 11-20
contents of, 10-10
ActivityLogNewFile command, A-- 18
creating, 10-47
ActivityLogSendToODBC command, A-- 19
creating on demand, 10-50
Addresses
deleting, 10-50
assigning, C-13
logging destinations, 10-46, 11-3
specifying for tags, 8-19
maximum number of, 10-58
Administration Console, shutdown after 2
hours, 22-- 17 naming, 10-57
Advanced objects, 15-- 51 storage format, ODBC, 20-2
Alarm banner, 10-- 8, 10-- 11 Alarm Log Viewer, 10-- 10, 10-- 58
alarm label in, 10-34, 10-39 Help, 10-59
Alarm bells, setting up, 10-- 24 Alarm logging, 10-- 44
See also Alarm monitoring
Alarm buffer zone. See Alarm deadband
access permissions, 10-56
Alarm commands
Acknowledge, 10-13, A-17 editing, 10-55
AcknowledgeAll, 10-13, A-18 Alarm message types, 10-- 9, 10-- 26
in alarm, 10-35, 10-40
AlarmEvent, A-19
out of alarm, 10-37, 10-43
AlarmLogNewFile, A-21
system default, 10-26
AlarmLogOff, A-22
user default, 10-28
AlarmLogOn, A-22
Alarm messages, 10-- 29
AlarmLogRemark, A-23
setting up, 10-26, 10-35, 10-41
AlarmLogSendTo ODBC, A-24 Alarm monitoring, 10-- 1, 10-- 44
AlarmOff, 10-11, 10-87, A-25 acknowledge bit, 10-16, 10-37, 10-43
AlarmOn, 10-17, 10-86, A-25 alarm events, 10-18
AlarmPrintOff, A-26 handshake bit, 10-17, 10-38, 10-43
AlarmPrintOn, A-26 handshaking, switching on, 10-17
Execute, 10-76 starting and stopping, 10-86, 22-6
HandshakeOff, A-41 starting, 10-86
HandshakeOn, 10-17, A-41 stopping, 10-87

I--2 ■ RSView Supervisory Edition User’s Guide


Alarm printing, suppressing, 10-- 82 setting up, 10-5
Alarm Setup editor, 10-- 21, 10-- 22 for analog tags, 10-32
Alarm severity, 10-- 8 for digital tags, 10-38
setting up, 10-23, 10-34, 10-40 using Tags editor, 10-2, 10-21, 10-31
suppressing, 10-13, 10-84
Alarm states, 10-- 8, 10-- 39
viewing suppressed alarms, 10-84
Alarm summary, 10-- 10
using tags for, 7-5
creating, 10-60
Allen-Bradley devices, C-- 1, C-- 3
displaying, 16-63
ALM_ (alarm) functions, 10-- 14, 10-- 15,
filtering data in, 10-70 18-- 14
setting up Analog tags, 8-- 1
alarm label, 10-34, 10-39 alarms for, 8-24, 10-2, 10-31
buttons, 10-65 alarms when crossing thresholds, 10-22
colors, 10-8, 10-64
and trends, 17-40, 17-43
fonts, 10-63
headings, 10-62 setting up, 8-13
showing areas, 10-82 Animation, 16-- 1
sorting data in, 10-75 copying objects, 16-73
using commands in, 10-79, 10-81 copying without copying objects, 16-74
using system tags in, 10-12 defining range of motion, 16-11
using wildcards in, 10-71 finding, 16-70
finding objects animated by tags, 16-72
Alarm Summary editor, 10-- 60
Alarm system tags, 10-- 12, B-- 1
for ActiveX objects, 16-44
for grouped objects, 15-276, 16-70
Alarm thresholds, 10-- 3, 10-- 5, 10-- 33
crossing, 10-22 searching for tags, 16-70
setting min. and max. values, 16-9
AlarmEvent command, A-- 19
testing, 16-7, 17-21
AlarmLogRemark command, 10-- 30, A-- 23
using with Execute button in alarm summary, using commands for actions, 16-8
10-81 using Current [Tag] parameter, 16-58
AlarmLogSendToODBC command, A-- 24 using display keys, 16-65
AlarmPrintOff command, 10-- 82, A-- 26 using object keys, 16-51, 16-54
AlarmPrintOn command, 10-- 82, A-- 26 using Object Smart Path, 16-6, 16-11
Alarms using tags and placeholders, 16-7
acknowledging, 10-13, 10-16 Animation dialog box, 16-- 4
adding to tags, 8-24, 10-2 Animation types, 16-- 1
ALM_ACK expression, changing default color, 10-11, 16-15
behavior, 10-15 fill, 16-22
assigning sounds to, 10-24 height, 16-30
charting in trends, 17-8, 17-10, 17-35 horizontal position, 16-24
creating expressions, 18-2 horizontal slider, 16-38
crossing thresholds, 10-22 OLE verb, 14-14, 16-42
expressions in, 10-14 rotation, 16-32
identifying, 10-37, 10-42, 10-77 touch, 16-36

Index ■ I--3
vertical position, 16-26
B
vertical slider, 16-40 Background scan period, C-- 18
visibility, 10-11, 16-14 Backspace key, 15-- 187
width, 16-28 Bar graphs, 15-- 177

Application commands Beep command, A-- 28

AppAbort, A-26 Bells for alarms, 10-- 24


Bitwise operators
AppStart, A-27
AND, &, 18-12
Application Explorer, 2-- 6, 2-- 9, 4-- 9 complement, ~, 18-13
displaying components in, 2-14 exclusive OR, ^, 18-12
editors, 2-11 inclusive OR, |, 18-12
folders, 2-10 left shift, <<, 18-13
importing images, 15-40 right shift, >>, 18-12
Blinking colors, 10-- 64, 16-- 16
Application files, deleting, 2-- 18
Built-in functions
Applications
file, 18-21
administering at run time, 22-17
math, 18-21
creating, 4-7 security, 18-22
deleting, 4-9 tag, 18-14
deploying, 22-2 time, 18-17
max. number of HMI servers, 4-11 Buttons, 15-- 66
opening, 2-3
stopping, 22-11 C
viewing number of graphic displays in, 22-8 CABARC.exe, 15-- 256
Windows, A-26, A-27 Cache
creating for data servers, 5-6
Arc graphic object, 15-- 46
synchronizing for data servers, 5-7
Area, showing in alarm summary, 10-- 82
Calling methods, 16-- 47
Areas, 4-- 3
Channel commands
adding, 4-12 DriverPrimary, A-39, C-11
application root, 4-4 DriverSecondary, A-39, C-11
home area, 4-4 DriverToggle, A-39, C-12
how to use, 4-10 Channel editor, C-- 6
removing, 4-13 Channels, C-- 1
setting up, C-6
Arithmetic operators, 18-- 8
setting up nodes, C-13
Arrow graphic object, 15-- 198
Circle graphic object, 15-- 44
Asynchronous execution Client key commands, Key, 19-- 22
and the = (Equal) command, A-14 Client keys, 19-- 6
and the Set command, A-56 creating, 19-19

I--4 ■ RSView Supervisory Edition User’s Guide


precedence among key types, 19-15 direct driver, setting up, C-1
running a key file, 19-22 errors, 18-14, C-12
Client Keys editor, 19-- 20 monitoring, B-2, C-20
Client-- side commands, A-- 5 OPC, setting up, 6-2

Clients setting up, without hardware or software, C-4


opening multiple, 22-15 timeouts, preventing, 6-6, C-15, D-5
setting up, 22-12 Communications commands
Code window, getting help, 21-- 11 DriverPrimary, A-39, C-11
Color DriverSecondary, A-39, C-11
in alarm summaries, 10-64 DriverToggle, A-39, C-12
in graphic displays, 15-7, 15-23, 15-285 NodeDisable, 6-12, A-47, C-17, D-8
animating, 10-11, 16-15 NodeEnable, 6-12, A-47, C-17, D-8
in trends, 17-18 NodeSwitch, 6-11, A-47, C-17, D-8
COMM_ERR function, 18-- 14, C-- 12 Component names
Command buttons and /P parameter, 2-19
editing, 15-72 and spaces, 2-19
highlight, enabling or disabling, 15-67 long, 2-19
Command execution, A-- 5 maximum length of, 2-19
Command line, using, A-- 9 Components
Command Wizard, 2-- 21, A-- 10 copying, 2-15
Commands, A-- 1 deleting, 2-18
See also individual command entries displaying, 2-14
absolute and relative references, A-7 opening, 2-15
assigning security to, 14-11 removing, 2-18
attaching to ActiveX events, 16-49 renaming, 2-17
client side, A-5 Constants, in expressions, 18-- 8
Context menus. See Shortcut menus
in buttons, 15-69
Control. See Animation
in editors, 2-21
Control list selectors, 15-- 200
in events, 13-1
ControlLogix processor, 7-- 3
in macros, 2-21
ControlNet, C-- 7
logging execution of, 11-10 Crystal Reports. See Seagate Crystal
placeholders in, 19-8, A-3 Reports
precedence over macros, A-4 Current [Tag] parameter, 16-- 58, 16-- 67
server side, A-5
startup and shutdown, 15-25 D
using in graphic displays, 16-8 Data log files
using with alarms, 10-76 and third-party software, 12-1
Communications creating, 12-22
DDE, setting up, D-1 deleting, 12-27
devices, C-1, C-2 maximum at run time, 12-1

Index ■ I--5
naming, 12-3 removing, 5-7
storage format, 12-2 synchronizing cache, 5-7
ODBC, 12-1, 12-4, 20-4 using in trends, 17-24
Data log models, 12-- 1, 12-- 7 Data source for tags, 8-- 2, 8-- 18
using in trends, 17-36 Data types for tags, 8-- 15
Data Log Setup editor, 12-- 5, 12-- 6 Date and time
Data logging in graphic displays, 15-237
access permissions, 12-18 in trends, 17-24, 17-29, 17-45
access permissions for services, 12-18 DDE, D-- 3
and events, 12-33, 13-1 and Microsoft Excel, D-6
changing rate at run time, 12-38, A-28 and RSServer, D-1
choosing the data to log, 12-35 poll rate, D-8
RSView as client
creating expressions, 18-2
assigning server to RSView tags, 8-19
on demand, 12-32, 12-34, A-31 requesting values from server, 8-25
paths, 12-13 setting up, D-4
backup, 12-12 DDE commands
moving data between, 12-21, A-28 NodeDisable, A-47, D-8
switching at run time, 12-20, 12-36, A-32
NodeEnable, A-47, D-8
setting up, 12-1, 12-30, A-31
NodeSwitch, A-47, D-8
setting up database tables manually, 12-10
DDE communications, and third-- party
starting and stopping, 12-39, 22-6, A-29, A-30 servers, D-- 2
using a new ODBC data source, 12-8 DDE nodes
using an existing ODBC data source, 12-5, 12-8 assigning to tags, 8-19
Data logging commands changing at run time, A-47, D-7
DataLogChangeRate, A-28 creating, D-4
DataLogMergeToPrimary, 12-21, A-28 enabling and disabling, D-5
DataLogNewFile, 12-26, A-29 Deadband for alarms, 10-- 3, 10-- 6, 10-- 37
DataLogOff, 12-40, A-30 Define command, 19-- 12, A-- 33
Derived tag commands
DataLogOn, 12-39, A-30
DerivedOff, A-34
DataLogRenameFile, A-31
DerivedOn, 9-7, A-34
DataLogSnapshot, 12-33, 13-1, A-31
Derived tags
DataLogSwitchBack, 12-20, A-32
creating, 9-5
Data server tags, 7-- 1 creating expressions for, 18-2
browsing for, 7-8 editing, 9-7
how to use, 7-4 evaluation interval for, 9-4
when to use, 7-4 maximum files at run time, 9-2
Data servers, 4-- 3, 5-- 1 maximum in a file, 9-2
adding, 5-3 starting and stopping processing, 9-7, 22-7
creating cache, 5-6 Derived Tags editor, 9-- 2
how to use, 5-2 Device nodes, C-- 3
properties, 22-12 assigning to tags, 8-18

I--6 ■ RSView Supervisory Edition User’s Guide


changing at run time, A-47, C-17 Driver commands
creating, C-13 DriverPrimary, A-39, C-11
enabling and disabling, C-15 DriverSecondary, A-39, C-11
DH, C-- 7
DriverToggle, A-39, C-12
DH+, C-- 7
DH-485, C-- 7 E
Digital tags, 8-- 1 Editors, 2-- 11
alarms for, 8-24, 10-8, 10-38 Activity Log Setup, 11-2
and trends, 17-40, 17-43 Alarm Log Viewer, 10-10
setting up, 8-16 Alarm Setup, 10-21, 10-22
Direct drivers, C-- 1 Alarm Summary, 10-60
backup, C-10 Channel, C-6
None Loaded type, C-10 Client Keys, 19-20
primary, C-10 Data Log Setup, 12-5, 12-6
secondary, C-10 Derived Tags, 9-2
selecting, C-6 Displays, 15-2
setting up, C-3 Events, 13-2
setting up RSLinx, C-5 Graphic Libraries, 15-295
setting up tags for, 8-18 hints for working in, 2-20
switching at run time, C-11 Library, 15-295
Disk space, monitoring, 10-- 50, 22-- 19 Macro, 19-8
Display cache, 15-- 17, 19-- 4 Node, 6-4, C-13, D-4
Display command, 19-- 3, A-- 34 Parameters, 15-54
and graphic displays, 15-21, 15-23, 15-30 Recipe, 15-231
and key lists, 16-70 Scan Class, C-19
and parameter files, 15-54, 15-56 Security Codes, 14-9
and trends, 17-66 Startup, 22-6
Display keys, 19-- 6
Suppressed List, 10-13, 10-84
creating, 16-65 Tags, 8-4, 10-21, 10-31
editing, 16-67 User Accounts, 14-5
precedence among key types, 19-15 Ellipse graphic object, 15-- 44
End key, 15-- 187
Display list selectors, 15-- 216
Enter key, 15-- 187
Display Settings dialog box, 15-- 11
Event, ActiveX, 16-- 49
Display types, 19-- 3
Event commands
Displays. See Graphic displays
EventOff, 13-8, A-39
Displays editor. See Graphic Displays
editor EventOn, 13-7, A-40
Download command, 15-- 144, 15-- 235, A-- 38 Event-based alarms, 10-- 18
DownloadAll command, 15-- 144, 15-- 235, Events
A-- 38 creating, 13-1, 13-5, C-12
Drawing objects. See Graphic object types creating expressions for, 13-6, 18-2

Index ■ I--7
editing, 13-6 Failure of primary network at run time,
C-- 11
evaluation interval for, 13-4
File locations, graphic libraries, 15-- 294
for on demand logging, 12-33
File names
maximum files at run time, 13-1
See also Component names
maximum in a file, 13-1
length of, 4-7
starting and stopping processing, 13-7, 22-7
long, for data logs, 12-3, 12-4
Events editor, 13-- 2
short, 11-4
Execute button, in alarm summaries, for activity logs, 11-9
10-- 76, 10-- 79
for alarm logs, 10-58
Execute command, 10-- 76
File types
Exporting, activity log, to ODBC, 10-- 54, graphics
11-- 14
importing, 15-290
Expressions, 2-- 22, 18-- 1
using bitmaps, 15-292
alarm events in, 10-20
log
and animation, 16-9 .dat
assigning to graphic objects, using the Property activity, 11-1, 11-8, 11-19
Panel, 15-262
data, 12-1, 12-2
built-in functions in, 18-14 .dat, alarm, 10-57
constants in, 18-8 .obf, 12-4
copying, 18-4 ODBC, activity, 10-54, 11-14

creating, 18-2 sound, .wav, 10-25, A-28, A-48


formatting, 18-5 Fill animation, 16-- 22
if-then-else logic in, 18-25 Filter

in alarms, 10-14 for tags, 7-18


in data logging, 12-33 removing from tags, 7-18
in derived tags, 9-6 FlushCache command, 15-- 30, A-- 40
and trends, 17-66
in events, 13-6
executing shutdown command with, 15-25
in the = (Equal) command, A-14
Folders, 8-- 3
in trends, 17-36
adding tags to, 8-8
operators in, 18-8
evaluation order of, 18-23 adding to Tag Browser, 7-13
tags and placeholders in, 8-3, 16-4, 18-6 creating, 8-6
using to report communication errors, 18-14 refreshing list in Tag Browser, 7-14
using to retrieve alarm information, 10-14 Fonts
guidelines for choosing, 15-32
in alarm summary, 10-63
F in graphic displays, 15-32
F1 key, precedence, 19-- 16 resized to fit object, 15-275
FactoryTalk directory in trends, 17-18, 17-30
changing, 22-5 substituted at run time, 15-35
setting , 22-4 Foreground scan period, C-- 18

I--8 ■ RSView Supervisory Edition User’s Guide


Freehand graphic object, 15-- 46 creating a template for, 15-12
Functions. See Built-in functions displaying alarm information in, 10-11
displaying in background, A-34
downloading values from, 15-136, 15-143
G moving among, 19-1, 19-3, A-51
Gauges, 15-- 168, 15-- 172
positioning, 15-23, A-36
GE programmable controller, D-- 6
preventing scroll bars in, 15-20
Global key commands, Key, A-- 45
printing, 2-22, 15-296, A-50
Graphic display commands
reducing call-up time of, 15-17, 15-30, A-35
Abort, 19-3, A-16
replacing text in, 15-256
Display, 19-3, A-34
running multiple copies of, 15-16
and key lists, 16-70
and parameter files, 15-54, 15-56 securing, 14-13, 15-23
caching, 15-30, 17-66 setting up, 17-21
positioning, 15-23 sizing, 15-19, 15-21, A-36
sizing, 15-21 specifying run-time appearance, 15-18
Download, 15-144, 15-235, A-38 startup and shutdown commands for, 15-25
DownloadAll, 15-144, 15-235, A-38 testing, 15-4
FlushCache, 15-30, A-40 animation, 16-7, 17-21
and trends, 17-66 types, 15-15
executing shutdown command with, 15-25
uploading recipes to, 15-230, 15-234
NextPosition, 16-54, A-46
uploading values to, 15-136, 15-143
NextWindow, A-46
using parameter files in, A-35
Position, 16-54, A-48
viewing number of in application, 22-8
PrevPosition, 16-54, A-49
Graphic Displays editor, 15-- 2
PrevWindow, A-49
Graphic libraries. See Libraries
PrintDisplay, 15-296, A-50 Graphic Libraries editor, 15-- 295
PullForward, 19-3, A-51 Graphic object types, 15-- 31
PushBack, 19-3, A-51 ActiveX, 15-251, 16-44
RecipeRestore, 15-235, A-53 advanced objects, 15-31, 15-51, 15-197
RecipeSave, 15-236, A-54 alarm summary, 10-11, 10-60
ScreenPrint, 15-296, A-54 arcs, 15-46
SendKeys, A-55 arrows, 15-198
SetFocus, 15-16, A-58 bar graphs, 15-177
Upload, 15-144, 15-236, A-62 circles, 15-44
UploadAll, 15-144, 15-236, A-62 control list selectors, 15-200
Graphic displays display list selectors, 15-216
background color of, 15-23 drawing objects, 15-32
caching, 15-17, 19-4 ellipses, 15-44
with the Display command, 15-30, A-34 freehand, 15-46
creating, 15-1 gauges, 15-168, 15-172
creating a background for, 15-289 graphs, 15-168, 15-177

Index ■ I--9
image, 15-35 copying from other Windows applications,
indicators, 15-146 15-1
list, 15-162 creating expressions, 18-2
multistate, 15-148 cutting and pasting, 15-271
symbol, 15-156 deselecting, 15-7, 15-266
key, 15-187 duplicating, 15-273
labels, 15-214 editing, 15-266, 15-277
lines, 15-45 flipping, 15-284
local message displays, 15-225 formatting, 15-285
numeric and string, 15-132 grouping and ungrouping, 15-276
numeric display fields, 10-11, 15-133 importing, 15-290
numeric input fields, 15-136 methods, 16-47
OLE objects, 14-14, 15-247 moving, 15-270
panel, 15-41 naming, 15-264, 16-44
polygons, 15-45 positioning, 15-278
polylines, 15-45 with grid, 15-8
push buttons, 15-58 replacing text in, 15-256
buttons, 15-66 reshaping, 15-50, 15-73
interlocked, 15-114 resizing, 15-274
latched, 15-93 rotating, 15-8
maintained, 15-83
selecting, 15-266
momentary, 15-73
multistate, 15-103, 15-205 setting up, using the Property Panel, 15-259
ramp, 15-123 using keys to work with. See Special keys
recipe fields, 15-230 using tags and placeholders, 15-52
rectangles, 15-44 using with object keys, 16-51
scales, 15-181 Graphs, 15-- 168
squares, 15-44 Grid
string display fields, 10-11, 15-134 in graphic displays, 15-8
string input fields, 15-136 in trends, 17-18, 17-47, 17-51, 17-52
text, 15-32 Grouped objects, setting up in the Property
Panel, 15-- 261
time and date displays, 15-237
trends, 17-21, 17-22
wedges, 15-46 H
Graphic objects Handshake bit, 10-- 17, 10-- 38, 10-- 43
aligning, 15-279 HandshakeOff command, A-- 41
animating. See Animation HandshakeOn command, 10-- 17, A-- 41
arranging, 15-275, 15-283 Handshaking, switching on, 10-- 17
assigning tags, using the Property Panel, Height animation, 16-- 30
15-262 Help
converting, 15-291 Code window, 21-11
to wallpaper, 15-289 for the activity log viewer, 11-19

I--10 ■ RSView Supervisory Edition User’s Guide


for the alarm log viewer, 10-59 pasting into graphic displays, 15-36
using VBA online help, 21-12 placing in graphic displays, 15-37
VBA Object Browser, 21-10 settings, 15-39
Help command, A-- 42 Index numbers, 16-- 54

Help files, creating for displays, 16-- 61


and buttons, 15-67
Highlight, enabling or disabling, 15-- 27
and control list selectors, 15-209
for buttons, 15-67 and display list selectors, 15-221
HMI servers
and numeric input objects, 15-138
adding, 4-13 and recipe files, 15-231
copying, 4-13 and string input objects, 15-140
deleting, 4-14 using for tab sequences, 16-54
how to use, 4-11 Indicators, 15-- 146
list, 15-162
load on demand, 22-16
multistate, 15-148
max. number in application, 4-11
symbol, 15-156
moving files, 22-7
Input field commands
removing, 4-14
Display, /U parameter, A-35
setting properties, 22-8
Download, 15-144, 15-235, A-38
startup components, 22-5
DownloadAll, 15-144, 15-235, A-38
HMI tags, 7-- 1, 8-- 1
NextPosition, 16-54, A-46
browsing for, 7-8
Position, 16-54, A-48
when to use, 7-5
PrevPosition, 16-54, A-49
Home area, 4-- 4
SendKeys, A-55
finding tags in, 7-14
Upload, 15-144, 15-236, A-62
Home key, 15-- 187
UploadAll, 15-144, 15-236, A-62
Horizontal position animation, 16-- 24
Input fields
Horizontal slider animation, 16-- 38
creating
numeric, 15-136
I recipe, 15-230
string, 15-136
IDE, 21-- 2
downloading values from, 15-136, 15-143
using, 21-3
highlight, enabling or disabling, 15-27
Identify command, 10-- 77, A-- 42
question marks in, 15-137, 15-143, 15-234
setting up alarms with, 10-37, 10-42
specifying behavior for, 15-27
If-then-else expressions, 18-- 25
specifying color for, 15-26
nesting, 18-27
updating tag values in, A-35
Image Browser, importing images, 15-- 40
uploading values to, 15-136, 15-143
Image graphic object, 15-- 35
using at run time, 15-142, 15-234
Images
using keys with
adding to Application Explorer, 15-40
Shift-Tab, A-49
adding to Image Browser, 15-40 special keys, 15-142
importing, 15-40 Tab, A-46

Index ■ I--11
Input focus, specifying behavior, 15-- 27 Logging in
Integrated Development Environment. and security, 14-17
See IDE at run time, 14-17
Interactive objects Logging out
creating, 15-51 and security, 14-18
specifying behavior, 15-26 at run time, 14-18
Interlocked push buttons, 15-- 114 Logging paths. See Data logging, paths
Invoke command, 16-- 48, A-- 43 Logical operators, 18-- 11
Login

K command, 14-11, 14-17, A-45


macro, 14-9
Key command, 19-- 22, A-- 45
Logout
Key definitions, 19-- 14
command, 14-11, 14-18, A-46
precedence, 19-15
macro, 14-9
using to open displays, 19-5
Key list, 16-- 69
disabling, 16-70 M
Keyboard, on-screen, 15-- 28, 15-- 144, A-- 35 Macro editor, 19-- 8
Keypad for numeric input, 15-- 29 Macros, 19-- 7
Keys, 15-- 187 attaching to ActiveX events, 16-49
See also Special keys creating, 2-21, 19-7
reserved, 19-17 login and logout, 14-9
understanding, 15-185 startup and shutdown, 15-25, 19-12, 22-7
using the Command Wizard, A-10
nesting, 19-11
L precedence of, 19-7, A-4
Label graphic object, 15-- 214 securing, 14-11
Latched push buttons, 15-- 93 using commands in, 19-8
Libraries, 15-- 1, 15-- 294 using in events, 13-1
locating, 15-294 using in graphics, 16-8
using for alarm displays, 10-11 using in trends, 17-66
using for trends, 17-22, 17-65 using parameters in, 19-10
Libraries editor, 15-- 295 using to identify alarms, 10-77
Limits, number of HMI servers, 4-- 11 Maintained push buttons, 15-- 83
Line graphic object, 15-- 45 Memory tags, 8-- 2, 8-- 20
List indicators, 15-- 162 Messages
Load balancing, across HMI servers, 4-- 11 See also Alarm messages
Local message displays, 15-- 225 clearing in activity bar, 11-19
Log files number of, on a channel, C-9
See also Activity log files; Alarm log files; Data Method, ActiveX, A-- 43
log files Methods, 16-- 47
ODBC schemas, 20-1 calling, 16-47

I--12 ■ RSView Supervisory Edition User’s Guide


Microsoft Access, 10-- 9, 12-- 4 Numeric input graphic object, 15-- 136,
15-- 143
Microsoft Excel
and on-screen keyboard, 15-28, 15-144
and activity logging, 11-1
and alarm logging, 10-9
and data logging, 12-1 O
and DDE, D-6 Object Browser, VBA, 21-- 8
using to create tags, 8-21 getting help, 21-10
Microsoft SQL Server, 12-- 4 Object Explorer, 15-- 268
Microsoft Visual Basic, 10-- 9 opening, 15-268
and DDE communications, D-2 using to select objects, 15-269
Modicon devices, 6-- 2, D-- 2 viewing objects in, 15-268
Module called ThisDisplay, 21-- 4 Object keys, 19-- 6

Momentary push buttons, 15-- 73


creating, 16-51
momentary off button, 15-69 editing, 16-67
momentary on button, 15-68, 15-69, 15-73 key list, 16-52, 16-67, 16-69
precedence among key types, 19-15
Move Down key, 15-- 187
Object model, RSView SE Client, 21-- 1
Move Left key, 15-- 187
Object properties, editing, 15-- 258
Move Right key, 15-- 187
Object Smart Path, 16-- 6, 16-- 11
Move Up key, 15-- 187
Objects, viewing, 21-- 8
Multistate indicators, 15-- 148
Objects that use data, 15-- 51
Multistate push buttons, 15-- 103, 15-- 205
ODBC data logging. See Data logging
ODBC storage format, 12-- 1, 12-- 4
N activity log files, 20-1
alarm log files, 20-2
Networks
See also DDE; OPC contents of tables, 20-4
choosing, C-7 OLE objects, 15-- 31, 15-- 247
attaching verb animation to, 16-42
failure at run time, C-11
securing, 14-14
NextPosition command, 16-- 54, A-- 46
On-screen keyboard, 15-- 28, 15-- 144, A-- 35
NextWindow command, A-- 46
OPC, 6-- 3
Node commands
and RSLinx, 6-2, 6-9
NodeDisable, 6-12, A-47, C-17, D-8
RSView as client
NodeEnable, 6-12, A-47, C-17, D-8
assigning server to RSView tags, 8-19
NodeSwitch, 6-11, A-47, C-17, D-8 requesting values from server, 8-25
Node editor, 6-- 4, C-- 13, D-- 4 setting up, 6-4
Nodes. See DDE nodes; Device nodes; OPC update rate, 6-12
nodes OPC commands
Non-Allen-Bradley devices, 6-- 2, D-- 2 NodeDisable, 6-12, A-47
Number format, 22-- 16 NodeEnable, 6-12, A-47
Numeric display graphic object, 15-- 133 NodeSwitch, 6-11, A-47

Index ■ I--13
OPC nodes Primary drivers, C-- 9
assigning to tags, 8-19 PrintDisplay command, 15-- 296, A-- 50
changing at run time, 6-11, A-47 Printers, selecting, 2-- 23
creating, 6-4 Procedure window. See VBA Procedure
window
enabling and disabling, 6-6
Procedures, defined, 21-- 6
OPC-- DA data items. See Tags Project Explorer. See VBA Project Explorer
Overview of RSView, 1-- 6 Project file path, viewing, 22-- 8
Properties, ActiveX, 16-- 45, A-- 43
Properties window. See VBA Properties
P window
Page Down key, 15-- 187 Property Panel, 15-- 258
Page Up key, 15-- 187 assigning tags to graphic objects, 15-262
Panel graphic object, 15-- 41 opening, 15-258
Parameter files, 15-- 54, A-- 35 setting up grouped objects, 15-261
running, 15-55 setting up multiple objects, 15-261
Parameters editor, 15-- 54 using to set up graphic objects, 15-259
Passwords, 14-- 18 using with ActiveX objects, 16-45
Pattern styles, 15-- 286 PullForward command, 19-- 3, A-- 51
how they work, 15-287 Push buttons, 15-- 58
invisible, 15-287 buttons, 15-66
interlocked, 15-114
Pause command, A-- 48
latched, 15-93
Placeholders, 10-- 27
maintained, 15-83
See also Tag placeholders
momentary, 15-73
in commands, 19-8, A-3
multistate, 15-103, 15-205
PlayWave command, A-- 48
ramp, 15-123
PLC, C-- 3
PushBack command, 19-- 3, A-- 51
address scanning, C-17
setting up communication with, C-1
type, selecting for device node, C-16
Q
Question marks
Poll rate for DDE nodes, D-- 8
in input fields, 15-137, 15-143, 15-234
Polygon graphic object, 15-- 45
in trends, 17-43
Polyline graphic object, 15-- 45
Quick Start, 1-- 6
Position command, 16-- 54, A-- 48
Precedence
among client, object, and display keys, 19-15
R
Ramp command, A-- 52
and the F1 key, 19-16
Ramp push buttons, 15-- 123
embedded ActiveX objects, 19-16
Read tag, 15-- 262
embedded OLE objects, 19-17 Read-- write tag, 15-- 262
reserved keys, 19-17 Recipe commands
PrevPosition command, 16-- 54, A-- 49 Download, 15-144, 15-235, A-38
PrevWindow command, A-- 49 DownloadAll, 15-144, 15-235, A-38

I--14 ■ RSView Supervisory Edition User’s Guide


RecipeRestore, 15-235, A-53 changing passwords, 14-18
RecipeSave, 15-236, A-54 failure of primary network, C-11
Upload, 15-144, 15-236, A-62 font substitution, 15-35
UploadAll, 15-144, 15-236, A-62 logging in, 14-17
Recipe editor, 15-- 231 logging out, 14-18
Recipes, 15-- 230 setting up clients, 22-12
and on-screen keyboard, 15-28, 15-144 switching drivers, C-11
using at run time, 15-232, 15-234 time, date, and number formats, 22-16
using recipes, 15-232, 15-234
using index numbers, 16-54
using trends, 17-62
using index numbers for, 15-231
Rectangle graphic object, 15-- 44
Relational operators, 18-- 10 S
Remark command, 11-- 10, A-- 54 Scales, 15-- 181
Remarks, adding to alarm log file, 10-- 30 Scan Class editor, C-- 19
Scan rate
Reserved keys, 19-- 17
assigning to tags, 8-19
precedence, 19-19
for DDE nodes, D-8
Root area, 4-- 4
for device nodes, C-17
Rotation animation, 16-- 32
for OPC nodes (update rate), 6-12
Rounded rectangle graphic object, 15-- 43
ScreenPrint command, 15-- 296, A-- 54
RSLinx, C-- 4, C-- 5
Scroll bars, preventing on graphic displays,
and OPC, 6-2, 6-9 15-- 20
RSLogix 5000, 7-- 3 Seagate Crystal Reports, 11-- 1, 12-- 1
RSServer, D-- 1, D-- 6 Secondary drivers, C-- 9
RSView, exploring, 2-- 5 Security, 14-- 1, 14-- 9
RSView Administration Console, 22-- 17 See also Passwords
See also Administration Console access permissions
RSView commands, A-- 1
activity logging, 11-13
alarm logging, 10-56
See also Commands; individual command
data logging, 12-18
entries
changing passwords, 14-18
RSView SE Client
disabling access to key combinations, 14-17
opening, 22-14
graphic displays, 15-23
setting up, 22-12
locking users into RSView, 14-17
starting when Windows starts, 22-15 logging in, 14-17
RSView SE Client object model, 21-- 1 logging out, 14-18
about, 21-6 securing applications, 14-16
RSView tools, DeskLock, 14-- 17 Unspecified_Command, 14-10
RSView VBA code, quick start, 21-- 5 using DeskLock, 14-17
Run time Windows user list, 14-1, 14-4
changing logging paths, 12-20, 12-36 Security codes, 14-- 10
changing logging rate, 12-38, A-28 assigning to commands, 14-11
changing nodes, 6-11, C-17, D-7 assigning to graphic displays, 14-13, 15-23

Index ■ I--15
assigning to macros, 14-11 Ctrl-PgDn, 15-143, A-38
assigning to OLE objects, 14-14 Ctrl-PgUp, 15-143, A-62
assigning to tags, 8-13, 8-17 Ctrl-R, 15-234
assigning to user accounts, 14-4 Ctrl-Shift-F6, A-49
default, 14-10 Ctrl-Shift-Tab, A-49
Security Codes editor, 14-- 9 Ctrl-Tab, 18-5, A-46
Selection button, 2-- 20 Ctrl-W, 15-234
SendKeys command, A-- 55 Enter, 15-143, 15-236, A-38
Server components, starting and stopping, disabling, A-35
22-- 16 using with on-screen keyboard, 15-145
Server names, showing in Tag Browser, Minus (–), using with graphic objects, 15-270
7-- 12
PgDn, 15-143, 15-236
Server-- side commands, A-- 5
PgUp, 15-143, 15-236
Servers, data, 4-- 3, 5-- 1
Plus (+), using with graphic objects, 15-270
Services
reserved keys, 19-21
activity logging, setting access permissions,
11-13 Shift-Tab, 16-57, A-49
data logging, setting access permissions, 12-18 Shift, using with graphic objects, 15-50, 15-270,
15-275
Set command, 8-- 20, 13-- 1, A-- 56
Tab, 15-143, 16-57, A-46
SetFocus command, 15-- 16, A-- 58
Square graphic object, 15-- 44
Short file names
Startup
for activity logs, 11-9
command in graphic displays, 15-25
for alarm logs, 10-58
components, 22-5
Shortcut menus, 2-- 20
macro, 19-12
using in graphics, 15-3
using in trends, 17-66
using in trends, 17-63, 17-68
settings, 22-6
Shutdown components, run when last
client closes, 22-- 16 Startup editor, 22-- 6

Siemens devices, 6-- 2, D-- 2 States, in alarms, 10-- 39

Silence command, A-- 58 Station address, entering, C-- 15

SilenceAll command, A-- 59 Status bar, 2-- 8, 15-- 3

SoftLogix 5, C-- 3, C-- 9, C-- 16


hiding, 2-8
Special keys
showing, 2-8
arrows String display graphic object, 15-- 134
using in trends, 17-70 String input graphic object, 15-- 136, 15-- 143
using with graphic objects, 15-275 and on-screen keyboard, 15-28, 15-144
Ctrl String tags, 8-- 1
copying objects with, 15-271 setting up, 8-17
drawing objects with, 15-44, 15-45, 15-46
Suppressed List editor, 10-- 13, 10-- 85
resizing objects with, 15-274
rotating objects with, 15-9 SuppressOff command, A-- 59
selecting objects with, 15-267 SuppressOffAll command, A-- 60
Ctrl-F6, A-46 SuppressOn command, 10-- 13, 10-- 84, A-- 60

I--16 ■ RSView Supervisory Edition User’s Guide


Symbol commands Tag folders, 8-- 6
Define, 19-12, A-33 Tag Import & Export Wizard, 8-- 21, 8-- 24
Undefine, 19-14, A-61 Tag placeholders, 15-- 51, 15-- 52, 16-- 7
Symbol indicators, 15-- 156 creating, 15-53
Symbols, 19-- 7, 19-- 12 parameter for Display command, A-36
Synchronizing data server cache, 5-- 7 replacing by listing tag names, 15-56
System tags, 8-- 1, B-- 1 replacing using a parameter file, 15-54
for alarms, 10-12, B-1 using in alarm summaries, 15-53
for communications, B-2, C-20 using in commands, A-37
System time and date, B-- 4 using in expressions, 18-6
using the [tag] parameter, 16-58
using with tag folders, 15-53
T Tag substitution, 15-- 256
Tab index, 16-- 54 Tag values
Tab key, creating a tab sequence, 16-- 57 changing, 8-20
Tab sequence displaying in a label object, 15-214
and buttons, 15-67 downloading, 15-136, 15-143
and control list selectors, 15-209 logging, 7-21, 12-35
and display list selectors, 15-221 updating, 6-12, 15-143, C-17, D-8
creating, 16-54, 16-57 uploading, 15-136, 15-143
Tag Browser Tags, 7-- 1
adding folders, 7-13 See also [tag] parameter; Analog tags; Data
displaying tag properties, 7-17 server tags; Derived tags; Digital tags;
HMI tags; String tags; System tags
displaying tags, 7-14
adding alarms to, 8-24, 10-2
filtering items, 7-18
addresses, 8-19
finding home area, 7-14
and events, 13-1
folders, 7-12
assigning to graphic objects, 15-51, 15-52
hiding tag descriptions, 7-15 using the Property Panel, 15-262
refreshing list of folders and tags, 7-14 basic steps for using, 7-3
removing filter, 7-18 browsing for, 7-8
selecting tags, 7-15 creating, 8-5, 8-20
showing server names, 7-12 data server. See Data server tags
showing tag descriptions, 7-15 data sources, 8-2, 8-18
using, 7-11 data types, 8-15
using wildcards, 7-18 displaying, 7-14
Tag commands displaying properties, 7-17
= (Equal), A-14 editing, 8-12
using for memory tags, 8-20 filtering, 7-18
Ramp, A-52 finding in objects, 16-72
Set, 8-20, 13-1, A-56 hiding descriptions, 7-15
Toggle, A-61 importing, 8-21, 8-24

Index ■ I--17
limits charts in, 17-3, 17-15, 17-16, 17-25
in alarm, 7-2 comparing data using, 17-10, 17-53
in graphic displays, 7-2 connecting data points in, 17-29
logging reads and writes, 11-11 data buffer in, 17-10, 17-34
refreshing list in Tag Browser, 7-14 data source, 17-9
removing a filter, 7-18 determining chart scale in, 17-4, 17-42, 17-47,
securing, 14-15 17-48
selecting, 7-15 displaying milliseconds in, 17-29
showing descriptions, 7-15 displaying tag values in, 17-9
using for alarms, 7-5 editing, at run time, 17-67
using in editors, 2-20 isolated graphing in, 17-17, 17-51
using in expressions, 2-22, 8-3, 16-5, 18-6 legends
with built-in functions, 18-14 current value legend, 17-5, 17-30
using in trends, 17-8, 17-9, 17-35 line legend, 17-5, 17-31
x-axis legend, 17-4
using with object keys, 16-53, 16-67
y-axis legend, 17-4
using with placeholders in commands, 19-8, overlays in, 17-10
A-3
at runtime, 17-71
Tags editor, 8-- 4, 10-- 21, 10-- 31 parts of, 17-3–17-72
TCP/IP, C-- 10 pens, 17-5
channel network type, C-7 adding, 17-35, 17-36
Test Display mode, 16-- 7 deleting, 17-38
Text graphic object, 15-- 32 editing, 17-38
ThisDisplay module, 21-- 4 editing multiple, 17-44
icons, 17-6, 17-31
Thresholds for alarms, 10-- 3, 10-- 5, 10-- 33
line number, 17-38
Time and date, 22-- 16, B-- 4 line style of, 17-41
in trends, 17-24, 17-29, 17-45, 17-47 line type of, 17-40
Time and date displays, 15-- 237 line width of, 17-39
Toggle command, A-- 61 markers, 17-7, 17-41
masking, 17-39
Toolbar, 2-- 5
selecting at run time, 17-67
hiding, 2-8
plotting a horizontal line in, 17-8
showing, 2-8
plotting an XY chart in, 17-16
Toolbars, 15-- 2, 15-- 5
plotting historical data in, 17-9
Toolbox, ActiveX, 15-- 254
plotting real-time data in, 17-9
ToolTips
printing, 17-71
adding to ActiveX toolbox, 15-255
running in the background, 17-66
adding to graphic objects, 15-264
scrolling in, 17-34, 17-68
Touch animation, 16-- 36
creating, 17-22
Trends, 17-- 1
setting up, 17-23
adding pens from a data log model, 17-36, appearance, 17-6
17-39
legend, 17-5
chart radix in, 17-29 multiple pens, 17-17
chart title in, 17-24 pens, 17-35

I--18 ■ RSView Supervisory Edition User’s Guide


selecting a data server, 17-24 User accounts, 14-- 4
shading, 17-10, 17-42, 17-43 login and logout macros for, 14-9
templates, 17-58 maintaining in Windows, 14-1, 14-4
using the graphic library, 17-65 tracking system usage by, 11-19
x-axis, 17-45
User Accounts editor, 14-- 4
y-axis, 17-48
shading in, 17-10
snapshots in, 17-10 V
adding as an overlay, 17-55 Value table, 7-- 6, 8-- 2
creating, 17-54 updating, 6-12, C-17, D-8
deleting, 17-55 VBA, 21-- 1
removing as an overlay, 17-55 Procedure window, 21-5
templates Procedures defined, 21-6
creating, 17-59 Project Explorer, 21-4
deleting, 17-60 Properties Window, 21-5
loading, 17-60 ThisDisplay module, 21-4
testing, 17-21 using the IDE, 21-3
time format in, 17-28 using with ActiveX objects, 15-254, 16-50
time span in, 17-46 VBA code, quick start, 21-- 5

updating pen values, 17-26 VBA documentation, 21-- 12


VBA Integrated Development Environment.
deadband, 17-27
See VBA IDE
heartbeat, 17-27
Vertical position animation, 16-- 26
using at run time, 17-8, 17-62, 17-66
Vertical slider animation, 16-- 40
pan, 17-70
Viewing objects, 21-- 8
zoom, 17-69
Visibility animation, 10-- 11, 16-- 14
using overlays, 17-53, 17-55
Visual Basic. See Microsoft Visual Basic
value bar in, 17-8, 17-29, 17-68
x-axis in, 17-3
W
y-axis in, 17-4 Wallpaper, converting graphic objects to,
15-- 289
Wedge graphic object, 15-- 46
Width animation, 16-- 28
U Wildcards, 8-- 3, 8-- 6
Undefine command, 19-- 14, A-- 61 and commands, A-2
Update rate for OPC nodes, 6-- 12 using to select tags, 7-18, 10-71
using to suppress alarm monitoring, 10-84
Upload command, 15-- 144, 15-- 236, A-- 62
WindowColor property, in trends, 17-- 20
UploadAll command, 15-- 144, 15-- 236, A-- 62
Windows, security, 14-- 1, 14-- 4, 14-- 18
User account commands Windows applications, A-- 26, A-- 27
Login, 14-11, 14-17, A-45 WindowStyle property, in trends, 17-- 20
Logout, 14-11, 14-18, A-46 WINtelligent LINX, C-- 4

Index ■ I--19
Workspace, 2-- 6
Write tag, 15-- 262

Z
Zoom, 15-- 10
in trends, 17-69

I--20 ■ RSView Supervisory Edition User’s Guide

You might also like