9399-2SE32RUG, RSView32 Runtime User`s Guide

9399-2SE32RUG, RSView32 Runtime User`s Guide
Runtime User’s Guide
Doc ID 9399-2SE32RUG-DEC 99
Contacting Rockwell
Software
Technical Support Telephone—440-646-7800
Technical Support Fax—440-646-7801
World Wide Web Support Library—www.software.rockwell.com
Copyright Notice
e1999 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
The Rockwell Software logo, RSAssistant, RSBatch, RSData, RSEmulate 5, RSEmulate 500,
RSGuardian, RSHarmony, RSKeys, RSLinx, RSLogix 5, RSLogix 500, RSPower, RSPowerCFG,
RSPowerRUN, RSServer32, RSServer, RSServerToolkit, RSSql, RSToolbox, RSTrainer, RSTrend,
RSTune, RSView32, RSView32 Resource Kit, RSView, RSWire, A.I. Series, Advanced Interface
(A.I.) Series, AdvanceDDE, ControlGuardian, ControlView, INTERCHANGE, Packed DDE,
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, and Visual Basic are registered trademarks, and Windows NT
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.
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 anytime without prior notice.
The instructions in this manual do not claim to cover all the details of variations in the
equipment, procedure, or process described, nor to provide directions for meeting every possible
contingency during installation, operation, or maintenance.
Doc ID 9399-2SE32RUG-DEC 99
Contents
Preface
About the documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Technical support services . . . . . . . . . . . . . . . . . . . . . . . . . . . .
When you call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
P-1
P-2
P-2
Chapter 1: Installing RSView32 Runtime
Determining system requirements . . . . . . . . . . . . . . . . . . . . .
Step 1 G Total your points . . . . . . . . . . . . . . . . . . . . . . . .
Step 2 G Determine the recommended
system configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing RSView32 Runtime . . . . . . . . . . . . . . . . . . . . . . . . .
Installing RSView32 on Windows NT . . . . . . . . . . . . . .
Installation summary . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ordering RSView32 Runtime on disks . . . . . . . . . . . . . . . . .
Activating RSView32 Runtime . . . . . . . . . . . . . . . . . . . . . . . .
About the Activation disk . . . . . . . . . . . . . . . . . . . . . . . .
Moving activation keys back to the Activation disk . . .
Activating RSView32 Runtime after installation . . . . . .
Protecting your activation files . . . . . . . . . . . . . . . . . . . .
Reactivating a damaged activation key . . . . . . . . . . . . . .
Troubleshooting activation . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstalling RSView32 Runtime . . . . . . . . . . . . . . . . . . . . . . .
1-1
1-2
1-3
1-4
1-4
1-5
1-5
1-5
1-5
1-6
1-7
1-8
1-9
1-10
1-10
Chapter 2: Running a Project
Setting up and running your project . . . . . . . . . . . . . . . . . . . .
Summary of steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 1 G Moving the project . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 2 G Specifying time, date, and number formats . . . . . . .
Step 3 G Starting RSView32 Runtime . . . . . . . . . . . . . . . . . . .
Starting RSView32 Runtime manually . . . . . . . . . . . . . .
Starting RSView32 Runtime automatically . . . . . . . . . .
2-1
2-2
2-2
2-3
2-4
2-4
2-4
H
H
iH
Contents
Step 4 G Opening the project . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Runtime Project Manager . . . . . . . . . . . . . . .
Step 5 G Setting up the channel, OPC server, or DDE server
Connecting to programmable controllers using
direct drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to OPC servers and DDE servers . . . . . . .
Step 6 G Changing the path to files outside the
project directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Step 7 G Running the project . . . . . . . . . . . . . . . . . . . . . . . . . .
Running a project manually . . . . . . . . . . . . . . . . . . . . . .
Running a project automatically . . . . . . . . . . . . . . . . . . .
Adding files to a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing data logging paths . . . . . . . . . . . . . . . . . . . . . . . . . .
Stopping a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
When a project stops . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2-5
2-6
2-7
2-7
2-7
2-8
2-9
2-9
2-10
2-10
2-11
2-11
2-11
Chapter 3: Using Security
Editing the users for a project . . . . . . . . . . . . . . . . . . . . . . . . .
Logging in at runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changing passwords at runtime . . . . . . . . . . . . . . . . . . . . . . .
3-1
3-2
3-3
Appendix A: RSView32 Commands
A-1
Index
H
H
H
ii
.................
Preface
RSView32t Runtime is a package for running automation
applications developed in RSView32 Works. RSView32 Runtime
runs on Microsoftr Windowsr 2000, Windows NTt, and
Windows 9x.
About the documentation
The RSView32 Runtime documentation includes:
Help, which contains procedures and reference information.
Readme file, which contains additional information about
RSView32. Read this file before you begin working with the
software.
H
H
P-1 H
Preface
Preface
Technical support services
If you have questions about RSView32 Runtime, please consult the
user’s guide or the Help.
If you cannot find the answer, contact Rockwell Software Technical
Support at:
Telephone:
440-646-7800
Fax:
440-646-7801
World Wide Web Support Library: www.software.rockwell.com
Support staff are available Monday to Friday from 8 am to 5 pm
Eastern Standard Time, except during holidays.
When you call
When you call, you should be at your computer and should be
prepared to give the following information:
the product serial number
You’ll find this number on the Activation disk label and in the
Help About dialog box that you access from the RSView32
Project Manager.
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
H
H
H
P-2
Installing RSView32 Runtime
This chapter describes:
hardware and software requirements
how to install and activate RSView32 Runtime
how to uninstall RSView32 Runtime
Determining system requirements
The hardware and software you use with RSView32 Runtime
depends on the demands your project places on the system. The
greater the demand, the more powerful a system you need.
The recommendations below are based on field experience. It is
possible that your application will operate on a platform below these
recommendations.
In the following tables, the demands your project places on the
system are represented by points. Total your points in step 1, and
then use the table in step 2 to determine the hardware and software
you need.
H
H
1-1 H
Installing RSView32 Runtime
Step 1
G Total your points
For
If you are
Add points
RSView32 project
running displays, or editing your project using
RSView32 Works
2
using more than 30,000 tags
2
using more than 5,000 tags
1
changing displays, on average, more than 5
times per minute
1
using more than 200 objects in displays
2
using ActiveX controls in displays
2
monitoring more than 1500 tags for alarms
2
monitoring more than 300 tags for alarms
1
Active Display System,
DDE, or OPC
simultaneously active
clients
using typically more than 5 active clients
2
using at least 1 client
1
Data log or Historical
trends
logging less than 100 tags in 1 model
1
logging between 100 and 1000 tags in 1 model
2
logging to more than 1 model
2
Event detector, derived
tags, or real-time
trends
using any
1
VBA
using any
2
Add-ons
using any, for each one
1
Alarms
Total your points here
H
H
H
1-2
Installing RSView32 Runtime
Step 2
G Determine the recommended system configuration
For this number
of points
Minimum hardware you need
8 or more
Pentium II 400 MHz
128 MB RAM
6 to 7
3 to 5
1 to 2
Pentium II 300 MHz
128 MB RAM
Pentium 200 MHz
64 MB RAM
Pentium 100 MHz
24 MB RAM
Minimum software you need
Windows 2000 Professional or
Windows NT Workstation 4.0
with Service Pack 4 or
Service Pack 6
Windows 2000 Professional or
Windows NT Workstation 4.0
with Service Pack 4 or
Service Pack 6
Windows 2000 Professional or
Windows NT Workstation 4.0
with Service Pack 4 or
Service Pack 6
Windows 2000 Professional or
Windows NT Workstation 4.0
with Service Pack 4 or
Service Pack 6 or
Windows 9x
H
H
1-3 H
Installing RSView32 Runtime
Installing RSView32 Runtime
The steps below explain how to install RSView32 software and user’s
guides from a CD-ROM to your computer. If you choose not to install
the user’s guides, you can view them from the CD-ROM.
Installing RSView32 on Windows NT
As part of the installation process, RSView32 Runtime creates
program folders and modifies registry entries. To make these
modifications, the currently-logged-in user must have administrative
rights on the computer on which RSView32 Runtime is installed (for
example, the Windows NT administrator account has these rights).
To install RSView32 Runtime on Windows NT and Windows 9x:
1. Close all open Windows programs.
2. Place the RSView32 CD-ROM into your CD-ROM drive. The CD-ROM
should start running automatically.
If the CD-ROM does not start automatically, run D:\Setup.exe
where D is the drive containing the CD-ROM.
3. In the RSView32 window, click the button beside Install
RSView32 Runtime.
4. Follow the on-screen instructions.
5. During installation, you will be prompted to activate RSView32
Runtime. If activation is present from an earlier version of
RSView32 Runtime, click Next.
If you removed the activation or if you are installing RSView32
Runtime for the first time, insert the Activation disk in the
diskette drive and click Activate. For details about activation, see
“Activating RSView32 Runtime” on page 1-5.
6. When installation is complete, restart Windows. If you choose not
to restart Windows now, be sure to restart it before running
RSView32 Runtime for the first time.
H
H
H
1-4
Installing RSView32 Runtime
If you plan to use RSView32 as an OPC server, you must configure
Microsoft Distributed COM (DCOM). For instructions see the
RSView32 Help.
Installation summary
The default installation does the following:
installs RSView32 Runtime in the folder \Program Files\Rockwell
Software\RSView
adds a Rockwell Software\RSView32 folder to your list of
programs. This folder contains the shortcut for RSView32
Runtime
Ordering RSView32 Runtime on disks
RSView32 Runtime is available on 3.5-inch disks. To order disks,
contact your local authorized Allen-Bradley distributor or your
local Allen-Bradley sales office.
Activating RSView32 Runtime
Rockwell Software Inc. uses activation files to activate its
Windows-based software packages. The activation files reside on the
Activation disk. During installation, the software prompts you to
insert the Activation disk and move the activation key from the disk
to the drive where you have installed RSView32 Runtime. RSView32
checks for the activation key every five minutes when you are
running the software, and will terminate if the activation key is not
present. A
About the Activation disk
RSView32 Runtime comes with an Activation disk (also referred to
as a Master disk) that activates the RSView32 Runtime software.
Without activation, RSView32 Runtime runs in demo mode, which
allows you to open a project with up to 35 device tags and run it for
up to two hours.
H
H
1-5 H
Installing RSView32 Runtime
The Activation disk contains:
one or more activation keys
The activation key is the software that activates RSView32
Runtime. Depending on what you purchased, your Activation
disk will have one or more activation keys. For example, if your
company purchased four RSView32 Runtime installations, you
require four activation keys. The keys are product-specific. For
example, RSView32 Runtime requires a Runtime activation key.
Multiple copies of the same software require activation keys with
matching serial numbers. All of the activation keys can be on the
same activation disk.
a program called Evmove.exe that moves activation keys to and
from computers
a program called Reset.exe that reactivates a damaged activation
key
You can move activation keys to and from the Activation disk. The
programs Evmove.exe and Reset.exe always stay on the Activation
disk.
Moving activation keys back to the Activation disk
You can move the activation key back to the Activation disk any
time. For example, move activation back to the Activation disk:
to run RSView32 Runtime on a different computer
before installing or using software that could damage your
activation files (see “Protecting your activation files” on page 1-8
for a list of specific operations that can damage activation)
before sending your computer to a technician
By default, when you move activation back to the Activation disk,
the software automatically moves all activation keys for the
appropriate product.
H
H
H
1-6
Installing RSView32 Runtime
To move activation keys back to the Activation disk:
1. Ensure RSView32 Runtime and all other Rockwell Software
products are closed.
2. Insert the Activation disk into a diskette drive.
3. Run A:\Evmove.exe where A is the diskette drive containing the
Activation disk. The EvMove Summary dialog box opens.
4. In the From field, select the drive where RSView32 Runtime is
installed. In the To field, select the drive containing the Activation
disk. Click OK.
5. Either move activation keys for all installations or for a selected
number of installations.
To move activation keys for all installations, click Move.
To change the number of activations to move to the Activation
disk, select the activation key, and then click Edit Selected. In
the Move field, type the number of activation keys to move.
Click OK, and then click Move.
6. To close the EvMove Summary dialog box, click OK.
Activating RSView32 Runtime after installation
You might need to reactivate RSView32 after moving activation keys
back to the Activation disk or after resetting a damaged key. To
reactivate RSView32, move the activation key from the Activation
disk to the hard drive. B
By default, when you move activation to a hard drive from the
Activation disk, the software moves only one activation key for
RSView32 Runtime.
H
H
1-7 H
Installing RSView32 Runtime
To move activation keys to the hard drive:
1. Ensure RSView32 Runtime and all other Rockwell Software
products are closed.
2. Insert the Activation disk into a diskette drive.
3. Run A:\Evmove.exe where A is the diskette drive containing the
Activation disk. The EvMove Summary dialog box opens.
4. In the From field, select the drive containing the Activation disk.
In the To field, select the drive where RSView32 Runtime is
installed. Click OK.
5. Either move activation keys for all installations or for a selected
number of installations.
To move activation keys for all installations, click Move.
To change the number of activations to move, select the
activation key, and then click Edit Selected. In the Move field,
type the number of activation keys to move. Click OK, and
then click Move.
6. To close the EvMove Summary dialog box, click OK.
Protecting your activation files
Performing certain operations on your hard drive can damage
activation files. Always move activation from your hard drive back
to the Activation disk before doing any of the following operations.
After completing the operation, it is safe to move the activation back
to the hard drive and reactivate RSView32. C
Move activation files back to the Activation disk before:
Upgrading or installing your computer’s operating system.
Upgrading, installing, and uninstalling operating system software or
networking system software can damage the activation files.
H
H
H
1-8
Installing RSView32 Runtime
Compressing or uncompressing your computer’s hard drive.
Compressing the hard drive with some compression software
programs can damage activation software. In addition,
uncompressing a hard drive with activation files on the compressed
drive can damage activation.
Reactivating a damaged activation key
If your activation key becomes damaged for any reason, contact
Rockwell Software Technical Support at 440-646-7800 for a reset
code.
When you call
When you call, you should be at a computer. You do not have to use
the same computer that RSView32 Runtime is installed on. However,
you must have the Activation disk with a serial number that matches
the RSView32 Runtime software.
The support representative will explain how to find the product ID
and system ID from the Activation disk, and then will assign a reset
code for the activation key. After obtaining a reset code from the
technical support representative, reset the key, and then reactivate
RSView32.
To reactivate a key with a reset code:
1. Ensure RSView32 Runtime and all other Rockwell Software
products are closed.
2. Insert the Activation disk into a diskette drive.
3. Run A:\Reset.exe where A is the diskette drive containing the
Activation disk.
4. In the Reset Code dialog box, type the reset code, and then click
OK.
5. Reactivate RSView32 following the steps in “Activating RSView32
Runtime after installation” on page 1-7.
H
H
1-9 H
Installing RSView32 Runtime
Troubleshooting activation
If activation is not working:
Are you using the correct Activation disk? Check the serial
numbers on your RSView32 software and on your Activation disk
labels—the serial numbers must match.
Does your computer have a virus? Boot sector viruses can damage
your Activation disk. The Rockwell Software support team
recommends using a commercial virus protection program.
Did you save other files on the Activation disk? Saving any files to
the Activation disk can damage the activation software.
Did you perform an operation on your hard drive that damaged
the activation software? See “Protecting your activation files” on
page 1-8.
Uninstalling RSView32 Runtime
To uninstall RSView32 Runtime, use the Windows Control Panel.
To uninstall RSView32 Runtime:
1. Click the Windows Start button, point to Settings, and then click
Control Panel.
2. Double-click Add/Remove Programs, select RSView32 6.3, and
click Add/Remove.
3. Follow the on-screen instructions.
4. When the Uninstall program is finished, restart Windows.
H
H
H
1-10
Running a project
This chapter outlines:
the steps for setting up and running your project
how to add files to a project
how to stop a project
Setting up and running your project
Once you have installed RSView32 Runtime on the target computer,
you are ready to set up and run the project you have created in
RSView32 Works.
H
H
2-1 H
Running a project
Summary of steps
1. Move the project to the target computer.
2. If the target computer is configured for a different locale than the
development computer, specify time, date, and number formats.
3. Start RSView32 Runtime.
4. Open the project.
5. Set up the channels, OPC server, or DDE server.
6. If applicable, change the path for any files that are outside of the
project directory.
7. Run the project.
Each of these steps is discussed in detail on the following pages.
Step 1 G Moving the project
If your project will be running on a different computer than it was
developed on, you must move the project using an external tool such
as the Windows Explorer or the File Manager. Be sure you move all
files referenced in your project, including any files outside of the
project directory.
You do not have to move the project to the same directory in which
it was created. When you move a project from one computer to
another, RSView32 Runtime automatically changes the project
directory’s paths to the drive and directory the project has been
moved to. If your project references files outside of the project
directory, update the path to these files in the Project Paths dialog
box. See “Changing the path to files outside the project directory”
on page 2-8.
H
H
H
2-2
Running a project
To move your project:
1. In the Windows Explorer or File Manager, move or copy the
project folder to the target location.
2. Move or copy any folders or files outside the project folder to the
target location.
Step 2 G Specifying time, date, and number formats
Skip this step unless the target computer is configured for a different
locale than the development computer, and the new locale uses
different time, date, or number formats.
Use the Windows Control Panel to specify the formats. You can also
change these formats after the project is running, but you must close
and restart the project for the changes to take effect.
1. Click the Windows Start button, point to Settings, and then click
Control Panel.
2. Double-click Regional Settings.
3. Select the language whose settings you want to use. If you use
Windows NT, click the “Set as system default locale” check box.
4. Verify and/or customize the settings on the Number, Time, and
Date tabs.
5. Click OK.
For more information, see your Windows documentation.
H
H
2-3 H
Running a project
Step 3 G Starting RSView32 Runtime
You can start RSView32 Runtime manually, or you can set up
RSView32 Runtime to start automatically when Windows starts.
Starting RSView32 Runtime manually
Click the Windows Start button, point to Programs, Rockwell
Software, RSView, and then click RSView32 Runtime.
Starting RSView32 Runtime automatically
To automatically start RSView32 Runtime each time Windows starts,
include an RSView32 Runtime shortcut in the Windows Startup
folder. You can also open a project when Windows starts.
To add RSView32 Runtime to the Startup folder:
1. Click the Windows Start button, point to Settings, and then click
Taskbar.
2. In the Taskbar Properties dialog box, click the Start Menu
Programs tab.
3. Click Add. The Create Shortcut dialog box opens.
4. In the Command Line field, do one of the following:
to open RSView32 Runtime when Windows starts, specify the
path to RSView32 Runtime. If you choose the default
installation, the path is:
“C:\Program Files\Rockwell Software\RSView\Rsvrt32.exe”
H
H
H
2-4
Running a project
to open RSView32 Runtime and open a project when Windows
starts, specify the path to RSView32 Runtime and to the
project. Add the /r (run) parameter to the command line. If you
choose the default installation, the path is:
“C:\Program Files\Rockwell Software\RSView\Rsvrt32.exe”
“C:\Proj 1\Proj 1.rsv” /r
where Proj 1 is the name of the project.
If the path contains spaces, you must enclose it in double
quotes. The /r parameter must be outside the quotes.
5. Click Next.
6. In the Select Program Folder dialog box, select the StartUp folder
and specify a name for the shortcut (for example, RSView32
Runtime).
7. Click Finish.
For more information, see your Windows documentation.
Step 4 G Opening the project
To open a project:
1. In the RSView32 Runtime window, click Open on the File menu.
2. In the Open dialog box, locate the project, click the project’s .rsv
file (for example, Norm’s Bakery.rsv), and then click Open.
H
H
2-5 H
Running a project
Using the Runtime Project Manager
. . . any related
components
developed in
RSView32 Works
are listed here. To
run a component,
double-click it.
When you select an
icon here . . .
With the Runtime Project Manager you can:
edit channels, nodes, user accounts, and data log paths—to open
an editor, double-click the editor’s icon
view activity and alarm logs—to open the viewers, double-click
the Activity Log Viewer and the Alarm Log Viewer icons
open the command line to manually enter RSView32
commands—to open the command line, double-click the
Command Line icon
run individual project components—to run a component, select
the icon for the editor that created the component, and then
double-click the component name
run a project—for details about running a project, see “Running
the Project” on page 2-9
H
H
H
2-6
Running a project
Step 5 G Setting up the channel, OPC server, or DDE server
Before you can run a project, you must load and configure drivers
for the programmable controllers or servers that your project was
configured to use.
Connecting to programmable controllers using direct drivers
To connect to most Allen-Bradley devices, install and load RSLinxt
and install the driver required by your RSView32 project.
To communicate with SoftLogixt 5 programmable controllers, you
must use an RSLinx driver.
IMPORTANT You must use the version of RSLinx that came with your RSView32
software. This version has been tested for compatibility with RSView32.
Other versions may not function correctly.
To select a different RSLinx driver for your project, use the Channel
editor.
For details about the RSLinx drivers, see the documentation
accompanying RSLinx. For details about the Channel editor, see
Chapter 2, Setting up direct driver communications, in the RSView32
User’s Guide.
Connecting to OPC servers and DDE servers
To connect to a wide range of local and remote devices, install and
configure the appropriate OPC or DDE server. For details about
configuring the server, see your server documentation.
To change the OPC node’s server name and access path or the
application and topic name for the DDE server your project will use,
use the NodeSwitch command or use the Node editor.
For details about the NodeSwitch command, see Appendix A,
RSView32 Commands, or see Help. For details about the Node
editor, see Chapter 3, Setting up OPC and DDE communications, in
the RSView32 User’s Guide.
H
H
2-7 H
Running a project
Step 6 G Changing the path to files outside the project directory
If your project references files outside of the project directory and
the path to these files has changed (for example, the drive letter has
changed), use the Project Paths dialog box to update the path.
For example, imagine your project directory is C:\Norm’s Bakery
but you have stored graphic files in C:\Gfx. You move your project
from C:\ to D:\. The paths to the files in \Norm’s Bakery are
automatically updated, but the path to \Gfx is not—you must update
the path in the Project Paths dialog box.
To change the path:
1. With the Project Manager active, click Project on the menu bar,
and then click Project Paths.
2. Click the Application Paths tab.
H
H
H
2-8
Running a project
3. In the Name field, select the editor that was used to create the
component.
Any components associated with the editor are displayed in the
Components field.
4. In the Default Path field, type the new path or click Browse to
select the new path.
5. Click Apply Default Path.
The components are updated to the new path.
6. Click OK.
Step 7 G Running the project
You can run the project manually or you can set up the project to
run automatically when Windows starts.
Running a project manually
In the Project Manager, click Run Project.
Click this button to
run a project.
H
H
2-9 H
Running a project
Running a project automatically
To automatically start RSView32 Runtime and run a project each
time Windows starts, include an RSView32 Runtime shortcut in the
Windows Startup folder, as described on page 2-4.
Adding files to a project
You can add new files to a project any time by copying or moving
the physical file to the target computer and then adding the file’s
name to the Project Manager.
To add files:
1. In the Windows Explorer or File Manager, copy or move the file
you want to add into the appropriate folder in the project. For
example, add a graphic display file to the Gfx folder.
2. In the RSView32 Project Manager, select the icon for the editor
that was used to create the file (for example, select the Data Log
icon for a data log model), right-click, and then click Copy
Existing Component into Project or click Create Shortcut to
Existing Component.
H
H
H
2-10
Running a project
3. In the dialog box, locate the file that you moved, and then click
Open. The file name will be added to the right-pane of the Project
Manager.
Changing data logging paths
You can change the data logging paths at runtime. You can change
the primary and secondary paths for dBASE IV data log models, and
the backup path for ODBC data log models. You cannot change the
ODBC database using RSView32 Runtime. After you change the
logging path you must stop and restart data logging for the changes
to take effect.
To edit the logging paths:
1. In the Project Manager, open the Data Log folder.
2. Open the Data Log Path editor.
3. Specify paths as described in “Specifying Logging Paths” in
Chapter 7, Configuring data logging, in the RSView32 User’s
Guide.
You can also change logging paths at runtime using the DataLogPath
command. For details about the DataLogPath command, see
Appendix A, RSView32 commands, or see Help.
Stopping a project
To stop a project, do one of the following:
in the Project Manager, click the Stop Project button
on the command line, type ProjectStop
When a project stops
When a project stops, the following occurs:
open displays and RSView32 components close
running data log models stop
running derived tag files stop
H
H
2-11 H
Running a project
running event files stop
alarm monitoring stops
OPC/DDE (realtime) data server stops
If a shutdown macro has been specified in the Startup editor, the
macro runs once the above components have closed and stopped
running.
H
H
H
2-12
Using security
This chapter describes how to:
add, delete, or change users
log into a running project
change passwords
This chapter is applicable only for projects that use security.
Editing the users for a project
If your project has been set up with security, only users or groups of
users listed in the User Accounts editor can log in and out of the
project.
You can enter user names and passwords in the User Accounts
editor, or, if you are using Windows NT, you can use the
Windows NT user list instead of creating a custom RSView32 list.
No matter which method you choose to create the user list, you still
have to assign security access to the individual users.
H
H
3-1 H
Using security
To open the User Accounts editor:
1. In the Project Manager, open the System folder.
2. Open the User Accounts editor.
For details about the fields in the User Accounts editor, see
Chapter 10, Adding security, in the RSView32 User’s Guide.
Logging in at runtime
If you want users to log in, your project must include a way for users
to access the RSView32 Login dialog box.
One way is to create a button in RSView32 Works. When
configuring the button, use the Login command as the press action.
When the button is pressed, the RSView32 Login dialog box
appears.K
H
H
H
3-2
Using security
To successfully log in, users must enter a name and/or a password
that exists in the User Accounts editor.
Changing passwords at runtime
If you want users to be able to change their passwords, your project
must include a way for them to access the Password dialog box.
One way is to create a button in RSView32 Works. When
configuring the button, use the Password command as the press
action. When the button is pressed, the Password dialog box
appears.L
The new
password is
retyped here
to confirm it.
The new password is also added to the Password field of the User
Accounts editor.
IMPORTANT If your project is using the Windows NT security option, and you change
your password using the RSView32 Password command, your password
for the Windows NT domain will automatically be changed as well.
H
H
3-3 H
RSView32 commands
This appendix lists the RSView32 commands that are supported in
RSView32 Runtime. Commands that are not listed here will not run
in the runtime package.
For more information about commands and their usage, see the
RSView32 User’s Guide.
H
H
A-1 H
RSView32 commands
= (Equal)
[&]<tag_name> = <expression>
Writes the value resulting from an expression to a tag.
M
[&]
Forces the command to be executed asynchronously,
which makes the command faster.
<tag_name>
The name of the tag that will store the result of the
expression.
<expression>
A value, string, tag name, or a more complex
expression.
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.
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 RSView32 command. For more information about security, see
Chapter 10, Adding security, in the RSView32 User’s Guide.
For more information about expressions, see Chapter 14,
Creating expressions, in the RSView32 User’s Guide.
H
H
H
A-2
RSView32 commands
Examples: The = (Equal) command
&Tag1 = Tag1 + 1
Evaluates the command asynchronously. Increases the value of Tag1
by 1.
Tag1 = Tag2
Sets the value of Tag1 to be the same as Tag2.
Tag1 = Tag2 + Tag3
Adds the values of Tag2 and Tag3 and stores the result in Tag1.
1Pump = {Industry-2} + {2Pump}
Adds the values of Industry-2 and 2Pump and stores the result in
1Pump. Braces surround Industry-2 because of the dash in the name.
Braces surround 2Pump because the name starts with a number. No
braces are used for 1Pump because this name is on the left side of the
equal sign.
Tag1 = if (Tag1 < Tag2) then 3 else 4
If Tag1 is less than Tag2, Tag1 is set to 3, but if Tag1 is equal to or
greater than Tag2, Tag1 is set to 4.
Tank1\Message = “Tank1 Overflow”
Writes the string Tank1 Overflow to the Tank1\Message tag.
H
H
A-3 H
RSView32 commands
Abort
Abort [parameter]
Closes one or more windows. Without a parameter, the Abort
command closes the window that has focus.
[parameter]
One of the following:
me
Closes the window from which the command is
executed.
editor
Closes the specified editor, such as a graphic display
or an alarm summary. To name the editor, use the
RSView32 command that opens the editor. See the
examples below.
*
Closes all windows.
Ctrl-F4 also closes the active window.
Examples: The Abort command
Abort
Without a parameter, closes the window that has focus.
Abort me
Closes the window from which the command is executed.
Abort Display
Closes all open graphic displays.
Abort Display Pumps or Abort Pumps
Closes the graphic display called Pumps.
Abort Monitor
Closes all open tag monitors.
Abort *
Closes all windows.
H
H
H
A-4
RSView32 commands
Account
Account
Opens the User Accounts editor. To prevent security from being
changed at runtime, restrict access to this command.
Acknowledge
Acknowledge [tag_name]
Acknowledges an alarm or a group of alarms. This command gives
no indication that it has run but will display a message if not
executed properly.
If an acknowledge bit is associated with an alarm, acknowledging the
alarm sets the acknowledge bit.
[tag_name]
The name of the tag to be acknowledged. This can be
a tag name, a name with wildcards, or the [tag] literal
string.
If no tag is specified, this command acknowledges the
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.
H
H
A-5 H
RSView32 commands
Acknowledge [tag]
Acknowledges the alarm for the tag associated with the highlighted
object in the active graphic display.
AcknowledgeAll
AcknowledgeAll
Acknowledges all outstanding alarms. This command runs more
quickly than Acknowledge *. It gives no indication that it has run
but will display a message if not executed properly.
If an acknowledge bit is associated with an alarm, acknowledging the
alarm sets the acknowledge bit.
There is no limit to the number of tags that can be acknowledged
with this command.
ActivityBarOff
ActivityBarOff
Hides the activity bar.
ActivityBarOn
ActivityBarOn
Shows the activity bar.
You can undock the activity bar and move it anywhere on the screen.
To move the bar, click between the Clear and Clear All buttons and
drag. To redock the activity bar, click the title bar and drag the bar
until it touches the RSView32 status bar.
To resize the activity bar, drag any corner or edge.
H
H
H
A-6
RSView32 commands
ActivityLogSend
ToODBC
ActivityLogSendToOdbc <data_source> <target_table_name>
[/Wn] [/Uuser_name] [/Ppassword]
Exports activity log data from DBF files to the ODBC database. The
connection to the ODBC database is maintained for the length of
time specified by the wait (/W) parameter.
<data_source> A valid ODBC data source name. If the name has a
space embedded in it, enclose the name in
quotes (“”).
<target_table_ The name of a table in the ODBC database where
name>
the data will be exported. If the table does not exist
RSView32 attempts to create it.
[/Wn]
The time the connection to the ODBC database will
be maintained. If nothing is specified, the wait time
defaults to about 5 minutes. A wait time of zero
keeps the connection open until the project is
stopped.
This parameter allows frequent exports to the
database without having to connect every time. Once
the connection is established, RSView32 waits the
specified time and, if another command is received to
export data, the command is executed and the wait
timer is reset. If no command is received within the
wait time, the connection is closed.
[/Uuser_name]A user ID that is valid on the data source.
[/Ppassword] A password that is valid on the data source.
ActivityOff
ActivityOff
Stops activity logging.
ActivityOn
ActivityOn
Starts activity logging.
Activity logging is on by default.
H
H
A-7 H
RSView32 commands
ActivityPrintOff
ActivityPrintOff
Turns off the printing of activity logging. By default, activity log
printing is turned on when you start an RSView32 project.
ActivityPrintOn
ActivityPrintOn
Turns on the printing of activity logging if it has been turned off by
the ActivityPrintOff command. By default, activity log printing is
turned on when you start an RSView32 project.
ActivityViewer
ActivityViewer
Opens the Activity Log Viewer.
AlarmEvent
AlarmEvent <EventName> <EventType> [TagType] [/VTagValue]
[/SSeverity] [/H“Timestamp”] [/L“LogMessage”]
Creates an alarm event. 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 need not, be a tag name in the tag
database. The alarm event name cannot be the name
of an alarm tag.
H
H
H
A-8
RSView32 commands
<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] Indicates that the tag has gone out of
or [Out]
alarm.
[InAndOut
OfAlarm]
or
[InAndOut]
[TagType]
Indicates that an alarm has occurred,
but the tag is again immediately out of
alarm, such as a digital change-of-state
alarm.
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.
H
H
A-9 H
RSView32 commands
[/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 configured for your computer. If
you want to use a 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.
[/LLog
Message]
AlarmLogOff
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.
AlarmLogOff
Stops alarm logging.
AlarmLogOn
AlarmLogOn
Starts alarm logging.
Alarm logging is on by default.
H
H
H
A-10
RSView32 commands
AlarmLogRemark
AlarmLogRemark [“Text”] [/P] [/Sn] [/R] [/Ttagname]
Adds the specified text string as a transaction in the alarm log file.
[“Text”]
[/P]
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.
Prompts the operator for a remark at runtime by
displaying a dialog box containing a text field. 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 runtime, and the operator
can modify or add to the contents of the Text
parameter before it is logged to the alarm log file. If
the tag name (/T parameter) is specified, the prompt
dialog box will display the tag name at runtime, but
the operator cannot change the tag name.
[/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 runtime, but the operator cannot
change the severity.
H
H
A-11 H
RSView32 commands
AlarmLogSend
ToODBC
[/R]
Logs the remark to a printer as well as to the alarm
log file. If the alarm severity is not specified (/Sn
parameter), the printer for Severity 1 is used. If no
printer is assigned to the specified severity, the alarm
log remark is not printed.
[/Ttagname]
The string that is logged in the Tagname column of
the alarm log file. This string can be a tag name, the
name of a user-generated alarm event, or any other
string that matches the syntax of a tag name. You can
use this parameter to correlate remarks with specific
alarm transactions for generating reports later.
AlarmLogSendToOdbc <data_source> <target_table_name> [/Wn]
[/Uuser_name] [/Ppassword]
Exports alarm log data from DBF files to the ODBC database. The
connection to the ODBC database is maintained for the length of
time specified by the wait (/W) parameter.
<data_source> A valid ODBC data source name. If the name has a
space embedded in it, enclose the name in
quotes (“”).
<target_table_ The name of a table in the ODBC database where
name>
the data will be exported. If the table does not exist
RSView32 attempts to create it.
[/Wn]
The time the connection to the ODBC database will
be maintained. If nothing is specified, the wait time
defaults to about 5 minutes. A wait time of zero
keeps the connection open until the project is
stopped.
This parameter allows frequent exports to the
database without having to connect every time. Once
the connection is established, RSView32 waits the
specified time and, if another command is received to
export data, the command is executed and the wait
timer is reset. If no command is received within the
wait time, the connection is closed.
H
H
H
A-12
RSView32 commands
[/Uuser_name]A user ID that is valid on the data source.
[/Ppassword] A password that is valid on the data source.
AlarmOff
AlarmOff
Stops alarm monitoring. Once this command has run, it displays a
message indicating that alarm monitoring has stopped.
AlarmOn
AlarmOn [/H]
Starts alarm monitoring. Once this command has run, it displays a
message indicating that alarm monitoring has started.
[/H]
Turns on handshaking the moment alarm monitoring
starts and sets the handshake bit for any tags in alarm
at that moment.
To have alarming start when a project starts, open the Startup editor
and click the Alarming check box.
AlarmPrintOff
AlarmPrintOff
Stops alarms from printing.
AlarmPrintOn
AlarmPrintOn
Starts alarm printing.
Alarm printing is on by default.
AlarmViewer
AlarmViewer
Opens the Alarm Log Viewer.
H
H
A-13 H
RSView32 commands
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 will read Untitled - Notepad. To close Notepad you must type
exactly what’s in the Notepad title bar as follows:
AppAbort Untitled - Notepad
AppActivate
AppActivate <application>
Activates (pulls forward) the specified Windows application. The
application must already be running. (You can use the AppStart
command to start the application.)
<application> The name of the Windows application you want to
activate. Typically, this is the name that appears in the
application’s title bar.
AppStart
AppStart <application>
Runs the specified application, which can be another Windows
application or an “application extender” you’ve programmed.
<application> The path and executable required to start the
program.
H
H
H
A-14
RSView32 commands
Examples: The AppStart command
AppStart c:windows\notepad c:\autoexec.bat
Opens Notepad and displays the autoexec.bat file.
AppStart c:\Program Files\Plus!\Microsoft
Internet\Iexplore.exe
Opens Internet Explorer.
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.
Channel
Channel
Opens the Channel editor.
CommandLine
CommandLine
Opens the command line.
ComStatus
ComStatus
Obsolete. Use ComStatusOff or ComStatusOn.
H
H
A-15 H
RSView32 commands
ComStatusOff
ComStatusOff
Stops logging of communication errors.
ComStatusOn
ComStatusOn
Starts logging of communication errors if RSView32 is set up to do
so.
To log communication errors, ensure the Communications category
is selected in the Activity Log Setup editor.
To have error logging automatically start when a project starts, open
the Startup editor and click the Communication Status check box.
DatabaseSync
DatabaseSync
Makes RSView32 convert the tag database into binary format the
next time the project opens. Use this command if you change the tag
database that a project uses (using the Project Paths dialog box), after
changing a node’s data source, or after changing a direct driver’s
device type.
To synchronize the tag database:
1. On the command line type DatabaseSync, and then press Enter.
2. Close the project.
3. Open the project. The database will be synchronized as the
project opens.
H
H
H
A-16
RSView32 commands
DataLog
ChangeRate
DataLogMerge
ToPrimary
DataLogChangeRate <file> <value> [unit]
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.
<file>
The name of a data log model, without a file
extension.
<value>
The numeric portion of the time interval for the log
rate. For example, if you want to log data every 20
seconds, the value is 20. The value must be an integer
from 1 to 64,000.
[unit]
The time unit of the log rate: hundredths, tenths,
seconds, minutes, hours, or days. If you omit the
[unit] parameter, the default is seconds.
DataLogMergeToPrimary <parameter>
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.
<file>
The name of a data log model, without a file
extension.
*
Moves data for all models that are currently running.
You can use the DataLogMergeToPrimary<file> command whether
or not the specified model is running. If a model is running when
you issue the DataLogMergeToPrimary command, RSView32
switches back to the primary path or ODBC database. If a model
uses the .dbf format, RSView32 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, RSView32 merges the ODBC
backup files into the ODBC database and continues logging to the
ODBC database.
H
H
A-17 H
RSView32 commands
DataLogNewFile
DataLogNewFile <parameter>
Creates a new data log file for the specified model or for all models,
on the path RSView32 is currently logging to (either the primary
path or the backup path). If RSView32 is logging to an ODBC
database, RSView32 logs an End snapshot and then a Begin snapshot
when you issue this command.
DataLogOff
<file>
The name of the data log model, without a file
extension.
*
Creates new files for all models that are currently
running.
DataLogOff <parameter>
Stops data logging for a specified model or stops data logging for all
models.
DataLogOn
<file>
The name of a data log model, without a file
extension.
*
Stops data logging for all models.
DataLogOn <file>
Starts data logging for the specified model.
<file>
The name of a data log model, without a file
extension.
To have data logging automatically start when a project starts, open
the Startup editor, click the Data Logging check box and specify a
file.
H
H
H
A-18
RSView32 commands
DataLogPath
DataLogPath <file>
Opens the Data Log Path editor. You can use the editor to change
the primary and secondary paths for dBASE IV data log models, and
the backup path for ODBC data log models. You cannot change the
ODBC database using the Data Log Path editor.
<file>
DataLog
RenameFile
DataLogSnapshot
The name of a data log model, without a file
extension.
DataLogRenameFile <file> <LogFileIDString>
Changes the log file identifier string that is used as part of the file
name for dBASE IV log files and ODBC backup files that use long
file names. The change affects the current logging session only,
including the current set of log files.
<file>
The name of a data log model, without a file
extension.
<LogFileID
String>
The log file identifier string, up to 20 characters.
DataLogSnapshot <parameter>
Logs one snapshot of data to the data log file, for the specified model
or all models.
<file>
The name of the data log model, without a file
extension.
*
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.
H
H
A-19 H
RSView32 commands
DataLog
SwitchBack
DDEExecute
DataLogSwitchBack <parameter>
Switches data logging back to the primary dBASE IV file 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, RSView32 is logging data to the secondary or backup path,
and the primary path or ODBC database is available. For .dbf files,
RSView32 creates a new set of files when it switches back to the
primary path.
<file>
The name of the data log model, without a file
extension.
*
Switches data logging for all models that meet the
conditions outlined above.
DDEExecute <application>|<topic> <command>
Sends a command or series of commands to an application through a
DDE channel.
<application> The name of the server application you want to send
a command to. This is usually the name of the
application’s .exe file without the .exe extension.
<topic>
The name of the subject of the communication,
preceded by the | character. Many applications that
support DDE recognize a topic named System,
which is always available.
<command>
A command or series of commands recognized by the
server application. Multiple commands must be in
one string.
If the command string contains an exclamation mark (!), enclose the
string in quotes. If the string includes quotes, use double quotes.
IMPORTANT Before using the DDEExecute command, the server application must be
running (but it can be minimized).
H
H
H
A-20
RSView32 commands
Examples: The DDEExecute command
DDEExecute RSlinx|__Drivers [Who_Active()]
Sends the Who_Active command, which displays the default RSLinx
RSWho window.
Drivers must be preceded by two underscores.
DDEExecute WINAB5|SYSTEM .SR 3
Sends WINtelligent LOGIC 5t (WINAB5) the Dot command
SR 3, which means search for Rung 3.
DDEExecute WINAB5|SYSTEM .UI
Sends WINtelligent LOGIC 5 (WINAB5) the Dot command UI,
which displays the System Information window.
DDEExecute Winrecip|IcomDdeExe
[CONTROL_PANEL_DEFAULTS ()]
Sends WINtelligent RECIPEt the
CONTROL_PANEL_DEFAULTS command, which opens the
default WINtelligent RECIPE Control Panel.
DDEPokeDisable
DDEPokeDisable
Obsolete. Use RTDataWriteDisable.
DDEPokeEnable
DDEPokeEnable
Obsolete. Use RTDataWriteEnable.
DDEServerOff
DDEServerOff
Obsolete. Use RTDataServerOff.
H
H
A-21 H
RSView32 commands
DDEServerOn
DDEServerOn
Obsolete. Use RTDataServerOn.
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 RSView32 is restarted. Symbols are
typically defined in a startup or login macro.
<symbol>
The abbreviated command. It cannot contain spaces.
[string]
An existing command with or without parameters. It
can contain spaces and other non-alphanumeric
characters. Omitting the [string] parameter deletes
the symbol definition.
See also Undefine.
Examples: The Define command
Define Di Display
Creates the symbol Di for the command Display. Typing Di as a
command in any valid command syntax will have the same effect as
typing Display.
Define Show Display Overview /CC
Creates the symbol Show for the command Display Overview /CC.
Whenever Show is used, the graphic called Overview is displayed in
the center of the screen.
Define Di
Deletes the symbol Di.
H
H
H
A-22
RSView32 commands
DerivedOff
DerivedOff <file>
Stops running the specified derived tag file.
<file>
DerivedOn
The name of a derived tag file without a file
extension.
DerivedOn <file>
Starts running the specified derived tag file.
<file>
The name of a derived tag file without a file
extension.
To have a derived tag file automatically start when a project starts,
open the Startup editor, click the Derived Tags check box and specify
a file.
Display
Display <file> [/B] [/E] [/U] [/O] [cache] [/Pfile] [/Ttag_name]
[/Hnnn] [/Wnnn] [/Min] [/Max] [position]
Runs the specified graphic display file. Parameters specified here
override settings in the Display Settings dialog box in the Graphic
Display 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
runtime, 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.
<file>
The name of a graphic display file without a file
extension.
[/B]
Displays the specified graphic display in the
background.
H
H
A-23 H
RSView32 commands
[/E]
Disables the Enter key so it does not download
values in numeric input fields to the programmable
controller or server, unless the Display On-Screen
Keyboard option is selected (in the Behavior tab of
the Display Settings dialog box).
[/U]
Updates tag values in all input fields when the display
first opens.
[/O]
Suppresses the display of the key list.
[cache]
Specifies how to load the specified graphic display
into the display cache, as follows:
/Z
Loads the specified graphic display
into the cache (but does not make it
visible), so the display appears
quickly when it is first used.
/ZA
Loads the specified graphic display
into the cache (but does not make it
visible) and continually updates the
graphic display, even when it is not
visible. For example, use /ZA for a
display that contains a realtime 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 [file]
command.
[/Pfile]
The name of the parameter file 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 file has a long file name, enclose the
file name in quotes, for example /P“Long file name”.
H
H
H
A-24
RSView32 commands
[/Ttag_name] One or more tags, separated by commas and no
spaces, to be substituted for placeholders in the
display. If the display does not contain placeholders,
do not use this parameter.
[/Hnnn]
Specifies the height of the graphic display in pixels.
[/Wnnn]
Specifies the width of the graphic display in pixels.
[/Min]
Runs the graphic display minimized (as an icon).
[/Max]
Runs the graphic display maximized (full-screen
size).
[position]
Specifies the position of the window as follows:
/Q1
top right corner
/Q2
top left corner
/Q3
bottom left corner
/Q4
bottom right corner
/CT
centered in the top half
/CB
centered in the bottom half
/CL
centered on the left side
/CR
centered on the right side
/CC
centered in the screen
/Xnnn
nnn pixels from the left edge
/Ynnn
nnn pixels down from the top
Examples: The Display command
Display Sample
The first time the graphic display called Sample is opened, it is
positioned and sized as specified in its Display Settings dialog box.
When the display is closed, its size and position will be saved, so the
next time it is opened it will be the same size and position as when it
was last closed.
Display Picture /PNames /CB
Positions the graphic display called Picture in the bottom half of the
screen, using the file called Names to replace tag placeholders with
tag names.
H
H
A-25 H
RSView32 commands
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.
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.
H
H
H
A-26
RSView32 commands
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.
DriverPrimary
DriverPrimary <channel>
Switches from the secondary driver to the primary driver on the
specified channel.
<channel>
DriverSecondary
The number of the channel (1 through 4) that is being
switched from its secondary to primary driver.
DriverSecondary <channel>
Switches from the primary driver to the secondary driver on the
specified channel.
<channel>
DriverToggle
The number of the channel (1 through 4) that is being
switched from its primary to secondary driver.
DriverToggle <channel>
Switches from the current driver to the one not being used on the
specified channel.
<channel>
The number of the channel (1 through 4) that is being
switched from one driver to another.
H
H
A-27 H
RSView32 commands
EchoOff
EchoOff
Stops logging commands to the activity log file. Other activities,
such as errors and tag values, are still logged.
This command is normally used in macros to prevent the contents of
the macro from being logged.
EchoOn
EchoOn
Restores logging to normal after an EchoOff command.
EventOff
EventOff <file>
Stops running the specified event file.
<file>
EventOn
The name of an event file without a file extension.
EventOn <file>
Starts running the specified event file.
<file>
The name of an event file without a file extension.
To have an event file automatically start when a project starts, open
the Startup editor, click the Event Detector check box and specify a
file name.
FlushCache
FlushCache [file]
Without the parameter, unloads all graphic displays from the display
cache. With the parameter, unloads the specified graphic display
from the display cache.
[file]
H
H
H
A-28
The name of a graphic display file without a file
extension.
RSView32 commands
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
Display editor. You can cache up to 40 graphic displays.
If a display uses the Always Updating option with the Cache After
Displaying option, the display’s shutdown command is executed
when you issue the FlushCache command.
HandshakeOff
HandshakeOff
Disables alarm handshaking, regardless of whether the individual
handshake bits are configured. This command gives no indication
that it has run but will display an error message if not executed
properly.
HandshakeOn
HandshakeOn
Enables alarm handshaking. By default this setting is off.
Handshaking can be disabled with the HandshakeOff command.
This command gives no indication that it has run but will display a
message if not executed properly.
IMPORTANT This command will not set the handshake bit for any tag already
in alarm when the command is executed.
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
H
H
A-29 H
RSView32 commands
[/Ffile]
The name of a Windows help file. The default help
file is for RSView32.
If no search word is specified, the command opens the RSView32
help file and displays the Contents topic.
Example: Opening Help for the RSGauge ActiveX object
Help /fc:\windows\system\RSGauge.hlp
Opens the RSTools help file for the RSGauge ActiveX object.
Identify
Identify [tag_name]
Runs the command or macro associated with the named tag, whether
or not the tag is in alarm.
[tag_name]
The name of the tag in alarm. The command or
macro associated with this tag will run. 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.
Running the Identify command is not the same as acknowledging an
alarm.
IMPORTANT When many alarms are occurring rapidly, do not use the Identify
command without a tag name. A new alarm could become the current
alarm before the Identify command runs, and the command or macro that
runs might not be the one expected.
H
H
H
A-30
RSView32 commands
Examples: The Identify command
Identify Hopper1\Divider
Runs the Identify command or macro for the tag Hopper1\Divider,
whether or not the tag is in alarm.
Identify [tag]
Runs the Identify command or macro for the selected tag in the
active graphic display.
Identify
Runs the Identify command or macro for the most recent, most
severe unacknowledged alarm.
Invoke
Invoke <parameter>
Use this command with ActiveX objects. Use the 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
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:
file.object.method(parameter1, parameter2, . . .) calls an object’s
method
file
The name of the graphic display that contains the
ActiveX object
me
An alternative to using file. At runtime it resolves
to the graphic file that has focus.
H
H
A-31 H
RSView32 commands
object
The name of the ActiveX object as specified in the
Object Name dialog box in the Graphic Display
editor.
method
The name of a function or sub-routine in the
ActiveX 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.
You must specify all of the parameters, even those
that are optional.
tag_name=file.object.method(parameter1, parameter2, . . .) assigns
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 will be assigned.
file.object.property(tag_name or constant) sets an object’s property
to the specified tag’s value or to a constant value
tag_name=file.object.property sets the specified tag’s value to the
value of the object’s property
Key
Key <parameter>
Starts or stops running the global key file.
<parameter> One of the following:
file
The name of a global key file without a file extension.
/R
Stops running the global key file.
To have a global key file automatically start when a project starts,
open the Startup editor, click the Global Key File check box and
specify a file.
H
H
H
A-32
RSView32 commands
Login
Login [username] [password]
Logs users into the system. To log in, users must have an account in
the User Accounts editor.
[username]
The user’s name as defined in the User Accounts
editor.
[password]
The user’s password as defined in the User Accounts
editor. If this parameter is omitted, a window appears
prompting the user to enter the password.
Using this command with both parameters logs the user into the
system. Using this command with only one parameter displays the
login dialog box.
Logout
Logout
Logs the current user off the system.
Monitor
Monitor [file][/Xnnn] [/Ynnn][/Ttag_name]
In edit mode, without the [file] parameter, opens the Tag Monitor
editor; with the [file] parameter, opens the specified tag monitor file.
In run mode, with the [file] parameter, opens the specified tag
monitor file. With the [/Ttag_name] parameter, opens a tag monitor
containing the specified tags.
[file]
The name of a tag monitor file without a file
extension.
[/Xnnn]
Positions the tag monitor nnn pixels from the left
edge of the screen. The width depends on screen
resolution.
[/Ynnn]
Positions the tag monitor nnn pixels from the top
edge of the screen. The height depends on screen
resolution.
H
H
A-33 H
RSView32 commands
[/Ttag_name] The name of a tag. You can use wildcards and can
name more than one tag. Precede each tag name with
a space and /T.
You can monitor up to 100 tags in one file.
Examples: The Monitor command
Monitor /THopper1\Flow
Opens a tag monitor displaying the tag Hopper1\Flow.
Monitor /THopper1\Flow /THopper\Temp
Opens a tag monitor displaying the tags Hopper1\Flow and
Hopper\Temp.
Monitor /T*
Displays information on the first 100 tags in the tag database.
Monitor /THopper*\Divider
Displays information on the first 100 tags called Divider from all
folders beginning with Hopper.
Monitor Bread
Displays the tag monitor file called Bread.
NextPosition
NextPosition
Moves focus to the object with the next highest 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.
H
H
H
A-34
RSView32 commands
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.
Node
Node
Opens the Node editor.
NodeDisable
NodeDisable <node name>
Disables the specified node.
<node name> The name of the node you want to disable.
NodeEnable
NodeEnable <node name>
Enables the specified node.
<node name> The name of the node you want to enable.
NodeSwitch
NodeSwitch <node name> <parameter>
Permanently changes a device node’s address, an OPC node’s
computer name, server name, and access path, or a DDE node’s
application and topic.
<node name> The name of the node that you want to switch to
another programmable controller address, server, or
application.
<parameter> One of the following:
station
For device nodes, the physical address for the
programmable controller you want to switch to.
H
H
A-35 H
RSView32 commands
\\computer
name\server
name[|access
path]
For OPC servers, the computer name, server name,
and access path (if in use) for the OPC server you
want to switch to. Separate the access path from the
server name with the | character.
application|
topic
For DDE servers, the application and topic, separated
by the | character, for the DDE server you want to
switch to.
When you use the NodeSwitch command to change a node’s address
or server information, the change appears in the Node editor’s
spreadsheet. If the Node editor is open when you use the command,
the change won’t appear until you’ve refreshed the display by
closing and re-opening the editor.
Password
Password
Displays the Password dialog box so users can change their
password. Users must already be logged in to use this command.
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>
PlayWave
The number of seconds that will elapse between the
execution of the first and second command.
PlayWave <file>
Plays the specified wave file.
<file>
H
H
H
A-36
The complete path to the wave file, including the
.wav extension.
RSView32 commands
Position
Position <n>
Moves focus to the object with the specified 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
This command operates on the active graphic display. If no display is
active, this command is ignored.
See also PrevPosition and NextPosition
PrevPosition
PrevPosition
Moves focus to the object with the previous 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.
H
H
A-37 H
RSView32 commands
PrintDisplay
PrintDisplay [parameter] [/Wait=tttt] [/U] [/Pfile] [/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:
file
The name of a graphic display file
without a file extension.
me
The current graphic display (the
display from which the command
is executed).
[/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.
[/Pfile]
Specifies the name of a parameter file 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, RSView32 prints the
display without making it visible. If this command is issued without
specifying a display, and no display has focus, RSView32 logs an
error to the activity log.
PrintDisplay prints the entire runtime display, even if parts are
covered by other displays. However, PrintDisplay does not
necessarily print ActiveX or OLE objects in their runtime state.
The ScreenPrint command prints an image of whatever shows on the
monitor. Use ScreenPrint to ensure that the display is printed
showing all objects in their current, runtime state (provided they are
not covered by other displays).
H
H
H
A-38
RSView32 commands
If you issue the PrintDisplay command when RSView32 is in Edit
mode, RSView32 sends the last-saved version of the display file to
the printer. Any changes you make after saving the display are not
reflected in the printout. To ensure the printout is up-to-date, save
the display before printing it.
Project
Project
Obsolete. Use ProjectHide, ProjectRun, ProjectShow, or
ProjectStop.
ProjectHide
ProjectHide
Hides the Project Manager so it is not visible on the screen.
Ctrl-Alt-P also hides the Project Manager if it is visible.
ProjectRun
ProjectRun
Starts running the project. This is the same as choosing the Run
Project button in the Run Mode tab of the Project Manager.
ProjectShow
ProjectShow
Displays a hidden Project Manager.
Ctrl-Alt-P also shows the Project Manager if it is hidden.
ProjectStop
ProjectStop
Stops running the project. This is the same as choosing the Stop
Project button in the Run Mode tab of the Project Manager.
H
H
A-39 H
RSView32 commands
PullForward
PullForward <file>
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.
<file>
The name of an open graphic display file without a
file extension.
If the specified display is of the Replace or Overlay type, and if no
other Replace or Overlay displays are open, nothing happens when
you issue this command.
PushBack
PushBack <file>
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.
<file>
The name of an open graphic display file without a
file extension.
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.
Quit
Quit [/R]
Quits RSView32, stopping all project components, and returns to
Windows.
[/R]
H
H
H
A-40
Restarts the computer.
RSView32 commands
Ramp
Ramp [/V] <tag_name> <value>
Increases or decreases a tag value by a particular value or by another
tag’s value.
Use this command only with analog tags.
[/V]
Performs a read immediately after the write to verify
that the value was altered in the programmable
controller or server.
This parameter is useful if the network is in poor
condition or susceptible to noise interference.
If the verification fails, the error message is logged to
the activity log, activity bar, or printer using the Tag
Write category. Specify where to send Tag Write
errors using the Categories tab of the Activity Log
Setup editor.
<tag_name>
The name of an analog tag.
<value>
The amount to add or subtract from the current
programmable controller value, as follows:
plus (+) or minus (-) a numeric value
plus (+) or minus (-) a percentage of a numeric
value in the form: +value%
plus (+) or minus (-) a tag
If Ramp calculates a value that is outside of the tag’s minimum and
maximum range, it will write the highest or lowest allowable value to
the programmable controller or server.
IMPORTANT If you use the Ramp command in a macro, you must use two percent
signs (%%) instead of one. A single percent sign is used in a macro to
indicate a parameter. For example, to create a macro that increases the
value of tag1 by 75%, you would type: Ramp tag1 + 75%%
H
H
A-41 H
RSView32 commands
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 <file>
Reads the values from a recipe file into all input fields in the active
graphic display. This command is used with the Recipe field.
<file>
The name of the file, without a file extension, tag
values are read from.
This command operates on the active graphic display. If no display is
active, this command is ignored.
H
H
H
A-42
RSView32 commands
RecipeSave
RecipeSave <file>
Saves the values in all input fields of the active graphic display to a
recipe file. This command works with the Recipe field.
<file>
The name of the file, without a file extension, to
which the values will be saved. If a file of this name
does not exist, it is created. If a file of this name does
exist, this command prompts you to overwrite it.
This command operates on the active graphic display. If no display is
active, this command is ignored.
Remark
Remark <comment>
Writes a text string to an activity log file, which is useful for
operators to store comments.
<comment>
A string up to 132 characters long. The string can
contain any characters, including spaces. Enclose the
exclamation mark (!) and the semi-colon (;) in single
or double quotes.
To log comments, the Remarks category must be selected in the
Activity Log Setup editor.
RTDataServerOff
RTDataServerOff
Stops running the RSView32 realtime data server.
H
H
A-43 H
RSView32 commands
RTDataServerOn
RTDataServerOn [/Quiet] [/NetDDE]
The RSView32 OPC or DDE server is also known as the realtime
data server. This command runs the RSView32 realtime data server,
allowing OPC and DDE client applications to read (but not write)
tag values.
To enable writes, use the RTDataWriteEnable command.
RTDataWrite
Disable
[/Quiet]
Makes RSView32 use the current Remote Users
accessibility setting in the Windows Registry.
Without this parameter or if the setting is not
configured correctly, RSView32 displays a dialog box
that allows you to specify the setting when you issue
the command.
[/NetDDE]
Enables RSView32 as a NetDDE server to remote
DDE clients. If the realtime data server is already
running, this parameter is ignored.
RTDataWriteDisable [/Quiet] [/NetDDE]
Disables writes by external Windows applications running OPC or
DDE, so these applications cannot change tag values in RSView32.
The RSView32 OPC or DDE server is also known as the realtime
data server. If the RSView32 realtime data server is not running—that
is, if the RTDataServerOn command has not been
run—RTWriteDisable also starts the RSView32 realtime data server.
H
H
H
A-44
[/Quiet]
Makes RSView32 use the current Remote Users
accessibility setting in the Windows Registry.
Without this parameter or if the setting is not
configured correctly, RSView32 displays a dialog box
that allows you to specify the setting when you issue
the command.
[/NetDDE]
Enables RSView32 as a NetDDE server to remote
DDE clients. If the realtime data server is already
running, this parameter is ignored.
RSView32 commands
By default, writes are disabled. Therefore, the RTDataWriteDisable
command is required only after the RTDataWriteEnable command
has been used.
RTDataWrite
Enable
RTDataWriteEnable [/Quiet] [/NetDDE]
Enables writes by external Windows applications using OPC or
DDE, so these applications can change tag values in RSView32.
The RSView32 OPC or DDE server is also known as the realtime
data server. If the RSView32 realtime data server is not running—that
is, if the RTDataServerOn command has not been
run—RTDataWriteEnable also starts the RSView32 realtime data
server.
[/Quiet]
Makes RSView32 use the current Remote Users
accessibility setting in the Windows Registry.
Without this parameter or if the setting is not
configured correctly, RSView32 displays a dialog box
that allows you to specify the setting when you issue
the command.
[/NetDDE]
Enables RSView32 as a NetDDE server to remote
DDE clients. If the realtime data server is already
running, this parameter is ignored.
By default, writes are disabled.
ScreenPrint
ScreenPrint
Generates a screen print on the default printer specified in Windows.
See also PrintDisplay.
H
H
A-45 H
RSView32 commands
SendKeys
SendKeys <“keystring”>
Sends the specified keystrokes to the active window.
<“keystring”> A list of keys. The quotes must be included.
The following syntax rules apply:
Use braces { } to enclose special keys, such as F3 or Enter; for
example, “{Enter}” sends Enter.
Use ^ to send a control key. For example, “^{F2}” sends Ctrl-F2.
Use + to send a shift key. For example, “+{F3}” sends Shift-F3.
Use % to send an alt key. For example, “%A” sends Alt-A.
Special keys can be in upper and/or lower case letters. You can type
any of the following to represent the special keys on the keyboard:
Backspace, BkSp, BS
End
Enter
Escape, Esc
Delete, Del
Down
F1 to F12
Home
Set
Insert
Left
PgDn
PgUp
PrtSc
Right
Tab
Up
[&]Set [/V] <tag_name> <value>
Writes a value to a tag.
IMPORTANT If a node has been disabled, the Set command changes the value in the
value table but not in the programmable controller.
H
H
H
A-46
RSView32 commands
[&]
Forces the command to be executed asynchronously,
which makes the command faster.
[/V]
Performs a read immediately after the write to verify
that the value was altered in the programmable
controller or server.
This parameter is useful if the network is in poor
condition or susceptible to noise interference.
If the verification fails, the error message is logged to
the activity log, activity bar, or printer using the Tag
Write category. Specify where to send Tag Write
errors using the Categories tab of the Activity Log
Setup editor.
<tag_name>
The name of a tag.
<value>
One of the following:
For analog tags:
Numeric value within the range specified by the tag’s minimum
and maximum values.
Percentage of the total min/max range. The formula is:
value = min + percentage/100 * (max - min)
Tag name of another analog or digital tag.
For digital tags:
Numeric value of 0 or 1.
Tag’s on or off label 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.
Name of another analog or digital tag. If it is an analog tag with a
value that is not 0, the value 1 is written to the digital tag,
otherwise the value 0 is written.
For string tags:
String enclosed in quotation marks. The string can contain any
character and can include spaces.
Name of another string tag.
H
H
A-47 H
RSView32 commands
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 Valve\23 open
Valve\23 is a digital tag with its on label configured 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.
SetFocus
SetFocus <file>
Sets the focus to a particular graphic display.
<file>
H
H
H
A-48
The name of a graphic display file without a file
extension.
RSView32 commands
Silence
Silence <tag_name>
If the alarm for the specified tag is configured to use the internal bell,
this command silences the computer’s sound.
If the alarm for the specified tag is configured to use the external bell,
this command resets the tag associated with the external bell and
silences the associated audio device.
<tag_name>
SilenceAll
The name of a tag that is in alarm. You can use
wildcards.
SilenceAll
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.
Summary
Summary <file> [/Xnnn] [/Ynnn]
Runs the specified alarm summary file.
<file>
The name of an alarm summary file without a file
extension.
[/Xnnn]
Positions the X coordinate of the alarm summary
window to nnn pixels from the left edge of the
screen. Valid range depends on screen resolution.
[/Ynnn]
Positions the Y coordinate of the alarm summary
window to nnn pixels from the top edge of the
screen. Valid range depends on screen resolution.
H
H
A-49 H
RSView32 commands
Suppressed
Suppressed
Opens the Suppressed List editor.
SuppressOff
SuppressOff <tag_name>
Restores alarm reporting for the specified suppressed alarm.
<tag_name>
SuppressOffAll
The name of a tag that no longer requires alarm
suppression. You can use wildcards.
SuppressOffAll
Restores alarm reporting for all suppressed alarms.
This command is faster than the SuppressOff * command.
SuppressOn
SuppressOn <tag_name>
Suppresses reporting of alarms for the specified tag.
<tag_name>
The name of a tag, or a wildcard.
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.
H
H
H
A-50
RSView32 commands
Toggle
Toggle [/V] <tag_name>
Reads the tag’s value and writes back a 1 or 0 as follows:
if the tag value is 0, Toggle changes it to 1
if the value is not 0, Toggle changes it to 0
[/V]
Performs a read immediately after the write to verify
that the value was altered in the programmable
controller or server.
This parameter is useful if the network is in poor
condition or susceptible to noise interference.
If the verification fails, the error message is logged to
the activity log, activity bar, or printer using the Tag
Write category. Specify where to send Tag Write
errors using the Categories tab of the Activity Log
Setup editor.
<tag_name>
Undefine
The name of an analog or digital tag.
Undefine <symbol>
Deletes a symbol definition that was created using the Define
command.
Example: The Undefine command
Undefine test
Deletes the definition for the symbol “test” that was previously
created with the Define command.
Undefine *
Deletes all symbol definitions.
See also Define.
H
H
A-51 H
RSView32 commands
Upload
Upload
In a graphic display, reads a value from the programmable controller
or server and displays it in the selected input field.
This command operates on the active graphic display. If no display is
active, this command is ignored.
Ctrl-PgUp also uploads the value to the selected input field.
UploadAll
UploadAll
In a graphic display, reads values from the programmable controller
or server and displays them in all the input fields.
This command operates on the active graphic display. If no display is
active, this command is ignored.
PgUp also uploads all the values to the input fields.
VbaExec
VbaExec <program_name> [parameters]
Runs a VBA program.
H
H
H
A-52
<program
_name>
The name of the program as specified in the Sub
statement.
[parameters]
Any argument that a particular program requires.
Separate arguments with commas.
Index
Symbols
.rsv file, 2-5
.wav files, A-15, A-36
[tag] parameter, using
to acknowledge alarms, A-5
with the Identify command, A-30
= (Equal) command, A-2
A
Abort command, A-4
Account command, A-5
Acknowledge command, A-5
AcknowledgeAll command, A-6
Activating RSView32 Runtime, 1-5
after installation, 1-7
moving activation keys, 1-6, 1-7
reactivating damaged key, 1-6, 1-9
troubleshooting, 1-10
with reset code, 1-9
Activation disk
moving activation keys, 1-6
protecting files, 1-8
ActiveX methods, A-31
ActiveX properties, A-31
Activity commands
ActivityBarOff, A-6
ActivityBarOn, A-6
ActivityLogSendToODBC, A-7
ActivityOff, A-7
ActivityOn, A-7
ActivityPrintOff, A-8
ActivityPrintOn, A-8
ActivityViewer, A-8
ComStatusOff, A-16
ComStatusOn, A-16
EchoOff, A-28
EchoOn, A-28
Remark, A-43
Activity Log Viewer, opening, 2-6
ActivityLogSendToODBC command, A-7
ActivityPrintOff command, A-8
ActivityPrintOn command, A-8
Adding files to a project, 2-10
Alarm commands
Acknowledge, A-5
AcknowledgeAll, A-6
AlarmEvent, A-8
AlarmLogOff, A-10
AlarmLogOn, A-10
AlarmLogRemark, A-11
AlarmLogSendToODBC, A-12
AlarmOff, A-13
AlarmOn, A-13
AlarmPrintOff, A-13
AlarmPrintOn, A-13
AlarmViewer, A-13
HandshakeOff, A-29
HandshakeOn, A-29
Identify, A-30
Silence, A-49
SilenceAll, A-49
Summary, A-49
Suppressed, A-50
SuppressOff, A-50
SuppressOffAll, A-50
SuppressOn, A-50
Alarm Log Viewer, opening, 2-6
AlarmEvent command, A-8
AlarmLogRemark command, A-11
AlarmLogSendToODBC command, A-12
AlarmPrintOff command, A-13
AlarmPrintOn command, A-13
H
H
I-1 H
Index
Allen-Bradley devices, connecting to, 2-7
Application commands
AppAbort, A-14
AppActivate, A-14
AppStart, A-14
Applications, Windows, A-14
Asynchronous execution
and the = (Equal) command, A-2
and the Pause command, A-36
and the Set command, A-47
B
Beep command, A-15
C
Changing passwords, 3-3
Channel commands
Channel, A-15
DriverPrimary, A-27
DriverSecondary, A-27
DriverToggle, A-27
Channel editor, using to select drivers, 2-7
Channels, setting up, 2-7
Command line, opening, 2-6
CommandLine command, A-15
Commands. See Appendix A; Individual
command entries
Communications commands
ComStatusOff, A-16
ComStatusOn, A-16
DriverPrimary, A-27
DriverSecondary, A-27
DriverToggle, A-27
NodeDisable, A-35
NodeEnable, A-35
NodeSwitch, A-35
RTDataServerOff, A-43
RTDataServerOn, A-44
RTDataWriteDisable, A-44
H
H
H
I-2
RTDataWriteEnable, A-45
Components
adding, 2-10
changing the path to, 2-9
running, 2-6
Connecting
to device drivers, 2-7
to OPC and DDE servers, 2-7
D
Data logging
changing rate at runtime, A-17
on demand, A-19
paths, A-19
moving data between, A-17
switching at runtime, A-20
setting up, A-19
starting and stopping, A-18
Data logging commands
DataLogChangeRate, A-17
DataLogMergeToPrimary, A-17
DataLogNewFile, A-18
DataLogOff, A-18
DataLogOn, A-18
DataLogPath, 2-11, A-19
DataLogRenameFile, A-19
DataLogSnapshot, A-19
DataLogSwitchBack, A-20
Data logging paths, changing at runtime,
2-11
DatabaseSync command, A-16
Date format, specifying, 2-3
DDE
and RSLinx, A-21
and WINtelligent LOGIC 5, A-21
and WINtelligent RECIPE, A-21
connecting to devices, 2-7
RSView32 as server, enabling, A-44
for tag writes, A-45
Index
server, 2-7
setting up, 2-7
switching applications, 2-7
switching topics, 2-7
DDE commands
DDEExecute, A-20
NodeDisable, A-35
NodeEnable, A-35
NodeSwitch, A-35
RTDataServerOff, A-43
RTDataServerOn, A-44
RTDataWriteDisable, A-44
RTDataWriteEnable, A-45
DDE nodes, changing at runtime, A-35
Define command, A-22
Demo mode, for RSView32 runtime, 1-5
Derived tag commands
DerivedOff, A-23
DerivedOn, A-23
Device nodes, changing at runtime, A-35
Devices
direct driver, 2-7
OPC and DDE, 2-7
Disks, ordering, 1-5
Display command, A-23
Download command, A-26
DownloadAll command, A-27
Driver commands
DriverPrimary, A-27
DriverSecondary, A-27
DriverToggle, A-27
E
EchoOff command, A-28
EchoOn command, A-28
Editors, opening, 2-6
Event commands
EventOff, A-28
EventOn, A-28
Evmove.exe, 1-6, 1-7, 1-8
Expressions, in the = (Equal) command,
A-2
F
File types, sound, .wav, A-15, A-36
Files
.rsv file, 2-5
adding to a project, 2-10
changing paths, 2-8
referencing the physical file, 2-10
FlushCache command, A-28
G
Global key commands, Key, A-32
Graphic display commands
Abort, A-4
Display, A-23
Download, A-26
DownloadAll, A-27
FlushCache, A-28
NextPosition, A-34
NextWindow, A-35
Position, A-37
PrevPosition, A-37
PrevWindow, A-37
PrintDisplay, A-38
PullForward, A-40
PushBack, A-40
RecipeRestore, A-42
RecipeSave, A-43
ScreenPrint, A-45
SendKeys, A-46
SetFocus, A-48
Upload, A-52
UploadAll, A-52
H
H
I-3 H
Index
Graphic displays
caching, with the Display command,
A-23
displaying in background, A-23
moving among, A-40
positioning, A-25
printing, A-38
reducing call-up time of, A-24
sizing, A-25
using parameter files in, A-24
H
HandshakeOff command, A-29
HandshakeOn command, A-29
Hardware requirements, 1-1
Help, online, P-1
Help command, A-29
I
Identify command, A-30
Input field commands
Display, /U parameter, A-24
Download, A-26
DownloadAll, A-27
NextPosition, A-34
Position, A-37
PrevPosition, A-37
SendKeys, A-46
Upload, A-52
UploadAll, A-52
Input fields
updating tag values in, A-24
using keys with
Shift-Tab, A-37
Tab, A-34
Installing RSView32 Runtime, 1-4
Invoke command, A-31
H
H
H
I-4
K
Key command, A-32
Keyboard, on-screen, A-24
Keys
See also Special keys
activation keys, 1-6
L
Log files, viewing, 2-6
Logging in at runtime, 3-2
Login, command, A-33
Logout, command, A-33
M
Master disk. See Activation disk
Method, ActiveX, A-31
Microsoft DCOM, 1-5
Monitor command, A-33
Moving projects between computers, 2-2
N
NetDDE, A-44, A-45
NextPosition command, A-34
NextWindow command, A-35
Node commands
Node, A-35
NodeDisable, A-35
NodeEnable, A-35
NodeSwitch, 2-7, A-35
Node editor, 2-7
Number format, specifying, 2-3
Index
O
On-screen keyboard, A-24
Online help, P-1
OPC
connecting to devices, 2-7
RSView32 as server, enabling, A-44
for tag writes, A-45
server, 2-7
configuring, 1-5
setting up, 2-7
switching, 2-7
switching access paths, 2-7
OPC commands
NodeDisable, A-35
NodeEnable, A-35
NodeSwitch, A-35
RTDataServerOff, A-43
RTDataServerOn, A-44
RTDataWriteDisable, A-44
RTDataWriteEnable, A-45
OPC nodes, changing at runtime, A-35
P
Parameter files, A-24
Password command, 3-3, A-36
Passwords, changing at runtime, 3-3
Path
to log data to, changing, 2-11
to project files, changing, 2-8
Pause command, A-36
PlayWave command, A-36
Position command, A-37
PrevPosition command, A-37
PrevWindow command, A-37
PrintDisplay command, A-38
Project commands
ProjectHide, A-39
ProjectRun, A-39
ProjectShow, A-39
ProjectStop, A-39
Quit, A-40
Project directory, changing the path to, 2-8
Project Manager
adding components to, 2-10
using, 2-6
Project paths, updating, 2-8
Projects
adding files to, 2-10
adding users, 3-1
changing passwords, 3-3
changing paths, 2-8
commands, ProjectStop, 2-11
editing users, 3-1
logging in, 3-2
moving from another computer, 2-2
opening, 2-5
running, 2-4, 2-9
automatically, 2-10
manually, 2-9
stopping, 2-11
updating paths, 2-8
working with, 2-1
Property, ActiveX, A-31
PullForward command, A-40
PushBack command, A-40
Q
Quit command, A-40
H
H
I-5 H
Index
H
H
H
I-6
R
S
Ramp command, A-41
ReadMe file, described, P-1
Realtime data server. See DDE server;
OPC server
Recipe commands
Download, A-26
DownloadAll, A-27
RecipeRestore, A-42
RecipeSave, A-43
Upload, A-52
UploadAll, A-52
Remark command, A-43
Requirements, hardware and software, 1-1
Reset.exe, 1-6, 1-9
RSLinx, and DDE, A-21
RSLinx drivers, 2-7
RSView32 commands. See Appendix A;
Individual command entries
RSView32 Runtime
activating, 1-5
demo mode, 1-5
described, P-1
documentation, P-1
hardware and software requirements, 1-1
starting, 2-4
starting automatically, 2-4
uninstalling, 1-10
RSView32 Works, running projects, 2-1
RTDataServerOff command, A-43
RTDataServerOn command, A-44
RTDataWriteDisable command, A-44
RTDataWriteEnable command, A-45
Runtime
changing logging paths, A-19
changing logging rate, A-17
ScreenPrint command, A-45
Security, 3-1
logging in, 3-2
passwords, changing at runtime, 3-3
users, 3-1
Windows NT user list, 3-1
SendKeys command, A-46
Set command, A-46
SetFocus command, A-48
Setting up
channel, 2-7
DDE server, 2-7
OPC server, 2-7
project, 2-1
Silence command, A-49
SilenceAll command, A-49
SoftLogix 5 programmable controllers, 2-7
Software requirements, 1-1
Special keys
Ctrl-F6, A-35
Ctrl-PgUp, A-52
Ctrl-Shift-F6, A-37
Ctrl-Shift-Tab, A-37
Ctrl-Tab, A-35
Ctrl-PgDn, A-26
Enter, A-26
disabling, A-24
Shift-Tab, A-37
Tab, A-34
Starting
project when Windows starts, 2-4
RSView32 Runtime, 2-4
Stopping projects, 2-11
Summary command, A-49
Suppressed command, A-50
SuppressOff command, A-50
Index
SuppressOffAll command, A-50
SuppressOn command, A-50
Symbol commands
Define, A-22
Undefine, A-51
T
Tag commands
= (Equal), A-2
DatabaseSync, A-16
Monitor, A-33
Ramp, A-41
Set, A-46
Toggle, A-51
Tag placeholders
parameter for Display command, A-25
using in commands, A-26
Technical support, P-2, 1-9
Time format, specifying, 2-3
Toggle command, A-51
Troubleshooting, activation, 1-10
U
Undefine command, A-51
Uninstalling RSView32 Runtime, 1-10
Updating project paths, 2-8
Upload command, A-52
UploadAll command, A-52
User account commands
Account, A-5
Login, A-33
Logout, A-33
Password, 3-3, A-36
User accounts
editing, 3-1
logging in, 3-2
maintaining in Windows NT, 3-1
passwords, changing at runtime, 3-3
User Accounts editor, opening, 3-2
V
VBA commands, VbaExec, A-52
Viewing log files, 2-6
W
Windows 95
and RSLinx, 2-7
and WINtelligent LINX, 2-7
Windows applications, A-14
Windows NT
and RSLinx, 2-7
and RSView32 Runtime, 1-4
security, 3-1
WINtelligent LINX drivers, 2-7
WINtelligent LOGIC 5, A-21
WINtelligent RECIPE, A-21
World Wide Web, P-2
H
H
I-7 H
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement