You are on page 1of 1139

VIEWSE_UM003C_EN_E_Ttlpg.

qxd 8/25/03 10:38 AM Page 1

User’s Guide

Doc ID VIEWSE-UM003C-EN-E
Contacting Technical Support Telephone—440-646-5800
Rockwell Software Technical Support Fax—440-646-5801
World Wide Web Support—www.software.rockwell.com or
www.support.rockwellautomation.com

Copyright Notice © 2003 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,
RSServer Toolkit, 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,
PLC-500, WINtelligent, WINtelligent EMULATE 5, WINtelligent EMULATE 500,
WINtelligent LOGIC 5, WINtelligent VIEW, WINtelligent RECIPE, WINtelligent VISION,
and WINtelligent VISION2 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.
Microsoft, MS-DOS, Windows, FoxPro, and Visual Basic are registered trademarks, and
Windows NT, ActiveX, and Microsoft Access are trademarks of the Microsoft Corporation.
Ethernet is a registered trademark of Digital Equipment Corporation, Intel, and Xerox
Corporation. IBM is a registered trademark of International Business Machines Corporation.
AIX, PowerPC, Power Series, and RISC System/6000 are trademarks of International Business
Machines Corporation. Adobe and Photoshop are registered trademarks of Adobe Systems
Incorporated. AutoCAD is a registered trademark of Autodesk, Inc. CorelDRAW is a trademark
of Corel Corporation. Seagate Crystal Reports is a trademark of Seagate Technology, Inc. or one
of its subsidiaries. Intel and Pentium are registered trademarks of Intel Corporation. OPC is a
trademark of the OPC Foundation. UNIX is a registered trademark in the United States and
other countries, licensed exclusively through X/Open Company Limited.
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 or 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-UM003C-EN-E
September 2003
Contents
Preface ................................................................................................................................................... P-1
About the documentation ............................................................................ P-1
Finding the information you need .......................................................... P-2
Try the user’s guides and Help first .......................................................................... P-2
Information on the Internet....................................................................................... P-2
Contacting Rockwell Software Technical Support ................................................. P-3

Chapter 1
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

Chapter 2
Exploring RSView Studio ...................................................................................................2-1
Starting RSView Studio ................................................................................. 2-1
Opening an application ................................................................................. 2-2
Running the samples application............................................................................... 2-4
Exploring the RSView Studio main window ................................... 2-4
The menu bar ............................................................................................................... 2-5
The toolbar ................................................................................................................... 2-5
The Application Explorer........................................................................................... 2-5
The workspace ............................................................................................................. 2-5

Contents Q
i
The Application tab......................................................................................................2-5
The Communications tab............................................................................................2-6
The Diagnostics List ....................................................................................................2-6
The status bar ................................................................................................................2-7
Showing and hiding items in the main window .......................................................2-8
Working in the Application Explorer .....................................................2-8
Undocking the Application Explorer ........................................................................2-9
Folders......................................................................................................................... 2-10
Editors......................................................................................................................... 2-10
Components ............................................................................................................... 2-13
Adding components to an application ............................................. 2-14

Renaming, removing, and deleting components....................... 2-16


Renaming a component............................................................................................ 2-16
Removing a component............................................................................................ 2-17
Deleting a component and file ................................................................................ 2-17
Naming components ..................................................................................... 2-18
Names that conflict with commands or macros................................................... 2-18
Techniques for working in editors ...................................................... 2-19
Using the context menus.......................................................................................... 2-19
Using the Browse button.......................................................................................... 2-19
Entering tag names.................................................................................................... 2-19
Using RSView commands ........................................................................................ 2-20
Using expressions ...................................................................................................... 2-21
Printing.................................................................................................................... 2-21
Selecting a printer ...................................................................................................... 2-22
Setting up the printer ................................................................................................ 2-23
Selecting a network printer....................................................................................... 2-23
Printing at run time ................................................................................................... 2-23

ii Q
RSView Supervisory Edition User’s Guide
Chapter 3
Planning an application .......................................................................................................3-1
Understanding the process ........................................................................ 3-1

Planning the layout of your network.................................................... 3-2


The Windows domain or workgroup ....................................................................... 3-2
The computers you’ll need ......................................................................................... 3-2
The network is scalable............................................................................................... 3-4
System requirements and installation........................................................................ 3-5

Planning redundancy....................................................................................... 3-5

Planning communications ........................................................................... 3-6

Designing an HMI tag database ............................................................. 3-7


Collect information...................................................................................................... 3-7
Organize HMI tags ..................................................................................................... 3-8

Planning alarms .................................................................................................. 3-8

Collecting data .................................................................................................... 3-8

Planning graphic displays ........................................................................... 3-9


Develop a hierarchy of displays................................................................................. 3-9
Create a template to ensure consistency................................................................... 3-9

Using trends ........................................................................................................ 3-11

Designing a secure system ...................................................................... 3-11

Customizing the system, and integrating with


other applications ........................................................................................... 3-12
Using data from other applications......................................................................... 3-12
Customizing the system ............................................................................................ 3-12

Designing a multi-user system............................................................... 3-13

Designing a system that is easy to deploy and maintain ... 3-14

Contents Q
iii
Chapter 4
Setting up FactoryTalk Directory .............................................................................4-1

About FactoryTalk Directory ......................................................................4-1


About FactoryTalk Directory redundancy................................................................4-3
Setting up FactoryTalk Directory without redundancy...........4-4
Summary of steps .........................................................................................................4-5
Specifying the FactoryTalk Directory location
for stand-alone applications ........................................................................................4-5
Setting up the FactoryTalk Directory Server computer
for distributed applications .........................................................................................4-6
Setting up the other computers on the network
for distributed applications .........................................................................................4-7
Setting up redundancy for FactoryTalk Directory ......................4-8
Summary of steps .........................................................................................................4-8
Setting up the FactoryTalk Directory server computers ........................................4-9
Setting up the other computers on the network................................................... 4-13

Chapter 5
Working with distributed applications ...............................................................5-1

About distributed applications .................................................................5-1


Key concepts.........................................................................................................5-2
HMI server, HMI project, HMI client ....................................................................5-2
FactoryTalk Directory..................................................................................................5-2
Application, area, data server......................................................................................5-4
About FactoryTalk Directory redundancy................................................................5-5
About HMI-server redundancy .................................................................................5-5
About data-server redundancy....................................................................................5-7
How stand-alone and distributed applications differ ..............................................5-8
More about areas ..........................................................................................................5-8
Absolute and relative references.............................................................................. 5-10

iv Q
RSView Supervisory Edition User’s Guide
Basic steps for developing an application .................................... 5-12

Activities when deploying an application ...................................... 5-12

Setting up FactoryTalk Directory......................................................... 5-12

Creating an application ............................................................................... 5-12

Renaming an application ........................................................................... 5-14

Deleting an application ............................................................................... 5-15

Structuring an application ........................................................................ 5-15


Using areas .................................................................................................................. 5-16
Adding HMI servers or data servers ...................................................................... 5-16

Adding and removing areas...................................................................... 5-17

Adding HMI servers ....................................................................................... 5-18


Limitations on the number of servers .................................................................... 5-18
Naming restrictions ................................................................................................... 5-19
Creating a new HMI server ..................................................................................... 5-20
Copying an HMI server............................................................................................ 5-20
Importing a project from RSView32, SE, or ME................................................. 5-21
Attaching to an existing HMI server...................................................................... 5-21

Setting up redundant HMI servers ...................................................... 5-21

Setting up HMI server properties ........................................................ 5-22


Setting up the HMI server’s general properties.................................................... 5-23
Setting up HMI server redundancy ........................................................................ 5-25
Specifying the HMI server’s startup and shutdown components ..................... 5-26

Starting and stopping HMI services manually ............................ 5-29

Starting and stopping an HMI server’s components


manually ................................................................................................................. 5-29

Removing HMI servers ................................................................................ 5-29

Deleting HMI server project files......................................................... 5-30

Contents Q
v
Chapter 6
Working with stand-alone applications .............................................................6-1

Key concepts.........................................................................................................6-1
Understanding terminology.........................................................................................6-1
About stand-alone applications ..................................................................................6-1
About data-server redundancy....................................................................................6-2
Using references in stand-alone applications ...........................................................6-2
Basic steps for developing an application .......................................6-3
Activities when deploying an application.........................................6-3
Creating an application..................................................................................6-4
Importing a project into a new application .....................................6-5
Renaming an application ..............................................................................6-6
Deleting an application ..................................................................................6-7
Using data servers in stand-alone applications ...........................6-7
Setting up HMI server properties ...........................................................6-8
Setting up the HMI server’s general properties.......................................................6-9
Specifying the HMI server’s startup and shutdown components ..................... 6-10
Starting and stopping an HMI server’s components
manually ................................................................................................................. 6-12

Chapter 7
Setting up communications ............................................................................................7-1

About OPC communications ......................................................................7-1


Overview of OPC communications ........................................................7-2
Summary of steps ..............................................................................................7-3
About data servers ............................................................................................7-4
Types of data servers....................................................................................................7-5
Using multiple data servers .........................................................................................7-5

vi Q
RSView Supervisory Edition User’s Guide
Adding OPC data servers ............................................................................ 7-7
Setting up general properties...................................................................................... 7-8
Setting up data server redundancy ............................................................................ 7-9
Setting up advanced properties................................................................................ 7-10
Adding RSLinx Enterprise data servers........................................... 7-12
Setting up general properties.................................................................................... 7-13
Setting up data server redundancy .......................................................................... 7-14
Setting up communications in RSLinx Enterprise ................... 7-15
Primary and Secondary tabs ..................................................................................... 7-15
Removing data servers ................................................................................ 7-17

Chapter 8
Working with tags.......................................................................................................................8-1
Tags and the HMI tag database ............................................................. 8-1
Data server tags, HMI tags, and their attributes..................................................... 8-1
Basic steps for using tags ............................................................................................ 8-3
When to use data server tags ................................................................... 8-4
Eliminate duplication .................................................................................................. 8-4
Access to complex data............................................................................................... 8-4
Steps for using data server tags ............................................................ 8-4
When to use HMI tags .................................................................................... 8-5
Alarms............................................................................................................................ 8-5
Security .......................................................................................................................... 8-5
Data manipulation ....................................................................................................... 8-6
Storing values in RSView’s memory ......................................................................... 8-7
Steps for using HMI tags ............................................................................. 8-7
Browsing for tags .............................................................................................. 8-8
Browsing for off-line tags from RSLinx ............................................ 8-10
Browsing for off-line tags from other OPC servers ................. 8-10
Using the tag browser .................................................................................. 8-11

Contents Q
vii
Working with folders in the tag browser ........................................ 8-12
Showing server names............................................................................................... 8-12
Adding folders............................................................................................................ 8-12
Finding the home area .............................................................................................. 8-13
Refreshing the list of folders and tags .................................................................... 8-14
Working with tags in the tag browser .............................................. 8-14
Displaying tags ........................................................................................................... 8-14
Showing or hiding tag descriptions......................................................................... 8-14
Selecting tags .............................................................................................................. 8-15
Using the selected tags list........................................................................................ 8-15
Displaying tag properties.......................................................................................... 8-17
Filtering tags ............................................................................................................... 8-17
Creating, editing, and importing HMI tags ........................................................... 8-18
Using tag references .................................................................................... 8-19
Absolute references ................................................................................................... 8-19
Relative references..................................................................................................... 8-19
The home area............................................................................................................ 8-20
Logging tag values ......................................................................................... 8-21

Chapter 9
Creating HMI tags ......................................................................................................................9-1
HMI tag types .......................................................................................................9-1
Data sources for HMI tags .........................................................................9-2
Device.............................................................................................................................9-2
Memory ..........................................................................................................................9-2
Retentive memory tags ................................................................................................9-2
Organizing HMI tags ........................................................................................9-3
Naming HMI tags ........................................................................................................9-3
Using folders to group HMI tags ..............................................................................9-4
The Tags editor ....................................................................................................9-4

viii Q
RSView Supervisory Edition User’s Guide
Using the Accept and Discard buttons .............................................. 9-5

Using the form ..................................................................................................... 9-5

Using the query box ......................................................................................... 9-6

Using the folder hierarchy .......................................................................... 9-6


Creating a folder........................................................................................................... 9-7
Opening a folder .......................................................................................................... 9-8
Adding tags to a folder................................................................................................ 9-8
Nesting a folder............................................................................................................ 9-9
Duplicating a folder................................................................................................... 9-10
Deleting a folder ........................................................................................................ 9-10
Using the spreadsheet ................................................................................. 9-11
Moving through the spreadsheet............................................................................. 9-11
Resizing columns and rows ...................................................................................... 9-11
Adding a tag................................................................................................................ 9-11
Duplicating a tag ........................................................................................................ 9-12
Editing a tag................................................................................................................ 9-12
Deleting a tag.............................................................................................................. 9-12
Setting up tag type ......................................................................................... 9-12
Setting up an analog tag ............................................................................................ 9-13
Setting up a digital tag ............................................................................................... 9-16
Setting up a string tag ................................................................................................ 9-17
Specifying a data source ........................................................................... 9-18
Specifying device as the data source ....................................................................... 9-18
Addressing syntax for OPC tags ............................................................................. 9-19
Specifying memory as the data source.................................................................... 9-20
Other ways of creating HMI tags ......................................................... 9-20
Creating tags in a third-party application ............................................................... 9-21
Creating tags as needed in other RSView editors ................................................. 9-21

Contents Q
ix
Importing tags from a PLC database...................................................................... 9-22
Using the Tag Import and Export Wizard ............................................................ 9-24
Adding alarms to HMI tags ...................................................................... 9-25

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

Chapter 11
Setting up alarms......................................................................................................................11-1
Summary of features ..................................................................................... 11-1
Key concepts...................................................................................................... 11-2
Alarms for analog HMI tags.................................................................................... 11-2
Alarms for digital HMI tags .................................................................................... 11-7
Alarm severity............................................................................................................. 11-7
Alarm messages.......................................................................................................... 11-8
Alarm log file.............................................................................................................. 11-8
Alarm displays ............................................................................................................ 11-9
Alarm acknowledgment .......................................................................................... 11-12

x Q
RSView Supervisory Edition User’s Guide
Alarm suppression ................................................................................................... 11-12
Alarm functions in expressions ............................................................................. 11-13
Acknowledge bit ...................................................................................................... 11-15
Handshake bit........................................................................................................... 11-16
Switching handshaking on...................................................................................... 11-17
Alarm events............................................................................................................. 11-17
Summary of steps.......................................................................................... 11-20
The Alarm Setup editor ............................................................................. 11-21
Specifying how the monitoring system behaves .................... 11-22
Setting up alarm trigger thesholds......................................................................... 11-22
Specifying how often the system checks for alarms........................................... 11-23
Specifying how alarm monitoring behaves on redundant servers.................... 11-23
Setting up alarm severity ........................................................................ 11-24
Setting up alarm messages.................................................................... 11-26
Types of messages ................................................................................................... 11-27
Defining the content of the message.................................................................... 11-27
Adding remarks to the alarm log file at run time ................... 11-30
Specifying alarm conditions for analog and digital tags .. 11-31
When to set up alarms for tags .............................................................................. 11-32
Setting up alarms for analog tags ..................................................... 11-32
Setting up alarm thresholds.................................................................................... 11-32
Setting up alarm messages ...................................................................................... 11-34
Setting up advanced features.................................................................................. 11-35
Setting up alarms for digital tags ...................................................... 11-37
Setting up alarm states............................................................................................. 11-37
Setting up alarm messages ...................................................................................... 11-39
Setting up advanced features.................................................................................. 11-40
Setting up alarm logging .......................................................................... 11-42
Specifying where to store alarm log files .................................... 11-44

Contents Q
xi
Creating log files............................................................................................ 11-45
Monitoring disk space............................................................................................. 11-45
Managing log files ......................................................................................... 11-46
Creating files periodically........................................................................................ 11-46
Creating files on demand........................................................................................ 11-47
Never creating new files ......................................................................................... 11-47
Deleting log files ............................................................................................ 11-48
Logging to a central database ............................................................. 11-49
Exporting alarm log files manually to ODBC format....................................... 11-51
Editing alarm log setup ............................................................................. 11-52
Setting up security to allow alarm logging to a
remote computer ........................................................................................... 11-53
About alarm log files ................................................................................... 11-55
How log files are named ......................................................................................... 11-55
Viewing alarm log files .............................................................................. 11-56
Using the alarm log viewer at run time ................................................................ 11-57
Creating an alarm summary .................................................................. 11-57
Creating an alarm summary object........................................................................ 11-58
The parts of an alarm summary............................................................................. 11-58
Inserting headings.................................................................................................... 11-59
Choosing fonts......................................................................................................... 11-61
Choosing colors and blink styles........................................................................... 11-61
Formatting buttons.................................................................................................. 11-63
Choosing data........................................................................................................... 11-67
Filtering data............................................................................................................. 11-67
Sorting data............................................................................................................... 11-73
Running commands, macros, or custom programs in response to alarms..... 11-74
Using alarm data with commands ......................................................................... 11-77
Viewing the area name in tag names..................................................................... 11-80

xii Q
RSView Supervisory Edition User’s Guide
Suppressing alarm printing .................................................................... 11-81
Using AlarmOn and AlarmPrintOff in the correct order ................................. 11-81
Suppressing alarm monitoring ............................................................. 11-81
Suppressing alarm monitoring for tags................................................................. 11-82
Viewing suppressed tags ......................................................................................... 11-82
Using the Suppressed List ...................................................................................... 11-83
More RSView commands....................................................................................... 11-83
Starting and stopping alarm monitoring ....................................... 11-83
Ways to start alarm monitoring at the HMI server............................................ 11-84
Ways to stop alarm monitoring ............................................................................. 11-85

Chapter 12
Logging system activity ................................................................................................... 12-1

Key concepts ...................................................................................................... 12-1


Destinations................................................................................................................ 12-2
Message routing ......................................................................................................... 12-3
Category....................................................................................................................... 12-3
Summary of steps....................................................................................................... 12-6
The FactoryTalk Diagnostics Setup tool ........................................ 12-7
Setting up the local log file ...................................................................... 12-8
Setting up the logging path....................................................................................... 12-8
Setting up the maximum size of the log file .......................................................... 12-9
Clearing the log file manually................................................................................. 12-10
Logging to a central database ............................................................. 12-10
Setting up message buffering ................................................................................. 12-12
Setting up the ODBC data source........................................................................ 12-13
Routing messages......................................................................................... 12-14
Setting up security to allow logging system activity
to a remote computer ................................................................................. 12-15

Contents Q
xiii
Using the Diagnostics List...................................................................... 12-17
Hiding, showing, and moving the Diagnostics List ........................................... 12-18
Messages in the Diagnostics List........................................................................... 12-19
Viewing FactoryTalk Diagnostics log files ................................. 12-19
Using the Diagnostics Viewer at run time ........................................................... 12-20

Chapter 13
Setting up data logging ......................................................................................................13-1

About data log models.............................................................................................. 13-1


How to use multiple data log models ..................................................................... 13-1
Summary of steps ........................................................................................... 13-2
About data log storage formats ............................................................ 13-2
The log file sets ................................................................................................ 13-2
How log file sets are named..................................................................................... 13-3
The ODBC database storage format ................................................. 13-4
How ODBC tables are named................................................................................ 13-4
Using an existing ODBC data source.................................................................... 13-4
Creating a new ODBC data source........................................................................ 13-5
The Data Log Models editor ..................................................................... 13-6
Setting up a model ......................................................................................... 13-7
Setting up log paths .................................................................................... 13-12
Switching log paths.................................................................................................. 13-12
Specifying log paths................................................................................................. 13-13
Setting up security to allow data logging to a
remote computer ........................................................................................... 13-18
Using the DataLogSwitchBack command
to switch logging paths ............................................................................ 13-19
Using DataLogMergeToPrimary to
move secondary files to the primary path................................... 13-20

xiv Q
RSView Supervisory Edition User’s Guide
Creating file sets ........................................................................................... 13-21

Monitoring disk space ............................................................................................. 13-21


Creating files periodically........................................................................................ 13-23
Creating files at specified times ............................................................................. 13-23
Creating files when a particular event occurs ...................................................... 13-24
Never creating new files.......................................................................................... 13-25

Using the DataLogNewFile command to create files .......... 13-25

Deleting ODBC database records and file sets ....................... 13-26

Specifying when to log data .................................................................. 13-29

Logging periodically ................................................................................................ 13-30


Logging on change................................................................................................... 13-30
Logging on demand................................................................................................. 13-31
Using the DataLogSnapshot command ............................................................... 13-32
Combining logging .................................................................................................. 13-33
Providing operators with a way to log on demand............................................. 13-33

Choosing the data to be logged .......................................................... 13-34

Editing the data log model ...................................................................... 13-35

Changing log paths using the RSView Administration Console ...................... 13-36

Making run-time changes without editing


the data log model ........................................................................................ 13-36

Changing the log rate for periodic logging .......................................................... 13-37


Changing the log file identifier string ................................................................... 13-37

Displaying historical data in a trend................................................ 13-38

Starting and stopping data logging .................................................. 13-38

Ways to start data logging....................................................................................... 13-38


Ways to stop data logging....................................................................................... 13-39

Contents Q
xv
Chapter 14

Setting up events ......................................................................................................................14-1

How to use multiple event components ................................................................ 14-1


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

Chapter 15
Setting up security ..................................................................................................................15-1

How security works ....................................................................................... 15-1


Set up users, codes, and secure access ........................................ 15-2
Before you begin, make lists................................................................... 15-4
Finding your way around ............................................................................ 15-4
Setting up user accounts .......................................................................... 15-5
Setting up default access........................................................................................... 15-6
Ensuring you always have access ............................................................................ 15-7
Adding users or groups............................................................................................. 15-7
Removing users or groups........................................................................................ 15-8
Assigning security codes to users or groups ............................ 15-10
Login and logout macros ......................................................................... 15-10

xvi Q
RSView Supervisory Edition User’s Guide
Securing commands and macros ....................................................... 15-11
Security codes ........................................................................................................... 15-12
The Unspecified_Command .................................................................................. 15-12
Setting up security by inclusion ............................................................................. 15-13
Setting up security by exclusion............................................................................. 15-13
Assigning security to a graphic display ........................................ 15-14
Assigning security to an OLE object ............................................... 15-16
Assigning security to an HMI tag ...................................................... 15-17
Preventing users from modifying an application .................... 15-19
Locking users into the RSView SE Client environment ..... 15-20
Logging in at run time ................................................................................ 15-21
Logging out at run time ............................................................................. 15-21
Changing passwords at run time ....................................................... 15-22

Chapter 16
Creating graphic displays .............................................................................................. 16-1
About graphic displays and graphic objects ............................... 16-1
The Graphic Displays editor .................................................................... 16-2
The parts of the editor .............................................................................................. 16-3
Mastering basic techniques ..................................................................... 16-5
Correcting mistakes ................................................................................................... 16-5
Zooming in and out................................................................................................... 16-5
Using the grid ............................................................................................................. 16-6
Using the toolbars...................................................................................................... 16-7
Selecting a drawing tool ............................................................................................ 16-8
Testing graphic displays ............................................................................................ 16-9
Working with objects ................................................................................................ 16-9
Selecting and deselecting objects........................................................................... 16-10
Using the Object Explorer ..................................................................................... 16-11
Highlighting objects in the Object Explorer ....................................................... 16-13

Contents Q
xvii
Using the context menu.......................................................................................... 16-15
Moving objects......................................................................................................... 16-15
Copying objects........................................................................................................ 16-16
Duplicating objects.................................................................................................. 16-18
Resizing objects........................................................................................................ 16-19
Arranging objects..................................................................................................... 16-20
Stacking objects........................................................................................................ 16-21
Aligning objects ....................................................................................................... 16-22
Spacing objects......................................................................................................... 16-24
Flipping objects........................................................................................................ 16-25
Rotating objects ....................................................................................................... 16-26
Grouping and ungrouping objects........................................................................ 16-28
Editing grouped objects.......................................................................................... 16-29
Applying colors ........................................................................................................ 16-31
Applying pattern styles............................................................................................ 16-32
Changing line properties......................................................................................... 16-33
Using the Property Panel........................................................................................ 16-34
Setting up properties ............................................................................................... 16-35
Assigning tags and expressions to objects ........................................................... 16-38
Using tag substitution to replace text associated with objects.......................... 16-39
Testing the appearance of objects in different states......................................... 16-42
Naming graphic objects .......................................................................................... 16-43
Adding tooltips to objects ...................................................................................... 16-43
Creating a background for your display ............................................................... 16-45
Importing graphic files from third-party applications ......... 16-46
Converting imported objects to RSView native objects.................................... 16-47
Using bitmaps .................................................................................................. 16-47
When a bitmap could help ..................................................................................... 16-49
Using graphic libraries .............................................................................. 16-49
Location of library files........................................................................................... 16-49

xviii Q
RSView Supervisory Edition User’s Guide
Using tag placeholders ............................................................................. 16-51
Replacing tag placeholders using a parameter file .............................................. 16-52
Assigning parameter files to graphic displays...................................................... 16-54
Replacing tag placeholders using parameters to the Display command ......... 16-55

Setting up the display ................................................................................ 16-57


Creating default display settings ............................................................................ 16-58
Using the Display Settings dialog box .................................................................. 16-58

Setting up display properties ................................................................ 16-59


Specifying the display type...................................................................................... 16-60
Allowing multiple running copies ......................................................................... 16-61
Specifying caching.................................................................................................... 16-62
Setting up the title bar and other display attributes............................................ 16-63
Preventing scroll bars on the main window ........................................................ 16-65
Specifying display size ............................................................................................. 16-66
Specifying how displays are resized....................................................................... 16-66
Specifying display position ..................................................................................... 16-67
Specifying a security code....................................................................................... 16-67
Specifying background color.................................................................................. 16-68

Setting up display behavior.................................................................... 16-68


Specifying startup and shutdown commands...................................................... 16-69
Specifying colors for input fields........................................................................... 16-70
Specifying the behavior of interactive objects..................................................... 16-70
Specifying the behavior of objects with input focus .......................................... 16-71
Displaying the on-screen keyboard....................................................................... 16-72

Displaying graphics more quickly...................................................... 16-74


Removing displays from the cache ....................................................................... 16-74

Printing displays at run time ................................................................. 16-75

Contents Q
xix
Chapter 17

Setting up graphic objects .............................................................................................17-1

Types of graphic objects ........................................................................... 17-1


Creating drawing objects .......................................................................... 17-2

Creating text ....................................................................................................... 17-2


Choosing a font.......................................................................................................... 17-2
Creating a text object ................................................................................................ 17-4
Setting up the appearance of the text ..................................................................... 17-5
Adding an image to a graphic display .............................................. 17-6
Pasting images into graphic displays....................................................................... 17-7
Adding images to your application ......................................................................... 17-8
Placing images in graphic displays........................................................................... 17-8
Adding images to your application ....................................................................... 17-11
Creating a panel ............................................................................................. 17-12
Drawing a rounded rectangle ............................................................... 17-14

Drawing a rectangle or square ............................................................ 17-15

Drawing an ellipse or circle ................................................................... 17-15

Drawing a line .................................................................................................. 17-16


Drawing a polyline or polygon .............................................................. 17-16

Drawing a freehand object ..................................................................... 17-17

Drawing an arc or wedge ......................................................................... 17-17


Reshaping drawing objects .................................................................... 17-18

Changing the properties of drawing objects ............................. 17-20

Setting up properties common to all graphic objects ........ 17-22


Creating objects that use data ............................................................ 17-26
Objects described in other chapters ..................................................................... 17-26
Using tag names ....................................................................................................... 17-27

xx Q
RSView Supervisory Edition User’s Guide
Using the keyboard to navigate to, and select objects ..... 17-27
What input focus looks like.................................................................................... 17-27
Using the keys on the keyboard or keypad .......................................................... 17-28
Removing objects from the tab sequence............................................................ 17-28
How to use push buttons ......................................................................... 17-29
Setting up push buttons .......................................................................................... 17-31
How to use the States tab for push buttons ........................................................ 17-33
How to use the Connections tab for push buttons............................................ 17-34
How the Value tag works ....................................................................................... 17-35
How the Indicator tag works ................................................................................. 17-36
Creating push buttons ................................................................................ 17-37

Creating buttons ............................................................................................ 17-37


Setting up the button’s appearance, and how it works at run time.................. 17-39
Setting up the button’s actions .............................................................................. 17-40
Setting up what the button looks like when it is not pressed ........................... 17-42
Setting up what the button looks like when it is pressed................................... 17-44
Editing a button ....................................................................................................... 17-45
Reshaping a button.................................................................................................. 17-45
Creating momentary push buttons ................................................... 17-45
Setting up the appearance and action of the momentary push button ........... 17-47
Setting up what the momentary push button does
when it is pressed and released .............................................................................. 17-50
Connecting the momentary push button to data................................................ 17-54
Creating maintained push buttons .................................................... 17-55
Setting up the appearance of the maintained push button,
and how it changes state ......................................................................................... 17-57
Setting up what the maintained push button does
when it is pressed and released .............................................................................. 17-60
Connecting the maintained push button to data................................................. 17-64

Contents Q
xxi
Creating latched push buttons ............................................................ 17-65
Setting up the appearance of the latched push button,
and how to unlatch it .............................................................................................. 17-67
Setting up what the latched push button does
when it is latched and unlatched ........................................................................... 17-69
Connecting the latched push button to data ....................................................... 17-73
Creating multistate push buttons ...................................................... 17-74
Setting up the appearance of the multistate push button,
and how it changes state......................................................................................... 17-76
Setting up what the multistate push button does
when it is pressed and released.............................................................................. 17-79
Setting up whether the multistate push button repeats when held down....... 17-83
Connecting the multistate push button to data................................................... 17-84
Creating interlocked push buttons ................................................... 17-85
Setting up the appearance and value of the interlocked push button ............. 17-87
Setting up what the interlocked push button looks like
when it is pressed and released.............................................................................. 17-89
Connecting the interlocked push button to data ................................................ 17-93
Creating ramp push buttons .................................................................. 17-94
Setting up the appearance of the ramp push button, and how it works ......... 17-96
Setting up the text that appears on the ramp push button................................ 17-99
Setting up whether the ramp push button repeats when held down............. 17-102
Connecting the ramp push button to data......................................................... 17-103
Creating numeric or string fields ..................................................... 17-103
Creating numeric display fields............................................................................ 17-103
Creating string display fields ................................................................................ 17-105
Creating numeric or string input fields............................................................... 17-107
Using input fields at run time ............................................................. 17-113
Updating tag values continuously ....................................................................... 17-113
Keys ......................................................................................................................... 17-114

xxii Q
RSView Supervisory Edition User’s Guide
RSView commands................................................................................................ 17-115
Using the on-screen keyboard ............................................................................. 17-115
How to use indicators .............................................................................. 17-117
How to use the States tab for indicators ............................................................ 17-118
How to use Least Significant Bits to trigger states ........................................... 17-119
How to use the Connections tab for indicators................................................ 17-119
Creating multistate indicators ........................................................... 17-120
Setting up the appearance of the multistate indicator,
and its number of states........................................................................................ 17-122
Setting up how the multistate indicator’s appearance changes
to match its value ................................................................................................... 17-123
Connecting the multistate indicator to data....................................................... 17-128
Creating symbol indicators .................................................................. 17-128
Setting up the appearance of the symbol indicator,
and its number of states........................................................................................ 17-130
Setting up how the symbol indicator changes appearance
when its value changes .......................................................................................... 17-131
Connecting the symbol indicator to data ........................................................... 17-133
Creating list indicators ............................................................................ 17-134
Setting up the appearance of the list indicator,
and its number of states........................................................................................ 17-136
Setting up how the list indicator’s appearance changes
when its value changes .......................................................................................... 17-138
Connecting the list indicator to data................................................................... 17-140
How to use gauges and graphs ......................................................... 17-141
Gauges make it easy to see limits ........................................................................ 17-141
Graphs make it easy to compare values ............................................................. 17-142
How to use the Connections tab for gauges and graphs................................. 17-143
Creating gauges ........................................................................................... 17-144
Setting up the appearance of the gauge.............................................................. 17-146
Setting up how the gauge works.......................................................................... 17-148
Connecting the gauge to data............................................................................... 17-150

Contents Q
xxiii
Creating bar graphs ................................................................................... 17-150
Setting up the appearance of the bar graph....................................................... 17-152
Connecting the bar graph to data........................................................................ 17-154
Creating scales ............................................................................................. 17-154
Setting up the appearance of the scale ............................................................... 17-156
How to use keys ........................................................................................... 17-158
Using the Key objects ........................................................................................... 17-159
Keys can work with the object that has focus................................................... 17-160
Creating keys ................................................................................................. 17-160
Setting up the appearance of the key.................................................................. 17-162
Adding text or an image to the key..................................................................... 17-165
Setting up whether the key repeats when held down....................................... 17-168
Creating advanced objects .................................................................. 17-169
Objects described in other chapters ................................................................... 17-169
Creating arrows ............................................................................................ 17-170
How to use control list selectors .................................................... 17-172
Choosing between control list selectors
and piloted control list selectors.......................................................................... 17-172
How control list selectors work at run time ...................................................... 17-172
How to use the States tab for control list selectors.......................................... 17-173
How to use the Connections tab for control list selectors.............................. 17-174
Creating control list selectors ........................................................... 17-177
Setting up the appearance of the control list selector ...................................... 17-179
Setting up the control list selector’s value and appearance ............................. 17-182
Setting up the control list selector to work with an Enter key ....................... 17-184
Connecting the control list selector to data....................................................... 17-185
How to use piloted control list selectors................................... 17-186
Choosing between piloted control list selectors
and control list selectors ....................................................................................... 17-186
How piloted control list selectors work at run time......................................... 17-187

xxiv Q
RSView Supervisory Edition User’s Guide
How to use the States tab for piloted control list selectors ............................ 17-189
How to use the Connections tab for piloted control list selectors ................ 17-191
Creating piloted control list selectors ......................................... 17-194
Setting up the appearance of the piloted control list selector......................... 17-196
Setting up the piloted control list selector's state values and captions .......... 17-198
Setting up the piloted control list selector to work with an Enter key.......... 17-201
Connecting the piloted control list selector to data.......................................... 17-202
Creating tag labels ..................................................................................... 17-204

How to use display list selectors..................................................... 17-206


Understanding the States tab for display list selectors ..................................... 17-206
Creating display list selectors ........................................................... 17-207
Setting up the appearance of the display list selector....................................... 17-209
Setting up which displays appear in the display list selector ........................... 17-212
How to use local message displays ............................................... 17-215
What is displayed at run time............................................................................... 17-215
Creating local message displays ..................................................... 17-216
Setting up the appearance of the local message display................................... 17-218
Connecting the local message display to data.................................................... 17-220
Creating recipe fields ............................................................................... 17-221

Creating a recipe file ................................................................................ 17-222


Two ways to create a recipe file........................................................................... 17-222
Using a recipe at run time .................................................................... 17-225

Creating time and date displays ....................................................... 17-228


Setting up the appearance of the time and date display................................... 17-229
Using local messages .............................................................................. 17-231
Basic steps for setting up local messages ........................................................... 17-232
Creating local messages......................................................................................... 17-234
Creating local messages using a spreadsheet application................................. 17-237

Contents Q
xxv
Creating and editing OLE objects ................................................... 17-238
Other methods for inserting OLE objects ....................................................... 17-240
Converting OLE objects...................................................................................... 17-240
Creating and editing ActiveX objects ........................................... 17-242
When exchanging data with tags, use the same data type ............................... 17-242
ActiveX properties, methods, and events .......................................................... 17-243
Making ActiveX objects interact with RSView ................................................. 17-244
Using VBA code to make ActiveX objects interact with RSView................. 17-245
Using the ActiveX Toolbox ................................................................................. 17-245
Deploying ActiveX components automatically
at run time ........................................................................................................ 17-247
Recording and authorizing run-time changes
using electronic signatures ................................................................. 17-248
Securing tag writes, commands, and downloads .............................................. 17-249
Securing objects in displays.................................................................................. 17-249
Tracking changes with FactoryTalk Diagnostics .............................................. 17-250
Using the Signature button for compliance with
regulated manufacturing applications ................................................................. 17-250
Creating Signature buttons .................................................................. 17-250
Specifying a caption for the Signature button................................................... 17-252
Setting up the run-time behavior of the Signature button .............................. 17-252
Specifying colors for the Signature button ........................................................ 17-255
Specifying a tag for the Signature button........................................................... 17-256
Changing the style and color of the font ........................................................... 17-256

Chapter 18
Animating graphic objects .............................................................................................18-1
Types of animation ......................................................................................... 18-1
Using the Animation dialog box ............................................................ 18-3
Using the Animation dialog box ............................................................................. 18-4
Using Object Smart Path to set animation visually .............................................. 18-6

xxvi Q
RSView Supervisory Edition User’s Guide
Testing animation ........................................................................................... 18-6
Using tag names and tag placeholders ........................................... 18-7
Tag names ................................................................................................................... 18-7
Tag placeholders ........................................................................................................ 18-7
Using commands and macros ................................................................ 18-8
Using expressions........................................................................................... 18-8
Setting the range of tag values
for animating the object ............................................................................. 18-9
Limiting the range of values used for animation ................................................ 18-10
Defining a range of motion for the object .................................... 18-11
Objects that do not have a range of motion........................................................ 18-11
Using OSP (Object Smart Path) ........................................................................... 18-11
Setting up visibility animation ............................................................. 18-13
Setting up color animation ..................................................................... 18-14
Using the colors and thresholds list...................................................................... 18-15
Setting up fill animation ........................................................................... 18-20
Setting up horizontal position animation ..................................... 18-22
Setting up vertical position animation ........................................... 18-23
Setting up width animation .................................................................... 18-25
Setting up height animation .................................................................. 18-27
Setting up rotation animation............................................................... 18-29
How rotation animation works.............................................................................. 18-29
Setting up touch animation .................................................................... 18-33
Setting up horizontal slider animation ........................................... 18-34
Setting up vertical slider animation................................................. 18-36
Setting up OLE verb animation ........................................................... 18-37
Attaching other types of animation to OLE objects ......................................... 18-38
Animating ActiveX controls ................................................................... 18-39
Naming an ActiveX object..................................................................................... 18-40

Contents Q
xxvii
Connecting tags to an ActiveX object’s properties.............. 18-40
Connecting tags to an object’s methods ..................................... 18-42
Viewing an object’s methods ................................................................................. 18-42
Using the Invoke command to call a method ..................................................... 18-43
Connecting tags to an ActiveX object’s events ...................... 18-44
Using VBA code to make ActiveX objects interact with RSView .................. 18-45
Associating objects and displays with keys ............................. 18-45
Creating object keys ................................................................................... 18-46
Using index numbers .................................................................................. 18-49
How tab index numbers work ............................................................................... 18-49
Checking an object’s index number...................................................................... 18-50
Changing index numbers........................................................................................ 18-51
Creating a tab sequence .......................................................................................... 18-52
Using the Current [Tag] parameter .................................................. 18-54
Summary of steps .................................................................................................... 18-54
Three examples ........................................................................................................ 18-55
Creating display keys ................................................................................. 18-60
Editing display and object keys .......................................................... 18-62
Modifying a key........................................................................................................ 18-63
Removing a key........................................................................................................ 18-63
Removing all keys .................................................................................................... 18-63
Viewing the key list at run time.......................................................... 18-64
Disabling the key list ............................................................................................... 18-65
Applying animation to groups............................................................... 18-65
Checking the animation on objects ................................................. 18-65
Checking animation using the menu, or the Animation dialog box ................ 18-66
Changing the animation on objects ................................................. 18-67
Copying or duplicating objects with animation ....................... 18-67
Copying animation without copying objects ............................. 18-68

xxviii Q
RSView Supervisory Edition User’s Guide
Chapter 19
Setting up trends ...................................................................................................................... 19-1

Summary of trend features ....................................................................... 19-1


The parts of a trend ....................................................................................... 19-3
Chart ............................................................................................................................ 19-3
Chart title..................................................................................................................... 19-4
x-axis ............................................................................................................................ 19-4
x-axis legend ............................................................................................................... 19-4
y-axis ............................................................................................................................ 19-4
y-axis legend................................................................................................................ 19-4
Pens.............................................................................................................................. 19-5
Legends........................................................................................................................ 19-6
Pen icons ..................................................................................................................... 19-6
Pen markers ................................................................................................................ 19-7
Trend Properties dialog box..................................................................................... 19-8
Value Bar..................................................................................................................... 19-9
Trend chart types .......................................................................................... 19-10
Standard Chart.......................................................................................................... 19-10
XY Plot Chart .......................................................................................................... 19-11
Isolated graphing...................................................................................................... 19-12
Choosing trend colors, fonts, lines, and markers .................. 19-13
Changing the trend highlight color ....................................................................... 19-13
Changing the trend chart background color........................................................ 19-14
Changing the trend object background ................................................................ 19-15
Creating a trend object ............................................................................. 19-16
Setting up how the trend loads and updates data ................ 19-17
Selecting a chart style............................................................................................... 19-18
Setting up the chart update mode ......................................................................... 19-19
Displaying data in a trend ....................................................................................... 19-20

Contents Q
xxix
Saving trend data to the data buffer ..................................................................... 19-20
Overlaying a snapshot of previously-charted data.............................................. 19-21
Setting up the trend display settings ............................................. 19-22
Displaying a current value legend ......................................................................... 19-24
Displaying a line legend .......................................................................................... 19-25
Determining how the trend chart is filled with data .......................................... 19-27
Adding pens to the trend ......................................................................... 19-29
Adding a pen from a data log model .................................................................... 19-30
Deleting a pen from the trend ............................................................................... 19-32
Setting up pen attributes......................................................................................... 19-32
Editing multiple pens simultaneously................................................................... 19-37
Plotting tag limits..................................................................................................... 19-38
Using shading to compare pens ............................................................................ 19-38
Setting up the horizontal axis (x-axis) ........................................... 19-43
Setting up the x-axis display options .................................................................... 19-44
Setting up the vertical axis (y-axis) ................................................. 19-45
Defining the minimum and maximum values on the vertical axis................... 19-46
Setting up the Y-Axis display options .................................................................. 19-48
Setting up the vertical scale for multiple pens..................................................... 19-49
Comparing real-time and historical data ...................................... 19-50
Setting up snapshots and overlays .................................................. 19-51
Deleting snapshots .................................................................................................. 19-53
Changing the attributes of a snapshot pen .......................................................... 19-53
Setting up overlays................................................................................................... 19-53
Creating a trend template ....................................................................... 19-56
Applying a consistent appearance to trend charts .............................................. 19-56
Creating a set of different views for the same data ............................................ 19-56
Returning to a standard display ............................................................................. 19-56
Saving pen attribute data ........................................................................................ 19-57
Creating and saving a new template...................................................................... 19-57

xxx Q
RSView Supervisory Edition User’s Guide
Loading a template .................................................................................................. 19-59
Deleting a template.................................................................................................. 19-59
Loading a template at run time.............................................................................. 19-59
Setting up the trend’s run-time options......................................... 19-60
Displaying property pages at run time.................................................................. 19-61
Setting up chart behavior........................................................................................ 19-61
Setting up context menu options .......................................................................... 19-62
Setting up the Common properties ................................................... 19-63
Using the Trend graphic library .......................................................... 19-63
Testing the trend ........................................................................................... 19-63
Using the trend at run time .................................................................... 19-64
Collecting data in the background at run time .................................................... 19-64
Selecting pens ........................................................................................................... 19-65
Changing the trend properties ............................................................................... 19-66
Using scrolling options at run time....................................................................... 19-67
Using the value bar at run time.............................................................................. 19-68
Using the delta value bar at run time .................................................................... 19-69
Using zoom at run time .......................................................................................... 19-70
Using pan at run time.............................................................................................. 19-71
Using the arrow keys at run time........................................................................... 19-71
Printing the trend chart at run time ...................................................................... 19-72
Using overlays at run time ...................................................................................... 19-72
Fixing run-time errors ............................................................................................. 19-73

Chapter 20
Creating expressions........................................................................................................... 20-1

About expressions .......................................................................................... 20-1


Expression components ........................................................................................... 20-1
Where you can use expressions ........................................................... 20-2
Using expressions in a command ............................................................................ 20-2

Contents Q
xxxi
Creating expressions .................................................................................... 20-2
Expression buttons.................................................................................................... 20-3
Using the Check Syntax button............................................................................... 20-4
Cutting, copying, and pasting expressions .................................. 20-4
Formatting expressions .............................................................................. 20-5
Using tag names and tag placeholders ........................................... 20-6
Using area names with tag names ........................................................................... 20-7
Using tag placeholders instead of tag names......................................................... 20-7
Constants .............................................................................................................. 20-7
Arithmetic operators ..................................................................................... 20-8
String operands .......................................................................................................... 20-9
Relational operators...................................................................................... 20-9
How string operands are evaluated......................................................................... 20-9
Logical operators .......................................................................................... 20-10
Bitwise operators .......................................................................................... 20-10
Built-in functions............................................................................................ 20-12
Tag functions............................................................................................................ 20-13
Time functions ......................................................................................................... 20-15
File functions............................................................................................................ 20-19
Math functions ......................................................................................................... 20-19
Security functions .................................................................................................... 20-20
Evaluation order of operators............................................................... 20-21
If–then–else ...................................................................................................... 20-23
Nested if–then–else structure............................................................................... 20-25

Chapter 21
Creating embedded variables.....................................................................................21-1

About embedded variables ....................................................................... 21-1


Where you can create embedded variables ................................. 21-2

xxxii Q
RSView Supervisory Edition User’s Guide
Creating embedded variables ................................................................. 21-2
Creating numeric embedded variables.................................................................... 21-4
Creating string embedded variables ........................................................................ 21-5
Creating time and date embedded variables .......................................................... 21-7
Cutting, copying, and pasting embedded variables ............... 21-9
Editing embedded variables .................................................................... 21-9
Deleting embedded variables ................................................................. 21-9
How embedded variables are updated at run time ............... 21-10
How embedded variables are displayed at run time............ 21-10
Numeric embedded variables................................................................................. 21-10
String embedded variables...................................................................................... 21-11
Time and date embedded variables....................................................................... 21-11

Chapter 22
Creating macros ........................................................................................................................ 22-1
Creating macros ............................................................................................... 22-1
Running macros ................................................................................................ 22-3
Using parameters ....................................................................................................... 22-4
Typing macro names that contain spaces .............................................................. 22-5
Nesting macros........................................................................................................... 22-5
Creating a macro that runs when an HMI server starts...................................... 22-6

Chapter 23
Setting up navigation .......................................................................................................... 23-1
Developing a hierarchy of displays ..................................................... 23-1
Ways of moving among displays ........................................................... 23-2
Commands for moving among displays................................................................. 23-3
Reducing display call-up time .................................................................................. 23-4
Where to use RSView commands ........................................................................... 23-4
Examples of navigation methods ......................................................... 23-5

Contents Q
xxxiii
Using keys ............................................................................................................ 23-7
General rules about precedence .............................................................................. 23-7
Precedence and the F1 key ...................................................................................... 23-8
Precedence and embedded ActiveX objects ......................................................... 23-8
Precedence and embedded OLE objects .............................................................. 23-9
Reserved keys ........................................................................................................... 23-10
Creating client keys .................................................................................... 23-12
Running client key components ......................................................... 23-14

Chapter 24
Using the SE Client object model and display code ........................24-1
The VBA integrated development environment........................ 24-2
Opening the IDE window....................................................................................... 24-2
Parts of the IDE window ........................................................................................ 24-3
Quick Start steps............................................................................................. 24-5
How VBA code runs ................................................................................................ 24-5
About procedures ............................................................................................ 24-5
The RSView SE Client Object Model ................................................. 24-6
Viewing the objects ................................................................................................. 24-10
Getting Help with RSView SE Client objects..................................................... 24-10
Opening Help from the Object Browser............................................................. 24-11
Opening Help from the Code Window ............................................................... 24-11
Opening Help from the RSView Help Contents window ................................ 24-12
Using VBA Help .............................................................................................. 24-13
VBA documentation............................................................................................... 24-13

Chapter 25
Setting up redundancy ........................................................................................................25-1
HMI redundancy as part of a complete strategy ..................... 25-2
Protecting against software failures ................................................ 25-3

xxxiv Q
RSView Supervisory Edition User’s Guide
Considering redundancy options .......................................................... 25-5
Redundant FactoryTalk Directory computers ...................................................... 25-5
Redundant RSView SE Servers ............................................................................... 25-6
Redundant data servers ............................................................................................. 25-9
Planning the layout of a redundant system ................................ 25-10
An application with a single HMI server............................................................. 25-10
An application with two HMI servers ................................................................. 25-12
An application with up to five HMI servers ....................................................... 25-12
A distributed application that can run
as a set of stand-alone applications ....................................................................... 25-13
Scenarios that explain how redundancy works ...................... 25-15
FactoryTalk Directory is down, and redundancy is not set up for it............... 25-15
Primary FactoryTalk Directory goes down, secondary becomes active.......... 25-16
One primary FactoryTalk Directory, multiple secondary
FactoryTalk Directory computers: primary goes down ..................................... 25-17
Setting up a redundant RSView SE system ................................ 25-18
Licensing in a redundant system ....................................................... 25-19
FactoryTalk Directory computers ......................................................................... 25-19
RSView SE Servers.................................................................................................. 25-19
OPC Servers............................................................................................................. 25-19
RSView SE Clients .................................................................................................. 25-20

Chapter 26
Deploying distributed applications...................................................................... 26-1
Overview of deploying your distributed application............... 26-1
Copying FactoryTalk Directory files .................................................. 26-4
Specifying the location of FactoryTalk Directory .................... 26-4
Copying HMI server files ............................................................................ 26-4
Copying an HMI server that is not running .......................................................... 26-5
Copying an HMI server while it is running ........................................................... 26-6
Setting up HMI server properties ........................................................ 26-8

Contents Q
xxxv
Starting and stopping an HMI server’s components
manually ................................................................................................................. 26-9

Starting and stopping HMI services manually .......................... 26-10

Synchronizing the secondary HMI server


with the primary server............................................................................. 26-12

Copying data server files ......................................................................... 26-12


Files for RSLinx Enterprise ................................................................................... 26-13
Files for RSLinx for RSView ................................................................................. 26-13
Setting up data server properties ..................................................... 26-14

Setting up RSView SE Clients .............................................................. 26-14

Copying client configuration files ..................................................... 26-16

Opening RSView SE Clients ................................................................... 26-16


Opening the RSView SE Client automatically when Windows starts ............. 26-18
Opening multiple clients......................................................................................... 26-18
How server components start and stop ............................................................... 26-19

Chapter 27

Deploying stand-alone applications ....................................................................27-1

About deploying stand-alone applications .................................... 27-1

Overview of deploying your stand-alone application ............ 27-1

Copying a stand-alone application ..................................................... 27-3

Setting up HMI server properties ........................................................ 27-3

Starting and stopping an HMI server’s components


manually ................................................................................................................. 27-3

Moving or copying data server files ................................................... 27-4

Setting up data server properties ....................................................... 27-4

Setting up the RSView SE Client.......................................................... 27-5

xxxvi Q
RSView Supervisory Edition User’s Guide
Opening the RSView SE Client............................................................... 27-6
Opening the RSView SE Client automatically when Windows starts ............... 27-7
Opening multiple clients........................................................................................... 27-7
How server components start and stop ................................................................. 27-8

Chapter 28
Administering applications........................................................................................... 28-1
Specifying time, date, and number formats ................................. 28-1
Backing up or restoring a stand-alone application ................. 28-2
Administering your application ............................................................. 28-2
Monitoring disk space on the HMI server...................................... 28-4

Appendix A
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-2
Precedence ................................................................................................................... A-4
Where commands run................................................................................................ A-4
Commands that do not run in test display mode .................................................. A-6
Absolute and relative references............................................................................... A-6
How relative references are resolved ....................................................................... A-7
Creating symbols......................................................................................................... A-8
Important guidelines .................................................................................................. A-9

Using the command line ............................................................................ A-10

Using the Command Wizard .................................................................... A-10


Building a command string...................................................................................... A-11

The RSView commands, organized alphabetically ................ A-13

Contents Q
xxxvii
Appendix B
System tags ...................................................................................................................................... B-1
Alarms .......................................................................................................................B-1
Time ............................................................................................................................B-2

Appendix C
Setting up DDE communications for HMI tags ........................................ C-1
About DDE communications .....................................................................C-1
Overview of DDE communications .......................................................C-2
Summary of steps .............................................................................................C-3
Creating an HMI tag using DDE ..............................................................C-3
Specifying device as the data source .........................................................................C-3
Syntax for DDE addresses.........................................................................................C-4
Scanning for new tag values .....................................................................C-4

Appendix D
The ODBC database schemas.................................................................................... D-1
FactoryTalk Diagnostics log table ....................................................... D-1
Alarm log table ................................................................................................... D-2
Data log tables ................................................................................................... D-5

Appendix E
Exporting text in your application for translation ...............................E-1
Text that you cannot export .....................................................................E-2
Text that is part of the software ................................................................................E-2
Text that is displayed at run time, but cannot be exported...................................E-3
Text that is not displayed at run time, and cannot be exported ...........................E-4
Exporting text ......................................................................................................E-5
Importing text ......................................................................................................E-8

xxxviii Q
RSView Supervisory Edition User’s Guide
Troubleshooting importing....................................................................... E-10
Common errors and their causes............................................................................ E-10
Information for translators ...................................................................... E-12
File name and format ............................................................................................... E-12
Opening the text file in Microsoft Excel .............................................................. E-13
Saving the text file in Microsoft Excel .................................................................. E-15
Differences in file format for files saved in Excel.............................................. E-16
Editing the Unicode text file in Notepad.............................................................. E-16
File schema ................................................................................................................ E-16
Working with pairs of double quotes .................................................................... E-18
Working with backslashes and new-line characters............................................. E-18

Appendix F
Importing and exporting XML files ........................................................................ F-1
About XML .............................................................................................................. F-1
Creating an XML file .................................................................................................. F-1
Saving XML files in Notepad.................................................................................... F-2
Testing an XML file.................................................................................................... F-2
Importing a Multistate Indicator XML file ........................................ F-3
Error log file .................................................................................................................F-3
Multistate Indicator XML file structure ............................................. F-4
Syntax, attributes, and elements................................................................................. F-4
Specifying attributes in the correct order................................................................. F-5
Version and encoding ................................................................................................. F-5
The gfx element ........................................................................................................... F-6
The msi element........................................................................................................... F-6
The defs element.......................................................................................................... F-6
Multiple multistate indicators in the same file......................................................... F-7
Multistate Indicator element ...................................................................................... F-8
States element............................................................................................................... F-9
Font Element..............................................................................................................F-10

Contents Q
xxxix
Connection Element ................................................................................................. F-11
Animation Element ................................................................................................... F-11
Image Element ........................................................................................................... F-12
Caption element......................................................................................................... F-13

Index .......................................................................................................................................................... I-1

xl Q
RSView Supervisory Edition User’s Guide
P Preface
Thank you for choosing RSView 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 Microsoft® Windows® 2000 and Windows XP,
RSView Supervisory Edition gives you all the tools you need to create
effective monitoring and supervisory control applications.

About the documentation


The RSView Supervisory Edition 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
Finding the information you need
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.

For information about searching the User’s Guide, see Adobe®


Acrobat® Reader Help.

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.

You can connect to the Rockwell Software and Rockwell Automation


web sites from within RSView Studio. To do so, you must have a web
browser installed on your computer, and you must have an active
Internet connection.

P–2 ■ RSView Supervisory Edition User’s Guide


To connect to web sites from RSView Studio

„ On the Help menu, select Rockwell Software on the Web, and then
click the name of the web page you want to view.

For information about the Rockwell Automation KnowledgeBase


and the Rockwell Software Discussion Forums, see the next
sections.

The Rockwell Automation KnowledgeBase

The KnowledgeBase web page contains a comprehensive searchable


database of support information for all Rockwell Automation and
Rockwell Software products.

Rockwell Software Discussion Forums

The Rockwell Software Discussion Forums are web pages for users of
Rockwell Software products. The forums offer discussion groups, for
exchanging tips and questions with other RSView users.

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 sites:

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

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


time (North America only), except on statutory holidays.

Preface ■ P–3
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
About RSView Studio dialog box available from the Help menu 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.

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.

P–4 ■ RSView Supervisory Edition User’s Guide


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.

When you have finished developing your application, use RSView


SE Client to view and interact with your application.

Getting started ■ 1–1


In RSView Studio,
use the Displays
editor in the
Graphics folder 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.
FactoryTalk Directory™ is software that supplies a directory of
services (for example, RSView SE Servers, or OPC servers) and names
(for example, areas, tags, graphic displays, log models, and so on) to any

1–2 ■ RSView Supervisory Edition User’s Guide


computer on the network that participates in RSView Supervisory
Edition applications.

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 stand-alone applications for parts of your plant or process


that are self-contained, and are not related to other parts of your
process.

„ 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 CorelDRAW! ™, and Adobe®
Photoshop®.

„ use the ActiveX 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 direct referencing of data server tags, the Command Wizard,
Tag Browser, and Object Smart Path™.

Getting started ■ 1–3


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

„ 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 a FactoryTalk Diagnostics log file, and


remote ODBC databases, to provide various records of production
data. You can view and manipulate the ODBC-format logged data
directly, using third-party programs such as Microsoft Access and
Seagate Crystal Reports™ 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.

Application Manager is software for moving, copying, renaming,


backing up, and restoring applications.

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.

1–4 ■ RSView Supervisory Edition User’s Guide


RSView SE Service Manager is a tool for starting and stopping
HMI servers. For example, use this tool to stop an HMI server before
copying its configuration files to a redundant server.
SE Alarm Log Setup is software for setting up RSView alarm logging.
SE Alarm Log Viewer is software for viewing the contents of alarm
log file sets.
SE Alarm Log Viewer Help is information about using the SE Alarm
Log Viewer.
Tag Import and Export Wizard is software for importing or
exporting the RSView SE Server’s tag database.

The Rockwell Software utilities

Depending on the particular software package(s) you installed, you


might have one or more of these utilities installed:
Activation Help is information about how to use Rockwell Software
activation keys.
Diagnostics Setup is software for setting up activity logging for
RSView Supervisory Edition.
Diagnostics Viewer is software for viewing the contents of
FactoryTalk Diagnostics log files.
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.
Rockwell Software Data Client is diagnostic software for use with
the assistance of Rockwell Software technical support staff.
Specify FactoryTalk Directory Location is software for specifying
which computer on your network contains the FactoryTalk Directory
service.

Getting started ■ 1–5


Support Services Help is information about how to obtain technical
support for your Rockwell Software products.

Quick Start steps

The following steps explain how to get up and running with RSView.
If you are creating a stand-alone application, skip step 3. You
must complete step 2 at a minimum before you can complete steps 5
or 6. The other steps can be completed in any order.
If you are creating a distributed application, you must complete
steps 2 and 3 at a minimum before you can complete steps 5 or 6. The
other steps can be completed in any order.

Differences between stand-alone and distributed applications are


explained wherever they occur.

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—Set up the FactoryTalk Directory


software
This step applies to distributed applications only. For stand-alone
applications, this step is completed automatically by the software.

FactoryTalk Directory is software that allows the parts of an


application to find each other on a computer, or on the network.

Decide which computer will be the FactoryTalk Directory, and then


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

1–6 ■ RSView Supervisory Edition User’s Guide


After you install RSView Supervisory Edition, and before you create an
application, 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.
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 FactoryTalk Directory without


redundancy” on page 4-4.

For details about how the FactoryTalk Directory software works, see
page 5-2.

Step 2—Create and organize an application

Create the application that operators will use at run time.

Stand-alone applications include one HMI server. You can add one or
more data servers to a stand-alone application. You cannot add areas or
HMI servers to stand-alone applications.

Distributed applications can consist of one or more areas, one HMI


server per area, and one or more data servers.

Stand-alone and distributed applications also contain 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 5, Working with distributed applications, or


Chapter 6, Working with stand-alone applications.

Step 3—Add an HMI Server

This step applies to distributed applications only. Stand-alone


applications contain one HMI server that is created automatically
when the application is created.

Getting started ■ 1–7


The HMI server stores 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).

For details, see Chapter 5, Working with distributed applications.

Step 4—Plan how you will access data

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

To access data, you need to plan two things:

„ how your application will communicate with the programmable


controllers or devices you are using.

„ once communications have been set up, how your application will
access values in the programmable controllers or devices.

Setting up communications with devices

To access values in programmable controllers or devices, you need to

„ know what kinds of controllers or devices you are using.

„ plan how your application will communicate with the controllers or


devices.

For communications with Allen-Bradley local and remote


devices, RSView provides built-in support via RSLinx Enterprise or
RSLinx for RSView.

„ If you are using RSLinx Enterprise, create a device shortcut in


RSLinx Enterprise, and then create an RSLinx data server in
RSView Studio that points at RSLinx Enterprise.

1–8 ■ RSView Supervisory Edition User’s Guide


„ If you are using RSLinx for RSView, create an OPC topic in RSLinx
for RSView, and then create an OPC data server in RSView Studio
that points at RSLinx for RSView.

For details, see Chapter 7, Setting up communications.

For communications with non-Allen-Bradley local and remote


devices, RSView supports OPC connections. OPC (OLE for
process control) allows RSView to act as a client to other OPC servers.
Set up your OPC server according to its manufacturer’s instructions,
and then set up an OPC data server in RSView. For details, see
Chapter 7, Setting up communications.

Accessing values in devices

Once your application can communicate with a device, you need to


plan how your application will access the values in the device. To access
values in a device, you can use data server tags, or HMI tags, or a
combination of both.

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.

You access these tags by specifying the tag’s address for any object
you want to connect to data, in RSView Studio. For example, in a
graphic display, you can type the tag’s address as part of an object’s
expression.

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

Getting started ■ 1–9


You access these tags by setting up an HMI server in RSView
Studio. 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 8, Working with tags.

Step 5—Set up communications using RSLinx

Either complete this step, or step 6. You need not necessarily complete
both.

Set up communications in RSLinx if you want to communicate with


Allen-Bradley devices. You can have multiple data servers accessing
topics in RSLinx in an application. Each data server can point at a
different instance of RSLinx.

To set up communications using RSLinx:

1. For each device you want to communicate with, create an OPC


topic in RSLinx.

2. Set up an OPC data server in RSView Studio. The data server


makes it possible to see the RSLinx OPC topics in RSView.

When you browse for tags in devices, the OPC topics appear in the tag
browser, each representing a device.

For details, see Chapter 7, Setting up communications.

Step 6—Set up communications for


OPC data servers

Either complete this step, or complete step 5. You need not necessarily
complete both.

Set up communications for use with OPC data servers if you want to
communicate with non-Allen-Bradley devices. You can have multiple

1–10 ■ RSView Supervisory Edition User’s Guide


OPC data servers in an application, each pointing at a different OPC
server.

To set up communications for use with OPC data servers:

1. For each device you want to communicate with, create an OPC


topic in your OPC server by following the manufacturer’s
instructions.

2. Set up an OPC data server in RSView Studio, and point it at the


OPC server you set up in the previous step.

When you browse for tags in devices, the OPC topics appear in the tag
browser, each representing a device.

For details, see Chapter 7, Setting up communications.

Step 7—Create HMI tags


If necessary, create HMI tags in any combination of these 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 8, Working with tags, and Chapter 9, Creating HMI
tags.

Getting started ■ 1–11


Step 8—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 16, Creating graphic displays.

Step 9—Set up logging

Set up activity, alarm, and data logging to have a record of what is


happening when your system is running.

Set up activity logging in the Diagnostics 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–12 ■ RSView Supervisory Edition User’s Guide


For details about setting up logging, see:

„ Chapter 11, Setting up alarms.

„ Chapter 12, Logging system activity.

„ Chapter 13, Setting up data logging.

Step 10—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 15, Setting up security.

Step 11—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 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.

Getting started ■ 1–13


„ 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 diagnostics log file Send


specific messages to the Diagnostics List and Diagnostics 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 24, Using the SE Client object model
and display code.

1–14 ■ 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.

„ adding, renaming, removing, and deleting components from


applications.

„ time-saving techniques for working in editors.

„ printing from editors.

Starting RSView Studio

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

To start RSView Studio and select a product type

1. Do one of the following:

„ Click the Start button, select Programs, and then click RSView
Studio.
„ Click the Start button, select 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


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, click the icon for the
type of application you want to create, and then click Continue.

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 SE Distributed Application dialog box.

2–2 ■ RSView Supervisory Edition User’s Guide


To open an existing application

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


Open Application
menu, click Open Application.

2. In the New/Open SE Distributed Application, or New/Open SE


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

The application appears in the Application Explorer.

To open an application you used recently

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

Exploring RSView Studio ■ 2–3


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 15-5.

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

To do this, click the Windows Start button, select Programs,


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

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

Browse devices on
the network

View your application

Diagnostics List
Status bar

2–4 ■ RSView Supervisory Edition User’s Guide


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

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

The Application tab


This tab shows the Application Explorer.

Exploring RSView Studio ■ 2–5


The Communications tab
The Communications tab allows you to browse for devices your
computer can access on the network, similar to RSWho. Use this tab
with RSLinx data servers, when setting up device shortcuts in RSLinx
Enterprise. For details, see “Adding RSLinx Enterprise data servers”
on page 7-12.

The Diagnostics List


The Diagnostics List shows system activities. You can specify the types
of activities you want to appear in the Diagnostics List, you can resize
it, move it, and clear the messages in it.

Use the Diagnostics Setup tool to select the activity categories you want
to log to the Diagnostics List. For details, see “Routing messages” on
page 12-14.

Moving the Diagnostics List

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

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

To detach the
Diagnostics List, drag
the grab bars.

To prevent the Diagnostics List from docking automatically while you


move it across the screen, hold down the Ctrl key on the keyboard
while you move the Diagnostics List.

When the Diagnostics List 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.

2–6 ■ RSView Supervisory Edition User’s Guide


To clear the most recent message in the Diagnostics List, click Clear.
To clear all the messages in the Diagnostics List, click Clear All.

Messages in the Diagnostics List

The types of messages that appear in the Diagnostics List depend on


what is specified in the Diagnostics Setup tool.

Diagnostics 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 you can display
in the Diagnostics List, see “Message routing” on page 12-3.

The status bar


The status bar provides different kinds of information depending on
where the pointer is and what RSView Studio 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:

Exploring RSView Studio ■ 2–7


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 Diagnostics
List and Application
Explorer are hidden.
Workbook mode is off.

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

Components are listed


below the editor’s icon

Click the + symbol to


open a folder

2–8 ■ RSView Supervisory Edition User’s Guide


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.

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.

Exploring RSView Studio ■ 2–9


Folders
The Application Explorer uses folders to organize editors. To open or
close a folder, do one of the following:

„ Click the + or – 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.

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 context menu, and then
click New or Open.
Right-click to view the
context menu.

If you can use the editor to create multiple components, the context
menu contains New. If the editor can open only a single component,
the context menu contains Open.

The following table describes each editor.


Use this editor To

Diagnostics Setup Specify the type of system activity you want to log
(Tools menu) and where, when, and how you want it logged.

The settings you specify using this editor apply


only to the computer you are using.

To access this editor, click the Tools menu in


RSView Studio.

2–10 ■ RSView Supervisory Edition User’s Guide


Use this editor To

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

The settings you specify using this editor apply


only to the computer you are using.

To access this editor, click the Tools menu in


RSView Studio.
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.
Command Line Open a command line for entering RSView
commands.
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 you want 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.
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.

Exploring RSView Studio ■ 2–11


Use this editor To

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 Re-map 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.

2–12 ■ RSView Supervisory Edition User’s Guide


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.

Exploring RSView Studio ■ 2–13


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 context menu, and then


click Open.

Right-click to view the


context menu.

For information about renaming, removing, and deleting components,


see page 2-16.

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 context menu in the Application Explorer.

When you add a component in the Application Explorer using the Add
Component into Application option, you are creating a copy of the file
in the application.

2–14 ■ RSView Supervisory Edition User’s Guide


To add a component using drag and drop

X 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 context 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 context menu, click Add Component into Application.

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.

Exploring RSView Studio ■ 2–15


Renaming, removing, and deleting components

Use the items on the context 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

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


click Rename.

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

3. Click OK.

If you change the name of a file that is referenced by an HMI project,


the component (reference to the file) cannot be opened. You must

2–16 ■ RSView Supervisory Edition User’s Guide


remove the component, and then add the component into the HMI
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 context menu, click Add
Component Into Application.

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

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 context 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

X 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 context menu. Deleting a component deletes both the file reference
and the physical file from disk.

To delete a component and file

X Right-click the component and then click Delete.

Exploring RSView Studio ■ 2–17


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.

2–18 ■ RSView Supervisory Edition User’s Guide


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 context menus

The Application Explorer and the Graphic Displays editor use context
menus. To open a context 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 open
Browse button 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

X 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 run time.

„ Click the Browse button or Tags button, whichever is available,


to open the Tag Browser, where you can select, or create a tag.

For detailed information about tags, see Chapter 8, Working with tags.

Exploring RSView Studio ■ 2–19


Using RSView commands

Many editors require an RSView command. Commands allow you to


control RSView at run time. 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 Command Wizard

X Do one of the following:

„ Click the Browse button beside any action field or in the


command line.

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

2–20 ■ RSView Supervisory Edition User’s Guide


For detailed information about RSView commands, see Appendix A,
RSView commands.

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 20, 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.

Exploring RSView Studio ■ 2–21


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 run time.

The settings in the Print Setup dialog box do not affect


run-time log printing set up in the Alarm Setup editor.

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.

2–22 ■ RSView Supervisory Edition User’s Guide


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 run time


You can also 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. For information about creating graphic displays, see
Chapter 16, 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.

Exploring RSView Studio ■ 2–23


3
Chapter

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

„ understanding the process you’re automating.

„ planning the layout of your network.

„ planning redundant systems.

„ planning communications.

„ designing an HMI tag database.

„ planning alarms.

„ collecting data.

„ designing graphic displays.

„ using trends.

„ designing a secure system.

„ customizing the system and integrating with other applications.

„ designing a system to be used by multiple users, simultaneously.

„ designing a system that is easy to deploy and maintain

Understanding the process

Gather information from a variety of sources so you have a complete


and detailed understanding of the process you’re automating.

Planning an application ■ 3–1


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—OPC, or


DDE communications.

„ determine which process variables need to be accessed and identify


their locations in the programmable controllers.

Planning the layout of your network

When planning a distributed application, pay careful attention to the


layout of your network.

The Windows domain or workgroup


For ease of network and user administration, a domain controller is
recommended. All computers participating in a single application must
be members of the same Windows NT or Windows 2000 domain.

Alternatively, RSView Supervisory Edition can be used in a Windows


workgroup environment. In this case, all computers participating in a
single application must be members of the same Windows workgroup,
and all computers must have administrative rights.

The computers you’ll need


You can develop a distributed application on a single computer, and
you can run it on a single computer for testing purposes. However, at

3–2 ■ RSView Supervisory Edition User’s Guide


run time, depending on your needs, a distributed application typically
runs on the following computers:
One or more redundant pairs of computers running FactoryTalk
Directory FactoryTalk Directory is software that works like a
telephone directory or electronic address book, allowing the parts of an
application to find each other on a computer, or on the network.

All computers that participate in the distributed application must point


at the same computer running FactoryTalk Directory.

You can set up multiple FactoryTalk Directory computers, if your


application requires it.

For details, see Chapter 4, Setting up FactoryTalk Directory.


One or more redundant pairs of computers running the RSView
SE Server The 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).

You can add HMI servers to your application, up to a maximum of five


on a single computer, or ten in your application, in total.

For details, see Chapter 5, Working with distributed applications.


One or more redundant pairs of computers running data
servers Data servers allow clients to access information in
programmable controllers, devices, and other data servers that comply
with the OPC-DA 2.0 specification.

You can add as many data servers to your application as you need.

If your application includes a large number of tags and you are not
using RSLinx for RSView or RSLinx Enterprise for communications,
you should place your OPC data server in a different area than the one
in which your HMI server is located. This provides best performance
when accessing data in a large number of tags. RSLinx for RSView and
RSLinx Enterprise are optimized to provide best performance, even if
located in the same area as the HMI server.

Planning an application ■ 3–3


For details about data servers, see Chapter 7, Setting up communications.

One or more development computers, running RSView


Studio RSView Studio is configuration software for developing and
testing machine- and supervisory-level human-machine interface
(HMI) applications.

For details, see the topics in this manual. For details about developing
RSView Machine Edition applications, see the RSView Machine Edition
User’s Guide.

One or more run-time client computers, running the RSView


SE Client RSView SE Client is software for viewing and interacting
with supervisory-level applications developed using RSView Studio.

For details about setting up RSView SE Clients, see page 26-14.

Optionally, your network might also include:

One or more administration computers, running the RSView


Administration Console The RSView Administration Console is
software for administering RSView Supervisory Edition applications
after they have been deployed. The 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.

For details, see Chapter 28, Administering applications.

The network is scalable

Using the schema outlined above, you can scale your network to any
size you need, by adding as many computers as you need, running each
of the pieces of software described above, subject to the limits
described above.

The number of software programs you can run concurrently is also


limited by the activation keys you purchased with your software, and
the maximum number limited by the application or the software itself.

3–4 ■ RSView Supervisory Edition User’s Guide


System requirements and installation
For details about determining system requirements and installing
software, see the RSView Supervisory Edition Installation Guide.

Planning redundancy
In theory, the ideal redundant solution involves having at least one copy
of everything—hardware, software, networks, and so on. In practice,
this is seldom feasible, or even necessary.

Before setting up redundancy, plan:

„ which components in your system need to be made redundant—in


other words, decide how much redundancy you need.

„ where (on what computers) you want to locate backup systems.

„ your network layout, and calculate the processing load you expect
for each computer. This information can help you plan what parts
of your application can share hardware. For example, you might
decide to have four secondary HMI servers run on a single
computer. Or, you might decide to structure your distributed
application so that if the HMI network fails, the application
continues running on the computer as a set of stand-alone
applications.

You can set up redundancy for:

„ FactoryTalk Directory

„ HMI servers

„ data servers

„ alarm log files

„ data log files

„ system activity log files (also called FactoryTalk Diagnostics log


files)

Planning an application ■ 3–5


RSView Supervisory Edition provides built-in warm redundancy for
FactoryTalk Directory, HMI servers, and data servers.

You can set up RSView Supervisory Edition to send alarm and data log
information automatically to an ODBC-compliant database. You can
set up an HMI server to buffer data locally if the database becomes
unavailable.

Set up redundancy separately for system activity logging, using the


Diagnostics Setup utility.

Planning communications
When planning communications, gather information about the types
of controllers or devices in your plant, and the software you have
available for communicating with them. This will help you set up one
or more OPC servers.

Next, plan how you want the programmable controllers on your


network to communicate with your application. This will help you plan
the number of OPC servers you need, and the number of data servers
you need in your application.

Also plan how you will access data in the controllers or devices. For
most purposes you can access the values in controllers or devices
directly, using tags provided by a data server in your application.

For certain special purposes, however, 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

3–6 ■ RSView Supervisory Edition User’s Guide


controller devices, by changing the physical addresses to which tag
names are mapped.

Finally, plan what redundant systems you need to minimize disruptions


to clients in the event that access to data becomes unavailable. This will
help you plan what redundant data server pairs you need.

For details about setting up communications in RSView, see Chapter 7,


Setting up communications.

For details about setting up communications in RSLinx, see Getting


Results with RSLinx, or see Help for RSLinx.

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

„ A list of programmable controller data table or register addresses


your project will be accessing.

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


page 3-8).

Planning an application ■ 3–7


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.

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.

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.

3–8 ■ RSView Supervisory Edition User’s Guide


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.

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.

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:

„ the company logo.

„ a title.

Planning an application ■ 3–9


„ the 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.

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

3–10 ■ RSView Supervisory Edition User’s Guide


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?

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 whether limited access is enough.

„ restrict access to certain parts of the plant.

„ have everyone log on.

Planning an application ■ 3–11


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.

Customizing the system


You can use the RSView SE Client object model to customize your
system in the following ways:

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

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

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

Manipulate the RSView SE Client window Write VBA code to


arrange graphic displays based on the size of the RSView SE Client

3–12 ■ RSView Supervisory Edition User’s Guide


window. This allows you to adapt your application dynamically to
various screen desktop sizes and resolutions.

Send custom messages to the Diagnostics log file Send specific


messages to the Diagnostics List, and Diagnostics log file, to notify the
operator of problems with VBA code.

Secure the system The RSView 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 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.

Planning an application ■ 3–13


Designing a system that is easy to deploy
and maintain
RSView Supervisory Edition includes tools and features to help you
build ease of maintenance into your application in these ways:

„ Create special graphic displays to help deployment and


maintenance personnel test your application.

„ Link parts of your HMI application to logic in your programmable


controller using the OpenRSLogix5000 command.

For example, by linking actions performed in RSView to Sequential


Function Charts (SFCs) in RSLogix 5000, you can help operators
track the state of processes that are running in your plant.

Because Sequential Function Charts are graphical representations


of batch procedures, actions in RSView that are linked to
RSLogix 5000 programs could also be used frequently by operators
who monitor the progress of batch procedures.

For details about the OpenRSLogix5000 command, see


Appendix A, RSView commands.

3–14 ■ RSView Supervisory Edition User’s Guide


4
Chapter

Setting up FactoryTalk
Directory
This chapter describes:

„ the FactoryTalk Directory software, and how to set it up.

„ how to set up redundancy for computers running FactoryTalk


Directory.

About FactoryTalk Directory


FactoryTalk Directory is software that works like a telephone directory,
or electronic address book, allowing the parts of an application to find
each other on a computer, or on the network.

Setting up FactoryTalk Directory ■ 4–1


For example, to access graphic displays on HMI servers in the
application, HMI clients use FactoryTalk Directory to find out which
computers on the network are hosting HMI servers.

You can set up your network so that multiple applications share a single
FactoryTalk Directory, or so that there are multiple FactoryTalk
Directory computers for multiple applications.

Multiple applications, one FactoryTalk Directory computer

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. All of the
computers that connect to the application must also be in the same
Windows domain or workgroup.

Multiple applications, multiple FactoryTalk Directory


computers

Your network can also contain more than one computer running the
FactoryTalk Directory software. This is useful if you want to:

„ run multiple applications that are separated by a slow network, for


example a wide-area network (WAN).

To do this, set up one FactoryTalk Directory at each site on either


side of the WAN.

„ balance the network and processing load of very large applications


for better performance.

To do this, each application can be in a different FactoryTalk


Directory, so that network requests can be routed to multiple

4–2 ■ RSView Supervisory Edition User’s Guide


computers, and so that a single computer does not have to manage
the processing load of all the requests to the FactoryTalk Directory.

„ eliminate a single point of failure on your network.

On a network with multiple applications running, each application


can be in a different FactoryTalk Directory. If one FactoryTalk
Directory computer fails, only one application is affected. You can
also set up redundant FactoryTalk Directory computers, so the
application is affected only for as long as it takes to switch to the
redundant FactoryTalk Directory.

IMPORTANT Each computer on the network can connect to only one


computer running the FactoryTalk Directory software.
You cannot connect computers to multiple FactoryTalk
Directory computers simultaneously.

About FactoryTalk Directory redundancy


If FactoryTalk Directory becomes unavailable while an application is
running, the application will continue to run correctly, and be able to
read and write values, acknowledge alarms, open and close displays, and
so on, even if no redundant FactoryTalk Directory is present on the
network. This is because a copy of the information provided by
FactoryTalk Directory is stored locally on each computer that is
connected to the FactoryTalk Directory computer.

However, while FactoryTalk Directory is disconnected, you cannot


modify an application’s structure—for example, you cannot add or edit
an area, a data server, or an HMI server.

Setting up FactoryTalk Directory ■ 4–3


To ensure that you can modify an application’s structure while
FactoryTalk Directory is unavailable, you can set up a redundant
computer running FactoryTalk Directory. For details, see page 4-8.

IMPORTANT If changes were made to the primary or secondary


FactoryTalk Directory, the changes must be copied
manually from one to the other, and then the computer
must be restarted. For details, see “Copying FactoryTalk
Directory files” on page 26-4.

How RSView Studio, or the Administration Console respond


to server disruptions

During server disruptions, users do not have to restart their RSView


Studio, or Administration Console software to continue using the
system. Once the system has switched to the redundant FactoryTalk
Directory, HMI server, or data server, RSView Studio and the
Administration Console continue functioning normally.

Setting up FactoryTalk Directory without redundancy


To set up FactoryTalk Directory with redundancy, see “Setting up
redundancy for FactoryTalk Directory” on page 4-8.

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 specify which computer on the
network is running FactoryTalk Directory.

Run the utility called Specify FactoryTalk Directory Location on each


computer you want to have access to your distributed applications.

For details about how FactoryTalk Directory works, see “FactoryTalk


Directory” on page 5-2.

4–4 ■ RSView Supervisory Edition User’s Guide


Summary of steps
To set up FactoryTalk Directory, complete the following steps. For
stand-alone applications, skip steps 1 and 3.

1. For distributed applications, decide which computer on your


network will run the FactoryTalk Directory software.

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 determining system requirements and installing


software, see the RSView Supervisory Edition Installation Guide.

3. On every computer that you want to have access to your


applications, run the utility called Specify FactoryTalk Directory
Location. For details, see the sections that follow.

Specifying the FactoryTalk Directory location


for stand-alone applications
For stand-alone applications, FactoryTalk Directory is set up
automatically. You do not need to set it up.

The setting specified in the utility called Specify FactoryTalk Directory


Location is ignored, and is set to This Computer by default.

Setting up FactoryTalk Directory ■ 4–5


Setting up the FactoryTalk Directory Server
computer for distributed applications
1. Click the Start button, select Programs, Rockwell Software,
Utilities, and then click Specify FactoryTalk Directory Location.

To change the
location of the
primary server,
click the Browse
button.

2. Do one of the following:

„ If the Primary Directory Server is set to localhost, click OK,


and then skip to step 7.
„ If the Primary Directory Server is not set to localhost, click the
Browse button.
3. In the FactoryTalk Directory Server Configuration dialog box,
click This computer, and then click OK.

4. Restart the computer.

4–6 ■ RSView Supervisory Edition User’s Guide


Setting up the other computers on the
network for distributed applications
1. Click the Start button, select Programs, Rockwell Software,
Utilities, and then click Specify FactoryTalk Directory Location.

To change the
location of the
primary server,
click the Browse
button.

2. Click the Browse button for the Primary Directory Server.

3. In the FactoryTalk Directory Server Configuration dialog box, do


the following:

a. Click Remote computer.

b. Type the name of the primary computer on which the


FactoryTalk Directory software is running, and then click OK.

4. Restart the computer.

Setting up FactoryTalk Directory ■ 4–7


Setting up redundancy for FactoryTalk Directory
You cannot set up redundant operation for FactoryTalk Directory in
stand-alone applications. This section applies to distributed
applications only.

You can set up redundant operation for FactoryTalk Directory, to


provide minimal disruption of system operation in the event that
clients lose service from a server, for example because of network or
computer failures.

Summary of steps
To set up redundancy, complete these steps:

1. On the computer on which the redundant copy of FactoryTalk


Directory will run, do the following:

a. Install the FactoryTalk Directory software. For details, see the


RSView Supervisory Edition Installation Guide.

b. Copy the FactoryTalk Directory files from the primary


FactoryTalk Directory computer. For details, see “Copying
FactoryTalk Directory files” on page 26-4.

c. Run the utility called Specify FactoryTalk Directory Location,


on both computers, and then specify the locations of primary
and secondary FactoryTalk Directory computers. For details,
see the next section.

2. On every other computer on the network that you want to have


access to the secondary FactoryTalk Directory computer, run the
utility called Specify FactoryTalk Directory Location. Specify the
names of the primary and secondary FactoryTalk Directory
computers. For details, see “Setting up the other computers on the
network” on page 4-13.

4–8 ■ RSView Supervisory Edition User’s Guide


Setting up the FactoryTalk Directory server
computers

The primary and secondary FactoryTalk Directory cannot be located


on the same computer.

To set up the primary FactoryTalk Directory computer

1. Click the Start button, select Programs, Rockwell Software,


Utilities, and then click Specify FactoryTalk Directory Location.

To change the
location of the
primary server,
click the Browse
button.

2. Do one of the following:

„ If the Primary Directory Server is set to localhost, click OK,


and then skip to step 7.

„ If the Primary Directory Server is not set to localhost, click the


Browse button.

3. In the FactoryTalk Directory Server Configuration dialog box,


click This computer, and then click OK.

Setting up FactoryTalk Directory ■ 4–9


4. Select the check box, Enable redundancy via a secondary location.

To specify the
location of the
secondary
server, click the
Browse button.

5. Click the Browse button for the Backup Directory Server.

6. In the FactoryTalk Directory Server Configuration dialog box, do


the following:

a. Click Remote computer.

b. Type the name of the secondary computer on which the


FactoryTalk Directory software is running, and then click OK.

7. Restart the computer.

4–10 ■ RSView Supervisory Edition User’s Guide


To set up the secondary FactoryTalk Directory computer

1. Click the Start button, select Programs, Rockwell Software,


Utilities, and then click Specify FactoryTalk Directory Location.

To change the
location of the
primary server,
click the Browse
button.

2. Click the Browse button for the Primary Directory Server.

3. In the FactoryTalk Directory Server Configuration dialog box, do


the following:

a. Click Remote computer.

b. Type the name of the primary computer on which the


FactoryTalk Directory software is running, and then click OK.

Setting up FactoryTalk Directory ■ 4–11


4. Select the check box, Enable redundancy via a secondary location.

To specify the
location of the
secondary
server, click the
Browse button.

5. Click the Browse button for the Backup Directory Server.

6. In the FactoryTalk Directory Server Configuration dialog box,


click This computer, and then click OK.

7. Restart the computer.

4–12 ■ RSView Supervisory Edition User’s Guide


Setting up the other computers on the
network
1. Click the Start button, select Programs, Rockwell Software,
Utilities, and then click Specify FactoryTalk Directory Location.

To change the
location of the
primary server,
click the Browse
button.

2. Click the Browse button for the Primary Directory Server.

3. In the FactoryTalk Directory Server Configuration dialog box, do


the following:

a. Click Remote computer.

b. Type the name of the primary computer on which the


FactoryTalk Directory software is running, and then click OK.

Setting up FactoryTalk Directory ■ 4–13


4. Select the check box, Enable redundancy via a secondary location.

To specify the
location of the
secondary
server, click the
Browse button.

5. Click the Browse button for the Backup Directory Server.

6. In the FactoryTalk Directory Server Configuration dialog box, do


the following:

a. Click Remote computer.

b. Type the name of the secondary computer on which the


FactoryTalk Directory software is running, and then click OK.

7. Restart the computer.

4–14 ■ RSView Supervisory Edition User’s Guide


5
Chapter

Working with
distributed applications
This chapter describes:

„ distributed applications and their components.

„ creating, renaming, and deleting distributed applications.

„ structuring distributed applications.

„ adding and removing HMI servers.

About distributed applications


In RSView Studio you can create two kinds of supervisory-level
applications: stand-alone applications, or distributed applications.

In distributed applications, the software programs that allow a


distributed application to run can each be located on a different
computer on the network. These software programs include, for
example, FactoryTalk Directory, the HMI server, the HMI client,
OPC data servers, and so on.

In stand-alone applications, these software programs must be located


on the same computer. For details about stand-alone applications, see
Chapter 6, Working with stand-alone applications.

Working with distributed applications ■ 5–1


Key concepts

HMI server, HMI project, HMI client


HMI servers are software programs that supply information to clients
when they request it. 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 by 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.

FactoryTalk Directory
FactoryTalk Directory is software that allows the parts of an
application to find each other on a computer, or on the network.

For example, to access graphic displays on HMI servers in the


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

Multiple applications, one FactoryTalk Directory computer

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. All of the

5–2 ■ RSView Supervisory Edition User’s Guide


computers that connect to the application must also be in the same
Windows domain or workgroup.

Multiple applications, multiple FactoryTalk Directory


computers

Your network can also contain more than one computer running the
FactoryTalk Directory software. This is useful if you want to

„ run multiple applications that are separated by a slow network, for


example a wide-area network (WAN).

To do this, set up one FactoryTalk Directory at each site on either


side of the WAN.

„ balance the network and processing load of very large applications


for better performance.

To do this, each application can be in a different FactoryTalk


Directory, so that network requests can be routed to multiple
computers, and so that a single computer does not have to manage
the processing load of all the requests to the FactoryTalk Directory.

„ eliminate a single point of failure on your network.

On a network with multiple applications running, each application


can be in a different FactoryTalk Directory. If one FactoryTalk
Directory computer fails, only one application is affected. You can
also set up redundant FactoryTalk Directory computers, so the
application is affected only for as long as it takes to switch to the
redundant FactoryTalk Directory.

IMPORTANT Each computer on the network can connect to only one


computer running the FactoryTalk Directory software.
You cannot connect computers to multiple FactoryTalk
Directory computers simultaneously.

Working with distributed applications ■ 5–3


Application, area, data server

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. You can set up a redundant pair of host computers
for each 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.

„ data servers, that allow clients to access information in


programmable controllers, devices, and other data servers that
comply with the OPC-DA 2.0 specification, without the use of
HMI tags. You can set up a redundant pair of host computers for
each data server.

Examples of the information provided by data servers are:

„ temperature values from sensors.

„ text strings such as bar codes, from scanners.

„ a gateway to tag databases that exist in programmable controllers


themselves.

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 or addresses that exist in
controllers themselves, as is the case with RSLinx and ControlLogix.

5–4 ■ RSView Supervisory Edition User’s Guide


About FactoryTalk Directory redundancy

For information about how FactoryTalk Directory redundancy works,


see “Planning redundancy” on page 3-5.

You can set up redundant operation for FactoryTalk Directory, to


provide minimal disruption of system operation in the event that
clients lose service from a server, for example because of network or
computer failures.

For details, see “Setting up redundancy for FactoryTalk Directory” on


page 4-8.

How RSView SE Clients respond to server disruptions

During server disruptions, users do not have to restart their RSView SE


Client software to continue using the system. Once the system has
switched to the redundant FactoryTalk Directory, HMI server, or data
server, RSView SE Clients continue functioning normally.

About HMI-server redundancy

You can set up redundant operation for HMI servers, to provide


minimal disruption of system operation in the event that clients lose
service from a server, for example because of network or computer
failures.

For information about how HMI-server redundancy works, see


“Planning redundancy” on page 3-5.

Viewing the operational status of HMI servers

You can see the operational status of primary and secondary HMI
servers by clicking the General tab in the HMI Server Properties dialog
box of either the primary or the secondary server.

Working with distributed applications ■ 5–5


There are four possible states for an HMI server:

The operational status of


primary and secondary
HMI servers is shown here.

„ Active means that the server is running, and able to serve data to
clients that connect to it.

„ Standby means that the server is running, and will replace the
active server if the active server fails.

„ Out of service means that the server has been created, but cannot
be contacted.

For details about loading the primary server automatically when


Windows starts, see “Setting up the HMI server’s general
properties” on page 5-23.

For details about loading the server manually, see “Starting and
stopping an HMI server’s components manually” on page 26-9.

„ Unknown applies to the secondary server only. Unknown means


that the secondary server has not been created yet.

How RSView SE Clients respond to server disruptions

During server disruptions, users do not have to restart their RSView SE


Client software to continue using the system. Once the system has
switched to the redundant FactoryTalk Directory, HMI server, or data
server, RSView SE Clients continue functioning normally.

5–6 ■ RSView Supervisory Edition User’s Guide


File synchronization

While the server is active, changes made to files (for example,


configuration files, or log files) are not automatically synchronized with
the server’s redundant pair.

If required, the files must be synchronized manually after the changes


are made. You can do this by copying the files using Windows Explorer.

For details, see “Synchronizing the secondary HMI server


with the primary server” on page 26-12.

Alarm state synchronization

For alarm states to be synchronized properly, the clocks on the primary


and secondary HMI servers must be kept synchronized to a time
server. If the clocks on both computers are not synchronized, when
fail-over occurs multiple alarms or inconsistent information might be
displayed in an alarm summary.

About data-server redundancy


You can set up redundant operation for data servers, to provide
minimal disruption of system operation in the event that clients lose
service from a server, for example because of network or computer
failures.

How RSView SE Clients respond to server disruptions

During server disruptions, users do not have to restart their RSView SE


Client software to continue using the system. Once the system has
switched to the redundant FactoryTalk Directory, HMI server, or data
server, RSView SE Clients continue functioning normally.

Working with distributed applications ■ 5–7


How stand-alone and distributed
applications differ

In RSView Studio you can create two kinds of supervisory-level


applications: stand-alone applications, or distributed applications.

Stand-alone applications are different from distributed applications in


the following ways:

Stand-alone applications are located on a single computer only.


You cannot access HMI servers located on remote computers from a
stand-alone application. Only application components located on the
same computer are accessible to a stand-alone application. However,
you can add data servers that are located on remote computers to a
stand-alone application.

Stand-alone applications cannot contain areas, or multiple HMI


Stand-alone applications have only one default HMI server.
servers.
The HMI server has the same name as the application.

More about areas

In distributed applications, the use of areas is optional. You cannot


create areas in stand-alone applications.

In distributed applications, 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 would allow you

5–8 ■ RSView Supervisory Edition User’s Guide


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

IMPORTANT An absolute reference to an application’s root area does


not include the application’s name, even though the
application’s name appears in the root area in RSView
Studio. For example, to refer to the root area of the
application called Samples Water, use /:: not
/Samples Water::. For details about absolute references,
see “Absolute and relative references” on page 5-10.

The home area

In distributed applications, 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.

Working with distributed applications ■ 5–9


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.

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 all the areas that contain 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.

For example, a relative reference to a display called Detail is simply the


display’s name: Detail.

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. The relative reference is simply
the tag’s name: 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.

5–10 ■ RSView Supervisory Edition User’s Guide


If the tag Temp does not exist in the AssemblyLineSouth area, an error
appears in the FactoryTalk Diagnostics List.

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 5-16.

Use absolute or relative references when building commands, or when


connecting graphic objects to tags.

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 in distributed applications

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 in the button’s press action, 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.

Working with distributed applications ■ 5–11


„ 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 “Using tag references” on page 8-19.

For information about using absolute and relative references with


commands, see page A-6.

Basic steps for developing an application


For an overview of the basic steps you need to follow to develop an
application, see “Quick Start steps” on page 1-6.

Activities when deploying an application


For an overview of the activites you need to perform to deploy an
application, see page 26-1.

Setting up FactoryTalk Directory


FactoryTalk Directory is software that allows the parts of an
application to find each other on a computer, or on the network.

For details about how the FactoryTalk Directory software works, see
page 5-2.

For details about setting up the FactoryTalk Directory software, see


page 4-4.

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

5–12 ■ RSView Supervisory Edition User’s Guide


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.

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


application you want to create:

„ To create a distributed application, double-click the SE


Distributed icon.

„ To create a stand-alone application, double-click the SE Stand-


alone icon.

Working with distributed applications ■ 5–13


3. In the New/Open SE Distributed Application dialog box, type a
name and description for the application.

For example, use the Description box to describe an application’s


location, to identify a contact person or number in the event of
failure, or to keep track of changes or version information.

The application name can be


up to 32 characters long.

After you create a new application, the Application Explorer appears


displaying the name of the application.

Renaming an application
You cannot rename a distributed application that is in use. Ensure that
all users disconnect from the application first.

To rename an application

X Click the Start button, select Programs, Rockwell Software, RSView


Enterprise, Tools, and then click Application Manager.

For details about using the Application Manager tool, click Help.

5–14 ■ RSView Supervisory Edition User’s Guide


Deleting an application
You cannot delete a distributed application that is in use. 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 5-30. For details
about removing a data server, to delete its cache files, see page 7-17.

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 3, below).

2. Click the Start button, select Programs, Rockwell Software,


RSView Enterprise, Tools, and then click Application Manager.

For details about using the Application Manager tool, click Help.

3. To delete the application’s HMI server files, see page 5-30.

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.

Working with distributed applications ■ 5–15


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.

Adding HMI servers or data servers

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

If you want to provide redundant operation for HMI servers or data


servers at run time, you must install each HMI server or 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 server tags to the new data server. This distributes the

5–16 ■ RSView Supervisory Edition User’s Guide


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.

Adding HMI servers or data servers for redundant operation

You can set up redundant HMI servers or data servers to enable your
application to use a secondary server in the event that the primary
server goes out of service.

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

„ For details about adding HMI servers to your application, see


page 5-18.

„ For details about adding data servers to your application, see


page 7-7.

„ For details about setting up redundant operation for FactoryTalk


Directory, see page 4-8.

Adding and removing areas


You cannot add areas to stand-alone applications. You cannot copy
areas in distributed applications.

Working with distributed applications ■ 5–17


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, select New, and then click Area.
2. In the New Area dialog box, type a name for the area. You can also
type a description for the area.

For example, use the Description box to describe the location, to


identify a contact person or number in the event of failure, or to
keep track of changes or version information.

3. Click OK

To remove an area

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

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

Adding HMI servers


You can add an HMI server to your application by:

„ creating a new HMI server.

„ copying an existing HMI server.

„ importing a project from RSView32, RSView Supervisory Edition,


or RSView Machine Edition.

„ attaching to an existing HMI server without copying it.

Limitations on the number of servers


In distributed applications, each area can contain only one HMI server.

5–18 ■ RSView Supervisory Edition User’s Guide


Each computer on which the RSView SE Server is installed can have
no more than five HMI servers running on it. If your distributed
application needs more than five HMI servers, install them on more
than one computer.

Your distributed application cannot contain more than a total of ten


HMI servers.

Naming restrictions
The names of HMI servers are stored by FactoryTalk Directory, and
are not deleted, even if you remove an HMI server from all
applications in which it is used and then delete the HMI server’s
project files.

The name of every HMI server must be unique. This means that:

„ You cannot re-use a name for an HMI server, even after you have
deleted the HMI server.

„ If multiple users share the same FactoryTalk Directory, the names


of all HMI servers created by all users must be unique. Similarly, if
multiple applications share the same FactoryTalk Directory, the
name of each HMI server in each application must be unique.

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.

The Add HMI Server wizard appears.

Working with distributed applications ■ 5–19


2. Click one of the operations. For details about the operations, see
the topics below.

3. Click Next.

4. Follow the instructions on the screen to complete the wizard.

When you are finished adding your HMI server, you can set up the
HMI server’s properties. For details, see page 5-22.

Creating a new HMI server

If you want to create a new HMI server that is not based on an existing
HMI server, HMI project, or RSView32 application, click Create a
new HMI server.

When you create an HMI server, the server’s HMI project is created
automatically.

Copying an HMI server

To make a copy of an existing HMI server, click Copy an HMI server.

After you have copied an HMI server, changes made to the original do
not affect the copy, or vice versa.

5–20 ■ RSView Supervisory Edition User’s Guide


Importing a project from RSView32, SE, or ME
To use a project from RSView32, RSView Supervisory Edition, or
RSView Machine Edition as the basis for a new HMI server, click
Import a project.

After you have copied a project into the new HMI server, changes
made to the original project do not affect the copy, or vice versa.

Attaching to an existing HMI server


To connect to an existing HMI server without making a copy of the
HMI server, click Attach to an existing HMI server.

IMPORTANT You cannot attach to an existing HMI server if the HMI


server is used in another application.

Setting up redundant HMI servers


To set up a redundant HMI server, complete these steps:

1. Install the RSView SE Server on the computer you want to host


the redundant HMI server. For details, see the RSView Supervisory
Edition Installation Guide.

2. Copy the HMI project files from the primary HMI server to the
secondary HMI server. For details, see “Copying HMI server
files” on page 26-4.

3. Set up the properties of the secondary HMI server. For details, see
the next section.

Working with distributed applications ■ 5–21


Setting up HMI server properties
After you have added an HMI server to your application, you need to
set up the HMI server. 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.

„ specify the name of a second computer that hosts a redundant HMI


server, for minimal disruption if the primary HMI server fails.

„ start or stop components manually.

„ view the HMI server’s name, project file path, number of existing
graphic displays, and the maximum number of graphic displays
allowed on the HMI server.

„ if you have set up redundancy, view the status of primary and


secondary HMI servers.

You must set up the properties of each HMI server separately in a


distributed application.

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, fill in the fields in each
tab, as described in the sections that follow. When you are finished,
click OK.

5–22 ■ RSView Supervisory Edition User’s Guide


Setting up the HMI server’s general
properties
In the General tab, type a description for the HMI server, specify the
name of the computer running the HMI server, and specify when the
HMI server should start.

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. For example, use this box to describe a
component’s location, to identify a contact person or number in the
event of failure, or to keep track of changes or version information.

Working with distributed applications ■ 5–23


Computer hosting the server The name of the computer that is
hosting the HMI server. Type a computer name, or click the browse
Browse button button to 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 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 HMI
server’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 be loaded:

On demand The HMI server is loaded when the first client is


opened, and is unloaded when the last client is closed.

When the HMI server is loaded, you can edit the server’s HMI
project using RSView Studio, and you can connect clients to the
HMI server. 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 and run startup components when operating system


initializes The HMI server is loaded into memory when
Windows starts, and the HMI server’s startup components run.
This option is for normal use at run time.

This option allows clients to connect quickly, and ensures that the
HMI server can be brought back to normal operation automatically
if the computer on which it is running is restarted.

5–24 ■ RSView Supervisory Edition User’s Guide


If you are setting up redundancy for an HMI server, and choose not
to run components when the servers start up, you can specify
macros to start the components only when the server is the active
server. For details, see “On active macro” on page 5-28. For details
about creating macros, see Chapter 22, Creating macros.

The HMI server can only be unloaded by changing the Startup type
to On demand, and then closing all clients.

Because the HMI server runs as a service, users do not have to log
in to make the HMI server run.

Setting up HMI server redundancy


To minimize disruptions to clients if the primary HMI server fails, set
up a redundant HMI server. In RSView, the redundant server is called
the secondary server.

In the Redundancy tab, specify the name of the computer hosting the
secondary HMI server.

When the primary HMI server becomes available again, the system
automatically switches back to the primary server.

Working with distributed applications ■ 5–25


Provide redundancy using a secondary server Select this check
box to enable redundancy for this HMI server. Clear this check box to
disable redundancy for this HMI server.

This option is available only if the HMI server startup type is set to
Load and run startup components when operating system initializes.
For details about the HMI server’s startup type, see page 5-24.

Computer hosting the server Type the name of the computer


hosting the secondary HMI server. To browse for the name of the
computer, click the Browse button.

Specifying the HMI server’s startup and


shutdown components
Use the Components tab to specify:

„ which components will run when the HMI server starts.

„ which macros will run when the HMI server shuts down.

„ which macros will run when switching to the secondary HMI


server, or back to the primary HMI server.

The HMI server can be started automatically when the operating


system starts, or manually. For details about starting the HMI server
manually, see page 26-9.

IMPORTANT The order in which items appear in the Components tab


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.

5–26 ■ RSView Supervisory Edition User’s Guide


Select the check box for each of the following items you want to run
when the HMI server runs. Where required, specify the component
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 <component> command. Up to 20 data
log model files can run simultaneously, but only one can be specified in
the Components tab. To run more files, list them in a startup macro.

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
Components tab. To run more files, list them in a startup macro.

Events Runs the specified event component. This is the same as using
the EventOn <component> command. Up to 20 event components can

Working with distributed applications ■ 5–27


run simultaneously, but only one component can be specified in the
Components tab. To run more files, list them in a startup macro.
Macro Runs the specified macro when the HMI server starts. This
macro allows you to run a series of commands when the HMI server
runs. You can run any macro when the HMI server starts.
On 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 On shutdown macro.
On active macro Runs the specified macro when the HMI server
becomes active. An HMI server can become active if another HMI
server fails. Any macro can be used as the On active macro.

If you have not set up a secondary server in the Redundancy tab, this
option is not available.
On standby macro Runs the specified macro when the HMI server
switches from being active to being on standby. This most frequently
happens when the system switches back from the secondary HMI
server to the primary HMI server after the primary server has been
restored to operation. This macro will not run if the active HMI server
fails and is unable to run the macro, for example if the power to the
computer fails. Any macro can be used as the On standby macro.

If you have not set up a secondary server in the Redundancy tab, this
option is not available.

5–28 ■ RSView Supervisory Edition User’s Guide


Starting and stopping HMI services manually

You can start or stop the HMI services running on a computer


manually.

When you stop the HMI services manually, clients are disconnected, all
HMI servers running on the computer are shut down, and the
activation keys used by the HMI servers are released.

When you start the HMI services manually, clients are allowed to
connect to HMI servers on the computer.

For details about starting or stopping HMI services manually, see


page 26-10.

Starting and stopping an HMI server’s components


manually

You can run an HMI server’s startup components, or stop the


components running on an HMI server from within the HMI Server
Properties dialog box.

If you have set up a redundant HMI server, you can also start or stop
the redundant server’s components manually.

For details, see page 26-9.

Removing HMI servers

You can remove an HMI server from your application without deleting
its project files. This allows you to add the HMI server to an
application at a later time. You can also add the HMI server to an
application temporarily, while you copy components to other HMI
servers in the application.

Working with distributed applications ■ 5–29


To remove an HMI server

1. Disconnect all clients from the HMI server. A client is any of the
following: RSView Studio, RSView Administration Console, or
RSView SE Client.

2. Start RSView Studio, and then open the application from which
you want to remove the HMI server.

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

Remove does not delete the HMI server’s project files.

Deleting HMI server project files


Remove the HMI server from the application in which it is used before
you delete the HMI server’s files.

To delete an HMI server’s project files

1. Disconnect all clients from the HMI 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 hosting the HMI server:

\Documents and Settings\All Users\Documents\


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.

5–30 ■ RSView Supervisory Edition User’s Guide


6
Chapter

Working with
stand-alone applications
This chapter describes:

„ stand-alone applications and their components.

„ creating, renaming, and deleting stand-alone applications.

„ using data servers in stand-alone applications.

Key concepts

Understanding terminology
For definitions of terms such as FactoryTalk Directory, HMI server,
and so on, see Chapter 5, Working with distributed applications.

About stand-alone applications


In RSView Studio you can create two kinds of supervisory-level
applications: stand-alone applications, or distributed applications.

Stand-alone applications have the following characteristics:

„ FactoryTalk Directory, the HMI server, HMI project, and the


HMI client, are all located on the same computer.

„ Only data servers can be located on other computers.

„ You do not have to set up FactoryTalk Directory for use with stand-
alone applications. This is done automatically.

Working with stand-alone applications ■ 6–1


„ Redundancy is not supported for FactoryTalk Directory, or for the
HMI server. However, redundancy is supported for data servers.

„ Stand-alone applications cannot contain areas, or multiple HMI


servers. Stand-alone applications have only one default HMI server.
The HMI server has the same name as the application.

About data-server redundancy


You can set up redundant operation for data servers, to provide
minimal disruption of system operation in the event that clients lose
service from a server, for example owing to network or computer
failures.

How RSView SE Clients respond to server disruptions

During server disruptions, users do not have to restart their RSView SE


Client software to continue using the system. Once the system has
switched to the redundant data server, RSView SE Clients continue
functioning normally.

Using references in stand-alone applications


When you refer to an application component, for example a graphic
display, you create a reference to the component.

Stand-alone applications make use of relative references to refer to


application components, for example tags, or graphic displays. Relative
references point at a component relative to the current server or area.

For example, a relative reference to a display called Detail is simply the


display’s name: Detail.

6–2 ■ RSView Supervisory Edition User’s Guide


Example: Using the Display command with relative references in
stand-alone applications
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 with a relative reference to the name of the display: type
Display Overview.

Because stand-alone applications contain only one root area and one
HMI server, you cannot use absolute references.

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

Activities when deploying an application


For an overview of the activites you need to perform to deploy an
application, see page 27-1.

Working with stand-alone applications ■ 6–3


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.

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


application you want to create. To create a stand-alone application,
double-click the SE Stand-alone icon.

6–4 ■ RSView Supervisory Edition User’s Guide


3. In the New/Open SE Stand-alone Application dialog box, type a
name and description for the application.

For example, use this box to describe the application’s location, to


identify a contact person or number in the event of failure, or to
keep track of changes or version information.

The application name can be


up to 32 characters long.

To import a
project, type an
application
name, and then
click Import.

After you create a new application, the Application Explorer appears


displaying the name of the application.

Importing a project into a new application


You can import a project from RSView32, RSView Supervisory
Edition, or RSView Machine Edition into a new application.

You cannot import a project into an existing application.

To import a project

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


type a name and description for the application.

For example, use this box to describe the application’s location, to


identify a contact person or number in the event of failure, or to
keep track of changes or version information.

2. Click Import.

Working with stand-alone applications ■ 6–5


3. In the dialog box, Supervisory Edition Import Wizard - Import
File, click the type of project you want to import, and then click
Next.

4. Type the path and file name of the project you want to import, or
click the Browse button to browse for the project file, and then
click Finish.

After you have copied a project into the new application, changes made
to the original project do not affect the copy, or vice versa.

Renaming an application
You cannot rename a stand-alone application that is in use. Close all
RSView SE Clients first.

To rename an application

X Click the Start button, select Programs, Rockwell Software, RSView


Enterprise, Tools, and then click Application Manager.

For details about using the Application Manager tool, click Help.

6–6 ■ RSView Supervisory Edition User’s Guide


Deleting an application
You cannot delete an application that is in use. Close all RSView SE
Clients first.

By default, the HMI project 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 project, see page 6-12.
For details about removing a data server, to delete its cache files, see
page 7-17.

To delete an application

1. Write down the the name of the HMI server in the application.
You will need this list if you want to delete the HMI server’s files
(step 3, below).

2. Click the Start button, select Programs, Rockwell Software,


RSView Enterprise, Tools, and then click Application Manager.

For details about using the Application Manager tool to delete a


stand-alone application, click Help.

3. To delete the HMI server’s files, see page 5-30.

Using data servers in stand-alone applications

Adding data servers for load balancing

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


the computer running the data server might become over-utilized. This
might happen because of an increase in the size of the HMI project.

If this happens, you should add another data server, installed on a


different computer, and then move some of the OPC server tags to the
new data server. This distributes the processing load across computers
more effectively, providing better performance.

Working with stand-alone applications ■ 6–7


Adding data servers for redundant operation

If you want to provide redundant operation for data servers at run time,
you must install each data server on a separate computer.

You can set up redundant data servers to enable your application to use
a secondary server in the event that the primary 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 7-7.

Setting up HMI server properties


After you have added an HMI server to your application, you need to
set up the HMI server. Use the HMI Server Properties dialog box to
view the HMI server’s name, project file path, number of existing
graphic displays, and the maximum number of graphic displays allowed
on the HMI server.

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, fill in the fields on each
tab, as described in the sections that follow. When you are finished,
click OK.

6–8 ■ RSView Supervisory Edition User’s Guide


Setting up the HMI server’s general
properties
On the General tab, type a description for the HMI server.

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. For example, use this box to describe a
component’s location, to identify a contact person or number in the
event of failure, or to keep track of changes or version information.

Project file (relative to server computer) The file path to the HMI
server’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.

Working with stand-alone applications ■ 6–9


Licensed Maximum The maximum number of graphic displays
allowed by your RSView SE Server license. This number is for your
information only.

Specifying the HMI server’s startup and


shutdown components
Use the Components tab to specify:

„ which components will run when the HMI server starts.

„ which macros will run when the HMI server shuts down.

The HMI server is always started automatically when the RSView SE


Client connects to the HMI server in the application.

IMPORTANT The order in which items appear in the Components tab


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.

6–10 ■ RSView Supervisory Edition User’s Guide


Select the check box for each of the following items you want to run
when the HMI server runs. Where required, specify the component
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
Components tab. To run more files, list them in a startup macro.

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
Components tab. To run more files, list them in a startup macro.

Events Runs the specified event component. This is the same as using
the EventOn <component> command. Up to 20 event components can

Working with stand-alone applications ■ 6–11


run simultaneously, but only one component can be specified in the
Components tab. To run more files, list them in a startup macro.
Macro Runs the specified macro when the HMI server starts. This
macro allows you to run a series of commands when the HMI server
runs. You can run any macro when the HMI server starts.

On 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 On shutdown macro.

Starting and stopping an HMI server’s


components manually
You can run an HMI server’s startup components, or stop the
components running on an HMI server from within the HMI Server
Properties dialog box.

For details, see page 27-3.

6–12 ■ RSView Supervisory Edition User’s Guide


7
Chapter

Setting up
communications
This chapter describes:

„ how communications work.

„ what data servers are.

„ how to add and set up data servers in your application.

„ how to remove data servers from your application.

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 for RSView to retrieve tag values from:

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

„ third-party controller devices, such as Siemens or Modicon®, using


third-party OPC servers.

Setting up communications n 7–1


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
RSLinx OPC server
application
with OPC
server support

PLC network Network or


OPC network link via DCOM third-party
comunication
link

Allen-Bradley Non-
programmable Allen-Bradley
controller device

Remote computer – Remote computer – Remote computer –


RSLinx Gateway RSView32 Third-party
(OPC server) OPC server OPC server

7–2 n RSView Supervisory Edition User’s Guide


Summary of steps
To set up communications, complete these steps:

1. Gather information about your network, and the devices that are
connected to it. You will need this information to set up RSLinx,
or another OPC server.

2. Decide what OPC server you want to use for communications.


You can use any of the following OPC servers:

„ any OPC-DA 2.0-compliant server


„ RSLinx for RSView
„ RSLinx Enterprise
For information to help you choose an OPC server, see “Types of
data servers” on page 7-5.

3. If you want to use RSLinx for RSView as the OPC server that
enables communications on your network, set up RSLinx for
RSView. For details, see Getting Results with RSLinx, or see Help for
RSLinx.

RSLinx for RSView is not installed automatically when you install


RSView Supervisory Edition. For details about installing RSLinx,
see the RSView Supervisory Edition Installation Guide, included on the
RSView Supervisory Edition CD-ROM.

4. If you want to use RSLinx Enterprise as the OPC server that


enables communications on your network, set up RSLinx
Enterprise.

RSLinx Enterprise is installed automatically when you install


RSView Supervisory Edition. For details about setting up RSLinx
Enterprise, see “Adding RSLinx Enterprise data servers” on
page 7-12. Also see RSLinx Enterprise Help by clicking the
Communications tab in the Application Explorer, and then pressing
F1.

Setting up communications n 7–3


5. If you want to use an OPC server other than RSLinx to enable
communications on your network, set up the OPC server you
want to use. For details, see the documentation supplied with your
OPC server.

6. In RSView Studio, add a data server that points at the OPC server
you set up in step 3, step 4, or step 5.

7. If you want to use HMI tags in your application, open the Tags
editor, and then create device tags that point at addresses in
devices. For details about creating HMI tags, see Chapter 9,
Creating HMI tags.

If you do not want to use HMI tags, but instead want to access
addresses in devices directly, skip this step. For details about using
tags, see Chapter 8, Working with tags.

8. In objects in graphic displays, or anywhere else you want to access


values in tags, type the tag name using the syntax for your OPC
server, or use the tag browser.

About data servers


A data server provides a route to the physical devices on your network,
so you can see the values in those devices, for example:

„ programmable controller values.

„ OPC tags, and their value or status information.

„ named variables in a ControlLogix processor.

7–4 n RSView Supervisory Edition User’s Guide


Types of data servers

In RSView Supervisory Edition, you can create three kinds of data


servers:

An OPC data server provides support for any data server that
conforms to the OPC-DA 2.0 standard, or an OPC server for use
with the version of RSLinx called RSLinx for RSView.

An OPC data server for use with RSLinx for RSView provides
enhanced support for Rockwell Automation programmable controllers
and devices.

If you are using RSLinx for RSView or another OPC data server for
communications, create an OPC data server. If you are using RSLinx
Enterprise for communications, create an RSLinx data server.

An RSLinx data server for use with RSLinx Enterprise provides


best performance when communicating with ControlLogix processors.

If you are using RSLinx Enterprise for communications, create an


RSLinx data server. If you are using another OPC data server for
communications, create an OPC data server.

Using multiple 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 RSLinx can be set up to communicate with multiple types


of controllers simultaneously, you might not need a separate data
server for each controller:

„ If you have set up RSLinx to communicate with all the


controllers in your application, you need only one data server,

Setting up communications n 7–5


and then you can access each controller using a different
RSLinx topic.
„ If you have set up multiple copies of RSLinx, each of which
communicates with a different controller or network, you will
need to set up a data server for each copy of RSLinx you have
running.
For details about setting up communications in RSLinx, see Getting
Results with RSLinx, or see Help for RSLinx.

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

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

If your application includes a large number of tags and you are not
using RSLinx for RSView or RSLinx Enterprise for communications,
you should place your OPC data server in a different area than the one
in which your HMI server is located. This provides best performance
when accessing data in a large number of tags. RSLinx for RSView and
RSLinx Enterprise are optimized to provide best performance, even if
located in the same area as the HMI server.

7–6 n RSView Supervisory Edition User’s Guide


Adding OPC data servers
Add an OPC data server for use with RSLinx for RSView, or for use
with another OPC server.

For details about adding RSLinx Enterprise data servers, see “Adding
RSLinx Enterprise data servers” on page 7-12.

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

To add an OPC data server

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


„ Right-click the application root, or right-click an area name,
select New Data Server, and then click OPC Data Server.
„ Click the File menu, select New, and then click OPC Data
Server.
The name of the data server cannot include dashes or hyphens (–).

2. In the Data Server Properties dialog box, fill in the fields in each
tab, as described in the sections that follow. When you are finished,
click OK.

Setting up communications n 7–7


Setting up general properties
In the General tab, type a description for the data server, and specify
the name of the computer that will run the OPC server.

Name Type a name for the data server. The name cannot include
dashes or hyphens (–).

Description Type a description for the data server. For example, use
this box to describe a component’s location, to identify a contact
person or number in the event of failure, or to keep track of changes or
version information.

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

7–8 n 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.

If you want to use RSLinx as the OPC server, click the Browse button,
and then click RSLinx Remote OPC Server.

Setting up data server redundancy


To minimize disruptions to clients if the primary data server fails, set
up a redundant data server. In RSView, the redundant server is called
the secondary server.

In the Redundancy tab, specify the name of the secondary 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 the secondary server Type the name of the


computer on which the secondary data server is running. 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

Setting up communications n 7–9


using the secondary server even when the primary becomes available
again.

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

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

2. Click the Advanced tab.

3. Select the check box, Include extended information in the server


cache file.

7–10 n RSView Supervisory Edition User’s Guide


4. Click Create Cache.

5. Click OK.

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

To synchronize a data server’s cache

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


click Properties.

2. Click the Advanced tab.

3. Click the Synchronize button.

4. Click OK.

Setting up communications n 7–11


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

For details about adding OPC data servers for use with RSLinx for
RSView or other OPC servers, see “Adding OPC data servers” on
page 7-7.

To add an RSLinx data server

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


„ Right-click the application root, or right-click an area name,
select New Data Server, and then click RSLinx Data Server.
„ Click the File menu, select New, and then click RSLinx Data
Server.
The name of the data server cannot include dashes or hyphens (–).

2. In the Data Server Properties dialog box, fill in the fields in each
tab, as described in the sections that follow. When you are finished,
click OK.

7–12 n RSView Supervisory Edition User’s Guide


Setting up general properties
In the General tab, type a description for the data server, and specify
the name of the computer that will run the data server.

Name Type a name for the data server. The name cannot include
dashes or hyphens (–).

Description Type a description for the data server. For example, use
this box to describe a component’s location, to identify a contact
person or number in the event of failure, or to keep track of changes or
version information.

Computer hosting the RSLinx Enterprise server Type the name of


the computer on which the RSLinx Enterprise data server is running.
To browse for the name of the computer, click the Browse button.

Setting up communications n 7–13


Setting up data server redundancy
To minimize disruptions to clients if the primary data server fails, set
up a redundant data server. In RSView, the redundant server is called
the secondary server.

In the Redundancy tab, specify the name of the secondary 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 the secondary server Type the name of the


computer on which the secondary data server is running. To browse for
Browse button 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 becomes available
again.

7–14 n RSView Supervisory Edition User’s Guide


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

Setting up communications in RSLinx Enterprise


Use the Communication Setup editor to add drivers, add devices, set up
driver and device properties, and set up device shortcuts.

Primary and Secondary tabs


If you have set up only a primary RSLinx data server, only the Primary
tab appears in the Communication Setup editor.

Setting up communications n 7–15


If you have set up both a primary and a secondary RSLinx data server,
both the Primary and the Secondary tabs appear in the Communication
Setup editor.

You can use these tabs to point RSLinx Enterprise at different


networks or different hardware in case of failure.

IMPORTANT When specifying device shortcuts, be sure to use exactly


the same shortcut names for both servers, otherwise tag
references that use these shortcuts will not be able to
obtain data reliably.

To set up communications in RSLinx Enterprise

1. In the Application Explorer, double-click the Communication


Setup editor.

2. In the Communication Setup editor, add, or remove device


shortcuts, or open an offline tag file to browse for tags offline.

For details about using the Communication Setup Editor, click


Help.

7–16 n RSView Supervisory Edition User’s Guide


Removing data servers

To remove a data server

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

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

Setting up communications n 7–17


8
Chapter

Working with tags


This chapter provides general information about working with all kinds
of tags. For specific information about creating HMI tags, see
Chapter 9, Creating HMI 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 for 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 ■ 8–1


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.

Tag-related 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.

If your application includes a large number of tags and you are not
using RSLinx for RSView or RSLinx Enterprise for communications,

8–2 ■ RSView Supervisory Edition User’s Guide


you should place your OPC data server in a different area than the one
in which your HMI server is located. This provides best performance
when accessing data in a large number of tags. RSLinx for RSView and
RSLinx Enterprise are optimized to provide best performance, even if
located in the same area as the HMI server.

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. For details, see Chapter 9, Creating HMI tags.

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 8-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. When

Working with tags ■ 8–3


you do create the tag, ensure that you spell it the same way you did
when you referred to it.

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 the RSView 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.

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

8–4 ■ RSView Supervisory Edition User’s Guide


For information about creating tags in a ControlLogix processor,
see the documentation for your device programming software.

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 11, 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 15,
Setting up security.

Working with tags ■ 8–5


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

HMI 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 “Setting up an analog tag” on page 9-13.

8–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 9, 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, create memory tags, or, for device tags, map
each tag name to an OPC, or DDE 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 ■ 8–7


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
Browse button 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 8-15.

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

8–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 ■ 8–9


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

8–10 ■ RSView Supervisory Edition User’s Guide


Using the tag browser
When you click a Browse button or Tag button, the tag browser opens.

Browse button

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 ■ 8–11


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

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.

8–12 ■ RSView Supervisory Edition User’s Guide


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 add folders to


HMI servers only.

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.

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.

The home area appears


in bold type.

For information about the home area, see page 8-20.

Working with tags ■ 8–13


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 a folder

X Right-click a folder in the Folders list, and then click Refresh folder.

To refresh the list of tags in all folders

X Right-click a folder in the Folders list, and then click 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.

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.

8–14 ■ RSView Supervisory Edition User’s Guide


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.

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.

Working with tags ■ 8–15


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.

To remove selected items from the list

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

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

„ Click the Remove button.


„ Right-click the highlighted items to open the context 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.

X Do one of the following:

„ Click the Clear button.


„ Right-click anywhere in the list to open the context menu, and
then click Clear.

8–16 ■ RSView Supervisory Edition User’s Guide


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.

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.

Working with tags ■ 8–17


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

X To remove a tag filter, in the Tag Filter list, click <None>.

Creating, editing, and importing HMI tags

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

„ 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 9,
Creating HMI tags. For information about importing tags from a PLC
database, see page 9-22.

8–18 ■ RSView Supervisory Edition User’s Guide


Using tag references

When you type a tag name, you are creating 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,


using correct syntax. You can also create references to tags manually, by
typing the tag name and, optionally, its path.

In distributed applications, there are two ways to refer to a tag. You can
create an absolute reference, or a relative reference.

In stand-alone applications you need use relative references only.

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 that you are referring
to a specific tag in a specific location.

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 5-16.

Working with tags ■ 8–19


The home area
The home area is the area in which a component (for example, a
graphic display) is located. The home area is useful for distributed
applications only.

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.

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.

The home area appears


in bold type.

8–20 ■ RSView Supervisory Edition User’s Guide


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

Working with tags ■ 8–21


9
Chapter

Creating HMI tags


This chapter describes:

„ the different types of HMI tags.

„ how to organize tags.

„ how to create analog, digital, and string tags using the Tags editor.

„ how to create tags using third-party applications such as databases


or spreadsheets.

„ how to import and export tags in the tag database.

HMI tag types


An RSView SE 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.
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 that uses an alphanumeric product code.

Creating HMI tags ■ 9–1


Tag Type of data stored

System Information generated while the system is running, including


alarm information, 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 programmable
controller or other device via RSLinx, or from another OPC or DDE
server.

Memory

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

Retentive memory tags

For memory tags, optionally you can specify that the tag’s value be
retained when RSView Studio, or the RSView SE Client shuts down.

Unless another instance of RSView Studio or the RSView SE Client


changes the memory tag’s value, the next time RSView Studio or the
RSView SE Client starts, the memory tag will have the same value it had

9–2 ■ RSView Supervisory Edition User’s Guide


when that instance of RSView Studio or the RSView SE Client was last
shut down.

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 run time.

„ use folders to group related tags.

Naming HMI tags

Tag names can be up to 255 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 20, Creating expressions.

Creating HMI tags ■ 9–3


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.

9–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 ■ 9–5


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 wildcard 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 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

9–6 ■ RSView Supervisory Edition User’s Guide


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 HMI Tag Folder dialog box, type the folder name.

3. Click OK.

The new folder appears in the hierarchy.

Creating HMI tags ■ 9–7


Opening a folder
When you open a folder, its contents are displayed in the spreadsheet.

To open a folder

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

9–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 HMI Tag 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 ■ 9–9


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.

2. On the Edit menu, click Duplicate Folder on the Edit menu, or on


the toolbar, click the Duplicate Tag Folder button.
Duplicate Tag Folder
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.

2. On the Edit menu, click Delete Folder, or on the toolbar, click the
Delete Folder button.
Delete folder

9–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 Insert Row button. This inserts a new row above the highlighted
row.

Creating HMI tags ■ 9–11


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.

2. On the Edit menu, click Delete, or on the toolbar, click the Delete
button.
Delete

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 9-18.

9–12 ■ RSView Supervisory Edition User’s Guide


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 15, Setting up security.

Description Type a description of the tag, up to 128 characters


long.

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.

Creating HMI tags ■ 9–13


The range between the minimum and maximum values cannot
exceed the maximum floating point value (3.402823E38).

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

9–14 ■ RSView Supervisory Edition User’s Guide


Data Type The data types are:
Data type Description Range

Default The default data type is Floating Point. See below.

Do not use Default for OPC or DDE


addresses, as this might produce
unexpected results.
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.402823E+38 to –1.175494E –38,
0,
1.175494E –38 to 3.402823E +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.

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.

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.

Creating HMI tags ■ 9–15


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 the
proper security code. For detailed information about security, see
Chapter 15, Setting up 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.

9–16 ■ RSView Supervisory Edition User’s Guide


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 15, Setting up security.

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.

Creating HMI tags ■ 9–17


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 9-12.

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:

„ Allen-Bradley or SoftLogix 5 programmable controllers through


RSLinx.

„ programmable controllers through an OPC or DDE server.

„ another Windows program through an OPC or DDE server.

For details about creating HMI tags for use with DDE
communications, see Appendix C, Setting up DDE communications for
HMI tags.

To create a tag with device as the data source

1. Click Device.

2. In the Address box, specify the name of the tag in the OPC server,
or specify the DDE item.

You can click the Browse button to select the address of the OPC
Browse button
tag.

9–18 ■ RSView Supervisory Edition User’s Guide


For information about setting up OPC communications, see
Chapter 7, Setting up communications.

For information about setting up DDE communications for tags,


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

Addressing syntax for OPC tags


The syntax for OPC tag addresses is:

[AccessPath]Address or

::[AccessPath]Address

where :: indicates that the address resides in a data server in the home
area.

IMPORTANT The square brackets are part of the syntax. They do not
indicate optional parameters.

The access path is one of the following:

„ For communications with an RSLinx OPC server, the access path


is the name of a DDE/OPC topic in RSLinx.

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

Creating HMI tags ■ 9–19


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.

3. To have the tag’s value retained when RSView Studio or the


RSView SE Client shuts down, select the Retentive check box.

If you want the memory tag to revert to its inital value the next time
RSView Studio or an RSView SE Client starts, clear the Retentive
check box.

Other ways of 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.

9–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 can be merged with tags already in the tag
database, in which case 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 9-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

Browse button 1. Click the Browse button or the Tags button, whichever is available,
to open the tag browser.

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
Tag button
New HMI Tag.

The Tag Editor dialog box opens so you can set up the tag.

Creating HMI tags ■ 9–21


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

X Do one of the following:

DB Browser button in
„ In the tag browser, right-click a blank area of the Contents
the Tags editor pane, and then click Import PLC Tags.

„ In the Tags editor, click the DB Browser button on the toolbar.

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
B3/1 will not show B3/10,
B3/11, and so on.

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.

9–22 ■ RSView Supervisory Edition User’s Guide


You can import tags from any of these databases:

„ legacy PLC databases, created using WINtelligent LOGIC 5™ or


A.I. 5,™ 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

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. In the Import tags into Folder box, type the name of the folder in
the tag database into which you want to import the tags.

If the folder does not exist, it is created automatically.

2. In the RSLinx Topic box, type the name of the RSLinx topic to
which the tags belong.

3. 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
Browse button 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.

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

Creating HMI tags ■ 9–23


5. Highlight the symbol, or symbols you want to import.

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.

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

X Do one of the following:

„ In RSView Studio, click the Tools menu, and then click Tag
Import and Export Wizard.
„ Click the Windows Start button, select 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.

9–24 ■ RSView Supervisory Edition User’s Guide


Adding alarms to HMI tags
Analog and digital tags can have alarms associated with them. At run
time, 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 11, Setting up alarms.

Creating HMI tags ■ 9–25


10
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’s 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 ■ 10–1


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:

1. Set the maximum update rate for the the derived tag component in
the Derived Tag Setup dialog box.

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

10–2 ■ RSView Supervisory Edition User’s Guide


Using the Check Syntax button
Click the Check Syntax button to verify that the expression you typed
uses correct syntax. You can check the syntax of your expression at any
time while the Derived Tags editor is open.

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.

Creating derived tags ■ 10–3


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.

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.

10–4 ■ RSView Supervisory Edition User’s Guide


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.

3. In the Maximum Update Rate list, click an update rate. For


example, if you click 0.25, derived tags in the component will be
evaluated no 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 ■ 10–5


To create a derived tag

1. In the Tag Name box, type the name of the tag that will hold the
derived value. You can also browse for the tag name using the
Browse button Browse button.

You can use any tag as a derived tag. The tag must already exist, for
example in a programmable controller or data server, before you
can use it as a derived tag.

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 information about expressions, see
Chapter 20, 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.

Editing derived tags


You can edit derived tags using RSView Studio only.

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.

10–6 ■ RSView Supervisory Edition User’s Guide


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 HMI Server Properties dialog box, click the Components
tab, 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.

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

Creating derived tags ■ 10–7


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 about stopping an HMI server’s components manually:

„ in distributed applications, see page 26-9.

„ in stand-alone applications, see page 27-3.

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.

10–8 ■ RSView Supervisory Edition User’s Guide


11
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 ■ 11–1


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

„ synchronize alarm acknowledgement on redundant HMI server


pairs using the Acknowledge bit.

„ 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).

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

11–2 ■ RSView Supervisory Edition User’s Guide


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.

Example: Alarm thresholds

Alarm
Threshold security
values Thresholds levels

5,000 6 * 1

4,000 5 * 4
Increasing

3,000 4 8

2,000 Safe zone


3
8

1,000 2 6
Decreasing

1 1 4
Time
Thresholds must be set up
in ascending order * These alarms are triggered only if the check
box ‘Generate alarms when approaching
normal operating range’ is selected in the
Alarm Setup dialog box.

Setting up alarms ■ 11–3


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

11–4 ■ RSView Supervisory Edition User’s Guide


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

Setting up alarms ■ 11–5


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

4,000
Deadband
3,500
3,000
Threshold
2,000 Out of 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.

11–6 ■ RSView Supervisory Edition User’s Guide


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.

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.

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.

Setting up alarms ■ 11–7


When you set up alarm severity, you specify what severity levels mean
and what actions they will trigger.

Severity determines the order in which alarms are displayed in an alarm


banner.

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

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,™ or Microsoft Visual Basic.

11–8 ■ RSView Supervisory Edition User’s Guide


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.

Setting up alarms ■ 11–9


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 is full and a new alarm is
generated, the alarm at the bottom of the list (the oldest alarm) is
acknowledged automatically by the system, and then dropped from the
the list. Alarms that are acknowledged automatically by the system
appear in the alarm log file with SysAk (system-acknowledged) in the
TransType (transaction type) field.

Alarms are also dropped when they are out of alarm, or acknowledged
manually. 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 page 11-11). 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

11–10 ■ RSView Supervisory Edition User’s Guide


Information graphic library. Use the graphic objects as they are, or edit
them to suit your needs.

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

Setting up alarms ■ 11–11


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.

11–12 ■ RSView Supervisory Edition User’s Guide


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 11-17.

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

Setting up alarms ■ 11–13


running the HMI server. Once you have created the key, change its
string value to False. The key is located at:

HKEY_LOCAL_MACHINE\Software\Rockwell Software\
RSView Enterprise\Alarm Server

To create or change the key, use the Windows Regedit32 utility. For
details about using Regedit32, 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 20, 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 single character.


* Matches any number of characters, including the
backslash (\) 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 20-13.

11–14 ■ RSView Supervisory Edition User’s Guide


Acknowledge bit

An acknowledge bit is a digital tag that can be used for two things:

„ 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
slow the system down considerably.

IMPORTANT The acknowledge bit must be set up as a digital tag in the


tag database.

You can use the acknowledge bit to keep acknowledged alarms


synchronized on redundant HMI server pairs. This means that when
you acknowledge an alarm on the primary HMI server, the alarm is
also acknowledged automatically on the secondary HMI server.

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.

Setting up alarms ■ 11–15


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.

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.

11–16 ■ RSView Supervisory Edition User’s Guide


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.

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

Setting up alarms ■ 11–17


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.

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, 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 retained after the AlarmOff command


is issued, or after the HMI server shuts down.

11–18 ■ RSView Supervisory Edition User’s Guide


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 255 characters long. The alarm event
name can contain the following characters:

„ A to Z

„ 0 to 9

„ underscore ( _ ) and dash (–)

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

Setting up alarms ■ 11–19


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.

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, complete these steps:

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.

Using the Alarm Setup editor, 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.

2. Set up the alarm log file.

The alarm log file is a record of alarm incidents. Using the Alarm
Log Setup editor, you can specify where you want the alarm log file
stored, and when - if ever - you want log files created and deleted.

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.

11–20 ■ RSView Supervisory Edition User’s Guide


4. Set up ways to display alarm information. In graphic displays, you
can:

„ set up alarm summaries.

„ embed numeric or string displays using alarm functions or


alarm system tags.

5. Choose methods for starting and stopping alarm monitoring.

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

Setting up alarms ■ 11–21


Specifying how the monitoring system behaves
You can specify:

„ how the system behaves when alarms recross trigger thresholds.

„ how often the system checks for new alarms.

„ where alarms are logged and printed when HMI-server redundancy


is enabled.

Setting up alarm trigger thesholds


An alarm is triggered when the value of an analog tag crosses its alarm
threshold. If the value of the tag fluctuates above and below its alarm
threshold, alarms are triggered each time the tag value rises above the
threshold value, or falls below the threshold value. You can enable or
disable this feature.

For more information about how this feature works, see “Thresholds”
on page 11-2.

To trigger alarms when tags recross alarm thresholds

1. In the Alarm Setup dialog box, click the Setup tab.

2. Select the check box, Generate alarms when approaching normal


operating range.

This option applies to all analog alarm tags in the HMI project.

When this check box is selected, RSView generates alarms when the
value of an analog tag moves back towards the normal operating
range, and recrosses the alarm trigger threshold. For an example,
see page 11-3.

3. To close the Alarm Setup dialog box, click OK.

11–22 ■ RSView Supervisory Edition User’s Guide


Specifying how often the system checks
for alarms
The system does not check for alarms more frequently than the
maximum update rate specified in the Alarm Setup dialog box.

You should match the maximum update rate to the rate at which you
expect tag values to change. For example, if you are monitoring
temperatures that fluctuate slowly, you can check for alarms less
frequently than if you are monitoring rapidly-changing manufacturing
processes.

To specify the maximum rate at which the system checks for


new alarms

1. In the Alarm Setup dialog box, click the Setup tab.

2. In the Maximum Update Rate list, click a number to specify the


frequency with the system checks HMI tags for new alarms.

3. To close the Alarm Setup dialog box, click OK.

Specifying how alarm monitoring behaves on


redundant servers
If you have set up redundant HMI servers, alarms can be logged and
printed on the active HMI server only, or on both the active and the
standby HMI server.

IMPORTANT For alarm states to be synchronized properly, the clocks


on the primary and secondary HMI servers must be kept
synchronized to a time server. If the clocks on both
computers are not synchronized, when fail-over occurs
multiple alarms or inconsistent information might be
displayed in an alarm summary.

Setting up alarms ■ 11–23


To specify where alarms are logged and printed when
redundancy is enabled

1. In the Alarm Setup dialog box, click the Setup tab.

2. To log and print alarms on the active HMI server only, click Only
log and print alarm messages on the active server.

To log and print alarms on both HMI servers in a redundant pair,


click Log and print alarm messages on both the active and standby
servers.

3. To close the Alarm Setup dialog box, click OK.

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.

To set up alarm severity

1. In the Alarm Setup editor, click the Severities tab.

Alarm severities

Alarm incidents

11–24 ■ RSView Supervisory Edition User’s Guide


2. Click an alarm severity or an incident.

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.

Setting up alarms ■ 11–25


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

Alarm messages appear in the description field of the alarm log file
only. You cannot display them in alarm summaries.

11–26 ■ RSView Supervisory Edition User’s Guide


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

This placeholder Is replaced with the

\C Current value of the tag.


\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 Name of the tag in alarm.
\S Description of the tag in alarm.

Setting up alarms ■ 11–27


This placeholder Is replaced with the

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

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.

11–28 ■ RSView Supervisory Edition User’s Guide


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 “System default
messages” on page 11-27.

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 11-32.

„ “Setting up alarms for digital tags” on page 11-37.

Setting up alarms ■ 11–29


Your message can say whatever you want and can use both words and
placeholders. For a list of placeholders, see “System default messages”
on page 11-27.

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 at run time to
type a remark for the alarm
log file.

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.

11–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 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 information about using the Tag Import and
Export Wizard, see page 9-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


defined for it, an X appears in
this column.

Setting up alarms ■ 11–31


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:

1. Set up the alarm threshold, and then choose the message that will
appear if the threshold is crossed.

2. Set up the messages that are sent when a tag goes out of alarm and
when an operator acknowledges an alarm.

3. Set up advanced features, such as deadband and handshake.

Setting up alarm thresholds


1. Click the Alarm Thresholds tab.

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.

11–32 ■ RSView Supervisory Edition User’s Guide


3. Fill in the fields as follows:

To set up an alarm threshold,


first click a threshold in
this list.

Threshold To define a constant threshold, type a number. To


define a variable threshold, specify a tag name.

IMPORTANT At run time, a variable theshold must not become


higher than the threshold above it, or lower than the
threshold below it. If this happens, 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 11-24.

Setting up alarms ■ 11–33


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

2. Select the file and printer messages for when a tag goes out of
alarm, and for when an operator acknowledges an alarm.

11–34 ■ RSView Supervisory Edition User’s Guide


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 11-26.

Setting up advanced features

1. Click the Advanced tab.

2. Fill in the fields as follows:

Alarm Identification Type a command, macro 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.

Setting up alarms ■ 11–35


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.

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 11-5.

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 11-15.

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
Browse button as the 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 11-16.

11–36 ■ RSView Supervisory Edition User’s Guide


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.

Setting up alarm states

1. Click the Alarm States tab.

Setting up alarms ■ 11–37


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

Alarm Label Type a description of the alarm up to 21 characters


long. This description is displayed in the alarm summary and 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 11-24.

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 11-26.

11–38 ■ RSView Supervisory Edition User’s Guide


Setting up alarm messages
1. Click the Alarm Messages tab.

2. Select the file and printer messages for when a tag goes out of
alarm and 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 11-26.

Setting up alarms ■ 11–39


Setting up advanced features
1. Click the Advanced tab.

2. Fill in the fields as follows:

Alarm Identification Type a command, macro 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.

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.

11–40 ■ RSView Supervisory Edition User’s Guide


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 11-15.

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
Browse button use as the 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.

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 11-16.

By default, alarm handshaking is off. To start alarm handshaking,


issue the AlarmOn /H, or HandshakeOn command.

Setting up alarms ■ 11–41


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.

11–42 ■ RSView Supervisory Edition User’s Guide


To open the Alarm Log Setup editor

X Do one of the following:


„ Click the Start button, select 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 ■ 11–43


Specifying where to store alarm 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 “Setting up security to
allow alarm logging to a remote computer” on page 11-53.

11–44 ■ 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 11-55.

„ “Viewing alarm log files” on page 11-56.

„ the schema for the ODBC alarm log table on page D-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 28-4.

Setting up alarms ■ 11–45


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.

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

11–46 ■ RSView Supervisory Edition User’s Guide


For this period The new file is created

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.

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 17-37.

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.
For details about how to monitor disk space on computers running
HMI servers, see page 28-4.

You cannot delete an alarm log file while RSView is monitoring alarms.

Setting up alarms ■ 11–47


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. If your
application creates a new file each day and deletes the oldest 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.

11–48 ■ RSView Supervisory Edition User’s Guide


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.

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
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 D-2.

Setting up alarms ■ 11–49


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.

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 the ODBC database and HMI server are not located on the
same computer, you must enter a User ID and password to

11–50 ■ RSView Supervisory Edition User’s Guide


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 “Setting up
security to allow alarm logging to a remote computer” on
page 11-53.

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

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

Setting up alarms ■ 11–51


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 D-2.

Editing alarm log setup


You can edit the alarm log setup during development or run time, using
the Alarm Log Setup editor.

If you change the alarm log setup at run time, the changes take effect
immediately.

To edit the alarm log setup

1. Open the Alarm Log Setup editor by doing one of the following:

„ Click the Start button, select Programs, Rockwell Software,


RSView Enterprise, Tools, and then click SE Alarm Log Setup.
„ In RSView Studio, or the RSView Administration Console click
the Tools menu, and then click Alarm Log Setup.

2. Make the required changes.

3. Save the changes.

11–52 ■ RSView Supervisory Edition User’s Guide


Setting up security to allow alarm logging to a
remote computer
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 in Windows 2000

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.

If DCOM Configuration Warning messages appear, click No for


each one.

3. In the Distributed COM Configuration Properties dialog box, click


the Applications tab.

4. In the Applications list, click RsAlmLogExpServ, and then click


Properties.

5. In the RsAlmLogExpServ Properties dialog box, click the Identity


tab.

6. Click This user, and then type the name and password of a user
that has access to the network share or database.

7. Click OK.

8. In the Applications list, click RsAlmLogService Class and then


click Properties.

9. In the RsAlmLogService Class Properties dialog box, click the


Identity tab.

10. Click This user, and then type the name and password of a user
that has access to the network share or database.

Setting up alarms ■ 11–53


11. Click OK.

12. Restart the computer.

To change the security account of the alarm log program


files in Windows XP

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. In the Component Services window, double-click Component


Services, double-click the Computers folder, double-click My
Computer, and then double-click DCOM Config.

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 RsAlmLogExpServ and then click


Properties.

6. In the RsAlmLogExpServ Properties dialog box, click the Identity


tab.

11–54 ■ RSView Supervisory Edition User’s Guide


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.

13. Restart the computer.

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:

„ YYYY are the four digits of the year.

„ MM is the month.

„ DD is the day.

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

Setting up alarms ■ 11–55


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.

For information about the contents of the alarm log ODBC tables, see
page D-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.

To open the alarm log viewer

X 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, select 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
Help for the alarm log viewer.

11–56 ■ RSView Supervisory Edition User’s Guide


To open the alarm log viewer Help

X Click the Start button, select 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.

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.

Setting up alarms ■ 11–57


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 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 16,


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.

11–58 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up alarms ■ 11–59


For stand-alone applications, the Area heading is not available.
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 disappears.

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

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

11–60 ■ RSView Supervisory Edition User’s Guide


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.

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

Setting up alarms ■ 11–61


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.

4. To set up the blink style for an item’s state, click Blink and then
select the blink colors.

11–62 ■ RSView Supervisory Edition User’s Guide


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.

If you select the Execute check box, the Execute Command dialog
box appears. For information about using the Execute button, see
“Using alarm data with commands” on page 11-77.

Setting up alarms ■ 11–63


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.
Silence Current If the highlighted alarm is set up to set off the
internal bell, 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.

11–64 ■ RSView Supervisory Edition User’s Guide


This button Does this

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 be sorted temporarily.

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 11-67.

Setting up alarms ■ 11–65


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.

11–66 ■ 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.

Using Filter

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.

You cannot filter by area name in stand-alone applications.

Using Sort

Use Sort to specify the order in which alarm information is displayed.

You cannot sort by area name in stand-alone applications.

Filtering and sorting at run time

Alarm information can also be filtered and sorted at run time, but
changes are not saved.

Displaying tag names with the areas they belong to

To display tag names with the names of the areas they belong to, click
Display full tag name.

This option is not available for stand-alone applications.

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.

Setting up alarms ■ 11–67


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.

You cannot filter by area name in stand-alone


applications.

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 5-9.

11–68 ■ RSView Supervisory Edition User’s Guide


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.
This option is not available in stand-alone applications.

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 single character.


* Matches any number of characters, including the
backslash (\) 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

To collect alarm transactions from the current area for all tags whose
names begin with Coolant, type:

Coolant*

Setting up alarms ■ 11–69


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 16-51.

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::*

To display alarm transactions from a specific area for a tag whose name
you want to specify at run time, type:

Area::#1

11–70 ■ RSView Supervisory Edition User’s Guide


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

For more information, see “Replacing tag placeholders using a


parameter file” on page 16-52, and “Replacing tag placeholders using
parameters to the Display command” on page 16-55.

Setting up alarms ■ 11–71


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.

11–72 ■ 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.

IMPORTANT You cannot sort by area name in stand-alone


applications.

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 ■ 11–73


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 area
name, tag name, alarm type, severity, value, date and time, and the tag
type.

IMPORTANT In stand-alone applications, you cannot include the area


name.

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.

11–74 ■ 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 11-77.

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 11-63.

To run the command, macro, or custom program

X 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 information about using the Execute button in an alarm summary,


and for an example, see “Using alarm data with commands” on
page 11-77.

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 ■ 11–75


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 11-35.

„ for digital tags, see “Alarm Identification” on page 11-40.

To run the Identify command

X 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 23, Setting up


navigation.

11–76 ■ 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 FactoryTalk Diagnostics 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 parameters

Setting up alarms ■ 11–77


into any position within a command by passing the parameters to a
macro. For details about using parameters with macros, see page 22-4.

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.

11–78 ■ 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 ■ 11–79


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

11–80 ■ RSView Supervisory Edition User’s Guide


Suppressing alarm printing

To suppress alarm printing for all tags, use the AlarmPrintOff


command. To re-enable printing of alarms, use the AlarmPrintOn
command.

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.

Setting up alarms ■ 11–81


To view a list of the tags not being monitored, use the Suppressed List.
You can also turn monitoring back on from this list.

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 single character.


* Matches any number of characters, including the
backslash (\) 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.

11–82 ■ 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.

To turn off suppression Click All Off to turn off


for a tag, click the tag suppression for all tags.
name, and then click
Suppress Off.

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.

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.

Setting up alarms ■ 11–83


Ways to start alarm monitoring at the HMI
server

To start alarm monitoring, 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 Alarm On command in the examples below. For
details about using the AlarmOn command, see
Appendix A, RSView commands.

„ In the HMI Server Properties dialog box, click the Components


tab, and then 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 HMI Server Properties dialog box, click the
Components tab, and then 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.

11–84 ■ 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 about stopping components manually:

„ in distributed applications, see page 26-9.

„ in stand-alone applications, see page 27-3.

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 Alarm On command in the examples below. For
details about using the AlarmOn 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 ■ 11–85


12
Chapter

Logging system activity


FactoryTalk Diagnostics records information about various types of
system activity, including:

„ command and macro usage.

„ operator comments.

„ system messages and errors.

„ errors from the communication network.

„ tag read and write activity.

FactoryTalk Diagnostics allows the information to be:

„ viewed using the Diagnostics List, or the Diagnostics 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.

Key concepts

The settings for FactoryTalk Diagnostics apply to all Rockwell


Software products installed on a single computer.

You must set up FactoryTalk Diagnostics separately on every computer


on which you want to log system activity.

Logging system activity ■ 12–1


Setting up FactoryTalk Diagnostics involves:

„ setting up destinations, where logged information is received for


storage or display.

„ setting up which destinations receive which categories of messages.


This is called message routing.

Destinations

FactoryTalk Diagnostics messages can be sent to various


destinations—for example, the message log file on the local computer,
an ODBC-compliant database, and messages can be displayed in the
RSView Diagnostics List at the bottom of the window in RSView
Studio, or the RSView SE Client.

Each destination has features or behavior you can set up.

IMPORTANT The destinations available might vary, depending on


what Rockwell Software products you have installed.
RSView adds the ODBC Database, and Diagnostics
List destinations to FactoryTalk Diagnostics.

If RSView is not installed on the computer, these


destinations are not available in FactoryTalk
Diagnostics.

Making log files redundant

You can make Diagnostics log files redundant by logging to an


ODBC-compliant database, and then setting up redundancy for the
database.

If you also set up local log files, you can use them to buffer information
while communications with the database are lost.

12–2 ■ RSView Supervisory Edition User’s Guide


Message routing

You can decide which destinations receive messages of which severity,


and for which audience. This allows you to make the right information
available to the right person, in the right place.

Routing messages to destinations

For example:

„ You can send messages that contain information about system


activity to the local log file. You can also send warnings about things
that might go wrong if left unattended to the local log file.

This allows a control systems engineer to analyze system activity


and performance, and make corrections during scheduled
maintenance times.

„ You can send errors that require immediate action to the


FactoryTalk Diagnostics List, as well as the log file.

At run time, if the FactoryTalk Diagnostics List is visible, an


operator can alert the plant’s control systems engineer to problems
such as tag errors, as they occur.

During scheduled maintenance time, the engineer can use the


errors, together with warnings, or information messages recorded
in the local log file, to analyze operation of the system, and then
make the necessary corrections.

Category

Rockwell Software’s FactoryTalk-enabled products categorize the


messages they send to FactoryTalk Diagnostics by severity, and by
audience. To route messages, you need to specify that a particular
destination (for example, the FactoryTalk Diagnostics List) receive

Logging system activity ■ 12–3


messages of a particular severity (for example, Errors), and audience
(for example, Operator).

Severity

RSView categorizes messages in four severities:

„ Errors indicate that a process or action has failed. For example, a


tag’s value could not be written, or a user typed the wrong password
while logging on to the system.

„ Warnings indicate that a process or action might not function


correctly, or might eventually fail if preventive action isn’t taken. For
example, if an ActiveX Control used in a graphic display is a
different version than the one installed at the RSView SE Client, a
warning is logged to indicate the mismatch. Mismatched ActiveX
Controls might not behave as expected at run time.

„ Information indicates that a process or action has completed


successfully. For example, a user logged on to the system.

„ Audit indicates that the system configuration has been changed.

RSView also records an audit message:

„ for all tag writes.

„ whenever an editor that handles multiple components adds,


deletes, or removes a component. Examples of multi-
component editors are the Data Log Models editor, Graphics
editor, and Macros editor.

Audience

FactoryTalk-enabled products categorize messages in different ways so


they can be sorted, and then viewed together. For example, RSView
categorizes tag writes as Developer.

12–4 ■ RSView Supervisory Edition User’s Guide


RSView categorizes all the messages it generates as Operator, except
for audit messages, which are categorized as Developer, and as Secure.

RSView does not make use of the Engineer category. Selecting this
option has no effect for messages generated by RSView.

More detail about how tag writes are categorized

Tag writes that are successful are categorized as Information, and as


Audit. Tag writes that fail are categorized as Error, and as Audit.

The audiences for tag writes, whether successful or unsuccessful, are


Developer and Secure. All other messages are categorized as Operator.

The Secure audience allows auditing tools, such as those required for
US Government 21 CFR Part 11 compliance, to track system activity.

IMPORTANT You cannot specify, or change the audience or the


severity of diagnostic messages. For example, you
cannot specify that a Developer receive all messages of
type Error.

You can only specify that messages that are generated


for a particular audience be logged to a particular
destination. For example, you can specify that messages
about tag writes that are logged for the audience
Developer be sent to the local log file, or the Diagnostics
List, or both, or neither.

If messages for a category are not routed to any


destination, the messages for that category are not
logged.

Logging system activity ■ 12–5


Summary of steps
The main steps involved in setting up FactoryTalk Diagnostics are
described below. You do not have to complete the steps in this order.

1. Decide what information needs to be logged, and from which


computers on your network.

2. On each of the computers on which you want to log system


activity, run the FactoryTalk Diagnostics Setup tool. Set up:
„ where you want to send the information. These are called
destinations.
By default, system activity is logged to a local file on each
computer.
„ which categories of information are sent to which destination.
This is called message routing, and allows you to specify where
(to what destination) to send what information (of what
severity) and for whom (for what audience).
By default, all system activity is logged to the local log file on
each computer.

Tag writes are logged to the severities called Error or


Information, and Audit, and to the audiences called Developer,
and Secure.

All other messages are logged to the audience called Operator,


and to the severities called Error, Warning, or Information.

3. If you want to log system activity to a central, ODBC-compliant


database, set up the database, and then set up the ODBC
Database destination in the FactoryTalk Diagnostics Setup tool.

For details about the schema for the ODBC database, see Appendix D,
The ODBC database schemas.

12–6 ■ RSView Supervisory Edition User’s Guide


The FactoryTalk Diagnostics Setup tool
The instructions in this chapter describe how to set up FactoryTalk
Diagnostics for use with RSView.

If you use FactoryTalk Diagnostics with other Rockwell Software


products installed on the same computer, also see the documentation
for those products for details about setting up FactoryTalk
Diagnostics.

To open the FactoryTalk Diagnostics Setup tool

X Do one of the following:

„ In RSView Studio or in the RSView Administration Console,


click the Tools menu, and then click Diagnostics Setup.
„ Click the Start button, select Programs, Rockwell Software,
Utilities, and then click Diagnostics Setup.

Click here to expand the list


of destinations.

Specify where the log file is


located, its maximum size,
and when entries are
overwritten.

Optionally, set up logging to


a central database.

Specify which destinations


receive which categories of
messages.

Logging system activity ■ 12–7


IMPORTANT You must run the Diagnostics Setup tool on every
computer on which you want to log system activity.

System activity for all the Rockwell Software programs


running on the computer is logged to the log files on
that computer.

Setting up the local log file


1. In the Diagnostics Setup tool, click Local log.

2. Fill in the fields as described in the sections that follow. To save the
changes, click Apply. When you are finished, click OK.

Setting up the logging path


1. Click the Browse button.

Browse button
2. In the Browse for Folder dialog box, click the folder in which you
want to create the log file.

3. Click OK.

12–8 ■ RSView Supervisory Edition User’s Guide


Setting up the maximum size of the log file
Fill in the fields described below to specify the maximum size for the
log file, and then specify what happens when the log file reaches its
maximum size.

Maximum log size Type or select the maximum size of the log file in
kilobytes.

Overwrite events as needed Select this option to overwrite the


oldest event in the log file when the log file becomes full and a new
event occurs.

Overwrite events older than x days Select this option to overwrite


events older than the specified number of days only. The system does
not overwrite events newer than the specified number of days. If the
log file becomes full, and there are no events older than the specified
number of days, new events are discarded.

Do not overwrite events Select this option if you don’t want the
system to overwrite any events in the log file. To prevent the log file
from becoming full, clear the log file manually, as described below. If
the log file becomes full, new events are discarded.

Logging system activity ■ 12–9


Clearing the log file manually

1. Click Clear Log.

2. If you want to save a copy of the log file before it is cleared,


click Yes.

3. Browse for the folder in which you want to save the file.

4. Type a name for the file, and then click Save.

Logging to a central database

In addition to logging to a local log file on each computer, you can


optionally set up FactoryTalk Diagnostics to log data to a central,
ODBC-compliant database.

This option is only available if FactoryTalk Directory, RSView Studio,


RSView Administration Console, RSView SE Server, or the RSView
SE Client are also installed on the computer on which FactoryTalk
Diagnostics is installed.

Central logging works by periodically exporting the contents of the


local log file to an ODBC-compliant database. RSView supports the
following ODBC-compliant databases: Microsoft Access, Sybase SQL
Server, Oracle, and Microsoft SQL Server.

If you have set up FactoryTalk Diagnostics to overwrite events in the


local log file, make sure messages are logged to the ODBC-compliant
database before the oldest events are deleted.

12–10 ■ RSView Supervisory Edition User’s Guide


For information about the contents of the FactoryTalk Diagnostics
ODBC tables, see page D-1.

To log data to a central database

1. In the Diagnostics Setup tool, expand the Destination Setup list,


and then click ODBC Database.

2. Fill in the fields as described in the sections that follow. Click


Apply to save the changes without closing the Diagnostics Setup
window.

3. When you are finished, click OK.

Logging system activity ■ 12–11


Setting up message buffering
FactoryTalk Diagnostics messages are stored in the computer’s local
log file, and are exported to the ODBC-compliant database at the
interval you specify.

You can also specify that messages remain in the local log file for a
period of time after they have been exported to the ODBC-compliant
database. This is useful in the event of a network failure, or any other
reason that causes the database to be unavailable. In this case, the
messages remain in the local log file until the buffer time expires. If the
ODBC-compliant database becomes available during that time, the
buffered messages are then exported to the database.

Log message to database every: Type a number, and then select a


time interval to specify how frequently messages are exported from the
local log file to the ODBC-compliant database. Ensure this interval is
lower than the interval at which the contents of the log file is
overwritten.

Buffer message locally for up to: Type a number, and then select a
time interval to specify how long messages should remain in the local
log file before they are deleted.

12–12 ■ RSView Supervisory Edition User’s Guide


Setting up the ODBC data source

Data source name Type the name of the ODBC data source. To
browse for the data source name, click the Browse button.
Browse button
Target table Type the name of 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.

Maintain connection Specify how long the connection to the


ODBC-compliant database should remain open. Type the number of
minutes, or click indefinitely.

Login required If the ODBC database and HMI server are not
located on the same computer, you must enter a Database user ID and
password to connect to the database. Select the Login Required check
box, and then type the user ID and password.

If the ODBC 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 FactoryTalk Diagnostics service
runs. For details, see page 12-15.

Logging system activity ■ 12–13


Routing messages
For each destination you have set up, you can specify how messages are
routed. Routing messages consists of specifying two things: what kinds
of messages are routed to what audiences.

To route messages

1. Click a destination in the list.

2. Select or clear check boxes for the messages types you want to log,
and the audiences you want to receive them.

IMPORTANT RSView does not log any messages for the audience
called Developer. Selecting check boxes for the
audience Developer has no effect.

All messages are logged as Error, Warning, or Info,


depending on their severity, with the audience,
Operator.

Tag writes are the only messages generated by


RSView that are also logged as Audit, with the
audiences, Developer and Secure.

12–14 ■ RSView Supervisory Edition User’s Guide


3. To save changes without closing the Diagnostics Setup dialog box,
click Apply.

4. Click Accept message from Windows CE devices if you want the


computer to receive messages that are broadcast by Windows CE
devices on the network.

This feature is for use with RSView Machine Edition applications


only. For details, see the RSView Machine Edition User’s Guide.

5. When you are finished, click OK.

Setting up security to allow logging system activity to


a remote computer

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 logging service.

To change the security account of the activity logging


service in Windows 2000

1. 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 RsLogExpServ, and then click


Properties.

6. In the RsLogExpServ Properties dialog box, click the Identity tab.

Logging system activity ■ 12–15


7. Do one of the following:

„ If you are using a network share or UNC path, click This user,
and then type the name and password of a user that has access
to the network path or database.
„ If you are using a mapped network drive, click Interactive user.

8. Click OK.

9. Restart the computer.

To change the security account of the activity logging


service in Windows XP

1. Click the Windows Start button, and then click Run.

2. In the Open box, type dcomcnfg, and then press Enter.

3. In the Component Services window, double-click Component


Services, double-click the Computers folder, double-click My
Computer, and then double-click DCOM Config.

4. If DCOM Configuration Warning messages appear, click No for


each one.

5. In the Distributed COM Configuration Properties dialog box,


click the Applications tab.

12–16 ■ RSView Supervisory Edition User’s Guide


6. In the Applications list, click RsLogExpServ, and then click
Properties.

7. In the RsLogExpServ Properties dialog box, click the Identity tab.

8. Do one of the following:

„ If you are using a network share or UNC path, click This user,
and then type the name and password of a user that has access
to the network path or database.
„ If you are using a mapped network drive, click Interactive user.
9. Click OK.

10. Restart the computer.

Using the Diagnostics List


To keep track of what is happening when an application is running, use
the Diagnostics List.

Diagnostics List
Status bar

Logging system activity ■ 12–17


For system activity messages to appear in the Diagnostics List,
messages must be routed to the Diagnostics List. For details about
routing messages, see page 12-14.

Hiding, showing, and moving the


Diagnostics List
When RSView Studio first starts, the Diagnostics List is visible and is
docked above the status bar in the RSView main window.

Hiding and showing the Diagnostics List

To show or hide the Diagnostics List, click Diagnostics List on the


View menu. When Diagnostics List has a check mark beside it, the
Diagnostics List is visible.

Moving the Diagnostics List

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

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

To prevent the Diagnostics List from docking automatically while you


move it across the screen, hold down the Ctrl key on the keyboard
while you move the Diagnostics List.

12–18 ■ RSView Supervisory Edition User’s Guide


Resizing the Diagnostics List

When the Diagnostics List 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 Diagnostics List

The types of messages that appear in the Diagnostics List depend on


what is set up in the Message Routing window of the Diagnostics Setup
dialog box.

Diagnostics 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. To view the
whole message, resize the
Diagnostics List.

To clear messages, click the Clear or Clear All button. Clear removes
the top message. Clear All removes all the messages. Clearing a message
in the Diagnostics List does not delete the message from the
Diagnostics log file.

Viewing FactoryTalk Diagnostics log files

Use the FactoryTalk Diagnostics Viewer to view the contents of


FactoryTalk Diagnostics log files.

You can open the FactoryTalk Diagnostics Viewer from within


RSView Studio, or the RSView Administration Console.

Logging system activity ■ 12–19


To open the FactoryTalk Diagnostics Viewer

X Do one of the following:

„ In RSView Studio, or the RSView Administration Console,


click the Tools menu, and then click Diagnostics Viewer.
„ Click the Windows Start button, select Programs, Rockwell
Software, Utilities, and then click FactoryTalk Diagnostics
Viewer.
For information about setting up and using the FactoryTalk
Diagnostics Viewer, see Help.

Using the Diagnostics Viewer at run time


To display the Diagnostics Viewer at run time:

1. In a graphic display, create a button operators can use to open the


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

12–20 ■ RSView Supervisory Edition User’s Guide


13
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, and can
be:

„ displayed in trends.

„ archived for future use.

„ analyzed using any ODBC-compatible reporting software, such as


Microsoft Excel, or Seagate Crystal Reports.™

About data log models

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, or records when using an ODBC-compliant database.

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 ■ 13–1


Summary of steps
To set up a data log model, specify:

„ what format to use.

„ where to store data log files (primary or 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.

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.

The log file sets


Data log files are stored in sets of three files each. Each file set includes
a file for storing numeric values (whether integers or floating point
values), text, and tag names, respectively.

13–2 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up data logging ■ 13–3


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 details about the contents of the tables, see page D-5.

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. In the Data Log Models dialog box, you
can edit these names before creating the tables, or you can specify the
names of different tables.

If you specify a backup path for an ODBC model, RSView names the
backup log files as described on page 13-3.

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.

13–4 ■ RSView Supervisory Edition User’s Guide


„ Create new tables automatically or manually in the existing database
using the Data Log Models 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 13-10 for information about the
steps you need to complete to add fields to an existing table.

The section “Data log tables” on page D-5 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 13-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 Models editor. For more
information, see “Setting up a model” on page 13-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 13-10.

3. Set up the rest of your data log model, as described in “Setting up a


model” on page 13-7.

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 13-7.
RSView can create the ODBC tables automatically, or you can create
the tables manually.

Setting up data logging ■ 13–5


The Data Log Models editor
To open the Data Log Models editor:

1. In the Application Explorer, open the Data Log folder.

2. Open the Data Log Models editor by doing one of the following:

„ Right-click the Data Log Models icon and then click New.
„ Drag the Data Log Models icon to the workspace.

Set up general aspects of


the model.

Specify the paths to which


the data is logged.

Specify when you want


logged data created
and deleted.

Specify how and when


logging should occur.

Specify the tags for which


you want to log data.

13–6 ■ RSView Supervisory Edition User’s Guide


Setting up a model
1. In the Data Log Models editor, click the Setup tab.

2. Type a description of the model. This is optional, and 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 13-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 13-37. 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 information about ODBC tables see “The ODBC database
storage format” on page 13-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 ■ 13–7


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 13-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 Tables.

13–8 ■ RSView Supervisory Edition User’s Guide


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 page 13-10.

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
page 13-10.

„ 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 D-5.

8. If the ODBC 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. For details, see “Setting up security
to allow data logging to a remote computer” on page 13-18.

Setting up data logging ■ 13–9


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.

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 starting
on page D-5.

13–10 ■ RSView Supervisory Edition User’s Guide


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 D-5.

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 starting on page D-5. 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.

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 data logging ■ 13–11


Setting up log paths

Switching log 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. If the primary path or ODBC database is still unavailable when
the buffer fills or when the maximum amount of time to buffer data
has elapsed, 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

13–12 ■ RSView Supervisory Edition User’s Guide


ODBC database has become available, RSView switches back
automatically.

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 13-19) or
the DataLogMergeToPrimary command (see page 13-20).

For models that use the file set format, 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 13-36.

Setting up data logging ■ 13–13


To specify primary and secondary paths for a file set, and the
ODBC backup file path

1. In the Data Log Models 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 runs, RSView creates a subfolder with the same name as the
model name and stores the files there.

If the primary or secondary path, or 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. For

13–14 ■ RSView Supervisory Edition User’s Guide


details, see “Setting up security to allow data logging to a
remote computer” on page 13-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 log paths” on page 13-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.

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.

Setting up data logging ■ 13–15


If the primary or secondary path, or 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. For
details, see “Setting up security to allow data logging to a
remote computer” on page 13-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.

This option only appears if


the storage format on the
Setup tab is set to File Set.

Maximum time to buffer data before attempting switchover


(minutes) If you specify 0, RSView switches over immediately and
no data is buffered.

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.

13–16 ■ RSView Supervisory Edition User’s Guide


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 ■ 13–17


Setting up security to allow data logging to a
remote computer
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.

To open the DCOM Configuration Properties dialog box in


Windows 2000

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.

To open the DCOM Configuration Properties dialog box in


Windows XP

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.

13–18 ■ RSView Supervisory Edition User’s Guide


3. In the Component Services window, double-click Component
Services, double-click the Computers folder, double-click My
Computer, and then double-click DCOM Config.

4. If DCOM Configuration Warning messages appear, click No for


each one.

5. In the Distributed COM Configuration Properties dialog box,


click the Applications tab.

To change the security account of the data log program file

1. Open the Distributed COM Configuration Properties dialog box


as described for Windows 2000 or Windows XP in the sections
above.

2. In the Applications list, click DatalogServ, and then click


Properties.

3. In the DatalogServ Properties dialog box, click the Identity tab.

4. Click This user, and then type the name and password of a user
that has access to the network share or database.

5. Click OK.

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.

Setting up data logging ■ 13–19


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 make it possible for operators 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.

Using DataLogMergeToPrimary 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 FactoryTalk Diagnostics 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

13–20 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up data logging ■ 13–21


To prevent loss of data, you can monitor disk space. For details about
monitoring disk space on computers running HMI servers, see
page 28-4.

To specify when to start new file sets

1. In the Data Log Models 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.

13–22 ■ 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 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, Sat


Date 1 to 28

You cannot specify 29, 30, or 31. You cannot


create new log files on the 29th, 30th, or 31st of
the month.
Hour 00: to 23:
Minute :00 to :59

You can combine hours and minutes with a day or date.

Setting up data logging ■ 13–23


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:

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 20, 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 Models editor, click On Event, and then in the expression
box, type NextShift.

13–24 ■ RSView Supervisory Edition User’s Guide


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. For
details about monitoring disk space on computers running HMI
servers, see page 28-4.

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 Models editor. The new file set is created in the same path that
RSView is currently logging to.

Setting up data logging ■ 13–25


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 make it possible for operators 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.

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.

13–26 ■ RSView Supervisory Edition User’s Guide


To specify when to delete file sets or ODBC database data

1. In the Data Log Models 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 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.

Setting up data logging ■ 13–27


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 13-29.

3. If you are using the ODBC storage format, select the check box,
After Maximum Time. 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.

13–28 ■ RSView Supervisory Edition User’s Guide


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 13-33.

To specify what should trigger logging

1. In the Data Log Models editor, click the Log Triggers tab.

2. To specify a log trigger, click an option, and then fill in any


additional information. For information about the different types
of log triggers, see the topics below.

Setting up data logging ■ 13–29


Logging periodically
Periodic logging takes a snapshot of all tag values at periodic time
intervals.

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 OPC update rate or OPC
topic poll rate, or you will log redundant data.

You can change the periodic log rate at run time, as described on
page 13-37. 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.

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.

13–30 ■ RSView Supervisory Edition User’s Guide


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.

Setting up data logging ■ 13–31


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 13-33.

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

13–32 ■ RSView Supervisory Edition User’s Guide


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.

To combine logging

1. In the Data Log Models 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:

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

Setting up data logging ■ 13–33


Choosing the data to be logged
Log models can contain up to 10,000 tags.

To specify tags

1. In the Data Log Models 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.

13–34 ■ RSView Supervisory Edition User’s Guide


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

Setting up data logging ■ 13–35


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.

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 13-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).

13–36 ■ RSView Supervisory Edition User’s Guide


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.

Setting up data logging ■ 13–37


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 information about trends, see Chapter 19, 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 HMI Server Properties dialog box, click the Components


tab, 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 multiple DataLogOn <component> commands 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 action box,

13–38 ■ RSView Supervisory Edition User’s Guide


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 about stopping running components:

„ in distributed applications, see page 26-9.

„ in stand-alone applications, see page 27-3.

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.

Setting up data logging ■ 13–39


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

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

13–40 ■ RSView Supervisory Edition User’s Guide


14
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 at 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 run, see


page A-4.

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 20,
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 ■ 14–1


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.

14–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 ■ 14–3


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 does not appear anywhere else.

For example, if you were creating an event component for a certain


area of your plant, you might type 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 OPC server update rate, or DDE server polling rate.

4. Click OK.

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.

14–4 ■ RSView Supervisory Edition User’s Guide


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.

For information about macros and symbols, see Chapter 23, 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.

Setting up events ■ 14–5


3. In the Description box, type a brief description to document the
event’s function. This description is for your information only—it
does not appear anywhere else.

4. In the Expression box, create an expression to specify the


conditions that will trigger the action.

For information about expressions, see Chapter 20, 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.

To edit an event

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.

14–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 HMI Server Properties dialog box, click the Components
tab, select the Events 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 ■ 14–7


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 about stopping running components:

„ in distributed applications, see page 26-9.

„ in stand-alone applications, see page 27-3.

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.

14–8 ■ RSView Supervisory Edition User’s Guide


15
Chapter

Setting up security
Set up security in 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 opening an application using RSView Studio, or


the RSView Administration Console.

„ lock users into the RSView SE Client environment.

How security works


Commands, macros, graphic displays, or HMI tags are secured only
when the application is opened in the RSView SE Client.

In RSView Studio or the RSView Administration Console, only the


application can be secured. After a user has opened an application in
RSView Studio or the RSView Administration Console, no further
security is available for the components in the application.

Setting up security ■ 15–1


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, or a local workstation domain.
For an example of how to use user groups, see page 15-3.

„ assign a security code (A through P) to each user or group.


Security is based on a system of codes. You decide what the security
codes mean.

2. Assign security codes to commands, graphic displays, or HMI tags.

Only users with the specified security code can run the secured
commands, open 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, a ControlLogix address) to an HMI tag,
and then secure the HMI tag. For information about
creating HMI tags, see Chapter 8, 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.

15–2 ■ RSView Supervisory Edition User’s Guide


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.

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. This group can also
access any graphic displays that have no security assigned to them.

Setting up security ■ 15–3


„ users who belong to the Shift Supervisors group can access
everything at run time when they are using the RSView SE Client,
but they cannot open the application in RSView Studio, or the
RSView Administration Console.

„ Gail has full access to the system at run time, 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.

Before you begin, make lists


Before you begin, gather lists of the:

„ users or groups of users requiring accounts.

„ RSView commands and macros you want to secure.

For a complete list of RSView commands, see Appendix A, RSView


commands, or see Help.

„ graphic displays, OLE objects with verb animation, and tags you
want to secure.

Finding your way around


To assign security codes to Use the For details, see

users or groups User Accounts below


editor
RSView commands and macros Secured page 15-11
Commands editor
graphic displays and OLE Graphic Displays page 15-14
objects with verb animation editor

15–4 ■ RSView Supervisory Edition User’s Guide


To assign security codes to Use the For details, see

tag writes, RSView commands, Electronic page 17-248


and input fields in graphic Signature button in
displays the Graphic
Displays editor
HMI tags Tags editor page 15-17
an application Application page 15-19
Explorer

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.

The list of RSView users can be users or groups in a Windows network


domain, or a local workstation domain.

Any users you don’t select for the RSView user list will not have access
to the parts of the application you have secured.
This is the RSView
User Accounts editor.
Using this editor, you
can add Windows
users or groups to the
list of users in
RSView.

The main use for this


editor is to assign
RSView security
codes to Windows
users and groups

Setting up security ■ 15–5


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

X 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 the


groups are enclosed
in square brackets.

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.

15–6 ■ RSView Supervisory Edition User’s Guide


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 or local workstation
domain.

To add users from a Windows domain, your network must have at least
one Windows server acting as a domain controller.

You can use local workstation domains provided that all computers
participating in the application have identical sets of user accounts and
passwords, are in the same Windows workgroup, and all users
participating in the workgroup must have administrative rights.

IMPORTANT All of the users participating in your distributed


application must be members of the same Windows
domain or Windows workgroup.

To add user accounts from a Windows domain

1. On the Setup menu, click Add User/Group, or click the Add


Add User/Group tool 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.

Setting up security ■ 15–7


3. In the Windows Users or Groups list, click the user or group
names you want to include in the RSView User Accounts list.

To select multiple users, do one of the following:

„ Click a user name, and then drag the mouse up or down.


„ Click a user name, and then Shift-click other user names
immediately above or below the first selected user name.
„ Click a user name, and then Ctrl-click other user names
anywhere in the 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 name of the user or group is deleted from the RSView User
Accounts list. The user or group is not deleted from the Windows
domain.

„ The security codes of the user or group 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.

15–8 ■ RSView Supervisory Edition User’s Guide


To remove user accounts from the RSView user list

1. On the Setup menu, click Add User/Group, or click the Add


Add User/Group tool User/Group tool on the toolbar.

2. In the RSView User Accounts list, click the user name or group
name you want to delete.

To select multiple users, do one of the following:

„ Click a user name, and then drag the mouse up or down.


„ Click a user name, and then Shift-click other user names
immediately above or below the first selected user name.
„ Click a user name, and then Ctrl-click other user names
anywhere in the list.
3. Click the Remove button.

4. When you are finished, click OK.

Setting up security ■ 15–9


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. In the Security Codes area, select the check box for each security
code you want this user to have access to.

3. Click Accept.

4. Repeat steps 1 through 3 for each user.

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

For the login and logout macros to be executed, they must be in the
area from which the Login or Logout command was executed.

For more information about macros, see “Creating macros” on


page 22-1.

To assign a login or logout macro to a user account

1. In the User Accounts editor, click the name of the user or group
whose account you want to change.

2. Type the name of a macro in the Login Macro box and Logout
Macro box.

These macros run each time this user logs in and out. For more
information about macros see “Login and logout macros” on
page 15-10.

15–10 ■ RSView Supervisory Edition User’s Guide


3. Click Accept.

4. Repeat steps 1 through 3 for each user to whom you want to assign
a login or logout macro.

5. To save the user account configuration, click Close.

Securing commands and macros


In the Secured Commands editor, create a list of the RSView
commands and macros you want to secure, and then assign a security
code to each item in the list.

You can also secure commands using the Signature button in a graphic
display, to control the actions an operator can perform at run time, for
example:

„ setting the value of a tag.

„ issuing a command.

„ downloading values in all of the input fields in the display to


programmable controllers or devices.

For details about using the Signature button, see “Recording and
authorizing run-time changes using electronic signatures” on
page 17-248.

Setting up security ■ 15–11


To open the Secured Commands editor

X In the Application Explorer, do one of the following:

„ Double-click the Secured Commands icon.


„ Right-click the Secured Commands icon and then click Open.

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.

15–12 ■ RSView Supervisory Edition User’s Guide


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.

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 Secured Commands editor.

To set up security by inclusion

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. Optionally in the Description field, type a remark to describe the


level of security provided.

5. Repeat steps 2 through 4 for each command and macro.

6. To save the configuration, click Close.

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 Secured Commands editor.

Setting up security ■ 15–13


To set up security by exclusion

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. Optionally in the Description field, type a remark to describe the


level of security provided.

5. Repeat steps 2 through 4 for each command and macro.

6. To save the configuration, click Close.

Assigning security to a graphic display

Use the Graphic Displays editor to assign security to a graphic display.


You can assign security while you are creating a graphic display, or you
can assign it later.

You can also secure objects in a graphic display using the Signature
button, to control the actions an operator can perform at run time, for
example:

„ setting the value of a tag.

„ issuing a command.

„ downloading values in all of the input fields in the display to


programmable controllers or devices.

15–14 ■ RSView Supervisory Edition User’s Guide


For details about using the Signature button, see “Recording and
authorizing run-time changes using electronic signatures” on
page 17-248.

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.
2. In the Security Code list, click a security code.

Click a security code.

3. Click OK.

Setting up security ■ 15–15


Assigning security to an OLE object
Use the Graphic Displays editor to assign security to a graphic object
with OLE verb animation.

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.

4. Click the OLE Verb tab.

Click a security code.

15–16 ■ 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


Use the Tags editor to assign 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.

You can also secure tags using the Signature button in a graphic display,
to control the actions an operator can perform at run time, for
example:

„ setting the value of a tag.

„ issuing a command.

„ downloading values in all of the input fields in the display to


programmable controllers or devices.

For details about using the Signature button, see “Recording and
authorizing run-time changes using electronic signatures” on
page 17-248.

Setting up security ■ 15–17


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.

15–18 ■ RSView Supervisory Edition User’s Guide


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.

Setting up security ■ 15–19


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 16-63.

Disable access to the operating system

You can do this by:

„ preventing users from switching to other applications.

To do this, set up the RSView SE Client using the RSView SE Client


Wizard.

For details about setting up clients:

„ in distributed applications, see page 26-14.


„ in stand-alone applications, see page 27-5.
„ preventing 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.

15–20 ■ RSView Supervisory Edition User’s Guide


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.

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, the


account of the Windows user that is logged in must not be 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. All displays are closed (including cached displays).

2. The current user’s logout macro is executed and the user is logged
out.

Setting up security ■ 15–21


3. If the RSView SE Client is licensed, it releases the license, allowing
the license to be used for other RSView SE Clients.

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

15–22 ■ RSView Supervisory Edition User’s Guide


16
Chapter

Creating graphic displays


This chapter describes the Graphic Displays editor and describes:

„ basic techniques for using the Graphic Displays editor.

„ how to set up the drawing environment.

„ how to draw, edit, and arrange graphic objects.

„ how to import graphic files from third-party applications.

„ how to use objects from the Graphic Libraries editor.

„ how to re-use the same graphic display with different sets of tags.

„ how to set up the graphic display for run-time use.

„ how to print graphic displays at run time.

For details about creating and editing specific graphic objects, see
Chapter 17, Setting up graphic objects.

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. This limit includes the tags contained in embedded variables.

Creating graphic displays ■ 16–1


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.

„ created by another Windows application and inserted in the graphic


display using OLE (Object Linking and Embedding).

„ ActiveX™ objects 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.

16–2 ■ RSView Supervisory Edition User’s Guide


The parts of the editor
The Graphic Displays editor consists of the following parts:

Docked toolbar

Drawing area

Floating toolbar

Diagnostics list

Status bar

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

The display area is your graphic display. The appearance of the


display in the Graphic Displays editor is similar to what you see at run-
time, except for the title bar and the position of the display. If you
change the zoom settings or resize the display by dragging the borders
of its window, these changes do not affect the appearance of the display
at run time.

Creating graphic displays ■ 16–3


If you want the display to have a title bar at run time, set up the title bar
in the Display Settings dialog box. You can also use the Display Settings
dialog box to specify the size of the display, its position, its background
color, and whether it has a border at run time. For details, see the
sections starting on page 16-66.

The Object Explorer lists all the objects and groups of objects in your
display. The Object Explorer does not list objects that have been
converted to wallpaper.

You can click an object in the list to select it in your display. You can
also right-click the object to open the context menu for the object.

You can keep the Object Explorer open while you work on different
objects, and in different displays. For more information about using the
Object Explorer, see page 16-11.

The Property Panel displays the properties of the selected objects, and
shows what values are assigned to the properties. For example, the
Property Panel shows whether an object’s background style (BackStyle)
is solid or transparent. The Property Panel also lists the object’s
connections, and shows which tags or expressions have been assigned
to them.

In addition to displaying information, you can use the Property Panel


to modify the properties of graphic objects, and to assign tags and
expressions to the objects.

You can keep the Property Panel open while you work on different
objects, and in different displays. For details about using the Property
Panel, see page 16-34.

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.

16–4 ■ RSView Supervisory Edition User’s Guide


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.

Correcting mistakes
If you change your mind about something you did, undo the action. If
Undo you change your mind again, redo the action.

To undo an action
Redo
X On the Edit menu, click Undo, or on the toolbar, click the Undo
button.

To redo an action

X On the Edit menu, click Redo, or on the toolbar, click the Redo
button.

Zooming in and out


To magnify or reduce your view of a graphic display, use Zoom In or
Zoom in Zoom Out. Zoom In magnifies objects, Zoom Out reduces
magnification.

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

Creating graphic displays ■ 16–5


To zoom out

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

To cancel Zoom to fit

X On the View menu, click Cancel Zoom.

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


make the grid active. Set the spacing of
Select a color for the the grid points in
grid points. pixels.

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

16–6 ■ RSView Supervisory Edition User’s Guide


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 toolbars


The toolbars are a convenient way to perform an action. You can:

„ 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 ■ 16–7


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.

Freehand tool Text 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.

16–8 ■ RSView Supervisory Edition User’s Guide


To deselect a drawing tool

X Do one of the following:

„ Click the Select tool.

„ Click another drawing tool.

Testing graphic displays

To quickly test objects in a graphic display, use Test Display mode.


Test Display mode When you are finished 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 you want to use test mode and your graphic displays contain objects
associated with tags, your system must be set up to communicate with
data servers, OPC servers, or DDE servers.

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

Working with objects

Once you have drawn an object, you can select the object, and then edit
it. You can:

„ move objects.

„ copy objects.

„ duplicate objects.

„ resize objects (except text objects).

Creating graphic displays ■ 16–9


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 16-11.

To use the Select tool

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

Selecting objects

To select Do this

An object or group of Do one of the following:


objects
„ Click the object or group.
„ In the Object Explorer, click the object or
group.
An object within the Do one of the following:
group of objects
„ Double-click the group, and then click the
object.
„ 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.
All objects in the On the Edit menu, click Select All, or press Ctrl-A
drawing area, or in a on the keyboard.
group you are editing

16–10 ■ RSView Supervisory Edition User’s Guide


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.

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 an object that is hidden behind other
objects in the display, without bringing the object to the front. Objects
are listed in front-to-back order. The object you created most recently
is at the front, unless you move it back using the Send to Back option.
For details about stacking objects, see page 16-21.

You can also use the Object Explorer to highlight objects that have
animation attached, and to highlight objects with specific tag or
expression assignments. For more information, see page 16-13.

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

X Do one of the following:


Show/Hide Object Explorer
tool
„ On the Graphics toolbar, click the Object Explorer tool.
„ On the View menu, click Object Explorer.
„ Right-click an object, and then click Object Explorer.

Creating graphic displays ■ 16–11


You can keep the Object Explorer open as you work in the Graphic
Displays editor.

To view the objects in a group

X Do one of the following:

„ Click the + icon next to the group name.


„ Double-click the group name.
„ Click the group name, and then click Expand.
The list expands to show the objects and groups within the group.

If the list is already expanded, double-clicking the group name, or


clicking Collapse, collapses the group.

Click the + icon to view the


objects and grouped objects
within the group.

When you click an object in When you right-click an


the Object Explorer, you object in the Object Explorer,
automatically select the the object’s context menu
object in the graphic display. opens, just as if you had
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.

16–12 ■ RSView Supervisory Edition User’s Guide


„ For ActiveX objects, the object’s behavior depends on the vendor’s
implementation.

Highlighting objects in the Object Explorer

You can use the Object Explorer to highlight:

„ specific types of objects

„ objects that have animation attached

„ objects that have a specific tag or expression assigned to them

The objects are highlighted in red in the Object Explorer and in the
graphic display. If your graphic display uses a red background, the
highlighting is not visible in the graphic display.

To highlight objects in the Object Explorer

1. In the Object Explorer, click Highlighting on, and then click


Settings.

To clear all the check boxes,


right-click the list, and then
click Clear All.
To select all the check
boxes, right-click the list, and
then click Select All.

Creating graphic displays ■ 16–13


2. To highlight one or more object types, select the check boxes in the
By object type list.

3. To highlight objects with one or more types of animation assigned,


select the check boxes in the By animation type list.

Each object that has one or more of the specified animation types
assigned will be highlighted.

4. To highlight objects that have a specific tag or expression assigned


to them, select the check box, By tag name, and then select a tag or
expression from the list.

The list displays all the tags and expressions that have been assigned
to objects in the graphic display, except tags contained in embedded
variables.

5. Click OK.

Objects with the specified highlight settings are highlighted in the


Object Explorer and in the graphic display.

Objects that use embedded variables containing the tag specified in


step 4 are not highlighted in the Object Explorer, unless they match
the criteria specified in steps 2 or 3.
If an object is selected in the display,
and highlighted in the Object Explorer,
its highlight is gray.

16–14 ■ RSView Supervisory Edition User’s Guide


Using the context menu
No matter where you are in the Graphic Displays editor, you can open
a context menu by clicking the right mouse button. The items on the
menu depend on the cursor’s location. For example, when you right-
click an object, the menu contains items relevant to that object.

When you right-click an


object …

… the context menu


opens. It contains
menu items for
working with the
selected object.

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.

Creating graphic displays ■ 16–15


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.

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.

16–16 ■ RSView Supervisory Edition User’s Guide


3. When the object is where you want it, release the mouse button
and Ctrl key.

A new copy of the object is created.

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.


Cut
2. On the Edit menu, click Cut or Copy, or click the Cut or Copy
button on the toolbar.

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


Paste
2. On the Edit menu, click Paste, or click the Paste button on the
toolbar.

Creating graphic displays ■ 16–17


To delete objects

X 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.
Duplicate
1. Select one or more objects.

2. On the Edit menu, click Duplicate, or click the Duplicate button


on the toolbar.

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.

16–18 ■ RSView Supervisory Edition User’s Guide


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.

Creating graphic displays ■ 16–19


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:

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

„ rotate objects around an anchor point.

„ combine several objects into a group that behaves as a single object.

„ divide a grouped object into its component objects.

16–20 ■ RSView Supervisory Edition User’s Guide


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


Bring to Front Front button on the toolbar.

Select the object from behind. Bring the object to front.

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


Send to Back Back button on the toolbar.

Select the object. Send the object to back.

Creating graphic displays ■ 16–21


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

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

16–22 ■ 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 ■ 16–23


Aligning objects top, middle, and bottom

Align top

Align middle

Align bottom

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


Space Horizontal objects an equal distance apart
horizontally.
Places the centers of the selected
Space Vertical
objects an equal distance apart vertically.

16–24 ■ RSView Supervisory Edition User’s Guide


Spacing objects vertically and horizontally

Centers are
separated by an equal
vertical distance.

Select objects Space vertically

Centers are
separated by an equal
horizontal distance.

Select objects Space horizontally

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

Creating graphic displays ■ 16–25


Flipping objects vertically and horizontally

Select object Flip vertical

Select object Flip horizontal

Rotating objects
Use the Rotate tool to rotate an object or group of objects around an
Rotate tool anchor point.

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 18-29.

You cannot rotate OLE objects, ActiveX objects, bitmaps, and text.

16–26 ■ 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.

You can place the crosshair 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 ■ 16–27


Grouping and ungrouping objects
Grouping combines several objects into a single object so you can
manipulate them as a single object. Grouping is useful for keeping
objects in the same position relative to each other. You can cut, copy,
and paste groups, arrange the group as a single object relative to other
objects, and apply the same properties to all the members of the group
at once.

You can attach animation to a group, and any animation attached to


individual objects in the group remains active. The group animation
generally takes precedence over the animation of individual objects
within the group. For more information, see “Applying animation to
groups” on page 18-65.

To group objects

1. Select all the objects you want grouped.

2. On the Arrange menu, click Group, or click the Group button on


Group the toolbar.

The handles around each object are replaced by a set of handles


around the group.

Drag the mouse to select the objects. Group them.

16–28 ■ RSView Supervisory Edition User’s Guide


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


Ungroup on the toolbar.

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


Edit a group of objects in the same way you would edit an individual
object. You can:

„ use the Property Panel to apply the same properties to all the
members of the group at once. For example, change the line width
of all objects in the group to 2 pixels.

Creating graphic displays ■ 16–29


For information about using the Property Panel to edit groups of
objects, see “Viewing properties for grouped objects” on
page 16-37.

„ use the toolbars to apply the same pattern style, background style,
foreground colors, and background colors to all the members of the
group.

„ for objects that have states, use the States toolbar to cycle through
the states and apply the same properties to the states for each object
in the group at once. When you select a group containing objects
with states, only the states that are common to all objects in the
group appear in the toolbar. For information about using the States
toolbar, see “Testing the appearance of objects in different states”
on page 16-42.

Editing a group of objects without breaking the group is particularly


useful when you have animation attached to groups, because when you
ungroup an object, any animation attached to the group is deleted.

To edit grouped objects, double-click the grouped object. A rope-like


border appears around the group. Click inside this box to access
another group or to access the individual objects.

Double-click to edit the Click again. Handles appear.


group. A rope-like border The handles show the
appears. This border individual object selected
indicates that this is a group. within the group.

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 use the
Object Explorer. For details about using the Object Explorer, see
page 16-11.

To stop editing, click outside of the group.

16–30 ■ RSView Supervisory Edition User’s Guide


Applying colors
The color palettes contain the colors you can apply to objects. To show
and hide the color palettes, click them on the View 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.

For objects with patterns, you can set the color of the pattern
separately. To do this, open the object’s Properties dialog box, click the
Pattern color box, and then click a pattern color.

To make objects blink, attach color animation to the objects. For


details, see page 18-14.

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 ■ 16–31


Applying pattern styles
Pattern styles are available on the Pattern Styles toolbar. To see the
toolbar, click the View menu, select toolbars, and then click Pattern
Styles.

An object’s pattern only appears if the object’s background style is


Solid. Objects with a transparent background have no pattern.

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

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.

16–32 ■ RSView Supervisory Edition User’s Guide


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.

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 context 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

Creating graphic displays ■ 16–33


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 Trend Properties dialog box.

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

X Do one of the following:


Show/Hide Property Panel
„ On the Graphics toolbar, click the Show/Hide Property Panel
tool
tool.
„ On the View menu, click Property Panel.

16–34 ■ RSView Supervisory Edition User’s Guide


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

Click this button for help with


the selected property.

Scroll to see more


properties …

… or drag this bar up or


This box describes the
down to see more properties,
selected property, and
or more of the description.
indicates the type of data the
property uses.

Setting up properties

Use the Properties tab in the Property Panel 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.

Creating graphic displays ■ 16–35


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 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 button
Browse button to open the dialog box.

Some objects that can be set up using a Properties dialog box, have
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.

16–36 ■ 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 that
one object is selected, this are shared among all
box shows the object’s selected objects, click
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 ■ 16–37


Assigning tags and expressions to objects
Use the Connections tab in the Property Panel 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 object can write to the tag or expression.

„ A left arrow indicates that the tag or expression sends values to the
object. The object can read from the tag or expression.

„ A double arrow indicates that the data flows in both directions. The
object can write to, or read from, the tag or expression.

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.

16–38 ■ 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 8-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 20, 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 16-51.

To delete a tag or expression

X Click the row that contains the tag you want to delete, and then
press Delete.

Using tag substitution to replace text


associated with objects
You can replace any text string, such as a tag name, an expression, or
an RSView command, associated with a graphic objects using tag
substitution.

Tag substitution does not work for text objects you create using the
Text tool.

Creating graphic displays ■ 16–39


Tag substitution does not replace the tags contained in embedded
variables. To change the tags in embedded variables, edit the variables
directly. For information about editing embedded variables, see
page 21-9.

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.

The lists under the Search for, and Replace with, boxes show the
text strings used by the objects you selected in the graphic display.

The text you type in the Search for, or Replace with boxes can be
part or all of:

„ a tag name (without wildcards).

„ a folder name (without wildcards).

„ the text in an expression.

„ an RSView command.
Browse button
The Browse button opens the Tag Browser.

16–40 ■ RSView Supervisory Edition User’s Guide


3. In the Search for box, do one of the following:

„ In the list under the Search for box, select the text string you
want to search for.
„ Click the Browse button to open the Tag Browser, and then
select the tag you want to search for.
Browse button
„ In the Search for box, type the text you want to search for.
4. In the Replace with box, do one of the following:

„ In the list under the Replace with box, select the text string you
want to replace with.
„ Click the Browse button to open the Tag Browser, and then
select the tag you want to replace with.
„ In the Replace with box, type the text you want to replace with.
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.

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.

Creating graphic displays ■ 16–41


Testing the appearance of objects
in different states
Some objects have multiple states. Each state has different settings that
make the object change its appearance when its state changes. To make
sure the different states for an object are set up correctly, you can view
each of the states using the States toolbar, or using the Property Panel.

To open the States toolbar

X On the View menu, select Toolbars, and then click States.

To view an object’s states using the States toolbar

1. Select one or more objects.

2. In the States toolbar, click the state you want to view.

If you selected multiple objects, the toolbar shows the states that are
common to all the objects.

3. To view the next state, click it in the list in the States toolbar, or
press the Down Arrow key on your keyboard.

You can also use these keys to select the next state:

„ To view the previous state, press the Up Arrow key.


„ To view the first state, press the Home key.
„ To view the last state, press the End key.

To view an object’s states using the Property Panel

1. Select one or more objects.

2. In the Property Panel, click the State property and then click the
state you want to view.

3. To view the next state quickly, double-click the row, or press the
Enter key on your keyboard.

16–42 ■ RSView Supervisory Edition User’s Guide


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 16-11.

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

You can create tooltips for objects in two ways:

„ in the Property Panel. For details, see below.

„ in the Common tab of the object’s Properties dialog box. For


details, see page 17-22.

To name an object, and type a tooltip description


in the Property Panel

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

Creating graphic displays ■ 16–43


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 ( _ ).
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 type a


description for the object.

16–44 ■ RSView Supervisory Edition User’s Guide


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.

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, select Wallpaper and then click Convert to


Wallpaper.

To unlock wallpaper

X On the Edit menu, select Wallpaper, and then click Unlock


Wallpaper. All objects that were previously converted to wallpaper
are unlocked.

Creating graphic displays ■ 16–45


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
.jpg JPEG files
.dxf AutoCAD ® 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.

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.

16–46 ■ RSView Supervisory Edition User’s Guide


Converting imported objects to RSView
native objects
Converting imported objects to native objects offers the following
advantages:

„ Graphic display 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.

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 edit
device-dependent bitmaps in place 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.

Creating graphic displays ■ 16–47


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.

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.

16–48 ■ RSView Supervisory Edition User’s Guide


When a bitmap could help
Bitmaps generally make graphic displays slower. However, objects with
large amounts of detail, such as subtle shading, might draw 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


For Windows 2000, library files are stored in the folder,
\Documents and Settings\All Users\Documents\
RSView Enterprise\SE\Libraries

For Windows XP, library files are stored in the folder,


\Documents and Settings\All Users\Shared 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

Creating graphic displays ■ 16–49


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 list in the Libraries folder.

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

16–50 ■ RSView Supervisory Edition User’s Guide


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.

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.

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.

Creating graphic displays ■ 16–51


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.

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.

For details about the Display command, see Appendix A, RSView


commands, or see Help.

16–52 ■ RSView Supervisory Edition User’s Guide


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.

To run a parameter file

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

Creating graphic displays ■ 16–53


Example: Replacing tag placeholders using a
parameter component
To run the display called Canning with the parameter component called
Beans, type:

Display Canning /PBeans

Assigning parameter files to graphic displays


You can also use parameter files with:

„ graphic displays that are opened using display list selectors. For
details about setting up display list selectors, see page 17-206.

„ the graphic display that opens when the RSView SE Client connects
to the application.

In the RSView SE Client wizard, select the graphic display in the


Initial display list.

In the Display parameters box, type the /P parameter from the


Display command, and then type name of the parameter file you

16–54 ■ RSView Supervisory Edition User’s Guide


want to use with the display (for example /PBeans). You can
include any parameters to the Display command in the Display
parameters box, but do not type the Display command in the
Display parameters box.

For details about setting up RSView SE Clients:

„ in distributed applications, see page 26-14.

„ in stand-alone applications, see page 27-5.

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

X 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 at the command line.

Creating graphic displays ■ 16–55


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

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

16–56 ■ RSView Supervisory Edition User’s Guide


Setting up the display

To set up a graphic display, use the Display Settings dialog box.

To open the Display Settings dialog box

X 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 context menu.

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 graphic displays ■ 16–57


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.

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.

16–58 ■ RSView Supervisory Edition User’s Guide


Setting up display properties

The Properties tab lets you


set up the appearance,
security, and performance of
a graphic display.

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

Creating graphic displays ■ 16–59


Specifying the display type

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

16–60 ■ RSView Supervisory Edition User’s Guide


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.

For example, to display two copies of the same graphic display in


different places on the screen you could use these commands:

Display PID /Q1

Display PID /Q2

PID is the name of a graphic display. /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.

You can also run multiple copies without selecting this option, by using
the Display command with different parameter files for each copy of
the display.

For details about parameter files, see “Replacing tag placeholders using
a parameter file” on page 16-52.

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.

Creating graphic displays ■ 16–61


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.

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 16-69.

16–62 ■ RSView Supervisory Edition User’s Guide


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

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)

Creating graphic displays ■ 16–63


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 “When Resized” on page 16-66.

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.

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 This is the fastest rate at which data
servers send changes in tag values to the graphic display.

16–64 ■ RSView Supervisory Edition User’s Guide


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

Creating graphic displays ■ 16–65


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.

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 four times its original size, only one quarter of the display

16–66 ■ RSView Supervisory Edition User’s Guide


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.

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 15, Setting up security.

Creating graphic displays ■ 16–67


Specifying background color
To select a background color, click the Background Color box, and
then click a color in the palette.

Setting up display behavior

The Behavior tab lets you set


up how objects in the graphic
display behave at run time.

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

16–68 ■ 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. The cache is flushed when:

„ the FlushCache command is issued.

„ a user is logged out.

„ the RSView SE Client is closed.

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 ■ 16–69


Specifying colors for input fields

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.

Text color is the color of the text in the input field. Fill color is the
background color of the input field. To open the color palette click a
colored box, and then click a color.

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 18-52.

16–70 ■ 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 ■ 16–71


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.

16–72 ■ 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 ■ 16–73


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 16-62.

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

16–74 ■ RSView Supervisory Edition User’s Guide


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.

Creating graphic displays ■ 16–75


17
Chapter

Setting up graphic objects


This chapter describes the Graphic Displays editor and outlines how to
create and edit graphic objects.

For details about the basic techniques for using the Graphic Displays
editor, and for details about setting up graphic displays, see Chapter 16,
Creating graphic displays.

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.

Setting up graphic objects ■ 17–1


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 OCXs):


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 18, Animating graphic objects.

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

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,

17–2 ■ 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.

You can select any font you have installed, but TrueType™ and
OpenType® fonts are recommended. These fonts can be resized
easily, without losing text quality.

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

Setting up graphic objects ■ 17–3


For more design suggestions, see Chapter 3, Planning an application, and
the sample files included with RSView Studio.

Creating a text object


To create a text object:

1. Click the Text tool.


Text tool 2. Click the mouse where you want to position the text, and then drag
the pointer to draw a box to contain the text.

When you release the left mouse button, the Text Properties dialog
box opens.

3. In the Text box, type the text.

To move the cursor to the next line of text, press Enter.

To use an embedded variable in the text, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box

17–4 ■ RSView Supervisory Edition User’s Guide


that appears, make selections to compose the variable, and then
click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

4. Set up the appearance of the text, as described in the next section.

After you’ve set up one text object to look the way you want, copy
and paste it to create additional text objects with the same
formatting. Then edit the text of the new objects.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up the appearance of the text


In the General tab, specify the appearance of the text, and its font:

Font, size, and style Click a font for the text 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.

Or, click the Browse button to open the Font dialog box and set up
font attributes.
Browse button
Back color Click the color box, and then click a color for the text’s
background.

Fore color Click the color box, and then click a color for the text.

Setting up graphic objects ■ 17–5


Size to fit Select this check box to resize the text object so that all the
text you type appears in the display. Clear the check box if you want the
text to be cropped within the outline of the text object.

Word wrap Select this check box to wrap words to the next line if they
are too long for the width of the text object. Clear this check box to
wrap on characters instead.

The maximum number of characters displayed depends on the size of


the font, and the size of the box you drew to contain the text.

This option does not apply if you select Size to fit.

Alignment Click a position in the grid, relative to the text box. In the
default alignment position, the text is centered vertically and
horizontally within the text box.

Back style Click Solid to cover the display behind the text object with
a solid rectangle in the shape of the text’s box. Click Transparent to
allow the display’s background to show through between the letters.

To edit a text object

1. Double-click the text.

The Text Properties dialog box opens.

2. In the Text box, click where you want to make the change. To
delete characters, use the Backspace and Delete keys.

Adding an image to a graphic display

RSView can read .bmp and JPEG (.jpg, .jpeg, .jpe, .jif, .jfif) files in their
native format, without requiring their conversion. For information
about importing graphic files in formats other than .bmp or JPEG, see
“Importing graphic files from third-party applications” on page 16-46.

17–6 ■ RSView Supervisory Edition User’s Guide


For information about choosing graphic file formats for best
performance, and for more information about bitmap files, see “Using
bitmaps” on page 16-47.

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” on page 17-7.

„ place an image you want to use repeatedly in several displays. For


information about placing images in graphic displays, see page 17-8.

„ 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 16-46.

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.

You can paste an image you copy only for as long as the image remains
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.

Setting up graphic objects ■ 17–7


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.

Adding images to your application


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.

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 17-11.

Placing images in graphic displays


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
Image tool
use image editing software to convert it to the Windows bitmap format
(*.bmp) before you can place it in a graphic display.

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.

17–8 ■ RSView Supervisory Edition User’s Guide


To place an image in a display

1. In the Graphics Display editor, do one of the following:


„ Click the Objects menu, select 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.

When you release the mouse button, the image browser appears.

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 image
files in bitmap (.bmp), or
JPEG (.jpg, .jpeg, .jpe, .jif,
or .jfif) format.

3. Click an image in the list on the left, and then click OK.

4. Double-click the image to set it up.

Setting up graphic objects ■ 17–9


5. 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 select an image, click the


Browse button.

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

17–10 ■ RSView Supervisory Edition User’s Guide


blinking at run time. You cannot make grayscale or color images
blink.

7. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

8. When you are finished, click OK.

Adding images to your application

Images you add to your application, can be added 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 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.

Setting up graphic objects ■ 17–11


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 change in value.

To create a panel

1. In the Graphics Display editor, do one of the following:


„ Click the Objects menu, select Drawing, and then click Panel.
„ In the toolbar, click the Panel tool.
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.

17–12 ■ RSView Supervisory Edition User’s Guide


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 page 17-14.

Setting up graphic objects ■ 17–13


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. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Drawing a rounded rectangle


Use the Rounded Rectangle tool to draw a rectangle with rounded
corners.
Rounded rectangle tool
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.

17–14 ■ RSView Supervisory Edition User’s Guide


For details about changing a rounded rectangle’s properties see
“Changing the properties of drawing objects” on page 17-20.

Drawing a rectangle or square


Use the Rectangle tool to draw a rectangle or square.
Rectangle tool 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 17-20.

Drawing an ellipse or circle


Use the Ellipse tool to draw an ellipse or circle.
Ellipse tool 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 17-20.

Setting up graphic objects ■ 17–15


Drawing a line
Use the Line tool to draw straight lines in any direction.
Line tool 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 the object’s
Properties dialog box. For details, see “Changing the properties of
drawing objects” on page 17-20.

Drawing a polyline or polygon


A polyline is a series of connected line segments. A polygon is a closed
polyline shape.
Polyline tool

Polygon tool

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

17–16 ■ RSView Supervisory Edition User’s Guide


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 17-20.

Drawing a freehand object


Drawing freehand is similar to drawing with a pen on paper.
Freehand tool 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 17-20.

Drawing an arc or wedge


Arcs and wedges are drawn in two steps: first you create an ellipse or
circle, and then you reshape the ellipse or circle.
Arc tool
To draw the arc or wedge in 45-degree increments, hold down Ctrl
while you draw.

Wedge tool
Arc Hollow wedge Filled wedge

Setting up graphic objects ■ 17–17


To draw an arc or wedge

1. Click the Arc tool, 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” on page 17-20.

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, right-click the
object, and then click Edit.

The cursor changes to the Polygon tool.

17–18 ■ RSView Supervisory Edition User’s Guide


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 proportions (width to height) 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 do
one of the following:

„ Double-click the object.


„ Right-click the object and then click Edit.
The cursor changes to the Arc tool, 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.

Setting up graphic objects ■ 17–19


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 16-34.

„ using the toolbars for Foreground and Background color, and


Pattern style. For details, see the topics starting on page 16-31.

To open an object’s Properties dialog box

1. Select the object. For details about the ways you can select objects,
see page 16-10.

2. Do one of the following:


„ Right-click the object, and then click Properties on the context
menu.
„ Double-click the object.
3. In the object’s Properties dialog box, specify how you want the
object to look.

All of the drawing objects


except the Text, Image, and
Panel objects have the same
properties. Line objects have
no pattern.

17–20 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–21


Setting up properties common to all graphic objects

Every graphic object has a Common tab in its Properties dialog box.
Use the Common tab to set up these properties for the object:

„ height and width

„ top and left position

„ name

„ tooltip

„ visibility

For ActiveX and trend objects, you can also set up these properties:

„ focus highlight

„ pointer highlight

„ key navigation

„ tab index

To set up the common properties for an object

1. Select the object. For details about the ways you can select objects,
see page 16-10.

2. Do one of the following:

„ Right-click the object, and then click Properties on the context


menu.

„ Double-click the object.

„ For ActiveX objects, click Connections on the context menu.

3. Click the Common tab.

17–22 ■ RSView Supervisory Edition User’s Guide


4. Fill in the fields as follows.

Height Type the number of pixels for the height of the object. The
height includes the object’s borders.

If the object’s shape is a circle or ellipse, the height applies to the


rectangular area occupied by the object.

Width Type the number of pixels for the width of the object. The
width includes the object’s borders.

If the object’s shape is a circle or ellipse, the width applies to the


rectangular area occupied by the object.

Top Type the number of pixels from the top of the display to
position the object. You can type a positive or negative number. If
you use a negative number, part or all of the object is off the display.

If the object’s shape is a circle or ellipse, the top position applies to


the rectangular area occupied by the object.

Setting up graphic objects ■ 17–23


Left Type the number of pixels from the left of the display to
position the object. You can type a positive or negative number. If
you use a negative number, part or all of the object is off the display.

If the object’s shape is a circle or ellipse, the left position applies to


the rectangular area occupied by the object.

Name Type a name for the object. The name must start with a
letter, and cannot contain spaces. You can use numbers and the
underscore character ( _ ) in the name.

If you don’t specify a name for the object, the default name is used
in the status bar, activity bar, Property Panel, and Object Explorer
in RSView Studio, and in activity log messages at run time.

Tooltip text Type a tooltip for the object. Tooltips are descriptive
text that appear at run time when you bring the cursor to rest over
an object for a few seconds, if the object is not disabled. An object
that has been disabled cannot be selected.

For an illustration of how tooltips work at run time, see “Adding


tooltips to objects” on page 16-43.

Visible Click this box to make the object visible. Clear the check
box if you don’t want the object to appear at run time.

If you are using visibility animation, the visibility animation setting


overrides this option.

17–24 ■ RSView Supervisory Edition User’s Guide


5. For ActiveX and trend objects, specify these options as well:

Focus highlight Select this check box to display a highlight box


around the ActiveX or trend object when it has focus at run time.

Clear the check box if you don’t want the object to display a
highlight box at run time.

For more information about focus highlight, see “What input focus
looks like” on page 17-27.

Pointer highlight Select this check box to display a highlight box


around the ActiveX or trend object when the cursor (mouse
pointer) is resting on it.

Clear the check box if you don’t want the object to display a
highlight box at run time.

Key navigation Select this check box to allow the operator to


navigate to the ActiveX or trend object using the keyboard and give
the object focus.

Clear the check box if you don’t want the operator to navigate to the
object using the keyboard.

For more information about keyboard navigation, see “Using the


keyboard to navigate to, and select objects” on page 17-27.

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 18-49.

Setting up graphic objects ■ 17–25


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 menu.
Objects menu to create
objects that can be The basic steps are:
supplied with data at run
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 setting up the object, 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 See
object

Alarm Summary page 11-57


Trend Chapter 19, Setting up trends

17–26 ■ RSView Supervisory Edition User’s Guide


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.

To supply a tag name

X Do one of the following:

Browse button „ 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.

Using the keyboard to navigate to, and select objects

If a mouse or touch screen is not connected to the computer at run


time, the operator can use the keys on a keyboard or keypad to select
(give focus to) these objects:

„ control list selectors and display list selectors

„ trends

„ third-party ActiveX input objects

What input focus looks like

The object with focus is surrounded by a highlight box, unless the


Disable Highlight When Object has Focus check box is selected in the
Display Settings dialog box.
Highlight box
You can also specify the color of the highlight in the Display Settings
dialog box. For details, see “Specifying the behavior of objects
with input focus” on page 16-71.

Setting up graphic objects ■ 17–27


Focus highlight for ActiveX and trend objects

For ActiveX and trend objects, you can specify whether or not to
display a highlight box in the object’s Properties dialog box, on the
Common tab. For details, see “Setting up properties common to all
graphic objects” on page 17-22.

If the Disable Highlight When Object has Focus box is selected in the
Display Settings dialog box, that setting overrides the setting you
specify in the ActiveX object’s Properties dialog box.

Using the keys on the keyboard or keypad


When a graphic display opens, the display list selector, trend, numeric
or string input object, or ActiveX input object that is closest to the top
left corner of the display is selected. The operator can use these keys to
move to and select a different object:
Use this key To do this

Tab Move from the upper left to the lower right


Shift+Tab Move from the lower right to the upper left
Ctrl+arrow key Move left, right, up, or down

Removing objects from the tab sequence


By default, you can use the keys to navigate to the display list selector,
trends, numeric or string input objects, and ActiveX input objects in a
display. However, you can disable the key navigation for objects if
desired.

When an object’s key navigation is disabled, the operator can still select
the object using a mouse or touch screen, if available.

17–28 ■ RSView Supervisory Edition User’s Guide


To disable key navigation, use one of these methods

„ In the Property Panel, click the Properties tab, and then set the
KeyNavigation property to False.

„ For display list selectors, open the object’s Properties dialog box,
click the General tab, and then clear the Key navigation check box.

„ For ActiveX and trend objects, open the object’s Properties dialog
box, click the Common tab, and then clear the Key navigation check
box.

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

Setting up graphic objects ■ 17–29


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

17–30 ■ RSView Supervisory Edition User’s Guide


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 four tabs: a General
tab, a States tab, a Common tab, and a Connections tab.

Setting up graphic objects ■ 17–31


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.

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 Common tab is common to all graphic objects. Use the Common
tab to change the object’s spatial properties, its name, tooltip, and
visibility. For details, see “Setting up properties common to all graphic
objects” on page 17-22.

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.

The button object has no Connections tab; instead it has an Action tab.
Set up the tags to which the button is connected on the Action tab.

17–32 ■ RSView Supervisory Edition User’s Guide


How to use the States tab for push buttons
You define a button’s action, and set up its appearance for each state in
the States tab of the button’s Properties dialog box.

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

Setting up graphic objects ■ 17–33


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 “Creating buttons” on
page 17-37.

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

How to use the Connections tab for push


buttons
To connect with a device such as a programmable controller, push
buttons use tags or expressions. You set up these tags or expressions in
the Connections tab of the button’s Properties dialog box.

The arrow shows whether


the tag is a read tag (arrow
points left), a write tag
(arrow points right), or a Type the tag
read and write tag (double- name, or
headed arrow). expression if
applicable,
here.

Most push buttons have two ways of 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 or expression 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

17–34 ■ RSView Supervisory Edition User’s Guide


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
“Creating buttons” on page 17-37.

„ Latched push buttons have an additional tag called the handshake


tag. Use the handshake tag to unlatch the Latched push button. For
details, see “Connecting the latched push button to data” on
page 17-73.

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

Setting up graphic objects ■ 17–35


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.

How the Indicator tag works


The Indicator tag or expression 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.

17–36 ■ RSView Supervisory Edition User’s Guide


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, select Toolbars, and then click Objects.

Creating buttons
Use the Button tool to create push buttons that work like standard
Windows buttons. You can attach RSView commands to the buttons
Button tool
so they trigger actions when pressed and released.

You can apply visibility, color, horizontal and vertical slider, horizontal
and vertical position, width, and height animation to the button.

Setting up graphic objects ■ 17–37


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 in each tab to set up the button’s appearance and
what it does, as described in the sections that follow.

4. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

5. When you are finished, click OK.

17–38 ■ 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.

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.

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 18-49.

Setting up graphic objects ■ 17–39


Setting up the button’s actions

In the action tab, click an action in the list, and then specify what
happens when the action occurs.:

Set tag to 1Sets the specified tag to 1 when the button is released
(mouse down = no action, mouse up = Set <tag name> 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> 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.

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),

17–40 ■ RSView Supervisory Edition User’s Guide


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 an
Browse button 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.

Setting up graphic objects ■ 17–41


Setting up what the button looks like when it
is not pressed

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

Caption Type a caption for the button. To change the caption’s font
or size, click a font or size in the corresponding list.

17–42 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–43


Setting up what the button looks like when it
is pressed
In 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, clear the check box, and then choose
different options. For details about the options, see “Setting up what
the button looks like when it is not pressed” on page 17-42.

17–44 ■ RSView Supervisory Edition User’s Guide


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 17-39.

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 “Reshaping drawing objects” on
page 17-18.

Creating momentary push buttons

For some important definitions, and to understand how push buttons


work, see “How to use push buttons” on page 17-29.

Use the Momentary Push Button tool to create a button that starts a
process or action. When pressed, momentary push buttons change a
Momentary Push Button
tag to one value, and when released, they change a tag to another value.
tool
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

Setting up graphic objects ■ 17–45


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.

To create a momentary push button

1. Click the Momentary Push Button tool.

Momentary Push Button 2. Drag the mouse to draw a button the size you want.
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.

17–46 ■ RSView Supervisory Edition User’s Guide


5. If desired, set up the properties in the Common tab. For details,
see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up the appearance and action of the


momentary push button

In 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 in
the States tab. For details, see “Border color” on page 17-51.

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.

Setting up graphic objects ■ 17–47


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.

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 17-51.

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.

17–48 ■ 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.

Setting up graphic objects ■ 17–49


Setting up what the momentary push button
does when it is pressed and released
In 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.

Copy and Paste To copy settings from one state to another:

17–50 ■ RSView Supervisory Edition User’s Guide


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

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.

Setting up graphic objects ■ 17–51


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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

17–52 ■ 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.

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.

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.

Setting up graphic objects ■ 17–53


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.

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 momentary push button to


data
In the Connections tab, specify the tags or expression with which
button exchanges data.
The arrow shows whether
the tag is a read tag (arrow
points left), a write tag
(arrow points right), or a Type the tag
read and write tag (double- name, or
headed arrow). expression if
applicable,
here.

17–54 ■ RSView Supervisory Edition User’s Guide


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 17-29.
Maintained Push Button
tool Use the Maintained Push Button tool to create a button that changes a
setting in a machine or process. Maintained push buttons are not useful
for starting or stopping a machine or process.

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.

Setting up graphic objects ■ 17–55


4. In the Maintained Push Button Properties dialog box, fill in the
fields on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

17–56 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the maintained
push button, and how it changes state

In 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 in
the States tab. For details, see “Border color” on page 17-61.

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.

Setting up graphic objects ■ 17–57


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.

17–58 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–59


Setting up what the maintained push button
does when it is pressed and released

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

17–60 ■ 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.

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.

Setting up graphic objects ■ 17–61


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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

17–62 ■ RSView Supervisory Edition User’s Guide


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.

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.

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.

Setting up graphic objects ■ 17–63


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.

Connecting the maintained push button to


data
In 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
points left), a write tag
(arrow points right), or a Type the tag
read and write tag (double- name, or
headed arrow). expression if
applicable,
here.

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.

17–64 ■ RSView Supervisory Edition User’s Guide


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.

Creating latched push buttons


For some important definitions, and to understand how push buttons
work, see “How to use push buttons” on page 17-29.

Use the Latched Push Button tool to create a button that latches in the
on position, and must be unlatched by another button or process to
Latched Push Button tool
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.

Setting up graphic objects ■ 17–65


4. In the Latched Push Button Properties dialog box, fill in the fields
on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

17–66 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the latched
push button, and how to unlatch it

In 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 in
the States tab. For details, see “Border color” on page 17-70.

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.

Setting up graphic objects ■ 17–67


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) in the


States tab, and assign a Handshake tag in 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.

17–68 ■ 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 latched push button does


when it is latched and unlatched
In the States tab, specify what the button does when it is latched and
unlatched.

Setting up graphic objects ■ 17–69


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.

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.

17–70 ■ RSView Supervisory Edition User’s Guide


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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

Setting up graphic objects ■ 17–71


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.

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.

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.

17–72 ■ RSView Supervisory Edition User’s Guide


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.

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 latched push button to data


In 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
points left), a write tag Type the tag
(arrow points right), or a name, or
read and write tag (double- expression if
headed arrow). applicable,
here.

Setting up graphic objects ■ 17–73


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 (in the General tab, see page 17-68).

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.

Creating multistate push buttons

For some important definitions, and to understand how push buttons


work, see “How to use push buttons” on page 17-29.

Use the Multistate Push Button tool to create a button that displays and
allows an operator to cycle through multiple options consecutively. The
Multistate Push Button tool
multistate push button displays the current state 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.

17–74 ■ RSView Supervisory Edition User’s Guide


To create a multistate push button

1. Click the Multistate Push Button tool.

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.

4. In the Multistate Push Button Properties dialog box, fill in the


fields on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–75


Setting up the appearance of the multistate
push button, and how it changes state

In 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 in
the States tab. For details, see “Border color” on page 17-80.

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.

17–76 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up graphic objects ■ 17–77


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.

17–78 ■ RSView Supervisory Edition User’s Guide


Setting up what the multistate push button
does when it is pressed and released

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

Setting up graphic objects ■ 17–79


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.

17–80 ■ 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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

Setting up graphic objects ■ 17–81


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.

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.

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.

17–82 ■ 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.

Setting up whether the multistate push


button repeats when held down
In 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.

Setting up graphic objects ■ 17–83


Auto repeat delay Click the number of milliseconds the button must
remain pressed before auto repeat starts.

Connecting the multistate push button to


data
In 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
points left), a write tag
(arrow points right), or a Type the tag
read and write tag (double- name, or
headed arrow). expression if
applicable,
here.

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.

17–84 ■ RSView Supervisory Edition User’s Guide


Creating interlocked push buttons
For information about how push buttons work, see “How to use push
buttons” on page 17-29.

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.

Setting up graphic objects ■ 17–85


4. In the Interlocked Push Button Properties dialog box, fill in the
fields on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

17–86 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance and value of the
interlocked push button

In 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 in
the States tab. For details, see “Border color” on page 17-90.

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.

Setting up graphic objects ■ 17–87


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.

17–88 ■ 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 interlocked push button


looks like when it is pressed and released
In the States tab, specify what the button looks like when it is pressed
or released at run time.

Setting up graphic objects ■ 17–89


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.

17–90 ■ 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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 “Choosing a
font” on page 17-2.

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.

Setting up graphic objects ■ 17–91


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.

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.

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.

17–92 ■ RSView Supervisory Edition User’s Guide


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.

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
In 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 tag
(arrow points right), or a Type the tag
read and write tag (double- name, or
headed arrow). expression if
applicable,
here.

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.

Setting up graphic objects ■ 17–93


Creating ramp push buttons
For some important definitions, and to understand how push buttons
work, see “How to use push buttons” on page 17-29.

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.

17–94 ■ RSView Supervisory Edition User’s Guide


4. In the Ramp Push Button Properties dialog box, fill in the fields on
each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–95


Setting up the appearance of the ramp push
button, and how it works

In 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 “Border color” on page 17-96.

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.

17–96 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–97


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.

17–98 ■ RSView Supervisory Edition User’s Guide


Setting up the text that appears on the ramp
push button
In the Label tab, specify what text or image appears on the button.

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.

Setting up graphic objects ■ 17–99


To use an embedded variable in the caption, click Insert Variable, and
then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

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.

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.

17–100 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up graphic objects ■ 17–101


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

Auto repeat delay Click the number of milliseconds the button must
remain pressed before auto repeat starts.

17–102 ■ RSView Supervisory Edition User’s Guide


Connecting the ramp push button to data

In 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 tag
(arrow points right), or a Type the tag
read and write tag (double- name, or
headed arrow). expression if
applicable,
here.

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.

Creating numeric display fields


Numeric Display tool
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 based on
an expression.

Setting up graphic objects ■ 17–103


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 20, 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.

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.

17–104 ■ 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.

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. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

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

Setting up graphic objects ■ 17–105


4. In the String Display Properties dialog box, fill in the fields as
follows:

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 20, 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

17–106 ■ RSView Supervisory Edition User’s Guide


offset of 8. The address part of the string will not be displayed. To
display the address in a separate field, create another string display
field, specify the same tag name and specify a field width of 8 and
an offset of 0.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

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

To download data, the operator types a number into Programmable controller


the input field, and then presses PgDn or Enter.

Setting up graphic objects ■ 17–107


Numeric and string input fields can also be used to upload values and
display them in a graphic display.

12345

To upload data and display it in the input field, the Programmable controller
operator presses PgUp.

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 17-221.

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 16-70.

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.

17–108 ■ RSView Supervisory Edition User’s Guide


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.

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 16-51.

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 18-49.

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.

Setting up graphic objects ■ 17–109


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.

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.

17–110 ■ RSView Supervisory Edition User’s Guide


5. If desired, set up the properties in the Common tab. For details,
see “Setting up properties common to all graphic objects” on
page 17-22.

6. Click OK.

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 16-51.

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 18-49.

Setting up graphic objects ■ 17–111


Default data Type the text that appears in the string input field
when the graphic is initially displayed.

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. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. Click OK.

17–112 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–113


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.

17–114 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–115


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 then inserts into the Recipe
File field the text the operator typed.
Cancel Closes the on-screen keyboard, and discards the
operator’s changes.

For information about setting up displays to use the on-screen


keyboard see “Displaying the on-screen keyboard” on page 16-72.

17–116 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–117


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

17–118 ■ RSView Supervisory Edition User’s Guide


How to use Least Significant Bits to trigger
states
The Least Significant Bit (LSB) trigger type changes the indicator’s
state based on the position of the lowest bit in the tag’s value. Any
higher bit positions are ignored.

Each bit position in the tag’s value corresponds to one of the indicator’s
states: for example, position 1 triggers state 1.

The number of states a tag’s value can trigger depends on the tag’s data
type. For example, a tag of type long integer can be used to change up
to 33 of an indicator’s states (32 bit positions plus zero).

You can use a programmable controller to set these bits individually.

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 expression. You set
up the Indicator tag or expression in the Connections tab of the
indicator’s Properties dialog box.

The arrow shows that the


tag is a read tag. You Type the tag
cannot write a value to an name or
indicator tag. expression
here.

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.

Setting up graphic objects ■ 17–119


Creating multistate indicators
For some important definitions, and to understand how indicators
work, see “How to use indicators” on page 17-117.

Use the Multistate Indicator tool to create an indicator that displays the
current state of a process or operation by showing a different color,
Multistate Indicator tool
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.

To create a multistate indicator

1. Click the Multistate Indicator tool.

2. Drag the mouse to draw an indicator the size you want.

3. Double-click the indicator to set it up.

17–120 ■ RSView Supervisory Edition User’s Guide


4. In the Multistate Indicator Properties dialog box, fill in the fields
on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–121


Setting up the appearance of the multistate
indicator, and its number of states
In 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 in the States tab. For details, see “Border color” on
page 17-124.

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.

17–122 ■ RSView Supervisory Edition User’s Guide


Number of states Click the number of states you want the indicator
to have.
Trigger type Click Value to trigger a state based on the value of the
Value tag.

Click LSB to trigger a state based on the least significant bit’s position
of the Value tag.

Setting up how the multistate indicator’s


appearance changes to match its value
In the States tab, specify how the indicator’s appearance changes when
its tag or expression’s value changes.

Setting up graphic objects ■ 17–123


The indicator’s error state is displayed at run time when:

„ the Indicator tag has no tag or expression assigned to it.

„ the value of 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.

17–124 ■ 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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

Setting up graphic objects ■ 17–125


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.

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.

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.

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.

17–126 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up graphic objects ■ 17–127


Connecting the multistate indicator to data
In 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
cannot write a value to an name or
indicator tag. expression
here.

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 symbol indicators


For some important definitions, and to understand how indicators
work, see “How to use indicators” on page 17-117.

Use the Symbol Indicator tool to create an indicator that displays a


monochrome image that changes color to match the state of a process
Symbol Indicator tool
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. When you
release the left mouse button, the Image Browser appears
automatically.

17–128 ■ RSView Supervisory Edition User’s Guide


3. Select an image. This image appears on the symbol indicator.

For details about adding images to graphic displays, see page 17-6.

4. Double-click the indicator to set it up.

5. In the Symbol Indicator Properties dialog box, fill in the fields on


each tab, as described in the sections that follow.

6. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

7. When you are finished, click OK.

Setting up graphic objects ■ 17–129


Setting up the appearance of the symbol
indicator, and its number of states
In 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.
Trigger type Click Value to trigger a state based on the value of the
Value tag.

Click LSB to trigger a state based on the least significant bit’s position
of the Value tag.

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.

17–130 ■ RSView Supervisory Edition User’s Guide


If you click the Browse button, the Image Browser appears. Click an
image in the list on the left, and then click OK.
Browse button

Setting up how the symbol indicator changes


appearance when its value changes
In 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 has no tag or expression assigned to it.

„ the value of 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.

Setting up graphic objects ■ 17–131


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.

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.

17–132 ■ 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


In 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
cannot write a value to an name or
indicator tag. expression
here.

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.

Setting up graphic objects ■ 17–133


Creating list indicators
For some important definitions, and to understand how indicators
work, see “How to use indicators” on page 17-117.

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.

17–134 ■ 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.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–135


Setting up the appearance of the list
indicator, and its number of states
In 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 “Border color” on page 17-136.

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.

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.

17–136 ■ RSView Supervisory Edition User’s Guide


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 17-2.

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.
Trigger type Click Value to trigger a state based on the value of the
Value tag. Click LSB to trigger a state based on the least significant bit’s
position of the Value tag.

Setting up graphic objects ■ 17–137


Setting up how the list indicator’s appearance
changes when its value changes
In 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.

17–138 ■ 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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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.

Setting up graphic objects ■ 17–139


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.

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


In 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
cannot write a value to an name or
indicator tag. expression
here.

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.

17–140 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up graphic objects ■ 17–141


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.

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.

17–142 ■ RSView Supervisory Edition User’s Guide


„ 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
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 in the
Connections tab of the indicator’s Properties dialog box.

The arrow shows that the


tag is a read tag. You Type the tag
cannot write a value to a name or
bar graph’s tag. expression
here.

Setting up graphic objects ■ 17–143


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 gauges
For some important definitions, and to understand how gauges work,
see “How to use gauges and graphs” on page 17-141.

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.

17–144 ■ 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.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–145


Setting up the appearance of the gauge
In 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.

Needle color Click the color box to open the palette, and then click a
color for the gauge’s needle.

17–146 ■ RSView Supervisory Edition User’s Guide


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 17-2.

Setting up graphic objects ■ 17–147


Setting up how the gauge works
In 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.

17–148 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–149


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


In 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
cannot write a value to a name or
gauge’s tag. expression
here.

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 17-141.

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.

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.

17–150 ■ RSView Supervisory Edition User’s Guide


4. In the Bar Graph Properties dialog box, fill in the fields on each
tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–151


Setting up the appearance of the bar graph
In 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 in the States tab. For details, see “Border color” on
page 17-152.

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 you use
thresholds, this color is used until the graph’s value reaches the first
threshold.

17–152 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up graphic objects ■ 17–153


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

In 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
cannot write a value to a name or
bar graph’s tag. expression
here.

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.

To create a scale

1. Click the Scale tool.

2. Drag the mouse to draw a scale the size you want.

3. Double-click the scale to set it up.

17–154 ■ RSView Supervisory Edition User’s Guide


4. In the Scale Properties dialog box, fill in the fields on each tab, as
described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–155


Setting up the appearance of the scale

In 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 “Border color” on page 17-156.

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.

17–156 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–157


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 18-45.

„ 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, in the
Behavior tab of the Display Settings dialog box. For details, see
“Setting up display behavior” on page 16-68.

17–158 ■ RSView Supervisory Edition User’s Guide


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 the cursor or highlight 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.

Setting up graphic objects ■ 17–159


Keys can work with the object that has focus
If your graphic display contains more than one control list selector,
piloted 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 “Send press to” on page 17-164.

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 17-158.

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

17–160 ■ RSView Supervisory Edition User’s Guide


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.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up graphic objects ■ 17–161


Setting up the appearance of the key

In 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 “Border color” on page 17-162.

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.

17–162 ■ RSView Supervisory Edition User’s Guide


Highlight color Click the color box to open the palette, and then click
a color for the key when it is selected.

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.

Setting up graphic objects ■ 17–163


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.

17–164 ■ RSView Supervisory Edition User’s Guide


Adding text or an image to the key
In the Label tab, specify what text or image appears on the key.

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.

Setting up graphic objects ■ 17–165


To use an embedded variable in the caption, click Insert Variable, and
then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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 17-2.

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.

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.

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.

17–166 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up graphic objects ■ 17–167


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.

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.

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

17–168 ■ 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 See
object

Alarm Summary page 11-57


Trend Chapter 19, Setting up trends

Setting up graphic objects ■ 17–169


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.

17–170 ■ 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 20, 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. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. Click OK.

Setting up graphic objects ■ 17–171


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.

Choosing between control list selectors and


piloted control list selectors
Piloted control list selectors offer additional features not supported by
control list selectors. For details, see “Choosing between piloted
control list selectors and control list selectors” on page 17-186.

How control list selectors work at run time


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 state is selected automatically. If you want the operator to
confirm the selection of a particular state before the state’s value is
written to the programmable controller, include an Enter key with the
control list selector.

Using control list selectors with key objects

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 17-160.

„ 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 17-158.

17–172 ■ 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 in 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.

Setting up graphic objects ■ 17–173


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 in the Connections tab of the Properties dialog box.

The arrow shows whether


the tag is a read tag (arrow
points left), a write tag Type the tag
(arrow points right), or a name, or
read and write tag (double- expression if
headed arrow). applicable,
here.

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
in the Timing tab.

„ The Enter handshake tag or expression resets the Enter tag, using
the Handshake reset type option specified in the Timing tab.

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.

17–174 ■ RSView Supervisory Edition User’s Guide


„ when another process changes the tag’s value in the programmable
controller.

For example, a control list selector is used to change 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.

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 has expired, 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.

Setting up graphic objects ■ 17–175


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 tag is not assigned, the Enter tag 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 transitionresets 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 diagnostics
log file.

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 diagnostics log file.

Graphic display changes

If the graphic display is closed, the Enter tag is reset to 0, and any
handshake timing is also reset.

17–176 ■ RSView Supervisory Edition User’s Guide


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 17-172.

Use the Control List Selector tool to create a list that displays and
allows an operator to cycle through multiple options consecutively. The
Control List Selector tool
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.

Setting up graphic objects ■ 17–177


4. In the Control List Selector Properties dialog box, fill in the fields
on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

17–178 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the
control list selector

In the General tab, specify what the control 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 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 “Border color” on page 17-179.

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 control list selector.

Pattern color Click the color box to open the palette, and then click
a color for the pattern.

Setting up graphic objects ■ 17–179


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 control list selector blink at run
time. Clear the check box to prevent the control 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 17-2.

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 control 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 control list
selector to have.

17–180 ■ 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.

Key navigation Select this check box to allow the operator to navigate
to the control 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 18-49.

Wrap around Select this check box to allow the list to wrap
automatically from the last item back to the first item when scrolling
down, and from the first item back to the last item when scrolling up.

Setting up graphic objects ■ 17–181


Setting up the control list selector’s value and
appearance
In 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.

17–182 ■ 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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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.

Setting up graphic objects ■ 17–183


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.

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

In 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. To set up the Enter tag, click
the Connections tab. For details, see page 17-185.

Enter key hold time Select the amount of time the Enter tag remains
set 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 in the Connections tab.

17–184 ■ RSView Supervisory Edition User’s Guide


Enter key handshake time Select the maximum amount of time the
Enter tag remains set at a value of 1. This setting only applies if the
Enter tag and Enter handshake tag are both set up in 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

In 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
points left), a write tag Type the tag
(arrow points right), or a name, or
read and write tag (double- expression if
headed arrow). applicable,
here.

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 “How to use control list selectors” on
page 17-172.

Enter handshake Type a tag name or expression, or click a Browse


button to browse for a tag, or compose an expression.

Setting up graphic objects ■ 17–185


The Enter handshake tag or expression resets the Enter tag, using the
Handshake reset type option specified in 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.

How to use piloted control list selectors


Piloted control list selectors allow an operator or remote device 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.

Choosing between piloted control list


selectors and control list selectors
Piloted control list selectors include the following features that control
list selectors do not:

„ The states can be selected either by an operator, or remotely, for


example by a programmable controller, or by both an operator and
a remote device. Individual states can be disabled, to prevent them
from being selected by either the operator or the remote device.

Control list selectors can be controlled either by the operator, or by


the programmable controller, but not both. Control list selectors do
not allow states to be disabled.

„ The state values of all of the items that are visible in the list can be
written to the Visible States tag when the list scrolls. The Visible
States tag must be a data-server tag that supports arrays. You cannot
use an HMI tag.

Control list selectors have no Visible States tag.

„ The state value of the item at the top of the list can be written to the
Top Position tag when the list scrolls.

Control list selectors have no Top Position tag.

17–186 ■ RSView Supervisory Edition User’s Guide


How piloted control list selectors work at run
time
A piloted control list selector can show several states at the same time,
but only one state can be selected at a time.

You can set up the piloted control list selector to be operator controlled
or remote controlled by assigning tags or expressions on the
Connections tab.

The value of the Remote Access tag determines who can select the
piloted control list selector’s states. When the piloted control list
selector is set up to be:

„ operator controlled (the Remote Access tag is either not assigned,


or has a value of zero), only the operator can select states. The
operator cannot select any states whose access is set up as Remote,
or None (disabled).

„ remote controlled (the Remote Access tag has a non-zero value),


only the remote device can select states. The remote device cannot
select any states whose access is set up as Operator or None
(disabled).

You can also set up individual states to be operator controlled, remote


controlled, both, or none. If set to none, the state is disabled.

If the piloted control list selector is set up to be operator controlled,


and the operator selects a remote-controlled state, or one that is
disabled, a hollow cursor is displayed.

The operator can select this state. The operator cannot select
this state.

Setting up graphic objects ■ 17–187


Using piloted control list selectors with key objects

When a piloted control list selector is operator controlled, it works


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 17-160.

„ 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 piloted
control list selector that has focus, or with a specific piloted control list
selector. For details about how keys work, see “How to use keys” on
page 17-158.

Selecting items in the list

Each state can be selected directly by an operator, or remotely by a


device such as a programmable controller. The operator or the
controller scrolls through the list to select a different state or a different
group of visible states.

When an operator or remote device selects a state, the value assigned


to the selected state is written to the piloted control list selector’s Value
tag. If the state is disabled, the state’s value is not written to the Value
tag.

If the operator attempts to select a state that is remote controlled, the


state’s value is not written to the Value tag.

17–188 ■ RSView Supervisory Edition User’s Guide


Scrolling through the list

If the piloted control list selector contains more states than can be
displayed in the list simultaneously, the value of the Top Position tag (if
assigned) changes whenever the item at the top of the list changes.

If the visible states tag is assigned, the values assigned to all visible
states are written to the Visible States tag whenever the list scrolls. If all
the visible states are written, the tag must support arrays, and the array
must be the same length as the number of visible states in the piloted
control list selector.

How to use the States tab for piloted control


list selectors
Piloted control list selectors change the Value tag, and change their
appearance based on their states. For each state, you define the value to
which the piloted control list selector changes the Value tag, and set up
the text that appears in the list.

You can also set up whether each state can be selected by the operator,
or remotely, for example by a programmable controller or other device,
or by both the operator and a remote device, or by neither. If you set
access to None, the state cannot be selected.

Setting up graphic objects ■ 17–189


Set up the states in the States tab of the piloted control list selector’s
Properties dialog box.

You can set this value for


each state individually, to
specify whether the operator,
the programmable controller,
or both can select the state. If
you click None, the state
cannot be selected at
run time.

You can set up 255 states for a piloted control list selector. This
provides the operator with up to 255 selections in the list.

17–190 ■ RSView Supervisory Edition User’s Guide


How to use the Connections tab for piloted
control list selectors
To connect with a device such as a programmable controller, piloted
control list selectors use tags or expressions. You set up these tags or
expressions in the Connections tab of the Properties dialog box.

Type the tag


The arrow shows whether names, or
the tag is a read tag (arrow expressions if
points left), a write tag applicable,
(arrow points right), or a here.
read and write tag (double-
headed arrow).

Piloted control list selectors have seven tags for sending and receiving
data:

„ The Value tag receives the value of the currently-selected state. You
can use this value to triggers an action, for example setting a motor’s
speed to low, medium, or high.

„ The Indicator tag selects an item in the list if the piloted control list
selector is being controlled remotely, for example by a
programmable controller.

„ The Remote Access tag or expression determines whether the


piloted control list selector can be operated by the operator, or
remotely, for example by a programmable controller. If the remote
access tag has a value of zero, or is not assigned, the operator can
select states in the list. If the remote access tag has a non-zero value,
the the selected state is determined by the value of the Indicator tag
or expression.

„ The Top Position tag receives the value of the state that is the first
item in the list whenever the list scrolls.

Setting up graphic objects ■ 17–191


„ The Visible States tag receives the values of all the states visible in
the list whenever the list scrolls. The tag must support arrays, and
the arrays must have as many elements as the number of items
visible in the piloted control list selector.

For example, if the piloted control list selector has 5 visible states,
and the state values are written to programmable controller
addresses N7:0 through N7:4 using RSLinx Enterprise, the Visible
States tag should be an array tag with the following address:

::[RSLinx Device Shortcut]N7:0,L5

where L5 indicates that the tag writes values to five addresses in the
array.

„ The Enter tag allows a programmable controller to confirm a


selection after Value tag is written. The Enter tag is set for as long
as is specified in the Timing tab.

„ The Enter handshake tag or expression resets the Enter tag, using
the Handshake reset type option specified in the Timing tab.

How the Value tag works

The Value tag can be changed:

„ if the Write on enter check box in the General tab is cleared, and the
operator selects an item in the list.

For details about the Write on enter check box, see page 17-197

„ if the Write on enter check box in the General tab is selected, and
the operator selects an item in the list, and then presses the Enter
key.

„ when a remote device selects an item in the list.

17–192 ■ RSView Supervisory Edition User’s Guide


How Enter-key handshaking works

Enter-key handshaking can only be used if the Write on enter check


box is selected, and the piloted control list selector is operator
controlled.

When the operator presses the Enter key associated with the piloted
control list selector, 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.

How the handshaking tags and settings interact

If the Enter tag is not assigned, no handshaking takes place.

If the Enter tag is assigned, when the operator presses the Enter key
associated with the piloted control list selector, the following happens:

1. The timer for the Enter key control delay option begins timing.
When the time has expired, 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 tag is not assigned, the Enter tag remains
set until the Enter key hold time expires.

4. The Enter tag is reset to 0.

Setting up graphic objects ■ 17–193


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 diagnostics
log file.

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 diagnostics log file.

Graphic display changes

If the graphic display is closed, the Enter tag is reset to 0, and any
handshake timing is also reset.

Creating piloted control list selectors

For some important definitions, and to understand how piloted control


list selectors work, see “How to use piloted control list selectors” on
page 17-186.

Use the Piloted Control List Selector tool to create a list that displays
and allows an operator to cycle through multiple options consecutively.
Piloted Control List
The piloted control list selector displays the current state of a process
Selector tool
or operation by highlighting the state.

17–194 ■ RSView Supervisory Edition User’s Guide


To set up a piloted control list selector

1. Click the Piloted Control List Selector tool.

2. Drag the mouse to draw a piloted control list selector the size you
want.

3. Double-click the piloted control list selector to set it up.

4. In the Piloted Control List Selector Properties dialog box, fill in


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

Setting up graphic objects ■ 17–195


Setting up the appearance of the piloted
control list selector

In the General tab, specify what the piloted control 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 to change the thickness of the piloted


control list selector’s border. Border width is measured in pixels.

Border uses back color Select this check box if you want the piloted
control list selector’s border to have the same color as the selector’s
background.

Clear the check box if you want the piloted control list selector’s border
to have a different color than the selector's background, and then
choose a Border color.

Back color Click the color box, and then click a color for the piloted
control list selector’s background.

Border color Click the color box, and then click a color for the
piloted control list selector’s border.

Pattern style Click a pattern style for the piloted control list selector.

Pattern color Click the color box, and then click a color for the
pattern.

Selection back color Click the color box, and then click a color for
the background of a highlighted item in the list.

Selection fore color Click the color box, and then click a color for
the text of a highlighted item in the list.

Blink Select this check box to make the selector blink at run time.
Clear the check box to prevent the selector from blinking at run time.

17–196 ■ RSView Supervisory Edition User’s Guide


Font, size, and style Click a font for the selector’s text 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.
Caption truncate Click Word to cut off captions that exceed the
maximum length at the beginning of a word. Click Character to cut off
captions that exceed the maximum length in the middle of a word.

The maximum caption length depends on the width of the selector and
the font size.

When a caption has been truncated, an asterisk ( * ) appears at the right


end of the caption to indicate that text is missing.

Number of states Click the number of states you want the selector to
have.

Write on enter Select this check box to send the piloted 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
scrolls to a new state.

Setting up graphic objects ■ 17–197


Key navigation Select this check box to allow the operator to
navigate to the piloted control list selector and give it focus using the
keyboard.
Wrap around Clear this check box if you want the list to wrap from
the end of the list to the beginning when scrolling down and from the
beginning of the list to the end when scrolling up.

Setting up the piloted control list selector's


state values and captions
In the States tab, set up the value and caption for each state, and then
set up whether the state is operator controlled, remotely controlled,
both, or neither.

Select state Click a state, and then set up the state on the right-hand
side.

17–198 ■ 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.

5. Click Current State to paste the settings to the selected state only.
Click All States to paste the settings to all of the object’s states.

6. Click OK.

Value Type the integer value for each state. The Value tag changes to
this value when the state is selected.

Caption Type the text you want to appear in the list for this state.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

Setting up graphic objects ■ 17–199


For more information about embedded variables, see Chapter 21,
Creating embedded variables.
Caption color Click the color box, and then click a color for the
caption’s text.
Caption back color Click the color box, and then click a color for the
caption’s background.

The caption’s background color is visible only on items in the list that
are not highlighted, and if the Caption back style is Solid.
Caption blink Select this check box to make the caption blink at run
time. Clear the check box to prevent the caption from blinking at run
time.
Caption back style Click Solid to cover the piloted control list
selector’s background color with the caption’s background color. Click
Transparent to hide the caption’s background color.
Alignment Click a position in the grid, relative to the piloted control
list selector. In the default alignment position, the text is positioned at
the left of the piloted control list selector, inside the border (if a border
is used).
Access Click Operator and Remote to allow both the operator and a
remote device to select this state.

Click Operator to allow only the operator to select the state.

Click Remote to allow only the remote device to select the state.

Click None to prevent the state from being selected.

17–200 ■ RSView Supervisory Edition User’s Guide


Setting up the piloted control list selector to
work with an Enter key
In 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. To set up the Enter tag, click
the Connections tab. For details, see page 17-185.
Enter key hold time Select the amount of time the Enter tag remains
set 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 in the Connections tab.

Enter key handshake time Select the maximum amount of time the
Enter tag remains set at a value of 1. This setting only applies if the
Enter tag and Enter handshake tag are both set up in 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.

Setting up graphic objects ■ 17–201


Connecting the piloted control list selector to
data
In the Connections tab, specify the tags or expressions with which the
piloted control list selector exchanges data.

Type the tag


The arrow shows whether names, or
the tag is a read tag (arrow expressions if
points left), a write tag applicable,
(arrow points right), or a here.
read and write tag (double-
headed arrow).

Value Type a tag name, or click the Browse button to browse for a tag.
You can use the Value tag to trigger an action when the operator selects
the state. For example, you can use the tag to change a motor’s speed
to a new setting.
Indicator Type a tag name or expression, or click a Browse button to
browse for a tag, or compose an expression. The Indicator tag or
expression shows which state is selected when the piloted control list
selector is controlled remotely. For example, the Indicator tag or
expression can be used to show which recipe is selected.
Remote Access Type a tag name or expression, or click a Browse
button to browse for a tag, or compose an expression. The Remote
Access tag determines whether the piloted control list selector is
controlled by the operator, or controlled remotely, for example by a
programmable controller. If the Remote Access tag is not assigned, or
when its value is zero, the operator controls the piloted control list
selector. When the Remote Access tag has a non-zero value, the
selected state is set remotely using the Indicator tag.

17–202 ■ RSView Supervisory Edition User’s Guide


Top Position Type a tag name, or click a Browse button to browse for
a tag. The top position tag stores the value of the state that is at the top
of the list whenever the list scrolls.
Visible States Type a tag name, or click the Browse button to browse
for a tag. The tag must be a data-server tag that supports arrays. The
Visible States tag cannot be an HMI tag. When the list scrolls, the
values of the visible states are written to the array tag. The first visible
state is written to the first element of the array tag, the second visible
state is written to the second element of the array tag, and so on. The
length of the array tag must be the same as the number of visible states
the object has. The syntax of the array tag is depends on the type of
OPC data server the application is using.

For an example of the syntax for arrays in OPC tags using RSLinx as a
data server, see “How to use the Connections tab for piloted
control list selectors” on page 17-191.
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. The piloted control list selector
cannot be operated while the Enter tag is set to 1. For details about how
the Enter tag works, see “How Enter-key handshaking works” on
page 17-193.

Enter Handshake Type a tag name or expression, or click a Browse


button to browse for a tag, or compose an expression.

The Enter handshake tag or expression resets the Enter tag, using the
Handshake reset type option specified in 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.

Setting up graphic objects ■ 17–203


Creating tag labels
Use the Tag Label tool to create fields that display different types of tag
information at run time.

Because of their extended properties, HMI tags have equivalent labels,


but with different names than other types of tags. The equivalents for
Tag Label tool
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

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.

17–204 ■ RSView Supervisory Edition User’s Guide


3. Fill in the fields as follows:

To select a tag
name, click the
Browse button.

Tag Specify a tag name or tag placeholder.

For information about tag placeholders, see “Using tag


placeholders” on page 16-51.

Property Click a property. For information about the various


properties, see the table on page 17-204.

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. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

5. Click OK.

Setting up graphic objects ■ 17–205


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 5-9.

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.

17–206 ■ RSView Supervisory Edition User’s Guide


Creating display list selectors
To understand how display list selectors work, see “How to use display
list selectors” on page 17-206.

Use the Display List Selector tool to create list of displays in the
application. Each graphic display is represented by a different state in
Display List Selector tool
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.

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.

Setting up graphic objects ■ 17–207


4. In the Display List Selector Properties dialog box, fill in the fields
on each tab, as described in the sections that follow.

5. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

17–208 ■ RSView Supervisory Edition User’s Guide


Setting up the appearance of the display list
selector

In 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 “Border color” on page 17-209.

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.

Setting up graphic objects ■ 17–209


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 17-2.

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.

17–210 ■ 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 18-49.

Wrap around Select this check box to allow the list to wrap
automatically from the last item back to the first item when scrolling
down, and from the first item back to the last item when scrolling up.

Setting up graphic objects ■ 17–211


Setting up which displays appear in the
display list selector
In 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.

17–212 ■ 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 that opens when the
operator highlights this state and presses Enter. To browse for a
graphic display, click the Browse button.

Parameter file Type the name of the parameter file you want to run
when the operator highlights this state and presses Enter. To browse
for a parameter file, click the Browse button.

A parameter file assigns tags to tag placeholders in the display when the
display opens.

Display position Select this check box to specify the Top position and
Left position for the display. These properties apply only to displays of
type On Top or Overlay. These properties do not apply to displays of
type Replace.

Top position Type the number of pixels from the top of the screen at
which you want the display positioned.

Left position Type the number of pixels from the left edge of the
screen at which you want the display positioned.

Setting up graphic objects ■ 17–213


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.

To use an embedded variable in the caption, click Insert Variable, and


then click the type of variable you want to insert. In the dialog box that
appears, make selections to compose the variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

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.

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 aligned
at the left edge of the display list selector.

17–214 ■ 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.

How to use local message displays


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.

For information about how local messages work, see “Using local
messages” on page 17-231.

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.

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.

Setting up graphic objects ■ 17–215


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 17-215.

Use the Local Message Display tool to create an area in a graphic


display where messages are displayed. Local message displays are useful
Local Message Display
for providing the operator with information about what to do next, or
tool
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 17-231.

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.

17–216 ■ RSView Supervisory Edition User’s Guide


5. In the Local Message Display Properties dialog box, fill in the
fields on each tab, as described in the sections that follow.

6. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

7. When you are finished, click OK.

Setting up graphic objects ■ 17–217


Setting up the appearance of the local
message display
In 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 “Border color” on
page 17-218.

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.

17–218 ■ 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 17-2.

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.

Setting up graphic objects ■ 17–219


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


In the Connections tab, specify the tag or expression the local message
display is connected to.

The arrow shows that the


tag is a read tag. You Type the tag
cannot write a value to a name or
bar graph’s tag. expression
here.

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 (?).

17–220 ■ RSView Supervisory Edition User’s Guide


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 numeric and
Recipe tool
string input fields in a graphic display.

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.

Setting up graphic objects ■ 17–221


5. In the Field length box, type a value to specify the maximum
number of characters that can be displayed in the recipe field.

6. Click Left, Center, or Right to specify how the recipe file name will
be aligned within the field.

7. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

8. 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 Properties dialog box, and
then check the number in the Index field.

For details about index numbers, see “Using index numbers” on


page 18-49.

Two ways to create a recipe file


You can create a recipe file with the Recipes 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 Recipes editor

1. Open the Recipes editor.

2. Type one entry per line. Type one entry for each input field in the
display. You can have up to 500 entries.

17–222 ■ RSView Supervisory Edition User’s Guide


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

Setting up graphic objects ■ 17–223


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

17–224 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–225


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.

17–226 ■ RSView Supervisory Edition User’s Guide


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.

Setting up graphic objects ■ 17–227


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 that shows
Time and Date Display
the time and date in a graphic display. You specify the appearance of
tool
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.

17–228 ■ RSView Supervisory Edition User’s Guide


5. If desired, set up the properties in the Common tab. For details,
see “Setting up properties common to all graphic objects” on
page 17-22.

6. When you are finished, click OK.

Setting up the appearance of the time and


date display
In 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 time and date display’s border. Border width is
measured in pixels.

Border uses back color Select the check box if you want the time and
date display’s border to have the same color as the time and date
display’s background.

Clear the check box if you want the time and date display’s border to
have a different color than the time and date display’s background, and
then choose a Border color. For details, see “Border color” on
page 17-230.

Back color Click the color box to open the palette, and then click a
color for the time and date display’s background.

Setting up graphic objects ■ 17–229


Border color Click the color box to open the palette, and then click a
color for the time and date display’s border.

Back style Click Solid to cover objects or the display background


behind the time and date display. Click Transparent to allow objects or
the display background behind the time and date display to show
through.

Pattern style Click a pattern style for the time and date 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 time and date display.

Blink Select the check box to make the time and date display blink at
run time. Clear the check box to prevent the time and date 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 17-2.

Word wrap Select this check box to wrap words to the next line if they
are too long for the width of the time and date display. Clear this check
box to truncate words that are too long for the width of the time and
date display.

The maximum number of characters displayed in the time and date


display depends on the size of the time and date display, and the font.

17–230 ■ RSView Supervisory Edition User’s Guide


Alignment Click a position in the grid, relative to the time and date
display. In the default alignment position, the text is centered vertically
and horizontally on the time and date display.

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 17-215.

Setting up graphic objects ■ 17–231


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.

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

17–232 ■ RSView Supervisory Edition User’s Guide


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.

3. Save the message file with the name Hoist status.

4. In the Graphic Displays editor, create a local message display.

5. In the object’s Properties dialog box, click the General tab, and
then select the Hoist status message file.

6. Click the Connections tab, and then type Hoist_Status in the Value
tag box.

Setting up graphic objects ■ 17–233


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 tag’s value is 0, the local message display is cleared.

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.

17–234 ■ RSView Supervisory Edition User’s Guide


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 17-234.

Message Type the message, up to 256 characters.

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

4. Click Close.

To start a new line in the message

X Type \n and then type the rest of the message.

If you want the character sequence \n to appear in the message,


type \\n. This way, the sequence won’t be interpreted as a line
break.

For example, to create the message, Logging to \norm’s


bakery\logs has been interrupted, you would type this: Logging to
\\norm’s bakery\logs has been interrupted.

Setting up graphic objects ■ 17–235


To add an embedded variable to the message

1. Right-click the Message cell in the spreadsheet, and then click Edit
String.

2. In the String Edit dialog box, click Insert Variable, and then click
the type of variable you want to insert.

3. In the dialog box that appears, make selections to compose the


variable, and then click OK.

For more information about embedded variables, see Chapter 21,


Creating embedded variables.

To sort the messages by trigger value

1. Select the rows you want to sort.

2. Right-click any of the selected rows, and then click Sort.

To delete a message

X Click any cell in the row you want to delete, and then press Delete.
To delete multiple messages, shift-click the cells.

17–236 ■ RSView Supervisory Edition User’s Guide


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.

To create messages in a spreadsheet application

X Create one message per row, as follows:

a. In column A, type the trigger value.

b. In column B, type the message.

Type the messages in the order you want them to appear in the
Local Messages editor.

Setting up graphic objects ■ 17–237


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.

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.

17–238 ■ RSView Supervisory Edition User’s Guide


„ 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 HMI project, embedded objects are automatically


moved with the HMI project files.

To create an OLE object

1. Click OLE Objects on the Objects menu, or click the


OLE Objects tool on the Objects toolbar.
OLE Object 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, select the Link check box. To embed the file, clear
the Link check box.

4. Select an object type or file.

Setting up graphic objects ■ 17–239


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.

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.

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

17–240 ■ RSView Supervisory Edition User’s Guide


3. Click Paste or Paste Link.

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

Setting up graphic objects ■ 17–241


this example, you can paste the object as an embedded Excel
worksheet, as a graphic image, or as text.

5. Click OK.

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.

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

17–242 ■ RSView Supervisory Edition User’s Guide


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 tool „ 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 17-245, click the tool in the toolbox, draw a box the size you
want for the object, and then skip the rest of these steps.

2. Draw a box the size you want for the object.

Setting up graphic objects ■ 17–243


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

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 16-38.

„ connect an object’s methods to tags. To do this, use the Invoke


command. For details, see “Connecting tags to an object’s
methods” on page 18-42.

„ 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 18-44.

17–244 ■ RSView Supervisory Edition User’s Guide


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 24-2.

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 lower part of the tab you want to add tools to, and
then click Additional Controls.

3. In the list of installed controls, select the check boxes of 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 name in the toolbox.

2. On the context menu, click New Page.

A new page appears, with the name New Page.

Setting up graphic objects ■ 17–245


To rename or remove tabs in the ActiveX Toolbox

1. Right-click the tab you want to rename or remove.

2. On the context 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. When a
tab has focus (is selected) a dotted line appears around the label’s text.

This tab is selected. Click these buttons to scroll


through the tabs in the
toolbox.

To remove tools from the ActiveX Toolbox

1. Right-click the tool you want to remove.

2. On the context 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.

17–246 ■ RSView Supervisory Edition User’s Guide


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, and then put the .cab files in the same folder
where you installed RSView. To do this, use the program
CABARC.exe located on the computer that is running the HMI
server, in the folder \Documents and Settings\All Users\Documents\
RSView Enterprise\ActiveX Control Setup.

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.

Setting up graphic objects ■ 17–247


Recording and authorizing run-time changes using
electronic signatures
RSView includes an electronic signature verification and authorization
feature that provides a way to secure operations by verifying the
identity of the operator before an action can occur.

When the operator clicks this


button, the RSView Electronic
Signature dialog box opens, and
the user must be authenticated
before values are downloaded to
the programmable controller.

The operator’s identity is verified by the Signature button—an ActiveX


control that only allows certain operations to be performed if the
operator provides the appropriate user name and password.

17–248 ■ RSView Supervisory Edition User’s Guide


Securing tag writes, commands, and
downloads

Using the Signature button, you can secure these operations:

„ setting a tag value

„ issuing an RSView command

„ downloading all input field values to a programmable controller

For added security, the Signature button can also be set up so that
authorization by another person, such as a supervisor, is required
before the operation can be carried out.

At run time, the action can be prevented from being carried out and an
error message can be displayed if a user name or password is incorrect,
or if other information, such as an operator’s comment, is required but
not provided.

Securing objects in displays

The Signature button does not change the way RSView graphic objects
work. For example, any numeric input fields in a graphic display will
download their values to a programmable controller when the user
presses Enter or Page Down, even if the Signature button appears on
the display.

To ensure that values are downloaded only if the an electronic signature


is verified, you must secure these graphic objects separately:

„ To disable the Enter key, add the /E parameter to the Display


command. For details about the Display command, see page A-33.

„ Set the Page Up, Ctrl-Page Up, Page Down, and Ctrl-Page Down
keys to do nothing using display keys. For details about display key
animation, see page 18-60.

Setting up graphic objects ■ 17–249


Tracking changes with FactoryTalk
Diagnostics

These activities are logged to FactoryTalk Diagnostics, and can be


viewed in the Diagnostics List or Diagnostics Viewer, depending on
how they are set up. The information that is logged includes the user
name, old value, new value, the operator’s comments about why the
change was made, and the name of the person who approved the
change.

Using the Signature button for compliance


with regulated manufacturing applications

The Signature button can be used together with other features of


RSView Supervisory Edition to meet the security standards required
for regulated manufacturing applications, for example those required
for US Government 21 CFR Part 11 compliance.

RSView Supervisory Edition is designed for “headless server”


operation—an architecture that allows users to be logged in only at the
client. This also makes tracking system usage simpler, for compliance
with manufacturing regulations.

Creating Signature buttons

The Signature button is an ActiveX control that you add to a graphic


display to control the actions that can be performed by the operator at
run time, for example:

„ setting the value of a tag.

„ issuing a command.

„ downloading values in all of the input fields in the display to


programmable controllers or devices.

17–250 ■ RSView Supervisory Edition User’s Guide


To create a Signature button

1. In the Graphic Displays editor in RSView Studio, open the display


to which you want to add the Signature button.

2. If the ActiveX toolbox is not visible, click the View menu, and
then click ActiveX Toolbox to make it visible.

3. In the ActiveX toolbox, click the Electronic Signature tab, and


then click the RSView SE Signature button tool.
RSView SE Signature tool
4. Draw a box the size you want for the Signature button.

When you release the mouse button, the Signature button appears
in the graphic display.

5. Double-click the button to set it up.

6. In the RSView SE Signature Button Properties dialog box, fill in


the fields in each tab to set up the button’s appearance and what it
does, as described in the sections that follow.

7. If desired, set up the properties in the Common tab. For details,


see “Setting up properties common to all graphic objects” on
page 17-22.

Setting up graphic objects ■ 17–251


8. When you are finished, click OK.

Specifying a caption for the Signature button


In the General tab, type the caption that appears on the button at run
time.

Button caption Type a caption for the button.

Setting up the run-time behavior of the


Signature button
When the operator clicks the Signature button at run time, the
authentication dialog box appears. In the Signature tab, set up how the
authentication dialog box behaves at run time.

17–252 ■ RSView Supervisory Edition User’s Guide


Operation Click an operation in the list:

„ Set Value sets the value of a tag.

„ Send Command issues a command.

„ Download Input Values downloads the values in all of the input


fields in the display to programmable controllers or devices.
Window Title Type the title that is displayed in the title bar of the
authentication dialog box at run time.
Operation Description Type a description of the operation that the
button will carry out. This description is displayed in the authentication
dialog box, and is logged to the Diagnostics List at run time.

Set Value If the button’s operation is Set Value, specify the maximum,
minimum, and number of decimal places that is set for the tag. If
maximum and minimum are the same value, they are ignored.

When you click an option


here …

… the options displayed


change here.

Minimum Specify the minimum allowable value that the tag can be
set to.
Maximum Specify the maximum allowable value that the tag can be
set to.

Setting up graphic objects ■ 17–253


Decimals Specify the number of decimal places that are used to
show current and entered tag values in the authentication dialog
box.
RSView Command If the button’s operation is Send Command, type
the command string, or click the Browse button to open the Command
Wizard. The command string must include the command name and the
parameters required for the command.

When you click an option


here …

… the options displayed


change here.

Domain Type the name of the domain the operator and approver are
members of, or click the Browse button, and then select a domain.
Browse button
Enable Performer Authentication Select the check box to enable the
User name and Password boxes for the operator in the Authentication
dialog box at run time. This means that the person who is currently
logged in to the client must verify their login identity before they can
perform the operation.
Performer Group Specify the name of the group that the performer
must be a member of. If the Performer group box is blank, the
performer does not need to belong to any group.
Enable Approver Authentication Select the check box to enable the
User name and Password boxes for the approver in the Authentication

17–254 ■ RSView Supervisory Edition User’s Guide


dialog box at run time. The person who approves can be any valid user
in the specified domain or approver group.
Approver Group Specify the name of the group that the approver
must be a member of. If the Approver group box is blank, the approver
does not need to belong to any group.

Specifying colors for the Signature button


In the Colors tab, specify the colors for the background and
foreground of the Signature button.

Properties Select the property for which you want to specify a color.
Color Set Click the color set you want to use. You can use either a
standard set of colors, or you can select the Windows System Colors.
Color Palette Click the color you want to use for the property. You
can also create custom colors.

Setting up graphic objects ■ 17–255


Specifying a tag for the Signature button

In the Connections tab, specify the tag whose value is set by the
Signature button. The tag must be associated with the Value property
of the button.

Value Type the name of a tag or click the Browse button to open the
Tag browser, and then select a tag.

The double-headed arrow indicates that the Signature button can read
from, or write to the tag.

Changing the style and color of the font

To change the style of the button’s font, use the Font property in the
Properties tab of the Property Panel. To change the font’s color, change
the ForeColor property.

You can also use the Property Panel to change other properties for the
button, such BackColor, Height, and Width.

For details about using the Property Panel, see page 16-34.

17–256 ■ RSView Supervisory Edition User’s Guide


18
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 Path™ (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.

„ attach OLE verb animation to an OLE object so when the


expression evaluates to true, it activates an OLE object by initiating

Animating graphic objects ■ 18–1


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.

Some graphic objects, such as the Multistate Indicator, can have only
Visibility animation. Others can have as many types of animation as you
like. For example, you can apply both width and height animation to the
drawing objects to give them the appearance of moving into or out of
the display as they shrinks and expand.

18–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 context menu.

To open the Animation dialog box

X 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 context 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 18-45.

Animating graphic objects ■ 18–3


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.

Range of values A check mark indicates that


through which the animation of this type is
object is animated. assigned to the selected object.

Animation tabs

Expression area

Expression range.

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 Tag button and then
click a name, or type the name. If you do not specify the minimum and
maximum values, and if you use multiple tags in an expression, the first
HMI tag is used for the minimum and maximum values.

18–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 20,


Creating expressions.

Expression range or state

Specify how the object’s appearance should change based on the result
of the expression.

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 can be derived from the minimum and
maximum values for the tag, from constant values, or from the values
of other tags.

Range of values for animating the object

If you do not want to use the values set for the tag or are using data
server tags, specify minimum and maximum values. The range of
motion for the object 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.

If the value of the expression 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 tag in the expression. For

Animating graphic objects ■ 18–5


details, see “Setting the range of tag values for animating the object” on
page 18-9.

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 18-11.

Testing animation

You can test the animation you have set up in a graphic display quickly
Test Display mode by switching to Test Display mode. When you are finished 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
Edit Display mode items on the View menu.

18–6 ■ RSView Supervisory Edition User’s Guide


If your graphic displays contain objects that are associated with device
tags, your system must be set up to communicate with programmable
controllers or data 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-6.

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 and tag placeholders” on page 18-7.

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,

Animating graphic objects ■ 18–7


#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 18-54.

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 22-1.

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 20, Creating expressions, before you begin.

18–8 ■ RSView Supervisory Edition User’s Guide


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.

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.

„ 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

Animating graphic objects ■ 18–9


you want to use minimum and maximum values you expect to
change, or when passing parameters to data server tags.

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

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 you do not specify the minimum and maximum values, and if you use
multiple tags in an expression, the first HMI tag is used for the
minimum and maximum values.

18–10 ■ RSView Supervisory Edition User’s Guide


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

All motion is defined in pixels, degrees, or percent.

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.

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, select


Animation, and then click Horizontal Slider.

Animating graphic objects ■ 18–11


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.

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.

18–12 ■ RSView Supervisory Edition User’s Guide


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.

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.

Animating graphic objects ■ 18–13


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.

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.

18–14 ■ RSView Supervisory Edition User’s Guide


Using the colors and thresholds list
The boxes show the Foreground color
foreground and background Background color
colors for each threshold. If
you select white as the
foreground and background
color, the boxes will not be A box containing two colors
visible over the white shows the colors the object
background of the dialog will alternate between when
Threshold value
box. blinking.
Threshold

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.

Animating graphic objects ■ 18–15


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.

18–16 ■ RSView Supervisory Edition User’s Guide


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 17-2.

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:

a. In the Expression box, type 0.

b. Zero is the default value for threshold A.

c. In the list, click threshold A.

d. Leave the value in the Value box as 0.

e. For Foreground color, click Blink (only foreground color


affects text).

f. Click each color box to open the color palette and then click a
color.

4. Click Apply.

Animating graphic objects ■ 18–17


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. Right-click the rectangle and then click Properties. In the Back


Style list, click Solid.

3. Using the Foreground Color and Background Color palettes, make


the rectangle gray.

18–18 ■ RSView Supervisory Edition User’s Guide


4. Open the Animation dialog box, and then click the Fill tab. Attach
fill animation as follows:

a. In the Expression box, type Hopper\FlourLevel (this is the tag


that controls the fill level).

b. For Fill Direction, click Up.

c. Click Apply.

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

a. In the thresholds and colors list, click A.

b. In the Value box, leave the value as 0.

c. For Foreground and Background colors, click Solid.

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

a. In the thresholds and colors list, click B.

b. In the Value box, type 80.

c. For Foreground and Background colors, click Blink.

d. For Foreground and Background, open the color palettes. For


the first color, click gray. For the second color, click yellow.
Gray Yellow

Animating graphic objects ■ 18–19


Set up the color for the second warning

a. In the thresholds and colors list, click C.

b. In the Value box, type 95.

c. For Foreground and Background colors, click Blink.

d. For Foreground and Background, open the color palettes. For


the first color, click gray. For the second color, click red.
Gray Red

6. Click Apply.

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 push buttons of type Button. It also does not
affect transparent 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.

18–20 ■ RSView Supervisory Edition User’s Guide


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.

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.

Animating graphic objects ■ 18–21


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.

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.

18–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


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.

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.

Animating graphic objects ■ 18–23


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.

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.

18–24 ■ RSView Supervisory Edition User’s Guide


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.

Animating graphic objects ■ 18–25


„ To specify a range of values for changing the width 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 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.

18–26 ■ RSView Supervisory Edition User’s Guide


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.

Animating graphic objects ■ 18–27


„ To specify a range of values for changing the height 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 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.

18–28 ■ RSView Supervisory Edition User’s Guide


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.

Text, advanced objects (except arrows), OLE objects, ActiveX objects,


the button object, 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

„ the degree of rotation for the object

Animating graphic objects ■ 18–29


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

18–30 ■ RSView Supervisory Edition User’s Guide


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.

Animating graphic objects ■ 18–31


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
The circle and crosshair
center of rotation, and then click the option button next to the
indicate the object’s
center of rotation.
box in which the coordinates are displayed.
„ 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
Rotate tool 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 minimum check box.

18–32 ■ RSView Supervisory Edition User’s Guide


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 Do not use drawing objects with touch animation as


momentary push buttons.

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.

To set up touch animation

1. Click the object.

2. In the Animation dialog box, click the Touch tab.

Animating graphic objects ■ 18–33


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.

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.

18–34 ■ RSView Supervisory Edition User’s Guide


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

Animating graphic objects ■ 18–35


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.

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.

18–36 ■ RSView Supervisory Edition User’s Guide


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

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, and edit.

To set up OLE verb animation

1. Click the OLE object.

2. In the Animation dialog box, click the OLE Verb tab.

Animating graphic objects ■ 18–37


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 senior
operator can edit an embedded spreadsheet. For more information
about security, see Chapter 15, Setting up security.

6. Click Apply.

Attaching other types of animation


to OLE objects
You can attach Visibility, Touch, and OLE Verb animation to OLE
objects. Like other objects, the type of animation you can 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

18–38 ■ RSView Supervisory Edition User’s Guide


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 context 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 Chapter 24,
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—in the
Properties tab in the Property Panel. For more information, see “Using
the Property Panel” on page 16-34.

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.

Animating graphic objects ■ 18–39


For details about how to create an ActiveX object, see “Creating and
editing ActiveX objects” on page 17-242.

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 16-43.

„ ActiveX events, see “Connecting tags to an ActiveX object’s


events” on page 18-44.

„ the Invoke command, see “Using the Invoke command to call a


method” on page 18-43.

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
context menu.

The content of the property panel is determined by the application that


created the ActiveX object, not by RSView.

18–40 ■ RSView Supervisory Edition User’s Guide


To link the Properties of an ActiveX object to tags

1. Right-click the object. On the context menu, click Property Panel.

2. In the Property Panel, click the Connections tab.

3. In 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.

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:
„ Type the name of the tag or expression you want to connect to
the property.
Browse button
„ Click the Browse button in the Tag or Exprn column, and then
select a tag or expression for the property.

Animating graphic objects ■ 18–41


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.

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 context menu, click Methods.

2. In the Object Methods dialog box, click a method to view its


description.

18–42 ■ RSView Supervisory Edition User’s Guide


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 18-40.

Use the RSView Invoke command to call the method for the named
object.

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

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

Animating graphic objects ■ 18–43


The easiest way to create the string:

display_name.object.method(parameter1, parameter2, …)

for the Invoke command is to use the Command Wizard.

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 context menu, click


ActiveX Events.

2. Click the event you want to attach the command or macro to.

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.

18–44 ■ RSView Supervisory Edition User’s Guide


3. Type the command or macro name, or click the Browse button to
open the Command Wizard, and then click a command or macro.
Browse button
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.

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, select the check box Log event to Diagnostics
Log, and then if necessary, set up logging in the Diagnostics Setup
editor.

For information about using the Diagnostics Setup editor, see


Chapter 12, Logging system activity.

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 18-40.

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 24-2.

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

Animating graphic objects ■ 18–45


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.

Object keys and display keys are different from client keys. Object keys
and display keys are active only while a particular object or 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 23-12.

For details about the order of precedence among object, display, and
client keys, see page 23-7.

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 16-70.

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.

18–46 ■ RSView Supervisory Edition User’s Guide


To create an object key

1. Click an object.

2. On the Edit menu, click Object Keys.

3. Click Add.

4. In the 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 “Reserved keys” on page 23-10.

5. Click OK.

The key you added appears in the Select key list. If you selected a
modifier, the first letter of that modifier is also displayed. If you

Animating graphic objects ■ 18–47


create a label in the next step, it also appears in the Select key list the
next time you open the Object Keys dialog box.

The information in the Select 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 18-64.

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 18-54.

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 16-70.

10. Click OK.

For details about the Tab index box, see “Using index numbers” on
page 18-49. For details about the Current [Tag] box, see “Using the
Current [Tag] parameter” on page 18-54.

18–48 ■ RSView Supervisory Edition User’s Guide


Using index numbers
RSView assigns index numbers to the following objects:

„ numeric and string input objects

„ button objects

„ objects with object key animation

„ ActiveX objects

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 17-222.

Animating graphic objects ■ 18–49


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.

„ For objects with object key animation, right-click the object, click
Object Keys, and then check the number in the Tab index box.

The selected object


has tab index
number 1.

18–50 ■ RSView Supervisory Edition User’s Guide


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.

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 three ways to change an object’s index number:

„ in the object’s Properties dialog box.

„ in the Property Panel.

„ in the Object Keys dialog box.

To change an index number in the 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.

2. In the Index 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.

Animating graphic objects ■ 18–51


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.

To change an index number in the Object Keys dialog box

1. Right-click the object, and then click Object Keys.

2. In the Tab index 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.

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 18-49.

18–52 ■ RSView Supervisory Edition User’s Guide


To move through a tab sequence

X Do one of the following:


„ 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 values 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 ■ 18–53


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 Edit 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 18-60.

4. In the Press Action field, type an RSView command with [tag] as


the command parameter.

5. Select the graphic object.

6. On the Edit 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.

18–54 ■ RSView Supervisory Edition User’s Guide


Three examples
The following three examples show how to use the Current [Tag]
parameter.

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

2. In the Object Keys dialog box, type the tag name in the Current

Animating graphic objects ■ 18–55


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

18–56 ■ 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 18-61. In the Press Action box, type Help [tag].

Animating graphic objects ■ 18–57


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.

18–58 ■ 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 11-57.

2. In the Display Keys dialog box, assign a display key. In the Press
Action box, type Display AlmSumm /t[tag].

Animating graphic objects ■ 18–59


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 for which you want
to view alarms in the alarm
summary.

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”

18–60 ■ RSView Supervisory Edition User’s Guide


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 16-70.

To create a display key

1. On the Edit menu, click Display Keys.

2. Click Add.

Animating graphic objects ■ 18–61


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 Select 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 Select key list the
next time you open the Display Keys dialog box.

The information in the Select 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 18-64.

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, or
Browse button 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 18-54.

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.

18–62 ■ RSView Supervisory Edition User’s Guide


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 Select key list, click the key you want to modify.

3. Click the Modify button.

4. Make the necessary changes, and then click OK.

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

Animating graphic objects ■ 18–63


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.

Label
Modifiers
Key

The key list displays the keys listed in the Select 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.

18–64 ■ RSView Supervisory Edition User’s Guide


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.

This rule does not apply to visibility, fill or color animation: for objects
with these kinds of animation, animation of the individual objects takes
precedence over animation of the group.

To apply animation to objects within groups, use the group edit feature.
For details about editing grouped objects, see page 16-29.

Checking the animation on objects


To see what type of animation a graphic object or grouped object has,
use the Animation menu or the Animation dialog box . To see what
type of animation objects within a group have, use the group edit
feature. For details about editing grouped objects, see page 16-29.

To find which object in a graphic display is animated by a particular tag,


or to find objects with animation attached, you can use the Object
Explorer. For details, see page 16-11.

Animating graphic objects ■ 18–65


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 context menu, select
Animation, and then see which items have a check mark.

The object has visibility


animation.

18–66 ■ RSView Supervisory Edition User’s Guide


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.

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 16-29.

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 objects, see page 16-16. For


information about duplicating objects, see page 16-18.

Animating graphic objects ■ 18–67


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.

18–68 ■ RSView Supervisory Edition User’s Guide


19
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 Trend graphic library.

„ set up the run-time appearance and behavior of a trend.

Summary of trend features


A trend is a visual representation, or chart, of real-time or historical tag
values. A trend 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.

„ plot data over time, or plot one tag against another in an x-y plot
chart to show the relationship between the two tags.

„ 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 ■ 19–1


The following illustration shows two trends that have been added to a
graphic display.

19–2 ■ RSView Supervisory Edition User’s Guide


The parts of a trend
The following illustration shows a standard trend chart, with two pens
and a three-minute time span. A standard chart is one of two plot types.
The two plot types allow you to plot either against time or against a
scale of values. For more information about the plot types, see
page 19-18.
Chart title
Trend border

Chart Pen with a


square symbol
pen marker
y-axis
Pen icon

y-axis legend

Pen without a
pen marker

x-axis
x-axis legend
Scrolling
mechanism

Line legend in the Current value legend


bottom position 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.

Setting up trends ■ 19–3


Chart title

The chart title is the name you give to the trend chart. Naming the
trend is optional.

x-axis

The x-axis is the bottom horizontal edge of the chart. It is also known
as the horizontal axis or time axis.

x-axis legend

For standard charts, the x-axis legend indicates the time span covered
by the trend. For XY Plot charts, the x-axis legend shows the scale, or
range, of values from a pen you select.

You can set up the trend to omit the x-axis legend. The number of
timestamps or values shown depends on the size of the trend object
and the number of vertical grid lines.

The x-axis legend can also be used at run time to open the X-Axis tab.
For details about setting this up, see “To open the X-Axis tab” on
page 19-66.

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 shows the scale, or range, of values for the pens. You
can set up the trend to omit the y-axis legend.

19–4 ■ RSView Supervisory Edition User’s Guide


The minimum and maximum values for the scale can be:

„ determined automatically (using the best fit for the current data).

„ derived from a pen’s minimum and maximum values.

„ constant values.

„ controlled by tags.

You can set up the trend so that all pens use the same scale, or so that
each pen has its own scale on the y-axis. When the operator clicks a pen
in the line legend, the vertical axis shows the selected pen’s scale.

For example, if Pen 1 has a minimum value of 10 and a maximum value


of 100, the scale 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 scale
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 at run time to open the Y-Axis tab
or to pan data. For details about setting this up, see “To open the Y-
Axis tab” on page 19-66 For more information about panning data at
run time, see “Using pan at run time” on page 19-71.

Pens

Pens are the lines or symbols used to represent values. Pens can be
different colors, widths, and symbols—called markers—so operators
can distinguish one pen from another easily.

For an example of how pen markers are used, see page 19-7. For a list
of pen markers, see page 19-34.

The pen values can be tags you are monitoring, expressions that
manipulate tag values, or constants.

Setting up trends ■ 19–5


Legends

There are four kinds of trend legends:

„ x-axis legend

„ y-axis legend

„ line legend

„ current value legend

The x-axis and y-axis legends are described earlier in this chapter.

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 side of the trend chart and
the current value legend appears on the right 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 page 19-26.

Pen icons

Pen icons appear at the right edge of the chart. You can specify whether
or not pen icons are displayed on the trend chart. For more
information about showing or hiding pen icons, see page 19-25.

At run time, if a pen’s current value is within the scale 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.

19–6 ■ RSView Supervisory Edition User’s Guide


Pen markers
Pen markers are symbols that indicate data points. The list of pen
markers is shown on page 19-34. 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.

You can use pen markers to show when data is sampled. For example,
when the trend is updated as the value changes, the pen marker
indicates when the trend is updated.

A ‘boxed’ pen marker

An ‘Up triangle’ pen


marker

You can use pen markers as a means to reading pen values at run time.
Place the value bar on a pen marker, and the value bar shows the value
of the chart point indicated by the pen marker.

Setting up trends ■ 19–7


Trend Properties dialog box
The Trend Properties dialog box contains nine tabs for setting up the
appearance and content of the trend. Specify the trend chart’s
appearance, and how the trend plots data by filling in the fields on these
tabs.

For information about setting up the trend using the Trend Properties
dialog box, see the topics starting on page 19-17.

19–8 ■ RSView Supervisory Edition User’s Guide


Value Bar
The value bar marks 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
at run time.

The value of each pen


plotted on the trend chart at
this position

The value bar

Setting up trends ■ 19–9


Trend chart types

Standard Chart
A standard chart plots tag values against time.

In a standard chart, the y-


axis shows pen values …

… and the y-axis legend


shows time values.

19–10 ■ RSView Supervisory Edition User’s Guide


XY Plot Chart
An XY Plot chart plots the values of one or more tags against another
tag.

Use the XY Plot chart to plot one tag’s values against another tag’s
values instead of plotting one tag’s values against time. For example,
you could plot the temperature of a tank against the pressure of the
tank.

In an xy plot, the y-axis


shows pen values …

… and the x-axis legend


shows pen values.

In the illustration above, the y-axis pen’s data is plotted as a diagonal


line on the trend chart.

The x-axis legend displays the scale for the x-axis pen. The time period
covered by the chart is at the upper left.

Setting up trends ■ 19–11


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. Use
isolated graphing to view each pen individually on the trend chart.

This is an example of isolated graphing, with 0% isolation between


each pen’s band: A pen band is the area of the trend chart used by an
isolated pen. Use the isolated graphing percentage to specify the space
between each band.

In this illustration each pen uses its own scale. You can use the same
scale for all pens. For information about setting up the pen scale, see
“Setting up the vertical scale for multiple pens” on page 19-49.

With isolated graphing, a grid line is automatically placed above each


pen’s band.

19–12 ■ RSView Supervisory Edition User’s Guide


Choosing trend colors, fonts, lines, and markers
The following table summarizes where to specify colors, fonts, lines,
and markers for a trend in the Trend Properties dialog box.
And then use
this box or
To specify this Click this tab column

Chart background color Display Background color


Text color of the x-axis legend Display Text color
Text font, style, and size Display Font (button)
Pen line, pen marker, pen icon, and Pens Color
the text color of the y-axis legend
Pen line width Pens Width
Pen line style Pens Style
Pen marker Pens Marker
Color of vertical lines in the grid X-Axis Grid color
Color of horizontal lines in the grid Y-Axis Grid color

You can also specify these settings in the Properties tab of the Property
Panel. For details about using the Property Panel, see page 16-34.

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. For information about the highlight
color for the graphic display, see page 16-71.

Setting up trends ■ 19–13


Changing the trend chart background color
The default background color of the trend chart is black.

To change the trend chart background color

1. In the Display tab, click Background color.

2. Click a color in the palette.

This chart has a


background color.

19–14 ■ RSView Supervisory Edition User’s Guide


Changing the trend object background
The space behind and around the trend chart and legends is the
background of the trend object.

You can change the color and style settings for the background using
the WindowStyle and WindowColor options in the Property Panel.

The shaded area is the


background of the trend
object.

There are three settings for the WindowStyle property:

Default uses the opaque WindowStyle and RSView’s ambient color


settings.

Opaque uses WindowColor.

Transparent allows other objects to be seen when they are located


behind the trend object. This setting may slow the drawing of the trend.

Setting up trends ■ 19–15


To display the background color

1. In the Property Panel, click WindowColor.

2. Select a window color from the palette.

3. Click WindowStyle, and then click Opaque from the list.

For information about using the Property Panel, see page 16-34.

Creating a trend object


Instead of creating a trend from scratch, you can use the trend chart in
the Trends graphic library. For more information, see “Using the Trend
graphic library” on page 19-63.

To create a trend object

1. In a graphic display, choose the Trend drawing tool by doing one


of the following:

„ Click the Objects menu, select Advanced Objects, and then


click Trend.
„ Click the trend tool in the Objects toolbar.
Trend tool
The cursor changes to the trend drawing tool:

2. Drag the mouse to create a box approximately the size you want
for the trend.

3. Double-click the trend to open the Trend Properties dialog box.

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

19–16 ■ RSView Supervisory Edition User’s Guide


For information about editing graphic objects, see Chapter 16, Creating
graphic displays.

Setting up how the trend loads and updates data

In the General tab, set up


the chart title, data server
type, chart style, and chart
update mode.

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 trend real-time values using the TrendX object


model. If no server is defined in the object model, data is acquired
from RSView. For information about using the TrendX Object
Model, see Help.

Setting up trends ■ 19–17


„ Real-time data server acquires data from tags and data log models.
Use this option when the data log is logging infrequently and you
want to plot data more often than that in the data log model.

„ Poll for Historical Data acquires the newest historical data from the
data server. Use this option to poll the data log at the rate specified
by the chart update mode. When you use this option, the trend
charts only historical data. For information about the chart update
mode, see page 19-19.

If you use Poll for Historical Data, the current value legend does not
display pen icons or pen values.

Display progress bar while loading historical data Select this


check box to display a progress bar with a Cancel button while data is
being loaded into the Trend. The progress bar does not appear if the
data loads faster than 1 second. Providing this option allows operators
to cancel a request for data if, for example, the operator has requested
the wrong data, or if the request is taking too long and the operator
wants to narrow the selected time span.

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 x-axis. Use a Standard plot type to measure a pen’s values against
time.

XY Plot This option is available only when one or more pens have
been set up in the Pens tab.

Click XY Plot to create a trend with a pen that serves as the x-axis. Use
an XY Plot chart to plot one pen’s values against another pen’s values.

19–18 ■ RSView Supervisory Edition User’s Guide


For example, you could plot the temperature of a tank against the
pressure of a tank.

X-Axis pen Select the pen for the x-axis in an xy plot. The y-axis pen
on the trend chart charts against the x-axis pen’s values.

Setting up the chart update mode

Manual If the Data Server option is set to Real-time data server, or


Poll for historical data, set the chart update mode to Automatic. For
information about the Data Server option, see page 19-17.

The Manual option is reserved for use with the NewData method in
the TrendX object model, and is only available when the data server is
set to None.

The NewData method allows you to provide data to the trend chart
from sources other than RSView real-time and historical data
providers. For more information about the NewData method in the
TrendX object model, see Help.

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.

While using Historical poll mode, the refresh rate controls how often
the data server is polled for data, and the refresh rate cannot be set to
a value lower than 1 second.

Setting up trends ■ 19–19


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 specify when data is updated:

„ 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 want to update On
change but not use the heartbeat, type 0.

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

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. For information about data log models, see Chapter 13,
Setting up data logging.

Saving trend data to the data buffer


When the trend chart is paused, pen data is saved in the data buffer. A
data point is saved to the buffer whenever the value changes. When the
buffer is full, the oldest data point is overwritten with a new data point.
The buffer contains up to 32,767 data points per pen. For more
information about the data buffer, see “Buffer for extra data” on
page 19-28.

You can use the buffer to collect data for the trend when trend is not
visible on the graphic display. For information about charting data

19–20 ■ RSView Supervisory Edition User’s Guide


when the trend is not visible in the graphic display, see “Collecting data
in the background at run time” on page 19-64.

Overlaying a snapshot of previously-


charted data
You can also layer a trend with a snapshot of previously-charted data.
This is called an overlay.

An overlay allows you to compare charted data to a snapshot, and is


useful if you want to compare data from a particular shift or batch
process.

For more information about snapshots and overlays, see “Comparing


real-time and historical data” on page 19-50.

Overlay pen

Currently-plotting pen

Currently-plotting pen

Overlay pen

Setting up trends ■ 19–21


Setting up the trend display settings

Use the Display tab to set


up the appearance of the
trend.

Time format Specify how the trend displays time:

„ Use system time setting-displays time using the time format


specified in the Windows Control Panel, in the Regional Options
dialog box of Windows 2000, or the Regional and Language
Options of Windows XP.

„ 24-hour format.

„ AM/PM format.

Chart radix Specify the numeric base format (decimal, hexadecimal,


or octal) for displaying numeric values in the trend legends.

19–22 ■ RSView Supervisory Edition User’s Guide


This setting affects the y-axis legend, current value legend, and value
bar for both plot types. If you select the XY Plot chart style, this setting
also affects the x-axis legend.

IMPORTANT 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, the
number of decimal places 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 connects data points with a line.

„ Show disconnects shows plot lines 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 displays a marker for each data point. Lines do
not connect the data points.

IMPORTANT A pen does not appear in a trend chart if you specify


Show only markers, and the pen has no marker assigned
to it in the Pens tab.

Display milliseconds If you select the Standard chart style, select this
check box to display milliseconds in the time labels on the x-axis
legend. 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
using the value bar at run time, see “Using the value bar at run time”
on page 19-68.

Setting up trends ■ 19–23


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 “Choosing trend
colors, fonts, lines, and markers” on page 19-13.

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 selected pen. To
select a pen, click a pen in the line legend.

Font Click this button to change the type style of all text in the trend
chart.

Displaying a current value legend


The current value legend can be displayed by itself or as part of the line
legend. When the line legend is set to appear at the bottom of the trend
chart, the line legend includes the current value legend. When the line
legend is displayed to the left of the trend, the current value legend is
displayed to the right of the trend.

The following illustration shows the current value legend to the right
of the trend:
Current time
Current pen value
Pen icon
Pen line color

The following illustration shows the current value legend as part of the
line legend, at the bottom of the trend:

Pen caption Current value Min/max values Engineering units


legend

19–24 ■ RSView Supervisory Edition User’s Guide


Display pen values Select this check box to display pen values in the
current value legend.

Display time Select this check box to display the time when data was
last collected.
Display pen icons Select this check box to display the pen icons in the
current value legend. The pen icons show the current value of the pen.
When the chart is paused, the pen icon continues to chart the current
value of the pen, and therefore could be in a different position than the
end of the pen line in the chart.

Displaying a line legend


The line legend shows the details of a pen line, including the line color,
pen name, the minimum and maximum values, and the engineering
units.

The line legend’s appearance is different, depending on where it is


located relative to the chart. The following illustration shows the line
legend as it appears when it is in the bottom position:

Pen caption Current value Min/max values Engineering units


legend

The following illustration shows the line legend as it appears when it is


in the left position:
Pen caption

Engineering units Min/max values

Setting up trends ■ 19–25


Display Line Legend Select this check box to display a legend for
each pen line.
Position Specify a position for the line legend:

„ Click Bottom to make the line legend and the current value legend
appear at the bottom of the chart.

„ Click Left to make the line legend appear 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. At run time, the line legend will display only the
number of pens you have specified, in the order that they appear in the
Pen Attributes spreadsheet.

If there are more pens specified than you have specified to appear in
the line legend, the trend chart will plot all the pens, but the line legend
will only show the number of pens you have specified. To view the pens
that are not shown on the chart, use the scroll bar.

Display mix/max values Select this check box to display the


minimum and maximum values for each pen in the line legend. The
minimum and maximum values are set in the Pens tab. For details, see
“Min/Max” on page 19-35.

Pen caption Specify the type of pen caption to be displayed:

„ Long tag name displays the full path and tag name for each pen.

19–26 ■ RSView Supervisory Edition User’s Guide


„ Short tag name displays only the tag name, without the path.

„ Description displays the tag description set up in the Pens tab.

Maximum pen caption length Specify the maximum number of


characters that can appear in the pen caption, up to 80 characters. The
pen caption is truncated on the line legend if you specify fewer
characters than there are in the pen caption.

Determining how the trend chart


is filled with data

Allow scrolling Select this check box to allow the trend data to plot
on the trend chart.

If you clear this option, the trend chart is paused, and the data buffer
stores trend data until the buffer limit is reached. When the limit is
reached, the oldest data is discarded and replaced with the newest data.
While the trend is paused, the pen icons to the right of the trend chart
indicate pen values by pointing to the position of the pen value. For
information about displaying pen icons, see page 19-25.

The operator can turn off pause by clicking the pause button at run
time. When pause is turned off, the trend data that was held in the
buffer plots on the trend chart. For more information about the
scrolling mechanism, see page 19-67.

Setting up trends ■ 19–27


If you allow scrolling, specify a scroll mode:

„ Continuous Scroll scrolls the chart from right to left as the trend
data is plotted.

„ Half Screen Scroll scrolls the chart half a screen at a time. The chart
scrolls from left to right. When the pens reach the right side of the
chart, the chart scrolls half a screen and the pens continue plotting
values starting in the center of the chart.

„ Full Screen Scroll scrolls the chart a full screen at a time. The chart
scrolls from left to right. When the pens reach the right side of the
chart, the entire chart scrolls and the pens continue plotting values,
starting at the left side of the chart.

Display Scrolling Mechanism Select this check box to display VCR-


style buttons for scrolling the chart manually.

The buttons allow operators to scroll backward and forward through


data. The operators can also pause and resume automatic scrolling For
more information about using the VCR-style buttons at run time, see
page 19-67.

Buffer for extra data The data buffer stores pen values that are not
within the time period or the value range of the trend chart at run time.
The operator can view these pen values by using the VCR-style
buttons to scroll through the data manually.

You can use the data buffer to collect data in the background when the
trend chart is not displayed in the graphic display. For more
information about collecting trend data in the background, see
page 19-64.

Type the number of data points to store for each pen. You can store a
maximum of 32,767 data points, or records, per pen.

Scrolling is faster when pen values are stored in a buffer. However, a


larger buffer size also requires more system resources.

19–28 ■ RSView Supervisory Edition User’s Guide


Adding pens to the trend

The pens tab lets you set


up the appearance, tags or
expressions for a pen, or
for multiple pens.

To add pens to the trend

1. In 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 information about using the
Expression Editor, see Chapter 20, Creating expressions.

„ To plot a tag value, click Tags, and then specify a tag name in
the Tag Browser.
„ To plot a constant value-such as a tag’s alarm level-type a value
in the Expression box.
„ To define an expression, use the buttons in the Expression
Editor.

Setting up trends ■ 19–29


„ 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 information about placeholders, see
page 16-51.

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, you must
set up a data log model. For information about data logging and how
to set up a data log model, see Chapter 13, Setting up data logging.

To open the Configure Tags


dialog box, in the Pens tab,
click Add pens from model.

19–30 ■ RSView Supervisory Edition User’s Guide


To add a pen to the trend from a data log model

1. In the Pens tab, click Add Pen(s) from Model to open the
Configure Tags dialog box.

2. Click the browse button to select an area. A stand-alone


application has only one area to select.

If there is no area to select, you have not set up a data log model for
this application. Click Cancel to return to the Pens tab.

3. In the model list, specify a data log model. The data log model tags
are listed in the box.

4. Click the tag you want to add to the trend as a pen, and then click
Add. To add all of the tags in the model, click Add all.

To select multiple tags, do one of the following:

„ Click the first tag you want to select, press and hold down the
Shift key, and then click the last tag you want to select.
„ Click, and then drag the mouse across the tags you want to
select.
„ To select tags that are not consecutive, click the first tag you
want to select, press and hold down the Ctrl key, and then click
each tag you want to select.
5. The tags 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 of the tags listed
in the tags to monitor box, click the tag, and then click Remove.

7. To remove all of the tags from the Tags to Monitor box, click
Remove All.

8. When the Tags to monitor box lists the tags you want to add to the
trend, click OK.

Setting up trends ■ 19–31


Deleting a pen from the trend
1. Select the pen you want to delete from the Pen Attributes
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 pens you want to
select.
„ 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


Use the Pen Attributes spreadsheet to set up the individual attributes
for each pen. A tag you specify becomes a pen for the trend. 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
spreadsheet.

This is the pen number. To


select a pen, click its
number.

Pen Number This column identifies the number of the pen. Up to 100
pens can be added to a trend. To select a pen, click the pen number.

19–32 ■ RSView Supervisory Edition User’s Guide


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 a pen is determined by the value of the tag or
expression. Click the browse button to edit the expression or select a
tag.

Model Click the browse button to select a data log model for a pen.
Tags and expressions must be set up in the data log model you select.
For information about data log models, see Chapter 13, Setting up data
logging.

Color Select a color to identify this pen on the trend chart. 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 the cell to switch the Visible setting to On or Off. When Visible
is set to Off, the pen is not displayed in the chart.

Width The pen width affects the thickness of the pen line and the
markers.

Click the cell, and then specify a pen width from the drop-down list
box. If you specify a width other than 1 pixel, you cannot change the
line style setting.

Type Click the cell, 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:

Setting up trends ■ 19–33


This item Does this

Digital Draws a line along the time axis as the first value, then, when
the value changes, draws a vertical line to the second value.
For example:

Full Width Draws a tag’s most recent value horizontally across the
width of the trend.

For example, if the most recent value for a tag is 75, draws
a horizontal 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 set points.

Style Click this cell, and then specify a line style. You can select from
one of five styles, shown below.

The styles are:


Solid

Dash

Dot

Dash-Dot

Dash-Dot-Dot

Marker Select a marker from the symbols in the list. If you use the
Show only markers option, specified in the Display tab, only pens for
which you specify a marker 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 Marker

Boxed

19–34 ■ RSView Supervisory Edition User’s Guide


Name Marker

Up triangle

Down triangle

Keyboard characters <:!@#(


Letters A, a, B, b
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.

Min/Max The Min and Max tag values are specified in the HMI
server’s tag editor and are automatically entered in these columns.

The tag’s minimum and maximum values are used to determine a pen’s
scale. When an operator clicks a pen in the line legend, the y-axis legend
re-scales to fit the selected pen’s minimum and maximum values. Tag
values outside the minimum and maximum scale do not appear on the
trend chart.

You can change these values if necessary. Click the minimum or


maximum cell, and then type a value to set the tag’s minimum and
maximum values.

You can also specify a pen scale on the Y-Axis tab. For more
information about setting minimum and maximum value options on
the Y-Axis tab, see page 19-46.

Eng. Units Select this check box, and then type the name of the
engineering unit that the pen represents. For example, rpm, gallons, fps,
or degrees. The engineering units are displayed as part of the line
legend.

Description If the tag you have added to the trend already has a
description, the description appears in this cell. To remove the
description, click the cell, and then press the Backspace key.

Setting up trends ■ 19–35


If the tag you have added to the trend does not already have a
description or if you want to change the description, click the cell, and
then type a description of the tag.

The description appears in the line legend.

Lower Bound The lower bound setting determines when shading will
occur between the pen for which you are setting up the pen attributes,
and the pen you select as the lower bound pen.

Click this cell and specify the lower bound pen in the list. At run time,
the area between the two pens is shaded when the pen you have set up
on the Pens tab crosses the lower bound pen on the trend chart. For
information about using shading to compare pen values, see
page 19-38.

Upper Bound The upper bound setting determines when shading will
occur between the pen for which you are setting up the pen attributes,
and the pen you select as the upper bound pen.

Click this cell and specify the upper bound pen in the list. At run time,
the area between the two pens is shaded when the pen you have set up
on the Pens tab crosses the upper bound pen on the trend chart. For
information about using shading to compare pen values, see
page 19-38.

Link Data Select this check box to update the tag’s minimum,
maximum, description, and engineering units properties at run time.
This allows you to make changes to the trend properties at any time and
have them updated at run time. Link data also updates the tag
properties if the properties were changed in the HMI server’s tag
editor.

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

19–36 ■ RSView Supervisory Edition User’s Guide


initially, you must update them manually. Update the tag properties
manually by changing the options in the Pen Attributes spreadsheet.

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 HMI server’s tag editor.

Editing multiple pens simultaneously


Use the Multiple Pen Edits spreadsheet to edit more than one pen at
the same time.

To edit multiple pens simultaneously

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.
„ 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 correct 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.

Setting up trends ■ 19–37


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.

There are two ways to plot a value so that it appears as a horizontal line
across the full width of the chart:

„ In 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.

„ In 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
Pen Attributes 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.

Using shading to compare pens

You can set up a trend so that certain parts of it are shaded to


emphasize a comparison between two or more 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

19–38 ■ RSView Supervisory Edition User’s Guide


value exceeds the alarm threshold by filling in the area between the two
pens with Pen 1’s line color.

Set up shading in the Pens tab in the Trend Properties Dialog box.

IMPORTANT Shading is determined by the position of lines on the


trend chart—not by the actual tag values.

The trend 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 ■ 19–39


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

To produce the shading shown above, the following settings were used:
Shading
Tag name or
Pen Constant value Upper Bound Lower Bound

Pen 1 VIN_LEVEL Pen 2 Pen 3


Pen 2 75
Pen 3 25

19–40 ■ 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

To produce the shading shown above, the following settings were used:

Shading
Tag name or
Pen Constant value Upper Bound Lower Bound

Pen 1 VIN_LEVEL Pen 2


Pen 2 OIL_LEVEL

Setting up trends ■ 19–41


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

To produce the shading shown above, the following settings were used:

Shading
Tag name or
Pen Constant value Upper Bound Lower Bound

Pen 1 VIN_LEVEL Pen 2 Pen 2


Pen 2 OIL_LEVEL

19–42 ■ RSView Supervisory Edition User’s Guide


Setting up the horizontal axis (x-axis)
For a Standard chart, the horizontal axis represents time; for an XY
Plot chart, the horizontal axis represents the values of the x-axis pen.
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 in the
Display tab, the start date and time are disabled. To change the start
date or time, clear the Allow scrolling check box.

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 side of the
x-axis. As the chart scrolls with new data, the time is updated on the
horizontal axis label.

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.

Setting up trends ■ 19–43


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 number, 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
XY 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 Select this check 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.

For an xy 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 Select this check box to display the date of
each time stamp.

19–44 ■ RSView Supervisory Edition User’s Guide


Display grid lines Select this check box to display vertical grid lines
on the trend chart.

Major grid lines/Minor grid lines Type the number of major and
minor lines that will appear 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.

Grid color If grid lines are displayed on the chart, you can change their
color. Click the grid color box, and then click a color in the palette. The
grid line color will change to the color you have selected.

Setting up the vertical axis (y-axis)

Use the Y-Axis tab to set


up the run-time chart’s
vertical axis.

Setting up trends ■ 19–45


Defining the minimum and maximum values
on the vertical axis

Use the Y-Axis tab to specify which scale of pen values you use for the
trend chart. The scale of values can be the same for all pens, different
for all pens, or a percentage of the pen values.

To use the same scale for all pens, use the All pens on same scale or
Scale using pen options. For details, see “Setting up the vertical scale
for multiple pens” on page 19-49.

To use a different scale for each pen, use the option, Each pen on
independent scale. For details, see “Setting up the vertical scale for
multiple pens” on page 19-49. When you use a different scale for each
pen, the minimum and maximum values on the y-axis legend 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 scale 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 scale on the vertical axis will change to -10 to 50 when the Tag2 pen
is selected.

To select a pen at run time, click a pen in the line legend.

Minimum/maximum value options Click an option to specify the


minimum and maximum values for the vertical axis:

„ Click Automatic to make the lowest pen value serve as the


minimum value, and the highest pen value serve as the maximum
value. As the trend acquires new data, the trend chart rescales to fit
the new values.

„ Click Preset to make the minimum and maximum pen values you
set up in the Pens tab serve as the y-axis scale. The scale does not
change.

The Scale options on the Y-Axis tab specify which pen’s minimum
and maximum values are used as the Preset values. For more

19–46 ■ RSView Supervisory Edition User’s Guide


information about Scale options, see “Setting up the vertical scale
for multiple pens” on page 19-49.

„ Click Custom to specify a constant, tag or expression for the


minimum and maximum values.
To set up a constant minimum or maximum value

1. In 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.

To set up a tag or expression as a minimum or maximum value

1. In the Y-Axis tab, click Custom.

2. Click Minimum value tag\expr. or Maximum value tag\expr.

Setting up trends ■ 19–47


3. Click the Browse button. The Expression Editor opens.

4. Type an expression or select a tag. For information about


adding a tag or expression, see page 19-29.

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

If you select isolated graphing, you cannot display horizontal grid lines.
Instead, a horizontal line appears above each band. For more
information about isolated graphing, see page 19-12.

% isolation This option is only available when you select Isolated


graphing.

Type a number between 0 and 10 for the percentage of the chart height
that separates 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 Select this check box to display the y-axis legend to the
left of the trend.

To display decimals in the legend, 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.

19–48 ■ RSView Supervisory Edition User’s Guide


Display grid lines Select this check box to display horizontal grid
lines on the chart.

Major grid lines/Minor grid lines Type the number of major and
minor lines that will appear 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.

Grid color If grid lines are displayed on the chart, you can change their
color. Click the Grid color box, and then click a color in the palette.

If you select isolated graphing, the grid color is used for the horizontal
lines between bands.

Setting up the vertical scale for multiple pens


You cannot set up a vertical scale for multiple pens if you specify
Custom minimum and maximum values. For information about setting
up Automatic and Preset minimum and maximum values in the Pens
tab, see page 19-35.

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 use one scale
for all pens. The lowest minimum value from all the pens and the
highest maximum value from all the pens makes up the pen scale.

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 scale. The vertical axis displays only one pen’s
scale at a time.

Setting up trends ■ 19–49


The operator can view each pen’s y-axis legend by clicking a pen in the
line legend. When the operator clicks the pen in the line legend, the
vertical axis changes to the new pen’s scale. The color of the y-axis
legend changes to the color of the selected pen.

Scale using pen You must add at least one pen to the trend to use this
option.

Click Scale using pen to use the same scale for all pens and then select
a pen from the list. The pen scale is based on the minimum and
maximum values for the specified pen.

Scale as percentage Select this check box to display the y-axis values
as a percentage of the minimum and maximum scale. The y-axis legend
displays the percentage scale, from 0 to 100%. For example, you could
have a tank with a minimum value of 0 gallons and a maximum value
of 5237.50 gallons. By using Scale as percentage, the trend chart would
show the tank as 50% full instead of a value of 2618.75 gallons.

Comparing real-time and historical data

Use an overlay to compare real-time and historical data. Overlays are


set up on the Overlays tab. From the Overlays tab, you can:

„ add a snapshot to the Trend as an overlay.

„ set the position of the overlay on the chart.

„ set the time where the overlay begins on the chart.

„ remove overlays from the Trend.

„ delete snapshots.

The Overlay options can be changed at run time. The run-time options
allow the operator to align, relocate, show, hide, and set up overlays. For

19–50 ■ RSView Supervisory Edition User’s Guide


information about setting up the trend’s run-time options, see
page 19-60.

Use the Overlays tab to


add, remove, or delete
snapshots of historical
data, and to specify where
the overlay appears on the
trend chart.

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. In RSView Studio, set up a trend chart to your specifications using


the information in this chapter.

2. On the Tools menu, click Launch SE Client.

3. Right-click the trend to open the context menu, and then click
Create Snapshot.

Setting up trends ■ 19–51


4. In the Component Name dialog box, type a name for the
snapshot, and then click OK.

To add a snapshot to the trend as an overlay

1. In RSView Studio, open a trend graphic display.

2. Double-click the trend. The Trend Properties dialog box opens.

3. In the Overlays tab, click Add.

4. In the Component browser, click a snapshot, and then click OK.

Operators can show or hide overlays on the trend chart using the
context menu at run time. You can set up run-time options in the
Runtime tab. For information about setting up the trend’s run-time
options, see page 19-60.

To remove an overlay

1. In the Overlay Attributes spreadsheet in the Overlays tab, click the


pen number of the overlay you want to select.

This is the pen number. To


select an overlay, click its
pen number.

2. Click Remove. The overlay is removed from the Trend, and is no


longer available to the operator at run time.

The snapshot is not deleted, but is no longer available as an overlay on


the run-time chart.

19–52 ■ RSView Supervisory Edition User’s Guide


Deleting snapshots
You cannot delete a snapshot until you remove it from every trend in
which the snapshot is used.

To delete a snapshot

1. In the Overlays tab, click Delete snapshot.

2. In the Component browser, click a snapshot, and then click OK.


The snapshot is deleted.

Changing the attributes of a snapshot pen


When you add a snapshot to a trend as an overlay, the pens from the
snapshot are automatically added to the Pens tab in the Trend
properties dialog box.

You can change the attributes of pens used in overlays in the same way
as the attributes of regular pens. For details about setting up pen
attributes, see page 19-32.

Setting up overlays
For information about changing the overlay at run time, see
page 19-72.

Name The name of the snapshot added to the trend as an overlay.

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 the cell to switch between Position and Time settings.

„ Click Position to align the earliest data in the snapshot with 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 scales of the
data in the snapshot change to match those of the run-time chart.

Setting up trends ■ 19–53


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.

„ Click Time to start the snapshot 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. For information about
setting up the refresh rate, see page 19-19.

If you pan or zoom the data in the chart, the overlay data held in the
snapshot also pans or zooms.

Start This cell is available when you anchor the overlay by time. It is
not available if you anchor the overlay by position.

The default start time is the time at the left-most side of the chart.

Double-click this cell to open the Start Time dialog box. Use the Start
Time dialog box to set up a start time. For information about the
options on the Start Time dialog box, see Help.

Offset (%) This cell is available when you anchor the overlay by
position. It is not available if you 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. The percentage is 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 in the snapshot starts 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.

19–54 ■ RSView Supervisory Edition User’s Guide


Visible Use this option to show or hide the overlay on the trend chart.

Click the cell to switch the Visible setting to On or Off. To display the
overlay when the chart opens at run time, set Visible to On. When
Visible is set to Off, the Overlay does not appear on the trend chart.

To show or hide a pen in the overlay, use the Visible option in the Pens
tab. For details, see page 19-33.

At run time, operators can show or hide each overlay using the context
menu. You can set run-time settings to allow an operator to show or
hide overlays at run time. For information about setting up run-time
settings, see page 19-60.

First Pen/Last Pen Use the First Pen/Last Pen option to determine
which pens in the Pens tab correspond with the pens in the snapshot.

When you add a snapshot to a trend, all of the pens in the snapshot are
added to the Pen Attributes spreadsheet in 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 in the Pens tab.
You can change pen attributes for snapshot pens in the Pens tab. For
information about using the Pen Attributes spreadsheet, see
page 19-32.

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. In the
Pens tab, the 3 pens from the snapshot hold positions 6, 7, and 8 in the
Pen Attributes spreadsheet.

Setting up trends ■ 19–55


Creating a trend template

You can use a trend template to:

„ apply a consistent appearance to trend charts.

„ create a set of different views for the same data.

„ return to a standard display after experimenting with display


options.

„ save pen attribute data

Applying a consistent appearance


to trend charts

Create a trend template to standardize a trend chart for all your


applications. Use a standard template when you have several different
applications and you need the trend chart to work the same way in each
application.

When you have created and saved your template, load the template into
each RSView Studio application’s trend chart.

Creating a set of different views


for the same data
Create a trend template for each type of trend data chart you need to
use in order to assess the data. Load these trend templates at run time
to change the appearance of your trend data. For information about
loading a template at run time, see page 19-59.

Returning to a standard display

Create a trend template to use as a standard display. Load the standard


display template when you or your operators have changed the trend
chart settings and you want to return to your standard trend chart.

19–56 ■ RSView Supervisory Edition User’s Guide


Saving pen attribute data

Create a trend template to save pen attribute data. You can add a
number of new pens at run time, create a template, and then save pen
attribute data with the template. You can then close the trend graphic
display, reopen it later, and instead of having to add each pen again, you
can load the template. When you load the template, the pen attribute
data will also be loaded.

IMPORTANT If you load a template at run time, any existing pens in


the trend are deleted and replaced with the pens in the
template.

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.
To set up options in this tab See page

General page 19-17


Display page 19-22
Pens page 19-29
X-Axis page 19-43
Y-Axis page 19-45

2. In 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, the trend tabs are listed. Click a
tab to select it.

On the right side of the options box, the tab options that can be
included in a trend template are listed. Click the option to check or

Setting up trends ■ 19–57


uncheck it. Checked tab options are saved with the template.
Unchecked tab options are not saved with the template.

Use the Template tab to


create pre-set trend
properties, and then save
them as a template.

To select or deselect all of


the options on all of the
tabs, select the All options
check box, and then click
Check All, or click
Uncheck All.

To select all of the To deselect all of the To return all settings to


options on one tab, options on one tab, their system defaults,
click Check All. click Uncheck All. click Default.

3. Click Save Template.

4. In the Component name dialog box, type the name of the


template, and then click OK.

19–58 ■ RSView Supervisory Edition User’s Guide


Loading a template
Load a template to return to your original settings, or to apply a
consistent trend appearance across applications.

1. In the Trend Properties dialog box, click the Template tab, and
then click Load template.

2. Select a template from the Component browser and then


click OK.

Deleting a template
1. In the Trend Properties dialog box, click the Template tab, and
then click Delete template.

2. Select a template from the Component browser, and then


click OK.

IMPORTANT Saving, loading, or deleting a template takes effect


immediately, and cannot be undone.

Loading a template at run time


Use the Invoke command to load a template at run time.

Example: Using the Invoke command to


switch between two templates at run time
1. Set up a template with isolated graphing called Isolated.

2. Set up a template with non-isolated graphing called Non-Isolated.

3. In the trend graphic display, create a button to load the isolated


graphing template with the following command:

Invoke Me.Trend1.LoadTemplate (“Isolated”)

Setting up trends ■ 19–59


4. In the trend graphic display, create a button to load the non-
isolated graphing template with the following command:

Invoke Me.Trend1.LoadTemplate (“Non-Isolated”)

5. Use the buttons at run time to load the required template.

Setting up the trend’s run-time options


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.

19–60 ■ RSView Supervisory Edition User’s Guide


Displaying property pages at run time
Select the check box for each tab to which operators will have access at
run time.

For example, to prevent operators from adding pens to the chart at run
time, clear the Pens tab check box.

Setting up chart behavior

Allow editing legend properties Select this check box to allow


operators to change trend legend options at run time. The operator can
double-click the trend chart legends at run time to open the
corresponding trend properties tab.
At run time, double-click the To open the

line legend Pens tab


x-axis legend X-Axis tab
y-axis legend Y-Axis tab
trend title Graph title dialog box

The Display Property option for at least one of the above tabs must be
checked to allow editing legend properties.

Allow Pan/Zoom Select this check box to allow operators to zoom


and pan the run-time chart. For details about using zoom at run time,
see page 19-70. For details about using pan at run time, see page 19-71.

Setting up trends ■ 19–61


Setting up context menu options

Use these settings to determine which context menu options are


available to the operator at run time.

Allow pause/resume scrolling Select this check box to allow


operators to use the context menu to pause and resume automatic
scrolling.

Allow Show/Hide value bar Select this check box to allow operators
to use the context menu to show and hide the value bar. This option
will allow operators to show the value bar even if you have cleared the
value bar check box in the Display tab. For information about setting
up options on the Display tab, see page 19-22.

Allow Snapshot creation Select this check box to allow operators to


create and name snapshots. Use snapshots to add an overlay to a trend
chart. For information about using snapshots and overlays, see
“Comparing real-time and historical data” on page 19-50.

Allow overlay options Select this check box to allow operators to


align, relocate, show, and hide overlays on the trend chart. This option
also allows operators to use the context menu to open the Overlays tab.

Allow print Select this check box to allow operators to print the trend
chart.

Allow Delta value bar Select this check box to allow operators to use
the Delta value bar. For information about using the Delta value bar at
run time, see page 19-69.

19–62 ■ RSView Supervisory Edition User’s Guide


Setting up the Common properties
Some properties, such as size and position, are common to all graphic
objects. Set up these properties in the Common tab. For details, see
“Setting up properties common to all graphic objects” on page 17-22.

Using the Trend graphic library


The Trend 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 Trend 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 Trend, and then click Open.

4. Drag and drop one or more trend buttons, or the trend chart into
your display.

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
Test Display mode you are finished testing, switch back to Edit Display mode to continue
editing.

Edit Display mode


To switch between test display and edit display modes

X On the View menu, click Test Display or Edit Display, or click the
Test Display or Edit Display buttons on the toolbar.

Setting up trends ■ 19–63


Using the trend at run time

Select run-time options in the Runtime tab of the Trend Properties


dialog box. For information about setting up the trend’s run-time
options, see page 19-60.

Collecting data in the background at 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. This can be a problem if the trend chart is not open for the
whole time the application is running, or if other graphic displays are
opened before the trend display.

If you want the trend to contain data when the graphic display is
opened, you can either use a data log model, or you can create a startup
macro that loads and updates the display in the background. This loads
data into the data buffer for the trend.

For information about setting up an HMI server to run a startup


macro:

„ in distributed applications, see “Specifying the HMI server’s startup


and shutdown components” on page 5-26.

„ in stand-alone applications, see “Specifying the HMI server’s


startup and shutdown components” on page 6-10.

Example: Updating trend data in the background

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 trend data into the
data buffer. This updates the trend while it is not visible.

19–64 ■ RSView Supervisory Edition User’s Guide


Trend data remains in the cache until you use the FlushCache
command or until you stop running your application.

2. When you want the real-time trend to become visible, issue the
following command:

Display Trend1

Trend1 will appear in the graphic display and will contain data.

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 scale of values for the pen.

The y-axis legend shows the


minimum and maximum
scale for a pen …

… when you click the pen


line in the line legend.

Setting up trends ■ 19–65


Changing the trend properties

To open the Trend Properties dialog box

X Right-click the trend chart, and then click Chart properties.

The Trend Properties dialog box opens. The dialog box shows only
the tabs for which check boxes are selected in the Runtime tab. The
Runtime tab is not accessible at run time.

To open the Graph title dialog box

The graph title window allows you to change the name of the trend
chart at run time.

1. In the trend chart display at run time, double-click the trend title.
The Graph title dialog box opens.

2. Type a name for the trend chart, and then click OK.

To open the Y-Axis tab

1. In the trend chart display at run time, double-click the y-axis


legend. The Y-Axis tab opens.

2. Change the settings for the Y-Axis tab, and then click OK.

For information about the options on the Y-Axis tab, see “Setting up
the vertical axis (y-axis)” on page 19-45.

To open the X-Axis tab

1. In the trend chart display at run time, double-click the x-axis


legend. The X-Axis tab opens.

2. Change the settings for the X-Axis tab, and then click OK.

For information about the options on the X-Axis tab, see “Setting up
the horizontal axis (x-axis)” on page 19-43.

19–66 ■ RSView Supervisory Edition User’s Guide


To open the Pens tab

1. In the trend chart display at run time, double-click the line legend.
The Pens tab opens.

2. Change the settings for the Pens tab, and then click OK.

For information about the options on the Pens tab, see “Adding pens
to the trend” on page 19-29.

Using scrolling options at run time


You can create buttons and graphic objects with which to view a trend’s
data, or you can use the trend buttons in the Trends graphic library. For
information about the graphic library, see “Using the Trend graphic
library” on page 19-63.

A set of VCR-style buttons are included with the trend. These buttons
allow the operator to view different areas of charted data. To show the
VCR-style buttons at run time, in the Display tab, click Display
scrolling mechanism.

Oldest data Backward 1 Backward ½ Pause Forward ½ Forward 1 Most


time span time span time span time span current
data

Setting up trends ■ 19–67


Using the value bar at run time
The value bar marks the value of each pen at the position you select on
the trend chart.

The value bar

To show the value bar, click the trend where you want the value bar to
appear.

To hide the value bar at run time

X Do one of the following:

„ Click the vertical axis.


„ Right-click the trend chart, and then click Show Value bar. A
check mark means the value bar appears on the trend chart, and
no check mark means the value bar is hidden from the trend
chart.
The value bar changes color automatically so that it is visible for all
background colors. For example, if the trend background color is black,
the value bar color will be white. If the trend background color is white,
the value bar will be black.

19–68 ■ RSView Supervisory Edition User’s Guide


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 pen at the exact time stamp of the value bar. The value displayed is
based on the nearest available reading.

Using the delta value bar at run time


The delta value bar works with the value bar to show the difference in
value between two x-axis points for Standard and XY Plot chart types.

The value of the data point


at the Value bar’s position

The difference between


the value bar’s data point
and the delta value bar’s
data point.

The delta value bar

To show the delta value bar at run time

1. At run time, right-click the trend chart to open the context menu,
point to Active value bar, and then click Value.

2. Click the trend where you want the value bar to appear.

Setting up trends ■ 19–69


3. Open the context menu, point to Active value bar, and then click
Delta.

4. Click the trend where you want to see the difference between the
value at the Value bar’s data point and the value at the Delta Value
bar’s data point.

To move the delta value bar at run time

1. Right-click the trend to open the context menu, point to Active


value bar, and then click Delta.

2. Click the trend chart at the position on the trend where you want
to know the difference between the value indicated by the Value
bar and the value indicated by the Delta value bar.

To remove the delta value bar at run time

1. Right-click the trend to open the context menu, and then click
Show value bar.

2. Both the value bar and the delta value bar are removed from the
trend.

3. Open the context menu, and then click Show value bar again. The
value bar reappears but the delta value bar does not.

Using zoom at run time


Use zoom to view a selected area of the trend chart in more detail.

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 the chart to zoom into the selected area.

19–70 ■ RSView Supervisory Edition User’s Guide


To restore the original view of the trend chart, right-click the chart, and
then click Undo Zoom/Pan.

Using pan at run time


Use pan to view areas of the trend chart that are outside the area of the
chart you are viewing.

To pan the trend chart at run time

1. At run time, pause the trend chart. You can:


„ Click the pause button, located at the bottom of the trend with
the other VCR buttons.
„ Right-click the trend chart, and then click Scroll to uncheck the
Scroll option.
2. Once the trend chart is paused, you can pan to the area of the
trend chart you want to view. You can:

„ Left-click and drag the y-axis legend to pan vertically.


„ Left-click and drag the x-axis legend to pan horizontally.

To restore the original view of the trend chart

X At run time, right-click the chart, and then select Undo Zoom/Pan.

Using the arrow keys at run time


You can use the arrow keys on the keyboard to perform some of the
same functions as the mouse and VCR-style buttons at run time.
Press and hold And then press
this key this arrow key To do this

(none) Left Move back half a time span


(none) Right Move forward half a time span

Setting up trends ■ 19–71


Press and hold And then press
this key this arrow key To do this

(none) Up Pan up 10%


(none) Down Pan down 10%
Shift Left Move back a full time span
Shift Right Move forward a full time span
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 up or down 10%
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 at run time


To print the trend chart, right-click the trend, and then click Print
Trend on the context 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 in the Overlays tab. For more information
about snapshots and overlays, see “Setting up snapshots and overlays”
on page 19-51.

To align an overlay to the left of the trend chart at run time

X At run time, right-click the trend chart, point to Overlays, Align


Left, and then click the name of the Overlay you want to align to
the left of the trend chart.

19–72 ■ RSView Supervisory Edition User’s Guide


To relocate an overlay at run time

X At run time, right-click the trend chart, point to Overlays, Relocate,


and then click the name of the Overlay you want to relocate.

To show or hide an overlay at run time

X At run time, right-click the trend chart, point to Overlays, Show/


Hide, and then click the name of the Overlay you want to show or
hide.

A check mark beside the overlay name means it is showing on the


trend chart. No check mark beside the overlay name means it is
hidden on the trend chart.

To open the Overlays tab at run time

X At run time, right-click the trend chart, point to Overlays, and then
click Properties.

The Overlays tab opens.

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 Diagnostics List. For information about
setting up FactoryTalk Diagnostics, see Chapter 12, Logging system
activity.

To view information in the Diagnostics List

X In RSView Studio, click the Tools menu, and then click Diagnostics
Viewer.

For information about troubleshooting common trend problems, see


Help.

Setting up trends ■ 19–73


20
Chapter

Creating expressions
This chapter includes

„ instructions for creating expressions.

„ descriptions 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.

„ tag placeholders.

„ constants.

„ mathematical, relational, logical, and bitwise operators.

„ built-in functions.

„ if–then–else logic.

Creating expressions ■ 20–1


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 box. In some
editors, you will also find:

„ expression buttons.

„ an expression column.

20–2 ■ RSView Supervisory Edition User’s Guide


The following illustration shows the items for creating an expression in
the Events editor.

Expression box

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 ■ 20–3


Using the Check Syntax button
Click the Check Syntax button to verify that the expression you typed
uses correct syntax. You can check the syntax of your expression at any
time while the Derived Tags editor is open.

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.

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

20–4 ■ RSView Supervisory Edition User’s Guide


To paste expressions in a window

1. Click where you want to paste the expression.

You can paste into the Expression box in the form or into the
Expression column in the spreadsheet.

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

2. Press Ctrl-X or Ctrl-C.

To paste expressions in a dialog box

1. Click in the Expression box 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 ■ 20–5


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 Tag Browser.

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.

This wildcard 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 8, Working with tags.

20–6 ■ RSView Supervisory Edition User’s Guide


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 8-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 16,
Creating graphic displays.

Constants
A constant can have any of the following formats:

„ integer (123).

„ floating point (123.45).

„ scientific notation (1.2345E² ).

„ string constant (“character string”).

„ the string ‘pi’ (to represent the symbol π). RSView replaces the
string with its numeric value.

Creating expressions ■ 20–7


Arithmetic operators
Arithmetic operators calculate values based on two or more numeric
values. The arithmetic operators are:

Symbol Operator Example


(For these examples, 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
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.

20–8 ■ RSView Supervisory Edition User’s Guide


String operands
The + operator can be used to join string operands. For example, the
expression “hello” + “world” returns: helloworld.

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† String examples‡

† For the numeric examples, tag1=5 and tag2=7


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

Creating expressions ■ 20–9


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 to the (tag1<tag2) AND (tag1==5)
right and to the left of the operator both statements are true; returns a 1
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 the NOT (tag1<tag2)
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 20-21.

Bitwise operators
Bitwise operators examine and manipulate individual bits within a
value.

IMPORTANT These operators are for integers only, not floating point
numbers.

20–10 ■ RSView Supervisory Edition User’s Guide


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.
<< shift left 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, toggles the bits within an
integer or tag.

Reverses every bit within the number so every 1 bit becomes a 0


and vice versa.

Creating expressions ■ 20–11


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)

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.

20–12 ■ RSView Supervisory Edition User’s Guide


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

ALM_IN_ALARM(tag*) If examining multiple tags, 1 (true) if one or


more of the tags or alarm events are in
alarm.
ALM_ACK(tag) 1 (true) if the tag or alarm event’s alarm has
or been 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.
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
or 1 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.

Creating expressions ■ 20–13


This function Returns

ALM_LEVEL(tag) The alarm level or threshold for an analog


or tag: a 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

ALM_SUPPRESS(tag*) If examining multiple tags, 1 (true) if one or


more of the tags’ alarms are suppressed.
ALM_FAULT(tag) 1 (true) if there has been an alarm fault for
or the 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.
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 single character.


* Matches any number of characters, including the
backslash (\) character.

20–14 ■ RSView Supervisory Edition User’s Guide


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.

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.

Creating expressions ■ 20–15


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]

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. If Aug 21 2000 is


not a Monday, this error is not detected.

20–16 ■ RSView Supervisory Edition User’s Guide


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

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)

Creating expressions ■ 20–17


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.

_____________________________

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

20–18 ■ 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(“C:\Documents and Settings\


file exists 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,
drive up to a 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
LOG10 (expression) The base ten log of the expression

Creating expressions ■ 20–19


This function Returns this value

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.

20–20 ■ RSView Supervisory Edition User’s Guide


Evaluation order of operators
Expressions with more than one operator are evaluated as follows:

„ 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 ■ 20–21


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

_____________________________

20–22 ■ 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.

IMPORTANT Do not confuse the If–then–else expression with the If


command. For details about the If command, see
Appendix A, RSView commands.

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 ■ 20–23


The if–then–else structure is illustrated below.

enter

true
statement

false

value2 value1

exit

20–24 ■ 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

false

value3 value2 value1

exit

Creating expressions ■ 20–25


Example 2: Nested if–then–else
This expression:

if (statement1) then
if (statement2) then (value1)
else (value2)
else (value3)

has this interpretation:

enter

true statement2 true value1


statement1

false false

value3 value2

exit

20–26 ■ RSView Supervisory Edition User’s Guide


21
Chapter

Creating
embedded variables
This chapter describes:

„ the types of embedded variables.

„ where you can create embedded variables.

„ using tag names and tag placeholders in embedded variables.

„ creating embedded variables.

„ cutting, copying, and pasting embedded variables.

„ editing and deleting embedded variables.

„ how embedded variables are updated at run time.

„ how embedded variables are displayed at run time.

About embedded variables

Embedded variables allow you to display values that change


dynamically at run time. You can use embedded variables in the text
captions on graphic objects, and in message text. You can use multiple
embedded variables in the same caption or message.

For example, you could embed a tag value and the time variable in a
local message. At run time when the local message is displayed, it is
updated to reflect the tag’s current value as the value changes. The time
is also updated as the time changes.

Creating embedded variables ■ 21–1


Embedded variables can consist of:

„ numeric (analog or digital) tags.

„ string tags.

„ tag placeholders. For information about tag placeholders, see


page 16-51.

„ the time.

„ the date.

The Objects sample application contains examples of embedded


variables.

Where you can create embedded variables

You can create embedded variables in these editors:

„ Graphic Displays—Use this editor to insert embedded variables in


the captions for graphic objects. For graphic objects with multiple
states, you can insert different embedded variables in each state’s
caption.

For information about specific graphic objects, see Chapter 17,


Setting up graphic objects.

„ Local Messages—Use this editor to insert embedded variables in


local messages.

For information about local messages, see page 17-231.

Creating embedded variables

Embedded variables are case sensitive, and must use the proper syntax
to work. Otherwise, the embedded variable is treated as a piece of text.
Therefore, we do not recommend creating and editing embedded

21–2 ■ RSView Supervisory Edition User’s Guide


variables manually. Instead, use the Insert Variable and Edit variable
dialog boxes.

For information about editing embedded variables, see page 21-9.

To create an embedded variable in the caption


of a graphic object

1. Open the graphic object’s Properties dialog box.

2. Click the tab containing the Caption box (the General tab or the
States tab, depending on the type of object).

3. Click Insert Variable.

4. Click the type of variable to insert.

5. Fill in the options in the dialog box that opens, as described in the
following sections.

To create an embedded variable in a message

1. In the Local Messages editor, right click the Message column, and
then click Edit String.

2. Click Insert Variable.

3. Click the type of variable to insert.

4. Fill in the options in the dialog box that opens, as described in the
following sections.

Creating embedded variables ■ 21–3


Creating numeric embedded variables
1. Do one of the following:
„ In a graphic object’s Properties dialog box, click Insert Variable,
and then click Numeric.
„ In a Message column, right-click, click Edit String, click Insert
Variable, and then click Numeric.
2. Fill in the fields as follows.

Tag Type the name of an analog or digital tag, or type a tag


placeholder.

To open the Tag Browser and select a tag, click the Browse button.

Number of digits Select the maximum number of digits to display,


Browse button
up to 17 digits. The decimal point and minus sign each count as a
digit.

Decimal places Select the number of digits to appear after the


decimal point.

Fill left with Select a character to fill the left of the display with if
the value at the data source contains fewer than the maximum
number of digits. If you don’t want to use a fill character, select
None.

3. Click OK.

21–4 ■ RSView Supervisory Edition User’s Guide


Example: Syntax for numeric embedded variables
Numeric embedded variables use this syntax:

/*N:# Tag_name Fill_character DP:#*/

where

„ N indicates that it is a numeric embedded variable.

„ # indicates the number of digits.

„ Tag_name is the tag to display; you can also type a tag placeholder
here.

„ Fill_character is the fill character: NOFILL, ZEROFILL, or


SPACEFILL.

„ # indicates the number of decimal places.

To display the current value of an analog tag called Oven_temp, with 3


digits, no decimal places, and no fill character, you would type this:

/*N:3 Oven_temp NOFILL DP:0*/

Creating string embedded variables


1. Do one of the following:
„ In a graphic object’s Properties dialog box, click Insert Variable,
and then click String.
„ In a Message column, right-click, click Edit String, click Insert
Variable, and then click String.

Creating embedded variables ■ 21–5


2. Fill in the fields as follows.

Tag Type the name of a string tag, or type a tag placeholder.

To open the Tag Browser and select a tag, click the Browse button.

Browse button Fixed number of characters Select this check box if you want the
variable always to display the same number of characters, and then
select the number of characters to be displayed, up to 255.

If this check box is cleared, the length of the embedded variable


changes to accommodate the length of the string tag’s value.

3. Click OK.

Example: Syntax for string embedded variables

String embedded variables use this syntax:

/*S:# Tag_name*/

where

„ S indicates that it is a string embedded variable.

„ # indicates the number of digits if you select a fixed number of


digits; type 0 if you don’t want to use a fixed number.

„ Tag_name is the tag to display; you can also type a tag placeholder
here.

21–6 ■ RSView Supervisory Edition User’s Guide


To display the current value of a string tag called Blower_status, with a
fixed length of 20 characters, you would type this:

/*S:20 Blower_status*/

Creating time and date embedded variables


1. Do one of the following:

„ In a graphic object’s Properties dialog box, click Insert Variable,


and then click Time/Date.
„ Right-click a Message column, click Edit String, click Insert
Variable, and then click Time/Date.
2. Select the time and date format for the embedded variable. The
options also include time only and date only.

3. Click OK.

Creating embedded variables ■ 21–7


Example: Syntax for time and date embedded variables
Time and date embedded variables use this syntax:

/*Time_date_format*/

where

Time_date_format uses one of these character sequences:


These characters Specify this format

SD Short date
LD Long date
SDT Short date and time
LDT Long date and time
T Time
TSD Time and short date
TLD Time and long date

To display the time followed by the short date, you would type this:

/*TSD*/

A space is placed between the time and date when the embedded
variable is displayed at run time.

21–8 ■ RSView Supervisory Edition User’s Guide


Cutting, copying, and pasting embedded variables
You can cut, copy, or paste an embedded variable between objects and
editors.
To do this Do this And then press this

Cut Select the text Ctrl-X


Copy Select the text Ctrl-C
Paste Double-click in the Message Ctrl-V
column, or click in the Caption
box, and then position the cursor
where you want the text.

Editing embedded variables


1. In the Caption box or String Edit dialog box, double-click the
embedded variable, or right-click the variable, and then click Edit
Variable.

2. Make the changes in the dialog box that opens.

3. Click OK.

Deleting embedded variables


X Click the embedded variable to select it, and then press Delete.

Creating embedded variables ■ 21–9


How embedded variables are updated at run time
At run time, this is how embedded variables are displayed and updated:

„ Graphic objects—When a display containing a graphic object that


uses an embedded variable is open, the value of the embedded
variable is updated whenever a new tag value is read from the data
source. For time and date embedded variables, the time and date are
updated as the system time and date change.

„ Local messages—When a display containing a local message


display object is open, and the message the object is displaying
contains an embedded variable, the value of the embedded variable
is updated whenever a new tag value is read from the data source.
For time and date embedded variables, the time and date are
updated as the system time and date change.

How embedded variables are displayed at run time


If there is no valid data available for the embedded variable, the variable
is replaced with question marks (?). This could occur when a display
first opens and the data has not arrived yet, or when there is a problem
that prevents communication with the data source.

Numeric embedded variables


The value shown for a numeric embedded variable depends on
whether the tag value is a floating-point number or an integer. Integer
values are displayed as is. Floating-point values are rounded to fit the
specified number of digits for the variable.

For example, if the variable is set up to show 6 digits, 1234.56 is


rounded to 1234.6. The value 1234.44 is rounded to 1234.4. The
decimal counts as one of the digits.

If the tag value, including the decimal point and minus sign, contains
more digits than specified for the variable, the numeric variable is
replaced with asterisks (*).

21–10 ■ RSView Supervisory Edition User’s Guide


Number formats

The numeric variable uses the number format you set up on the run-
time computer. For example, if the run-time computer is set up to use
a comma for the decimal symbol, the numeric variable uses a comma
for the decimal symbol.

String embedded variables

For string embedded variables that do not use a fixed number of


characters, the entire string tag value is displayed, unless a null character
is read. Nothing after a null character is displayed.

If a fixed number of characters is used, the variable displays the value


of the tag up to the number of characters specified, unless a null
character is encountered before the specified length. Nothing after a
null character is displayed. If necessary, spaces are used to make up the
required number of characters.

Null characters have a hex value of 0. The null character indicates the
end of string input. It does not add to the actual string length.

Time and date embedded variables

For embedded variables that show both the time and the date, a space
is placed between the time and date when the embedded variable is
displayed at run time.

Time and date formats

Time and date embedded variables use the time and date formats you
set up on the run-time computer. For example, if you specify the short
date format, at run time the display uses the short date format that the
run-time computer uses.

Creating embedded variables ■ 21–11


22
Chapter

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.

„ close any open windows.

„ set tag values.

Creating macros

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.

Creating macros ■ 22–1


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$ runs, 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.
For information about parameters, see “Using parameters” on
page 22-4. For 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
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.

22–2 ■ RSView Supervisory Edition User’s Guide


Running macros

At run time, operators can run a macro anywhere they can run an
RSView command. Ensure you include a way for operators to run
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.

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

Creating macros ■ 22–3


state. In this example, the home area is the area in which the macro is
run.

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:

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.

22–4 ■ RSView Supervisory Edition User’s Guide


Typing macro names that contain spaces
If the name of a macro contains spaces, enclose the name in quotation
marks when typing the macro name.

If the macro contains parameters, place the parameters outside the


quotation marks.

Example: Macro name with spaces and parameters


To run a macro called Factory Display from the command line, type:

“Factory Display” %1

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.

Creating macros ■ 22–5


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 Components tab of the HMI Server Properties dialog box.

For details about specifying the startup macro in distributed


applications, see page 5-28.

For details about specifying the startup macro in stand-alone


applications, see page 6-12.

22–6 ■ RSView Supervisory Edition User’s Guide


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

„ management summary displays.

„ trend displays of historical and real-time data.

Setting up navigation ■ 23–1


The following illustration shows a display hierarchy:

Main Menu
Graphic Display

Process-Wide Area 1 Area 2 Management


Alarm Summary Process Process 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.

23–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.
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 types.

Setting up navigation ■ 23–3


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 16-60.

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 16-62.

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.

23–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 18, Animating graphic objects. Client keys

Setting up navigation ■ 23–5


are created in the Client keys editor. For details, see “Creating client
keys” on page 23-12.

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
page 17-37.

23–6 ■ RSView Supervisory Edition User’s Guide


Using keys

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.

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 18-46


specific graphic object animation in the
(object key) Graphic Displays editor
Associate a key with a Attach display key page 18-60
specific graphic display animation in the
(display key) Graphic Displays editor
Create a key that works Create a key definition page 23-12
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.

Setting up navigation ■ 23–7


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

23–8 ■ RSView Supervisory Edition User’s Guide


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.

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.

Setting up navigation ■ 23–9


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

23–10 ■ RSView Supervisory Edition User’s Guide


This reserved key Does this

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

Setting up navigation ■ 23–11


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.

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.

23–12 ■ RSView Supervisory Edition User’s Guide


„ Right-click the Client keys icon and then click New.

3. Click Add.

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.

Setting up navigation ■ 23–13


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 wizard to
Browse button 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.

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.

23–14 ■ RSView Supervisory Edition User’s Guide


To start running a client key component

X 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>

where <component> is the name of the client key component

To stop running a client key component

X At the command line or in a macro, type:

Key /R

where /R removes the key definition

For a complete list of RSView commands and command syntax, see


Appendix A, RSView commands, or see Help.

Setting up navigation ■ 23–15


24
Chapter

Using the
SE Client object model
and display code
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.

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.

Using the SE Client object model and display code ■ 24–1


Sending custom messages to the Diagnostics log file Send
specific messages to the Diagnostics List and Diagnostics 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 24-13.

Opening the IDE window

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.

24–2 ■ RSView Supervisory Edition User’s Guide


„ 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 context 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 context menu. The code window opens in the context of
the object you right-clicked.

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

Using the SE Client object model and display code ■ 24–3


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.

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.

24–4 ■ RSView Supervisory Edition User’s Guide


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 16, 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 24-13.

How VBA code runs


The VBA procedures you create are called in response to a display’s
events. A graphic display’s events are triggered when you open the
display at run time. Procedures that respond to the events are executed
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.

Using the SE Client object model and display code ■ 24–5


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.

VBA can 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.

BackspaceButton Represents the RSView backspace button object.


This object works like the Backspace key on a keyboard.

BarGraph Represents the RSView bar graph object.

Button Represents the RSView button object.

ControlListSelector Represents the RSView control list selector


object.

Display Represents a graphic display.

DisplayListSelector Represents the RSView display list selector


object.

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

24–6 ■ RSView Supervisory Edition User’s Guide


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.

EndButton Represents the RSView end button object. This object


works like the End key on a keyboard.

EnterButton Represents the RSView enter button object. This object


works like the Enter key on a keyboard.

Freehand Represents the RSView freehand object.

Gauge Represents the RSView gauge 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.

HomeButton Represents the RSView home button object. This


object works like the Home key on a keyboard.

Image Represents the RSView image object.

InterlockedPushButton Represents the RSView interlocked push


button object.

LatchedPushButton Represents the RSView latched push button


object.

Line Represents the RSView line object.

ListIndicator Represents the RSView list indicator object.

Using the SE Client object model and display code ■ 24–7


LocalMessageDisplay Represents the RSView local message display
object.

MaintainedPushButton Represents the RSView maintained push


button object.

MomentaryPushButton Represents the RSView momentary push


button object.

MoveDownButton Represents the RSView move down button


object. This object works like the down arrow key on a keyboard.

MoveLeftButton Represents the RSView move left button object.


This object works like the left arrow key on a keyboard.

MoveRightButton Represents the RSView move right button object.


This object works like the right arrow key on a keyboard.

MoveUpButton Represents the RSView move up button object. This


object works like the up arrow key on a keyboard.

MultistateIndicator Represents the RSView multistate indicator


object.

MultistatePushButton Represents the RSView multistate push


button object.

NumericDisplay Represents the RSView numeric display object.

NumericInput Represents the RSView numeric input object.

PageDownButton Represents the RSView page down button object.


This object works like the Page Down key on a keyboard.

PageUpButton Represents the RSView page up button object. This


object works like the Page Up key on a keyboard.

Panel Represents the RSView panel object.

Picture Represents the RSView bitmap object.


PilotCtrlListSelector Represents the RSView piloted control list
selector object.

24–8 ■ RSView Supervisory Edition User’s Guide


Polygon Represents the RSView polygon object.

Polyline Represents the RSView polyline object.

PolyPolygon Represents the RSView polypolygon object.

RampPushButton Represents the RSView ramp push button object.

Recipe Represents the RSView Recipe object.

RoundedRectangle Represents the RSView rounded rectangle


object. Use the polygon object to represent rectangles.

Scale Represents the RSView scale object. Use this object with bar
graphs.

StringDisplay Represents the RSView string display object.

StringInput Represents the RSView string input object.

Symbol Represents the RSView symbol indicator object.

StringList Represents a collection of unique strings.

Tag Represents the FactoryTalk tag object. Use the Tag object to
provide runtime information for a tag, or to set the value of a tag.

TagGroup Contains a collection of Tag objects.

TagLabel Represents the RSView tag label object.

Text Represents the RSView Text object.

TimeDateDisplay Represents the RSView time and date display


object.

Wedge Represents the RSView wedge object.

Using the SE Client object model and display code ■ 24–9


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 context menu

„ on the View menu, click Object Browser

„ press F2

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.

24–10 ■ RSView Supervisory Edition User’s Guide


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

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.

Using the SE Client object model and display code ■ 24–11


Opening Help from the RSView Help Contents
window
1. On the RSView menu bar, click Help and then click Contents.

2. In the Contents list, double-click Creating Graphic Displays.

3. In the list of topics, do one of the following:


„ For a list of overview topics, double-click Creating VBA
Display Code.
„ For details about the objects, double-click Using the RSView
SE Client Object Model.

Help topics for VBA code and the RSView SE Client Object Model
open in a separate window, on top of the RSView Help window.
To return to the RSView Help window, close the SE Client Object
Model Help window.

24–12 ■ RSView Supervisory Edition User’s Guide


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 Microsoft Visual Basic Help.

„ 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

Using the SE Client object model and display code ■ 24–13


25
Chapter

Setting up redundancy
A redundant system is a back-up system that duplicates the function of
a device. This means that redundant components are alternate
components that can be used when primary components fail. For HMI
systems, redundancy provides a means of ensuring system availability.

This chapter includes information about how to protect against


software failures by taking advantage of redundancy features built into
RSView Supervisory Edition. These features minimize operation
disruptions and data loss when system failures occur.

Specifically, this chapter addresses the following topics:

„ HMI redundancy as part of a complete strategy

„ Protecting against software failures

„ Considering redundancy options

„ Planning a redundant system layout

„ Scenarios that explain how redundancy works

„ Configuring a redundant RSView Supervisory Edition system

„ Licensing in a redundant system

Setting up redundancy ■ 25–1


HMI redundancy as part of a complete strategy
The level of availability in your system—none, some, and complete—
when hardware or software fails increases with the number of
redundant system components. To increase the level of system
availability, consider these system components:

„ To protect against PLC failures, use redundant programmable


logic controllers (PLCs). For example, Rockwell Automation’s
ControlLogix platform allows transferring control from a primary
PLC to a redundant PLC when a failure occurs.

„ To protect against PLC network failures,install redundant PLC


networks, for example, use Rockwell Automation’s ControlNet
network.

„ To protect against information network failures,install a


redundant Ethernet network with a backup domain controller,
network cables, and network interface cards (NICs).

RSView Supervisory Edition requires a reliable information


network to allow RSView Supervisory Edition components to
communicate across a distributed application. In addition, RSView
Supervisory Edition requires a domain controller to authenticate
users who log into the system. If the domain controller fails while a
user is logged in, cached credentials allow that user to continue
working without interruption. The last ten users that logged into
the Windows domain from a computer can log in again from the
same computer, using cached credentials, while the domain
controller is unavailable. However, a domain controller must be
available for new users to log in and to allow the RSView
Supervisory Edition Signature Control to authenticate users on
demand. For information about configuring redundant domain
controllers, consult Microsoft documentation or your Information
Technology department.

„ To protect against host computer hardware failures, provide


backup computers to host application software such as RSView
Supervisory Edition.

25–2 ■ RSView Supervisory Edition User’s Guide


„ To protect against software failures, set up redundant RSView,
FactoryTalk, and RSLinx application servers.

This chapter includes information about protecting your supervisory-


level HMI system against software failures by taking advantage of
redundancy features built into RSView Supervisory Edition. This
chapter does not describe how to protect your control system, your
information network, hardware, or operating system and other
supporting software.

Protecting against software failures

A distributed HMI system includes both client components and server


components.

The client components provide the interface used by the human


operators of the system, typically via graphic displays that are updated
dynamically. These graphic displays depict the current state of the
manufacturing system and allow operators to monitor and control its
operation.

The dynamic information in these graphic displays, including animated


pictures, alarm summaries, updating tag values, and real-time and
historical trends, is provided by the server components in the HMI
system. Servers also log historical data and perform other behind-the-
scenes monitoring and control functions.

For operators to maintain continuous visualization and control of their


manufacturing system, the server components must provide a
continuous flow of information to the client components. This is why
software redundancy is so important. To help ensure that loss of
monitoring and control functions remain minimized, even during
server disruptions, RSView Supervisory Edition provides built-in
redundancy features, including:

„ In the worst case scenario, clients detect loss of communications


with the primary server within 5 seconds, and then switch over to
backup servers in fewer than 30 seconds. Typically, clients detect

Setting up redundancy ■ 25–3


that a server has failed in fewer than 5 seconds and fail over
(connect to a secondary HMI server) in fewer than 5 seconds. This
means that, depending on the application they are connected to,
clients might not see any interruption in the operation of their
application.

„ Redundant capabilities provided by RSView Supervisory Edition


and FactoryTalk are completely automatic and transparent to
clients. During server failure detection and switch-over, operators
need not take any action or restart client software to continue using
the system.

„ During the failover process, operators can continue to interact with


servers that are still online. Display fields that show data from the
failed server show a wire-frame view, so that operators do not rely
on tag values that might be incorrect.

„ Once the system switches to backup servers, clients continue


functioning normally.

„ When the primary server becomes available again, the system can
automatically switch back to it.

„ An RSView Supervisory Edition system includes three types of


servers, and each of these types can be made redundant through
standard configuration options.

„ FactoryTalk Directory. FactoryTalk Directory is a shared


software component that works like an electronic address
book, allowing parts of an application to find each other on a
computer or across a network. All of the computers
participating in a distributed application must share the same
FactoryTalk Directory.

„ RSView SE Servers. RSView SE Servers, also sometimes called


HMI servers, store HMI components, such as graphic displays,
and serve these components to clients. RSView SE Servers also
store tag databases, detect alarms, and log historical data. A

25–4 ■ RSView Supervisory Edition User’s Guide


single computer can host up to five RSView SE Servers.
A single application can include up to 10 RSView SE Servers.
„ Data Servers. Data servers, such as RSLinx, allow clients to
access information in programmable controllers, in other
hardware devices, and from other data servers that comply with
the OPC-DA (OLE for Process Control—Data Access) 2.0
specification. A single application can include up to 25 data
servers.

Considering redundancy options


All three types of servers associated with an RSView Supervisory
Edition system can be hosted on the same, or on different, computers
on the network, allowing for many different ways of configuring
redundant systems.

Redundant FactoryTalk Directory computers


If FactoryTalk Directory becomes unavailable while an application is
running, the application continues to operate normally, and continues
reading and writing tag values, acknowledging alarms, opening and
closing displays, and so on—even if redundancy is not set up and a
backup (also called secondary) FactoryTalk Directory is not available

Setting up redundancy ■ 25–5


on the network. This is because a copy of the FactoryTalk Directory
information is cached locally on each computer connected to it, as a
result of which the client computer can continue to resolve tag
addresses. However, while the FactoryTalk Directory is unavailable, an
application’s structure cannot be modified: for example, operators
cannot add or remove areas, data servers, or RSView SE Servers.

To allow modifying an application’s structure even if the computer


running FactoryTalk Directory becomes unavailable, set up a
redundant copy of FactoryTalk Directory on a different computer.
Since each computer in a distributed application needs to know where
the network-wide FactoryTalk Directory is located, set up all
computers to use the same primary FactoryTalk Directory computer.
A single backup computer on the network could host a secondary
FactoryTalk Directory for the entire system. With redundancy set up,
if the primary FactoryTalk Directory fails, the system automatically
switches all clients to the designated secondary computer. When the
primary FactoryTalk Directory comes back online, the system
automatically switches back to use it instead of the secondary
computer.

IMPORTANT If changes were made to the primary or secondary


FactoryTalk Directory, the changes must be copied
manually from one to the other, and then the computer
must be restarted. For details, see “Copying FactoryTalk
Directory files” on page 26-4.

Redundant RSView SE Servers


RSView SE Servers can be set up to fail over to a secondary server if
the primary server fails. When the primary server becomes available
again, it automatically reassumes responsibility for HMI server
activities. When setting up redundant RSView SE Servers, keep the
following points in mind.
Synchronizing alarms RSView SE Servers manage the
synchronization of alarms, so alarm states are kept synchronized

25–6 ■ RSView Supervisory Edition User’s Guide


between the primary and secondary servers. For example, if the
primary server has five unacknowledged alarms when failure occurs,
the secondary server will show the same five alarms as
unacknowledged when failover is complete. Alarm states are also kept
synchronized when the system switches back to the primary server.

While the primary RSView SE Server is active, the secondary server


runs the alarm monitoring system in a backup mode, so alarm states are
synchronized even if you have not set up the secondary server to start
alarm monitoring on demand.

This backup mode that runs on the secondary server does not detect
alarms; it only keeps alarm states synchronized.

When the system fails over to the secondary server, alarm monitoring
starts automatically on the secondary server if it was running on the
primary server. When the system fails back to the primary server, alarm
monitoring automatically starts on the primary server and stops on the
secondary server, if it was running on the secondary server.

For alarm states to synchronize properly, the clocks on the primary and
secondary RSView SE Servers must be kept synchronized to a time
server. If the clocks on the computers are not synchronized, multiple
alarms or inconsistent information could be displayed in an alarm
summary when failover occurs.

IMPORTANT If many tags are being monitored for alarms, it is


possible that alarms are missed for tags that go into and
out of alarm quickly during server fail-over or fail back.

Logging activity and alarm data We highly recommend that in any


distributed system you send activity and alarm information to a central
ODBC database, such as Microsoft SQL Server, for logging. These
system-wide logs can then be made secure and redundant through
database functionality. We also recommend configuring RSView
Supervisory Edition’s local activity and alarm logs to buffer
information in the event that communications with the ODBC
database are lost.

Setting up redundancy ■ 25–7


Even if your RSView SE Server is not set up with redundancy, we
recommend that you log activity and alarm information to an ODBC
database. Because activity log files are stored on every computer on
which system activity is generated, sending the alarm and activity log
files to an ODBC database provides you with one place on the network
to look for activity and alarm information when diagnosing problems.

When the primary server is active, the secondary server is loaded and
the project is loaded. However, components such as event detection,
alarm monitoring, and data logging do not have to be running unless
the secondary computer becomes active. This is user configurable. (See
“Startup type” on page 5-24.)
Synchronizing memory tag values, derived tags, and
data log files To keep these elements synchronized, runthe same
derived tag components and data log models on both primary and
secondary computers. Memory tags can be kept synchronized if their
values are the result of derived tags.
Managing events While events, triggered by an event detector, are
not specifically synchronized between primary and secondary RSView
SE Servers, it is possible to manage which server is responsible for
detecting and executing events, so that only one server is active at a
time. To handle the situation where an event is executing when a
primary RSView SE Server fails, issue the EventOn command (to start
event detection) only on an active HMI server, and always issue the
EventOff command (to stop event detection) on a standby server. To
do this automatically, you can issue these commands in the HMI
server’s On Active or On Standby macros.
Executing commands and macros If a primary HMI server fails
when a command or macro is executing, the execution stops during
failover to a secondary HMI server. To continue, re-issue the

25–8 ■ RSView Supervisory Edition User’s Guide


command or macro when the failover process finishes and the
secondary server becomes available.

IMPORTANT Because uptime during operation is crucial in a control


system, RSView Supervisory Edition provides
redundancy during runtime operations. However,
configuration changes are not synchronized
automatically.

As part of maintaining a redundant system, develop a planned


scheduled for copying project files from primary HMI servers to
secondary servers. Either copy project files manually, or duplicate the
project changes on each HMI server computer. As a planned activity,
this routine maintenance does not affect the operation of the system.

Redundant data servers


Primary data servers, such as RSLinx or any OPC-DA data server, can
be set up to fail over to backup servers when a primary server fails. As
part of configuring redundant data servers, specify whether, after a
failed primary server is repaired, the system should automatically
switch back to the primary server or continue using the secondary
server. This option allows you to avoid unnecessary interruptions in the
flow of data from servers to clients.

To minimize the time required to complete a failover, the system


creates OPC groups containing the necessary tags on both the primary
server and the secondary server. However, those groups and tags are
activated, or scanned, only by the active data server, so no additional
communication load is placed on PLCs by configuring a redundant
data server.

Setting up redundancy ■ 25–9


Planning the layout of a redundant system
Because all three types of servers involved in a distributed HMI system
are separate entities, they can be hosted on any computers on the
network. This allows for a great deal of flexibility in designing a
redundant architecture.

An application with a single HMI server


For example, in a system that contains only a single HMI server, with
a single line or process to control, the primary FactoryTalk Directory,
RSView SE Server, and RSLinx Server could all be hosted on the same
computer, with an identical backup computer hosting the secondary
servers.

25–10 ■ RSView Supervisory Edition User’s Guide


Or each of the primary and secondary servers could be installed on
separate computers, as shown below:

The configuration shown above is not always necessary. Depending on


your application’s size and computing needs, and your redundancy
needs, you might be able to install all three servers on a single pair of
redundant computers.

In particular, FactoryTalk Directory does not usually need to be


installed on its own hardware, because the FactoryTalk Directory
software is not computing intensive. We do recommend that you install
FactoryTalk Directory on a computer that is usually in a running state,
for example a computer hosting an RSView SE Server or RSLinx
Server.

IMPORTANT Installing FactoryTalk Directory on a computer acting as


a Windows domain controller is not recommended.

Setting up redundancy ■ 25–11


An application with two HMI servers
In an application that includes two HMI servers, with two lines or
processes to control, two computers could host all of the servers for
both lines; one hosting the primary server for line 1 and the secondary
server for line 2, and the other hosting the primary server for line 2 and
the secondary server for line 1.

An application with up to five HMI servers


Because RSView Supervisory Edition can host up to five RSView SE
Servers (each serving a different HMI project) on one computer, a
single computer can be the secondary server for more than one
primary RSView SE Server.

For example, in an application with five RSView SE Servers, one


computer could act as the secondary server for all five primary servers,
or for five RSView SE Servers and three data servers, or any other
combination.

This is advisable only if the secondary computer does not also perform
processor- or disk-intensive tasks like data logging, processing derived
tags, or detecting and triggering events. Because the HMI projects are
loaded into memory on a secondary computer as soon as it is set up to
be a secondary RSView SE Server, ensure that the secondary computer

25–12 ■ RSView Supervisory Edition User’s Guide


has enough RAM to host the total number of HMI projects that will
be loaded.

Because all parts of an RSView SE Station are always installed on the


same computer, RSView SE Station cannot be used in a redundant
configuration.

A distributed application that can run as a set


of stand-alone applications
Often the control network and the HMI network are separate—for
example, the control network could be ControlNet, and the HMI
network is usually Ethernet.

If you want your application to continue to run as a stand-alone


application if the HMI network goes down, install a ControlNet
network card and an Ethernet network card on the computer. Connect
the computer to both networks, and then set up the computer to host
the RSView SE Server, the RSView SE Client, the data server, and the
secondary FactoryTalk Directory.

Setting up redundancy ■ 25–13


If the HMI network fails, the application continues running on the
computer as a stand-alone application. This means that you cannot
access tags or alarms from other HMI servers but you can still update
tags or alarms from the local HMI server. Graphic displays, macros,
and client keys from other HMI servers are available only if they were
accessed before the HMI network failed, because these parts of an
application are cached automatically whenever they are accessed by
clients.

In this case, you cannot provide redundancy for HMI servers or data
servers because the redundant server would remain inaccessible if the
HMI network failed.

For best performance from your redundant system in the event of


failures other than those of the HMI network, we recommend setting
up redundancy for FactoryTalk Directory.

25–14 ■ RSView Supervisory Edition User’s Guide


To set up a distributed application to run as a set of stand-
alone applications

1. On each computer participating in the application, install the


RSView SE Client, the RSView SE Server, the data server, and the
FactoryTalk Directory software. All of these computers must be in
the same Windows domain.

2. On a separate computer in the same Windows domain, install only


the FactoryTalk Directory software. This computer will be the
primary FactoryTalk Directory.

3. Copy the configuration files from the primary FactoryTalk


Directory to all of the computers you set up in step 1. For details,
see “Copying FactoryTalk Directory files” on page 26-4.

4. On each of the computers you set up in step 1, do the following:

a. Run the utility called Select Shared Network FactoryTalk


Directory Location. Type the name of the primary FactoryTalk
Directory computer you set up in step 2.

b. Click the Configure Redundancy button to expand the dialog


box to include the redundancy options.

c. Select the check box, Provide FactoryTalk Directory


redundancy using a secondary location, and then click this
computer.

Scenarios that explain how redundancy works


To understand how redundancy affects the operation of the system,
consider some scenarios.

FactoryTalk Directory is down, and


redundancy is not set up for it
In this scenario, RSView SE Clients continue to function normally,
provided that the application was opened at least once before the

Setting up redundancy ■ 25–15


primary FactoryTalk Directory went down. If a client computer did not
open the application before the FactoryTalk Directory went down, the
application is not accessible to the RSView SE Client running on the
computer.

When a client computer opens the application, the information stored


by the FactoryTalk Directory is copied to the client computer, and
stored in a cache. Clients that have a cached copy of the FactoryTalk
Directory continue to see graphic displays and update tag values, even
if the displays and tags the client is accessing have not been accessed
before.

However, while FactoryTalk Directory is down, you cannot use


RSView Studio to modify the application’s structure, for example by
adding or removing areas, data servers, or HMI servers.

Primary FactoryTalk Directory goes down,


secondary becomes active

In this scenario, redundancy has been set up for FactoryTalk Directory.

When the primary FactoryTalk Directory computer goes down and the
secondary FactoryTalk Directory becomes active, all RSView SE
Clients, RSView Studio, and the RSView Administration Console can
continue to access the system normally. Graphic displays, tags, and
other components that are added to the system are immediately
accessible to all clients.

While one FactoryTalk Directory in the redundant pair is active, you


can continue to modify the application’s structure, for example by
adding or removing areas, data servers, or HMI servers.

When the system switches back to the primary FactoryTalk Directory,


all changes that were made to the application’s structure are not
automatically copied to the primary FactoryTalk Directory. You must
copy the changes manually, as described in “Copying FactoryTalk
Directory files” on page 26-4.

25–16 ■ RSView Supervisory Edition User’s Guide


You do not have to point the primary and secondary FactoryTalk
Directory computers at each other. Only clients need information
about where the primary and secondary FactoryTalk Directory
computers are located. Use the utility called Select Shared Network
FactoryTalk Directory Location to point clients at the primary and
secondary FactoryTalk Directory computers. However, if you have
clients running on the secondary FactoryTalk Directory, click This
computer in the Redundancy part of the Select Shared Network
FactoryTalk Directory Location dialog box.

One primary FactoryTalk Directory, multiple


secondary FactoryTalk Directory computers:
primary goes down

The network layout described in this scenario is a special case. It is


useful when you expect the HMI network to be unreliable, because it
allows you to maintain a reduced level of system operation if the HMI
network fails but the control network remains available, and every
client computer is connected to both networks.

Any computer connected to the application can be a secondary


FactoryTalk Directory, but a particular computer can only be set up to
have one primary and one secondary FactoryTalk Directory.

When the HMI network fails, every client computer continues running
as a stand-alone application on the network. Clients can continue to
open graphic displays and tags located on the same computer, but
cannot open graphic displays or tags located on other computers on the
network.

If you make changes to the application’s structure while the primary


FactoryTalk Directory computer is down, these changes will appear to
be lost when the primary FactoryTalk Directory becomes available.
You must copy the changes from the secondary FactoryTalk Directory
where they were made to the primary FactoryTalk Directory manually,
as described in “Copying FactoryTalk Directory files” on page 26-4.

Setting up redundancy ■ 25–17


Setting up a redundant RSView SE system
Redundancy options can be set up at any time in an RSView
Supervisory Edition system. No special redundancy programming is
required when developing RSView applications. Simply develop and
test an RSView application using RSView Studio, and then follow the
steps outlined below.

1. Install the necessary software on the backup computers set aside


for redundant operation.

For details about installing RSView Supervisory Edition software,


see the RSView Supervisory Edition Installation Guide.

2. Copy the FactoryTalk Directory application files to a backup


computer.

For details, see “Copying FactoryTalk Directory files” on page 26-4.

3. On each participating computer in the network, specify the name


of the FactoryTalk Directory backup computer.

For details, see “Setting up the FactoryTalk Directory server


computers” on page 4-9, and “Setting up the other computers on
the network” on page 4-13.

4. Copy RSView SE Server configuration files to a backup computer.

For details, see “Copying HMI server files” on page 26-4.

5. Copy the data server configuration files to a backup computer.

Each computer must host identical data server configuration


settings, including topics, networks, and other settings.

For details, see “Copying data server files” on page 26-12.

6. From RSView Studio, set up data server properties to specify the


name of the computer where the redundant data server is located.

For details, see “Setting up data server properties” on page 26-14.

25–18 ■ RSView Supervisory Edition User’s Guide


7. From RSView Studio, set up redundancy properties for RSView
SE Servers.

It is not necessary to set up server redundancy on RSView SE Client


computers—all RSView SE Server redundancy options are set up
only on the computers hosting RSView SE Servers.

For details, see “Setting up HMI server properties” on page 5-22.

Licensing in a redundant system

FactoryTalk Directory computers

The FactoryTalk Directory computer is part of the RSView


Supervisory Edition integrated architecture and does not require a
separate license.

RSView SE Servers

RSView SE Servers require licenses for the both primary servers and
the secondary servers. Floating licenses are not supported for RSView
SE Servers.

OPC Servers

OPC server licensing depends on the OPC server being used.RSLinx


requires a license for each instance that is running. However, RSLinx
for RSView is included with RSView SE Servers at no additional cost:
if you install RSLinx on the same computer as an RSView SE Server,
RSLinx uses the RSView Supervisory Edition license, which means you
don’t need to purchase additional RSLinx licenses. However, to set up
a redundant system using RSLinx Gateway, you must purchase two
RSLinx Gateway licenses.

Setting up redundancy ■ 25–19


RSView SE Clients
In a distributed system, you can use two licensing mechanisms for
RSView SE Clients: dedicated licenses and floating licenses. Dedicated
licenses are installed on the computer hosting the client, but floating
licenses are installed on the computer hosting FactoryTalk Directory.

FactoryTalk Directory does not hold licenses; rather, the computer on


which FactoryTalk Directory is running, does. As a result, FactoryTalk
Directory redundancy does not ensure redundant licenses. To ensure
that RSView SE Clients always have access to licenses, independent of
other computer failures, using dedicated licenses is recommended in a
redundant system.

However, should you decide to use floating licenses installed on the


FactoryTalk Directory computer, be aware of the following scenarios:

„ RSView SE Clients obtain their licenses from the primary computer


hosting FactoryTalk Directory services. If the primary computer is
not available, the clients will not be able to obtain licenses.

„ If the primary computer fails after RSView SE Clients have


obtained licenses, those clients continue to hold their licenses and
operate normally. Only licenses not currently used by clients will be
unavailable if the primary computer fails. When a client logs off,
however, its license is released. The client will not be able to obtain
another license until the FactoryTalk Directory computer becomes
available again.

25–20 ■ RSView Supervisory Edition User’s Guide


26
Chapter

Deploying
distributed 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 deploying an application.

There are several activities you must perform to deploy your


application.

This chapter describes how to:

„ set up the FactoryTalk Directory software.

„ set up the HMI servers in your application.

„ set up data servers.

„ set up and open RSView SE Clients.

Overview of deploying your distributed application


Use this list of activities as the basis for 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.

Deploying distributed applications ■ 26–1


To deploy your application, do the following:

„ Set up the FactoryTalk Directory software FactoryTalk


Directory is software that allows the parts of a distributed
application to find each other on the network.

To set up FactoryTalk Directory for a distributed application, you


must install the FactoryTalk Directory software on one of the
computers on your network, and then you must run the utility called
Specify FactoryTalk Directory Location on all the other computers
on your network.

Use the Specify FactoryTalk Directory Location utility to specify


the name of the computer on which the FactoryTalk Directory
software is running.

If you want to change the computer that is running the FactoryTalk


Directory software, you must also move the FactoryTalk Directory
files to the new computer. For details, see page 26-4.

„ Copy HMI server files If you are copying HMI servers from one
set of computers to another, you must copy the HMI servers’ files
as well. To copy the files, use Windows Explorer.

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

Specify the startup settings in the Components tab of the HMI


Server Properties dialog box for each HMI server.

„ Set up HMI server properties 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.

26–2 ■ RSView Supervisory Edition User’s Guide


„ Optionally, start or stop the HMI server’s components
manually. If you have set up a redundant HMI server, you can
start or stop its components as well. This is useful for testing,
troubleshooting, or making backup copies of the HMI server’s
project files.
„ Set up the data server properties If you have copied 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. Specify the application
that each RSView SE Client connects to, and the components the
RSView SE Client loads when it connects to the 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.

Deploying distributed applications ■ 26–3


Copying FactoryTalk Directory files
To copy the FactoryTalk Directory files from one computer to another:

1. Install the FactoryTalk Directory software on the new computer.


For details, see the RSView Supervisory Edition Installation Guide.

2. Copy the folder \Documents and Settings\All Users\


Application Data\Rockwell\RNAServer\Global from the source
computer to the target computer.

This folder contains the FactoryTalk files for distributed


applications.

By default, the Application Data folder is hidden. To see it, from the
Windows Explorer, click the Tools menu, select Folder Options,
and then click Show hidden files and folders.

3. Restart the computer on which FactoryTalk Directory is running.

Specifying the location of FactoryTalk Directory


For details about setting up FactoryTalk Directory, see Chapter 4,
Setting up FactoryTalk Directory.

Copying HMI server files


Before you copy an HMI server to a new location, make sure the
RSView SE Server software is installed, and the location of the
FactoryTalk Directory is set.

For information about setting up, or changing the location of the


FactoryTalk Directory, see Chapter 4, Setting up FactoryTalk Directory.

26–4 ■ RSView Supervisory Edition User’s Guide


Copying an HMI server that is not running
An HMI server that is in a running state is said to be loaded into
memory, or simply, ‘loaded’. The easiest way to copy an HMI server, is
to copy it when it is not loaded.

IMPORTANT The HMI server is automatically unloaded from


memory if RSView Studio, the RSView Administration
Console, and the RSView SE Client are not running, and
if the HMI server’s Startup type is set to On demand in
the HMI Server Properties dialog box.

If you are unsure whether or not the HMI server is


running, follow the steps in the next section.

To copy an HMI server that is not running

1. Copy the 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\

The HMI project folder has the same name as the HMI server in
the application, and contains the RSView SE Server's configuration
files.

2. Start RSView Studio, or the RSView 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 HMI server, and then click Properties to open the
HMI Server Properties dialog box.

Deploying distributed applications ■ 26–5


4. In the box, Computer hosting the server, type the name of the new
computer, or click the Browse button to select the name of the
Browse button new computer.

5. Click OK.

Copying an HMI server while it is running


You can make a copy of an HMI server while it is running, for example
to back up changes that were made while the server was online.

To do this, use the HMIBackup utility to copy the files from the source
computer to a temporary folder, and then copy the files from the
temporary folder to the target computer.

To copy an HMI server while it is running, complete four basic steps:

„ Download, and then install the HMIBackup utility.

„ Run the HMIBackup utility to back up the HMI server.

„ Copy the backup files to the target computer.

„ Update the HMI server properties with the name of the new
computer on which the HMI server is running.

To download and then install the HMIBackup utility

1. Download the HMIBackup utility from the Rockwell Software


Technical Support Knowledgebase.

For details, see “Finding the information you need” on page P-2 in
the preface to this manual.

2. Extract utility to the local drive of the computer where the HMI
server is located.

A folder called HMIBackup is created in the folder you specified,


and the HMIBackup tool is located in this folder.

26–6 ■ RSView Supervisory Edition User’s Guide


To run the HMIBackup utility

1. Click the Windows Start button, and then click Run.

2. In the Run window, type cmd and then press Enter.

3. Type cd c:\HMIBackup, where c is the letter of the drive to which


you extracted the HMIBackup utility.

4. For each HMI server located on the local computer that you want
to back up, run the following command from the Command
Prompt:

CopyHMI <server_project_name> [backup path name]

where:

<server_project_name> is the name of the HMI server project

[backup path name] is the optional path where the backup files will be
stored

For each HMI project you back up, a folder is created, with the same
name as the HMI project, inside the HMIBackup folder. The HMI
server’s backup files are copied to this folder.

To copy the backup files to the target computer

X Copy the backup HMI project folders to the following folder on the
target computer:

\Documents and Settings\All Users\Documents\


RSView Enterprise\SE\HMI Projects\

Deploying distributed applications ■ 26–7


To update the HMI server properties

1. Start RSView Studio, or the RSView 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.

2. Right-click the HMI server, and then click Properties to open the
HMI Server Properties dialog box.

3. In the box, Computer hosting the server, type the name of the new
computer, or click the Browse button to select the name of the
Browse button new computer.

4. Click OK.

Setting up HMI server properties

You can change an HMI server’s properties, including:

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


located. You can do this in distributed applications only.

„ specifying when the HMI server is loaded. You can do this in


distributed applications only.

„ specifying the name of a second computer that hosts a redundant


HMI server, for minimal disruption if the primary HMI server
fails.

„ starting or stopping components manually.

You can also use the HMI Server Properties dialog box to view the
HMI server’s name, project file path, number of existing graphic
displays or the maximum number of graphic displays allowed.

26–8 ■ RSView Supervisory Edition User’s Guide


If you have set up redundancy, the HMI Server Properties dialog box
also shows the status of primary and secondary HMI servers.

In distributed applications, you must set up the HMI server properties


separately for each HMI server in your application. For details, see
page 5-22.

Starting and stopping an HMI server’s


components manually
You can start or stop the components running on an HMI server
separately for each HMI server.

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 the Components


tab.

3. In the Components tab, click Run Startup Components. The


startup components specified in the Components tab, 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 the Components


tab.

Deploying distributed applications ■ 26–9


3. In the Components tab, 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 Components tab, clicking


Stop All Running Components runs the Shutdown macro.

Starting and stopping HMI services manually

Use the RSView SE Service Manager tool to start or stop the HMI
services running on a computer.

IMPORTANT When you stop the HMI services manually, clients are
disconnected, all HMI servers running on the
computer are shut down, and the activation keys used
by the HMI servers are released.

When you start the HMI services manually, clients are allowed to
connect to HMI servers on the computer.

To stop the HMI services manually

1. Click the Windows Start button, select Programs, Rockwell


Software, RSView Enterprise, Tools, and then click RSView SE
Service Manager.

26–10 ■ RSView Supervisory Edition User’s Guide


2. In the RSView HMI Service Manager window, click Stop.

3. To close the RSView HMI Service Manager window, click Close.

4. Use the Windows Task Manager to ensure that the server-side


processes have been unloaded.

Stopping the server can take several minutes, depending on the


number of HMI servers running on the computer.

Wait until all instances of the


HMI alarm services have
been removed from memory.

To start an HMI server manually

1. Click the Windows Start button, select Programs, Rockwell


Software, RSView Enterprise, Tools, and then click RSView SE
Service Manager.

2. In the RSView HMI Service Manager window, click Start.

3. To close the RSView HMI Service Manager window, click Close.

Deploying distributed applications ■ 26–11


Synchronizing the secondary HMI server
with the primary server
If you have set up redundancy for one or more HMI servers in your
application, you should ensure that the primary and secondary HMI
servers are running identical copies of your HMI project. To do this,
synchronize the HMI projects whenever you make changes to the
project on either server.

To synchronize the HMI projects

1. Click the Windows Start menu, select Programs, Rockwell


Software, Utilities, and then click Diagnostics Viewer.

2. Check the FactoryTalk Diagnostics log files for information


messages on both servers, to determine which server was active
when changes were made to the HMI project.

3. Stop the HMI services running on both computers in the


redundant pair. For details, see “Starting and stopping HMI
services manually” on page 26-10.

4. Copy the HMI project that was changed to the server on which
the project is out of date. For details, see “Copying HMI server
files” on page 26-4.

Copying data server files


This section explains how to copy files belonging to RSLinx
Enterprise, and RSLinx for RSView.

For details about copying third-party OPC data servers, see the
documentation supplied with your OPC server.

26–12 ■ RSView Supervisory Edition User’s Guide


Files for RSLinx Enterprise
The device shortcuts for RSLinx Enterprise data servers are saved with
information about your application on the computer that is running
FactoryTalk Directory. When you copy FactoryTalk Directory files to
a different computer, you are also copying setup information for
RSLinx Enterprise data servers in your application. For details about
copying FactoryTalk Directory files, see page 26-4.

Files for RSLinx for RSView


After installing the RSLinx for RSView software on the target
computer, copy the data server’s configuration files manually, as
described below.

To copy data server files for RSLinx for RSView

1. Click the Windows Start menu, select Rockwell Software, RSLinx,


and then click Backup Restore Utility.

2. In the RSLinx Backup Restore window, click Backup.

3. Select a folder for the backup file, type a name for the file, and then
click Save.

4. Copy the backup file from the source computer to the target
computer.

5. On the target computer, click the Windows Start menu, select


Rockwell Software, RSLinx, and then click Backup Restore Utility.

6. In the RSLinx Backup Restore window, click Restore.

Deploying distributed applications ■ 26–13


7. In the Open dialog box, browse for the backup file you copied
from the source computer, and then click Open to restore the
RSLinx configuration.

Setting up data server properties

If you copy a data server from one computer to another, you must
change the name of the computer on which the data server is running.

To change the computer name of the data server

1. Start RSView Studio or the RSView Administration Console, and


then open the application.

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


click Properties.

3. In the box, Computer that will run the OPC server, type the name
of the computer that is hosting the RSLinx or OPC-DA 2.0 data
Browse button server, or click the Browse button to select the computer name.

4. If you are setting up redundancy for the data server, specifiy the
properties of the secondary data server in the Redundancy tab. For
details, see “Setting up data server redundancy” on page 7-9.

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

26–14 ■ RSView Supervisory Edition User’s Guide


„ view trends.

„ adjust set points.

„ start and stop components on servers.

„ provide a secured operator environment.

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, select 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.

Deploying distributed applications ■ 26–15


Copying client configuration files
When setting up RSView SE Clients, you can specify the location for
the configuration files. The following instructions assume that the
configuration files for the RSView SE Client are present in their default
location.

To copy RSView SE Client configuration files


to another computer

X Copy the .cli file from the following folder at the source computer
to the same folder at the target computer.

\Documents and Settings\All Users\Documents\


RSView Enterprise\SE\Client

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
or workgroup.

For tips and troubleshooting suggestions to help you get


communications working between the client and server, see Help.

To open an RSView SE Client by double-clicking the .cli file

X Double-click the client configuration file (.cli) you want to open, in


the following default folder:

\Documents and Settings\All Users\Documents\


RSView Enterprise\SE\Client

26–16 ■ RSView Supervisory Edition User’s Guide


To open an RSView SE Client using the menus

1. Make sure all HMI servers used by the application are loaded. For
information about loading HMI servers, see “Setting up HMI
server properties” on page 5-22.

2. Do one of the following:

„ Click the Windows Start button, select Programs, Rockwell


Software, RSView Enterprise, and then click RSView
SE Client.
„ In RSView Studio, 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 locate
Browse button 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 either
cancel the attempt to run the RSView SE Client, or you can log in
manually as another user. If you click Retry to log in manually, the
RSView Login dialog box appears.

Deploying distributed applications ■ 26–17


Opening the RSView SE Client automatically
when Windows starts

1. Create a shortcut to the .cli file.

2. Move the shortcut to the Windows Startup folder. For details


about adding shortcuts to the Startup folder, 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 multiple 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.

To open multiple clients using


the DisplayClientOpen command

1. In a graphic display, create a button.

2. For the button’s press action, type the following command:

DisplayClientOpen <file>

where <file> is the name of the .cli file you want to open.

26–18 ■ RSView Supervisory Edition User’s Guide


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 information about starting components
manually, see page 26-9.

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 26-9.

Deploying distributed applications ■ 26–19


27
Chapter

Deploying
stand-alone applications
About deploying stand-alone applications

Once you have finished developing and testing your application, you
are ready to run your stand-alone application. If necessary, you can
move your application to a new location in a ‘live’ setting, for example,
the plant floor. This process is called deploying an application.

There are several activities you must perform to deploy your stand-
alone application.

This chapter describes how to:

„ move the application.

„ set up the HMI server in your application.

„ set up data servers.

„ set up and open the RSView SE Client.

Overview of deploying your stand-alone application

Use this list of activities as the basis for 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.

Deploying stand-alone applications ■ 27–1


To deploy your application, you must do the following:

„ Copy the application To copy the application, use the


Application Manager tool.

„ Specify the HMI server’s startup settings The startup settings


allow you to specify which parts of your application start
automatically when the HMI server starts.

Specify the startup settings in the Components tab of the HMI


Server Properties dialog box.

„ 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 Client At run time, operators interact with


graphic displays on an RSView SE Client. You must specify the
application the RSView SE Client connects to, and the components
the RSView SE Client loads when it connects to the application.
For example, the 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.

„ Open the RSView SE Client and test your application To open


the RSView SE Client, double-click the client configuration file.

27–2 ■ RSView Supervisory Edition User’s Guide


Copying a stand-alone application
1. Close the RSView SE Client, RSView Studio, and the RSView
Administration Console.

You cannot copy a stand-alone application that is in use.

2. Click the Start button, select Programs, Rockwell Software,


RSView Enterprise, Tools, and then click Application Manager.

3. Using the Application Manager tool, back up the stand-alone


application, and then restore it at the target computer.

For details about using the Application Manager tool, click Help.

Setting up HMI server properties


You can change the components that run when the HMI server starts
or stops. You can also start or stop components running at the HMI
server, manually.

The HMI Server Properties dialog box also shows the HMI server’s
name, project file path, number of existing graphic displays or the
maximum number of graphic displays allowed.

For details about setting up the properties of an HMI server, see


page 6-8.

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.

Deploying stand-alone applications ■ 27–3


2. In the HMI Server Properties dialog box, click the Components
tab.

3. In the Components tab, click Run Startup Components. The


startup components specified in the Components tab, 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 the Components


tab.

3. 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 Components tab, clicking


Stop All Running Components runs the Shutdown macro.

Moving or copying data server files


After installing the RSLinx for RSView software, or the software for
your OPC server, copy the data server’s configuration files.

If you are using RSLinx, on the RSLinx primary computer, run the
RSLinx Backup Restore Utility to back up configuration files. Then on
the second computer, run the utility to restore the configuration. Click
the Windows Start menu, select Rockwell Software, RSLinx, and then
click Backup Restore Utility.

Setting up 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.

27–4 ■ RSView Supervisory Edition User’s Guide


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 click the
Browse button Browse button to select the computer name.

3. Click OK.

Setting up the RSView SE Client

The RSView SE Client provides a complete run-time environment for


the application. For stand-alone applications, the RSView SE Client
and the HMI server are located on the same computer.

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.

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 will be loaded when you open the
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

Deploying stand-alone applications ■ 27–5


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, select 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.

Opening the RSView SE Client

To open an RSView SE Client by double-clicking the .cli file

X Double-click the client configuration file (.cli) you want to open, in


the following folder:

\Documents and Settings\All Users\Documents\


RSView Enterprise\SE\Client

To open an RSView SE Client using the menus

1. Do one of the following:

„ Click the Windows Start button, select 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.

27–6 ■ RSView Supervisory Edition User’s Guide


2. In the Launch RSView SE Client dialog box, specify the name of
the client configuration file, or click the Browse button to locate
Browse button 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 either
cancel the attempt to run the RSView SE Client, or you can log in
manually as another user. If you click Retry to log in manually, the
RSView Login dialog box appears.

Opening the RSView SE Client automatically


when Windows starts
1. Create a shortcut to the .cli file.

2. Move the shortcut to the Windows Startup folder. For details


about adding shortcuts to the Startup folder, 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 multiple stand-alone
applications located on a single computer.

Deploying stand-alone applications ■ 27–7


To open multiple 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.

To open multiple clients using the


DisplayClientOpen command

1. In a graphic display, create a button.

2. For the button’s press action, type the following command:

DisplayClientOpen <file>

where <file> is the name of the .cli file you want to open.

How server components start and stop

Server components start after the HMI server loads. Opening RSView
SE Client will run the Startup components. You can start HMI server
components manually using RSView Studio, or the RSView
Administration Console. For details, see page 27-3.

Server components stop when the HMI server is unloaded. In a stand-


alone application, this happens automatically when you close the
RSView SE Client.

You can also stop all HMI server components manually using RSView
Studio, or the RSView Administration Console. For details, see
page 27-3.

27–8 ■ RSView Supervisory Edition User’s Guide


28
Chapter

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 called
administration.

You can make changes to your application using either RSView Studio,
or the RSView Administration Console.

This chapter describes how to:

„ set the time, date, and number formats correctly for your computer.

„ start and use the RSView Administration Console.

„ monitor disk space on HMI servers.

„ back up and restore stand-alone applications.

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, select Settings, and then click Control Panel.

2. In the Control Panel window, double-click Regional Options.

The Regional Options dialog box opens.

Administering applications ■ 28–1


3. In the Regional Options dialog box, click the General tab, and then
click the locale whose settings you want to use.

4. Verify or customize the settings on the Numbers, Time, and Date


tabs.

5. Click OK.

For information about using the Control Panel to set time, date, and
number formats, see your Windows documentation.

Backing up or restoring a stand-alone application


You cannot back up a stand-alone application that is in use. Close all
instances of RSView Studio, the RSView Administration Console, or
the RSView SE Client first.

To back up or restore a stand-alone application

X Click the Start button, select Programs, Rockwell Software, RSView


Enterprise, Tools, and then click Application Manager.

For details about using the Application Manager tool, click Help.

Administering your application


To make changes to an application after it is deployed, you can use
either:

„ RSView Studio, or

„ RSView Administration Console.

IMPORTANT The RSView Administration Console shuts down after


2 hours of use, even though it does not require an
activation key.

28–2 ■ RSView Supervisory Edition User’s Guide


To start the RSView Administration Console

X Click Start, select Programs, Rockwell Software, RSView


Enterprise, Tools, and then click RSView SE Administration
Console.

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 how alarms are logged and annunciated, using the Alarm
Setup editor.

Administering applications ■ 28–3


„ add tags to, or remove tags from the Suppressed List, for testing
alarms.

„ change the path of data log models.

„ change what system activities are logged, and how frequently, using
the Diagnostics 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 the HMI 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 information about the free_bytes function, see “File functions” on


page 20-19. For information about events, see Chapter 14, Setting up
events.

28–4 ■ RSView Supervisory Edition User’s Guide


A
Appendix

RSView commands
This appendix describes:

„ where and how to use RSView commands.

„ where commands are executed.

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

„ Commands and parameters are not case sensitive.

RSView commands ■ A–1


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

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.

A–2 ■ RSView Supervisory Edition User’s Guide


Floating point tags can be a maximum of 17 digits long. If the value is
longer than 17 digits, it is represented in scientific format. The
maximum command length is 1000 characters. The command is
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.

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

RSView commands ■ A–3


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 run. 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 Display macro.

Where commands run


Some commands run at the server, some run at the client, and some
run wherever they were issued.

Commands that run at the RSView SE Server

Acknowledge AlarmPrintOn DerivedOn


AcknowledgeAll DataLogChangeRate EventOff
AlarmEvent DataLogMergeToPrimary EventOn
AlarmLogNewFile DataLogNewFile HandShakeOff

A–4 ■ RSView Supervisory Edition User’s Guide


AlarmLogOff DataLogOff HandShakeOn
AlarmLogOn DataLogOn Silence
AlarmLogSendToODBC DataLogRenameFile SilenceAll
AlarmOff DataLogSnapShot SuppressOff
AlarmOn DataLogSwitchBack SuppressOffAll
AlarmPrintOff DerivedOff

Commands that run at the RSView SE Client

The following commands run at the RSView SE Client.

Abort Key PushBack


Define Login RecipeRestore
Display Logout RecipeSave
DisplayClientClose NextPosition ScreenPrint
DisplayClientOpen NextWindow SendKeys
Download OpenRSLogix5000 SetFocus
DownloadAll Position SuppressOn
FlushCache PrevPosition Undefine
Help PrevWindow Upload
Identify PrintDisplay UploadAll
Invoke PullForward

Commands run at the computer on which they were issued

The following commands run wherever they are issued. For example,
if one of these commands is issued at the client, it runs at the client.

= (Equal) DDEExecute Remark


AlarmLogRemark If Set

RSView commands ■ A–5


AppAbort Pause Toggle
AppStart PlayWave
Beep Ramp

Commands that do not run


in test display mode
The following commands are ignored when issued 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.

A–6 ■ RSView Supervisory Edition User’s Guide


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.

In stand-alone applications you need use relative references only.

How relative references are resolved


You need only understand how relative references are resolved if you
are creating distributed applications. If you are creating stand-alone
applications only, you can skip this section.

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 runs 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 runs from the


IngredientDisplay display in the area RecipesArea, the area name

RSView commands ■ A–7


RecipesArea is used to resolve the relative reference in the
command.

If the command runs 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 run by an Events component, the Alarm


Identification feature, or the Startup or Shutdown macros, the area
that contains the HMI server is used to resolve the relative
reference.

Commands that take HMI project components as parameters

When the command runs from a graphic display, the area that contains
the graphic display is used to resolve the relative reference.

Some commands are run 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.

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.

A–8 ■ RSView Supervisory Edition User’s Guide


To define a symbol

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

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 15, Setting up 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.

RSView commands ■ A–9


To clear a symbol

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

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
context menu.

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.

A–10 ■ RSView Supervisory Edition User’s Guide


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.

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.

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.

RSView commands ■ A–11


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:

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.

Name lists the commands in the open folder.

Description describes the command’s function.

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.

The RSView commands, organized alphabetically

= (Equal) [&]<tag_name>=<expression>

Writes the value resulting from an expression to a tag.

[&] Forces the command to be run asynchronously, which means that


if the command runs 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.

RSView commands ■ A–13


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 information about security, see Chapter 15,
Setting up security.

For information about expressions, see Chapter 20, Creating expressions.

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.

A–14 ■ RSView Supervisory Edition User’s Guide


Tank1\Message=“Tank1 Overflow”
Writes the string Tank1 Overflow to the Tank1\Message tag.

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.

RSView commands ■ A–15


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

Acknowledge *
Acknowledges all outstanding alarms.

A–16 ■ RSView Supervisory Edition User’s Guide


Acknowledge [tag]
Acknowledges the alarm for the tag associated with the highlighted
object in the active graphic display.

AcknowledgeAll AcknowledgeAll [area]

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 run 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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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.

AlarmEvent AlarmEvent <EventName> <EventType> [TagType]


[/VTagValue] [/SSeverity] [/HTimestamp] [/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.

<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

RSView commands ■ A–17


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.

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

[/HTimestamp] 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–18 ■ 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.

[/L“LogMessage”] 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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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–19


AlarmLogOff AlarmLogOff [area]

Stops alarm logging on 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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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 runs from a graphic display, the area that contains the
graphic display is used to resolve the reference.

If the command is run 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–20 ■ RSView Supervisory Edition User’s Guide


AlarmLog AlarmLogRemark [area] [“Text”] [/P] [/Sn] [/R] [/Ttag_name]
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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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

RSView commands ■ A–21


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.

[/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.

[/Ttag_name] 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.

A–22 ■ RSView Supervisory Edition User’s Guide


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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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.

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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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–23


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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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 Properties dialog box, click the Components tab, and then
select the Alarming check box.

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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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


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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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.

Example: The AppAbort command

If Notepad is open and contains an untitled file, the Notepad title bar
reads Untitled–Notepad. To close Notepad you must type exactly
what’s in the Notepad title bar:

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 file required to start the


program.

RSView commands ■ A–25


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\Internet Explorer\


Iexplore.exe
Opens Internet Explorer.

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.

A–26 ■ RSView Supervisory Edition User’s Guide


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

RSView commands ■ A–27


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

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.

A–28 ■ RSView Supervisory Edition User’s Guide


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 a data log model start automatically when a project starts, open
the HMI Server Properties dialog box, click the Components tab, click
the Data Logging check box, and then specify a component.

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.

RSView commands ■ A–29


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

A–30 ■ RSView Supervisory Edition User’s Guide


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

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.

RSView commands ■ A–31


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

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 Properties dialog box, click the

A–32 ■ RSView Supervisory Edition User’s Guide


Components tab, 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.

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

RSView commands ■ A–33


/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”.

[/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

A–34 ■ RSView Supervisory Edition User’s Guide


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

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.

RSView commands ■ A–35


DisplayClient DisplayClientClose <file | Me | title>
Close
This command closes the specified RSView SE Client. It runs 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.

DisplayClient DisplayClientOpen <file>


Open
This command opens the specified RSView SE Client. It runs only at
the RSView SE Client and is ignored if it is issued at the HMI server.

<file> is the name of the RSView SEClient 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.

A–36 ■ RSView Supervisory Edition User’s Guide


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.

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.

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 Properties dialog box, click the
Components tab, select the Events 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.

RSView commands ■ A–37


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 runs when you
issue the FlushCache command.

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 run 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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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–38 ■ RSView Supervisory Edition User’s Guide


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 run
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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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 runs.

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.

The name of a Windows Help file. The default Help file is for
[/Ffile]
RSView.

If no search word is specified, the command opens the RSView Help


file and displays the Contents.

RSView commands ■ A–39


Identify Identify [tag_name] | [tag]

Runs the command or macro associated with the named tag, whether
or not the tag is in alarm. The command or macro runs 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.

[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 then 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.

A–40 ■ RSView Supervisory Edition User’s Guide


Identify
Runs the Identify command or macro for the most recent, most severe
unacknowledged alarm.

If If <expression> THEN <command>; <command>; …


[ELSE <command>; <command>; …] ENDIF

This command executes one or more commands conditionally. You


can use the If command anywhere you can issue other commands.

IMPORTANT Do not confuse the If command with the If–then–else


expression. For details about the the If–then–else
expression, see page 20-23.

<expression> is a comparison (for example, Tag1=Tag2, or


Tag1=Tag2+Tag3), or any expression that evaluates to a numeric
value. An expression that evaluates to any non-zero number is
considered to be TRUE. An expression that evaluates to zero is
considered to be FALSE.

The expression cannot contain IF, THEN, ELSE, or ENDIF


operators.
<command> is any RSView command or user-defined macro. For the
THEN or ELSE actions, you can specify single or multiple commands
or macros, separated by semi-colons.

If the expression evaluates to TRUE, the THEN action is performed.


If the expression evaluates to FALSE and an ELSE action is specified,
the ELSE action is performed. If the expression evaluates to FALSE
and no ELSE action is specified, no action is taken.

Rules for using the If command

You cannot nest If commands. Commands that you use for the
THEN or ELSE actions cannot be If commands.

All parts of the If command statement must be on a single line.

RSView commands ■ A–41


The maximum length of an If command is 1000 characters. If
substituted tag values cause the command to exceed the 1000-character
limit, the command is truncated.

The keywords IF, THEN, ELSE, and ENDIF are not case sensitive.

Where the If command is executed

The If command is executed locally at the HMI server, RSView


SE Client, RSView Studio, or the RSView Administration Console that
issued the command.

The commands specified in the THEN or ELSE actions are executed


where they would normally be executed when issued from outside the
If command. For details, see “Where commands run” on page A-4.

The If command is processed synchronously

If other commands are executed together with the If command, for


example in a macro, the next command will not be processed until the
commands in the THEN or ELSE actions have been sent for
execution, or until an error is encountered in the If command.

If you place an ampersand (&) in front of the If command, the system


will not wait for the commands in the THEN or ELSE actions to be
sent for execution before sending subsequent commands for
processing.

Example:

If Hopper1\Flow>90 Then Hopper1\Valve1=1;


Hopper1\Valve2=0 Else Hopper1\Valve2=1;
Hopper1\Valve1=0 Endif

A–42 ■ RSView Supervisory Edition User’s Guide


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.

You can use the Invoke command to change the properties listed in the
Property Panel for a graphic object.

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


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 object as specified in the Property Panel,


in the Graphic Displays editor.

method The name of a method exposed by the object.

parameter The tag name or constant that the method will use.
You must specify all of the parameters, even those that are optional.

RSView commands ■ A–43


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.

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 [user_name] [password]

Logs users into the system. To log in, users must have an account in the
User Accounts editor.

[user_name] The user’s name as defined in the User Accounts editor.

[password] The user’s password as defined in the Windows domain


or on the local computer. If this parameter is omitted, a window
appears prompting the user to enter the password.

A–44 ■ RSView Supervisory Edition User’s Guide


Using this command with both parameters logs the user into the
system. Using this command with only one parameter displays the
login dialog box.

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.

RSView commands ■ A–45


Open OpenRSLogix5000 <project> <program> <routine>
RSLogix5000 [/RNrung_number] | [/RIrung_identifier]

Opens the RSLogix 5000 program, and then displays the specified
routine. This command can only be issued from RSView Studio, the
RSView Administration Console, or the RSView SE Client, and
requires that RSLogix 5000, version 12 or later, be installed on the
computer on which the command is issued.
<project> The full path to an RSLogix 5000 project file (*.acd). If
there are spaces in the path name, enclose the path in quotation marks
(“ ”).
<program> The name of the program in the RSLogix 5000 project.
<routine> The name of the routine in the program.
[/RNrung_number] Optionally, the number of a rung in a ladder
diagram routine.
[/RIrung_identifier] Optionally, the identifier of a rung in a ladder
diagram routine.

Use a rung identifier to avoid navigating to the wrong rung in a ladder


diagram if a rung is added or removed subsequently, causing the rung
numbers to change. You can use the command wizard to convert a
rung number to a rung identifier.

Specify either a rung number or a rung identifier, but not both.

Examples:
OpenRSLogix5000 "c:\My Projects\Pumphouse.acd"
MainProgram Ladder1 /RN34
This command opens the project called Pumphouse.acd, locates the
program called MainProgram, opens the routine called Ladder1, and
navigates to rung number 34.

OpenRSLogix5000 c:\Pumphouse\Pumphouse.acd
MainProgram Ladder1 /RI4967157
This command opens the project called Pumphouse.acd, locates the

A–46 ■ RSView Supervisory Edition User’s Guide


program called MainProgram, opens the routine called Ladder1, and
navigates to the rung with the identifier 4967157.
OpenRSLogix5000 \\comp1\Projects\Pumphouse.acd
Welder Ladder1
This command opens the project called Pumphouse.acd on the
computer called comp1, locates the program called Welder, and then
opens the routine called Ladder1 at rung 0.
OpenRSLogix5000 c:\Pumphouse\Pumphouse.acd Welder
Motion3
This command opens the project called Pumphouse.acd, locates the
program called Welder, and then opens the routine called Motion3. If
this routine is not a ladder diagram, the cursor is placed at the top of
the routine. If this routine is a ladder diagram, the cursor is placed at
rung 0.

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.

RSView commands ■ A–47


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

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.

A–48 ■ RSView Supervisory Edition User’s Guide


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 showing

RSView commands ■ A–49


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.

Ramp Ramp [/V] <tag_name> <value | tag_name>

Increases or decreases a tag’s value by a particular value or by the value


of another tag.

A–50 ■ RSView Supervisory Edition User’s Guide


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 Diagnostics


log or Diagnostics List, using the Error and Audit categories. You can
specify whether FactoryTalk Diagnostics records errors and audit
messages for the audience called Developer. To do this, use the
Message Routing item in the Diagnostics Setup tool.

<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 | tag_name> The amount to be added or subtracted 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 writes 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%%

RSView commands ■ A–51


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.

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.

A–52 ■ RSView Supervisory Edition User’s Guide


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

You can specify whether comments are logged. To do this, select the
Message Routing item in the Diagnostics Setup tool, and then select
one or more of the Info check boxes.

ScreenPrint ScreenPrint

Generates a screen print on the default printer specified in Windows.

See also PrintDisplay.

SendKeys SendKeys <“key_string”>

Sends the specified keystrokes to the active window.

<“key_string”> 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.

RSView commands ■ A–53


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

Set [&]Set [/V] <tag_name> <value | tag>

Writes a constant or another tag’s value to a tag.

[&] Forces the command to be run asynchronously, which means that


if the command runs 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 Diagnostics


log or Diagnostics List, using the Error and Audit categories. You can
specify whether FactoryTalk Diagnostics records errors and audit
messages for the audience called Developer. To do this, use the
Message Routing item in the Diagnostics Setup tool.

<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:

A–54 ■ RSView Supervisory Edition User’s Guide


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

For analog HMI 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 HMI 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 HMI tags

„ A string enclosed in quotation marks. The string can contain any


character and can include spaces.

„ The name of another string tag.

RSView commands ■ A–55


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.
Set Valve23 open
Valve23 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.

A–56 ■ RSView Supervisory Edition User’s Guide


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.

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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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–57


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 runs from a graphic display, the area that contains
the graphic display is used to resolve the reference.

„ If the command is run 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.

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.

A–58 ■ RSView Supervisory Edition User’s Guide


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 Diagnostics


log or Diagnostics List, using the Error and Audit categories. You can
specify whether FactoryTalk Diagnostics records errors and audit
messages for the audience called Developer. To do this, use the
Message Routing item in the Diagnostics Setup tool.

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

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.

RSView commands ■ A–59


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–60 ■ 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.

At run time, only the first 40 characters stored in


this tag are displayed in the format specified by the
Regional Settings in the Windows Control Panel.
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 in the HMI server. Only the first
82 characters of the tag name are displayed.
system\AlarmMostRecentTime String The time of hte most recent, most severe alarm.
system\AlarmMostRecentUnits String The units of the most recent, most severe alarm.

System tags ■ B–1


Tag name Type Contains information about

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.

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\DateAndTime Analog Number of seconds Read only
Integer elapsed since midnight
(00:00:00) January 1,
1970, coordinated
universal time (UTC).
system\DateAndTime String Complete date and Read only
String time display. For
example:

Monday,
December 16 2002
10:47:50 AM
system\DayOfMonth Analog Day of the month Read only
(1 to 31).
system\DayOfWeek Analog Day of the week Read only
(1 to 7); Sunday=1.

B–2 ■ RSView Supervisory Edition User’s Guide


Tag name Type Provides this data Read or write

system\DayOfYear Analog Day of the year Read only


(1 to 366).
system\Hour Analog Hour of the day Read and write
(0 to 23).
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 Read only
(1980 to 2099)

System tags ■ B–3


C
Appendix

Setting up DDE
communications for
HMI tags

To obtain values from HMI tags, you must set up communications. To


support legacy applications, RSView supports DDE communications.

This chapter describes how to use DDE communications with


HMI tags.

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 RSServer™ products, or other third-
party servers, to connect an HMI server to communication devices.

DDE servers provide a way to connect an HMI server’s HMI tags (the
DDE client) to:

„ communication devices such as Siemens or Modicon.

„ a third-party DDE server such as Microsoft Excel or Visual Basic®.

Setting up DDE communications for HMI tags ■ C–1


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 CF_Text or
XLTable AdvanceDDE TM

AdvanceDDE*
Third-party Third-party
RSServer DDE server
application,
such as
Microsoft Excel

Network or
PLC network comunication
link

Modicon, Other non-


* The third-party server can GE, Siemens Allen-Bradley
use AdvanceDDE format if or other device
the server uses the Rockwell programmable
Software server toolkit controller

C–2 ■ RSView Supervisory Edition User’s Guide


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. For distributed applications, add an area.

4. Create an HMI server.

5. In the Tags editor, create tags. Select Device as the data source. In
the Address box, type the required DDE address.

For details about the syntax of DDE addresses, see page C-4.

For details about creating tags, see “Working with tags” on page 8-1.

Creating an HMI tag using DDE

The following topics describe how to complete the Data Source fields
in the Tags editor for tags that use DDE communications.

For details about creating HMI tags, see “Creating HMI tags” on
page 9-1.

Specifying device as the data source


An HMI tag with device as its data source receives its data from a
source external to RSView. This section describes how to create tags
for data that comes from:

„ programmable controllers through a DDE server.

„ another Windows program through a DDE server.

Setting up DDE communications for HMI tags ■ C–3


To create a tag with device as the data source

1. Click Device.

2. In the Address box, specify the DDE item.

Type the DDE address for the tag. The DDE item name and
format depend on the DDE server, and are not validated by
RSView.

Syntax for DDE addresses


The syntax for DDE tag addresses is

DDE : Application|Topic!Item

There are no spaces:

„ between the Application name, the vertical bar, and the Topic name.

„ between the Topic name, the exclamation mark, and the Item name.

For information about addressing syntax, see the documentation


supplied with your DDE server.

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.

C–4 ■ RSView Supervisory Edition User’s Guide


D
Appendix

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.

FactoryTalk Diagnostics log table


FactoryTalk Diagnostics log data in ODBC format uses one table. For
information about how the log files are named, see “The ODBC
database storage format” on page 13-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
MessageText The text of the message. SQL_VARCHAR, or 254
SQL_CHAR
Audience A number representing the audience for SQL_SMALLINT, or 1
the message: SQL_INTEGER

2 for Developer
3 for Secure
4 for Engineer
8 for Operator

The ODBC database schemas ■ D–1


This column Contains SQL data type Length

Severity A number representing the severity of the SQL_SMALLINT, or 1


message: SQL_INTEGER

1 for Error
2 for Warning
4 for Information
8 for Audi
Area The area in which the activity occurred. SQL_VARCHAR, or 80
SQL_CHAR
Location The name of the computer that initiated SQL_VARCHAR, or 15
the command or action that caused the SQL_CHAR
activity.
UserID The name of the user that initiated the SQL_VARCHAR, or 38
command or action that caused the activity. SQL_CHAR
UserFullName The name of the user (including domain SQL_VARCHAR, or 255
name, if there is one) that initiated the SQL_CHAR
command or action that caused the activity.
Provider The name of the product the activity SQL_VARCHAR, or 20
belongs to. SQL_CHAR

Alarm log table


Alarm log data in ODBC format uses one table. For information about
how the log files are named, see “The ODBC database storage format”
on page 13-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

D–2 ■ RSView Supervisory Edition User’s Guide


This column Contains SQL data type Length

TransType The type of alarm that was generated. The SQL_VARCHAR, or 5


transaction type is one of the following: SQL_CHAR

SysAk (System Acknowledged)


InAlm (In Alarm)
OutAlm (Out of Alarm)
InFlt (In Fault)
OutFt (Out of Fault)
Ack (Acknowledged)
RmAck (Remote Acknowledged)
SupOn (Suppress On)
SupOf (Suppress Off)
Remar (Remark)
TagName The name of the tag or alarm event that SQL_VARCHAR, or 255
caused 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, SQL_VARCHAR, or 1
D for 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 SQL_VARCHAR, or 38
name, if there is one) that initiated the alarm SQL_CHAR
transaction. If the transaction was initiated
by an HMI server, the user column contains
‘System’.

The ODBC database schemas ■ D–3


This column Contains SQL data type Length

AlarmType The number RSView assigns to the SQL_SMALLINT, or 1


transaction type. SQL_INTEGER

0 for SysAk (System Acknowledged)


1 for InAlm (In Alarm)
2 for OutAlm (Out of Alarm)
3 for InFlt (In Fault)
4 for OutFt (Out of Fault)
5 for Ack (Acknowledged)
6 for RmAck (Remote Acknowledged)
7 for SupOn (Suppress On)
8 for SupOf (Suppress Off)
9 for Remar (Remark)
Dscrptn The message that is associated with the SQL_VARCHAR, or 132
transaction (alarm) type, the log message for SQL_CHAR
the 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
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.

D–4 ■ RSView Supervisory Edition User’s Guide


Data log tables
Log data in ODBC format uses up to three tables. For more
information, see “The ODBC database storage format” on page 13-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

DateAndTime The date and time the tag values were SQL_TIMESTAMP Driver
logged. dependent
Millitm The millisecond time the tag values were SQL_SMALLINT, or 4
logged. SQL_INTEGER
TagIndex, or The index number for the tag. The tag SQL_SMALLINT, or 2 or
name that corresponds to this number is SQL_INTEGER 4
listed in the tag name table.

TagName If the tag table isn’t used, the tag name SQL_VARCHAR, or 255
appears in 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

The ODBC database schemas ■ D–5


This column Contains SQL data type Length

Status Blank if communications are working SQL_VARCHAR, or 1


properly. 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 B when the DataLogOn command was SQL_VARCHAR, or 1
issued, and logging began. SQL_CHAR

E when the DataLogOff command was


issued, and logging ended.

S when the DataLogSnapshot command


was issued.

D–6 ■ RSView Supervisory Edition User’s Guide


Tag table

This column Contains SQL data type Length

TagName The tag name. SQL_VARCHAR, or 255


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 for Analog tag


3 for Digital tag
4 for String tag
TagDataType The tag data type: SQL_SMALLINT 2

0 for Long
1 for Float
2 for String

The ODBC database schemas ■ D–7


E
Appendix

Exporting text in your


application for translation
To allow your application to be translated into foreign languages,
RSView Supervisory Edition allows you to export the text that
operators see in your application at run time. The text strings in each
HMI server are exported to separate text files in Unicode format that
you can then send to translators.

When the translators send the translated files back to you, you can
import them into your application, substituting the original language of
your application for the one contained in the translated text files.

RSView Supervisory Edition allows an application to have only one


language at a time. For each language, you must make a copy of your
application, and then import the translated text file.

For details about copying the parts of a distributed application, see


Chapter 26, Deploying distributed applications. For details about copying a
stand-alone application, see Chapter 27, Deploying stand-alone applications.

This chapter includes information about:

„ what text in your application cannot be exported.

„ how to export and import text.

„ troubleshooting import errors.

„ the file format of the text file, including information about what
parts of the file should not be translated. You should share this
information with the translator to ensure that the file can be
imported after translation.

Exporting text in your application for translation ■ E–1


Text that you cannot export
All text in your application can be exported, except for:

„ text that is part of the language version of the RSView Studio or


RSView SE Client software.

„ text that can be displayed at run time, but is used to operate your
application, for example the names of graphic displays, and
command strings.

„ text that you add to your application, but is not displayed at run
time.

Text that is part of the software


Any text that is part of the RSView Studio or RSView SE Client
program cannot be exported. This includes any text that you do not
specify for your application at design time, for example:

„ tooltips on buttons belonging to the RSView Studio, or RSView


SE Client software, except for tooltips that you add to objects in a
graphic display.

„ text on the on-screen keyboard or numeric keypad.

„ text in the login dialog box that appears to operators at run time.

„ text in the Recipe dialog box that appears to operators at run time.

and so on.

E–2 ■ RSView Supervisory Edition User’s Guide


Text that is displayed at run time, but cannot
be exported

Some RSView Supervisory Edition components include text that you


do specify, but cannot be exported for translation. This includes:

„ command strings, including those you type for the Remark


commands.

„ the description for tags in the tag database.

„ the text of alarm messages. To translate alarm messages, you can


export the alarm messages separately to a comma-separated value
(.csv) file, translate the messages, and then import the .csv file again.

„ string constants in expressions, and in all components that use


expressions. You might use string constants in expressions if your
application displays different strings in a string display based on the
result of an expression.

„ the text that appears in the title bar of the RSView SE Client
window. This text is part of the setup for your display client. The
text is not part of your application.

System Tags

You might have used system tags in your application to display text in
graphic displays. System tags are always shown in the format prescribed
by the language of the Windows operating system—if you are running
the English language version of the Windows operating system, the
text in system tags is displayed in English, and dates and numbers are
formatted for U.S. English. These system tags include:

„ Time

„ Date

„ DateAndTimeString

Exporting text in your application for translation ■ E–3


„ MonthString

„ AlarmResetDateAndTimeString

For details about system tags, see Appendix B, System tags.

Text that is not displayed at run time, and


cannot be exported
Some of the text that you can add to your application is never shown
to the operator at run time. RSView Supervisory Edition deliberately
does not export this text because it is not displayed at run time.

The following text strings are not exported. The properties listed below
apply to all graphic objects in your application that support the
properties mentioned, unless the names of specific objects are
mentioned.

In this product This graphic object Includes text that cannot be exported
for this property (where applicable)

RSView Supervisory Edition all objects Extended Name


and RSView Machine Edition Description
Image
St_Image
LinkedObject
Display list selector St_Display
St_Parameter

E–4 ■ RSView Supervisory Edition User’s Guide


In this product This graphic object Includes text that cannot be exported
for this property (where applicable)

RSView Supervisory Edition Recipe Value


Numeric input, and TagName
string input
Numeric display, and Expression
string display
Tag label TagName
PropertyName
Caption
Trend All properties, except ChartTitle, Pen
Description, and EngineeringUnits. These
three properties are exported.
RSView Machine Edition Goto display button Display
Parameter
Local message display MessageFile
Alarm list, alarm FilteredTriggers
banner, and alarm
status list
Macro button Macro

Exporting text
Text in your application is exported to tab-delimited text files in
Unicode format.

For distributed applications, text from each HMI server is exported to


a separate file.

Because stand-alone applications contain only one HMI server, text in


a stand-alone application is exported to a single file.

Exporting text in your application for translation ■ E–5


To export text in your application to a text file

1. Ensure that the HMI project containing the text you want to
export is not being modified or edited. If components are being
edited remotely and have not been saved, the exported file will not
contain the unsaved changes.

2. In the Application Explorer, right-click the root of the application


tree, and then click String Import and Export on the context
menu.

The String Import Export wizard appears.

3. In the Select Operation window, click Export strings from


application, and then click Next.

E–6 ■ RSView Supervisory Edition User’s Guide


4. If you are exporting text from a stand-alone application, skip to the
next step. For distributed applications, in the Select Servers
window, select the check box for each HMI server from which you
want to export text, and then click Next.

To select all of the check boxes, click Select All. To deselect all of
the check boxes, click Clear All.

Text exported from each HMI server in the application is saved in


a separate file.

Exporting text in your application for translation ■ E–7


5. In the Select Destination window, do one of the following:

„ To export text to files located in the default folder, click Next.

The default folder is:

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


RSView Enterprise\Strings

„ To export text to files located in a specific folder, type the name


of the folder or click the Browse button to browse for a folder,
Browse button and then click Next.

If you cancel the export before it is complete, any files that were created
are not deleted, but their contents might not be complete.

Importing text

To import text from a file into your application, the file must be saved
in Unicode Text format.

For details about saving the file in Microsoft Excel, see “Saving the text
file in Microsoft Excel” on page E-15.

Text strings that exist in your application, but do not appear in the text
file are not deleted. This allows you to import only those strings that
have been modified.

E–8 ■ RSView Supervisory Edition User’s Guide


To import text into your application from a text file

1. Ensure that the HMI project into which you want to import text is
not being modified or edited. If components are being edited
remotely and are saved after you have imported text for them, the
imported text will be overwritten.

2. Create a backup of the text currently in your application by


exporting it.

This is recommended because it allows you to restore the original


text to your application if an error occurs while importing, or if you
cancel the import before it is complete.

For details, see “Exporting text” on page E-5.

3. In the Application Explorer, right-click the root of the application


tree, and then click String Import and Export on the context
menu.

The String Import Export wizard appears.

4. In the Select Operation window, click Import strings into


application, and then click Next.

5. In the Select Files window, click the Browse button, and then select
the text files that contain the text you want to import into your
Browse button application.

If you are importing text into a distributed application, you can


import text for multiple HMI servers at the same time.

Exporting text in your application for translation ■ E–9


If you cancel the import before it is complete, any text strings that were
changed are not restored to their original values. To restore the text
originally in the application, import the text from the backup text file
you created in step 2.

Troubleshooting importing

You do not have to check every graphic display in your application to


verify that text was imported correctly. If errors occurred while
importing text, they are displayed automatically from a log file called
ImportErrors.txt in the following folder:

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


RSView Enterprise\Strings

Each time errors occur while importing text into an application, the
ImportErrors.txt file is overwritten.

If errors occurred while importing text, or if the import was canceled,


a message appears in the diagnostics list, and in the diagnostics log file.

Common errors and their causes


If text appears to have been imported for some HMI servers and not
for others, see the ImportErrors.txt file for an error message. The
causes of common errors, and their remedies are described below.

If some, but not all, of the text in an HMI server appears to have been
modified, the import might have been canceled. If you cancel the
import before it is complete, any text strings that were changed are not
restored to their original values. To restore the text originally in the
application, import the text from the backup text file you created in
step 2 on page E-9.
ServerName defined in FileName.txt does not exist. None of the
strings in this file were imported. This error is logged if the name
of the HMI server is invalid. If the HMI server was renamed, open the
file, and then correct the name of the HMI server.

E–10 ■ RSView Supervisory Edition User’s Guide


File “FileName”, Line x. ComponentType is not a valid
component type for the application. The string was not
imported. x is the line number in the text file. This error is logged
if
the component type has been modified in the text file. Open the text
file, and then correct the text for the component type.

File “FileName”, Line x. ComponentName is not a valid


component name for the application. The string was not
imported. x is the line number in the text file. This error is logged
if
the component name has been modified in the text file. Open the text
file, and then correct the text for the component name.

File “FileName”, Line x. The string reference must be an


unsigned long integer value between 1 and 4294967295. The
string was not imported. x is the line number in the text file. This
error is logged if the string reference number has been modified in the
text file, and the new string reference number is invalid. Open the
backup text file, and then copy the correct the string reference number
into the translated text file.

File “FileName”, Line x. The string was not used in the


application and was not imported. x is the line number in the text
file. This error is logged if:

„ the string reference number has been modified in the text file, and
the new string reference number is not used in the application.
Open the backup text file, and then copy the correct the string
reference number into the translated text file.

„ the object was deleted from the application after the text was
exported. If this is correct, ignore the error.

File “FileName”, Line x. The string definition must be contained


within double quotes. The string was not imported. x is the line
number in the text file. This error is logged if the translated string
definition includes embedded double quotes, but the string definition
itself was not enclosed in double quotes. Open the text file, and then
enclose all string definitions containing embedded double quotes in
double quotes. For example, the string definition, Start "Backup
motor" must be enclosed in double quotes like this: "Start "Backup
motor"".

Exporting text in your application for translation ■ E–11


File “FileName”, Line x. Invalid line format! x is the line number in
the text file. This error is logged if a line in the import file does not
contain all the component name or string reference number fields. The
import continues with the next line in the file. Open the backup text
file, and then copy the missing fields into the translated text file.
Unable to open {FileName.txt}. None of the strings from this file
were imported. This error is logged if the text file could not be
accessed. Make sure the text file is present in the folder from which you
are importing files, and that you can open the text file in Notepad or
Microsoft Excel.

Information for translators


This section contains information about the format and schema of the
exported file.

IMPORTANT Because RSView Enterprise requires that parts of the


text file remain the way they were exported, you should
share the information in this section with the translator,
to ensure that the file can be imported after it has been
modified.

File name and format


You can rename the exported file, for example, to distinguish the
translated version from the original.

However, to import text into an RSView Enterprise application, you


must save the file as tab-delimited text, in Unicode Text format.

E–12 ■ RSView Supervisory Edition User’s Guide


Opening the text file in Microsoft Excel
When you open the text file in Microsoft Excel, the Text Import
Wizard appears.

To specify the file format (Step 1)

1. In Step 1 under Original data type, click Delimited.

2. In the Start import at row box, type or select 1.

3. In the File origin list, click Windows (ANSI).

4. Click Next.

Exporting text in your application for translation ■ E–13


To specify the field delimiter (Step 2)

1. Select the Tab check box. If any other check boxes are selected,
clear them.

2. Make sure the check box, Treat consecutive delimiters as one, is


cleared.

3. Click Next.

E–14 ■ RSView Supervisory Edition User’s Guide


Specifying the column data format (Step 3)

4. If it is not selected already, under Column data format, click


General.

5. Click Finish.

Saving the text file in Microsoft Excel


When you click Save, Excel warns that the file may contain features that
are not compatible with Unicode Text.

1. When prompted to keep the workbook in Unicode format which


leaves out incompatible features, click Yes.

2. When closing the file, you are prompted to save changes. Click Yes.

3. You can save the file using its original name, or you can type a new
name.

4. When prompted again to keep the workbook in Unicode format


which leaves out incompatible features, click Yes.

Exporting text in your application for translation ■ E–15


Differences in file format for files saved in
Excel

If you use Notepad to open a Unicode text file that was saved in Excel,
you will notice some differences from a file edited and saved in
Notepad.

IMPORTANT You do not have to change the format of the file before
you import it into RSView Studio.

The differences are:

„ Double quotes surrounding the string definitions are removed for


most strings.

„ String definitions containing embedded double quotes or other


characters that Excel treats as special characters, such as commas,
are enclosed within double quotes.

„ Any embedded double quotes are converted to a pair of double


quotes.

Editing the Unicode text file in Notepad

When saving the file, save it using the Unicode encoding option in the
Save As dialog box.

File schema

Comments

The text file uses the # symbol as a comment delimiter if it is the first
character on a line.

E–16 ■ RSView Supervisory Edition User’s Guide


Header

The first seven lines of the text file contain header information that
should not be translated or modified.

Body

The body of the text file starts on line eight, and includes the following
fields:

Field Component type Component name String reference “String definition”

Example Graphic Display Pump station 1 “Stop motor”

The file is sorted alphabetically by component name, and then


numerically by string reference number.

Each string reference number refers to a different object in the


component. In the example shown above, string reference 1 might
refer to a push button in the graphic display called Pump station.

In the translated text file, the only text that should be modified is the
text inside the quotation marks in the string definition column. For
example, translated into German, the file would contain these changes:

Field Component type Component name String reference “String definition”

Example Graphic Display Pump station 1 “Motor abschalten”

Do not change the entries in the component name column, unless the
component was renamed in the application after the text was exported.

IMPORTANT Do not modify the component type or string reference


number. The string reference number is a unique
number that is assigned to an object by RSView.
Modifying the component type or string reference
number prevents RSView from identifying the object
correctly when you import the text.

Exporting text in your application for translation ■ E–17


Working with pairs of double quotes

If a text string contains double quotes, the whole string definition must
also be enclosed in double quotes. For example:

Call "Duty Manager"

must be entered in the string file as:

“Call “Duty Manager”“

Importing text containing multiple sets of double quotes

If the string definition contains an odd number of double quotes, the


number of double quotes is rounded down to an even number. For
example, the string:

“Call ““Duty Manager”

appears in the application as:

Call "Duty Manager

Working with backslashes and new-line


characters

To force text to begin on a new line, precede the text with the escape
character \ and the new line character n. For example:

Motor\nabschalten

appears in the application as:

Motor
abschalten

To make the characters \n appear as part of the text, type \\n. To make
a backslash appear in the application, type two backslashes (\\).

E–18 ■ RSView Supervisory Edition User’s Guide


Importing text containing multiple backslashes

If the imported text file contains an odd number of backslashes next to


each other, one of the backslashes will be ignored.

For example, the string:


Seven\\\Eight

is imported into the application as:

Seven\Eight

Exporting text in your application for translation ■ E–19


F
Appendix

Importing and exporting


XML files

This appendix describes:

„ uses for XML in RSView Supervisory Edition.

„ how to create, save, and test an XML file.

„ how to import a multistate indicator XML file.

„ the structure of a multistate indicator XML file.

About XML
XML is the Extensible Markup Language used to create documents
with structured information. In RSView Supervisory Edition, you can
use XML to edit the elements and attributes of multistate indicators.

For information about using the XML language, see the World Wide
Web Consortium’s web page about XML at:
http://www.w3.org/XML/

Creating an XML file


RSView Supervisory Edition allows you to import XML from a file
into a graphic display, to modify existing multistate indicator objects in
the graphic display.

Importing and exporting XML files ■ F–1


Creating an XML file from a sample

You cannot export XML from multistate indicator objects in an


existing graphic display; however, a sample XML file is provided in
Help. You can copy the text of the sample file into another application,
for example Notepad, and then save the file in Unicode format with a
.xml extension.

Alternatively, a sample file called MultistateIndicatorImport.xml is also


included in the folder, C:\Program Files\Rockwell Software
\RSView Enterprise.

Saving XML files in Notepad


Save XML files created in Notepad using either the UTF-8 or UTF-
16 file format. The Unicode file type in Notepad corresponds to UTF-
16 file format.

For files containing strings in English or other Latin-based languages,


UTF-8 is recommended, to reduce the size of the XML file. For other
languages such as Chinese, Japanese, or Korean, UTF-16 is
recommended.

IMPORTANT If you do not want to change a property, you don’t need


to include it in the XML file. Properties that are not
listed in the file are not modified when the file is
imported.

Testing an XML file


RSView Enterprise allows you to import only well-formed XML.

To test an XML file to ensure that it is well-formed, open the file in


Internet Explorer. If the XML code appears in Internet Explorer, the
file is well-formed. If the XML code is not well-formed, Internet
Explorer displays an error message.

F–2 ■ RSView Supervisory Edition User’s Guide


Importing a Multistate Indicator XML file

Import an XML file containing setup information for multistate


indicator objects into a graphic display when you want to modify one
or more existing multistate indicators using a programming tool or
editor.

You cannot export setup information for existing multistate indicators


to XML, but you can copy the sample multistate indicator XML file
and then modify it. For details about the sample XML file, see
“Creating an XML file from a sample” on page F-2.

To import an XML file into a graphic display

1. In RSView Studio, open the application into which you want to


import the XML file.

2. In the Application Explorer, open the Graphics folder.

3. Right-click the graphic display that contains the multistate


indicator objects that you want to update, and then click Import.

4. Select an XML file, and then click Open.

The settings for the multistate indicator objects defined in the file
are imported into the corresponding multistate indicator objects in
the Graphic Display.

Error log file


Errors that occur while importing the XML file are logged to a text file
called GraphicsImport.txt.

„ For stand-alone applications, the file is located in the following


folder:

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


Enterprise\SE\HMI Projects\<Application Name>

Importing and exporting XML files ■ F–3


„ For distributed applications, the file is located in a folder of the
same name as the HMI server in which the graphic display is
located, in the current user’s Windows Temp folder. For example,
in the case of Windows XP, if the HMI server is called Ingredients,
and the current user is DLSing, file is located in the folder:

C:\Documents and Settings\DLSing\Local Settings\


Temp\Ingredients

If the GraphicsImport.txt file already exists, it is overwritten.

Multistate Indicator XML file structure

The multistate indicator XML file is an RSView graphic XML


document. The root element, also called the document element, of the
graphic XML document is the graphic element. It is called gfx and it
represents the graphic display that contains the multistate indicator(s).
An XML document may contain only one root element. All other
elements in the document must be contained, or nested, within the root
element.

A sample XML file is provided in Help. Use this sample file for
information about the layout and hierarchy of elements in the XML
file.

You can copy the text in Help into another application, and then save
the file in Unicode format, with a .xml extension.

Alternatively, a sample file called MultistateIndicatorImport.xml is also


included in the folder, C:\Program Files\Rockwell Software
\RSView Enterprise.

Syntax, attributes, and elements

The syntax for specifying an attribute is: attribute name="value".

Attribute values can be enclosed in either single or double quotes.

F–4 ■ RSView Supervisory Edition User’s Guide


Element names are case-sensitive. All element names in a multistate
indicator XML document are lower case.

The root or document element in an XML document contains all other


elements.

Specifying attributes in the correct order

XML attributes correspond to the properties of a graphic object.


When you import an XML file, the attributes in it are applied to the
objects in the display in the order in which they are specified in the file.
If you do not keep this in mind when editing the XML file, you can get
unexpected results.

For example, if a multistate indicator has a border style set to line, and
a shape set to circle, and then you import an XML file to change the
border style to raised and the shape to rectangle, the object could be
displayed as a rectangle with the border style set to line.

This happens if the border style is specified before the shape in the
XML file. Because border style is specified first, it is applied to the
object when the object is still a circle. Since a circle cannot have a raised
border style, the change is not made. After that, the shape is changed
to a rectangle.

Version and encoding

The first line of every XML file contains the xml version, and encoding
attributes.

Make sure the encoding attribute matches the format that you use
when you save the file. For example, if the original file was saved as
UTF-8 and you plant to save it with UTF-16 encoding, make sure the
first line specifies:

attribute="UTF-16"

Importing and exporting XML files ■ F–5


The gfx element
In an XML document the start of an element, is marked this way:
<element name>. The end is marked this way: </element name>. The
start and end of the gfx element look like this in an XML document:

<gfx>
.
.
.
</gfx>

The msi element


The element that represents a multistate indicator in the XML file is
called msi. If a graphic display includes multiple multistate indicator
objects, use the id attribute of the msi element to differentiate between
them. The syntax for specifying an attribute for an element is:
attribute="value". The value for the id attribute is the name the object
was given in the Graphics editor. The attribute must be enclosed in
single or double quotes.

The defs element


The multistate indicator XML document contains an element called
defs that contains definitions for elements that can be referenced in
multiple msi elements. This lets you modify certain attributes in one
place. For example, defs contains an element named font, that contains
all the attributes needed to define a font. This is referenced by the font
id attribute within the msi elements. For this reason it is nested in the
gfx element at the same level as the msi elements, not within an msi
element.

F–6 ■ RSView Supervisory Edition User’s Guide


Multiple multistate indicators in the same file
The basic structure for an XML document for two multistate
indicators, called Indicator1 and Indicator2, with font element that
both msi elements use, would look like this:

<gfx>
<defs>
<font id="New Font" font family="Verdana"/>
</defs>
<msi id="Indicator1" >
.
</msi>
<msi id="Indicator2" >
.
</msi>
.
</gfx>

You can specify multiple attributes for an element, and have multiple
elements. For a more detailed XML example, see the sample multistate
indicator XML document in Help.

Each object in a graphic display must have a unique name. If your


graphic display includes multiple multistate indicator objects, the
object’s name allows you to differentiate among the objects in a single
XML file.

If you include settings for an object whose name does not match one
of those in the graphic display, the settings for that object are not
imported. Settings for all other objects in the file whose names do
match those in the graphic display are imported.

Importing and exporting XML files ■ F–7


Multistate Indicator element
This element is called msi in the XML file. The msi element must be
contained within a gfx element.

The attributes of this element correspond to the settings in the General


tab of the Multistate Indicator Properties dialog box.

In the following lists of attributes, text in braces <> indicates a data


type, such as string, int, float, and so on. Text separated by a vertical bar
| indicates that only one of the values is allowed.

Multistate indicator element (msi) attributes

backstyle = transparent | solid

borderstyle = raisedinset |none | raised |inset |line

borderusesbackcolor = true | false

borderwidth = <int>

description = <string>

height = <int>

id= <string> – Must be the name of the object you are modifying.
Each multistate indicator object must have a unique ID.

numstates = <int>

shape = rectangle | circle | ellipse

triggertype = value | lsb

visible = true | false

width = <int>

x = <int>

y = <int>

F–8 ■ RSView Supervisory Edition User’s Guide


States element
This element is called msi-state in the XML file. The msi-state
element must be contained within an msi-states element.

The attributes of this element correspond to the settings in the States


tab of the Multistate Indicator Properties dialog box.

States element (msi-state) attributes

= <color> – Type the # character followed by the


backcolor
RRGGBB value of the color. See Help for these values.

blink = true | false – Type the # character followed by the RRGGBB


value of the color. See Help for these values.

= <color> – Type the # character followed by the


bordercolor
RRGGBB value of the color. See Help for these values.

patterncolor = <color> – Type the # character followed by the


RRGGBB value of the color. See Help for these values.

patternstyle = none | dots | checks | small-box | med-box | large-


box | vert-line | wide-vert-line | horz-line | wide-horz-line | right-
diag | wide-right-diag | left-diag | wide-left-diag | hatch | bricks |
ovals | diamonds | scales | waves

stateid = <string> – Must be a number between 0 and 1999, or the


string, Error.

value = <int>

Importing and exporting XML files ■ F–9


Font Element
This element is called font in the XML file. The font element must be
located within a defs element.

The attributes of this element correspond to the font settings in the


States tab of the Multistate Indicator Properties dialog box.

Font element attributes

id = <string> – Type a short name that you can use when referring to
the font element later in the XML file. For example, you can use a font
ID called BigFont to refer collectively to the values of the font-size and
font-weight attributes. See also “Caption element” on page F-13.

font-family = <string>

font-size = <int>

font-style = normal | italic

font-weight = normal |bold

text-decoration = none|underline|line-though|
underline; linethrough – To specify multiple values for the text-
decoration attribute, separate the values with semi-colons. This is the
only attribute for which you can specify multiple values.

F–10 ■ RSView Supervisory Edition User’s Guide


Connection Element
This element is called connection in the XML file. The connection
element must be located within a connections element.

The attributes of this element correspond to the settings in the


Connections tab of the Multistate Indicator Properties dialog box.

Connection element attributes

name = <string>

expr = <string>

Animation Element
This element is called animation in the XML file. The animation
element must be contained within an animations element.

The attributes of this element correspond to the settings for visibility


animation that are attached to the multistate indicator object.

Animation element attributes

expr = <string>

type = visibility

visible = true | false

Importing and exporting XML files ■ F–11


Image Element
This element is called image in the XML file. The image element must
be located within an msi-state element.

The attributes of this element correspond to the image settings in the


States tab of the Multistate Indicator Properties dialog box.

Image element attributes

alignment = top-left | top-right | mid-left | mid-center | mid-right |


bottom-left |bottom-center | bottom-right

= <color> – Type the # character followed by the


backcolor
RRGGBB value of the color. See Help for these values.

backstyle = transparent | solid

blink = true | false

color = <color> – Type the # character followed by the RRGGBB


value of the color. See Help for these values.

name = <string> – The name of the Image component, as it appears


in the HMI project.

scaled = true | false

F–12 ■ RSView Supervisory Edition User’s Guide


Caption element
This element is called caption in the XML file. The caption element
must be located within an msi-state element.

The attributes of this element correspond to the caption settings in the


States tab of the Multistate Indicator Properties dialog box.

Caption element attributes

text = <string>

alignment = top-left | top-right | mid-left | mid-center | mid-right |


bottom-left |bottom-center | bottom-right

= <color> – Type the # character followed by the


backcolor
RRGGBB value of the color. See Help for these values.

color = <color> – Type the # character followed by the RRGGBB


value of the color. See Help for these values.

backstyle = transparent | solid

blink = true | false

font = <string> – Type the # character, followed by the font ID


defined in the font section (for example, #BigFont).

wordwrap = true |false

Importing and exporting XML files ■ F–13


Index
Symbols Active macro
See On Active macro
.bmp files „ 16-46, 16-47 ActiveX objects „ 16-2, 17-2, 17-242
.cab files „ 17-247 attaching animation „ 18-2, 18-39
.clp files „ 16-46
.dat files „ 13-1, 13-3
common properties „ 17-25
.dxf files „ 16-46 deploying automatically „ 17-247
.gif files „ 16-46 editing „ 18-40
.jpg files „ 16-46 events „ 18-44
.mgl files „ 16-46 methods „ 18-42, 18-43, A-43
.obf files „ 13-4
.pcx files „ 16-46 naming „ 18-40
.tif files „ 16-46 navigating to „ 17-27
.wav files „ 11-26, A-26, A-47 properties „ 18-40, A-43
.wmf files „ 16-46 using with VBA code „ 17-245, 18-45
.xml ActiveX Toolbox „ 17-245
file structure for multistate indicators „ F-4 Activity commands
.xml files „ F-1 Remark „ A-53
= (Equal) command „ A-13 Activity logging
and memory tags „ 9-20 See FactoryTalk Diagnostics
??? in input fields „ 17-108, 17-114, 17-225
Addressing syntax
[tag] parameter „ 18-54
See Syntax, DDE communications
as placeholder „ 18-8
See Syntax, OPC communications
for display keys „ 18-62
Administration
for object keys „ 18-48
See System administration
using to acknowledge alarms „ A-16 Administration Console
with the Identify command „ A-40 See RSView Administration Console
Advanced objects „ 17-26, 17-169

A See also Interactive objects


Alarm banner „ 11-7, 11-10
Abort command „ A-15 alarm label in „ 11-33, 11-38
Absolute references „ 5-10
Alarm bells
in commands „ A-6 setting up „ 11-25
syntax „ 5-10, 5-11 Alarm buffer zone
to tags „ 8-19 See Alarm deadband
Access Alarm commands
See Microsoft Access Acknowledge „ 11-12, A-16
Acknowledge bit „ 11-15, 11-36, 11-40
AcknowledgeAll „ 11-12, A-17
Acknowledge command „ 11-12, A-16
AcknowledgeAll command „ 11-12, A-17 AlarmEvent „ A-17
Activation AlarmLogNewFile „ A-19
redundancy „ 25-19 AlarmLogOff „ A-20

Index ■
I–1
AlarmLogOn „ A-20 system default „ 11-27
AlarmLogRemark „ 11-79, A-21 user default „ 11-28
AlarmLogSendToODBC „ A-23 Alarm messages „ 11-29
AlarmOff „ 11-10, 11-85, A-23 setting up „ 11-26, 11-34, 11-39
AlarmOn „ 11-17, 11-81, 11-84, A-24 Alarm monitoring „ 11-1, 11-42

AlarmPrintOff „ 11-81, A-24 acknowledge bit „ 11-15, 11-36, 11-40


AlarmPrintOn „ 11-81, A-25 alarm events „ 11-17
handshake bit „ 11-16, 11-36, 11-41
Execute „ 11-74
handshaking
HandshakeOff „ A-38
switching on „ 11-17
HandshakeOn „ 11-17, A-39
Identify „ 11-75, A-40 starting
setting up alarms with „ 11-35, 11-40 stopping „ 11-84
starting and stopping „ 5-27, 6-11, 11-84
Silence „ A-57
stopping „ 11-85
SilenceAll „ A-57
suppressing „ 11-81
SuppressOff „ A-57
Alarm printing
SuppressOffAll „ A-58 redundancy „ 11-23
SuppressOn „ 11-12, 11-81, 11-82, A-58 suppressing „ 11-81
Alarm deadband „ 11-3, 11-5, 11-36
Alarm Setup editor „ 11-20, 11-21
Alarm events „ 11-17
Alarm severity „ 11-7
Alarm faults „ 11-5
Alarm log files „ 11-8, 11-42, 11-55
setting up „ 11-24, 11-33, 11-38
Alarm states „ 11-7, 11-37
adding remarks at run time „ 11-30 Alarm summary „ 11-9
and third-party applications „ 11-8 creating „ 11-57
contents of „ 11-9 displaying „ 18-59
creating „ 11-45 filtering data „ 11-67
creating on demand „ 11-47 setting up
deleting „ 11-48 alarm label „ 11-33, 11-38
exporting to ODBC „ 11-51 buttons „ 11-63
logging destinations „ 11-44 colors „ 11-7, 11-61
maximum number of „ 11-55
fonts „ 11-61
naming „ 11-55
headings „ 11-59
viewing „ 11-56
Alarm Log Setup „ 11-43 showing areas „ 11-67, 11-80
Alarm Log Viewer „ 11-9, 11-56 sorting data „ 11-67, 11-73
Help „ 11-57 using commands „ 11-77, 11-79
Alarm logging „ 11-42 using wildcards „ 11-69
See also Alarm monitoring Alarm system tags „ 11-11
access permissions „ 11-53, 11-54 Alarm thresholds „ 11-2, 11-4, 11-32
editing „ 11-52 crossing „ 11-22
AlarmEvent command „ A-17
redundancy „ 11-23 AlarmLogRemark command „ 11-30, A-21
to ODBC database „ 11-49 using with Execute button in alarm summary
Alarm message types „ 11-8, 11-27 „ 11-79
in alarm „ 11-34, 11-38 AlarmLogSendToODBC command „ A-23
out of alarm „ 11-36, 11-40 AlarmPrintOff command „ 11-81, A-24

I–2 ■
RSView Supervisory Edition User’s Guide
AlarmPrintOn command „ 11-81, A-25 copying without copying objects „ 18-68
Alarms Current [Tag] parameter „ 18-54
acknowledging „ 11-12, 11-15 defining range of motion „ 18-11
adding to tags „ 9-25, 11-2
display keys „ 18-60
ALM_ACK expression
finding „ 18-65
changing default behavior „ 11-14
finding objects animated by tags „ 16-14
assigning sounds to „ 11-25
finding tags „ 18-65
bells „ 11-25
for grouped objects „ 16-28
charting in trends „ 19-29, 19-38
grouped objects „ 18-65
crossing thresholds „ 11-22
min. and max. values „ 18-9
expressions in „ 11-13
object keys „ 18-46, 18-49
identifying „ 11-35, 11-40, 11-75
logging „ 11-42 Object Smart Path „ 18-6, 18-11
locally „ 11-44 precedence in grouped objects „ 18-65
tags and placeholders „ 18-7
to ODBC „ 11-49
testing „ 18-6, 19-63
max. update rate „ 11-23
using commands for actions „ 18-8
messages „ 11-26, 11-34, 11-39
planning „ 3-8 using VBA code „ 18-39
running custom programs „ 11-80 viewing in Object Explorer „ 16-13
Animation dialog box „ 18-3
setting up „ 11-4, 11-20
Animation types „ 18-1
for analog tags „ 11-32 color „ 11-10, 18-14
for digital tags „ 11-37 in grouped objects „ 18-65
using Tags editor „ 11-2, 11-20, 11-31 fill „ 18-20
severity „ 11-24 in grouped objects „ 18-65
starting „ 11-84
height „ 18-27
stopping
horizontal position „ 18-22
starting „ 11-85
horizontal slider „ 18-34
summary of steps „ 11-20
OLE verb „ 15-16, 18-37
suppressing „ 11-12, 11-81, 11-82
rotation „ 18-29
viewing suppressed alarms „ 11-82
touch „ 18-33
suppressing printing „ 11-81
vertical position „ 18-23
system tags „ B-1
vertical slider „ 18-36
using tags for „ 8-5
ALM_ (alarm) functions „ 11-13, 11-14, 20-13
visibility „ 11-10, 18-13
Analog HMI tags width „ 18-25
alarms „ 11-32 Application commands
alarms for „ 9-25, 11-2, 11-31 AppAbort „ A-25
alarms when crossing thresholds „ 11-22 AppStart „ A-25
and trends „ 19-37 Application Explorer „ 2-5, 2-8, 5-14, 6-5

setting up „ 9-13 components „ 2-13


Animation „ 18-1 editors „ 2-10
ActiveX objects „ 18-39 folders „ 2-10
changing „ 18-67 importing images „ 17-11
copying objects „ 18-67 undocking „ 2-9

Index ■
I–3
Application files home area „ 5-9, 8-20
deleting „ 2-17 how to use „ 5-16
Application Manager „ 5-14, 5-15, 6-6, 6-7, max. number of HMI servers „ 5-18
27-3, 28-2
Applications
removing „ 5-18
administering at run time „ 28-2 showing in alarm summaries „ 11-67, 11-78,
11-80
distributed „ 5-1, 5-4
tag references „ 8-19
creating „ 5-13
Arithmetic operators „ 20-8
deploying „ 26-1 Arrow graphic object „ 17-170
FactoryTalk Directory location „ 4-6 Asynchronous execution
home area „ 5-9 = (Equal) command „ A-13
max. number of HMI servers „ 5-17 Set command „ A-54
Auto-repeat
number of displays „ 5-22
for keys „ 17-168
redundancy „ 25-13
renaming „ 5-14
root area „ 5-9
B
running as stand-alone „ 25-13 Backspace key „ 17-160
Bar graphs „ 17-150
localizing
indicator tag „ 17-143
see Localizing applications
Beep command „ A-26
opening „ 2-2 Bells for alarms „ 11-25
recently used „ 2-3 Bitwise operators
planning „ 3-1, 3-13 AND, & „ 20-10
running Samples „ 2-4 inclusive OR, | „ 20-10
securing „ 15-19 Browse button „ 2-19
Built-in functions
stand-alone „ 6-1
file „ 20-19
backing up „ 28-2
math „ 20-19
copying „ 27-3
security „ 20-20
creating „ 6-4 tag „ 20-13
deleting „ 6-7 time „ 20-15
deploying „ 27-1 Buttons „ 17-37
FactoryTalk Directory location „ 4-5 editing „ 17-45
importing projects „ 6-5 highlight
in redundancy „ 25-13 enabling or disabling „ 17-39
number of displays in „ 6-8
renaming „ 6-6 C
restoring „ 28-2 CABARC.exe „ 17-247
stand-alone vs. distributed „ 5-8 Cache
Windows „ A-25 creating for OPC data servers „ 7-10
Arc graphic object „ 17-17 synchronizing for OPC data servers „ 7-11
Areas „ 5-4, 5-8 Calling methods „ 18-43
adding „ 5-18 Check syntax
application root „ 5-9 derived tags „ 10-3
application root area „ 5-9 expressions „ 20-4

I–4 ■
RSView Supervisory Edition User’s Guide
Circle graphic object „ 17-15 Communications
Client commands See also DDE communications
DisplayClientOpen „ 26-18, 27-8 See also OPC communications
Client key commands errors „ 20-13
Key 23-15
„ planning „ 3-6
Client keys „ 23-5, 23-12 setting up „ 7-1
creating „ 23-12 Component names
precedence among key types „ 23-7 and /P parameter „ 2-18
running a key file „ 23-14 and spaces „ 2-18
Client Keys editor „ 23-12 long „ 2-18
Clients maximum length of „ 2-18
See RSView SE Client Components
Code window absolute references „ 5-10
getting help „ 24-11 adding „ 2-14
Color copying „ 2-14
in graphic displays „ 16-31, 16-68 deleting „ 2-17
animating „ 11-10, 18-14 in Application Explorer „ 2-13
in trends „ 19-13, 19-14, 19-15 naming „ 2-18
Color animation „ 18-14 opening „ 2-14
COMM_ERR function „ 20-13 relative references „ 5-10, 6-2
Command execution „ A-4 removing „ 2-17
Command line renaming „ 2-16
using „ A-10 starting manually „ 26-9, 27-3
Command Wizard „ 2-20, A-10 startup „ 5-26, 6-10
Commands „ A-1
stopping manually „ 26-9, 27-4
See also individual command entries Constants
absolute and relative references „ A-6 in expressions 20-7
„
adding alarm data „ 11-77 Context menus „ 2-19
assigning security to „ 15-13 using in graphics „ 16-15
attaching to ActiveX events „ 18-44 using in trends „ 19-62
executed at client „ A-5 Control
executed at server „ A-4 See Animation
Control list selectors „ 17-172, 17-177
in buttons „ 17-41 differences from piloted control list selectors
in editors „ 2-20 „ 17-186
in events „ 14-1 Enter-key handshaking „ 17-175
in macros „ 2-20 indicator tag „ 17-174
placeholders in „ 22-2, A-2 navigating to „ 17-27
precedence over macros „ A-4 value tag „ 17-174
redundancy wrap around „ 17-181
See Redundancy Control network redundancy
securing „ 15-13 See Redundancy
ControlLogix processor „ 8-3
startup and shutdown „ 16-69 Crystal Reports
using in graphic displays „ 18-8 See Seagate Crystal Reports
using with alarms „ 11-74 Current [Tag] parameter „ 18-54, 18-62

Index ■
I–5
D starting and stopping „ 5-27, 6-11, A-28,
A-29
Data log files stopping „ 13-39
and third-party software „ 13-1
when to log data „ 13-29
creating „ 13-21 Data logging commands
deleting „ 13-26 DataLogChangeRate „ A-26
max. at run time „ 13-1
DataLogMergeToPrimary „ 13-20, A-27
naming „ 13-3
DataLogNewFile „ 13-25, A-28
redundancy
DataLogOff „ 13-39, A-28
See Redundancy
DataLogOn „ 13-38, A-29
storage format „ 13-2
DataLogRenameFile „ A-29
ODBC „ 13-1, 13-4
Data log models „ 13-1
DataLogSnapshot „ 13-32, 14-1, A-30
editing „ 13-35 DataLogSwitchBack „ 13-19, A-31
setting up „ 13-7 Data server tags
using in trends „ 19-30 Tags „ 8-1, 9-1
Data Log Models editor „ 13-5, 13-6 Data servers „ 5-4, 7-4

Data logging deploying „ 26-14, 27-4


access permissions „ 13-18, 13-19 how to use „ 5-16, 6-7, 7-5
and events „ 13-32, 14-1 load balancing „ 5-16, 6-7
changing rate at run time „ 13-37, A-26 OPC
choosing data „ 13-34 adding „ 7-7
creating expressions „ 20-2 creating cache „ 7-10
editing „ 13-35
redundancy „ 7-9
log triggers „ 13-29
ODBC data source removing „ 7-17
creating new „ 13-5, 13-8 setting up „ 7-8
using existing „ 13-4, 13-8 synchronizing cache „ 7-11
ODBC database tables redundancy „ 5-7, 5-17, 6-8
creating new „ 13-5 See Redundancy
indexing „ 13-11 removing „ 7-17
setting up manually „ 13-10 RSLinx
using existing „ 13-4 adding „ 7-12
on demand „ 13-31, 13-33, A-30 Prog ID „ 7-9
paths „ 13-13 redundancy „ 7-14
backup „ 13-12 removing „ 7-17
moving data between „ 13-20, A-27 setting up „ 7-13
switching at run time „ 13-19, 13-36, tags „ 8-1
A-31 using in trends „ 19-17
planning „ 3-8 Data source for tags „ 9-2, 9-18
redundancy Data types for HMI tags „ 9-15
See Redundancy Date and time „ B-2
setting up „ 13-1, A-29 in graphic displays „ 17-228
starting „ 13-38 in trends „ 19-17, 19-23, 19-43

I–6 ■
RSView Supervisory Edition User’s Guide
DDE communications „ C-2 and trends „ 19-37
and RSServer „ C-1 setting up „ 9-16
poll rate „ C-4 Disk space
RSView as client monitoring „ 11-47, 13-21, 28-4
assigning server to RSView tags „ C-4 Display cache „ 16-62, 23-4
Display command „ A-33
setting up „ C-3
and graphic displays „ 16-66, 16-67, 16-74
setting up „ C-1
and key lists „ 18-65
syntax „ C-4
and parameter files „ 16-52, 16-55
Deadband for alarms „ 11-3, 11-5, 11-36
Define command „ A-9, A-31 and trends „ 19-64
Deploying applications Display keys „ 23-5
See Applications, distributed creating „ 18-60
See Applications, stand-alone editing „ 18-62
Derived tag commands precedence among key types „ 23-7
DerivedOff „ A-32 Display list selectors „ 17-206
DerivedOn „ 10-7, A-32 navigating to „ 17-27
Derived tags „ 10-1 Display Settings dialog box „ 16-57
DisplayClientOpen command „ 26-18, 27-8
checking syntax „ 10-3
Displays
creating „ 10-5
See Graphic displays
creating expressions „ 20-2 Displays editor
editing „ 10-6 See Graphic Displays editor
evaluation interval for „ 10-4 Distributed applications
max. components at run time „ 10-2 See Applications
max. in a component „ 10-2 Documentation for RSView SE „ P-1
max. update rate „ 10-4 Download command „ 17-115, 17-226, A-36
DownloadAll command „ 17-115, 17-226, A-37
redundancy
Drawing objects
See Redundancy
See Graphic object types
starting and stopping processing „ 5-27, 6-11,
10-7
Derived Tags editor „ 10-2 E
DeskLock „ 15-20
Edit Display mode „ 16-9, 19-63
Device HMI tags „ 9-2
Editors „ 2-10
DDE communications „ C-3 Alarm Log Viewer „ 11-9
OPC communications „ 9-18 Alarm Setup „ 11-20, 11-21
Diagnostics List „ 2-6, 12-17
Client Keys „ 23-12
clearing messages „ 2-7, 12-19
Data Log Models „ 13-5, 13-6
hiding „ 2-8
Derived Tags „ 10-2
moving „ 2-6
Displays „ 16-2
resizing „ 2-6
Events „ 14-2
showing „ 2-8
Diagnostics Setup „ 12-7
Graphic Libraries „ 16-50
Diagnostics Viewer „ 12-20 hints for working in „ 2-19
Digital HMI tags Libraries „ 16-50
alarms „ 11-37 Local Messages „ 17-235
alarms for „ 9-25, 11-7 Macros „ 22-1

Index ■
I–7
Parameters „ 16-53 creating expressions „ 20-2
Recipes „ 17-222 creating expressions for „ 14-6
Secured Commands „ 15-12 editing „ 14-6
Suppressed List „ 11-12, 11-82, 11-83 evaluation interval for „ 14-3
Tags „ 9-4, 11-20, 11-31 for on-demand logging „ 13-32
tags „ 11-31 max. components at run time „ 14-1
User Accounts „ 15-6 max. in a component „ 14-1
Electronic signatures „ 17-248 max. update rate „ 14-3
Ellipse graphic object „ 17-15
Embedded variables „ 21-1 overview „ 14-2
copying „ 21-9 redundancy
creating „ 21-2 See Redundancy
date and time starting and stopping processing „ 5-27, 6-11,
creating „ 21-7 14-7
Events editor „ 14-2
displaying at run time „ 21-11
Execute button
syntax „ 21-8 in alarm summaries „ 11-74, 11-77
deleting „ 21-9 Execute command „ 11-74
displaying at run time „ 21-10 Expressions „ 2-21, 20-1
editing „ 21-9 alarm events in „ 11-19
numeric and animation „ 18-8
creating „ 21-4 assigning to graphic objects
displaying at run time „ 21-10 using the Property Panel „ 16-38
syntax „ 21-5 built-in functions in „ 20-12
string checking syntax „ 20-4
creating „ 21-5 constants in „ 20-7
displaying at run time „ 21-11 copying „ 20-4
syntax „ 21-6 creating „ 20-2
time and date evaluation order „ 20-21
creating „ 21-7 formatting „ 20-5
displaying at run time „ 21-11 if–then–else logic „ 20-23
syntax „ 21-8 in alarms „ 11-13
types of values „ 21-2 in data logging „ 13-32
updating at run time „ 21-10 in derived tags „ 10-6
End key „ 17-160 in events „ 14-6
Enter key „ 17-160 in the = (Equal) command „ A-13
handshaking „ 17-174, 17-175, 17-176, in trends „ 19-29
17-192, 17-193, 17-194 operators in „ 20-8
Event commands
evaluation order of „ 20-21
EventOff 14-8, 25-8, A-37
„

EventOn 14-7, 25-8, A-37


„
tags and placeholders in „ 9-3, 18-4, 20-6
Eventbased alarms „ 11-17 using to report communication errors „
Events „ 14-1 20-13
ActiveX „ 18-44 using to retrieve alarm information „ 11-13
creating „ 14-1, 14-4 viewing in Object Explorer „ 16-13

I–8 ■
RSView Supervisory Edition User’s Guide
F Failure
See Redundancy
F1 key File locations
precedence „ 23-8 graphic libraries „ 16-49
FactoryTalk Diagnostics „ 12-1 File names
See also Diagnostics List See also Component names
access permissions for services „ 12-15, long
12-16 for data logs „ 13-3
audiences „ 12-4 short
buffering messages „ 12-12 for alarm logs „ 11-56
categories „ 12-3 File types
clearing the log file manually „ 12-10 graphics
destinations „ 12-2 importing „ 16-46
local log file „ 12-8 using bitmaps „ 16-47
logging path „ 12-8 log „ 13-2
logging to ODBC database „ 12-10 .dat „ 13-3
message audiences „ 12-4 data log „ 13-1
message buffering „ 12-12 .obf „ 13-4
message categories „ 12-3 ODBC
message routing „ 12-3 alarms „ 11-51
message severities „ 12-4 data log „ 13-4
ODBC data source „ 12-13 FactoryTalk Diagnostics „ 12-10
overview of steps „ 12-6 sound
routing „ 12-3 .wav „ 11-26, A-26, A-47
routing messages „ 12-14 Fill animation „ 18-20
setting up „ 12-6, 12-7 Filter
severities „ 12-4 alarm summaries „ 11-67
size of log file „ 12-9 removing from tags „ 8-18
tag writes „ 12-5 tags „ 8-17
viewing log files „ 12-19 FlushCache command „ 16-74, A-37

Windows CE messages „ 12-15 and trends „ 19-65


FactoryTalk Diagnostics log files executing shutdown command with „ 16-69
Folders „ 9-4
and third-party applications „ 12-1
FactoryTalk Diagnostics Viewer
adding tags to „ 9-8
See Diagnostics Viewer. adding to Tag Browser „ 8-12
FactoryTalk Directory „ 1-2, 4-1, 5-2 creating „ 9-6
changing „ 26-4 refreshing list in Tag Browser „ 8-14
HMI server names „ 5-19 Fonts

redundancy „ 4-3, 4-8, 5-5 guidelines for choosing „ 17-2


in alarm summary „ 11-61
setting up „ 4-4
in graphic displays „ 17-2
specifying location „ 4-6, 4-7, 4-13
FactoryTalk Live data „ 8-2
resized to fit object „ 16-20
Fail-over substitution at run time „ 17-3
See Redundancy in trends „ 19-13, 19-24

Index ■
I–9
Freehand graphic object „ 17-17 color „ 16-31
Functions creating „ 16-1, 17-1
See Built-in functions creating a background „ 16-45
creating a template „ 16-58
G creating templates „ 3-9
Gauges „ 17-141, 17-144
displaying alarm information in „ 11-10
indicator tag „ 17-143 displaying in background „ A-33
Global key commands downloading values from „ 17-107, 17-114
Key „ A-44 grid „ 16-6
Graphic display commands improving performance „ 16-74
Abort „ A-15 max. update rate of tags „ 16-64
Display „ A-33 moving among „ 23-1, 23-3, A-50
and key lists „ 18-65 planning „ 3-9
and parameter files „ 16-52, 16-55 positioning „ 16-67, A-34
caching „ 16-74, 19-64 preventing scroll bars „ 16-65
positioning „ 16-67 printing „ 2-21, 16-75, A-49
sizing „ 16-66 quantity in application „ 5-22, 6-8
reducing call-up time „ 16-62, 16-74, A-34
Download „ 17-115, 17-226, A-36
replacing text „ 16-39
DownloadAll „ 17-115, 17-226, A-37
running multiple copies „ 16-61
FlushCache „ 16-74, A-37
securing „ 15-14, 16-67
and trends „ 19-65
sizing „ 16-64, 16-66, A-34
executing shutdown command with „
specifying run-time appearance „ 16-63
16-69
startup and shutdown commands for „ 16-69
NextPosition „ 18-49, A-45 testing „ 16-9
NextWindow „ A-45 animation „ 18-6, 19-63
Position „ 18-49, A-48
types „ 16-60
PrevPosition „ 18-49, A-48
uploading recipes to „ 17-221, 17-225
PrevWindow „ A-48
uploading values to „ 17-107, 17-114
PrintDisplay „ 16-75, A-49
using parameter files „ 16-54
PullForward „ A-50
using parameter files in „ A-34
PushBack „ A-50 Graphic Displays editor „ 16-2
RecipeRestore „ 17-226, A-52 Graphic libraries
RecipeSave „ 17-227, A-52 See Libraries
ScreenPrint „ 16-75, A-53 Graphic Libraries editor „ 16-50
SendKeys „ A-53 Graphic object types „ 17-1
SetFocus „ 16-61, A-56 ActiveX „ 17-242, 18-39
Upload „ 17-115, 17-227, A-59 common properties „ 17-25
UploadAll „ 17-115, 17-227, A-60 advanced objects „ 17-1, 17-26, 17-169
Graphic displays „ 16-1 alarm summary „ 11-10, 11-58
background color „ 16-68 arc „ 17-17
caching „ 16-62, 23-4 arrow „ 17-170
with the Display command „ 16-74, bar graph „ 17-150
A-33 circle „ 17-15

I–10 ■
RSView Supervisory Edition User’s Guide
control list selector „ 17-172, 17-177 recipe field „ 17-221
display list selector „ 17-206 rectangle „ 17-15
drawing objects „ 17-2 rounded rectangle „ 17-14
changing properties „ 17-20 scale „ 17-154
reshaping „ 17-18 square „ 17-15
text „ 17-2 string display field „ 17-105
ellipse „ 17-15 string display fields „ 11-10
freehand „ 17-17 string input field „ 17-107
gauge „ 17-141, 17-144 electronic signatures „ 17-249
graph „ 17-141, 17-150 tag label „ 17-204
image „ 17-6 time and date display „ 17-228
indicators „ 17-117 trend „ 19-1, 19-16
list „ 17-134 common properties „ 17-25
multistate „ 17-120 wedge „ 17-17
Graphic objects „ 17-1
importing XML „ F-3
aligning „ 16-22
troubleshooting XML „ F-5
XML file structure „ F-4 animating
See Animation
symbol „ 17-128
arranging „ 16-20, 16-24
key
keys „ 17-160 assigning tags
using the Property Panel „ 16-38
line „ 17-16
changing properties „ 17-20
local message display „ 17-215
color „ 16-31
local messages „ 17-231
common properties
numeric and string „ 17-103
changing properties „ 17-22
electronic signatures „ 17-249
converting „ 16-47
numeric display field „ 17-103
to wallpaper „ 16-45
numeric display fields „ 11-10
numeric input field „ 17-107 copying from other Windows applications „
16-2
electronic signatures „ 17-249
creating expressions „ 20-2
OLE objects „ 15-16, 17-238
cutting and pasting „ 16-16
panel „ 17-12
deselecting „ 16-10
piloted control list selector „ 17-186, 17-194
duplicating „ 16-18
polygon „ 17-16
editing „ 16-9, 16-29
polyline „ 17-16
editing properties „ 16-34
push buttons „ 17-29
embedded variables in „ 21-2
buttons „ 17-37
flipping „ 16-25
interlocked „ 17-85
formatting „ 16-31
latched „ 17-65 grid „ 16-6
maintained „ 17-55 grouping and ungrouping „ 16-28
momentary „ 17-45 importing „ 16-46
multistate „ 17-74 line properties „ 16-33
ramp „ 17-94 methods „ 18-42

Index ■
I–11
moving „ 16-15 Help
naming „ 16-43, 17-24, 18-40 activation „ 1-5
navigating among „ 17-27 alarm log viewer „ 1-5, 11-57
pattern styles „ 16-32 Code window „ 24-11
positioning „ 16-21, 16-22, 16-24 RSView SE Client object model „ 24-10
with grid „ 16-6 technical support „ 1-6
replacing text „ 16-39 VBA „ 24-13
reshaping „ 17-18, 17-45 VBA Object Browser „ 24-11
Help command „ A-39
resizing „ 16-19
Help files
rotating „ 16-26 creating for displays „ 18-57
selecting „ 16-10 Highlight
setting up ActiveX objects „ 17-28
using the Property Panel „ 16-35 enabling or disabling „ 16-71
spatial properties for buttons „ 17-39
setting up „ 17-22 trends „ 17-28, 19-13
stacking „ 16-21 HMI clients „ 5-2
testing states „ 16-42 HMI projects „ 5-2
HMI servers „ 5-2
using keys to work with
adding „ 5-19
See Special keys
alarm monitoring „ 5-27, 6-11, 11-84, 11-85
using tags and placeholders „ 17-27
allowing clients to connect „ 26-11
using with object keys „ 18-46
attaching to existing „ 5-21
visibility „ 17-22
components stop automatically „ 27-8
Graphs
See Bar graphs computer name „ 5-24
Grid copying „ 5-20
in graphic displays „ 16-7 creating „ 5-20
in trends „ 19-45, 19-49 data logging „ 5-27, 6-11
Grouped objects deleting „ 5-30
animation „ 18-65 derived tag processing „ 5-27, 6-11
Group objects description „ 5-23, 6-9
setting up in the Property Panel „ 16-37 event processing „ 5-27, 6-11
how to use „ 5-16
H importing projects „ 5-21
load balancing „ 5-16
Handshake bit „ 11-16, 11-36, 11-41 load on demand „ 26-19
HandshakeOff command „ A-38 max. number in application „ 5-17
HandshakeOn command „ 11-17, A-39
max. number of displays „ 5-24, 6-10
Handshaking
for Enter key „ 17-174, 17-175, 17-192, max. number of servers „ 5-18
17-193 moving files „ 26-4
resetting „ 17-176, 17-194 name „ 5-23, 6-9
switching on „ 11-17 naming „ 5-19
Hardware failure number of displays used „ 5-24, 6-9
See Redundancy On Active macro „ 5-28
Height animation „ 18-27 On Shutdown macro „ 5-28, 6-12

I–12 ■
RSView Supervisory Edition User’s Guide
On Standby macro „ 5-28 placing in graphic displays „ 17-8
primary „ 5-25 settings „ 17-10
project file „ 5-24, 6-9 Index numbers „ 17-25, 18-49
redundancy „ 5-5, 5-17, 5-21, 5-25 and recipe files „ 17-222
removing „ 5-29 changing „ 18-51
secondary „ 5-25 checking „ 18-50
setting up „ 5-22, 6-8 removing „ 17-28
showing in Tag Browser „ 8-12 using for tab sequences „ 18-49
starting and stopping components „ 26-19, Indicator tag
27-8 control list selectors „ 17-174
starting components manually „ 26-9, 27-3 gauges and graphs „ 17-143
starting manually „ 1-5 indicators „ 17-119
starting when necessary „ 5-24 piloted control list selectors „ 17-191
starting with startup components „ 5-24 push buttons „ 17-36
startup macro „ 5-28, 6-12 Indicators „ 17-117
startup settings „ 5-24 indicator tag „ 17-119
status „ 5-6 list „ 17-134
stopping components manually „ 26-9, 27-4 multistate „ 17-120
stopping manually „ 1-5, 26-10 importing XML „ F-3
stopping when not needed „ 5-24 troubleshooting XML „ F-5
synchronizing „ 5-7, 26-12 XML file structure „ F-4
tags „ 8-1 symbol „ 17-128
HMI services Input field commands
starting manually „ 26-11 Display
stopping manually „ 26-10 /U parameter „ A-33
HMI tags Download „ 17-115, 17-226, A-36
See Tags DownloadAll „ 17-115, 17-226, A-37
Home area „ 5-9, 8-20
NextPosition „ 18-49, A-45
finding tags in „ 8-13 Position „ 18-49, A-48
Home key „ 17-160
Horizontal position animation „ 18-22
PrevPosition „ 18-49, A-48
Horizontal slider animation „ 18-34 SendKeys „ A-53
Upload „ 17-115, 17-227, A-59
I UploadAll „ 17-115, 17-227, A-60
Input fields
Identify command „ 11-75, A-40 creating
setting up alarms with „ 11-35, 11-40 numeric „ 17-107
If command „ A-41 recipe „ 17-221
If-then-else expressions „ 20-23
string „ 17-107
nesting „ 20-25
Image graphic object „ 17-6 downloading values from „ 17-107, 17-114
Images highlight
adding to Application Explorer „ 17-11 enabling or disabling „ 16-71
adding to Image Browser „ 17-11 question marks in „ 17-108, 17-114, 17-225
importing „ 17-11 specifying behavior for „ 16-71
pasting into graphic displays „ 17-7 specifying color for „ 16-70

Index ■
I–13
updating tag values in „ A-33 location of files „ 16-49
uploading values to „ 17-107, 17-114 using for alarm displays „ 11-10
using at run time „ 17-113, 17-225 using for trends „ 19-16, 19-63
using keys with Libraries editor „ 16-50
Shift-Tab „ A-48 Limits
special keys „ 17-113 number of HMI servers „ 5-16
Tab „ A-45 tags in graphic displays „ 8-2
Input focus tags with alarms „ 8-2
giving to graphic objects „ 17-27 Line graphic object „ 17-16
List indicators „ 17-134
specifying behavior „ 16-71
Load balancing
Integrated Development Environment
See IDE data servers „ 5-16, 6-7
Interactive objects HMI servers „ 5-16
See also Advanced objects Local message displays „ 17-215

creating „ 17-26 value tag „17-215


Local messages „ 17-231
specifying behavior „ 16-70
Interlocked push buttons „ 17-85 creating in a spreadsheet „ 17-237
Internet technical support „ P-3 embedded variables in „ 21-2
Invoke command „ 18-43, A-43 value tag „ 17-232, 17-234
Local Messages editor „ 17-235
K Localizing applications „ E-1
exporting text „ E-5
Key command „ 23-15, A-44 file format „ E-12
Key list „ 18-64
file name „ E-12
disabling „ 18-65
file schema „ E-16
Keyboard
on screen „ 17-115, A-33 importing text „ E-8
on-screen „16-72 information for translators „ E-12
Keyboard navigation „ 17-27 new line character „ E-18
Keypad for numeric input „ 16-73 text that is not exported „ E-2
Keys „ 17-160, 23-7 troubleshooting importing text „ E-10
See also Key list Logging in
See also Special keys and security „ 15-21
auto-repeat „ 17-168 at run time „ 15-21, 26-17, 27-7
precedence „ 23-7 Logging out
reserved „ 23-10 and security „ 15-21
understanding „ 17-158 at run time „ 15-21, 26-17, 27-7
using to open displays „ 23-5 Logging paths
viewing at run time „ 18-64 See Data logging, paths
Logical operators „ 20-10
L Login command „ 15-13, 15-21,
Login macro „ 15-10
A-44

Latched push buttons „ 17-65 assigning to users „ 15-10


Libraries „ 16-2, 16-49 Logout command „ 15-13, 15-21, A-45
adding „ 16-50 Logout macro „ 15-10
creating „ 16-50 assigning to users „ 15-10

I–14 ■
RSView Supervisory Edition User’s Guide
M Microsoft Visual Basic „ 11-8

See also RSView SE Client object model


Macros „ 22-1
See also VBA code
assigning to users „ 15-10
See also VBA documentation
attaching to ActiveX events „ 18-44
See also VBA IDE
creating „ 2-20, 22-1 Modicon devices „ 7-1, C-1
login and logout „ 15-10 Module called ThisDisplay „ 24-4
startup and shutdown „ 16-69, 22-6 Momentary push buttons „ 17-45
using the Command Wizard „ A-10 momentary off button „ 17-41
nesting „ 22-5 momentary on button „ 17-40, 17-45
On Active „ 5-28 Monitoring disk space „ 13-21
On Shutdown „ 5-28, 6-12 Move Down key „ 17-160
Move Left key „ 17-160
On Standby „ 5-28
Move Right key „ 17-160
precedence of „ A-4 Move Up key „ 17-160
redundancy Multistate indicators „ 17-120
See Redundancy importing XML „ F-3
securing „ 15-13 troubleshooting XML „ F-5
startup „ 5-28, 6-12 XML file structure „ F-4
using commands in „ 22-2 Multistate push buttons „ 17-74
using in events „ 14-1
using in graphics „ 18-8
using parameters in „ 22-4
N
using to identify alarms „ 11-75 Naming graphic objects „ 16-43, 17-24
using with trends „ 19-64 Navigation
Macros editor „ 22-1 among graphic objects in a display „ 17-27
Maintained push buttons „ 17-55 planning „ 3-9
Memory tags „ 9-2, 9-20 Network
redundancy planning layout „ 3-2
See Redundancy Network redundancy
Messages See Redundancy
clearing in Diagnostics List „ 12-19 NextPosition command „ 18-49, A-45
routing to FactoryTalk Diagnostics „ 12-14 NextWindow command „ A-45
Methods „ 18-42 Non-Allen-Bradley devices „ 7-1, C-1
ActiveX „ A-43 Number format „ 28-1
calling „ 18-43 Numeric display graphic object „ 17-103
Mic·osoft Visual Basic Numeric input graphic object „ 17-107,
and DDE communications „ C-1 17-114
Microsoft Access„ 11-8, 13-4 and on-screen keyboard „ 16-72, 17-115
Microsoft Excel
and alarm logging „ 11-8 O
and data logging „ 13-1
and FactoryTalk Diagnostics „ 12-1 Object Browser
using to create tags „ 9-21 VBA „ 24-10
Microsoft SQL Server „ 13-4 getting help „ 24-11

Index ■
I–15
Object Explorer „ 16-11 OPC-DA data items
opening „ 16-11 See Tags
using to highlight objects „ 16-13 OpenRSLogix5000 command „ 3-14, A-46
Overview of RSView „ 1-6
using to select objects „ 16-12
Object keys „ 23-5
features in brief „ 1-3
creating „ 18-46 software programs „ 1-1
editing „ 18-62
key list „ 18-48, 18-62, 18-64 P
precedence among key types „ 23-7 Page Down key „ 17-160
Object model Page Up key „ 17-160
See RSView SE Client object model Pan
Object properties in trends „ 19-71
editing „ 16-34 Panel graphic object „ 17-12
Object Smart Path „ 18-6, 18-11 Parameter files „ 16-53, A-34
Objects assigning to graphic displays „ 16-54
viewing „ 24-10 running „ 16-53
Objects that use data „ 17-26 Parameters editor „ 16-53
ODBC data logging Passwords „ 15-22
See Data logging Pattern styles „ 16-32
ODBC schemas invisible „ 16-32
See ODBC storage format Pause command „ A-47
Piloted control list selectors „ 17-186, 17-194
ODBC storage format
data log files „ 13-1, 13-4 controlling remotely „ 17-188
Offsetting differences from control list selectors „
Offsetting tag values „ 8-6 17-186
OLE objects „ 17-2, 17-238
Enter-key handshaking „ 17-193
attaching verb animation „ 18-37 indicator tag „ 17-191
converting „ 17-240 value tag „ 17-191
Placeholders „ 11-27
securing „ 15-16
See also Tag placeholders
OLE verb animation „ 18-37
On Active macro „ 5-28 in alarm summaries „ 11-70
On Shutdown macro „ 5-28, 6-12 in commands „ 22-2, A-2
On Standby macro „ 5-28 Planning applications „ 3-1
On startup macro PlayWave command „ A-47
PLC network redundancy
See Startup macro
Online help „ P-1 See Redundancy
On-screen keyboard „ 16-72, 17-115, A-33 PLC redundancy
OPC See Redundancy
RSView as client Poll rate for DDE „ C-4
Polygon graphic object „ 17-16
assigning server to RSView tags „ 9-18 Polyline graphic object „ 17-16
OPC communications „ 7-2 Position command „ 18-49, A-48
and RSLinx „ 7-1 Precedence
setting up „ 7-1 among client, object, and display keys „ 23-7
syntax „ 9-19 and the F1 key „ 23-8
OPC data servers embedded ActiveX objects „ 23-8
See Data servers embedded OLE objects „ 23-9

I–16 ■
RSView Supervisory Edition User’s Guide
in macros „ 20-21 Quick Start „ 1-6
reserved keys „ 23-12 VBA code „ 24-5
PrevPosition command „ 18-49, A-48
PrevWindow command
PrintDisplay command
„
„
A-48
2-23, 16-75, A-49
R
Printers Ramp command „ A-50
selecting „ 2-22 Ramp push buttons „ 17-94
Procedure window Read tag „ 16-38
See VBA Procedure window ReadMe file „ P-1
Read-write tag „ 16-38
Procedures
Recipe commands
defined „ 24-5
Download „ 17-115, 17-226, A-36
Programmatic ID
for RSLinx for RSView „ 7-9 DownloadAll „ 17-115, 17-226, A-37
Project Explorer RecipeRestore „ 17-226, A-52
See VBA Project Explorer RecipeSave „ 17-227, A-52
Project file path Upload „ 17-115, 17-227, A-59
viewing „ 5-22, 6-8 UploadAll „ 17-115, 17-227, A-60
Properties Recipes „ 17-221
ActiveX „ 18-40, A-43 and on-screen keyboard „ 16-72, 17-115
Properties window recipe field „ 17-221
See VBA Properties window recipe file „ 17-222
Property Panel „ 16-34 using at run time „ 17-223, 17-225
assigning tags to graphic objects „ 16-38 using index numbers „ 17-222, 18-49
opening „ 16-34 Recipes editor „ 17-222
setting up grouped objects „ 16-37 Rectangle graphic object „ 17-15
Redundancy „ 25-1, 25-15, 25-18
setting up multiple objects „ 16-37
activation
using to set up graphic objects „ 16-35
See Redundancy, licensing
using with ActiveX objects „ 18-40
PullForward command „ A-50
alarms „ 11-23, 25-6, 25-7
Push buttons „ 17-29 commands „ 25-8
buttons „ 17-37 computer for secondary server „ 5-26
indicator tag „ 17-36 control network „ 25-2
interlocked „ 17-85 data log files „ 25-8
latched „ 17-65 data servers „ 5-7, 5-17, 6-2, 6-8, 25-9
maintained „ 17-55 OPC „ 7-9
momentary „ 17-45 RSLinx „ 7-14
multistate „ 17-74 derived tags „ 25-8
ramp „ 17-94 effect on clients „ 25-4
value tag „ 17-35 events „ 25-8
PushBack command „ A-50 FactoryTalk Directory „ 4-3, 4-8, 5-5, 25-5,
25-15, 25-16, 25-17
Q fail-over time for servers „ 25-4
hardware „ 25-2
Question marks HMI server status „ 5-6
in input fields „ 17-108, 17-114, 17-225 HMI servers „ 5-5, 5-17, 5-21, 5-25, 25-6,
in trends „ 19-36 25-10, 25-12

Index ■
I–17
information network „ 25-2 RSLogix 5000 „ 8-3

licensing „ 25-19 OpenRSLogix5000 command „ 3-14, A-46


macros „ 25-8 Sequential Function Charts „ 3-14
memory tags „ 25-8 RSServer „ C-1
RSView
planning „ 3-5, 25-1, 25-2, 25-10
exploring „ 2-4
PLC „ 25-2
RSView Administration Console „ 1-2, 1-4,
primary HMI server „ 5-25 13-36, 28-2
RSLinx „ 25-9 shutdown after 2 hours „ 28-2
RSView SE Servers RSView commands „ A-1
See Redundancy, HMI servers See also Commands
secondary HMI server „ 5-25 See also individual command entries
synchronizing servers „ 5-7, 26-12 RSView SE Client „ 1-2
References copying configuration files „ 26-16
absolute „ 5-10 data server fail-over „ 5-7, 6-2
relative „ 5-10, 6-2 FactoryTalk Directory fail-over „ 4-4, 5-5
syntax „ 5-11 HMI server fail-over „ 5-6
to tags „ 8-19 opening „ 26-16, 27-6
Relational operators „ 20-9 opening multiple „ 26-18, 27-7
Relative references „ 5-10, 6-2
securing „ 15-20
in commands „ A-6
setting up „ 26-14
resolving in commands „ A-7
for stand-alone applications „ 27-5
syntax „ 5-10, 5-11, 6-2
starting when Windows starts „ 26-18, 27-7
to tags „ 8-19
RSView SE Client object model „ 24-1, 24-6
Remark command „ A-53
RSView SE Server „ 1-2
Remarks
See also HMI servers
adding to alarm log file „ 11-30
RSView SE Service Manager „ 1-5
Reserved keys „ 23-10
RSView Studio „ 1-1
precedence „ 23-12
exploring „ 2-4
Retentive tags „ 9-2
Rockwell Software overview „ 2-4
contacting „ P-3 starting „ 2-1
Root area „ 5-9 Run time
Rotation animation „ 18-29 administration
Rounded rectangle graphic object „ 17-14 See System administration
RSLinx
changing logging paths „ 13-19, 13-36
and OPC communications „ 7-1
changing logging rate „ 13-37, A-26
browsing for offline tags „ 8-10
changing passwords „ 15-22
redundancy
font substitution „ 17-3
See Redundancy
input fields „ 17-113
RSLinx data servers
logging in „ 15-21
See Data servers
RSLinx Enterprise
logging out „ 15-21
See Data servers recipes „ 17-223, 17-225
RSLinx for RSView setting up clients
See also Data servers for distributed applications „ 26-14
prog ID „ 7-9 for stand-alone applications „ 27-5

I–18 ■
RSView Supervisory Edition User’s Guide
time, date, and number formats „ 28-1 removing groups „ 15-8
trends „ 19-66 removing users „ 15-8
delta value bar „ 19-69 securing commands „ 15-11
loading a template „ 19-59 securing macros „ 15-11
overlays „ 19-72 setting up default access „ 15-6
printing „ 19-72 Signature button „ 17-248
scrolling „ 19-67 super user account „ 15-7
setting up „ 19-60 system administrator „ 15-7
troubleshooting „ 19-73 tags „ 15-17
value bar „ 19-68 Unspecified_Command „ 15-12
zoom „ 19-70 Windows user list „ 15-2, 15-5
Security codes „ 15-12

S assigning to commands „ 15-13


assigning to graphic displays „ 15-14, 16-67
Samples application assigning to groups „ 15-10
running „ 2-4 assigning to macros „ 15-13
Scale graphic object „ 17-154
Scaling tag values „ 8-6 assigning to OLE objects „ 15-16
ScreenPrint command „ 2-23, 16-75, A-53 assigning to tags „ 9-13, 9-16, 9-17
Scroll bars assigning to user accounts „ 15-5
preventing on graphic displays „ 16-65 assigning to users „ 15-10
Seagate Crystal Reports „ 12-1, 13-1
Secured Commands editor „ 15-12
default „ 15-12
Security „ 15-1 SendKeys command „ A-53
access permissions Service Manager „ 1-5
Services
alarm logging „ 11-53, 11-54
setting access permissions
data logging „ 13-18, 13-19
FactoryTalk Diagnostics logging „
FactoryTalk Diagnostics logging „
12-15, 12-16
12-15, 12-16
Set command „ 9-20, 14-1, A-54
adding groups „ 15-7 SetFocus command „ 16-61, A-56
adding users „ 15-7 Short file names
applications „ 15-19 for alarm logs „ 11-56
changing passwords „ 15-22 Shutdown macro
DeskLock „ 15-20 See On Shutdown macro
disabling access to key combinations „ 15-20 Siemens devices „ 7-1, C-1
electronic signatures „ 17-248 Signature button „ 17-248
for tags „ 8-5 Silence command „ A-57
graphic displays „ 16-67 SilenceAll command „ A-57
locking users into RSView „ 15-20 Software failure
logging in „ 15-21, 26-17, 27-7 See Redundancy
logging out „ 15-21, 26-17, 27-7 Special keys
OLE objects „ 15-16 arrows
Passwords „ 15-1 using in trends „ 19-71
planning „ 3-11 using with graphic objects „ 16-20

Index ■
I–19
Ctrl String HMI tags
copying objects with „ 16-16 setting up „ 9-17
drawing objects with „ 17-15, 17-16, String input graphic object „17-107, 17-114
17-17 and on-screen keyboard „ 16-72, 17-115
resizing objects with „ 16-19 Strings

rotating objects with „ 16-27 see Text


Suppressed List editor „ 11-12, 11-82, 11-83
Ctrl-F6 „ A-45
SuppressOff command „ A-57
Ctrl-PgDn „ 17-114, A-36 SuppressOffAll command „ A-58
Ctrl-PgUp „ 17-114, A-59 SuppressOn command „ 11-12, 11-82, A-58
Ctrl-R „ 17-225 Symbol commands
Ctrl-Shift-F6 „ A-48 Define „ A-9, A-31
Ctrl-Shift-Tab „ A-48 Undefine „ A-10, A-59
Ctrl-Tab „ 20-5 Symbol indicators „ 17-128
Ctrl–Tab „ A-45 Symbols „ A-8
Ctrl-W „ 17-225 Syntax
Enter „ 17-114, 17-227, A-36 absolute references „ 5-10, 5-11
disabling „ A-33 checking in derived tags „ 10-3
using with on-screen keyboard „ 17-116 checking in expressions „ 20-4
Minus (–), using with graphic objects „ 16-16 DDE communications „ C-4
PgDn „ 17-114, 17-227 embedded variables
PgUp „ 17-114, 17-227
date and time
Plus (+), using with graphic objects „ 16-16
reserved keys „ 23-13 syntax „ 21-8
Shift, using with graphic objects „ 16-16, numeric „ 21-5
16-20, 17-19 string „ 21-6
Shift-Tab „ 18-53, A-48 time and date „ 21-8
Tab „ 17-114, 18-52, A-45 OPC communications „ 9-19
using to navigate at run time „ 17-28 relative references „ 5-10, 5-11, 6-2
Specify FactoryTalk Directory Location „
4-6 tags
Square graphic object „ 17-15 DDE communications „ C-4
Stand-alone applications OPC communications „ 9-19
See Applications
System administration „ 28-1
Standby macro
On Standby macro „ 5-28 backing up stand-alone applications „ 28-2
Startup components „ 5-26, 6-10 date formats „ 28-1
Startup macro „ 5-28, 6-12, 22-6 monitoring disk space „ 28-4
using with trends „ 19-64 number formats „ 28-1
States
restoring stand-alone applications „ 28-2
in alarms „ 11-37
States toolbar „ 16-42
RSView Administration Console „ 28-2
Status bar „ 2-7, 16-4 time formats „ 28-1
hiding „ 2-8 System tags „ B-1
showing „ 2-8 for alarms „ 11-11, B-1
String display graphic object „ 17-105 System time and date „ B-2

I–20 ■
RSView Supervisory Edition User’s Guide
T using the [tag] parameter „ 18-54
using with tag folders „ 16-52
Tab index „ 17-25, 18-49 Tag substitution „ 16-39
removing „ 17-28 Tag values
Tab key changing „ 9-20
creating a tab sequence „ 18-52 displaying in a tag label object „ 17-204
Tab sequence
downloading „ 17-107, 17-114
changing index numbers „ 18-51
logging „ 8-21, 12-5, 13-34
checking index numbers „ 18-50
updating „ 17-114, C-4
creating „ 18-49, 18-52
continuously in graphic displays „
removing objects from „ 17-28
Tag Browser
17-113
adding folders „ 8-12 uploading „ 17-107, 17-114
displaying tag properties „ 8-17 Tags „ 8-1, 9-1

displaying tags „ 8-14 See also [tag] parameter


filtering items „ 8-17 See also Analog tags
folders „ 8-12 See also Derived tags
hiding tag descriptions „ 8-14 See also Digital tags
home area „ 8-13 See also String tags
refreshing list of folders and tags „ 8-14 See also System tags
removing filter „ 8-18 absolute references „ 8-19
selecting tags „ 8-15 adding alarms to „ 9-25, 11-2
showing server names „ 8-12 and events „ 14-1
showing tag descriptions „ 8-14 assigning to graphic objects „ 17-26, 17-27
using „ 8-11 using the Property Panel „ 16-38
using wildcards viewing in Object Explorer „ 16-13
using wildcards in „ 8-17 basic steps for using „ 8-3
Tag commands browsing „ 8-3, 8-11
= (Equal) „ A-13 browsing offline „ 8-10
using for memory tags „ 9-20 creating later „ 8-3
Ramp „ A-50 data server tags
Set „ 9-20, 14-1, A-54 how to use „ 8-4
Toggle „ A-58 when to use „ 8-4
Tag Import and Export Wizard „ 9-21, 9-24 data sources „ 9-2
Tag label graphic object „ 17-204
Tag placeholders „ 16-51, 17-26, 18-7
DDE „ C-3
creating „ 16-52 displaying „ 8-14
in alarm summaries „ 11-70 displaying properties „ 8-17
parameter for Display command „ A-34 filtering „ 8-17
replacing by listing tag names „ 16-55 finding in objects „ 16-14
replacing using a parameter file „ 16-52 hiding descriptions „ 8-14
resolving at run time „ 11-71 HMI tags
using in alarm summaries „ 16-52 adding „ 9-11
using in commands „ A-35 alarms „ 9-25, 11-32, 11-37
using in expressions „ 20-6 analog „ 9-13

Index ■
I–21
basic steps for using „ 8-7, 8-8 storing values in memory „ 8-7
creating „ 8-18, 9-5, 9-20 syntax
data sources „ 9-18 DDE communications „ C-4
data types „ 9-15 OPC communications „ 9-19
deleting „ 9-12 using for alarms „ 8-5
device „ 9-2 using in editors „ 2-19
digital „ 9-16 using in expressions „ 2-21, 9-3, 18-5, 20-6
duplicating „ 9-12 with built-in functions „ 20-13
editing „ 9-12 using in trends „ 19-29, 19-38
using with object keys „ 18-48, 18-62
folders „ 9-4, 9-6
using with placeholders in commands „ 22-2,
grouping „ 9-4 A-2
importing „ 8-18, 9-21, 9-22, 9-24 Tags editor „ 9-4, 11-20, 11-31
memory „ 9-2, 9-20 Technical support „ P-3, 1-6
Test Display mode „ 16-9, 18-6, 19-63
naming „ 9-3
Text
organizing „ 9-3 importing and exporting
retentive tags „ 9-2 see Localizing applications
string „ 9-17 Text graphic object „ 17-2
Tags editor „ 9-4 editing „ 17-6
when to use „ 8-5 ThisDisplay module „ 24-4
Thresholds for alarms „ 11-2, 11-4, 11-32
home area „ 8-13
Time and date „ 28-1, B-2
in graphic objects in trends „ 19-17, 19-23, 19-43, 19-44
updating continuously „ 17-113 Time and date displays „ 17-228
limits Toggle command „ A-58
alarms „ 8-2 Toolbars „ 2-5, 16-3, 16-7
in graphic displays „ 8-2, 16-1 ActiveX toolbox „ 17-245
logging values „ 8-21, 12-5 hiding „ 2-8
max. update rate in displays „ 16-64 showing „ 2-8
min. and max. values „ 8-6 States toolbar „ 16-42
Toolbox
offline „ 8-10
ActiveX „ 17-245
offsetting values „ 8-6 Tools „ 1-4
planning database „ 3-7 Alarm Log Setup „ 1-5, 11-43
redundancy Alarm Log Viewer „ 1-5, 11-56
See Redundancy Application Manager „ 1-4, 5-14, 5-15, 6-6,
references „ 8-19 6-7, 27-3, 28-2
refreshing list in Tag Browser „ 8-14 DeskLock „ 1-4, 15-20
relative references „ 8-19 Diagnostics Setup „ 1-5, 12-7
removing a filter „ 8-18 Diagnostics Viewer „ 1-5, 12-19, 12-20
scaling values „ 8-6 RSView SE Service Manager „ 1-5
securing „ 8-5, 15-17 Specify FactoryTalk Directory Location „
selecting „ 8-15 1-5, 4-6, 4-7, 4-13
showing descriptions „ 8-14 Tag Import and Export Wizard „ 1-5, 9-21,
showing server names „ 8-12 9-24

I–22 ■
RSView Supervisory Edition User’s Guide
Tooltips pens „ 19-5, 19-29
adding to ActiveX toolbox „ 17-246 adding „ 19-29, 19-30
adding to graphic objects „ 16-43, 17-24 adding from a data log model „ 19-30,
Touch animation „ 18-33
Translating applications
19-33
see Localizing applications attributes „ 19-32, 19-53
Trends „ 19-1 deleting „ 19-32
appearance „ 19-8, 19-15 editing „ 19-32
background color „ 19-15 editing multiple „ 19-37
changing at run time „ 19-66 icons „ 19-6, 19-25
chart background color „ 19-14
line number „ 19-32
chart radix „ 19-22
chart scale „ 19-4, 19-35, 19-44, 19-46 line style „ 19-34
chart title „ 19-17 line type „ 19-33
charts „ 19-3, 19-10, 19-11, 19-18 line width „ 19-33
common properties „ 17-25 markers „ 19-7, 19-34
comparing data „ 19-38, 19-50 masking „ 19-33
connecting data points „ 19-23 selecting at run time „ 19-65
creating planning „ 3-11
setting up „ 19-16 plotting a horizontal line „ 19-38
data buffer „ 19-20, 19-28 plotting an XY chart „ 19-11
data source „ 19-20 plotting historical data „ 19-20
delta value bar plotting real-time data „ 19-20
using at run time „ 19-69 printing „ 19-72
displaying milliseconds „ 19-23 radix „ 19-22
displaying tag values „ 19-38 running in the background „ 19-64
editing at run time „ 19-66 scrolling „ 19-27, 19-67
filling with data „ 19-27
at run time „ 19-67
graphic library „ 19-63
selecting a data server „ 19-17
isolated graphing „ 19-12, 19-48
shading „ 19-36, 19-38
legends „ 19-6
current value legend „ 19-6, 19-24 snapshots „ 19-21, 19-51
adding as an overlay „ 19-52
line legend „ 19-6, 19-25
x-axis legend „ 19-4 creating „ 19-51
y-axis legend „ 19-4 deleting „ 19-53
multiple pens „ 19-12 removing as an overlay „ 19-52
navigating to „ 17-27 templates „ 19-56
overlays „ 19-21, 19-50, 19-51 creating „ 19-57
adding „ 19-52 deleting „ 19-59
at runtime „ 19-72 loading „ 19-59
removing „ 19-52 testing „ 19-63
pan „ 19-71 time format „ 19-22
parts of time span „ 19-44
Heading 3 „ 19-3 troubleshooting „ 19-73

Index ■
I–23
updating pen values „ 19-19 piloted control list selectors „ 17-191
deadband „ 19-20 push buttons „ 17-35
heartbeat „ 19-20 VBA code „ 18-39
using at run time „ 19-9, 19-60, 19-64 planning „ 3-12
pan „ 19-71 quick start „ 24-5
using with ActiveX objects „ 17-245, 18-45
value bar „ 19-9, 19-23, 19-68
validating operator input „ 17-108
using at run time „ 19-68
VBA documentation „ 24-13
x-axis „ 19-4, 19-43 VBA IDE „ 24-1, 24-2
y-axis „ 19-4, 19-45 Procedure window „ 24-4
zoom „ 19-70 Procedures defined „ 24-5
Project Explorer „ 24-4
U Properties Window „ 24-4
ThisDisplay module „ 24-4
Undefine command „ A-10, A-59
Unicode format
using „ 24-2
for XML files „ F-2 using the IDE „ 24-2
Upload command „ 17-115, 17-227, A-59 VBA Integrated Development Environment
UploadAll command „ 17-115, 17-227, A-60 See VBA IDE
User account commands Vertical position animation „ 18-23
Login „ 15-13, 15-21, A-44 Vertical slider animation „ 18-36
Viewing objects „ 24-10
Logout „ 15-13, 15-21, A-45
Visibility animation „ 11-10, 18-13
User accounts „ 15-5
Visual Basic
adding „ 15-7 See Microsoft Visual Basic
administrator „ 15-7
assigning security codes „ 15-10
login and logout macros „ 15-10 W
maintaining in Windows „ 15-2, 15-5 Wallpaper
removing „ 15-8 converting graphic objects to „ 16-45
tracking system usage by „ 12-19 Wedge graphic object „ 17-17
User Accounts editor „ 15-6 Width animation „ 18-25
UTF-16 format Wildcards „ 9-3, 9-6
for XML files „ F-2 and commands „ A-2
UTF-8 format using to select tags „ 8-17, 11-69
for XML files „ F-2 using to suppress alarm monitoring „ 11-82
Utilities „ 1-5 Windows
See also Tools security „ 15-2, 15-5, 15-22
Windows applications „ A-25
Windows CE
V messages for FactoryTalk Diagnostics „
Value table 8-6
„ 12-15
updating „ C-4 Windows workgroups „ 3-2, 4-2, 5-3, 15-7,
Value tag 26-16
Workgroups in Windows „ 3-2, 4-2, 5-3, 15-7,
control list selectors „ 17-174 26-16
local message displays „ 17-215 Workspace „ 2-5
local messages „ 17-232, 17-234 Write tag „ 16-38

I–24 ■
RSView Supervisory Edition User’s Guide
X
XML „ F-1
importing into graphic displays „ F-1
saving „ F-2
testing for well-formed „ F-2
well-formed „ F-2

Z
Zoom „ 16-5
in trends „ 19-70

Index ■
I–25

You might also like