Professional Documents
Culture Documents
Cimplicity Users Manual Gfk1180f
Cimplicity Users Manual Gfk1180f
CIMPLICITY HMI
for Windows NT and Windows 95
Base System
User’s Manual
Warning notices are used in this publication to emphasize that hazardous voltages, currents, temperatures, or other
conditions that could cause personal injury exist in the equipment or may be associated with its use.
In situations where inattention could cause either personal injury or damage to equipment, a Warning notice is used.
Caution notices are used where equipment might be damaged if care is not taken.
Note
Notes merely call attention to information that is especially significant to understanding and operating the equipment.
This document is based on information available at the time of publication. While efforts have been made to be accurate,
the information contained herein does not purport to cover all details or variations in hardware or software, not to provide
for every possible contingency in connection with installation, operation, or maintenance. Features may be described
herein which are not present in all hardware and software systems. GE Fanuc Automation assumes no obligation of
notice to holders of this document with respect to changes subsequently made.
GE Fanuc Automation makes no representation of warranty, expressed, implied, or statutory with respect to, and assumes
no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein. No
warranties of merchantability or fitness for purpose shall apply.
GFK-1180 iii
Chapter 11. Alarm Audio Support: Shows you how to configure audible alarms.
Chapter 12. Alarm Blocking: Shows you how to implement hierarchical alarm
blocking.
Chapter 13. Alarm Printer Configuration: Shows you how to configure a printer
to record alarm messages.
Chapter 14. Role Configuration: Explains how to configure roles.
Chapter 15. User Configuration: Explains how to configure users.
Chapter 16. Database Logger: Discusses the Database Logger option and how to
configure tables and reports.
Chapter 17. Client Configuration: Shows you how to configure default logins for
CIMPLICITY HMI Viewers on client computers.
Chapter 18: Using CIMPLICITY HMI with CIMPLICITY Control: Shows
you how to import variables from a Control folder into points in an HMI project.
Chapter 19. Configuration Import/Export: Documents the Import/Export utility.
Chapter 20. Using the Alarm Viewer: Documents how to use Alarm Viewer to
configure and display alarm information.
Chapter 21. Using CimView: Explains the features of the graphic screen viewer.
Chapter 22. Using the Point Control Panel Shows you how to use the Point
Control Panel to display point information.
Chapter 23. Using the CIMPLICITY to Windows Server (DDE): Discusses how
to use CWSERV with third-party software such as Microsoft Excel spreadsheets.
Chapter 24. System Utilities: Describes the Show Users and Program Control
features of the System Utilities option.
Chapter 25. Resolving Problems: Discusses how to use the Status Log Viewer and
system log files to find an resolve problems.
Chapter 26. System Management: Discusses system management functions such
as changing global parameters and logical names, and how to remove CIMPLICITY
software from a computer.
Chapter 27. Managing Database Logging: Discusses the installation of ODBC
and Oracle drivers and data sources, how to manage the database for SQL Server,
how to control database disconnect recovery, and how to use the global parameters
for the Database Logger
Chapter 28. Security Features: Discusses the Login Password, Role Privileges,
Setpoint Security, Setpoint Password and Security Audit Trail.
Chapter 29. Using OEM Key: Shows you how to use the OEM key to temporarily
convert a Runtime license to a Development license
Chapter 30. Remote Projects, Point Bridge and Enterprise Server: Discusses
how to configure remote projects, point bridges to remote projects and enterprise
server projects.
Chapter 31. Site Wide Installation: Shows you how to use the Microsoft Systems
Management Server (SMS) for site-wide installations of CIMPLICITY HMI
software.
GFK-1180 Contents v
Contents
Introduction 1-1
About CIMPLICITY HMI Products ...................................................................................... 1-1
What You Receive ................................................................................................................. 1-1
System Architecture ............................................................................................................... 1-2
System Recommendations...................................................................................................... 1-3
For Windows NT on Intel Processors ...................................................................... 1-3
For Windows NT on DEC Alpha Processors........................................................... 1-3
For Windows 95 on Intel Processors ....................................................................... 1-4
Contacting Your Distributor................................................................................................... 1-4
Customer Support................................................................................................................... 1-4
Using the CIMPLICITY Startup Window.............................................................................. 1-5
Installing CIMPLICITY HMI Software ................................................................................. 1-6
Using a Local CD-ROM Drive ................................................................................ 1-6
Using a Shared CD-ROM Drive .............................................................................. 1-7
CIMPLICITY HMI Installation ............................................................................... 1-8
Creating and Loading Floppy Disk Installations .................................................................. 1-12
Command Format .................................................................................................. 1-12
Creating a Floppy Distribution............................................................................... 1-13
Creating A Replacement Floppy ............................................................................ 1-13
Installing CIMPLICITY HMI Software From A Floppy Distribution ................... 1-14
Registering CIMPLICITY HMI Software............................................................................ 1-15
Running the Registration Program ......................................................................... 1-15
Calling for Registration.......................................................................................... 1-16
Entering the Authorization Code............................................................................ 1-17
Running Without Authorization............................................................................. 1-17
Adding A New Option ........................................................................................... 1-18
Upgrading CIMPLICITY software ........................................................................ 1-18
Transferring Licenses ........................................................................................................... 1-20
Network Transfer ................................................................................................... 1-20
Diskette Transfer.................................................................................................... 1-20
Removing CIMPLICITY HMI Software.............................................................................. 1-21
From Windows 95.................................................................................................. 1-21
From Windows NT ................................................................................................ 1-21
Running the Demo Project ................................................................................................... 1-22
Creating A New Project ....................................................................................................... 1-22
Placing Programs or Documents On A Windows 95 Desktop ............................................. 1-23
Placing Programs or Documents In The Windows 95 Start Menu ....................................... 1-23
Starting A Project................................................................................................................. 1-24
Starting a Project with Out of Date Configuration ................................................. 1-24
Stopping A Project ............................................................................................................... 1-25
Using A Viewer.................................................................................................................... 1-26
Example - Displaying A Point On A Viewer ......................................................... 1-26
GFK-1180 vii
Using CIMPLICITY Software 2-1
Creating A New Project.......................................................................................................... 2-1
New Project Options ................................................................................................ 2-1
Opening a Project ................................................................................................................... 2-3
Configuration Cabinet Toolbar Buttons ................................................................... 2-4
Configuration Cabinet Shortcut Keys....................................................................... 2-4
Setting Project Properties ....................................................................................................... 2-5
Using the Project Wizard ....................................................................................................... 2-7
CIMPLICITY Project Wizard Step 1 of 3 ............................................................... 2-7
CIMPLICITY Project Wizard Step 2 of 3 ............................................................... 2-8
CIMPLICITY Project Wizard Step 3 of 3 ............................................................. 2-10
Installing A Project............................................................................................................... 2-11
Setting CIMPLICITY Options ............................................................................................. 2-12
Setting CIMPLICITY Project Options................................................................... 2-12
Setting Startup Options .......................................................................................... 2-14
Starting CimView Screens Automatically on Windows 95 .................................... 2-16
What’s Running .................................................................................................................... 2-21
How Configuration Updates Are Handled............................................................................ 2-22
Dynamic Update..................................................................................................... 2-22
Logging In ............................................................................................................................ 2-24
Copying A Project to Diskette.............................................................................................. 2-25
CIMPLICITY Command Line Options................................................................................ 2-26
viii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Device Point Data Collection ................................................................................................. 4-5
On Scan.................................................................................................................... 4-5
On Change ............................................................................................................... 4-5
On Demand On Scan................................................................................................ 4-5
On Demand On Change ........................................................................................... 4-5
Unsolicited ............................................................................................................... 4-5
Poll Once ................................................................................................................. 4-5
Virtual Point Calculation Types ............................................................................................. 4-6
Using the Expression Editor .................................................................................... 4-6
Global Points ......................................................................................................... 4-12
Equation Points ...................................................................................................... 4-13
Delta Accum Points ............................................................................................... 4-15
Value Accum Points............................................................................................... 4-18
Average Points ....................................................................................................... 4-20
Max Capture Points................................................................................................ 4-22
Min Capture Points ................................................................................................ 4-24
Timer/Counter Points............................................................................................. 4-26
Histogram Points.................................................................................................... 4-28
Trans-High Accum Points...................................................................................... 4-31
Equation w/Override Points ................................................................................... 4-33
Run-time Notes for Virtual Points........................................................................................ 4-35
Using Array Points ............................................................................................................... 4-35
Numbering Array Elements.................................................................................... 4-35
Calculating Array Limits........................................................................................ 4-36
Configuring Diagnostic Points ............................................................................................. 4-37
Creating a Diagnostic Point ................................................................................... 4-37
Using the Trigger Function .................................................................................................. 4-39
Trigger Point Update Criteria ................................................................................ 4-39
Example 1 - Device Point Interval Trigger ............................................................ 4-41
Example 2 - Efficiency........................................................................................... 4-41
Example 3 - Virtual Point Interval Trigger ............................................................ 4-42
Types of Alarming................................................................................................................ 4-43
Absolute Alarming ................................................................................................. 4-43
On Update Alarming.............................................................................................. 4-43
Rate of Change Alarming....................................................................................... 4-44
Deviation Alarming................................................................................................ 4-44
Types of Data Conversion.................................................................................................... 4-45
Linear Conversion.................................................................................................. 4-45
Custom Conversion................................................................................................ 4-46
Configuring Points ............................................................................................................... 4-47
Display Attributes .................................................................................................. 4-48
Setting Run-Time Point Properties....................................................................................... 4-51
Set Point Security................................................................................................... 4-51
Set Point Password................................................................................................. 4-52
Creating A New Point .......................................................................................................... 4-53
Defining Point Properties ..................................................................................................... 4-54
General Properties.................................................................................................. 4-55
Device Properties................................................................................................... 4-59
Virtual Properties................................................................................................... 4-64
View Properties...................................................................................................... 4-68
Conversion Properties............................................................................................ 4-70
Alarm Properties .................................................................................................... 4-72
Alarm Routing Properties ...................................................................................... 4-75
Alarm Option Properties ........................................................................................ 4-77
GFK-1180 Contents ix
Device Configuration 5-1
About Devices ........................................................................................................................ 5-1
Configuring Devices............................................................................................................... 5-1
Creating A New Device ........................................................................................... 5-3
Device General Properties ....................................................................................... 5-4
Device-Specific Properties....................................................................................... 5-5
Modifying A Device................................................................................................. 5-5
GFK-1180 Contents xi
Database Logger 16-1
About the Database Logger .................................................................................................. 16-1
Types of Log Files Available ............................................................................................... 16-1
Alarm Logging ....................................................................................................... 16-2
Event Logging........................................................................................................ 16-2
Data Logging.......................................................................................................... 16-3
Group Logging....................................................................................................... 16-3
Application Logging .............................................................................................. 16-3
Creating Tables .................................................................................................................... 16-4
Microsoft Access Note........................................................................................... 16-4
Using Wildcards in Search Strings ....................................................................................... 16-4
Table Characteristics ............................................................................................................ 16-5
Column Definitions ................................................................................................ 16-5
Key Definitions ...................................................................................................... 16-6
Entering from Point Configuration ....................................................................................... 16-7
Point Logging......................................................................................................... 16-7
Alarm Logging ....................................................................................................... 16-9
Using the Table Browser...................................................................................... 16-10
Starting from Your Project’s Configuration Cabinet .......................................................... 16-12
Database Logger Window Menu Options ............................................................ 16-13
Using the Window Pop-Up Menu ........................................................................ 16-14
Database Logger Toolbar Buttons ....................................................................... 16-15
Database Logger Shortcut Keys ........................................................................... 16-15
Creating A New Table........................................................................................................ 16-16
Table Properties ................................................................................................................. 16-17
Default Logging Conditions for the ALARM_LOG Table .................................. 16-18
Logging Conditions for Group and Data Tables .................................................. 16-19
Logging Attributes for ALARM_LOG, EVENT_LOG and Application Tables . 16-22
Logging Attributes for Group and Data Tables.................................................... 16-23
Maintenance Events for All Tables ...................................................................... 16-24
Maintenance Actions for All Tables .................................................................... 16-26
Logging Properties for All Tables........................................................................ 16-28
Filtering the Table List ....................................................................................................... 16-30
Copying a Table ................................................................................................................. 16-30
Renaming A Table.............................................................................................................. 16-31
Deleting A Table ................................................................................................................ 16-31
Reconciling a Table............................................................................................................ 16-32
Creating Uncreated Database Fields .................................................................... 16-33
Removing Unused Microsoft Access Fields......................................................... 16-33
Removing Unused SQL Server and Oracle Fields ............................................... 16-33
Database Logger Properties................................................................................................ 16-34
Parameters............................................................................................................ 16-34
Alarm and Point Logging ..................................................................................... 16-36
Displaying A Table ............................................................................................................ 16-39
Table Menu Options............................................................................................. 16-40
Using The Window Pop-Up Menu....................................................................... 16-41
Table Toolbar Buttons ......................................................................................... 16-42
Adding Points to A Table................................................................................................... 16-42
Removing Points from A Table.......................................................................................... 16-42
Editing Point Logging Properties ....................................................................................... 16-42
Group Table Point Properties............................................................................... 16-43
Data Table Point Properties ................................................................................. 16-44
Alarm Log Table Point Properties ....................................................................... 16-47
Filtering the Point List........................................................................................................ 16-48
xii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Filtering the Alarm or Event List ....................................................................................... 16-48
Reporting............................................................................................................................ 16-49
Notes on Installing Microsoft Excel..................................................................... 16-49
Installing the Sample Reports .............................................................................. 16-50
Alarm Report...................................................................................................................... 16-51
Setting Alarm Report Parameters......................................................................... 16-52
Generating an Alarm Report ................................................................................ 16-53
Clearing the Alarm Error Log .............................................................................. 16-53
Data Report ........................................................................................................................ 16-54
Setting Data Report Parameters ........................................................................... 16-55
Generating A Data Report.................................................................................... 16-56
Clearing the Data Error Log................................................................................. 16-56
Trend Report ...................................................................................................................... 16-57
Setting Trend Report Parameters ......................................................................... 16-58
Generating A Trend Report.................................................................................. 16-59
Clearing the Trend Error Log............................................................................... 16-59
Printing Reports Automatically .......................................................................................... 16-60
Modifying the CIMPLICITY Service for Automatic Printing ............................. 16-60
Creating a Script .................................................................................................. 16-61
Triggering an Automatic Report .......................................................................... 16-62
xiv CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Resetting an Alarm............................................................................................... 20-48
Deleting an Alarm................................................................................................ 20-48
Acknowledging and Resetting an Alarm.............................................................. 20-49
Acknowledging the First Alarm ........................................................................... 20-49
Acknowledging All Alarms.................................................................................. 20-49
Filtering Alarms ................................................................................................................. 20-50
Loading an Alarm Viewer Filter for Display ....................................................... 20-51
Modifying the Current Alarm Viewer Filter ........................................................ 20-51
Saving the Current Alarm Viewer Filter .............................................................. 20-54
Creating A New Alarm Viewer Filter .................................................................. 20-54
Deleting an Alarm Viewer Filter from the List .................................................... 20-54
Declaring a Default Alarm Viewer Filter ............................................................. 20-54
Printing Alarms .................................................................................................................. 20-55
Copying Alarms ................................................................................................................. 20-55
Installing an Alarm Viewer Screen..................................................................................... 20-56
Installing A Screen from Alarm Viewer............................................................... 20-56
Installing an Alarm Viewer Screen from the File Manager.................................. 20-57
Command Line Options ..................................................................................................... 20-57
GFK-1180 Contents xv
Using the CIMPLICITY To Windows Server (DDE) 23-1
About The CIMPLICITY To Windows Server .................................................................... 23-1
Command Syntax for CWSERV .......................................................................................... 23-1
Microsoft Excel Example....................................................................................... 23-2
Point Topic Attributes .......................................................................................................... 23-3
Using CWSERV with Microsoft Excel ................................................................................ 23-6
Displaying Point Data ............................................................................................ 23-6
Starting CWSERV ................................................................................................. 23-7
Modifying Point Data............................................................................................. 23-8
Sample Spreadsheets and Macros ........................................................................ 23-10
Command Syntax for System Topic ................................................................................... 23-12
Formats ................................................................................................................ 23-12
System Items ........................................................................................................ 23-12
Topics .................................................................................................................. 23-12
Help...................................................................................................................... 23-13
Error Messages................................................................................................................... 23-14
Remote Access of CWSERV on Windows NT .................................................................. 23-14
Creating a DDE Share.......................................................................................... 23-14
Referencing CWSERV from a Networked NT Client.......................................... 23-15
xvi CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Resolving Problems 25-1
About CIMPLICITY HMI Log Files ................................................................................... 25-1
System Log Files.................................................................................................... 25-1
Project Log Files.................................................................................................... 25-1
Viewing Log Files.................................................................................................. 25-1
Using the Status Log Viewer................................................................................................ 25-2
Which Status Log File Gets Displayed .................................................................. 25-3
Status Log Viewer Menu Options .......................................................................... 25-4
Status Log Viewer Toolbar Buttons....................................................................... 25-5
Status Log Viewer Shortcut Keys .......................................................................... 25-5
Selecting a Status Log to View............................................................................................. 25-6
Displaying Status Log Message Details ............................................................................... 25-7
Saving the Status Log as a Text File .................................................................................... 25-8
Printing the Status Log File.................................................................................................. 25-9
Selecting a Status Log Printer ............................................................................................ 25-10
Filtering the Status Log Messages...................................................................................... 25-11
Finding Status Log Messages ............................................................................................. 25-12
Finding the Next Status Log Message.................................................................. 25-13
Process Names in Status Log ............................................................................... 25-13
Checking System Output and Error Files ........................................................................... 25-14
Checking Process Output and Error Files........................................................................... 25-14
Backup Process Log Files .................................................................................... 25-15
xviii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using CIMPLICITY HMI with Remote Access 32-1
About Remote Access .......................................................................................................... 32 -1
About the Examples in this Document................................................................... 32-2
Before You Start .................................................................................................................. 32-3
Server Setup (Windows NT) ................................................................................................ 32-4
Installing the Remote Access Service .................................................................... 32-4
Further Configuration for the Server...................................................................... 32-7
Client Setup (Windows NT)................................................................................................. 32-9
Installing the Remote Access Service .................................................................... 32-9
Further Configuration for the Viewer .................................................................. 32-10
Client Setup (Windows 95) ................................................................................................ 32-11
Configuring the HOSTS Files ............................................................................................ 32-13
Testing the Connection....................................................................................................... 32-14
Ping ...................................................................................................................... 32-14
Configuring CIMPLICITY Options on the Server ............................................................. 32-14
Accessing a CIMPLICITY HMI Project from a Client...................................................... 32-15
Browsing for a Point ............................................................................................ 32-15
Opening a CimView Screen................................................................................. 32-15
Index i
GFK-1180 1-1
System Architecture
CIMPLICITY HMI software is scalable from a Human Machine Interface to a fully
networked Supervisory Control and Data Acquisition system. The networking
capabilities inherent at all levels within the product line let you achieve levels of
integration that virtually eliminate redundant configuration within a network.
Q R S
1 2 3
T U V
4 5 6
W X Y
7 8 9
+ Z (SP)
Server
- 0 .
DelKeypad
Can
Ctrl
FN
A B C D E F G H
Communication Protocols
F1 F2 F3 Function
F4 F5 Keys
F6 F7 F8 Alt
I J K L M N O P
F9 F10 F11 F12 F13 F14 F15 F16 Glide Point
GE Fanuc
1-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
System Recommendations
Your system must meet the following minimum requirements in order to successfully
install and run CIMPLICITY HMI software.
You should also check the Important Product Information document shipped with
your release for any last-minute changes to these recommendations.
Note
CIMPLICITY HMI Server and Viewer software may be run on Microsoft Windows
95, Microsoft Windows NT Workstation, or Microsoft Windows NT Server
software. However, Microsoft Windows NT Workstation imposes a limit of 10
network connections. Due to this limitation, the number of remote client/server and
device communication connections may be limited. If you require connections to
multiple devices and/or multiple remote nodes, you should purchase Microsoft
Windows Server for these applications.
Customer Support
GE Fanuc takes pride in the high quality of the CIMPLICITY software. Great
emphasis has been placed on ensuring the quality of this system throughout
development and testing. In spite of this, from time to time you may encounter
problems or deficiencies in the software or documentation.
If your CIMPLICITY software system is under warranty or is covered by a valid
support contract, you may report problems to the CIMPLICITY Technical Support
Hotline at one of the following numbers:
USA and Canada (800) GE-FANUC or (800) 433-2682
All others (804) 978-6036
The CIMPLICITY Hotline is available from 8 A.M. to 8 P.M. Eastern time, Monday
through Friday, except for regularly scheduled holidays.
1-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Using the CIMPLICITY Startup Window
Whenever you run setup.bat from your CIMPLICITY HMI CD, the CIMPLICITY
HMI Setup window opens.
1-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Using a Shared CD-ROM Drive
On the computer with the CD-ROM drive, do the following:
1. Open My Computer.
2. Select the CD-ROM drive.
3. Click the right mouse button and select Sharing... from the pop-up
menu.
4. On the Sharing property page for the drive, select Shared As.
5. Enter a name in the Share Name field.
6. Select OK.
On the computer where you want to install CIMPLICITY HMI software:
1. Open My Computer.
2. Click on the Map Network Drive button in the Toolbar.
3. Select a Drive.
4. Specify a path to the shared CD-ROM.
5. Select OK.
You can now open the shared drive and select setup.bat on the CIMPLICITY HMI
Distribution CD.
Welcome
The CIMPLICITY HMI System Setup screen opens with the Welcome dialog.
If you want to cancel the installation, select Cancel. Otherwise, select Next to
proceed to the next dialog box.
Read the software license agreement carefully. If you accept its terms, select Yes. If
not, select No. If you select No, the installation terminates.
1-8 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
CIMPLICITY System Product Options
Select the option you want to install. The options list will be built, and the Change
Destination Location dialog opens.
Select the directory where you want to install CIMPLICITY HMI software. You can
select Browse...and browse for a directory, or you can use the default directory
(C:\CIMPLICITY\HMI). After you have chosen a directory, select Next to
continue with the installation.
Select the components you want to install for this product option.
Some components in the Components list have more than one option available.
When you select one of these components, its options are displayed in the right-hand
list box. You can select the options you want to install for each of these components.
When you are through, select Next to continue with the installation.
1-10 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Registration
Setup Complete
For CIMPLICITY HMI software to function correctly, you will need to reboot your
computer. The Setup Complete dialog box gives you the opportunity to reboot your
computer immediately.
You can only create distributions for the platform you are on. For
example, if you are on an Intel PC, you can only create Intel distributions.
Before you start, make sure that you have enough pre-formatted diskettes to create
the distribution. To find out how many you need:
1. Insert the CIMPLICITY HMI Distribution CD in its drive.
2. Use the File Manager to locate the I386 (if you are on an Intel PC) or
ALPHA (if you are on a DEC Alpha PC).
3. You will see a number of files named DISKn.ID. The number of files
equals the number of diskettes you will need to create the release (for
example, if you see DISK1.ID through DISK17.ID, you will need 17
diskettes for your floppy distribution).
Command Format
The full command format for the DSK2FLPY utility is:
DSK2FLPY [-n<disk_no>] [-t<target_drive>] [?]
The optional arguments are
Argument Description
-n Use this argument to create a specific disk from the CIMPLICITY
Distribution CD-ROM, where <disk_no> is the disk number you
want to create.
This is useful if you find you have a bad floppy, and want to re-
create it. For example, if you find that the fifth diskette is bad, enter
the command DSK2FLPY -n5 to create a new copy.
-t The default target floppy drive is A:. Use this argument if your
floppy drive is not A:.
For example, if your floppy drive is B:, enter the command
DSK2FLPY -tB:.
? Use this argument to access Help for the DSK2FLPY utility.
1-12 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating a Floppy Distribution
To create a floppy distribution:
1. Insert the CIMPLICITY HMI Distribution CD in its drive.
2. Use the Explorer to locate DSK2FLPY.EXE in the appropriate
directory on the CD.
• For Intel processors, the directory is I386.
• For DEC Alpha processors, the directory is ALPHA.
3. Open a Command Prompt window.
If you think a diskette is not in the correct sequence, you can verify its order by
displaying the diskette contents in the File Manager. You should find a file named
DISK<n> where <n> is the sequence number of the diskette.
1-14 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Registering CIMPLICITY HMI Software
If you purchased a licensed CIMPLICITY HMI system, you will need to register
your software in order to access its full functionality.
Note
If you do not register your software, or you are running a Demo system, see Running
Without Authorization for a description of the restricted functionality.
Before you start, please make sure you have the licenses for the Base System,
Communication Enablers and Options you purchased handy.
You need to do the following to register your system:
• Run the Registration Program and register your user information and
serial numbers.
• Call GE Fanuc to get an Authorization Code.
• Run the Registration Program again and enter your Authorization Code.
1-16 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Entering the Authorization Code
To enter your Authorization Code:
1. Select the Registration icon in the CIMPLICITY HMI program group
to restart the CIMPLICITY HIM Registration procedure.
2. On the Registration Instructions dialog box, make sure the New
Registration radio button is selected and then select Next.
3. On the License Agreement dialog box, select Yes.
4. On the Registration Serial Numbers dialog box, select Next.
5. On the Registration Authorization dialog box, select Next.
6. On the Registration System Authorization Code dialog box, enter the
Authorization Code you received from GE Fanuc, and then select Next
to conntinue with registration.
7. On the Registration Finish dialog box, select OK to terminate the
Registration program.
You now have successfully registered your CIMPLICITY HMI software. You will
now have full access to the Base System and all the options you installed and
registered.
Functional Upgrades
CIMPLICITY HMI systems are available with a choice of device I/O counts (50, 75,
150, 300, 700 and unlimited) for both Development and Run-time systems.
You can make any of the following functional upgrades:
• From a lower to a higher point device I/O count
• From a Run-time to a Development system
• From a Viewer to a Server
Contact your distributor for complete information on placing a functional upgrade
order.
To register the upgrade:
1. In the CIMPLICITY Registration Serial Numbers dialog box, select
Change and enter the applicable serial number for the base system you
are registering.
2. Contact GE Fanuc with the new base serial number and System Key
Code to obtain a new System Authorization Code.
3. Enter the new System Authorization Code in the CIMPLICITY
Registration System Authorization Code dialog box.
If you want add additional options, you do not need to contact GE Fanuc. Simply
enter a valid serial number for each option you have purchased and want to enable.
1-18 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Version Upgrades
A Version Upgrade takes an older CIMPLICITY HMI system and upgrades it to the
current version. Contact your distributor for complete information on ordering a
Version Upgrade. Note the following:
• If your current installation is in the 90 day warranty period, the Version
Upgrade is provided free of charge.
• If your current version is out of the 90 day warranty period, you must
purchase the Version Upgrade.
You must transfer the entire registration (all licenses). Once you
complete the transfer, your source computer becomes an unauthorized
system. If you wish to continue to run fully functional CIMPLICITY
software on the source computer, contact your distributor to purchase
additional licenses.
Network Transfer
Important
Diskette Transfer
To transfer licenses via diskette, do the following:
1. Run the Registration program on the target computer (the one that is not
yet authorized).
2. Insert a formatted diskette into the floppy drive on the target computer,
and select Register the Diskette in the CIMPLICITY Registration
Transfer Using Floppy Diskette dialog box, then select Next.
1-20 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
3. Remove the diskette from the target computer and insert it into the
floppy drive on the source computer (the one that is authorized).
4. Run the Registration program on the source computer.
5. In the CIMPLICITY Registration Transfer Using Floppy Diskette
dialog box, select Authorize the Diskette, then select Next.
Remember, after this step completes, CIMPLICITY HMI software is no
longer registered on the source computer.
6. Remove the diskette from the source computer and insert it into the
floppy drive on the target computer.
7. Run the Registration program on the target computer.
8. In the CIMPLICITY Registration Transfer Using Floppy Diskette
dialog box, select and select Authorize the system from the
Authorized diskette, the select Next.
When the utility completes, the target computer is registered to run CIMPLICITY
HMI software.
Before you remove CIMPLICITY HMI software from your computer, you should
save any projects that you don’t want to lose. You can save them on diskette, or in a
non-CIMPLICITY directory.
From Windows 95
Perform the following steps to remove CIMPLICITY HMI software from a Windows
95 computer:
1. Use the Add/Remove applet on the Control Panel to remove
CIMPLICITY HMI software.
2. Reboot your computer.
From Windows NT
Perform the following steps to remove CIMPLICITY HMI software from a Windows
NT computer:
1. From the Start menu, open the Control Panel.
2. Open the Add/Remove Programs icon.
3. Select CIMPLICITY HMI from the list of programs, then select
Add/Remove.
4. After the software is removed, reboot your computer.
1-22 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Placing Programs or Documents On A Windows 95
Desktop
To place a program or document on the Desktop, do the following:
1. Use the Explorer to locate the program or file.
2. Click the item to select it.
3. To copy the item, hold the Ctrl key and drag the item onto the desktop.
To move the item, just drag it onto the desktop.
4. Release the Ctrl key if you used it, and the mouse button.
When you enable Dynamic Configuration, any changes you make take effect
immediately in the running project because you are making changes in both the
Master and Run-time configuration files.
CIMPLICITY HMI software checks for differences between the Master and Runtime
configuration files when it starts the project.
1-24 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
You can do one of the following:
• Select Yes to perform update the run-time configuration files then start
the project.
• Select No to start the project without updating the run-time
configuration files.
• Select Cancel to cancel the project start request.
Stopping A Project
If you want to stop a CIMPLICITY HMI project, do the following:
1. Open the project’s Configuration cabinet. Note that the Stop button is
enabled, and the Start button is disabled.
2. Click the Stop button on the Toolbar, or select Stop from the Project
menu.
3. Select OK when you are asked to "Select OK to terminate
CIMPLICITY on this node".
After the project stops, the Configuration cabinet redisplays. Note that the Start
button is now enabled, and the Stop button is disabled.
You can also use the Startup Options item in the CIMPLICITY HMI menu to stop a
project. To do this:
1. Select Startup Options from the CIMPLICITY HMI menu. The
CIMPLICITY Startup Options dialog box opens, and the currently
running project is displayed in the Running Project field.
2. Select Halt.
3. Select OK when you are asked to "Select OK to terminate
CIMPLICITY on this node".
1-26 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Using CIMPLICITY Software
GFK-1180 2-1
Enter information in the following fields to create a new project:
Project Type Select the type of project you want to create.
The type of project you can create is controlled by the
product option you have installed. For example, if you
have installed the HMI Server option, then you can only
create HMI Server base projects.
Project Name Enter the project name in this field.
New Subdirectory The project name you enter will also be used as the
default subdirectory name for the project.
If you want to use another name for your subdirectory,
enter it in this field.
Options You can select the options you want to be available in
this project from the list of all installed options. Set the
check box for each option you want to select.
Protocols You can select the protocols you want to be available in
this project from the list of all installed protocols. Set
the check box for each protocol you want to select.
Project Path Use the Drives and Directory input fields to select a
directory path for the project directory you are creating.
If you want to create the project on another disk in your
network, select Network... to define the network path.
When you have entered your information, select Create... to create the new project
or select Cancel to cancel the create request.
When you select Create..., the Configuration cabinet for the project is created, and
the Project Properties dialog box opens to display the Options properties.
2-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Opening a Project
When you select a CIMPLICITY project’s shortcut menu option from the Start
menu, the CIMPLICITY Configuration cabinet for the project opens.
You can use the menu options in the Configuration cabinet to create a new project,
open a project, delete a project, display project settings, start/stop a project, update
project configuration, open the Project Wizard, enable/disable the Toolbar and Status
bar, enable/disable dynamic configuration update, open an MS-DOS window, display
status logs, start configuration functions, and display Help information.
You can use the icons in the Configuration cabinet to start configuration functions
for your project. For example, to start Point Configuration, double-click the Points
icon.
2-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Setting Project Properties
The Project Properties dialog box opens when you:
• Create a new project, and you select Create... from the New Project
dialog box.
• Select Properties... from the Project menu for a project.
• Click the Settings button on the project Toolbar.
Use the Project Properties dialog box to choose or change general properties and
options for a project.
After you have modified the properties, you can select OK to accept the
modifications, or select Cancel to close the Project Properties dialog box without
accepting any changes.
General Properties
2-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Using the Project Wizard
The Project Wizard dialog box opens when you:
• Create a new project, and you select OK from the Program Groups
dialog box.
• Select Project Wizard... from the Project menu for a project.
• Click the Project Wizard button on the project Toolbar.
• Press Ctrl+W in the project.
You can use the Project Wizard to define ports, devices, and points for a project.
Modifying A Port
To modify a currently configured port:
1. Select the port you want to modify from the Configured Ports list.
2. Select Modify.
The Port Properties dialog box for the selected port opens. For more information on
modifying port properties, see the Port Properties for the particular protocol you
selected.
2-8 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Adding A New Device
To add a new device to the project configuration:
1. Select the port you want to select from the Available Protocols list.
2. Select Add->.
The New Device dialog box opens for the device you are adding. For more
information on adding a device, see Creating A New Device.
Removing A Device
Note
You will not be allowed to delete a device unless all points for that device have been
deleted.
To remove a currently configured device from the project configuration:
1. Select the device you want to delete from the Configured Devices
list.
2. Select Remove. You will be asked if you want to delete the selected
object.
3. Select Yes to delete the device.
Modifying A Device
To modify a currently configured device for the project:
1. Select the port you want to modify from the Configured Ports list.
2. Select Modify.
The Device Properties dialog box for the selected device opens. For more
information on modifying device properties, see the Device Properties for the
particular protocol you selected.
2-10 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Installing A Project
Once you create a project, you will want to install it in a folder for easy access. In
the Configuration cabinet for your project:
1. Select the File menu.
2. Select Install.
The Create Shortcut dialog box opens and lets you select the folder where you want
to install the shortcut to the project.
Select the folder where you want to place the shortcut. You can also use the New
Folder... button to create a new folder for the shortcut.
Use the Projects property page to display, start, and stop projects on a computer.
2-12 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
CIMPLICITY software supports When you open the CIMPLICITY Projects dialog box, it is connected to your
running multiple projects on a single
computer and shows you the currently running projects as well as the projects
computer.
available for running.
You can:
• Start as a Viewer.
• Connect to another computer in your network
• Stop a running project
• Add projects to the list of projects
• Start projects in the Projects list.
Start as a Viewer
To start as a Viewer, select Start Viewer.
You can display the projects currently running on any Server in your network. To do
this:
1. Click the drop-down list button to the right of the Computer Name
field.
2. Select the computer you want to connect to from the list of computers
that are currently running CIMPLICITY software.
If the computer name does not appear in the list, you can type it in the
Computer Name field (the computer name is not visible if no
projects are running).
3. Select Connect.
The projects that are currently running on that computer are displayed in the
Running Projects field.
2-14 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Network Options
You can select one of the following options:
Stand alone Select this option if you do not want to connect to other
projects in your enterprise, and you do not want other
projects in your enterprise to connect to this project.
Accept connections Select this option if you want to connect to other projects
in your enterprise and you want other projects to connect
to this project.
Use this dialog box to browse for projects to add to the list of projects to be started at
system boot. When you locate a project, select OK to add it to the list and close the
CIMPLICITY Default Project dialog box. Select Cancel to close the dialog box
without selecting a project.
To delete a project from the list, select the project, and then select Delete. The
project is removed from the list.
You can also select the one of the following:
None Select this option if you do not want any of the projects in the
list to start at system boot.
Start as viewer Select this option if you want to start a Viewer (that is, only
start the Router) on this computer when the computer reboots.
Start at boot Select this option if you want to projects in the list to start
when the computer boots. If there are no projects in the list,
only the Router starts.
2-16 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
3. Select Change Windows Password. The Change Windows
Password dialog box opens.
4. Enter the old Password (or leave it blank if you never entered a
password). Leave the New Password and Confirm New
Password fields blank, and select OK. The Change Windows
Password dialog box closes.
5. Select OK to close the Passwords Properties dialog box.
6. Select the Network icon in the Control Panel. The Network properties
dialog box opens.
2. In the Network Options box, select whether you want to start a stand-
alone project, or accept connections from other projects in your
enterprise.
3. In the System boot options box:
A. Make sure the project(s) you want to start at system boot are listed.
Select Add to browse for projects and add them to the list.
B. On Windows 95 computers, you can select CimView to set a
default CimView screen that opens at startup and define its display
options.
Note
On Windows NT computers, put a shortcut to the CimView screen
in your Start Menu folder for each screen you want to open at
startup. You can enter the startup options for the screen in the
shortcut’s command line.
2-18 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
The Dialog dialog box opens.
C. Enter the starting CimView screen in the Screen field. You can
also select Browse to the right of this field to search for the screen
you want.
D. Set the Start at boot field if you want the CimView screen to be
started automatically when the system boots.
E. Set the following check boxes as needed to define the screen’s
startup options:
Always Maximized
This option always maximizes the initial window to fill
the user’s terminal screen.
The user cannot resize the primary window, and the
window will not rise to the top when a user clicks on it
(this prevents it from obscuring other windows on the
terminal screen).
No Exit
This option does not let the user exit the primary
CimView window.
The Exit menu item is removed from the File menu,
and the Close menu item and Alt+F4 shortcut key are
removed from the Control menu. In addition, the
Close Screen action is ignored in the primary
window.
Keypad
This option opens the popup keypad whenever the user
needs to enter data for Variable setpoints.
This option is required for systems with no keyboard or
keypad.
Zoom to Best Fit
This option sizes the CimView screen to best fit the
window in which it is displayed.
No Menu/Title
This option removes the Menu and Title bars from the
primary CimView window and all subsequent
windows.
2-20 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
What’s Running
A CIMPLICITY project has two layers of programs:
• User Application
• Resident Process
The User Application layer consists of the Alarm Viewer, CimView, CimEdit,
and CWSERV programs. These programs are started by user request and remain
running until the user exits them.
The Resident Process layer consists of a set of programs that are started when you
start your CIMPLICITY project, and that remain running until your CIMPLICITY
project is shut down.
If you are on a Server, the Resident Process layer consists of such programs as the
Router, device drivers, Point Management, Point Data Logger, Alarm Management
Resident Process, and the Point Bridge.
If you are on a Viewer, the only process running in the Resident Process layer is the
Router.
Dynamic Update
The Dynamic Update option is available only if your user role has been assigned that
option.
If you have permission to use Dynamic Update, you can enable or disable Dynamic
Update from your project, or from individual configuration functions by either of the
following methods:
• Clicking the Dynamic toolbar button.
• Selecting Dynamic from the Tools menu.
In addition, when you enable Dynamic Update, "DYNAMIC" is displayed on the
Status Bar so that you are aware that it is enabled. Once you enable Dynamic
Update, changes made by configuration functions that support this option are put into
effect immediately. Any changes made to configuration data while Dynamic Mode
was disabled are not put into effect until the Configuration Update procedure is
invoked.
You should also be aware that the configuration procedures listed below have
restricted functionality in Dynamic Update mode.
2-22 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Point Configuration
If you are modifying a point in Dynamic Update mode, you cannot change:
• The point type
• The device for a Device point
• The number of array elements
• The calculation type for a Virtual point
• The service for a Virtual point
Device Configuration
In Dynamic Update mode, you may only modify the Enable/Disable state of a device.
Port Configuration
In Dynamic Update mode, you may only modify:
• Base scan rate
• Enable/Disable state of the port
• Retry count
Resource Configuration
You cannot create or modify resources in Dynamic Update mode.
Role Configuration
You cannot create or modify Roles in Dynamic Update mode.
Remote Projects
You cannot create or modify remote projects in Dynamic Update mode.
Database Logger
Changes to Database Logger configuration will be accepted while in Dynamic
Update mode, but changes to the running system will not be made dynamically.
2-24 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Copying A Project to Diskette
Each CIMPLICITY HMI project has several subdirectories associated with it. The
standard project subdirectories are:
alarm_help If you are creating operator Help files for alarms, put them in this
directory.
arc If you are using the Database Logger option, archive files are put
in this directory.
data All the run-time configuration files reside in this directory.
lock The project lock file resides in this directory.
log All status log files, and program error files reside in this directory.
master All the master copies of configuration files reside in this
directory.
screens All CimView screens reside in this directory by default.
scripts All Basic Control Engine scripts for this project reside in this
directory by default.
To make a backup copy of your project on a diskette, do the following:
Note
If you are backing up a running project, there is a file that is locked when the project
is running. This file will not be copied, and an error message to that effect will be
displayed. You may ignore the message and continue the backup, as the file is
created whenever a CIMPLICITY HMI project is started.
1. Using the Windows Explorer, locate the project directory for the
project you want to back up.
2. To save space on your diskette, you should delete all log files from the
project’s \log directory before making the backup.
If the project is running, some files in this directory may be locked and
will not be deleted.
3. Copy the project’s directory to the diskette.
This method works well for small projects. For large projects, consider zipping the
project and saving the zipped file or backing up the project directories to tape rather
than diskette.
2-26 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Using CIMPLICITY Configuration
Windows
Copy Item Copies information for the selected item to a new item.
GFK-1180 3-1
Configuration Menu Options
You can use the menu options to create new items, modify, copy, or delete existing
items, toggle the Status Bar display, filter the item list, change the list display
attributes, toggle dynamic updates, and access Help.
File Menu
The File menu functions are:
New Creates an item for this function.
Exit Exits the configuration function
Edit Menu
The Edit menu functions are:
Modify Displays and modifies the properties for the selected item.
Delete Deletes the selected item.
Copy Copies the information for the selected item to a new item.
Rename Renames the selected item. This menu item may be disabled for
some configuration functions
Setup Opens the function’s Properties dialog box. This menu item may be
disabled for some configuration functions
View Menu
The View menu functions are:
Toolbar Enables/disables the display of the Toolbar.
Status Bar Enables/disables the display of the Status bar.
Search... Filters the item list.
Attributes... Displays and modifies the attributes for the Configuration window.
Options... Selects options from the Options dialog box.
List Displays the list of items.
Details Displays the list of items along with their attributes.
Tools Menu
The Tools menu functions are:
Help Menu
The Help menu functions are:
3-2 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Using the Window Pop-Up Menu
The Window Pop-up Menu is available on selected input fields when you create or
modify an item. Use one of the following methods to access this menu:
• Position the cursor in the input field and click the right mouse button.
• Click the Pop-up Menu button to the right of the input field. The
button looks like this: .
If a field does not have a Pop-up Menu button, the right mouse button will not work.
The menu functions are:
New... Displays the dialog for creating a new item.
Edit... Displays the dialog box for editing the current item.
Browse... Displays the dialog box for selecting a new item from the
current set.
Recent items The bottom list contains the ten (10) most recently used
items for the current field.
Any new item you select or enter in the field moves to the
top of the list.
Before you use any items, the first ten items in the
configuration data are listed.
3-4 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Removing an Attribute from the Display List
The first item on the Display To remove an attribute from the display list:
Attributes list cannot be removed.
1. Select the attribute in the Display Attributes list.
2. Select Remove.
The attribute is placed on the Available Attributes list.
You can use this dialog box to enable and disable the following options:
Display search criteria at startup
If you set this check box, the Search dialog box opens whenever
you start this configuration function. You can use the Search
dialog box to filter the list of items prior to displaying it.
If you clear this check box, the Configuration window opens
with all defined items whenever you start this function
Edit Auto Complete
This check box changes the functionality of all input fields that
use the Pop-up menu button - - in any CIMPLICITY
application on your computer.
If you set this check box, the application tries to automatically
complete the name for you as you type in the field.
If you clear this check box, no item matching is performed.
When you are through, select OK to close the dialog box and save your changes, or
select Cancel to close the dialog box without implementing any changes.
As you continue to type, the software continues to match the item name.
For example, if you type I after the F in the Resource ID field, the first Resource
ID that starts with FI appears in the field. In this case, the first Resource ID that
matches FI is FIXTURES.
You can also use the Up and Down arrow keys to scroll through a list of all items
that match your current input.
For example, if you press the down arrow, the next Resource ID that starts with FI
appears in the field. In this case, it is FIXTURE_1. If you press the up arrow,
FIXTURES redisplays in the field.
When you reach the end of the list of matches, the down arrow key wraps to the
starting item in the list. Similarly, when you reach the start of the list, the up arrow
wraps to the ending item in the list.
Modifying an Item
To modify an item, you can double-click the item.
Alternatively, you can select the item, then do one of the following:
• Select Modify from the Edit menu.
• Click Modify Item on the Toolbar.
• Press Ctrl+M.
After you initiate the request, the Definition dialog box for the configuration function
opens. The properties contain the current configuration information for the selected
item. You can modify any properties that are not disabled (grayed out).
Select OK to close the Definition dialog box and modify the information for the
selected item.
Select Cancel to close the Definition dialog box without modifying the item.
3-6 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Copying an Item
To copy an item, select it, and then do one of the following:
• Select Copy from the Edit menu.
• Click Copy Item on the Toolbar.
• Press Ctrl+C.
After you initiate the request, the Copy dialog box for the item opens.
Enter a new item ID in the Destination field and select OK to create a new time
with the same characteristics as the selected one.
Select Cancel to close the Copy dialog box without making a copy of the selected
item.
Deleting an Item
To delete an item, select it, then do one of the following:
• Select Delete from the Edit menu.
• Click Delete Item on the Toolbar.
• Press Del.
After you initiate the request, the Delete Selected Item dialog box opens.
Select OK to close the dialog box and delete the selected item. The list of items in
the Configuration window automatically updates.
Select Cancel to close the dialog box without deleting the selected item.
You can filter the list by any combination of the fields listed in this dialog box.
You can also use the following wildcards in any of the fields:
* Use this wildcard to search for any number of characters at this point in the
string. For example, if you want to display a list of alarms that start with "M"
and end with "X", enter M*X in the Alarm ID field.
? Use this wildcard to search for any character in this place in the string. For
example, if you want to display the list of alarms that are three characters
long, and whose first character is "M" and third character is "X", enter M?X
in the Alarm ID field.
Note
There are no implied wildcards. If you do not include or terminate your search string
with an asterisk, only those items that match your request exactly will be returned.
3-8 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
About Browsers
You will find the Browser button - - to the right of certain input fields on your
configuration window and dialog boxes. When you click this button, you invoke a
Browser for that particular entity. A Browser let you search the list of entities and
select the one you want for your configuration.
Currently, the CIMPLICITY configuration functions let you access the Browsers for
the following entities:
• Point ID
• Resource
• Device
• Point Type
• Class ID
• Role ID
When you click the Browser button, the Select dialog for the particular Browser
opens. If the Auto Browse option is set for the configuration function, the display
list will initially show you all of the entities available for the Browser.
You can use the input fields in the dialog to tailor the display list to your needs by
asking the Browser to search for and display an individual entity or subset of entities.
You may also be able to access other Browsers from this dialog. For example, from
the Select A Point dialog box for the Point Browser, you can access the Browsers for
Device ID, Resource, and Point Type.
File Menu
The File menu functions are:
View Menu
The View menu functions are:
Attributes Opens the Configure Display Attributes dialog.
3-10 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Using Wildcards
You can use the following wildcards:
* Use this wildcard to search for any number of characters at this point in the
string. For example, if you want to display the list of points that start with
"M" and end with "X", enter M*X in the Point ID field.
? Use this wildcard to search for any character in this place in the string. For
example, if you want to display the list of points whose names are three
characters long, and whose first character is "M" and third character is "X",
enter M?X in the Point ID field.
Note
There are no implied wildcards. If you do not include or terminate your search string
with an asterisk, only those items that match your request exactly will be returned.
About Points
A main feature of CIMPLICITY HMI software is its ability to collect point data from
devices such as programmable controllers and distribute this data to CimView
screens, Alarm Viewer screens, alarm printers, logging tables, and optional
CIMPLICITY HMI software functions. The collection and distribution of point data
is handled by the Point Management subsystem. Its primary functions are:
• Updating the point database as point values change.
• Generating point alarms when limits are exceeded.
• Making point data available to other CIMPLICITY HMI and third party
software functions.
• Synthesize new point values by arithmetically combining other points.
Two types of points can be configured - Device points and Virtual points.
• Device points are points that are read from and/or written to devices.
• Virtual points are points that do not directly originate from devices.
There are two types of virtual points:
• Global points are points whose values are generated by an
application such as CimView. These values are shared by multiple
CIMPLICITY HMI software applications.
• Calculated points are points that are generated from arithmetic or
logical expressions that modify or combine one or more device points.
These values may then be shared by multiple CIMPLICITY HMI
software applications.
Point configuration defines where a point originates, how the data is collected, what
constitutes an alarm state, how the point should be displayed, and how the raw point
data is converted into engineering units.
GFK-1180 4-1
Naming Points
You will need to give each point you create in your project a unique Point ID. This
identifier may be up to 32 characters long. You may use any combination of upper-
case letters and numbers to create a Point ID. You may also use special characters in
a Point ID. There are however, some reserved words and reserved characters. If you
use reserved words or characters for a Point ID:
• When you include a Point ID that contains reserved words or special
characters in an expression or equation, you must enclose the Point ID
in single quotes.
• File names for Alarm Help files will be difficult to correlate to Point
IDs. These file names are usually automatically generated by
CIMPLICITY software and are based on the Point/Alarm ID.
Reserved Words
The following are reserved words in CIMPLICITY software. You should not use
these words for Point IDs:
A1 A2 AH1
AH2 AL AL1
AL2 ALARM ALARM_HIGH
ALARM_LOW ALARM_NOT_ACKED ANA
AND BAND BNOT
BOR BXOR EQ
EU_CONV GE GT
LE LT NE
NOT OR SQR
WARNING WARNING_HIGH WARNING_LOW
XOR
If, however, you do use a reserved word for a Point ID and you include such a Point
ID in a point expression or equation, you must enclose the Point ID in single quotes.
Reserved Characters
You cannot use a space (blank) or the following characters in a Point ID:
| $
If you attempt to do so, you will receive an error message.
The following characters are permitted. However, avoid using them as they can be
misinterpreted by the Expression Editor and other software:
+- * ? \ [ ]
You may use any other special character (such as @, #, %, etc.) on the keyboard in
your Point ID. However, if you include such a Point ID in a point expression or
equation, you must enclose the Point ID in single quotes. The only exception to this
rule is the underscore character ( _ ). You do not need to enclose the Point ID in
single quotes if you use the underscore.
4-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
You may start a Point ID with a number (0-9). However, if you include such a Point
ID in a point expression or equation, you must enclose the Point ID in single quotes.
Note
Although they are allowed, do not use brackets ( [ ] ) in Point ID names. CimView,
Trends and the Event Manager assume that this specifies an array element.
4-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Device Point Data Collection
Device point data can be read in one of the following modes:
On Scan
Data is collected for the point at a regular interval. This interval is equal to the base
scan rate for the point on which the device is located multiplied by the scan rate for
the point.
The point’s value is updated at the point’s scan interval, whether or not the value
changes.
On Change
Data is collected for the point at a regular interval. This interval is equal to the base
scan rate for the point on which the device is located multiplied by the scan rate for
the point.
The point’s value is only updated when changes. This is the default update criteria.
On Demand On Scan
Data is collected from the point whenever the point’s value is needed by an
application.
The point’s value is updated at the point’s scan interval, whether or not the value
changes.
On Demand On Change
Data is collected from the point whenever the point’s value is needed by an
application.
The point’s value is updated whenever its value changes.
Unsolicited
Data is distributed for the point whenever the device communications enabler notifies
CIMPLICITY Point Management that the point’s value has changed.
This mode is only valid if the device is capable of sending unsolicited updates of
point values and the device communications protocol supports it. See the
CIMPLICITY HMI for Windows NT and Windows 95 Device Communication
Manual (GFK-1181) for more information.
Poll Once
The point’s value is polled once when the device communications enabler starts up.
Thereafter, it may be updated by unsolicited data from the device or by Poll After
Setpoint.
4-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Double click an operation to select it. The operation is put at the current cursor
position in the input box. If the operation requires an argument, the cursor is
positioned for you to type the argument.
You can also:
• Select Point IDs... to access the Select A Point Browser.
• Select Edit Point… to edit the properties for a Point ID you have
selected in the input box.
• Select New Point… to create a new Point ID.
The operations are divided into the following areas:
• Arithmetic operations
• Alarm functions
• Bitwise operations
• Logical operations
• Relational operations
• Scientific operations
In addition to these operations, Point Configuration also supports the EU_CONV
function.
EU_CONV Function
By default, if a device point uses linear or custom conversion, the virtual point
equation uses the raw value for the point unless you do one of the following:
• Use the EU_CONV function in the expression whenever you reference
a device Point ID.
For example, if you have a device point called DEVICE_POINT with a
raw value of 1000 and an engineering units value of 100, then the
expression DEVICE_POINT / 10 yields 100, while
EU_CONV(DEVICE_POINT) / 10 yields 10.
• Set the Global Parameter PTMDP_DO_EU_CONV to "1".
If you do this, whenever a device Point ID is used in a virtual point
expression, it’s engineering units value is used, whether or not you
invoke the EU_CONV function.
For example, the expression DEVICE_POINT / 10 in the above
example yields 10 rather than 100 when this parameter is set.
Note
In CimView expressions, point values are always converted to engineering units in
expressions, whether EU_CONV is used or not in the expression.
4-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Logical Operations
Logical operations supported by the Expression Editor are:
AND Performs a logical AND of two Boolean expressions.
Format is <expr1> AND <expr2>.
OR Performs a logical OR of two Boolean expressions.
Format is <expr1> OR <expr2>.
NOT Performs a logical NOT of one Boolean expressions.
Format is NOT <expr1>.
XOR Performs a logical XOR of two Boolean expressions.
Format is <expr1> XOR <expr2>.
IF (expr1) THEN (expr2) ELSE (expr3) or (expr1) ? (expr2) : (expr3)
Performs a logical If A is TRUE, then B, else C.
expr1 must be a Boolean expression.
Bitwise Operations
Bitwise operations supported by the Expression Editor are:
BAND Performs a bitwise AND of two expressions.
Format is <expr1> BAND <expr2>.
BOR Performs a bitwise OR of two expressions.
Format is <expr1> BOR <expr2>.
BNOT Performs a bitwise NOT of one expressions.
Format is BNOT <expr1>.
BXOR Performs a bitwise XOR of two expressions.
Format is <expr1> BXOR <expr2>.
SHL Performs a binary left shift on an expression.
Format is (expr1) SHL (expr2).
For example, 2 SHL 1 returns a value of 4.
SHR Performs a binary right shift on an expression.
Format is (expr1) SHR (expr2).
For example, 2 SHR 1 returns a value of 1.
Alarm Functions
Alarm functions supported by the Expression Editor are:
AL
Returns True if the point is in any Alarm or Warning state.
Format is AL(<point id>)
A1 or WARNING
Returns True if the point is in a Warning High or Warning Low
state.
Format is A1(<point id>)
A2 or ALARM
Returns True if the point is in an Alarm High or Alarm Low state.
Format is A2(<point id>)
AH1 or WARNING_HIGH
Returns True if the point is in a Warning High state.
Format is AH1(<point id>)
AH2 or ALARM_HIGH
Returns True if the point is in an Alarm High state.
Format is AH2(<point id>)
AL1or WARNING_LOW
Returns True if the point is in a Warning Low state.
Format is AL1(<point id>)
AL2 or ALARM_LOW
Returns True if the point is in an Alarm Low state.
Format is AL2(<point id>)
ANA or ALARM_NOT_ACKED
Returns True if the point is in alarm and the alarm has not been
acknowledged.
Format is ANA(<point id>)
4-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Scientific Operations
The scientific operations supported by the Expression Editor are:
SIN Returns the sine (angle in radians) of an expression.
Format is SIN (expr)
COS Returns the cosine (angle in radians) value of an expression.
Format is COS (expr)
TAN Returns the tangent (angle in radians) of an expression.
Format is TAN (expr)
ASIN Returns the Arc Sine (angle in radians) value of an expression.
Format is ASIN (expr)
ACOS Returns the Arc Cosine (angle in radians) value of an expression.
Format is ACOS (expr)
ATAN Returns the Arc Tangent (angle in radians) value of an expression.
Format is ATAN (expr)
EXP Returns the exponential (ex) value of an expression where x is the
expression.
Format is EXP (expr)
LOG Returns the natural logarithm (base e) of an expression.
Format is LOG (expr)
LOG10 Returns the base 10 logarithm of an expression.
Format is LOG10 (expr)
X^Y Raise a value to a power.
The format for this operation is <value> ^ (<power>).
4-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Equation Points
An Equation point uses the expression you specify in the Equation field to update
the point’s value.
When you select the Equation Calculation Type, the Virtual properties are:
You can define a Reset Point, Trigger Point and an Equation for an Equation
point. You can also define an initial value for the point in Startup Condition.
Although this will not cause CIMPLICITY software to fail, it will cause
the Virtual Point Processor to always have work to do. This causes all
available computer time to be consumed, which adversely impacts
system performance.
• Use proper formatting for array points.
An example of the correct format is:
VIRTUAL_PT1 = DEVICE_PT[0] / 2.0
4-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Delta Accum Points
A Delta Accum point adds the difference between the current and previous values
of the expression that you specify in the Equation field to the current value of the
Delta Accum point. Delta accumulation is always calculated as follows:
If the previous value is less than the current value
Delta Accum = Delta Accum + (current value - previous value)
Else
Delta Accum = Delta Accum + (rollover value + 1) -
previous value + current value
The first Delta Accum update occurs after the first two expression updates are
received.
Delta values continue to be added until a Reset Condition is reached.
Use a Delta Accum point to capture the accumulation of positive increments in a
source point. A decrement in the source point value is also considered to be an
incremental delta. For example, a Delta Accum configured with a Rollover value
of 1000 receives a change from 100 to 999. Based on the formula described above,
the current value of the Delta Accum point is 899. The source point then changes
from 999 to 20. Based on the formula, the current delta is then (1000 + 1) - 999 + 20
= 22.
When you select the Delta Accum Calculation Type, the Virtual properties are:
You can define a Reset Point, Trigger Point, Equation, Variance, and
Rollover for a Delta Accum point. You can also define an initial value for the
point in Startup Condition.
4-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Reset Point for Delta Accum Point
Enter the Point ID of that point that will cause the Delta Accum point value to be
reset.
At run-time, the value of the Delta Accum point is reset as follows:
• If you do not define a Trigger Point:
• If the current value of the Equation is available, and no Init
Value is defined, the value of the Delta Accum point is reset to
zero (0).
• If the current value of the Equation is unavailable and an Init
Value is defined, the value of the Delta Accum point is reset to
the Init value.
• If current value of the Equation is available and an Init Value is
defined, the value of the Delta Accum point is reset to Init value.
• If the current value of the Equation is unavailable and no Init
Value is defined, the value of the Delta Accum point is reset to
zero (0).
• If you define a Trigger Point:
• If an Init Value is defined, the value of the Delta Accum point is
reset to the Init Value.
• If an Init Value is not defined, the value of the Delta Accum
point is reset to zero (0).
You can define a Reset Point, Trigger Point, and Equation for a Value
Accum point. You can also define an initial value for the point in Startup
Condition.
4-18 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Reset Point for Value Accum Point
Enter the Point ID of that point that will cause the Value Accum point value to be
reset.
At run-time, the value of the Value Accum point is reset as follows:
• If you do not define a Trigger Point:
• If the current value of the Equation is available, and no Init
Value is defined, the value of the Value Accum point is reset to
zero (0).
• If the current value of the Equation is unavailable and an Init
Value is defined, the value of the Value Accum point is reset to
the Init Value.
• If both current value of the Equation is available and an Init
Value is defined, the value of the Value Accum point is reset to
the Init Value.
• If the current value of the Equation is unavailable and no Init
Value is defined, the value of the Value Accum point is zero (0).
• If you define a Trigger Point:
• If an Init Value is defined, the value of the Value Accum point
is reset to the Init Value.
• If an Init Value is not defined, the value of the Value Accum
point is reset to zero (0).
The average is calculated as an eight-byte floating-point data type, then the result is
converted into the data type you specify for the Average point.
Note
For integer type points, the resulting data is rounded. This may result in a loss of
accuracy. It is suggested that you use the floating-point type for your Average
point.
When you select the Average calculation type, the Virtual properties are:
You can define a Reset Point, Trigger Point and Equation for an Average
point. You can also define an initial value for the point in Startup Condition.
4-20 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Reset Point for Average Point
Enter the ID of the point that will cause the Average point to be reset.
At run-time, when the Reset Point updates, the value of the Average point is reset
as follows:
• If the Trigger Point is not defined:
• If the current value of the Equation is available and no Init
Value is defined, the Average point is reset to the current value
of the equation.
• If the current value of the Equation is unavailable and an Init
Value is defined, the Average point is reset to the Init Value.
• If the current value of the Equation is available and an Init Value
is defined, the Average point is set to their average.
• If the current value Equation is unavailable and no Init Value is
defined, the Average point value is set to zero (0).
• If the Trigger Point is defined:
• If an Init Value is available, the Average point is reset to the Init
Value.
• If an Init Value is not available, the Average point value is set to
zero (0).
You can define a Reset Point, Trigger Point, and Equation for a Max Capture
point. You can also define an initial value for the point in Startup Condition.
4-22 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
• If the value of the Equation is available and the Init Value is
defined, the Max Capture point is set to whichever has the
maximum value.
• If the value of the Equation is unavailable and no Init Value is
defined, the Max Capture point value is set to the smallest
possible value for the point type. For example, for INT the value is
-32768.
• If the Trigger Point is defined:
• If the Init Value is defined, the Max Capture point is reset to the
Init Value.
• If no Init Value is defined, the Max Capture point value is set to
the smallest possible value for the point type. For example, for
INT the value is -32768.
You can define a Reset Point, Trigger Point, and Equation for a Min Capture
point. You can also define an initial value for the point in Startup Condition.
4-24 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
• If the current value of the Equation is available and the Init
Value is defined, the Min Capture point is set to whichever has
the minimum value.
• If the current value of the Equation is unavailable and no Init
Value is defined, the Min Capture point value is set to the
maximum possible value for the point type. For example, for INT
the value is 32767.
• If the Trigger Point is defined:
• If the Init Value is defined, the Min Capture point is reset to the
Init Value.
• If the Init Value is undefined, the Min Capture point value is set
to the maximum possible value for the point type. For example, for
INT the value is 32767.
4-26 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
You can define a Reset Point, Equation, Start Time, and Interval for a
Timer/Counter point. You can also define an initial value for the point in Startup
Condition.
Histogram Points
A Histogram point records the frequency at which the value of the source point,
identified in the Equation field, occurs within specified range intervals. This
information is typically displayed graphically as a histogram.
Each time the source point is updated, the counter whose range encompasses the
source point value is incremented.
You must configure a Histogram point as an array point. The number of elements
in the array will be:
the number of range intervals you desire + 6
The extra six elements are used to maintain the following data
• The minimum of the point values received
• The maximum of the point values received
• The total number of samples received
• The sum of the values of all samples received
• The number of sample values that were less than the lower limit of the
point range (underflow bucket)
• The number of sample values that were greater than the upper limit of
the point range (overflow bucket)
Use the Display Limits fields to specify the lower and upper range values within
which the point values are expected to occur. The range intervals are automatically
calculated based on the Display High and Display Low limits and the number of
Elements you specify.
4-28 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
When you select the Histogram Calculation Type, the Virtual properties are:
You can define a Reset Point, Trigger Point, and Equation for a Histogram
point. You can also define an initial value for the point in Startup Condition.
4-30 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Trans-High Accum Points
A Trans-High Accum point accumulates the number of times the Equation field
expression’s value transitions from a zero to a non-zero value. While the
CIMPLICITY project is running, this point remembers its latest state, even if the
points it depends on become unavailable.
Determining a transition takes into consideration the calculation type of the equation
and the point type of the Trans-High Accum point. For example:
• If the Trans-High Accum point type is DINT and the equation uses
floating point arithmetic, the result of the calculation is rounded to the
nearest integer. For example, a value of 0.1 is considered to be zero,
and a value of 0.6 is considered to be non-zero.
• If the Trans-High Accum point type is FLOAT and the equation uses
floating point arithmetic, then a transition from 0 to 0.1 is considered to
be a transition from a zero to a non-zero value.
When you select the Trans-High Accum Calculation Type, the Virtual properties
are:
You can define a Reset Point, Trigger Point, and Equation for a Trans-High
Accum point. You can also define an initial value for the point in Startup
Condition.
4-32 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Equation w/Override Points
An Equation w/Override point is similar to an Equation point. It uses the
expression you specify in the Equation field to update the point’s value. In
addition, applications may change the value of an Equation w/Override point.
The changed value remains in effect until one of the source points for the equation
changes and the equation is recalculated, or until an application supplies a new value
for the point.
When you select the Equation w/Override Calculation Type, the Virtual
properties are:
You can define a Reset Point, Trigger Point, and Equation for an Equation
w/Override point. You can also define an initial value for the point in Startup
Condition.
4-34 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Run-time Notes for Virtual Points
If the value entered in a Global point is out of range for the Point Type, the value
is truncated to fit the Point Type.
Out of range means that the result is For Equation and Equation with Override types, when the expression evaluates to
not within the range values specified
an out of range or overflow condition, the following message is logged to the
by the Point Type for the virtual
point. For example, an INT point Status Log with a Failure status:
has a range between -32768 and Result from expression is out of range. Point <point_id>
+32767.
The value of the virtual point becomes unavailable and remains that way until the
equation once more evaluates to a valid value.
All other calculation types keep their last available value
4-36 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Configuring Diagnostic Points
The CIMPLICITY HMI device communication enablers contain diagnostic data that
you can use to detect, diagnose, and correct data communication problems.
Standard diagnostic data, available for all enablers, includes:
Transmissions Number of messages sent to the device
Responses Number of responses received from the device
Retries Number of times a message had to be resent
Failures Number of periods of communication failure
Device status Current device state
Each enabler may also provide protocol-specific data.
Note
Diagnostic points are not available for the Point Bridge.
To view diagnostic data, configure device points corresponding to the diagnostic
locations in the enabler. These diagnostic points are like device data points in all
ways, except that they are always available when the enabler is running (points
containing device data are unavailable if communication with the device fails).
Diagnostic points may be scanned at any appropriate multiple of the port’s base scan
rate, displayed in CimView screens, trended, logged, alarmed, etc.
Note
You cannot write to diagnostic points. Always configure them for Read access.
Use the following values to configure diagnostic data for devices with custom
addressing:
Address Data Type Description
$TRANSMISSIONS UDINT Number of messages sent
$RESPONSES UDINT Number of messages received
$FAILURES UDINT Number of communication failures
$RETRIES UDINT Number of retries
$DEVICE_DOWN BOOL Device up status
$DEVICE_UP BOOL Device down status
4-38 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using the Trigger Function
The trigger function lets you configure points so that device data is read, or virtual
points are updated only when a trigger (or event) meets a configured condition.
For device points, triggers have the following requirements:
• The trigger point must be a configured device point.
• The trigger point must be on the same port as the points it is triggering.
The points may be on different devices, but the devices must be on the
same port.
For virtual points, the trigger point may be either a device point or a virtual point.
You can use triggers to:
• Coordinate or direct the sampling frequency of device points, or the
calculation frequency of virtual points.
• Make the system more efficient by reducing the amount of data that
needs to be managed by the data collection functions.
In other words, A1 is read at the 3, 6, 15, 18, and 24 second marks because the value
of D1 was HIGH at those times.
However, when the Update Criteria for D1 is set to On Change, the values for
A1 will vary as follows:
In other words, A1 is read at the 3, 15, and 24 second marks, because they are the
only places where the scanned value of D1 transitions from LOW to HIGH. Note
that any transitions that occur between scans (such as those between the 15 and 18
second marks) do not count.
4-40 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Example 1 - Device Point Interval Trigger
Data needs to be collected from point PLC1 at an interval signaled by a ready bit on
the PLC.
Configure the Trigger Settings and Scan Rate for PLC1 as follows:
At run-time, PLC1 will only be updated while the point PLC1_READY is equal to 1.
Example 2 - Efficiency
Triggering can reduce the amount of data that needs to be managed by the data
collection functions. This will help to improve the efficiency of your CIMPLICITY
system.
For example, for every contiguous sixteen bits of inputs or outputs on a Series 90-70
PLC, you can configure a single analog point that overlaps them. The update criteria
and trigger settings for the analog point would look like this:
The trigger settings and scan rate for each of the digital points should be configured
as follows:
If the trigger point (ANA_INP_20) does not change frequently, this gives a
performance benefit, because the digital points will only be updated when the analog
point changes.
4-42 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Types of Alarming
You can define values for Alarm High, Warning High, Warning Low, and Alarm
Low limits for points in the Analog Point Class. CIMPLICITY software supports
four methods for evaluating these alarm limits. The methods are:
Absolute Absolute alarms are used to detect when the value of a point
is too high or too low.
On Update On Update alarms are used to generate an alarm whenever
the point’s value is updated.
Rate of Change Rate of Change alarms can be used to detect either a faster or
slower than expected change in the value of a point.
Deviation Deviation alarms can be used to detect when the value of a
point deviates too far from that of a second point.
Absolute Alarming
If you choose the Absolute alarm criteria, you can define up to four Alarm Values.
Each time the point’s value is updated, its current value is compared with the Alarm
Values. An alarm is generated when the point’s value transitions from one alarm state
to another.
The transitions are:
State Description
Alarm High Point value ≥ Alarm High value.
Warning High Alarm High value > Point value ≥ Warning High value
Normal Warning High value > Point value > Warning Low value
Warning Low Warning Low value ≥ Point value > Alarm Low value
Alarm Low Point value ≤ Alarm Low value
If the point is in normal state, alarms for the point are reset by the Point Manager.
On Update Alarming
If you choose the On Update alarm criteria, you cannot define Alarm Values. Each
time the point’s value is updated, an alarm is generated.
Deviation Alarming
If you choose the Deviation alarm criteria, you will need to define Alarm Values,
and a Deviation Point. The point is scanned at its normal Scan Rate, but is
evaluated for alarming at the Alarm Delay rate (also known as the sample interval).
An alarm is generated when the difference between the current value of the point and
the current value of the Deviation Point exceeds an alarm limit. This difference is
calculated whenever the value of the point or the Deviation Point changes.
4-44 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Types of Data Conversion
You can define Engineering Unit (EU) conversions for points in the Analog Point
Class. CIMPLICITY software supports the following types of conversions:
None No conversion is performed.
Linear The point is converted according to the high and low Raw Limits you
specify on the Conversion page.
Custom The point is converted according to the Custom Expressions you
specify on the Conversion page.
When you specify Linear or Custom conversion, you must enter the values for the
Raw and Converted Limits.
Linear Conversion
When you use Linear conversion, you must enter four values for the Conversion
properties in the Limits box.
• The Raw Limit Low and Raw Limit High values determine the
minimum and maximum raw data values that can be expected for the
point. Values equaling or exceeding these limits are ignored.
• The Conv. Limit Low and Conv. Limit High values are the
maximum and minimum converted values for the point.
These four values are used to calculate the linear conversion for the point. The
conversion formula is:
where:
EU value = the Engineering Units value
RL = Raw Limit Low
RH = Raw Limit High
CL = Conv. Limit Low
CH - Conv. Limit High
Raw value = the value read from the device.
The inverse of this expression is used to convert Setpoint values entered by users to
raw values for downloading to the device.
When you use Custom conversion, you must enter two expressions for the
Conversion properties in the Custom Expressions box.
• The Forward expression is used to convert the raw data to engineering
units.
• The Reverse expression is used to convert setpoint values from
engineering units to raw data.
Use the place holder %P to indicate the point value in the expressions. Valid
operators that you can use are:
Arithmetic operators + - / * ( )
Logical operators AND, NOT, OR, XOR
Bitwise operators BAND, BNOT, BOR, BXOR
Relational operators LT, GT, EQ, LE, GE, NE
For example, if you have a conversion that calls for the raw data to be divided by
10.0, then multiplied by 2.5, the Forward expressions is:
(%P/10.0)*2.5
4-46 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Configuring Points
To configure points, double-click the Points icon in your project’s Configuration
cabinet.
If you have selected the Display search criteria at startup option, the Point
Search dialog box opens. Select the filtering criteria you want, and then select OK
to open the Configuration - Point window with the filtered list of points.
If you have not selected the Display search criteria at startup option, the
Configuration - Point window opens with a list of all configured points.
The list of points is initially sorted by Point ID. You may click any of the other title
buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Change Setpoint Security and Password information.
• Create a new point.
• Change the window display attributes.
• Change startup options.
• Modify a point.
• Copy the information for a selected point to a new point.
• Delete a point.
• Display a filtered list of points
Note
The $ROLE and $USER points are system points and cannot be changed or
removed.
Access Filter
Shows whether the point is an Enterprise point. If it is, the field contains "E",
otherwise, the field is blank.
Address
For a device point, this field contains the actual starting address of the point within
the device.
See the chapter in the CIMPLICITY HMI for Windows NT and Windows 95 Device
Communications Manual (GFK-1181) that pertains to device communications option
you are using for the correct address format to use.
Address Offset
For a device point, this field contains the offset in memory from the first bit of the
point Address that marks the start of the point data.
Alarm High
The high alarm value for the point.
Alarm Low
The low alarm value for the point.
Data Length
The data length associated with the data type chosen.
4-48 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Data Type ID
The point type used for the point. This field can have one of the following values:
0 Boolean type point
1 Integer type point
2 APPL type point
3 Text type point
4 Unsigned 8-bit integer type point
5 Unsigned 16-bit integer type point
6 Unsigned 32-bit integer type point
7 Signed 8-bit integer type point
8 Signed 16-bit integer type point
9 Signed 32-bit integer type point
10 Floating point type point
In addition, see the point’s Point Type attribute, which displays this information in
textual form.
Description
Text that gives users more information about the point.
Device ID
The source of the point data. This field can have one of the following values:
<device name> The name of the device that is supplying the point data.
$GLOBAL Indicates that the point is a Global derived point.
$DERIVED Indicates that the point is a Calculated derived point.
Display Format
The format used when displaying the point in CimView.
Display Limits
The upper and lower limits for horizontal/vertical movement, rotation/fill or
horizontal/vertical scaling in CimView if no limits are set for the expression and this
point is the single point used in the expression.
Has EU
Identifies whether or not Engineering Units (EU) conversion is being done for the
point. This field can have one of the following values:
0 No EU conversion
1 Linear or custom conversion is enabled
Point Class
Identifies the class selected for the point. This field can have one of the following
values:
0 Analog class
1 Digital class
3 Text class
4 Application class
Point Origin
Identifies the origin of the point. This field can have one of the following values:
0 Calculated derived point
1 Device point
2 Global derived point
Point Type
Identifies the type of point.
Resource
The resource associated with the point.
Warning High
The high warning value for the point.
Warning Low
The low warning value for the point.
4-50 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Setting Run-Time Point Properties
The run-time point properties let you:
• Enable/disable Set Point Security.
• Enable/disable Set Point Password.
To access the run-time point properties, you can do one of the following:
• Click the Points icon in your project’s Configuration cabinet, hold down
the right mouse key and select Setup from the drop-down menu.
• Select Setup from the Edit menu in the Configuration - Point window.
• Press Ctrl+O in the Configuration - Point window.
The Point Properties dialog box opens.
To enable Set Point Security, set the Set Point Security check box.
To enable Set Point Password:
1. Set the Set Point Password check box.
2. Enter the password that will be used to perform setpoint actions in the
Password input field.
3. Re-enter the password in the Confirm Password input field to
confirm it.
Select OK to close the dialog box and save your changes, or select Cancel to close
the dialog box without implementing any changes.
4-52 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Creating A New Point
To create a new point, you can do one of the following:
• Select New from the File menu.
• Click New Item on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the New Point dialog box opens. You can create
device and virtual points with this function.
Enter the name of the Point ID, Point Origin, and Point Class for the point you
are creating, then select OK. The system verifies that the point does not already
exist, and that no invalid characters have been used.
If the point information you entered is valid, the Point Definition dialog box for the
new point opens.
Point ID
Enter a unique identifier for the point you are creating. The identifier may be up to
32 characters long. You may use upper-case letters, numbers, and symbols in your
identifier.
See Naming Points for more detailed information.
Point Origin
If you are creating a device point, click the Device Point radio button, and then
enter the name of the device in the Device ID box. You can also:
• Click the Browser button to the right of the input field to browse for
devices.
• Click the Pop-up Menu button to create a new device, edit the currently
selected device, or browse for a device.
If you are creating a virtual point, click the Virtual Point radio button.
Point Class
Click the radio button for the Point Class you want to use for this point.
See Selecting A Point Class for more detailed information.
4-54 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
General Properties
The General properties let you define the description, Resource ID, data structure,
logging, access and safety point information for the point.
These properties are available for all points. Enter the following information to
define a new point.
Description
You can enter up to 40 characters of descriptive information about the point in this
field.
Resource ID
Enter the Resource ID associated with the point in this field. You can also:
• Click the Browser button to the right of the input field to use the Select
A Resource Browser to select the Resource ID from the current list of
configured resources.
• Click the Pop-up Menu button to create a new Resource ID, edit the
current Resource ID, or browse for a Resource ID.
Users that have this Resource ID assigned to their Role ID will be able to see any
alarms generated for this point on their Alarm Viewer screens.
Data Structure
This area contains the information that defines the structure of the point. Enter
information in the following fields:
Type Click the drop-down list button to the right of this list box to
display the types available for this point, and select one.
Logging
Use the check boxes and buttons in this area to indicate how the point is to be logged.
Log Data Set this check box if you want data for this point logged to the
Data Log or a Group log.
Log Alarm Set this check box if you want data for this point to be logged to
the Alarm or Event Log.
Once you set either box, the Settings... button activates. You can click Settings...
to enter Data Logger configuration information for the point.
Access
The fields in this input box are only available if you are defining a device point. Use
them to indicate how the point is to be accessed.
Read Click this radio button if you only want to be able to read values
from the point.
Read/Write Click this radio button if you want to be able to read and write
values to the point.
4-56 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Safety Point
The Safety Point is a digital or analog point that is to be checked when a Setpoint
request is made for this point. The point may be a device or virtual point.
At run-time, if the Safety Point evaluates to zero, or if it is unavailable, a Setpoint
will not be permitted on the point you are currently defining. Setpoints will only be
permitted if the Safety Point is available and evaluates to a non-zero value.
If you want to use this option, enter the Point ID of the safety point in this field. You
can also:
• Click the Browser button to the right of the input field to use the Select
A Point Browser to select the Point ID from the current list of
configured points.
• Click the Pop-up Menu button to create a new Point ID, edit the current
Point ID, or browse for a Point ID.
Availability Trigger
The Availability Trigger is a digital or analog point that is used to determine the
validity of the point you are currently configuring. You can use this point to
configure a "device healthy" signal for points that are tied to intermediate devices.
Enable Point
Set this check box if you want the point to be active when the project starts.
If you do not want the point to be enabled, clear the check box.
If you are using dynamic configuration, the point becomes active as soon as you
finish configuring it.
Enable Alarm
This check box is enabled when you define alarming for the point.
Set this check box if you want the point to generate alarms when the project is
running.
If you do not want the point to be alarmed, clear the check box.
If you are using dynamic configuration, point alarming becomes active as soon as
you finish configuring it.
Enterprise Point
Set this check box if you want the point to be available to other projects as an
enterprise point.
If you do not want the point to be available to other projects as an enterprise point,
clear this check box.
Max Duration Set this box to save a buffer of points based on time, and enter
the time period in the input boxes.
Max Count Set this box to save a number of point values in the buffer, and
enter the number of values you want to save in the input box.
You may select either option, or both. If you select both, the Max Count takes
precedence over Max Duration in determining the number of values saved in the
buffer.
Example:
Point ABC is scanned every 5 seconds
• If you define a Max Duration of 1 minute, the buffer contains the 12
most recent values for ABC at any given time.
• If you define a Max Count of 10, the buffer contains the 10 most
recent values (that is, the values for the last 50 seconds).
• If you define both Max Duration and Max Count, the buffer contains
the 10 most recent values.
Note
Point buffering is not supported for Enterprise Server points.
4-58 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Device Properties
The Device properties let you define the Device ID, addressing, trigger settings, scan
rate, and analog deadband for device points.
Important
Domains for programmable controllers in CIMPLICITY HMI software are
sized when the project starts. If you dynamically reconfigure domains
sizes on the programmable controller, you must restart the project to
access points at the new domain offsets.
Device ID
Enter the Device ID of the device where the point originates in this field. You can
also:
• Click the Browser button to the right of the input field to use the Select
A Device Browser to select the Device ID from the current list of
configured devices.
• Click the Pop-up Menu button to create a new Device ID, edit the
current Device ID, or browse for another Device ID.
Address Enter the starting address for the point in this field. The
address you use depends on the addressing conventions
for the individual device. See the CIMPLICITY HMI
for Windows NT and Windows 95 Device
Communications Manual (GFK-1181) for more
information.
Address Offset This field is active only when you are defining Bool
points.
If the first bit of the point’s data is not the first bit of the
address, enter the bit offset in this field. Address
offsets start at "0", and are numbered from right to left.
For example, if you are configuring a digital point
located in the third bit of Register 5 on a Series 90-70,
the Address is "%R5", and the Address Offset is
"2".
See the CIMPLICITY HMI for Windows NT and
Windows 95 Device Communications Manual (GFK-
1181) for more device and protocol specific
information.
Update Criteria This field determines when data for the point is passed
from the device communications processor to the point
database. Once the updated data is in the point
database, it is available to all CIMPLICITY
applications that need it.
For more information on update criteria, see Device
Point Data Collection.
Click the drop-down list button to the right of the field
to see the choices available, then click the one you
want.
Your choices are:
On Scan
On Change
On Demand On Scan
On Demand On Change
Unsolicited
Poll Once
4-60 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
The choices you see depend on the protocol you are
using.
Device Data Set this check box if the address you enter is for a
device point.
Diagnostic Data Set this check box if the address you enter is for a
diagnostic point.
Ethernet Global Data This check box will be enabled only if the device
supports Ethernet global data. Set this check box if the
address you enter is for Ethernet global data.
Domain Address
Domain Address is used for devices created via the Device Communications Toolkit
API that use standard addressing.
Use the fields in this input box to define where the point is located in the device, and
how the point is to be updated.
Domain Type Select the domain that represents the type of device memory
from which the point is coming.
Domain Offset Enter the starting address for the point in this field. The
address depends on the addressing conventions for the
individual device. See the CIMPLICITY HMI for Windows
NT and Windows 95 Device Communications Manual (GFK-
1181) for more information.
Bit Offset This field is active only when you are defining Bool points.
If the first bit of the point’s data is not the first bit of the
address, enter the bit offset in this field. Address offsets start
at "0", and are numbered from right to left.
See the CIMPLICITY HMI for Windows NT and Windows 95
Device Communications Manual (GFK-1181) for more device
and protocol specific information.
Update Criteria This field determines when data for the point is passed from
the device communications processor to the point database.
Once the updated data is in the point database, it is available
to all that need it.
For more information on update criteria, see Device Point
Data Collection.
Click the drop-down list button to the right of the field to see
the choices available, then click the one you want.
Trigger Settings
When you define Trigger Settings for Enter data in the fields in this box if reads of this point are to be triggered by a
a point, use a Scan Rate of 0 (zero).
certain condition of another point.
For more information on triggered points, see Using the Trigger Function.
Trigger Point Enter the Point ID of the device point that serves as the trigger
for this point. The Trigger Point must be on the same device
as the point you are defining. You can also:
• Click the Browser button to the right of the input field
to use the Select A Point Browser to select the Point ID
from the current list of configured points.
• Click the Pop-up Menu button to create a new Point ID,
edit the current Point ID, or browse for a Point ID.
Relation This field determines how the trigger point will be evaluated.
Click the drop-down list button to the right of the field to see the
choices available, then click the one you want.
Your choices are:
None Triggering will not occur.
ONCHANGE Trigger is activated whenever the
Trigger Point is changed.
EQ Trigger is activated when the Trigger
Point’s value equals Value.
LT Trigger is active when the Trigger
Point’s value is less than Value.
GT Trigger is active when the Trigger
Point’s value is greater than Value.
LE Trigger is active when the Trigger
Point’s value is less than or equal to
Value.
GE Trigger is active when the Trigger
Point’s value is greater than or equal to
Value.
Value Enter the value the Trigger Point will be compared with to
determine if the trigger condition has been met.
This point is read only when the trigger condition evaluates to TRUE.
The trigger condition is evaluated each time the trigger point is polled, so effectively,
this point is polled at the trigger point’s scan rate while the trigger condition is true.
4-62 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Scan Rate
When you define Trigger Settings for Enter the frequency at which the CIMPLICITY device communications option will
a point, enter 0 (zero) in the Scan
read this point’s data based on the ports Base Rate. The Base Rate is the
Rate field.
minimum rate at which device points can be polled on the port. The Scan Rate is a
multiple of the Base Rate. For example, if the Base Rate is 5 seconds, and the
Scan Rate is set to "3", the point is scanned every 15 seconds.
Analog Deadband
When you are defining an Analog point, you can use the Analog Deadband to
filter out changes in the raw value of this point. The raw value must change by at
least this value before the point value is updated in the CIMPLICITY point database.
You can use the Analog Deadband to have CIMPLICITY software ignore small
fluctuations in the value of a point. For example, if you have a point ranging from 0
to 10,000, and you enter 5 in this field, any point fluctuations of less than 5 are
ignored.
Point Manager
Displays the name of the Point Management process that manages this point.
Process ID
Displays the name of the Virtual Point process that calculates the value for this point.
Calculation Type
Select the method for determining the point value. Click the drop-down list button to
the right of the field to see the choices available, then select the one you want.
The calculation types are:
Global Max Capture
Equation Min Capture
Delta Accum Trans-High Accum
Value Accum Equation w/Override
Average Timer/Counter
Histogram
For Text and Appl point types, you can only define Global virtual points. For
Boolean point types, you can only define Global, Equation, and Equation
w/Override virtual point.
4-64 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Reset Point
Use the Reset Point for virtual points with Average, Min Capture, Max
Capture, Delta Accum, or Value Accum calculation types. See the description
for the calculation type for details on how this point is used.
The virtual point resets whenever the Reset Point is updated.
You can also:
• Click the Browser button to the right of the input field to use the Select
A Point Browser to select the Point ID from the current list of
configured points.
• Click the Pop-up Menu button to create a new Point ID, edit the current
Point ID, or browse for a Point ID.
For the Reset Point, you should choose a global point with an initial value.
Trigger Point
Enter the Point ID of the point that will cause the value of this virtual point to be
updated. See the description for the calculation type for details on how this point is
used.
The virtual point updates whenever the Trigger Point value updates. The Trigger
Point may be either a digital or an analog point.
You can also:
• Click the Browser button to the right of the input field to use the Select
A Point Browser to select the Point ID from the current list of
configured points.
• Click the Pop-up Menu button to create a new Point ID, edit the current
Point ID, or browse for a Point ID.
This feature is designed to minimize the system resources that are required for
calculating virtual points when it is not necessary to keep virtual points current with
the points used to calculate their values. For example, if the application requires that
the virtual point be updated hourly for logging purposes, select a Trigger Point
with a one hour scan rate.
See Using the Trigger Function for more information on trigger points.
Equation
Enter information that specifies how the point value is calculated.
You can click the Browser button to the right of the input field to use the Edit
Expression dialog box to construct the equation. You can also use the Pop-up Menu
button to:
• Browse for another Point ID
• Create a new Point ID.
• Edit the properties for a Point ID.
• Edit the expression.
• Select operations to be included in the expression.
See the description for the calculation type for details on how this field is used.
See Using the Expression Editor for more information
Rollover
For Delta Accum points, enter the value at which the point "rolls over" to a zero
value when incremented by one unit.
For example, if you configure a Rollover value of 99, and the point has a current
value of 97, if a new value of 3 is received, the delta is calculated as:
(100 - 97) + 3 = 6
Start Time
For Timer/Counter points, enter a starting time used by the Derived Point
Processor to update the Point Manager with information on the number of events,
cumulative duration, and time of the last HIGH event occurrence.
Interval
For Timer/Counter points, enter the frequency at which the Derived Point
Processor updates the Point Manager with information on the number of events,
cumulative duration, and time of the last HIGH event occurrence.
Local
Set this check box if the value of this virtual point is not to be reported to the Point
Management process. This is useful for points that are only used to hold
intermediate values in calculations. For such points, setting the Local flag
eliminates the overhead of reporting to the Point Management process. Local points
cannot be shared with other applications.
Startup Conditions
Use these radio buttons to select the source for the initial value of this point when the
software is started up or reset. You can choose:
Not Applicable No reset/startup condition is defined.
Saved Use the value saved when the project was last shutdown
Note
The last known value is not saved if the computer crashes.
Init Use the constant entered in the Initial Value field.
For Analog and Boolean class points and multi-character
strings (such as STRING_8), each element in the array is
initialized to the Initial Value. For example, if you have a
STRING_8 array of size 4 and an Initial Value of
"ABCDEFGH", each element in the array is initialized to
"ABCDEFGH".
4-66 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
For single character string arrays, each element in the array is
initialized with the corresponding character in the Initial
Value field. For example, if you have a STRING array of
size 8 and an initial value of "ABCDEFGH", then STRING[0]
is set to "A", STRING[1] to "B", etc. If too many elements
are given in Initial Value, the string truncates at the number of
elements. If the Initial Value does not specify enough
elements, the remaining elements of the string are initialize to
the Null character.
Saved or Init Use the saved value if there is one, otherwise use the constant
entered in the Initial Value field.
If you choose Init or Saved or Init, the Initial Value field activates. Enter the
value for the point at initialization, before any data is generated by its component
point(s).
See the description for the calculation type you are defining for details on Startup
Conditions are used.
Format
These input fields let you define the justification, display width, and precision to be
used when the point is displayed in standard CIMPLICITY software displays such as
CimView.
Justification Click the radio button next to the justification you want. Your
choices are:
Left - Point display is left justified
Right - Point display is right justified
Zero - Point display is right justified and zero filled
Width Enter the number of spaces you want to dedicate to the display
of the point value in this field.
If Width is omitted, CIMPLICITY software will use a width
large enough to accommodate the value.
Precision This field is available only if you are defining a Floating type
point.
Enter the number of digits to be displayed to the right of the
decimal point in this field.
4-68 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Type Use this field to determine the format type when the point is
displayed on a CimView screen.
• For integer point types, Decimal is the only
format type.
• For Real points and points with Engineering
Units conversion, select Fixed, Scientific or
Compact.
If you select Fixed, the point’s value is displayed in fixed
format using the Width and Precision information you
specify. For example, if you specify a Width of 7 and
Precision of 3, the point display uses 7 places and there are 3
places after the decimal point. For example, 10 displays as
10.000. If you do not specify the Precision, the default is 6.
If you select Scientific, the point’s value is displayed in
scientific format using the Width and Precision information
you specify. If you do not specify the precision, the default is
6.
If you select Compact, the point’s value displays in Fixed or
Scientific format based on Precision, which determines the
exponent to start displaying in Scientific format. For example,
if you specify a Precision of 5, the value 100,000 displays as
1e+005 and 10,000 displays as 10000. The Compact type
also truncates trailing zeros to the right of the decimal point.
For example, 10.0 displays as 10 and 10.10 displays as 10.1.
Display Settings
Display limits are used by CimView as maximum/minimum limits in single point
graphic expressions. These expressions are:
• Horizontal/Vertical movement
• Rotation/Fill
• Horizontal/Vertical scaling
If you have a single point expression in any of the above expressions and you do not
specify a minimum or maximum limit for the expression, the point’s display limits are
used instead. If these limits are not specified either, default values of 0 (minimum)
and 100 (maximum) are used.
Display High Enter the upper bound for the display in this field. If the
point value is greater than this value, the Display High
value is displayed.
Display Low Enter the lower bound for the display in this field. if the
point value is less than this value, the Display Low value
is displayed
Engineering Units Enter the units (for example, "degrees" or "parts") that the
point data represents in this field. Engineering units may
be selected whether or not any conversion takes place.
Conversion Properties
The Conversion properties let you define the type of value conversion to be
performed, the conversion limits, and custom expressions for the Custom
conversion
For an in-depth discussion of the types of data conversion, see Types of Data
Conversion.
Conversion
CIMPLICITY software supports the following types of point conversion:
None Click this radio button if you do not want any point conversion.
Linear Click this radio button to convert the point according to the high and
low Raw and Converted limits that you specify on this page.
Custom Click this radio button to convert the point according to the
conversion limits and Custom Expressions that you specify on this
page.
4-70 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Limits
For Raw Limit Low and Raw Limit High, enter the minimum and maximum raw
data values that can be expected for this point. Values equaling or exceeding the
indicated limits are ignored as follows:
• If a setpoint value exceeds a defined raw limit, the setpoint is rejected.
• If a raw limit is exceeded at run-time and RAW LIMIT ALARMS are
disabled, the last good point value displays until the point comes back
within raw limits.
• If a raw limit is exceeded at run-time and RAW LIMIT ALARMS are
enabled:
• The point value on CimView screens displays the default text until
the point comes back within raw limits.
• Point Control Panel displays asterisks (******) for the point value
until the point comes back within raw limits.
• If a raw limit is exceeded at startup,
• The point value on CimView screens displays the default text until
the point comes back within raw limits
• Point Control Panel displays asterisks (******) for the point value
until the point comes back within raw limits.
• Users cannot enter setpoints that exceed the raw limits.
If Raw Limit Alarms are enabled, an alarm is generated when a point value first
exceeds its alarm limits. When the point value returns to within its limits, the alarm
state will be set to Normal.
If you select Linear conversion, you must also enter values in the Conv. Limit
Low and Conv. Limit High fields. The entries in these four fields, plus the raw
value for the point are used to convert the point’s raw value to an engineering units
value.
See Types of Data Conversion for a description of the Linear Conversion
equation.
If you select Custom conversion, you may enter values in the Conv. Limit Low
and Conv. Limit High fields. If a setpoint value exceeds a defined conversion
limit, the setpoint will be rejected.
Custom Expressions
The Custom Expressions input fields are enabled when you select Custom
conversion.
Enter the equation to convert raw data to engineering units in the Forward
expression.
Enter the equation to convert Setpoint values from engineering units to raw values in
the Reverse expression.
You may also enter values in the Conv. Limit Low and Conv. Limit High fields.
If a setpoint value exceeds a defined conversion limit, the setpoint will be rejected.
See Types of Data Conversion for details on Custom Conversion.
Definition
To activate the rest of this dialog, you must first define the Alarm Class and Alarm
Message for the alarm.
This input box lets you define the alarm class and message that will be used when
this point’s value goes into an alarm state.
Alarm Class Enter an Alarm Class in this field. Alarms with similar
characteristics can be grouped by class, and classes can be
prioritized. An alarm’s class determines the order in which it
appears relative to other alarms in Alarm Viewer. You can
also:
• Click the Browser button to the right of the input box
to use the Select a Alarm Class Browser to display a
list of Alarm Classes and select one.
• Click the Pop-up Menu button to create a new Alarm
Class, modify the current Alarm Class, or browse for
an Alarm Class.
Alarm Message Enter a message in this field that will be displayed with the
alarm in Alarm Viewer. This message may contain text plus
the following variable information that is determined when the
alarm is generated:
%ID - displays the Point ID.
%VAL - displays the point value (converted to
engineering units if applicable).
4-72 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
%EU - displays the Engineering Units label.
%LIMIT - displays the alarm limit that was exceeded.
%STATE - displays the alarm string for the String Index.
%DEV_ID - displays the Point ID of the deviation point.
%DEV_VAL - displays the value of the deviation point.
%DEV_AMT - displays the difference between the
current point value and the deviation point value.
%% - displays an actual percent sign in the message.
For example, if an alarm string is configured so that the string
for Warning High is "WARNING", and the string for Alarm
High is "EMERGENCY, the Alarm High and Warning High
limits are 400 and 350 degrees, and the alarm message is:
CONDITION: %STATE - TEMP IS AT %VAL DEGREES
If the temperature reads 353 degrees, an alarm will be
generated with the message:
CONDITION: WARNING - TEMP IS AT 353 DEGREES
If the temperature goes to 402 degrees, the alarm will be
updated and the message will read:
CONDITION: EMERGENCY - TEMP IS AT 402 DEGREES
If you specify an Alarm Class, you must specify an Alarm
Message.
String Index If you are using %STATE in your alarm message, enter the
index number of the string whose texts you want to use. You
can also:
• Click the Browser button to the right of the input
field to use the Select a Alarm String Browser to
display the list of Alarm Strings and select one.
• Click the Pop-up Menu button to create a new Alarm
String, modify the current Alarm String, or browse
for an Alarm String.
Alarm Criteria
You can select one of the following methods for evaluating the alarm values:
Absolute Absolute alarms are used to detect when the value of a point is
too high or too low.
On Update On Update alarms can be used to detect point value changes.
Rate of Change Rate of Change alarms can be used to detect either a faster or
slower than expected change in the value of a point.
If you select this alarm criteria, you must also enter a sampling
interval in the Interval fields.
4-74 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Deadband
Enter a value defining the tolerance for alarm conditions in this field.
The deadband cushions the generation of alarms when a point value fluctuates at an
alarm limit. For example, if a high alarm limit is defined as 100, the point’s alarm
state changes each time the point value goes from 99 to 100 or 100 to 99. If you
define a deadband of 5, the point goes into the alarm state when its value reaches
100, and stays in the alarm state until its value drops below 95.
In addition, when a point transitions from an alarm state into a warning state of the
same type, the alarm status switches from Alarm to Warning only if the point value is
more than the deadband away from the alarm limit. For example, if a high alarm
limit of 100, a warning high limit of 90, and a deadband of 2 are defined for a point,
when the point’s value is 100, the point is in Alarm High state. The alarm state
changes to Warning High when the point’s value falls below 98 (the alarm limit
minus the deadband).
Help File
Enter the name of a text file that users can display when they click the Help button in
the Alarm Viewer. You can enter a filename of up to 8 characters.
The actual file is in the ALARM_HELP directory in your project. The actual
filename is the name given in this field, followed by ".HLP".
Alarm Help files are ASCII text files of up to sixty (60) lines. Each line can have a
maximum of 70 characters. Files are located in the %SITE_ROOT%\alarm_help
directory.
If you wish, you may use the same Help File for several points.
4-76 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Creating A New Role
If you do not see the Role you want, you can create a new Role. To do this:
1. Select New. The New Role dialog box opens.
2. Enter the new Role ID and select OK. The system verifies that the Role
ID does not already exist, and that no invalid characters have been used.
3. If the Role ID you entered is valid, the Role Properties dialog box
opens.
4. Enter the properties you want for this role
5. Select OK to create the new Role and return to the Alarm Routing
properties.
Note
If you have not defined an alarm for the point, any information you enter on this page
is not saved when you select OK.
Repeat Timeout
The Repeat Timeout is the time (in minutes) that the Alarm Manager waits before
repeating the alarm to all interested processes. The alarm will continue to be
repeated until it is acknowledged, reset, or deleted.
Acknowledge Timeout
The Acknowledge timeout is the time (in minutes) that the Alarm Manager waits
before automatically acknowledging an alarm.
Note
The actual number of minutes that the Alarm Manager will wait before
acknowledging the alarm may be greater than this number. The maximum time will
be the number you enter in this field plus the number of minutes configured for the
timer for processing automatic alarms in the Alarm Manager configuration file
(alarm_mgr.dat). The default for this timer is 5 minutes.
You can choose one of the following options:
Time Click this radio button, and enter a time in minutes in the
input field if you want to have the Alarm Manager
automatically acknowledge this point’s alarm if a user
has not acknowledged the alarm before this time period
expires.
Immediate Click this radio button if you want to have the Alarm
Manager automatically acknowledge this alarm
immediately after it is generated.
Never Click this radio button if you do not want the Alarm
Manager to automatically acknowledge this alarm.
Deletion Requirements
When an alarm has been acknowledged, one of two events has happened:
• A user has responded to the alarm and manually acknowledged it in the
Alarm Viewer.
• The alarm was automatically acknowledged by the Alarm Manager.
4-78 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
When an alarm has been reset, one of three events has happened:
• A user has manually reset the alarm in the Alarm Viewer. This is
permitted if you have enabled Manual Reset Allowed for the alarm.
• The alarm was automatically reset by the Alarm Manager. This is
permitted if you have selected a timed or immediate Reset Timeout
for the alarm.
• The condition causing the alarm no longer exists, and the alarm was
automatically reset by the process that detected the alarm condition.
The Deletion Requirements are the conditions that must exist in order for an alarm to
be deleted (removed from the system).
You can choose any combination of the following:
Acknowledge Set this check box to delete the alarm when it is
Acknowledged.
Reset Set this check box to delete the alarm when it is Reset.
If you set both check boxes, the alarm will not be deleted until it is acknowledged
and reset (these actions may occur in any order).
Reset Timeout
The Reset timeout is the time (in minutes) that the Alarm Manager waits before
automatically resetting an alarm.
Note
The actual number of minutes that the Alarm Manager will wait before resetting the
alarm may be greater than this number. The maximum time will be the number you
enter in this field plus the number of minutes configured for the timer for processing
automatic alarms in the Alarm Manager configuration file (alarm_mgr.dat). The
default for this timer is 5 minutes.
You can choose one of the following options:
Time Click this radio button, and enter a time in minutes in the
input field if you want to have the Alarm Manager
automatically reset this point’s alarm if it has not been
reset before this time period expires.
Immediate Click this radio button to have the Alarm Manager
automatically reset this point’s alarm immediately after it
is generated.
Never Click this radio button if you do not want the Alarm
Manager to automatically reset this alarm.
4-80 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Device Configuration
About Devices
A device is anything that can communicate point data to CIMPLICITY HMI
software. CIMPLICITY HMI software can read data from and write data to devices.
Examples of devices are programmable controllers such as the GE Fanuc Series 90.
Use this function to configure devices and specify their characteristics.
Configuration requirements for devices vary depending on the type of device and
communications protocol being used. See the CIMPLICITY HMI for Windows NT
and Windows 95 Device Communications Manual (GFK-1181) for detailed
information on configuring a device for a particular protocol.
Configuring Devices
To configure devices, double-click the Devices icon in your project’s Configuration
cabinet.
If you have selected the Display search criteria at startup option, the Device
Search dialog box opens. Select the filtering criteria you want and then select OK to
open the Configuration - Device window with the filtered list of devices.
If you have not selected the Display search criteria at startup option, the
Configuration - Device window opens with a list of all configured devices.
GFK-1180 5-1
When you select Devices the Configuration - Device window opens.
The Configuration - Device window always displays the following attribute for each
device:
Device ID The physical device identifier
In addition to Device, you can choose to display the following attributes:
Port The port to which the device is connected
Resource A configured resource
Only users that are assigned this resource can view alarms for
this device.
Note
Alarms for points on the device may or may not use the same
resource as the device.
Description Up to 40 characters of text that describes the device
The list of devices is initially sorted by Device ID. You may click on any of the
other attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new device.
• Change the window display attributes.
• Change startup options.
• Modify a device.
• Copy the information for a selected device to a new device.
• Delete a device.
• Display a filtered list of devices
5-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating A New Device
To create a new device, you can do one of the following:
• Select New from the File menu.
• Click the New Item button on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the New Device dialog box opens.
The General properties let you define the following for a new device:
Port The port you selected in the New Device dialog box is
displayed in this field.
5-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Device-Specific Properties
The device-specific properties depend on the type of device you are configuring. See
the CIMPLICITY HMI for Windows NT and Windows 95 Device Communications
Manual (GFK-1181) for detailed information.
For devices used by both CIMPLICITY HMI and CIMPLICITY Control, see "Using
CIMPLICITY HMI with CIMPLICITY Control" for detailed information.
Modifying A Device
To modify a device, you can double-click the Device you want to modify.
Alternatively, you can select the Device you want to modify, then do one of the
following:
• Select Modify from the Edit menu.
• Click the Modify Item button on the Toolbar.
• Press Ctrl+M.
After you initiate the request, the Device Properties dialog box opens. The
properties contain the device’s current configuration information. You can modify
any of these properties.
Select OK to close the Device Properties dialog box and modify the information for
the selected Device.
Select Cancel to close the Device Properties dialog box without modifying the
Device.
About Resources
Resources are the physical or conceptual units that comprise your facility. They can
be devices, machines, or stations where work is performed, or areas where several
tasks are carried out. Resource configuration plays an important role in your
CIMPLICITY HMI project by routing alarms to specific users and filtering the data
users receive.
CIMPLICITY HMI software uses resources in the following ways:
• Each CIMPLICITY HMI device and point is associated with a
resource.
• Each user has a view of the facility. The view is defined by the
resources configured for that user. CIMPLICITY HMI software alarms
are generated against resources and routed (displayed) to users who
have those resources in their view.
• Many base system functions (such as Alarm Viewer) and product
option functions filter data by resource. For example, a user can create
an Alarm Viewer display that only contains alarm data for a specific
resource.
Configuring Resources
To configure resources, double-click the Resources icon from your project’s
Configuration cabinet.
If you have selected the Display search criteria at startup option, the Resource Search
dialog box opens. Select the filtering criteria you want, then select OK to open the
Configuration - Resource window with the filtered list of resources.
If you have not selected the Display search criteria at startup option, the
Configuration - Resource window opens with a list of all configured resources.
GFK-1180 6-1
The Configuration - Resource window always displays the following attribute for
each resource:
Resource A name that uniquely identifies each resource.
In addition to Resource, you can choose to display the following attributes:
Description Text that gives users more information about the resource.
Resource Type Identifies the type of resource. CIMPLICITY HMI software
currently supports two resource types: SYSTEM, and
RESOURCE. This is a display-only field and cannot be
modified.
Any resources you create are automatically given a Resource
Type of RESOURCE
Alarm Mgr Identifies the Alarm Manager process that receives alarms for
this resource. This is a display-only field and cannot be
modified.
The list of resources is initially sorted by Resource. You may click any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new resource.
• Change the window display attributes.
• Change startup options.
• Modify a resource.
• Copy the information for a selected resource to a new resource.
• Delete a resource.
• Display a filtered list of resources
6-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating A New Resource
To create a new resource, you can do one of the following:
• Select New from the File menu.
• Click New Item on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the New Resource dialog box opens.
Enter the name of the new resource in the Resource ID field and select OK. The
system verifies that the Resource ID does not already exist, and that no invalid
characters have been used.
If the Resource ID you entered is valid, the Resource Definition dialog box for the
new resource opens.
Resource Definition
The Resource Definition dialog box lets you define the following for a new resource:
Description Up to 40 characters of explanatory text describing the
resource.
Note that you cannot use the $ or | characters in a resource
name.
Users for this The list of users that can view alarm or point information for
Resource this resource.
6-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Port Configuration
About Ports
A port is a communication "socket" that connects one or more factory devices such
as PLCs to the computer.
Use this function to configure ports and specify their characteristics. Configuration
requirements for ports vary depending on the type of port and communications
protocol being used. See the CIMPLICITY HMI for Windows NT and Windows 95
Device Communications Manual (GFK-1181) for detailed information on
configuring ports for your specific device.
Configuring Ports
You can create a maximum of sixteen (16) ports per project. If you attempt to create
more ports after that, the following message displays:
To configure ports, double-click the Ports icon from your project’s Configuration
cabinet.
If you have selected the Display search criteria at startup option, the Port Search
dialog box opens. Select the filtering criteria you want, then select OK to open the
Configuration - Port window with the filtered list of ports.
If you have not selected the Display search criteria at startup option, the
Configuration - Port window opens with a list of all configured ports.
GFK-1180 7-1
The Configuration - Port window always displays the following attribute for each
port:
Port The physical port identifier.
In addition to Port you can choose to display the following attributes:
Protocol ID The protocol used for device communications.
Description Text that gives users more information about the port.
The list of ports is initially sorted by Port. You may click on any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new port.
• Change the window display attributes.
• Change startup options.
• Modify a port.
• Delete a port.
• Display a filtered list of ports
7-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating A New Port
To create a new port, you can do one of the following:
• Select New from the File menu.
• Click New Item on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the New Port dialog box opens.
The General properties let you define the following for a new port:
Description Up to 40 characters of explanatory text about the port.
Scan Rate The basic timer for points monitored from this port. The rate at
which points are polled is a multiple of this scan rate. The scan
rate includes configurable units that may be set in units of
Ticks (hundredths of seconds), Seconds, Minutes or
Hours.
Retry Count The number of times to retry communications to devices on this
port after a communications error is encountered
If communications cannot be established, devices on this port
are considered to be down, and a $DEVICE_DOWN alarm is
generated for each device.
Once a device is down, periodic attempts are made to resume
communications to the device.
Enable Set this check box to enable communications on this port. The
port.
Clear this check box to disable communications on this port.
Note
If you dynamically disable a port, polling stops. However,
setpoints and unsolicited data will still be processed.
Port-Specific Properties
The port-specific properties depend on the type of port you are configuring. See the
CIMPLICITY MMI and MES/SCADA Products Device Communications Manual
(GFK-1181) for detailed information.
7-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Changing A Port’s Protocol
In your CIMPLICITY HMI project configuration, device and point data are protocol
dependent. You cannot delete a port then re-add it using another protocol if device
and point data for the original port still exist. The correct procedure for changing a
port’s protocol is:
1. If you plan to re-use the same point data, export the point data for the
port using the Import/Export utility.
2. Delete the point data for the port.
3. Delete the device data for the port.
4. Delete the port.
5. Create the port with the new protocol.
6. Define the devices for the port.
7. If you exported the point data, then use the Import/Export utility to
import the point data. Otherwise, define new points.
GFK-1180 8-1
The Configuration - Alarm Class window always displays the following attribute for
each Alarm Class:
Class ID The identifier for the class
In addition to Class ID, you can choose to display:
Class Description Order Alarm State BG
Alarm State FG Normal State BG Normal State FG
Ack State BG Ack State FG
The list of classes is initially sorted by Class ID. You may click any of the other
title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new alarm class.
• Change the window display attributes.
• Change startup options.
• Modify an alarm class.
• Copy the information for a selected alarm class to a new alarm class.
• Delete an alarm class.
• Display a filtered list of alarm classes
Note that the colors are displayed by number rather than name in this window.
8-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating A New Alarm Class
To create a new alarm class, you can do one of the following:
• Select New from the File menu.
• Click New Item on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the Alarm Class dialog box opens.
Select OK to close the Alarm Class dialog box and create the new Alarm Class.
Select Cancel to close the Alarm Class dialog box without creating a new Alarm
Class.
Enter the following information to create a new Alarm Class:
Class ID
Enter the name of the new Alarm Class. The class name can be up to five (5)
characters in length. Each class name must be unique.
Note that you cannot use the $ or | characters in a Class ID.
Description
Enter a description of the Alarm Class. The description can be up to 64 characters in
length.
Order
Enter the Alarm Class order (priority). This must be a number between 0 and 99.
The lower the number you enter, the higher the priority of the class.
Alarm State
You can select the foreground (text) and background colors for displaying alarms in
this class in Alarm Viewer that are in the Alarm state.
Default colors are White for the text and Black for the background.
Acknowledged State
You can select the foreground (text) and background colors for displaying alarms in
this class in Alarm Viewer that are in the Acknowledged state.
Default colors are White for the text and Black for the background
Audio Support
You can configure an alarm class to use audio alarming whenever an alarm in that
class is generated.
For details on configuring and using this feature, see Using Alarm Audio Support.
8-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Class Color Assignments
The default mappings for Alarm Colors are:
Number Red Green Blue Color
0 0 0 0 Black
1 255 0 0 Red
2 0 255 0 Lime
3 0 0 255 Blue
4 128 0 0 Maroon
5 0 128 0 Green
6 128 0 128 Purple
7 255 255 255 White
8 0 128 128 Teal
9 128 128 128 Gray
10 128 128 0 Olive
11 32 64 64 Dark
12 224 176 160 Rose
13 255 0 255 Fuchsia
14 0 255 255 Aqua
15 255 255 0 Yellow
8-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm String Configuration
GFK-1180 9-1
For example, the following alarm message has been configured for an analog point:
Temp Alarm - Temp: %STATE
Each set of alarm strings is identified by an index number that is specified when the
set is defined. Up to 99 sets, numbered 1 through 99, can be configured. When a
point is configured, an appropriate set of alarm strings may be selected for inclusion
in the alarm message.
The default configuration includes a set of alarm strings for Index number 1. This is
the default Alarm String Index that is used when you add a device point. This string
may be modified but should never be deleted.
9-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
The Configuration - Alarm String window always displays the following attribute for
each Alarm String Index:
Index The alarm string index number
In addition to Index, you can choose to display the following attributes:
Alarm High Msg The alarm string that will be displayed when a point using
this index is in the Alarm High state
Warning High Msg The alarm string that will be displayed when a point using
this index is in the Warning High state
Warning Low Msg The alarm string that will be displayed when a point using
this index is in the Warning Low state
Alarm Low Msg The alarm string that will be displayed when a point using
this index is in the Alarm Low state
The list of alarm strings is initially sorted by Index. You may click any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new alarm string.
• Change the window display attributes.
• Change startup options.
• Modify an alarm string.
• Copy the information for a selected alarm string to a new alarm string.
• Delete an alarm string.
• Display a filtered list of alarm strings
Alarm High
Enter the alarm string to be displayed when a point using this Alarm String is in the
Alarm High state. The string can contain up to 16 characters.
Warning High
Enter the alarm string to be displayed when a point using this Alarm String is in the
Warning High state. The string can contain up to 16 characters.
Warning Low
Enter the alarm string to be displayed when a point using this Alarm String is in the
Warning Low state. The string can contain up to 16 characters.
Alarm Low
Enter the alarm string to be displayed when a point using this Alarm String is in the
Alarm Low state. The string can contain up to 16 characters.
9-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Configuration
About Alarms
CIMPLICITY HMI software generates alarms for points that are in an alarm state. It
also generates alarm messages about system events, such as device failures, program
terminations, system startups, and system shutdowns.
To configure or modify alarms for Use Configure Alarm Definitions to configure alarm definitions for alarms generated
points, use the Configure Points
by custom software or to modify alarms for CIMPLICITY HMI system events or
function.
product options.
GFK-1180 10-1
Standard Alarms
A set of standard event alarms is included in your base configuration. These alarms
are:
$ALARM_DISABLED
Alarm is disabled for the specified point.
$ALARM_ENABLED
Alarm is enabled for the specified point
$ALARM_MODIFIED
Alarm is modified for the specified point.
$ALARM_RAWLIM
Alarm raw limits modified for the specified point.
$ALARM_RESTORED
Alarm limits restored for the specified point.
$AM_STATUS
Alarm Management status message used to analyze system performance. This
message is issued every half-hour and shows the number of alarms generated,
the count of alarms acknowledged, reset and deleted, and the average number
of seconds required to log an alarm.
$DEVICE
Alarm message for specified device.
$DEVICE_DOWN
Device failure message for specified device.
$DEVICE_FAILOVER
Reserved for future use.
$DL_FILE_FULL
Log file full message for specified log file.
$DOWNLOAD
Setpoint was downloaded to specified device.
$DYN_CFG
The specified entity has been changed dynamically
$GMR_DEV_DOWN
Device down message for Series 90 TCP/IP PLC redundancy.
$GMR_POINT_DISCREPANCY
Point discrepancy alarm for Series 90 TCP/IP PLC redundancy.
$LOGIN_FAILURE
Specified user failed to log in to the specified CIMPLICITY project.
10-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
$LOGON
Specified user has logged in to a specified CIMPLICITY project.
$LOGOUT
Specified user has logged out from a specified CIMPLICITY project.
$REDUND_DEV_DOWN
Alarm message for PLC redundancy.
$RTR_LINK_DOWN
Router link has been lost to specified node.
AMSI_ALARM
Reserved for future use.
DB_CONN_DOWN
Process has lost connection to specified logging database.
DB_START_FORWARD
Process is forwarding data to specified logging database.
MCP_PROC_DOWN
Specified CIMPLICITY process has terminated unexpectedly.
These alarms are not associated with any CIMPLICITY Point IDs. They may be
modified, but they should never be deleted.
The Configuration - Alarm Definitions window always displays the following for
each alarm:
Alarm ID The unique Alarm identifier for each alarm in your configuration.
In addition to Alarm ID, you can choose to display:
Class ID The Alarm Class in which this alarm will be grouped.
Alarm Type The type of alarm format used for this alarm. This field is display
only. An Alarm Type will be assigned by CIMPLICITY HMI
software to an alarm if it contains variable run-time parameters
(see page 10-1).
Description A description of the alarm.
Message Fixed text and run-time parameters that are displayed when the
alarm is generated.
You can control the amount of data presented, and the order in which it is presented.
Select Attributes... from the View menu, or click Attributes on the Toolbar to
open the Configure Display Attributes dialog box and make your changes.
10-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
The list of Alarm Definition list is initially sorted by Alarm ID. You may click on
any of the other title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new alarm.
• Change the window display attributes.
• Change startup options.
• Modify an alarm.
• Copy the information for a selected alarm to a new alarm.
• Delete an alarm.
• Display a filtered list of alarms
Enter the name of the new alarm in the Alarm ID field and select OK. The system
verifies that the Alarm ID does not already exist, and that no invalid characters have
been used.
If the Alarm ID you entered is valid, the Alarm Definition dialog box for the new
alarm opens. You will need to enter information on the following property pages:
Alarm Definition Defines what the alarm will look like.
Alarm Routing Defines what Roles will see the alarm.
Alarm Options Defines the Repeat, Acknowledge, Reset, and Delete
attributes for the alarm.
The Alarm Definition properties for a non-point alarm let you define the following
for an alarm:
Description Enter an optional description of the alarm.
Alarm Class Enter a valid Alarm Class ID in this field.
10-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Logging If Database Logging is installed on your computer, you can
set the Log Alarm check box to enable logging for this
alarm. If you enable logging, you can then select
Settings... to define the logging parameters for the alarm.
Clear this check box to disable logging for this alarm.
The Alarm Definition properties for point alarms let you define the following for an
alarm:
Definition
This input box lets you define the alarm class and message that will be used when
this point’s value goes into an alarm state.
Alarm Class An alarm’s class determines the order in which it appears
relative to other alarms in Alarm Viewer. Alarms with
similar characteristics can be grouped by class, and classes can
be prioritized.
Enter an Alarm Class in this field. You can also:
Alarm Criteria
You can select one of the following methods for evaluating the alarm values:
Absolute Absolute alarms are used to detect when the value of a point is
too high or too low.
On Change On Change alarms are used to detect when the value of a point
changes.
Rate of Change Rate of Change alarms are used to detect either a faster or
slower than expected change in the value of a point.
If you select Rate of Change, you must also enter a sampling
interval in the Interval fields.
The Interval fields represent the frequency at which the point
will be sampled for Rate of Change alarming. If the difference
between the current value of the point and the value at the last
sample time exceeds alarm limits, an alarm message will be
generated
10-8 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Deviation Deviation alarms are used to detect when the value of a point
deviates too far from that of a second point.
If you select Deviation, you must also enter a Point ID in the
Deviation Point field. You can also:
The Alarm Routing properties let you choose the roles to which this alarm will be
routed. All the currently available roles are listed in the Available Roles box. All
the roles currently configured for this alarm are listed in the Configured Roles for
Alarm box.
You can:
• Add a role to the alarm.
• Remove a role from the alarm.
• Change the properties of a selected role.
• Create a new role.
Adding A Role
To add a role to the Configured Roles for Alarms list:
1. Select the role in the Available Roles box.
2. Select Add.
10-10 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Removing A Role
To remove a role from the Configured Roles for Alarms list:
1. Select the role in the Configured Roles for Alarms list.
2. Select Remove.
Modifying A Role
To view (and possibly modify) the properties for a particular role:
1. Select the role.
2. Select Properties. The Role Properties dialog box for the selected
role opens.
The Alarm Options properties let you define the Repeat, Acknowledge, Delete, and
Reset requirements for the alarm.
• Use Repeat Timeout to control how often the alarm will be re-sent to
alarm printers.
• Use Acknowledge Timeout to control whether or not the alarm will
be automatically acknowledged.
• Use Deletion Requirements to determine when the alarm is deleted.
• Use Reset Timeout to control whether or not the alarm will be
automatically reset.
• Use Max Number Stacked to define the number of occurrences to
retain when this alarm is generated more than once before being
deleted. After the Max Number Stacked is reached, the oldest alarm
occurrence is deleted as each new occurrence is generated.
• Use Manual Reset Allowed to permit users to manually reset the
alarm. If you disallow Manual Reset, the alarm can only be reset by the
application detecting the alarm condition or by the Alarm Manager
when an Automatic Reset is defined.
10-12 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Repeat Timeout
If you have configured an Alarm Printer, use these fields to control how the message
for this alarm will be sent to the Alarm Printer:
Time Select this radio button to send the alarm message to all
interested processes at the interval you enter in the Minutes
input field until the alarm is cleared.
In particular, the Alarm Printer (AMLP) is an interested
process. Selecting this option will cause the alarm message to
be reprinted on the Alarm Line Printer at the selected interval
until the alarm is cleared.
Note
The actual number of minutes that the Alarm Manager will
wait before repeating the alarm may be greater than this
number. The maximum time will be the number you enter in
this field plus the number of minutes configured for the timer
for processing automatic alarms in the Alarm Manager
configuration file (alarm_mgr.dat). The default for this
timer is 5 minutes.
Immediate Select this radio button to send the alarm message to all
interested processes immediately when it is generated.
In particular, the Alarm Printer (AMLP) is an interested
process. Selecting this option will cause the alarm message to
be printed once when it is generated. The alarm message will
not be repeated.
Never Select this radio button if you do not want to send the alarm
message to any interested processes.
Deletion Requirements
The Deletion Requirements determine the conditions under which the alarm may be
deleted from the system. You can choose one or both of the following:
Acknowledge Set this check box to delete the alarm when it is
acknowledged.
Reset Set this check box to delete the alarm when it is reset.
If you set both check boxes, the alarm will not be deleted until it has been
acknowledged and reset.
Reset Timeout
Use these fields to control how the alarm will be reset.
Time Select this radio button and enter the number of minutes in the
Minutes input field for the Alarm Manager to wait before
automatically resetting the alarm.
The alarm may also be reset by the application detecting the
alarm condition or manually by a user (if manual reset is
allowed) before the time interval expires.
Note
The actual number of minutes that the Alarm Manager will
wait before automatically resetting the alarm may be greater
than this number. The maximum time will be the number you
enter in this field plus the number of minutes configured for
the timer for processing automatic alarms in the Alarm
Manager configuration file (alarm_mgr.dat). The default
for this timer is 5 minutes.
Immediate Select this radio button if you want the Alarm Manager to
automatically reset the alarm when it is generated.
Never Select this radio button if the alarm is never to be
automatically reset.
10-14 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Using Alarm Audio Support
GFK-1180 11-1
• If more than one project has the highest priority, then the order in which
the projects are displayed in the Alarm Sound Manager window
determines the project priority.
When you prioritize alarms by Project priority, the determination of the highest
priority alarm is:
• The sound for the alarm with highest priority Alarm Class in the highest
priority project is played first.
• If more than one project has the highest priority, then the order in which
the projects are displayed in the Alarm Sound Manager window
determines the project priority.
Examples
Suppose you have three projects, each with two Alarm Classes as follows:
Project Priority Alarm Class Priority Alarm Class Priority
PROJ1 3 ALM1A 1 ALM1B 2
PROJ2 2 ALM2A 1 ALM2B 2
PROJ3 1 ALM3A 1 ALM3B 2
In addition, you currently have one alarm generated for each class in each project.
If you prioritize audio alarms by Alarm Class, the alarm order is:
ALM3A, ALM2A, ALM1A, ALM3B, ALM2B, ALM1B
If you prioritize audio alarms by Project priority, the alarm order is:
ALM3A, ALM3B, ALM2A, ALM2B, ALM1A, ALM1B
11-2 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Configuring Alarm Audio Support
You configure Alarm Audio support in the Alarm Class configuration.
To configure Alarm Audio support for an Alarm Class:
1. Double-click the Alarm Class icon in your project’s Configuration
cabinet.
2. Select the Alarm Class for which you want to configure Alarm Audio
support from the list of Alarm Classes.
3. Open the Alarm Class Configuration dialog box for the Alarm Class.
4. Select the Audio property page.
Set the Audio support check box if you want audio support for the alarm class.
You can configure two types of sounds:
• Wave file
• Beep
You can now do one of the following:
• Select OK to save all changes made and close the Alarm Class
Configuration dialog box.
• Select Apply to save all changes made and leave the dialog box open.
• Select Cancel to close the Alarm Class dialog box without saving
changes.
Beep Configuration
To configure a beep for audio alarming:
1. Click the Beep radio button if you want to use a beep sound.
On computers with sound cards, this is the default sound event.
On computers without sound card, this is the default system beep.
2. Specify the following information for the beep sound:
For Windows NT, or if you are generating the beep through the sound
card on Windows 95:
• Enter the Frequency of the sound. Select a value between 37 and
32767 Hertz.
Remember, 1000 milliseconds equals 1 • Enter the Duration of the sound in milliseconds. Select a value
second.
between 1 and 10000 milliseconds.
For both Windows NT and Windows 95.
• Enter the Number of beeps to play when the alarm is generated.
Select a value between 1 and 10.
If you enter a value greater than 1, the Delay field is enabled.
• Use the Delay field to enter the delay between the beeps in
milliseconds. Select a value between 0 and 10000 milliseconds.
11-4 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
About Alarm Sound Manager
You can use the Alarm Sound Manager to connect to running HMI projects that are
broadcasting on your local network. The Alarm Sound Manager then plays sounds
and displays alarm information when alarms are generated by those projects for alarm
classes that have audio alarm support.
You must run the Alarm Sound Manager in order for the sounds to be played.
To run the Alarm Sound Manager, select or double click the Alarm Sound Manager
icon in the Windows Start Menu.
You can click on the icon to open the Alarm Sound Manager window.
They include:
• The current alarm being played
• The Mute check box
• The Load profile... and Save profile… buttons
• The Minimize, Exit, and Help buttons
You can use the Projects, Options, and Startup pages to select the projects whose
alarms you want to display, the priority of concurrent alarms, start the Alarm Sound
Manager at startup and select a default profile file.
11-6 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Projects Properties
The Projects page lets you add and remove broadcasting projects to the current
session.
While you are displaying this property page, you still have access to the alarm
information at the bottom of the window.
Adding a project
To add a project, click on the Add… button. The Add Project dialog box opens.
Use the drop-down list button to the right of the Project field to select a project to
add.
Select the project priority by specifying a number greater or equal to zero (0). The
higher the number, the lower the priority (which means that zero (0) is the highest
priority).
The project is placed in the list of projects according to its priority. If more than one
project has the same priority, then they are displayed in the order that they were
added to the list.
Deleting a project
To delete a project, select it and click on the Delete button.
11-8 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Option Properties
Startup Properties
The Startup page lets you configure the Alarm Sound Manager to start up at boot
time, and specify a default profile to use whenever the Alarm Sound Manager starts.
While you are displaying this property page, you still have access to the alarm
information at the bottom of the window.
To start the Alarm Sound Manager at boot, set the Start at Windows startup
check box.
To specify a profile file to be used by the Alarm Sound Manager when it starts, enter
the name of the file in the Use profile field. You can use the browser button to the
right of the input field to search for a profile file.
11-10 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Alarm Blocking Configuration
GFK-1180 12-1
Assigning Alarms
CIMPLICITY HMI software generates two types of alarms; point alarms and system
alarms. Each point alarm is uniquely identified by its Alarm ID. Each system alarm
is uniquely identified by its Alarm ID and Resource ID.
For example:
• For point XYZ, the unique Alarm ID is XYZ.
• Each unique instance of the $DEVICE_DOWN system alarm is
identified by the Alarm ID and the Resource ID of the affected device.
For Alarm Blocking, you can assign a uniquely identified alarm to only one group.
This means:
• You can assign a point alarm to only one blocking group.
• You can assign a uniquely identified system alarm to only one blocking
group.
This means that you can have more than one instance of a system alarm
in a blocking group or you may have system alarms in more than one
blocking group, provided that the Resource ID you assign to each
instance is unique across all Alarm Blocking groups.
12-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Blocking Rules
When an alarm that is assigned to an Alarm Blocking group is generated:
• If there is a current alarm with higher priority in the group, the newly
generated alarm is blocked.
• For Peer Blocking, if there is a current alarm with equal priority in the
group, the newly generated alarm is blocked. In other words, only one
alarm in a set of alarms with equal priority displays at any given time.
• For Non-Peer Blocking, all current alarms with equal priority display at
any given time.
When the blocking alarm returns to Normal state or is deleted:
• For Peer Blocking, if alarms of equal priority exist, the oldest one
displays and becomes the new blocking alarm.
• For Non-Peer Blocking, all alarms with the next lower priority display
and become the new blocking alarms.
If lower priority alarm is the current blocking alarm and a higher priority alarm is
generated, the lower priority alarm remains on the list of alarms and the higher
priority alarm becomes the new blocking alarm.
If an alarm already exists in Normal state and it returns to Alarm state, the alarm is
not blocked.
The Alarm Blocking Group - Configuration window always displays the following
attribute for each Alarm Class:
Group ID The identifier for the class
In addition to Group ID, you can choose to display:
Group Description Optional description of the group
Peer block Identifies whether Peer Blocking is enabled or
disabled.
The list of groups is initially sorted by Group ID. You may click any of the other
title buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new Alarm block group.
• Add alarms to the groups.
• Remove alarms from the groups.
• Modify alarm information in the groups.
• Change the window display attributes.
• Change startup options.
• Delete an alarm block group.
• Display a filtered list of alarm block groups.
12-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating an Alarm Block Group
To create a new Alarm block group, you can do one of the following:
• Select New from the File menu.
• Click New Item on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the Alarm Blocking dialog box opens.
You can resize the width of the Alarm ID, Priority and Resource ID fields to suit
your needs.
Enter the following information to create a new Alarm block group:
Group ID Enter a new, unique Alarm group name. The group
name can be up to 32 characters long.
Description Enter a description of the Alarm group. The
description can be up to 64 characters long.
Peer block Set this check box to enforce Peer Blocking Mode for
this group. Clear this check box if you want to use
Non-Peer Blocking Mode.
The Blocking Mode and alarm priorities determine the
alarm blocking hierarchy at run-time
Alarms This input box displays the current list of alarms in the
Alarm block group.
You can add an alarm to the list by directly entering its
Alarm ID, Priority and Resource ID or by using the
Add button to select an Alarm ID from the Browser
dialog box.
Adding an Alarm
You can enter the name of an Alarm ID in the Alarm ID field in any of the following
ways:
• You can select Add to open the Browser dialog box and browse for the
Alarm ID you want.
• You can click the Browser button to the right of the input field to open
the Browser dialog box and browse for the Alarm ID you want.
• You can click the Pop-up menu button to the right of the input field to
create a new Alarm ID, modify the current Alarm ID or browse for an
Alarm ID.
Enter the priority of the Alarm ID in the Priority field. This can be a number from 0
to 32767. The higher the number you enter, the higher the blocking priority for the
alarm. For example, if you have alarm XXX with priority set to 10 and alarm YYY
with priority set to 100 in the same group, when alarm YYY generates, it blocks
alarm XXX.
If the Alarm ID does not have a Point ID, you must assign a Resource ID to the
alarm. You can click the Browser button to the right of the input field to open the
Browser dialog box and browse for the Resource ID you want. You can also use the
Pop-up menu button to create a new Resource ID, modify the current Resource ID or
browse for a Resource ID. Remember that each Alarm ID/Resource ID combination
must be unique within a group and across all groups.
Removing an Alarm
To remove an alarm from an Alarm block group:
1. Select the alarm from the list.
2. Press Delete.
The list of alarms in the window updates immediately.
Modifying an Alarm
You can modify an alarm’s name, priority and Resource ID in the list. All you need
to do is:
1. Select the field you want to edit in the Alarms list.
2. Type in your changes.
12-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
If you are changing an Alarm ID or Resource ID, you can also use the Browser and
Pop-up Menu buttons in the field to search for a new one.
You can also set a number of alarms to the same priority and/or Resource ID at the
same time. To do this:
1. Select the alarms whose priority and/or Resource ID you want to set.
You can use the Shift and Ctrl keys while making your selection.
2. Select Set Attributes…. The Set Attributes dialog box opens
3. Enter the new priority and/or Resource ID for the alarms and select
OK. All the selected alarms will be assigned the new priority. Non-
point alarms will be assigned the new Resource ID.
Before you start, make sure that the printer is not configured in
Windows.
To configure an alarm printer, double-click the Alarm Printer icon in your project’s
Configuration cabinet.
If you have selected the Display search criteria at startup option, the Alarm
Log Printer Search dialog box opens. Select the filtering criteria you want, and then
select OK to open the Alarm Log Printer - Configuration window with the filtered
list of printers.
If you have not selected the Display search criteria at startup option, the Alarm
Log Printer - Configuration window opens with a list of all configured printers.
GFK-1180 13-1
The Alarm Log Printer - Configuration window always displays the following for
each printer:
Name The name of the alarm printer.
In addition to Name, you can choose to display:
Node ID The node to which the alarm printer is connected.
Destination The actual device or file name of the printer (like LPT1: or
amlp.fil).
Enter the name of the new alarm printer, or the name of the file you want to write
alarms to in the Name field and select OK. You may enter a maximum of 16
characters. The system verifies that the alarm printer name does not already exist,
and that no invalid characters have been used.
If the alarm printer name you entered is valid, the Alarm Printer properties dialog
box for the new alarm printer opens.
13-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Printer Properties
The Alarm Printer property sheet let you define the device, and the types of alarms
handled by it. You can configure local and network printers. You can also configure
redundant alarm printers if your project supports the Host Redundancy option.
When you are finished defining the alarm printer properties, select OK to close the
Alarm Printer property sheet and create the new alarm printer, or select Cancel to
close the property sheet without creating the new alarm printer.
General Properties
The AMLP Configuration property page let you define the following for a new alarm
printer:
Log Events
Select this check box if you want to log events to the printer.
Log Alarms
Select this check box if you want to log alarms to the printer.
If you clear this check box, the Alarm logging options are grayed out.
• Click the Browser button - - to the right of the input field to display
the Select Alarm Class browser and use it to select the Alarm Class.
• Click the Pop-up Menu button - - to create a new Alarm Class, edit
the current Alarm Class, or browse for an Alarm Class.
Output
Enter the device name for the alarm printer. You can:
• Enter the name of a local port on the project’s computer (for example -
LPT1 or COM1) where you have attached the alarm printer.
Note
If you are connecting to serial port COM10 and above, the format is \\.\COM<n>.
• Enter a file name to write alarms to a file. If you wish, you may also
enter a period followed by a three character file extension (for example,
alarms.fil).
If you do not enter a file extension, none is automatically provided.
The file is placed in the project’s \log directory.
13-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
• Enter the path for a network printer (for example,
\\M_005ad4\d5prn1).
Note
If the printer is connected locally on your computer, use the local port name instead
of the network path.
Layout Properties
The Layout property page lets you determine whether a header should be printed at
the top of a page. Enter information in the following fields:
Print Headers
Set this check box if you want to print a header at the top of each page.
If you have more than one alarm printer process sending messages to the same printer
or file, clear this check box. When you clear the check box, the Page length field
is disabled.
Page Width
Enter the number of characters that can be printed on a line. The number must be an
integer between 80 and 132.
Date/Time Format
Use the Date/Time Format properties to choose how the alarm printer will print the
date and time.
You can define the following:
Header Date
Select the format you want to use to print the date on the alarm printer page header.
This field is not available if you are not printing a page header. A sample for the
format you choose displays in the Sample field in this box. You may select one of
the formats from the list, or construct your own format.
13-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Date/Time
Select the format you want to use to print the date and time of each alarm. A sample
for the format you choose displays in the Sample field in this box. You may select
one of the formats from the list, or construct your own format.
• If you enter LPT1 in the Output field and select the Redundant
alarm printing check box, the Master project on COMP1 sends alarm
messages to LPT1 on COMP1 and the Slave project on COMP2 sends
alarm messages that it generates while in standby mode to LPT1 on
COMP2.
When the project on COMP2 becomes the Master project, it continues
to send alarm printer messages to LPT1 on COMP2.
• If you enter LPT1 in the Output field and clear the Redundant
alarm printing check box, the Master project on COMP1 sends
alarms to LPT1 on COMP1. The Slave project on COMP2 sends no
alarms until it becomes the Master project.
When the project on COMP2 becomes the Master project, it sends
alarm messages to LPT1 on COMP2.
Now, let’s look at a redundant configuration with a network line printer
(\\ABC\NET1). The primary computer is COMP1 and the secondary computer is
COMP2.
13-8 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
• If you enter \\ABC\NET1 in the Output field and clear the
Redundant alarm printing check box, the Master project on
COMP1 sends alarms to the network device. The Slave project on
COMP2 sends no alarms until it becomes the Master project.
When the project on COMP2 becomes the Master project, it sends
alarm messages to \\ABC\NET1.
13-10 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Role Configuration
About Roles
In CIMPLICITY HMI software, a role is the mechanism for granting users access to
privileged functions. Each user is assigned one role. Conversely, one role may be
assigned to several users.
The default configuration includes the following three roles:
• SYSMGR
• USER
• OPER
For each role defined in CIMPLICITY HMI project, you can specify whether users
assigned that role can:
• Perform Setpoints from CimView screens that contain Setpoint
actions.
• Enable dynamic configuration.
• Delete alarms from Alarm Viewer windows.
• Access the CPC (CIMPLICITY Process Control) utility.
• Modify alarm setups on Alarm Viewer windows.
• Generate a Setpoint audit trail.
• Use Point by Address points in CimView screens.
• Trigger events in the Basic Control Engine user interface.
• Stop, pause or resume scripts in the Basic Control Engine user
interface.
GFK-1180 14-1
Configuring Roles
To configure a role, double-click the Roles icon in your project’s Configuration
cabinet.
If you have selected the Display search criteria at startup option, the Role
Search dialog box opens. Select the filtering criteria you want, and then select OK
to open the Configuration - Role window with the filtered list of roles.
If you have not selected the Display search criteria at startup option, the
Configuration - Role window opens with a list of all configured roles.
The Configuration - Role window always displays the following attribute for each
role:
Role ID A name that uniquely identifies each role.
The list of Roles is sorted by Role ID. You may click on the title button to sort the
list.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new role.
• Change the window display attributes.
• Change startup options.
• Modify a role.
• Copy the information for a selected role to a new role.
• Delete a role.
• Display a filtered list of roles
14-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating A New Role
To create a new role, you can do one of the following:
• Select New from the File menu.
• Click New Item on the Toolbar.
• Press Ctrl+N.
After you initiate the request, the New Role dialog box opens.
Enter the name of the new role in the Role ID field and select OK. The system
verifies that the Role ID does not already exist, and that no invalid characters have
been used.
If the Role ID you entered is valid, the Role Properties dialog box for the new role
will be displayed. You will need to enter information in the following categories:
Privileges Defines the privileges for the role.
When you are finished defining the role’s properties, select OK to close the dialog
box and create the new role, or select Cancel to close the dialog box without
creating the new role.
Role Properties
The Privileges properties let you define the privileges for a new role.
Alarms Privileges
Delete Alarms If you select this check box, users assigned this role
can delete alarms from the Alarm Viewer.
Modify Alarm Setups If you select this check box, users assigned this role
can modify alarm setups in Alarm Viewer.
Points Privileges
Set Point If you select this check box, users assigned this role
can perform setpoints from CimView screens that
contain Setpoint actions.
Setpoint Audit Trail If you select this check box, a $DOWNLOAD event
will be recorded in the Event Log for each setpoint
that is generated by users assigned this role.
Point by Address If you select this check box, users assigned this role
can create points and expressions in CimEdit that
use Point by Address points.
14-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
User Configuration
About Users
The Users function lets you configure users for your CIMPLICITY HMI project. A
user is an individual person working with a CIMPLICITY HMI project. Each
CIMPLICITY HMI user has the following attributes:
Security A user may be assigned a Password. If a Password is configured
and enabled, then a user cannot access CIMPLICITY HMI project
functions without entering both the User ID and Password.
Roles and A user is assigned a role. Each role in your CIMPLICITY HMI
Privileges project has certain privileges assigned to it. The privileges define
the functions the user can access. If a user lacks the privilege to
access a secure function, an error message is displayed and access is
denied.
View of A user’s view determines the resource data to which the user has
Resources access. Alarms for resources outside a user’s view will not appear
on the user’s Alarm Viewer window.
The default configuration includes:
• ADMINISTRATOR (role: SYSMGR)
The default user does not require a password to access CIMPLICITY HMI project
functions.
Configuring Users
To configure a user, double-click the Users icon in your project’s Configuration
cabinet.
If you have selected the Display search criteria at startup option, the User
Search dialog box opens. Select the filtering criteria you want, and then select OK
to open the Configuration - User window with the filtered list of alarms.
If you have not selected the Display search criteria at startup option, the
Configuration - User window opens with a list of all configured alarms.
GFK-1180 15-1
The Configuration - User window always displays the following attribute for each
user:
User ID A name that uniquely identifies each user.
In addition to User ID, you can choose to display the following attributes for each
user:
Enabled Indicates if the account is enabled or disabled.
Password If a password is defined, it is displayed in this field.
Role ID The role assigned to the user. This determines the privileges
assigned to the user.
User Name The user’s name.
The list of Users is initially sorted by User ID. You may click on any of the other
attribute buttons at the top of the list to sort the list by that attribute.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new user.
• Change the window display attributes.
• Change startup options.
• Modify a user.
• Copy the information for a selected user to a new user.
• Delete a user.
• Display a filtered list of users
15-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Setting Run-Time User Properties
The run-time user properties let you specify how many failed login attempts can
occur before CIMPLICITY HMI software automatically disables the account.
Note
Automatic account disabling is not support on Servers using Server Redundancy.
To access the run-time user properties, you can do one of the following:
• Click the Users icon in your project’s Configuration cabinet, hold down
the right mouse key and then select Setup from the drop-down menu.
• Select Setup from the Edit menu in the Configuration - User window.
• Press Ctrl+O in the Configuration - User window.
The User Setup dialog box opens.
Enter the name of the new user in the User ID field and select OK. The system
verifies that the User ID does not already exist, and that no invalid characters have
been used.
If the User ID you entered is valid, the User Properties dialog box for the new user
opens. You will need to enter information in the following categories:
General Defines the password and role for the user.
Resources Defines the resources for which the user can view data.
When you are finished defining the user’s properties, select OK to close the dialog
box and create the new user, or select Cancel to close the dialog box without
creating the new user.
15-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
User General Properties
The General properties let you define the following for a new user.
Note
If you change a user’s configuration dynamically, the user must log out then log back
in for the changes to take effect.
Role
Enter the user’s role in this field.
You can click the Browser button - - to the right of the input field to display the
Select A Role Browser and use it to select the role.
You can also use the Pop-up Menu button - - to create a new role, edit the current
role, or Browser for another role.
Password Needed
Set this check box to require the user to enter a password at login. Clear this check
box if the user does not need to enter a password.
User Name
Enter the user’s name or descriptive text about the user.
Enabled
Set this check box to enable the user account.
If you clear this check box, the account is disabled and is not available for user login.
If you disable an account dynamically, currently logged in users will not be logged
out; however, new login attempts will be rejected.
Password Expires
Enter the number of days until the user’s password expires or enter zero if the
password never expires.
After the elapsed number of days, the user will be required to change the password
prior to logging in.
In s Server Redundancy configuration, Automatic Password Expiration is not
supported.
15-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
User Resource Properties
The Resources properties let you define the resources for which the user can view
alarms. The resources currently assigned to the user are displayed in the
Resources box. You can add or delete resources.
Note
If you change a user’s resources dynamically, the user must log out then log back in
to access the changed resources.
15-8 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Database Logger
GFK-1180 16-1
Alarm Logging
Alarm Logging lets you log alarm information in the Alarm Log table. You can
specify alarms to be logged as they are generated, cleared, acknowledged, and/or
deleted.
The following system alarms are recorded in the Alarm Log table:
Alarm ID Description
$DEVICE Specified device has a problem.
$DEVICE_DOWN Specified device has failed.
$DEVICE_FAILOVER Device failover for Server Redundancy.
$GMR_DEV_DOWN Specified Series 90 TCP/IP redundant
device is down.
$GMR_POINT_DISCREPANCY Specified Series 90 TCP/IP redundant point
has discrepancy.
$REDUND_DEV_DOWN Redundant device down for Server
Redundancy.
AMSI_ALARM Reserved for future use.
DB_CONN_DOWN Connection lost to specified database for
Database Logger.
DB_START_FORWARD Forwarding files found for Database Logger
Store and Forward.
MCP_PROC_DOWN Specified CIMPLICITY process has
terminated unexpectedly.
Event Logging
Event Logging lets you log system and user-defined events in the Event Log table.
The following system events are recorded in the Event Log table:
Event ID Description
$ALARM_DISABLED Alarming for specified point is disabled.
$ALARM_ENABLED Alarming for specified point is enabled.
$ALARM_MODIFIED Alarm limits for specified point modified by user.
$ALARM_RESTORED Alarm limits for specified point restored to original
values.
$AM_STATUS Alarm Management throughput statistics. Issued
every half-hour.
$DL_FILE_FULL Reserved for future use.
$DOWNLOAD Setpoint was downloaded to a specified point.
$DYN_CFG Dynamic configuration enable/disable has been
performed by a specified user.
$LOGIN_DISABLED Specified use failed to log in to the specified
CIMPLICITY HMI project.
16-2 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
$LOGON Specified user has logged in to a specified
CIMPLICITY HMI project.
$LOGOUT Specified user has logged out of a specified
CIMPLICITY HMI project.
$RTR_LINK_DOWN Router link has been lost to specified node.
DEMO_SPEED Carwash Demo speed alarm is generated.
Data Logging
Data logging lets you log point data in a variety of ways.
You can log points:
• At a specified time of day.
• Periodically at a specified time interval.
• Periodically at a specified time interval while a digital point is HIGH or
LOW.
• When the alarm state on the point changes.
• Whenever the point’s value is updated.
Whenever point data is logged, the entry in the log file includes the Point ID, a
timestamp, and other optional attributes that you select.
Group Logging
Group logging lets you log information on a group of points in parallel. This method
gives better performance and uses disk space more efficiently than Data logging.
Each entry in a Group log table contains a timestamp and the information you select
for each point.
Group data can be logged as follows:
• At a specified time of day.
• Periodically at a specified time interval.
• Periodically at a specified time interval while a digital point is HIGH or
LOW.
• In response to an event.
• When the alarm state on a point changes.
• Whenever a point’s value is updated.
Application Logging
Certain CIMPLICITY HMI applications, such as the Basic Control Engine, allow
you to log actions. To take advantage this feature, you must configure an
Application Table for the product option.
The application chooses what data to log and when to log it.
16-4 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Table Characteristics
The Database Logger tables have the following characteristics:
Column Definitions
A table can have, at most, 250 columns. The following columns are defined for each
type of log file:
• Data logging tables contain a timestamp and Point ID column, plus an
additional column for each table and point attribute you have selected.
The number of columns is independent of the number of points in the
table. For example, if you have a table that logs the point value and
previous value for all points configured for data logging, the table will
have four columns.
• Alarm, Event, and Application logging tables have columns that are
specific to that table, plus an additional column for each table attribute
you have selected. All table rows include a timestamp column and an
autoincrement sequence number that ensures that each row is unique.
• Group logging tables contain a timestamp column, plus an additional
column for each table and point attribute you have selected. For
example, if you have a table logging the value and alarm state of five
points, the table will have eleven columns.
Points with Engineering Units The number of columns you can actually have in a group table depends
conversion are stored in floating point
on the type of data you are storing. A record being added to the
format
database can have at most 2 KB of data. With overhead, 2 KB amounts
to approximately 222 8-byte floating-point numbers.
If you are storing a number of floating-point numbers or long text
strings in a group record, it is recommended that you verify that the 2
KB limit is not being exceeded.
16-6 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Entering from Point Configuration
When you are configuring a point, you can choose to log point data and/or alarm data
for that point.
• When you select Log Data, the point is automatically added to the
DATA_LOG table with the default point Logging Conditions for that
table. You can customize your point logging by selecting Settings....
The Point Logging dialog box opens.
• When you select Log Alarm, the point’s alarm is automatically added
to the ALARM_LOG table with the default alarm Logging Conditions
for that table. You can customize your alarm logging by selecting
Settings.... The Alarm Logging dialog box opens.
Point Logging
When you select Settings... for Log Data, the Point Logging dialog box opens
This dialog box lists the tables where the point you selected is currently being
logged. If the list is empty, the point is not being logged in any table.
Use this dialog box to add the point to logging tables, modify logging tables, or
remove the point from one or more logging tables.
16-8 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Logging
When you select Settings... for Log Alarm, the Alarm Logging dialog box opens
The Alarm Logging dialog box shows you the table the point alarm is being currently
logged to along with the states that are being logged.
If the alarm is not currently being logged, the default setting is ALARM_LOG and
the default ALARM_LOG point properties are selected.
If the alarm is currently being logged, the initial settings will indicate which table is
being used, and which states are being logged.
You can log an alarm to the ALARM_LOG table or to the EVENT_LOG table. An
alarm can only be logged to one of these tables, not both. If, for example, an alarm is
currently being logged to the EVENT_LOG table, and you select the ALARM_LOG
table in this dialog box, the alarm is automatically removed from the EVENT_LOG
table when you select OK.
Logging an Alarm
To log an alarm:
1. Select the ALARM_LOG table or the EVENT_LOG table.
2. If you have selected the ALARM_LOG table, select the alarm events to
log. You may choose any combination of events.
3. Select OK to confirm your changes and close the dialog box, or select
Cancel to cancel your proposed changes and close the dialog box.
Use the Table Browser dialog box to select a table to display a filtered list of logging
tables, add a point to one or more tables, create a new logging table, or modify the
properties of an existing table.
You can set the Auto Browse check box to have the current list of tables displayed
automatically when you open the browser.
16-10 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating A New Table
To create a new logging table:
1. Select New Table....
2. The New Table dialog box opens. Make your modifications, and then
select OK to return to the Table Browser dialog box.
3. When the Table Browser dialog box redisplays, the new table has been
created and appears in the table list. Note that the Cancel button has
changed to a Close button to indicate that you cannot undo the creation
of the table.
The CIMPLICITY Database Logger Configuration window displays a list of all the
currently configured group and data tables, as well as the Alarm Log and Event Log
tables. The icon to the left of each table indicates its type as follows:
Alarm Log table or Event Log table
Data Log table
Group Log table
Application table
You can use the Menu functions, Toolbar buttons and shortcut keys to:
• Add a new Group or Data table.
• Copy the information for a selected table to a new table.
• Delete a table.
• Modify a table’s properties.
• Open a table.
• Add points to a table.
• Modify logging properties.
• Display a filtered list of tables.
16-12 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Database Logger Window Menu Options
You can use the menu options to create new tables, modify, copy or delete tables,
toggle the Toolbar and Status Bar display, filter the table list, change logging
properties, and access Help.
16-14 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Delete Deletes the selected table
Copy... Copies the selected table to a new table.
Properties... Opens the Table Properties dialog for the selected
table.
Add Alarms... Opens the Select A Point or Select a Alarm Definition
Add Points... dialog box and lets you select points for the table.
Logging Properties... Opens the Logging Properties dialog box.
16-16 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Table Properties
Five properties can be associated with the property dialog box for a table. They are
Logging Conditions, Logging Attributes, Maintenance Events, Maintenance Actions
and Logging Properties.
• Logging Conditions determine when data will be put into the log table.
• Logging Attributes determine what data will be logged in the table.
You can specify point attributes, table attributes, and array attributes.
• Maintenance Events define when export, purge, and command actions
will be performed on the table.
• Maintenance Actions define the type of actions that take place when a
Maintenance Event occurs.
• Logging Properties define the database connection and the Store and
Forward properties for the table.
The number of properties, and the information on them depends on the type of table
you are looking at.
• For the ALARM_LOG table, you can modify Default Logging
Conditions, Logging Attributes, Maintenance Events, Maintenance
Actions and Logging Properties.
• For the EVENT_LOG table, you can modify Logging Attributes,
Maintenance Events Maintenance Actions and Logging Properties.
• For a data table, you can define or modify default Logging Conditions,
Logging Attributes, Maintenance Events, Maintenance Actions and
Logging Properties.
• For a group table, you can define or modify Logging Conditions,
Logging Attributes, Maintenance Events, Maintenance Actions and
Logging Properties.
• For an application table, you can modify Logging Attributes,
Maintenance Events, Maintenance Actions and Logging Properties.
To display a particular property page, move the cursor to its name tab in the Table
Properties dialog box and click the left mouse button. Before that page is displayed,
any changes that you have made on the current property page are validated. If any
problems are found during validation, you must correct them before the next property
page is displayed.
When you select OK, information on all the properties in the dialog box are applied
to the table.
When you select Cancel, none of the information on any of the properties is applied
to the table.
The Default Logging Conditions property page for the ALARM_LOG table displays
the current default logging criteria for alarms being logged into the table. These
criteria are:
Generate Information about the alarm is logged when the alarm occurs.
Acknowledge Information about the alarm is logged when the alarm is
acknowledged by the operator or the system.
Reset Information about the alarm is logged when the alarm is reset
by the operator or the system.
Delete Information about the alarm is logged when the alarm is
manually deleted from the system.
16-18 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Logging Conditions for Group and Data Tables
The Logging Conditions property page for a group or data table displays the current
logging conditions for the table. You can have logging to the table occur under any
combination of the following:
• Data triggered logging
• Alarm triggered logging
• Timed/gated logging
Select Use Defaults to reset the Logging Conditions to their default values. The
default is to log data periodically every 5 minutes.
The Point and Point Alarm fields have a Browser button and a Pop-up Menu
button.
• Use the Browser button - - to open the Select A Point Browser and
search for a Point ID.
Combining Triggers
You can combine triggers. When you combine triggers, logging occurs when either
of the triggers occurs. For example, if you want to log a set of points when
POINT_A is updated or when POINT_B is in Alarm High state:
1. Set the On point value update check box.
2. Enter POINT_A in the Point field.
3. Set the On point alarm state check box.
4. Set the Alarm High check box.
5. Enter POINT_B in the Point field.
16-20 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Table Timed/Gated Logging
Timers and gates determine the logging interval. You can choose one or more of the
following events:
Periodic Set this check box when you want to log data into the
table at regular intervals.
Enter the time value in the input field, and select the
time interval.
Valid intervals are DAYS, HOURS, MINUTES,
SECONDS, or TICKS (100 ticks = 1 second).
Synchronized Set this check box when you want to log data at a
particular time of day.
Enter the time in the input field, and select AM or
PM.
On digital point state Set this check box if you want to log data while a
digital point is in a certain state.
Select the state to check for and enter the digital
Point ID in the input field. Valid states are HIGH,
LOW, and TRANSITION
You can combine timed events. For example, if you want to log a set of points every
hour on the half-hour, do the following:
1. Set the Periodic check box, and enter 1 HOUR in the data fields.
2. Set the Synchronized check box and enter 12:30 AM in the data
fields.
If you select a TRANSITION point state, together with a periodic or synchronized
time, the gate will be ignored.
If you select or unselect the project name table attribute you must drop
the table so that it is properly recreated with or without the new project
field as part of the primary key. Failing to do so can cause the database
logger to fail to log data into the table.
16-22 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Logging Attributes for Group and Data Tables
The Logging Attributes property page for a group or data table displays the current
point attributes that will be logged to the table. You can define the following
attributes to be logged:
• Point attributes
• Table Attributes
Select Use Defaults to reset the Logging Attributes to their default values. The
default is to log Point Value and the Project Name.
If you select or unselect the project name table attribute you must drop
the table so that it is properly recreated with or without the new project
field as part of the primary key. Failing to do so can cause the database
logger to fail to log data into the table.
The Maintenance Events property page for a table displays the current maintenance
events for the table. Maintenance actions will occur when any of the events that you
configure on this property sheet occur. You can select:
• Triggered maintenance
• Timed/gated maintenance
Select Use Defaults to reset the Maintenance Events to their default values. The
default is to perform maintenance actions every day at midnight.
The Point field has a Browser button and a Pop-up Menu button.
• Use the Browser button - - to open the Select A Point Browser and
search for a Point ID.
16-24 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Triggered Maintenance Events
You can select either of the following triggered maintenance events:
Disk space low Maintenance actions will be executed when disk space falls
below the specified threshold.
The disk is checked for this condition at an interval you
specify in the Logging Properties dialog box.
Logging count Maintenance actions will be executed when the number of
records logged to the table reaches a multiple of this number.
The Maintenance Actions property page for a table displays the current maintenance
actions for a table. Every maintenance action for a table will be performed whenever
any of its maintenance events occurs. You can select:
• Export actions
• Purge actions
• Command actions
Select Use Defaults to reset the Maintenance Actions to their default values. The
default maintenance action is to purge all records except for those entered in the table
for the last day.
Export Actions
Export actions let you export data from the table to a CSV (Comma Separated Value)
format file when a maintenance event occurs.
To select this option:
1. Set the Export records check box.
2. Select the type of export you want to perform.
You can choose to export one of the following:
All All records in the table are exported.
By Count The last (most current) <n> records in the table are
exported.
By Time Data entered in the table for the last <n> days, hours, or
minutes is exported.
16-26 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Purge Actions
Purge actions let you delete data from the table when a maintenance event occurs.
To select this option:
1. Set the Delete records check box.
2. Select the number of records you want to retain in the table.
You can retain records in one of the following ways:
By Count Delete all but the last (most recent) <n> records in the
table.
By Time Delete all but the records entered in the table for the
last <n> days, hours, or minutes.
3. If you want to save the data to be purged from the table to a CSV
format file before removing it from the table, then set the Save
deleted in file check box and enter the name of the CSV file.
Command Actions
Command actions let you perform more complicated actions when maintenance
events occur. You can select one or both of these actions:
Execute SQL command Lets you execute a SQL command on the table.
Enter the command in the input field.
Run program Lets you run a program. Enter the program
pathname in the input field. You may include
command-line arguments for the program.
Compact database Use this action to compact the Microsoft Access
database where the table resides during a
maintenance event.
The Logging Properties property page for a table displays the current database
connection and the parameters used by Store and Forward for the table.
Connect Information
You can select an ODBC data source for each table that you create in the Database
Logger. To connect to a table, enter the following information:
ODBC data source Select the data source to receive logged data for this
table. This field displays the list of currently
configured ODBC data sources. In general, it will
consist of a list of one or more Microsoft Access or
SQL Servers.
The default data sources are:
• CIMPLICITY Alarm Logging
A Microsoft Access data source that logs data
to the CIMPLOG.MDB file in the ARC
directory of your CIMPLICITY HMI project.
• CIMPLICITY Point Logging
A Microsoft Access data source that logs data
to the POINTLOG.MDB file in the ARC
directory of your CIMPLICITY HMI project.
• CIMPLICITY SQL Server Logging
A Microsoft SQL Server data source that logs
data to an on-node SQL Server database. You
must install SQL Server (sold separately) to use
this data source.
16-28 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
If you have an Oracle database, you may the see
ODBC data source that you created for Oracle.
Database user Enter the username needed to connect to the
selected database driver. This field is required if
you are connecting to a SQL Server.
Password Enter the password needed to connect to the selected
database driver. This field is required if you are
connecting to a SQL Server.
Reconnect wait period Enter the amount of time the Database Logger waits
between reconnect attempts when the connection to
the database is lost. The default is 30 seconds.
Enter a value between 0 (continuous retries) and 24
hours.
Use this dialog box to filter the list of logging tables by Table Identifier and/or Table
Type.
To filter the table list:
1. Enter a full or partial Table ID in the Table Identifier input field. You
can use the ? and * wildcards to perform partial string searches.
2. Select the Table Type you want to filter for. Valid selections are
ALARM, ALL, DATA, EXTERNAL, or GROUP.
3. Select OK to filter the list according to the information you’ve entered,
or select Cancel to cancel the filter function.
To display all the tables, put an asterisk (*) in the Table Identifier field, and select
ALL for the Table Type.
Copying a Table
Important
You cannot copy the Alarm (ALARM_LOG), Event (EVENT_LOG) or
External tables.
To copy the attributes, actions, and contents of a selected group or data table to a
new table, select the table you want to copy, then do one of the following:
• Select Copy... from the File menu.
• Select Copy... from the window pop-up menu.
• Click the Copy button on the Toolbar
• Press Ctrl+C
The Copy dialog box opens.
16-30 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Enter the new table name in the input field. You must enter a new name. The Data
Logger will not let you use a current table name for a new table.
Select OK to create the table, or select Cancel to cancel the copy function.
Renaming A Table
To rename a data or group table, select the table, and then do one of the following:
• Select Rename... from the File menu.
• Select Rename... from the window pop-up menu.
• Press Ctrl+R.
The Rename table dialog box opens
Enter the new table name in the input field. You must enter a new name. The
Database Logger will not let you use a current table name when you rename a table.
Select OK to create the table, or select Cancel to cancel the rename function.
Note
You cannot rename the Alarm (ALARM_LOG), Event (EVENT_LOG) or External
tables.
Deleting A Table
To delete a group, data or external table, select the table, and then do one of the
following:
• Select Delete Table from the File menu.
• Select Delete... from the window pop-up menu.
• Click the Delete Table button on the Toolbar.
A confirmation message dialog box for the table opens.
Select OK in the confirmation message box to verify that you want the table
removed, or select Cancel to cancel your request. The table list updates after the
confirmation message box closes.
Note
You cannot delete the Alarm (ALARM_LOG) or Event (EVENT_LOG) tables.
The dialog box lists all the fields in the table configuration, and any fields in the table
in the database that are not in the configuration. Each field has one of the following
icons:
Field is in the Database Logger configuration and database table
Field is in the Database Logger configuration and database table, but
types don’t match
Field is in the database table, but not in the Database Logger table
configuration (unused).
Field is in the Database Logger configuration, but not in the database
table (uncreated).
Field has been removed from the Database Logger configuration and
the database table.
You can use this dialog box to remove unused fields from the database table or create
fields in the database table for new fields in the configuration.
Important
You can use this dialog box to remove fields from Microsoft Access
databases. Fields in SQL Server and Oracle databases must be
removed manually.
16-32 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating Uncreated Database Fields
To create fields in the database for new fields in the configuration:
1. Select the fields you want to create.
After the fields are created in the database, their icons change to:
After the unused fields are removed from the database, their icons change to:
Parameters
16-34 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
The Parameters page displays the current disk scan rate, data table queue size, data
logging scan rate, and maintenance action export path. When you open the ODBC
Configuration page, or select OK to close the property sheet, information on the page
will be validated. You can define the following parameters:
• Disk full scan rate
• Database queue size
• Point data logging scan rate
• Maintenance action export path
The Alarm Logging page shows the ODBC configuration that will be used when
logging data to the ALARM_LOG, EVENT_LOG and Application tables. The Point
Logging page shows the ODBC configuration that will be used when logging data to
Data and Group tables.
You can define the following parameters:
• Connect information, including ODBC Data Source, Database User,
Password, and Reconnect Wait Period.
• Store and forward information, including Enable Store and Forward and
the maximum number of stored records.
16-36 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
If additional information is required to connect to the database you selected, you will
be prompted for it during validation. Validation occurs when you select OK, or
select the Parameters page. Information needed varies from database to database. In
general:
• If you are connecting to a Microsoft Access database, you may be
prompted for a file name.
• If you are connecting to a SQL Server, you may be prompted for a
database name.
• If you are connecting to an Oracle database, you may be prompted for a
Server ID. Enter the Alias Name for the Oracle database in this field.
If the Data Logger is unable to connect to the selected database, validation fails.
Connect Information
Enter information in the following fields:
ODBC Data Source Select the data source to receive logged data. This
field displays a current list of ODBC data sources.
In general, it consists of a list of one or more
Microsoft Access or SQL Servers. The default data
sources are:
• CIMPLICITY Alarm Logging
A Microsoft Access data source that logs data
to the CIMPLOG.MDB file in the ARC
directory of your CIMPLICITY installation.
• CIMPLICITY Point Logging
A Microsoft Access data source that logs data
to the POINTLOG.MDB file in the ARC
directory of your CIMPLICITY installation.
Note
The CIMPLOG.MDB and POINTLOG.MDB files
are compatible with Microsoft Access version 7.0.
16-38 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Displaying A Table
To display the contents of a table, you can double-click on the table name in the
CIMPLICITY Database Logger Configuration window.
Alternatively, you can select the table in the CIMPLICITY Database Logger
Configuration window then:
• Select Open Table... from the File menu.
• Click the Open Table button on the Toolbar.
• Press Ctrl+O.
The CIMPLICITY Database Logger Configuration window for the selected table
opens.
You can use the Menu functions, Toolbar buttons and shortcut keys to:
• Add new points to the table.
• Delete points from the table.
• Display and modify point or alarm logging properties.
• Display and modify table properties.
• Display a filtered list of points.
• Close the table and return to the main Data Logging window.
16-40 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
The View Menu
When you select the View menu, the following drop-down list displays:
The Logging Attributes property page for a point in a group table displays the current
attributes assigned to the point. You can have point logging occur under any
combination of the following:
• Point Attributes
• Array Attributes (array points only)
Select Use Defaults to reset the Logging Attributes to their default values. The
default is to log point values.
The Logging Conditions property page for a point displays the current logging
conditions for that point. You can have point logging occur under any combination
of the following:
• Data triggered logging
• Alarm triggered logging
• Timed/gated logging
Note
If device point is configured as OnScan, point value is updated on every scan even
though its value remains unchanged.
16-44 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Select Use Defaults to reset the Logging Conditions to their default values. The
default is to log data periodically every 5 minutes.
The Point and Point Alarm fields have a Browser button and a Pop-up Menu
button.
• Use the Browser button - - to open the Select A Point Browser and
search for a Point ID.
Combining Triggers
You can combine triggers. When you combine triggers, logging occurs when either
of the triggers occurs. For example, if you want to log a set of points when
POINT_A updates or while POINT_B is in Alarm High state, do the following:
1. Set the On point value update check box.
2. Enter POINT_A in the Point field.
3. Set the On point alarm state check box.
4. Set the Alarm High check box
5. Enter POINT_B in the Point field.
16-46 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Log Table Point Properties
The Logging Conditions property sheet for an alarm in the ALARM_LOG table
displays the current default logging criteria for that alarm. These criteria are:
Generate Information about the alarm is logged when the alarm occurs.
Acknowledge Information about the alarm is logged when the alarm is
acknowledged by the operator or the system.
Reset Information about the alarm is logged when the alarm is reset
by the operator or the system.
Delete Information about the alarm is logged when the alarm is deleted
from the system.
The Filter Points dialog box lets you filter the list of points in a data or group table
by Point ID and/or Point Type.
To filter the point list:
1. Enter a full or partial Point ID in the Point Identifier input field. You
can use the ? and * wildcards to perform partial string searches.
2. Select the Point Type you want to filter for. Valid selections are ALL,
ANALOG, APPL, DIGITAL, or TEXT.
3. Select OK to filter the list according to the information you’ve entered.
Select Cancel to cancel the filter function.
To display all the points in the table, put an asterisk (*) in the Point Identifier field,
and select ALL for the Point Type.
The Filter Alarms dialog box lets you filter the list of alarms in the alarm or event
table by Alarm ID.
To filter the alarm list:
1. Enter a full or partial Alarm ID in the Alarm Identifier input field. You
can use the ? and * wildcards to perform partial string searches.
2. Select OK to filter the list according to the information you’ve entered.
Select Cancel to cancel the filter function.
To display all the alarms in the table, put an asterisk (*) in the Alarm Identifier
field.
16-48 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Reporting
Because the CIMPLICITY HMI Database Logger option writes to ODBC-compliant
databases, you may use database-specific reporting mechanisms to generate custom
reports for your site. Both the Microsoft Access and SQL Server databases provide
methods for reporting which you may find useful. Alternately, you may use any
ODBC-compliant application to generate reports.
Three sample reports are provided with the CIMPLICITY HMI Database Logger
product option. These reports are written in Microsoft Excel version 5.0 format, and
are stored in the report subdirectory of your CIMPLICITY HMI distribution
directory. The report files are:
SQLALARM.XLS A report for use with CIMPLICITY HMI Alarm tables.
SQLDATA.XLS A report for use with CIMPLICITY HMI Data tables.
SQLGROUP.XLS A report for use with CIMPLICITY HMI Group tables.
There is also a Microsoft Excel 97 version of each report. The files are:
SQLALARM97.XLS A report for use with CIMPLICITY HMI Alarm tables.
SQLDATA97.XLS A report for use with CIMPLICITY HMI Data tables.
SQLGROUP97.XLS A report for use with CIMPLICITY HMI Group tables.
For ad-hoc reporting, you will find that these samples are fully functional as shipped.
They may be used with either Access or SQL Server to report on any tables you may
have configured. In addition, you may copy and modify these reports to meet your
specific needs. Data in these reports is ordered by timestamp.
From Excel, you may save generated reports to disk for later use, print them, or
perform further analysis on your data.
16-50 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Alarm Report
This report provides the ability to report on the ALARM_LOG and EVENT_LOG
tables. You may filter the report by Alarm Class or timestamp.
When you open the SQLALARM.XLS spreadsheet in Microsoft Excel, the Control
worksheet is displayed initially.
This worksheet displays the current report parameters and status. From this
worksheet, you can:
• Set parameters.
• Generate the report.
• Clear the error log.
16-52 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Generating an Alarm Report
Once you have set your report parameters, click Generate Report to generate the
report.
While the report is being generated, progress messages will be displayed on the status
display of the report. The completed report will be stored on the Data worksheet.
An alarm report contains the following columns:
timestamp The time that the alarm was logged.
Alarm ID The alarm identifier of the alarm or event logged. For point
alarms, this is the same as the point identifier.
alarm_class The alarm class of the alarm or event logged. You may filter
a report to include only one class of alarm; see Set
Parameters, above.
resource The resource of the alarm or event logged.
logged_by The user or process which caused the alarm or event to be
logged. For point alarm generation, this is frequently
MASTER_PTM0_RP, the CIMPLICITY Point Manager.
reference Reference information for the alarm logged.
prev_state The previous state of the alarm before the event which caused
it to be logged. This may be N (normal), G (generated), A
(acknowledged), or R (reset).
log_action The trigger event which caused the alarm to be logged. This
may be G (generation), A (acknowledgment), R (reset), or D
(manual deletion).
final_state The final state of the alarm after the trigger event. This may
be G (generated), A (acknowledged), R (reset), or D
(deleted).
alarm_message The alarm message for the alarm being logged.
If you save your spreadsheet after generating a report, the data will be available the
next time you view the report.
This worksheet displays the current report parameters and status. From this
worksheet, you can:
• Set parameters.
• Generate the report.
• Clear the error log.
16-54 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Setting Data Report Parameters
To set report parameters, click Set Parameters. The Set Report Parameters dialog
box opens with the tunable parameters for this report.
16-56 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Trend Report
This report provides similar functionality to the Data report for use with Group
tables. In addition, it provides a static trend representation of the point values in the
report.
When you open the SQLGROUP.XLS worksheet, spreadsheet in Microsoft Excel,
the Control worksheet is displayed initially.
This worksheet displays the current report parameters and status. From this
worksheet, you can:
• Set parameters.
• Generate the report.
• Clear the error log.
16-58 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Generating A Trend Report
Once you have set your report parameters, click Generate Report to generate the
report.
While the report is being generated, progress messages will be displayed on the status
display of the report. The completed report will be stored on the Data worksheet.
A trend report contains a column for each point attribute in the table. The prefix of
each column is based on the SQL Field Prefix specified for the point. To this prefix
is appended a variable extension based on the attribute, and a number indicating the
array index (0 for non-array points). The attribute extensions are as follows:
timestamp The time that the point was logged.
project The name of the CIMPLICITY HMI project logging the alarm data.
_ALRM The alarm state of the point being logged.
_ENG The engineering units label of the point being logged.
_PREV The previous logged value of the point being logged. This value
will be NULL immediately following a CIMPLICITY restart.
_VAL The current value of the point being logged.
_TIME The timestamp of the previous time the point was logged. This
value will be NULL immediately following a CIMPLICITY restart.
It will be the same for all points in the group, because they are all
logged together.
_RAW The raw value of the point being logged. If the point does not have
engineering units conversion, it is the same as the current value.
_RES The resource of the point being logged.
In addition to the collection of data into the Data worksheet, this data will be
graphed on the Chart worksheet.
If you save your spreadsheet after generating a report, the data and chart will be
available the next time you view the report.
16-60 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Creating a Script
You will need to create a script to open the Microsoft Excel spreadsheet for your
report, generate the report and print it.
The following script opens the SQLALARM.XLS spreadsheet, generates a report,
and prints it. You can use it as a template for creating your own scripts:
Sub Main ()
’----------------------------------------------------------------------------------------
’ This section sets REPORT_TRIGGER back to 0 so that the script doesn’t continue to run.
’ This is not needed if the report is triggered directly from a CimView screen or by a
’ TIMED event in the Database Logger or Event Manager.
’
Dim PT As New point
PT.id = "\\PROJECT\REPORT_TRIGGER"
PT.value = 0
PT.set
’----------------------------------------------------------------------------------------
’ The code from this point on is for printing.
’ This example uses one of the existing Excel spreadsheets for extracting and printing
’ the data from the cimplog.mdb alarm database.
’ You will need to customize this code so that it prints what you need. It is also
’ possible in some applications to run a specific macro from the command line.
’ You can then use the SHELL command.
’
Dim Excel As Object
Set Excel = CreateObject ("Excel.Application")
’
’ Open the workbook for alarm reporting
Excel.application.workbooks.open "C:\CIMPICITY\REPORT\SQLALARM.XLS"
Excel.application.workbooks("SQLALARM.XLS").activate
’
’ Run the macro to get the data
Excel.application.Run "SQLALARM.XLS!GenerateReport"
’
’ Print the data
Excel.application.workbooks("SQLALARM.XLS").worksheets("Data").activate
Excel.application.workbooks("SQLALARM.XLS").activesheet.printout
’
’ Quit without saving the data
Excel.application.workbooks("SQLALARM.XLS").saved = TRUE
Excel.application.quit
End Sub
To create a script:
1. Select Program Editor from your CIMPLICITY HMI menu.
2. Create the script to run the report and print it. You can use the sample
script as a template.
3. Compile the script and create an executable.
16-62 CIMPLICITY HMI for Windows NT and Windows 95 User Manual GFK-1180
Client Configuration
GFK-1180 17-1
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Create a new client.
• Change the window display attributes.
• Change startup options.
• Modify an item.
• Copy the information for a selected item to a new item.
• Delete an item.
• Display a filtered list of items
Enter the name of the computer for the new client, then select OK. The Client
Properties dialog box opens.
17-2 CIMPLICITY® HMI for Windows NT and Windows 95 Base System User's Manual GFK-1180
Client Properties
Default User ID
Enter the optional default username for users on the Client computer. Users on the
Client computer will automatically be logged in to the CIMPLICITY HMI project
with this User ID.
You can click the Browser button - - to the right of the input field to open the
Select A User Browser and use it to select the User ID.
You can also use the Window Pop-up menu or the Pop-up menu button - - to
create a new user or browse for an existing user.
Trusted
Set this check box if you want the project to accept the Windows Logon Username
on the Client computer as the CIMPLICITY User ID and automatically log the user
into the project. The project must have a CIMPLICITY User ID configured that
matches the Windows Logon Username.
Clear this check box if you want users on the Client computer to manually log in to
CIMPLICITY HMI project.
GFK-1180 18-1
Supported Device Protocols
Any device protocol that supports Series 90 PLCs includes Control configuration
options when the software is properly installed. These protocols are:
• Series 90 TCP/IP
• Series 90 TCP/IP Redundancy
• SNP
Device Properties
To import variables as device points into a project, you must create an association
between the project’s devices and Control folders. A device can have associations
with multiple folders. However, a folder can only be associated with one of the
project’s devices because a folder is seen by the project as being a device itself.
When you create a new device that is supported by CIMPLICITY Control, a property
page called Control is displayed in the device properties. Use this property page to
configure and control imports from CIMPLICITY Control for that device.
18-2 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Import Options
You can select various options that customize the import of points from Control.
You can customize the following:
Point ID Prefix
The format of a point ID imported from CIMPLICITY Control can take the form
<prefix><PointID>. Use the radio buttons to select the prefix you want to use
for points you are importing.
• Select None if you want no prefix.
• Select Device name to use the device name as the prefix.
• Select Folder name to use the folder name as the prefix.
• Select Custom and enter the character string you want to create a
custom prefix.
The length of a Point ID may be up to 32 characters long in CIMPLICITY HMI.
Therefore, the allowed number of characters in the prefix depends on the number of
characters in the imported Point ID.
• If the Point ID is already greater than 32 characters, no prefix is
inserted and the Point ID is truncated at the end.
• If the Point ID is less than 32 characters long, the maximum number of
characters in the prefix will be:
32 - number of characters in the ID
• If the prefix exceeds this limit for a Point ID, it will be truncated before
it is added to the Point ID.
Add
Select this check box to create new points in the CIMPICITY HMI database. For
each device, any exportable variables from the associated folders that do not exist as
points in the project are created using the variable properties and the common point
properties.
Modify
Select this check box to modify points in the CIMPLICITY HMI database. For each
device, any exportable variables from the associated folders that exist as points in the
project are modified using the variable properties if the existing points belong to the
device. Common properties are also modified if you also set the Use common
point properties on modify check box.
Delete
Select this check box to delete points in the CIMPLICITY HMI database. For each
device, any previously exported point belonging to the device that was not exported
from an associated folder is deleted.
Note
Only previously exported points from existing associations are deleted. Previously
exported points from folder associations that no longer exist are not removed from
the project.
Actions
Select Import now to perform an exchange of data. The import is performed
regardless of whether it is needed. See Import Rules for a detailed explanation of
how imports are performed.
Select Associate with folders... to associate CIMPLICITY Control folders with
CIMPLICITY HMI devices. When you select this option the CIMPLICITY
Association Server dialog box opens.
18-4 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Associating Folders with Devices
When you select Associate with folders... on the Control property page for a
device, the CIMPLICITY Association Server dialog box opens.
This dialog box shows you the current associations and lets you:
• Create new associations
• Edit existing associations
• Delete associations
Enter the CIMPLICITY HMI project path name in the PROJECT PATH field.
Enter the CIMPLICITY Control folder path name in the FOLDER PATH field.
Enter the CIMPLICITY HMI device name in the DEVICE NAME field.
Remember that a device can have associations with multiple folders, but a folder can
only be associated with one of the project’s devices.
Editing an Association
To edit an association:
1. Select the association in the CIMPLICITY Association Server dialog
box.
2. Select EDIT.
The Edit Association dialog box opens
Use this dialog box to change the project path, folder path, or device name.
Deleting an Association
To edit an association:
1. Select the association in the CIMPLICITY Association Server dialog
box.
2. Select DELETE.
The Delete Association dialog box opens, prompting you to confirm your request.
Select Yes to delete the association, or select No to cancel the delete request.
18-6 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Import Process
When you select Import now from the Control property page of a supported device
or when you perform a configuration update, the CIMPLICITY Control Point Import
process starts.
During the import process a status dialog box displays and informs you the state of
the import process. This is done to give you positive feedback because the import
process can be quite lengthy.
Import Rules
CIMPLICITY HMI always assumes that the information in a Control folder is the
most up to date. During a configuration update, all devices with Control
configuration that have the On Configuration Update option selected are verified to
see if they need an import. An import is needed for those folders that have changed
since their last import.
There are three categories used to classify points during import:
New A point is considered new if it does not exist in the project.
Modifiable A point is considered modifiable if it exists in the project and it
belongs to the device associated with the folder being imported.
Removable A point is considered removable if it exists in the project and it
belongs to the device associated with the folder being imported but
was not imported during the current import session.
The import process retrieves exportable information from each association and uses
the following algorithm to import the points:
1. If a point is new and the configuration of the device associated with the
folder being imported has the new option selected, it is added into the
project.
Further imports will then consider this point modifiable unless its
device is changed through point configuration.
2. If a point is modifiable and the device configuration has the modify
option selected, the point is modified using the imported information.
If the device configuration has the use common properties on modify
option selected, common properties are also modified. Any other point
property is left intact (for example, alarm, display, engineering units,
etc.)
3. If a point is removable and the device configuration has the delete
option selected, it is deleted from the project.
18-8 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Resolving Point Conflicts
When conflicts occur during import, the CIMPLICITY Control Point Import
Conflicts dialog box opens and displays the list of conflicts.
To solve the conflict, you can take one of the following actions:
• Don’t import the point
• Rename it using a Point ID considered new or modifiable.
The action always defaults to Do not import.
Previously imported points with new point conflicts will always have new point
conflicts unless the point is renamed using the CIMPLICITY Control Workbench.
18-10 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Incorrect Information Conflict
An incorrect information conflict occurs when the information imported from the
folder is incorrect or incomplete.
To solve the conflict, you can take one of the following actions:
• Don’t import the point.
• Correct the point’s information.
If you rename the point you must use a Point ID considered new or modifiable. The
dialog box ensures that you do so.
The conflict action normally defaults to Do not import. However, for previously
imported points with incorrect information, their last imported information is placed
in the conflict correction dialog and the conflict action defaults to Correct.
Example
For example, given the following two computers:
ComputerA HMI and Control installed
Drive E: mapped to \\ComputerB\C$
Contains C:\project\project.gef
Configured associations:
C:\project\project.gef with
E:\folder\folder.ef7
18-12 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
You can make HMI changes to the project from either machine because they both
have HMI installed. You can make changes to the folder from either machine
because they both have Control installed.
If you open the project from ComputerA and perform a point import, it will be
performed because the computer has the project’s associations configured.
If you open the project from ComputerB and perform a point import, it will also be
performed because the computer has the project’s associations configured.
Note that if ComputerB had its association configured as follows:
F:\project\project.gef with C:\folder\folder.ef7
the import will be performed but it will end up assuming that the folder is a different
folder.
Introduction
You can use the Import/Export Utility to:
• Write existing CIMPLICITY HMI point data in to a file.
• Create and modify CIMPLICITY HMI point data using third party
software.
• Import point data into CIMPLICITY HMI software to update the
database.
• Update the configuration of multiple points at a time.
• Delete CIMPLICITY HMI point data from CIMPLICITY HMI
software.
You can use the same point information to configure more than one system. For
example, you can use a spreadsheet to create and modify point data, then import the
data into both the CIMPLICITY HMI database and Logicmaster 90 software.
The following is a quick overview of how Import/Export passes data between the
CIMPLICITY HMI point database and third party applications.
Point/Alarm
Third Party Import/Export Configuration
Applications
Files
Import/Export
Configuration
Files
CSV Files in
Log File
SNF format
GFK-1180 19-1
Import/Export Data File Format
The file and record formats used by the Import/Export Utility give you the ability to
transfer configuration data between the CIMPLICITY HMI point database and third-
party software.
Import/Export reads and writes text files that use the CSV (Comma Separated Value)
format. Each record in a CSV file begins on a new line and continues until the next
newline character is encountered. Each field in a record is separated by a comma.
You can process CIMPLICITY HMI point configuration data in any third-party
application that can read or write files in CSV format.
The CSV files used by Import/Export consist of a number of records. These records
use the SNF (Shared Name File) format. In an SNF file, the first record, called the
Field Names record, lists of the names of all the variables contained in each
subsequent record.
In addition, the SNF format used by Import/Export has the following conventions:
• For import, if a field is empty, and the point already exists, the current
value of the field is preserved.
• For import, if a field is empty, the point is a new point and a default is
defined in ie_deflds.cfg, the default is entered in the field in the
database.
• Comment lines are indicated by two pound signs at the beginning of the
line.
• The field names must be from the list of supported fields and are
case-insensitive. Any invalid fields will be identified as an error and
ignored.
}
PT_ID,PT_ORIGIN,DEVICE_ID,PT_TYPE,RAW_LIM_LOW,
RAW_LIM_HIGH,ALM_HIGH_1,ALM_HIGH_2,ALM_LOW_1,
ALM_LOW_2,DESC Field Names**
##
}
PT1,D,DEV_1,ANALOG_16,0,1000,800,950,100,5,Example 1
PD2,D,DEV_1,ANALOG_8,0,100,80,90,10,5,”Double””quotes”” ”
PT3,D,DEV_2,FLOATING,0.0,0.58,0.45,0.50,0.20,0.10,#3
PT4,D,DEV_2,ANALOG_8,0,120,100,110,20,10,”Comma, example” Records
PT5,D,DEV_2,FLOATING,1.0,2.5,2.0,2.3,1.4,1.2,” Spaces”
19-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Editing CSV Files in Notepad
When using Notepad to edit a CSV file, keep the following guidelines in mind:
• If you want to enter a blank character field, use " " (a double-quote,
followed by any number of spaces, followed by a double-quote) for the
field entry.
• If you want initial blanks at the start of the field, enclose the field
(including the blanks) in double quotes. For example:
...," Initial blanks",...
• You must enclose between double quotes any fields that contain a
comma as part of the data. For example:
...,"Comma, example",...
• You must enter two double quotes if you want a double quote to be part
of a data string. For example
...,"Quotes ""example"" ",...
• You do not need to enter two double quotes if you want a double quote
to be a part of a data string. For example:
The ie_deflds.cfg file defines default values for selected fields based on point
of origin and point type. You may configure default information for analog, digital
and text point types for both device and virtual (derived) points.
Important
When you import data into the CIMPLICITY HMI point configuration, any fields in
an import record that do not contain data, and that correspond to default fields in
ie_deflds.cfg, will have their values set to the default values contained in
ie_deflds.cfg. For example, if a new digital device point is being imported,
and the ACCESS field in the import file is left blank, the import function will
substitute the default ACCESS value used for IE_DEV_DIGITAL.
19-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Changing Information in ie_deflds.cfg
Default values are particularly useful if you frequently import points with similar
data. This data can be put in ie_deflds.cfg rather than putting it in every
import file.
You can modify the fields in ie_deflds.cfg with a text editor.
You may change the values for any fields in the data records of ie_deflds.cfg,
except the PT_ID, PT_ORIGIN and PT_TYPE fields.
You may add new default fields to this file. When you add a new field, perform the
following steps:
1. Type a comma at the end of the Field Name list, and add the field name.
2. Type a comma at the end of each data record in the file, and add the
field value. If the field is empty, just type a comma.
The default file contains two formats: Full Set and Logicmaster Export.
• The Full Set format contains all fields supported by Import/Export.
• The Logicmaster Export format contains the four fields of interest to the
Logicmaster 90 (LM90).
The internal format contains Select one of the formats in this file when you export data. If you do not select a
all the fields in the Full Set format, an internal format is used.
plus additional unsupported
fields.
19-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
In the above example:
• The INFO message tells you when the application (in this case, import)
started.
Point IDs may have up to 32 • The WARNING message tells you that the prefix that you are adding to
characters the beginning of each Point ID will cause the identified Point ID to be
truncated. For example, GEF_DEMO_REAL_REAL_LONG_NAME
will be truncated to
XXXXXXXX_GEF_DEMO_REAL_REAL_LONG.
• The ERROR message tells you that you do not have a DEVICE_ID for
a given point. This is categorized as an error, because this point data
will not be imported unless you add a Device ID.
Import Procedure
To import data, do the following:
1. Log in and start up a command shell in the project where you want to
import data.
2. At the system prompt, invoke the following command:
$ clie import <file> [-D <device_id>] [-R <resource_id>]
[-Pa <prefix>] [-y]
where:
<file> is a required argument, and is the full path of import file to be read. The
file may be in any directory, but the project’s data subdirectory is recommended.
You should always use the .csv extension with this filename.
19-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Importing Additional Roles
The format of the standard import file will only let you import point alarm routing
information for the SYSMGR, USER, and OPER roles. If you need to route point
alarms to other roles, and you want to import this information:
1. Create a second file called <filename>.rol where <filename>
is the same as the CSV file.
2. Add one line in <filename>.rol for each point that you are routing
to roles other than SYSMGR, USER, or OPER. The format of the line
will be the Point ID followed by a list of roles. Separate each field with
a comma.
3. Run the Import utility as usual. The utility will automatically search for
a .rol file whose name matches that of the .csv file, and process the
additional role information.
The following is an example of a .rol file:
## Point Role File Ver. 1.1
## File created by: GE Fanuc -- CIMPLICITY Ver. 1.0
## File created at: 15:33:35 on 6/21/95
##
TEST_ANALOG,DOER,FIXER
TEST_DIGITAL,FIXER
Export Procedure
To export configuration data, do the following:
1. Log in and start a command shell in the project from which you want to
export data.
2. At the system prompt, invoke the following command:
$ clie export <file> [-Pr] [-Ef <format>]
[-Sp<point_id>] [-Sd <device_id>] [-So <origin_id>]
[-St <type>] [-Sr <resource_id>]
where:
<file> is a required argument, and is the full path of export file to be written. The
file may be in any directory, but the project’s data subdirectory is recommended.
You should always use the .csv extension with this filename.
Option names are case The optional arguments for the export command are:
sensitive and must be entered
as defined.
Argument Description
-Pr Remove all prefixes from Point IDs (up to and including
the underscore), before exporting.
-Ef <format> The type of file format to use.
Specify one of the formats, found in the project’s
ie_formats.cfg format configuration file.
Default formats in the file are:
”Full Set” - all supported fields will be exported
”Logicmaster Export” - only 4 fields will be
exported.
If no format name is specified, the internal format is
used. This format includes all of the fields in the Full
Set, plus additional unsupported fields.
19-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
-Sp <point_id> A full or partial Point ID.
Export data for Point IDs that match the string you
specify.
-Sd <device_id> A full or partial Device ID. You can use the * and ?
wildcard characters when specifying a partial Device ID.
Export data for Point IDs whose Device IDs match the
string you specify.
-So <origin_id> Export data for Point IDs whose Origin IDs match the
string you specify. Specify one of the following:
D - device point
G - global virtual point
R - derived virtual point
-St <type> A full or partial Point Type in the CIMPLICITY
database. You can use the * and ? wildcard characters
when specifying a partial Point Type.
Export data for Point IDs whose Point Types match the
string you specify.
-Sr <resource_id> A full or partial Resource ID. You can use the * and ?
wildcard characters when specifying a partial Resource
ID.
Export data for Point IDs whose Resource IDs match the
string you specify.
Two export files will be generated by the Export utility: <filename>.csv and
<filename>.rol. The .rol file will contain information on additional roles
configured for alarm routing. If there are no roles other than SYSMGR, USER and
OPER, the file will still be generated, but will contain no information.
For example:
clie export myfile.csv -Pr -Ef "My Set"
exports the data fields defined by "My Set" in ie_formats.cfg to MYFILE.CSV
and MYFILE.ROL, and strip off any prefixes on the Point IDs.
There are no implied wildcards. If you do not include or terminate your search string
with an asterisk, only those items that match your request exactly will be returned.
>
There are no implied wildcards. If you do not include or terminate your Point ID
string with an asterisk, only those Point Ids that match your request exactly will be
deleted.
19-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Import/Export Field Names
The field names used by the Import/Export Utility correspond to a set of fields in the
CIMPLICITY HMI point and alarm configuration files. Each field has certain
requirements that must be met for information in that field to successfully be
imported into the CIMPLICITY HMI point database.
The next two sections give you detailed information about the field names used by
Import/Export.
Required Fields
The PT_ID field is required in every file. This should preferably be the first field in
the record.
Here is some more detailed information about the field:
Maximum Field Length 32 characters
CIMPLICITY Field Name Point ID
Description Unique name for a point
Optional Fields
Any of the fields listed below may be specified in a data file for Import/Export.
None are absolutely required, but, when specifying new points to be imported into
the CIMPLICITY database, certain fields may be required.
Points are device points, derived points, or global points.
• A device point gets its data directly from a device or PLC.
• A derived point gets its data from an equation, and cannot be set with a
setpoint.
• A global point can be updated either by an application or through
standard setpoint functions. An equation cannot be specified when the
point is defined.
Some of the optional fields are specific to points of a particular origin. The Point
Origin column identifies the type of point defined by the record. The point types
are:
A= All G= Global (virtual)
D= Device R= Derived (virtual)
All field names and enumerated data are case-insensitive.
19-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
ACCESS
Point Type D
Maximum Field Length 2 characters
CIMPLICITY Field Name Access
Description Device read/write access. Valid values are:
R = Read only
W = Read/Write
ACCESS_FILTER
Point Type A
Maximum Field Length Byte
CIMPLICITY Field Name Enterprise Point
Description Indicates whether the Enterprise Server has access
to the point. Valid values are:
E = Enterprise Server can access
B or blank = Enterprise Server cannot access
ACK_TIMEOUT
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Acknowledge Timeout
Description Time in minutes before the point’s alarm is
automatically acknowledged. Valid values are:
-1 = No auto acknowledge
0 = Acknowledge immediately
>0 = Minutes to wait for automatic acknowledge
ADDR
Point Type D
Maximum Field Length 32 characters
CIMPLICITY Field Name Memory Type or Address
Description Actual address of the point within the device. For
devices with memory types, this field contains the
memory type. Otherwise, the actual point address is
used.
ADDR_TYPE
Point Type D
Maximum Field Length 2 characters
CIMPLICITY Field Name Address Type
Description For MMS Ethernet devices only. The type of
address. Valid values are:
VN = Variable Name
FQ = Fully qualified
LG = Logical
UC = Unconstrained
AI = Array Index
SI = String Index
ALM_CLASS
Point Type A
Maximum Field Length 5 characters
CIMPLICITY Field Name Alarm Class
Description The Alarm Class ID to be used for the point’s
alarms. The Alarm Class ID must already be
defined in the CIMPLICITY database.
ALM_CRITERIA
Point Type A
Maximum Field Length 3 characters
CIMPLICITY Field Name Alarm Criteria
Description Method to be used for evaluating alarm conditions.
Valid options are:
ABS = Absolute
DEV = Deviation
ROC = Rate of Change
ONU = On Update
19-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
ALM_DEADBAND
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Alarm Deadband
Description Tolerance around alarm limits. The range is
determined by the PT_TYPE defined for the point.
ALM_DELAY
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Delay Alarms
Description Determine if the generation of alarms by the point
should be delayed. Valid values are:
0 = Alarms are not delayed
1 = Alarms are delayed by the length of time
specified by PT_SET_INIT and PT_SET_TIME.
ALM_HIGH_1
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Warning High
Description High warning limit
ALM_HIGH_2
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Alarm High
Description High alarm limit
ALM_HLP_FILE
Point Type A
Maximum Field Length 10 characters
CIMPLICITY Field Name Help File
Description Name of the help text file. ".HLP" will be added to
the name. Help files are located in
%SITE_ROOT%\am_help
ALM_LOW_2
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Alarm Low
Description Low alarm limit
ALM_MSG
Point Type A
Maximum Field Length 54 characters
CIMPLICITY Field Name Alarm message
Description Text displayed when the alarm is set. See Alarm
Message Variables for the list of variable
information that can be used in the text.
ALM_ROUTE_OPER
Point Type A
Maximum Field Length Boolean
CIMPLICITY Field Name Alarm Routing: OPER
Description Determines if alarm information is sent to users with
OPER role. Valid values are:
0 = Do not sent alarm to OPER role
1 = OPER role can display the alarm.
ALM_ROUTE_SYSMGR
Point Type A
Maximum Field Length Boolean
CIMPLICITY Field Name Alarm Routing: SYSMGR
Description Determines if alarm information is sent to users with
SYSMGR role. Valid values are:
0 = Do not sent alarm to SYSMGR role
1 = SYSMGR role can display the alarm.
19-18 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
ALM_ROUTE_USER
Point Type A
Maximum Field Length Boolean
CIMPLICITY Field Name Alarm Routing: USER
Description Determines if alarm information is sent to users with
USER role. Valid values are:
0 = Do not sent alarm to USER role
1 = USER role can display the alarm.
ALM_STR
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Alarm String Index
Description Alarm string index to be applied for alarms. Must
be a valid index.
ALM_TYPE
Point Type A
Maximum Field Length 2 characters
CIMPLICITY Field Name Alarm Type
Description Determines which log is written to. Valid values
are:
AL = Alarm Log
EV = Event Log
ANALOG_DEADBAND
Point Type D
Maximum Field Length Integer
CIMPLICITY Field Name Analog Deadband
Description Used to filter changes in raw value of point. The
raw value must change at least this much to update
the value of the point.
BFR_COUNT
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Point Buffering Max Count
Description The maximum number of point values to buffer for
Trending. If left zero, then the number of values is
not used as a limiting factor when buffering data.
BFR_EVENT_PERIOD
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented
BFR_EVENT_PT_ID
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
BFR_EVENT_TYPE
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
BFR_EVENT_UNITS
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
BFR_GATE_COND
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
19-20 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
BFR_SYNC_TIME
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name
Description Not currently implemented.
CALC_TYPE
Point Type R
Maximum Field Length 3 characters
CIMPLICITY Field Name Calc Types
Description Method for determining the derived point value.
Valid values are:
EQU = Equation
DAC = Delta Accumulator
VAC = Value Accumulator
AVG = Average
MAX = Maximum
MIN = Minimum
T_C = Timer/Counter
HST = Histogram
T_H = Transition High Accumulator
EWO = Equation with Override
CONV_LIM_HIGH
Point Type D
Maximum Field Length Integer
CIMPLICITY Field Name Conv Limit (hi)
Description Maximum limit for linear conversion.
CONV_LIM_LOW
Point Type D
Maximum Field Length Integer
CIMPLICITY Field Name Conv Limit (lo)
Description Minimum limit for linear conversion.
DELETE_REQ
Point Type A
Maximum Field Length 2 characters
CIMPLICITY Field Name Deletion Requirement
Description Determines when alarm occurrence should be
deleted. Valid values are:
A = Acknowledge only
R = Reset only
AR = Acknowledge and Reset
DESC
Point Type A
Maximum Field Length 40 characters
CIMPLICITY Field Name Description
Description Description of point
DEVIATION_PT
Point Type A
Maximum Field Length 32 characters
CIMPLICITY Field Name Deviation Point
Description Point that current point will be compared to when
checking for deviation alarm. Must be a configured
Point ID.
DEVICE_ID
Point Type D
Maximum Field Length 32 characters
CIMPLICITY Field Name Device ID
Description Device where the point data originates. Must be a
configured Device ID.
19-22 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
DISP_LIM_HIGH
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Disp. Limit (hi)
Description Largest value to display in CimView screens.
DISP_LIM_LOW
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Disp. Limit (low)
Description Smallest value to display in CimView screens.
DISP_WIDTH
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Display Width
Description Number of spaces for display of point value in
CimView.
ELEMENTS
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Elements
Description Number of discrete elements in the point’s data
array. This is determined by the point’s configured
data type.
ENG_UNITS
Point Type A
Maximum Field Length 8 characters
CIMPLICITY Field Name Eng. Units
Description Units that the data represents.
FW_CONV_EQ
Point Type D
Maximum Field Length 72 characters
CIMPLICITY Field Name Eng. Conversion Expression
Description Arithmetic expression used to convert raw data to
engineering units value. See Equation Operations
for the list of valid operators.
GR_SCREEN
Point Type A
Maximum Field Length 16 characters
CIMPLICITY Field Name Graphic Screen
Description CimView screen to display when the Get Screen
Hot Key is pressed for this point on the Point List or
Alarm Page.
INIT_VAL
Point Type R/G
Maximum Field Length Number
CIMPLICITY Field Name Initial Value
Description Value for point at initialization before any data is
generated by its component point(s). Use if
PT_TYPE is G, or PT_TYPE is D and
CALC_TYPE is ACC, MIN, or MAX.
19-24 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
JUSTIFICATION
Point Type A
Maximum Field Length Boolean
CIMPLICITY Field Name Justification
Description Determines if the value displayed is justified and/or
padded with zeros. Valid values are:
0 = Left justified
1 = Right justified
2 = Right justified with leading zeros
LOCAL
Point Type R/G
Maximum Field Length Boolean
CIMPLICITY Field Name Local Value
Description Determines if value is reported to Point Manager.
Valid values are:
0 = Report value
1 = Do not report value
MAX_STACKED
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Max Number Stacked
Description Maximum number of alarm occurrences tracked.
Valid values are:
0 = Alarm is not stacked
1 to 19 = Number of alarms stacked
POLL_AFTER_SET
Point Type D
Maximum Field Length Boolean
CIMPLICITY Field Name Poll After Set
Description Determines if polling should be done after a
setpoint. Valid values are:
0 = Do not poll (default)
1 = Scan immediately
PROC_ID
Point Type R/G
Maximum Field Length 14 characters
CIMPLICITY Field Name Virtual Proc ID
Description The Derived Point process that will calculate the
value of this point. Must be a valid PTDP_RP
Process ID. Format is:
<node_id>_PTDP_RP
PTMGMT_PROC_ID
Point Type R/G
Maximum Field Length 14 characters
CIMPLICITY Field Name Point Manager
Description The Point Management process that will manage
this point. Must be a valid PTM_RP Process ID.
Format is:
<node_id>_PTM<n>_RP
PT_ENABLED
Point Type D
Maximum Field Length Boolean
CIMPLICITY Field Name Enabled
Description Determines if the point is enabled or disabled.
Valid values are:
0 = Disabled
1 = Enabled
19-26 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
PT_ORIGIN
Point Type A
Maximum Field Length 1 characters
CIMPLICITY Field Name No field defined
Description Code indicating the origin of this point. Valid
values are:
D = Device Point
R = Derived Virtual Point
G = Global Virtual Point
I = Device Internal Point
A = Device Always Poll Point
PT_SET_INTERVAL
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Alarm Delay Interval (value)
For Rate of Change alarms, the frequency with
Description
which the point will be sampled for Rate of Change
alarming.
For Absolute alarms, the length of delay before the
alarm is reported if Delay Alarms is set to "Y".
PT_SET_TIME
Point Type A
Maximum Field Length 3 characters
CIMPLICITY Field Name Alarm Delay Interval (units)
Description The type of units for PT_SET_INTERVAL. Valid
values are:
SEC = Seconds
MIN = Minutes
HR = Hours
PT_TYPE
Point Type A
Maximum Field Length 16 characters
CIMPLICITY Field Name Type
Description Identifies type and length of point data. Must be a
configured point type.
RAW_LIM_LOW
Point Type D
Maximum Field Length Integer
CIMPLICITY Field Name Raw Limit (low)
Description The minimum data value expected from the device
for this point.
REP_TIMEOUT
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Repeat Timeout
Description Time in minutes before the point’s alarm is
automatically re-sent to alarm line printers. The
alarm will be re-sent only if it is still active. Valid
values are:
-1 = No automatic re-send
>0 = Minutes before automatic re-send
RESET_ALLOWED
Point Type A
Maximum Field Length Boolean
CIMPLICITY Field Name Reset Allowed
Description Determines if a user can reset the point’s alarm.
Valid values are:
0 = User cannot reset the alarm
1 = User can reset the alarm
19-28 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
RESET_COND
Point Type R/G
Maximum Field Length 2 characters
CIMPLICITY Field Name Reset/Startup Cond
Description Search sequence for source of initial value. Valid
values are:
UN = Unavailable
IN = Use INIT_VAL
SA = Use saved value
SI = Saved and init
RESET_PT
Point Type R/G
Maximum Field Length 32 characters
CIMPLICITY Field Name Reset Point
Description Point that will cause this derived point to reset.
Must be a configured Point ID.
RESET_TIMEOUT
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Reset Timeout
Description Time in minutes before this point’s alarm is
automatically reset. Valid values are:
-1 = No automatic reset
0 = Reset automatically
>0 = Minutes before automatic reset
RESOURCE_ID
Point Type A
Maximum Field Length 16 characters
CIMPLICITY Field Name Resource ID
Description Resource ID for this point. Must be a configured
Resource ID.
ROLLOVER_VAL
Point Type R
Maximum Field Length Integer
CIMPLICITY Field Name Rollover
Description For Delta Accumulator virtual points, the value of a
point at which it rolls over to a zero value when
incremented by one unit.
SAFETY_PT
Point Type A
Maximum Field Length 32 characters
CIMPLICITY Field Name Safety Point
Description Point ID of an analog or digital point to be checked
when a setpoint request is made for this point. If the
point evaluates to zero (0), the setpoint is denied.
Must be a configured Point ID.
SAMPLE_INTV
Point Type A
Maximum Field Length Number
CIMPLICITY Field Name ROC (value)
Description Size of rate of change interval expressed in
SAMPLE_INTV_UNIT units.
SAMPLE_INTV_UNIT
Point Type A
Maximum Field Length 3 characters
CIMPLICITY Field Name ROC (units)
Description The type of units for SAMPLE_INTV. Valid
values are:
SEC = Seconds
MIN = Minutes
HR = Hours
19-30 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
SCAN_RATE
Point Type D
Maximum Field Length Integer
CIMPLICITY Field Name Scan Rate
Description Frequency of point sampling. This is a multiple of
the base scan rate set for the system.
TRIG_CK_PT
Point Type A
Maximum Field Length 32 characters
CIMPLICITY Field Name Availability Trigger
Description The point serving as the availability trigger for this
point.
If the Availability Trigger is TRUE (non-zero) this
point value is available.
If the Availability Trigger is FALSE (zero), this
point value is unavailable.
TRIG_PT
Point Type D/R
Maximum Field Length 32 characters
CIMPLICITY Field Name Trigger
Description The point serving as the trigger for this point. Use
differs if device or derived point. Must be a
configured Point ID.
For device points the trigger point must be on the
same device as the points it triggers.
For derived points, the trigger point must be
processed by the same Derived Point Process as the
points it triggers.
TRIG_VAL
Point Type D
Maximum Field Length 16 characters
CIMPLICITY Field Name Value
Description Value the trigger is compared with to determine if
the TRIG_REL condition is met.
UPDATE_CRITERIA
Point Type D
Maximum Field Length 2 characters
CIMPLICITY Field Name Update Criteria
Description Value determining when point data is passed to the
CIMPLICITY point database after the device is
read. Valid values are:
UN = Unsolicited
OC = On Change
OS = On Scan
DS = On Demand On Scan
DC = On Demand On Change
PO = Poll Once
VARIANCE_VAL
Point Type R/G
Maximum Field Length Number
CIMPLICITY Field Name Variance value
Description Accumulator variance value.
19-32 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
VARS
Point Type A
Maximum Field Length Integer
CIMPLICITY Field Name Vars
Description Number of process variables represented by this
point.
Logicmaster 90 Support
}
BSO_PB,%I00001,Boiler shutoff pushbutton ,bool
OVRTMP,%Q00001,Boiler overtemp warning ,bool
STEMP,%R00001,Scaled boiler temperature ,real
TEMP1,%A00001,Boiler temp thermocouple #1 ,int Records
TEMP2,%A00002,Boiler temp thermocouple #2 ,int
GFK-1180 20-1
Configuring an Alarm Viewer OCX in CimEdit
To configure an Alarm Viewer in CimEdit, do one of the following:
• On the OLE toolbar, click the AMV button.
A new Alarm Viewer control is placed in the upper left corner of your
CimEdit screen.
• On the Tools toolbar, click the OLE button, or select OLE Object
from the Tools menu, then:
1. Select the position of the upper left corner of the Alarm Viewer
and click the left mouse button to fix it. The Insert Object dialog
box opens.
20-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Once the Alarm Viewer control is in CimEdit, you may:
• Click once on the Alarm Viewer control to activate its borders. You
can now resize the control or move it using the borders.
• Double-click on the control to display the CIMPLICITY AMV Control
Properties dialog box and configure the Alarm Viewer.
The list of fields depends on whether you are configuring a Static Alarm List or a
Dynamic Alarm List.
• Select Static to configure a Static Alarm List. The list of fields
changes to show you the ones available for the Static Alarm List.
• Select Dynamic to configure a Dynamic Alarm List. The list of fields
changes to show you the ones available for the Dynamic Alarm List.
If any field titles have been modified, the modified title appears in parentheses to the
right of the field name (for example, "(Ack)" appears to the right of "Ack State").
To select a field, set its check box.
Once you select a field, you can configure which row of the alarm message the field
will be placed in, where in the row it will be placed, and the length of the display.
Position Left
Select the Alarm List field you want to move, then click Position Left to move it
toward the front of the current message row.
Position Right
Select the Alarm List field you want to move, then click Position Right to move it
toward the end of the current message row.
Row Up
Minimum row number is 1. Select the Alarm List field you want to move, then click Row Up to move it up a
row in the message. The field will be placed at the start of the message row.
20-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Row Down
Maximum row number is 10. Select the Alarm List field you want to move, then click Row Down to move it
down a row in the message. The field will be placed at the start of the message row.
Modify
Select the Alarm List field you want to modify, then click Modify. The Field
Properties dialog box opens.
The current field length is displayed in the Length input field. To change the length
of a field:
1. Enter the new field length in the Length input field.
2. Click OK.
Note
Field length is based on the average size of characters in the font you have chosen.
Thus, a length of 6 may be sufficient to display the string "IIIIII", but may be too
short to display "WWWWWW". To ensure that the length is always adequate, select
a fixed pitch font (such as Courier New) for your alarm page display.
The current field title is displayed in the Title input field. To change the title of a
field:
1. Enter the new field title in the Title field.
2. Click OK.
When you change the title of a field, its original title appears next to the check box in
the Fields list, and the modified title appears to the right in parentheses.
The list of buttons depends on whether you are configuring a Static Alarm List or a
Dynamic Alarm List.
• Select Static to configure a Static Alarm List. The list of buttons
changes to show you the ones available for the Static Alarm List.
• Select Dynamic to configure a Dynamic Alarm List. The list of
buttons changes to show you the ones available for the Dynamic Alarm
List.
To select a button, set its check box.
You may need to use the vertical scroll bar to the right of the list to see all of the
buttons. The following is a complete list:
Button Description
Help Displays the help file for an alarm. See page 20-46 for
more information.
Setup Displays the Alarm Setup dialog. See page 20-46 for more
information.
Refresh Updates the alarm list. See page 20-46 for more
information.
View Stack Displays the stacked alarms for the selected alarm. See
page 20-47 for more information.
Comments Displays the Alarm Comments dialog. See page 20-47 for
more information.
20-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Toggle Displays the Dynamic Alarm list. See page 20-46 for more
information.
Ack Acknowledges the current alarm. See page 20-48 for more
information.
Reset Resets the current alarm. See page 20-48 for more
information.
Delete Deletes the current alarm. See page 20-48 for more
information.
Ack and Reset Acknowledges and resets the current alarm. See page 20-
48 for more information.
Ack First Acknowledge first alarm. See page 20-49 for more
information.
Ack All Acknowledge all alarms. See page 20-49 for more
information.
CimView Screen Displays the CimView screen associated with the alarm.
See page 20-47 for more information.
Custom1 through Lets you define up to eight custom buttons that you can use
Custom8 to integrate external applications with the Alarm Viewer.
See page 20-42 for more information.
All buttons are available for the Static display. For the Dynamic display, only the
Refresh and Help buttons are not available.
Once you have selected the buttons for display in the alarm list, you can configure
which button row the button will be placed in, where in the row it will be placed, and
what caption will be displayed.
Position Left
Select the Alarm List button you want to move, then click Position Left to move it
toward the front of the current row.
Position Right
Select the Alarm List button you want to move, then click Position Right to move
it toward the end of the current row.
Row Up
Minimum row number is 1 Select the Alarm List button you want to move, then click Row Up to move it up a
row. The button will be placed at the start of the row.
Row Down
Maximum row number is 10 Select the Alarm List button you want to move, then click Row Down to move it
down a row. The button will be placed at the start of the row.
To modify a button:
1. Enter the new caption in the Button Caption input field. You may
enter up to 100 characters.
2. Enter a description in the Description field.
3. If you have selected a custom button, enter the command string you
want to be executed when the button is selected in the Command
String field (this field is not available for the standard buttons).
4. Click OK.
For standard buttons, the button name in the Buttons field of the Button Layout
window does not change - just the caption that is displayed in the button at run-time.
For custom buttons, the caption displayed in the button at run-time changes, and
when a user clicks the button, the command string you specified will be executed.
20-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Projects
Use the Projects properties to select the projects from which you want to view
alarms.
To add a project to the list, select Add Project. When the Select Project dialog box
opens, select the project you want from the list of available projects, then select OK.
To delete a project from the list, select it, and then select Delete Project. When
you are asked to verify the deletion, select OK.
To connect to the local project, set the Connect to Local Project check box.
Sort Alarms
You can use these fields to select the primary and secondary sort parameters for the
Alarm List.
For the primary sort key:
By Click the drop-down list button to the right of the input field and
select the primary sort key.
Ascending Select this radio button if you want to sort the primary key in
ascending order.
Descending Select this radio button if you want to sort the primary key in
descending order.
For the secondary sort key:
Then Click the drop-down list button to the right of the input field and
select the secondary sort key.
Ascending Select this radio button if you want to sort the secondary key in
ascending order.
Descending Select this radio button if you want to sort the secondary key in
descending order.
20-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
You can select any of the following as a sort key:
None This key will not be used to sort alarm items.
Project Projects are sorted alphabetically by Project Name.
Class Alarms in the selected classes are sorted, lowest to highest, in the
sort order assigned to each Alarm Class when it was created.
Resource Alarms in the selected resources are sorted alphabetically, lowest
to highest, by Resource ID.
State Alarms are sorted according to a combination of their State and
Ack Status in the following order:
1. All unacknowledged alarms in ALARM state
2. All unacknowledged alarms in NORMAL state
3. All acknowledged alarms in ALARM state
Time Alarms are arranged according to the time of their occurrence,
with the most recent first.
Message Alarms are sorted alphabetically by alarm message contents.
Ack state Alarms are sorted/grouped by acknowledgement state (Y/N)
Stacked Alarms are sorted/grouped by presence/absence of stacked alarms.
Comment Alarms are sorted/grouped by presence/absence of comments.
Alarm ID Alarms are sorted alphabetically by Alarm ID
Duration In dynamic display mode, alarms are sorted by duration. This
value is not available in static display mode, so alarms will be
sorted by time if this item is selected.
Reference Alarms are sorted alphabetically by reference value.
The default sort key is Time descending. If an order is not established between
two alarms after applying the selected key criteria, Time descending will be used
to try to establish an order.
Select the desired sort criteria from the drop-down list boxes, and choose a desired
direction with the corresponding radio buttons.
If Allow title bar sort changes is enabled, the primary sort key can be modified with
the left mouse button in the title bar area of the alarm list.
Count Layout
Use the Count/Layout properties to select the count information to be displayed and
the order and orientation in which to display it.
20-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
You can define the following:
Position
Use these check boxes to position the alarm count information:
• Clear both check boxes to position the alarm count on the lower left-
hand corner of the Alarm Viewer.
• Set the Top of Screen check box to display the alarm information in
the upper left corner of the Alarm Viewer.
• Set the Top of Screen and Center Count check boxes to display the
alarm information centered at the top of the Alarm Viewer.
Orientation
You can choose to display the alarm count information fields horizontally or
vertically.
• Select the Horizontal radio button to display the alarm count
information fields side by side in the order you specify.
• Select the Vertical radio button to display the alarm count information
fields one on top of the other in the order you specify.
Fields
You can choose whether to display:
• Alarm count
• Alarm date
• Alarm time
You can use the Move Up and Move Down buttons in this area to order the count,
date, and time display to your liking.
Date
Select the format you want to use to display the date of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You may
select one of the formats from the list, or construct your own format using the
following information:
m Numeric month with no leading zero.
mm Numeric month with leading zero.
mmm Short text month.
mmmm Long Text month.
d Numeric day with no leading zero.
dd Numeric day with leading zero.
ddd Short text day of the week.
dddd Long text day of the week.
y Last two digits of year. For digits 00 through 09, only the last digit
is displayed.
yy Last two digits of year. For digits 00 through 09, both digits are
displayed.
yyyy All four digits of year
For example, if you enter dddd dd mmmm yyyy, the sample date will be
Saturday 05 March 1994.
20-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
You may use spaces, dashes, slashes or any other delimiter of your choice to separate
the date fields.
Time
Select the format you want to use to display the time of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You may
select one of the formats from the list, or construct your own format using the
following information:
H Hours based on a twelve-hour clock with no leading zero.
HH Hours based on a twelve-hour clock with leading zero.
HHH Hours based on a 24-hour clock with no leading zero.
HHHH Hours based on a 24-hour clock with leading zero.
M Minutes with no leading zero.
MM Minutes with leading zero.
S Seconds with no leading zero.
SS Seconds with leading zero.
T Hundredths of seconds with no leading zero.
TT Hundredths of seconds with leading zeros.
P, A, p, or a AM/PM indicator.
For example, if you enter HHHH:MM:SS:TT p, the sample time will be
13:05:06:08 PM.
You may use colons, spaces or any other delimiter of your choice to separate the date
fields.
All of the text fields are shown in the list box, along with their current font types and
sizes.
To change the font information for a text field:
1. Select the text you want to change.
2. Select Font.
3. The Font dialog box opens and shows you the current attributes for the
font in the Font, Font style, Size, Effects, and Script fields.
4. Change the font properties for the text.
5. Select OK to save your changes or select Close to close the Font
dialog box and return to the Fonts property page.
20-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Colors
Use the Colors properties to change the colors of properties in the control.
First, select the property you want to change in the Property Name field. You can
change the color of any of the following:
• Alarm list background
• Button background
• Alarm count text
• Count background
• Normal count text
• Status background
• Status text
To select a color for the property, you can choose a default system color from the
System Color list, or select one of the 16 colors from the palette.
Selecting Alarms
Several of the functions you can perform require you to select one or more alarms
from the alarm list. There are several ways to do this:
• To select a single alarm, move the mouse to the alarm and click on it.
• To select a series of individual alarms, hold down the Ctrl key, then
move to each alarm in turn and click on it.
• To select a group of alarms, click on the first alarm in the group, and
then hold down the Shift key, move the mouse to the last alarm in the
group and click on it. All alarms in the list between the first alarm and
last alarm will be selected.
20-18 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Configuring Alarm Viewer Methods
An Alarm Viewer method is a function that operates on an Alarm Viewer control in
CimView.
The following method is reserved for GE Fanuc use:
• NotifyAllPropertySinks
The following methods are available for Alarm Viewer controls:
AboutBox DoAckAll DoAckFirst
DoAcknowledge DoAckReset DoCimviewScreen
DoComments DoCustom<n> DoDelete
DoHelp DoRefresh DoReset
DoSetup DoToggle DoViewStack
MoveDownOneAlarm MoveUpOneAlarm PageDownAlarms
PageUpAlarms SelectAllAlarms SelectPageAlarms
SelectTopAlarm
AboutBox Method
This method displays the Help About dialog box for the CIMPLICITY Alarm Viewer
control. There is no equivalent to this method in the Alarm Viewer control.
When you configure the AboutBox method, the Advanced... button is not
activated because no further parameters are required for the method.
DoAckAll Method
This method acknowledges all alarms currently displayed on the CIMPLICITY
Alarm Viewer control. It is equivalent to the Ack All button in the Alarm Viewer
control.
When you configure the DoAckAll method, the Advanced... button is not activated
because no further parameters are required for the method.
DoAckFirst Method
This method acknowledges the first alarm in the alarm list on the CIMPLICITY
Alarm Viewer control. It is equivalent to the Ack First button in the Alarm Viewer
control
When you configure the DoAckFirst method, the Advanced... button is not
activated because no further parameters are required for this method.
DoAcknowledge Method
This method acknowledges the currently selected alarm(s) in the alarm list on the
CIMPLICITY Alarm Viewer control. It is equivalent to the Ack button in the Alarm
Viewer control
When you configure the DoAcknowledge method, the Advanced... button is not
activated because no further parameters are required for this method.
DoCimviewScreen Method
This method displays the CimView screen configured for the currently selected
alarm in the alarm list on the CIMPLICITY Alarm Viewer control. It is equivalent to
the CimView Screen button in the Alarm Viewer control
When you configure the DoCimviewScreen method, the Advanced... button is
not activated because no further parameters are required for this method.
DoComments Method
This method opens the Alarm Comments dialog box so that you can view the alarm’s
comments and add new ones. It is equivalent to the Comments button in the Alarm
Viewer control.
When you configure the DoComments method, the Advanced... button is not
activated because no further parameters are required for this method.
DoCustom<n> Method
These methods launch user-defined applications from the CIMPLICITY Alarm
Viewer control. They are equivalent to the Custom1 through Custom8 buttons in
the Alarm Viewer control.
When you configure the DoCustom<n> method, the Advanced... button is not
activated because no further parameters are required for this method.
DoDelete Method
If users have the Alarm Delete privilege, this method deletes the currently selected
alarm(s) in the alarm list on the CIMPLICITY Alarm Viewer control. It is equivalent
to the Delete button in the Alarm Viewer control
When you configure the DoDelete method, the Advanced... button is not activated
because no further parameters are required for this method.
DoHelp Method
This method opens the Alarm Operator Help dialog for the currently selected alarm
in the CIMPLICITY Alarm Viewer control. It is equivalent to the Help button in the
Alarm Viewer control.
When you configure the DoHelp method, the Advanced... button is not activated
because no further parameters are required for this method.
20-20 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
DoRefresh Method
This method refreshes Static Alarm list with the latest alarms. It is equivalent to the
Refresh button in the Alarm Viewer control.
When you configure the DoRefresh method, the Advanced... button is not
activated because no further parameters are required for this method.
DoReset Method
This method lets a user reset an alarm or group of alarms. It is equivalent to the
Reset button in the Alarm Viewer control. The alarm will not be triggered again
until it returns to its normal state then goes back to an alarm state.
When you configure the DoReset method, the Advanced... button is not activated
because no further parameters are required for this method.
DoSetup Method
This method opens the Alarm Setups dialog so that users can select the filtering they
want when viewing alarms in the CIMPLICTIY Alarm Viewer control. It is
equivalent to the Setup button in the Alarm Viewer control.
When you configure the DoSetup method, the Advanced... button is not activated
because no further parameters are required for this method.
DoToggle Method
This method toggles the CIMPLICITY Alarm Viewer control between the Static
Alarm list and the Dynamic Alarm list. It is equivalent to the Toggle button in the
Alarm Viewer control.
When you configure the DoToggle method, the Advanced... button is not
activated because no further parameters are required for this method.
DoViewStack Method
This method opens the Stacked Alarms dialog for the selected alarm in the
CIMPLICITY Alarm Viewer control. It is equivalent to the View Stack button in
the Alarm Viewer control.
When you configure the DoViewStack method, the Advanced... button is not
activated because no further parameters are required for this method.
MoveDownOneAlarm Method
This method moves the list of alarms being displayed down by one alarm. It is
equivalent to the down arrow on a user’s keyboard.
When you configure the MoveDownOneAlarm method, the Advanced... button
is not activated because no further parameters are required for this method.
PageDownAlarms Method
If there is more than one page of alarms in the list, this method displays the next page
of alarms. It is equivalent to the Page Down button on the user’s keyboard.
When you configure the PageDownAlarms method, the Advanced... button is
not activated because no further parameters are required for this method.
PageUpAlarms Method
If there is more than one page of alarms in the list, this method displays the previous
page of alarms. It is equivalent to the Page Up button on the user’s keyboard.
When you configure the PageUpAlarms method, the Advanced... button is not
activated because no further parameters are required for this method.
SelectAllAlarms Method
This method selects all alarms in the list.
When you configure the SelectAllAlarms method, the Advanced... button is not
activated because no further parameters are required for this method.
SelectPageAlarms Method
This method selects all alarms displayed on the current page.
When you configure the SelectPageAlarms method, the Advanced... button is
not activated because no further parameters are required for this method.
SelectTopAlarm Method
This method selects the first alarm in the current page and deselects all other selected
alarms.
When you configure the SelectTopAlarm method, the Advanced... button is not
activated because no further parameters are required for this method.
20-22 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Naming an Alarm Viewer Control
Before you can invoke a method for an Alarm Viewer control, the control must have
its Object name defined. To do this:
1. Select the Alarm Viewer control.
2. From the Edit menu, select Properties, or press Alt+Enter.
3. Select the General properties of the Object Properties dialog box.
4. Enter a name for the Alarm Viewer control in the Object name field.
5. Select OK to save your changes and close the Object Properties dialog
box.
You can now select the control when you create an Invoke Method action.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Log in as a particular CIMPLICITY HMI user.
• Select an Alarm Viewer file to display.
• Save the Alarm View you have just configured.
• Print the current list of alarms.
• Configure the count display.
• Configure the list display.
20-24 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Alarm Viewer Menus
You can use the menu options to access Alarm Viewer configuration files, copy
alarms from the Alarm Viewer window to the Clipboard, toggle the display of the
Toolbar and Status bar, configure a new Alarm Viewer screen, and access Help.
20-26 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
The Help Menu
When you select the Help menu, the following drop-down list displays:
20-28 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
You can define the following:
Position
Use these check boxes to position the alarm count information:
• Clear both check boxes to put the alarm count information in the lower
left-hand corner of the Alarm Viewer.
• Set the Alarm at Top of Screen check box to put the alarm count
information in the upper left-hand corner of the Alarm Viewer.
• Set the Alarm at Top of Screen and Center Count check boxes to
center the alarm count information on the top of the Alarm Viewer.
Orientation
You can choose to display the fields horizontally or vertically.
• Select Horizontal to display the fields side by side in the order you
specify.
• Select Vertical to display the fields one on top of the other in the order
you specify.
Fields
You can choose whether to display:
• Alarm count
• Alarm date
• Alarm time
You can use the Move Up and Move Down buttons in this area to order the count,
date, and time display to your liking.
20-30 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Date/Time Font
The current font name and size are displayed. To change the date/time font, select
Font... to display the Font dialog box. Use the dialog box to configure the font type,
style, and size to be used from the date/time fields.
The list of fields will depend on whether you are configuring a Static Alarm List or a
Dynamic Alarm List.
• Select Static to configure a Static Alarm List.
• Select Dynamic to configure a Dynamic Alarm List.
If any field titles have been modified, the modified title appears in parentheses to the
right of the field name (for example, "(Ack)" appears to the right of "Ack State").
You can select one or more of the fields in this list. To select a field, set its check
box.
Dynamic Alarm Fields
After you select Dynamic, the list of alarm fields looks like this:
You can select one or more of the fields in this list. To select a field, set its check
box.
Once you have selected a field for display in the alarm list, you can configure which
row of the alarm message the field will be placed in, where in the row it will be
placed, and the length of the display.
Position Left
Select the Alarm List field you want to move, then click Position Left to move it
toward the front of the current message row.
Position Right
Select the Alarm List field you want to move, then click Position Right to move it
toward the end of the current message row.
Row Up
Minimum row number is 1. Select the Alarm List field you want to move, then click Row Up to move it up a
row in the message. The field will be placed at the start of the message row.
Row Down
Maximum row number is 10. Select the Alarm List field you want to move, then click Row Down to move it
down a row in the message. The field will be placed at the start of the message row.
20-32 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Modify
Select the Alarm List field you want to modify, then click Modify. The Field
Properties dialog opens.
The current field length is displayed in the Length input field. To change the length
of a field:
1. Enter the new field length in the Length input field.
2. Click OK.
Note
Field length is based on the average size of characters in the font you have chosen.
Thus, a length of 6 may be sufficient to display the string "IIIIII", but may be too
short to display "WWWWWW". To ensure that the length is always adequate, select
a fixed pitch font (such as Courier New) for your alarm page display.
The current field title is displayed in the Title input field. To change the title of a
field:
1. Enter the new field title in the Title field.
2. Click OK.
When you change the title of a field, its original title appears next to the check box in
the Fields list, and the modified title appears to the right in parentheses.
Font
The current font name and size are displayed. To change the alarm list font, select
Font... to display the Font dialog box. Use the dialog box to configure the font type,
style, and size to be used for the alarm list.
Background Color
The current background color for the screen is displayed. To change the background
color, select Color... to display the Color dialog box. Use the dialog box to
configure the background color you want for the alarm list.
20-34 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Selecting Alarm List Button Layout
Use the Button Layout properties to change the button layout and captioning used for
the Alarm List.
The list of buttons will depend on whether you are configuring a Static Alarm List or
a Dynamic Alarm List.
• Select Static to configure a Static Alarm List.
• Select Dynamic to configure a Dynamic Alarm List.
Static Alarm List Buttons
After you select Static, the list of alarm buttons looks like this:
You can select one or more of these buttons. To select a button, set its check box.
20-36 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Dynamic Alarm List Buttons
After you select Dynamic, the list of buttons looks like this:
You can select one or more of these buttons. To select a button, set its check box.
Toggle Displays the Static Alarm list. See page 20-46 for more
information.
Setup Displays the Alarm Setup dialog box. See page 20-46 for more
information.
Once you have selected the buttons for display in the alarm list, you can configure
which button row the button will be placed in, where in the row it will be placed, and
what caption will be displayed.
Position Left
Select the Alarm List button you want to move, then click Position Left to move it
toward the front of the current row.
Position Right
Select the Alarm List button you want to move, then click Position Right to move
it toward the end of the current row.
Row Up
Minimum row number is 1 Select the Alarm List button you want to move, then click Row Up to move it up a
row. The button will be placed at the start of the row.
Row Down
Maximum row number is 10 Select the Alarm List button you want to move, then click Row Down to move it
down a row. The button will be placed at the start of the row.
To modify a button:
1. Enter the new caption in the Button Caption field. You may enter up
to 100 characters.
2. Enter a description in the Description field.
3. If you have selected a custom button, enter the command string you
want to be executed when the button is selected in the Command
String field (this field is not available for the standard buttons).
4. Click OK.
For standard buttons, the button name in the Buttons field of the Button Layout
window will not change - just the caption that is displayed in the button at run-time.
For custom buttons, the caption displayed in the button at run-time will be changed,
and when a user clicks the button, the command string you specified will be
executed.
Background Color
The current background color for the screen is displayed. To change the background
color, click Color... to display the Color dialog box. Use the dialog box to
configure the background color you want for the alarm list.
20-38 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
General Configuration Information
Use the General properties to define the system that Alarm Viewer will connect to
when it displays this Alarm List, and how the window will be placed.
Date
Select the format you want to use to display the date of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You may
select one of the formats from the list, or construct your own format using the
following information:
m Numeric month with no leading zero.
mm Numeric month with leading zero.
mmm Short text month.
mmmm Long Text month.
d Numeric day with no leading zero.
dd Numeric day with leading zero.
20-40 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
ddd Short text day of the week.
dddd Long text day of the week.
y Last two digits of year. For digits 00 through 09, only the last digit is
displayed.
yy Last two digits of year. For digits 00 through 09, both digits are
displayed.
yyyy All four digits of year
For example, if you enter dddd dd mmmm yyyy, the sample date will be
Saturday 05 March 1994.
You may use spaces, dashes, slashes or any other delimiter of your choice to separate
the date fields.
Time
Select the format you want to use to display the time of an alarm on the list. A
sample for the format you choose displays in the Sample field in this box. You may
select one of the formats from the list, or construct your own format using the
following information:
H Hours based on a twelve-hour clock with no leading zero.
HH Hours based on a twelve-hour clock with leading zero.
HHH Hours based on a 24-hour clock with no leading zero.
HHHH Hours based on a 24-hour clock with leading zero.
M Minutes with no leading zero.
MM Minutes with leading zero.
S Seconds with no leading zero.
SS Seconds with leading zero.
T Hundredths of seconds with no leading zero.
TT Hundredths of seconds with leading zeros.
P, A, p, AM/PM indicator.
or a
For example, if you enter HHHH:MM:SS:TT p, the sample time will be
13:05:06:08 PM.
You may use colons, spaces or any other delimiter of your choice to separate the date
fields.
20-42 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
%PROJECT CIMPLICITY project name
%PRJ same as %PROJECT
Example
Alarm Comments are only available for the duration of an instance of an alarm. You
can use a Custom Button to create a set of long-term notes, describing the historical
conditions surrounding past alarm conditions in a factory.
To do this:
1. Select a Custom button from the Button Layout list.
2. Type Notes... in the Button Caption field.
3. Type Edit Alarm notes for a selected alarm in the Description
field.
4. Type NOTEPAD %DIR\NOTES\%ID.TXT in the Command
String field.
The completed dialog looks like this:
When a user selects this button, a new Notepad will be executed for a file in the
NOTES subdirectory of the CIMPLICITY HMI project directory. The filename is
determined by the Alarm ID of the selected alarm.
Enter your CIMPLICITY HMI username in the Username field, and enter your
CIMPLICITY HMI user password (if you have one) in the Password field.
You can also:
• Click on the Reconnect at Startup check box to automatically login
each time you start up Alarm Viewer.
• Click on the Save Username + Password check box to save your
username and password. They will automatically be entered in their
fields the next time you log in using this dialog.
When you select the Login! menu option, you may see the Select Project dialog box.
Use this dialog box to select a remote project to log in to.
20-44 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Viewing the Alarm List
After you have configured an alarm list, you can save it or use it to view alarms. You
can also use Open... on the File menu to select an alarm list for display.
You can use the buttons at the bottom of the alarm list to perform various other
functions.
You can use the Print functions on the File menu to print the alarm list.
You can use the Copy function on the Edit menu to copy selected alarms from the
alarm list to the clipboard.
Selecting Alarms
Several of the functions you can perform require you to select one or more alarms
from the alarm list. There are several ways to do this:
• To select a single alarm, move the mouse to the alarm and click on it.
• To select a series of individual alarms, hold down the Ctrl key, then
move to each alarm in turn and click on it.
• To select a group of alarms, click on the first alarm in the group, and
then hold down the Shift key, move the mouse to the last alarm in the
group and click on it. All alarms in the list between the first alarm and
last alarm will be selected.
When you click Toggle on the Static Alarm list, the Dynamic Alarm list displays.
When you click Toggle on the Dynamic Alarm list, the Static Alarm list displays.
The Alarm Operator Help dialog box displays all the information associated with the
alarm at the top of the dialog. If a help file has been defined for the alarm, the
contents of the file will be displayed in a scrolling region.
Click Done to close the dialog box and return to the Alarm Viewer screen.
20-46 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Viewing the Alarm Stack
An alarm can be configured so the states it passes through can be kept or stacked. If
the number of states exceeds the maximum number configured for the alarm’s stack,
the oldest occurrences are eliminated. When an alarm is deleted, all occurrences of
the stacked alarm are deleted.
If an alarm has stacked occurrences, and the Stacked field is being displayed, you
will see an asterisk (*) in the "Stacked" field.
To view an alarm’s stack:
1. Click the alarm in the list.
2. Click View Stack.
The Stacked Alarms dialog box opens. Information about the selected alarm is
displayed at the top of the screen. The alarm stack displays the state information
with the most recent state change at the top of the list.
Click Done to close the dialog box and return to the Alarm Viewer screen.
Resetting an Alarm
You can manually reset an alarm to indicate to the system that you are manually
overriding the alarm condition. If you do this, the alarm will not be triggered again
until the situation returns to the configured acceptable range and then goes back out
of the acceptable range.
The system automatically resets an alarm if the condition that triggered the alarm
returns to within acceptable limits.
To reset an alarm (or a group of alarms):
1. Select the alarm.
2. Click Reset.
When you reset an alarm, its state changes from ALARM to NORMAL.
Deleting an Alarm
Deletion requirements are defined Normally, alarms are automatically deleted once they have been successfully
during alarm configuration. acknowledged and/or reset as long as their deletion requirements have been met.
If you have been given the Alarm Delete privilege, you can force alarms to be
deleted without the deletion requirements being met.
To delete an alarm (or a group of alarms):
1. Select the alarm.
2. Click Delete.
When you delete an alarm, it will be removed from the alarm list.
20-48 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Acknowledging and Resetting an Alarm
You can simultaneously acknowledge and reset an alarm to indicate to the system
that you have seen the condition and are manually overriding it. If you do this, the
alarm will not be triggered again until the situation returns to the configured
acceptable range and then goes back out of the acceptable range.
To simultaneously acknowledge and reset an alarm (or a group of alarms):
1. Select the alarm.
2. Click Ack and Reset.
When the Alarm Setups dialog box opens, the current filter displays in the Setup
field. The list of filters that you can use is displayed below the current filter. There
are three types of filters:
<<UNFILTERED>> This is the default filter. When it is loaded, you can view
all alarms available to your CIMPLICITY HMI User ID.
Site-wide filters Filters that start with the "$" character are site-wide
filters, and are available to any user.
You need to be logged in as ADMINISTRATOR to
create, modify, or delete site-wide filters.
User filters Filters that do not start with the "$" characters are only
available to users that log in with your CIMPLICITY
HMI User ID.
To close the dialog box and return to the Alarm List display, click Done.
20-50 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Loading an Alarm Viewer Filter for Display
To load a filter for display:
1. Click on the filter in the list that you want to use. The filter name
displays in the Setup field.
2. Click Load.
The filter loads and the Alarm List is refiltered and redisplayed.
Note
You must load a filter in order to modify it.
The Classes property page displays the list of current alarm classes and indicates
which ones are used in the filter. Set the check box to the left of a class to include
alarms for that class in the Alarm List. Clear the check box to exclude alarms for that
class from the Alarm List.
Click Add All to select all classes.
Click Remove All to clear all classes.
The Resources property page displays the list of current resources, and indicates
which ones are used in the filter. Set the check box to the left of a resource to include
alarms for that resource in the Alarm List. Clear the check box to exclude alarms for
that resource from the Alarm List.
Click Add All to select all resources.
Click Remove All to clear all resources.
20-52 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
The Time/State/Sort property page displays the current status of the Time and State
filters, and the Sort Order for the Alarm List.
Filter by Time
You can use this option to display all alarms that have occurred since a certain time.
To do this, set the Use Time Filter check box to enable this filter, then enter the
starting date and time for the filter in the Select Alarms Since input fields.
The time and date when you opened the Modify Setup dialog box are used as the
default time and date.
Filter by State
You can use this option to limit the alarms displayed on the Alarm List to only those
that occur in the state you select. The choices are:
State Ack Description
Status
Alarm N Display points in alarm state that have not been
acknowledged.
Alarm Y Display points in alarm state that have been acknowledged.
Normal N Display points that have returned to a normal state, but
have not been acknowledged.
Select the check box for each state for which you want to filter.
Sort
You can use this option to select the primary sort parameter for the Alarm List. The
choices are:
Class Alarms in the selected classes are sorted, lowest to highest, in the
sort order assigned to each Alarm Class when it was created.
Resource Alarms in the selected resources are sorted alphabetically, lowest to
highest, by Resource ID.
State Alarms are sorted according to a combination of their State and Ack
Status in the following order:
1. All unacknowledged alarms in ALARM state
2. All unacknowledged alarms in NORMAL state
3. All acknowledged alarms in ALARM state
Time Alarms are arranged according to the time of their occurrence, with
the most recent first.
The default sort key is Time. If a category other than Time is selected as the
primary sort key, the secondary sort key is Time.
Click the radio button next to the sort order you want to use.
20-54 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Printing Alarms
The File menu contains three functions for printing the alarm list.
• Print Setup...
• Print Preview
• Print...
When you click on Print Setup..., the Print Setup dialog box opens. You can use
this dialog to select the printer, and the format for your alarm list printout.
When you click on Print Preview, the printout that will be generated is displayed.
You can zoom in for a closer look, step through the pages, or view the printout as
one-sided or two-sided. In addition, if you click on the Print... button, you can
access the Print dialog box.
When you click on Print..., the Print dialog box opens. You can use this dialog box
to select the print range, print quality, and number of copies. In addition, you can
click on the Setup... button in this dialog to access the Print Setup dialog box.
Copying Alarms
The Copy function on the Edit menu lets you copy selected alarms to the clipboard.
Once the alarm is on the clipboard, you can paste it in another window.
For example, if there is an alarm on the list that you want to include in an e-mail
message:
1. Select the alarm.
2. Select Copy from the Edit menu.
3. Go to the e-mail message you are creating.
4. Position the cursor in the message.
5. Select Paste from the Edit menu.
20-56 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Installing an Alarm Viewer Screen from the File
Manager
You can use the File Manager to install a shortcut for an Alarm Viewer screen.
Once you have done this, however, you should:
1. Select the shortcut.
2. Click the right mouse button to open the Windows pop-up menu.
3. Select Properties. The Properties dialog box for the screen opens.
4. On the Shortcut properties page, add amv.exe to the beginning of the
Target command line.
If you do not do this, the screen will take a longer time to start, and Alarm Viewer
will be forced to query the user about the project to be used.
to this:
amv.exe /noconfig C:\cimplicity\projects\proj\view.AMV
You can also use the command line to start multiple Alarm Viewer screens from a
single icon.
The following command line arguments are available for your use:
/noconfig
Does not allow the user to configure the count and list layouts on the screen.
The Count Layout and List Layout menu items are disabled on the Configure
menu.
Example:
amv.exe /noconfig C:\myproj\view.amv
20-58 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using CimView
About CimView
CimView is an interactive graphical user interface to help you monitor and control
your facility. It displays the screens that were created with CimEdit.
Your data can be displayed and monitored as text or a variety of graphic objects.
Both text and graphic objects can automatically change color, move, and rotate based
on the data collected.
CimView screens can also have a variety of interactive control functions that let you
set point values, display other graphic screens, initiate custom software routines and
start other Windows applications.
Getting Started
There are many ways to start a CimView session. Here are some:
• Your CimView session may be configured by your System Manager to
automatically start when you login.
• You can select a CimView icon that is in your project folder or on the
desktop.
GFK-1180 21-1
Window Components
The CimView window has several components that have been labeled in the above
figure.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Open a CimView screen in the current or a new window.
• Print the current screen.
• Flush cached screens.
• Enable/disable the Toolbar, Status Bar, and Menu/Title Bar.
• Toggle and zoom the screen size.
• Display help.
Depending on the configuration set up by your System Manager, you may not see all
of these window components, and you may not have access to all of these functions.
For example, in many installations the title bar, menu bar, toolbar, and status bar will
be hidden, and the CimView window will occupy the entire terminal screen.
21-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Menu Bar
The Menu Bar displays the menus that you will use to control most of your work in
CimView.
Title Bar
The Title Bar displays the filename of the screen you are currently displaying. You
can also use it to move the CimView window.
When you click the right mouse button in the Title bar, a menu of standard window
functions is displayed. You can use these functions to move, resize, lower, or close
the window.
Window Buttons
When you click on the Minimize button, you will minimize the window.
The minimized window is hidden. To restore the window, click on its button in the
task bar.
When you click on the Maximize button, the window will be resized to take up the
entire terminal screen. When the window is maximized, the Maximize button is
replaced by the Restore button.
When you click on the Restore button, the window will be restored back to its old
size.
Scroll Bars
Use the vertical scroll bar to move the screen up and down if it doesn’t fit in the
window.
Use the horizontal scroll bar to move the screen back and forth if it doesn’t fit in the
window.
Status Bar
The Status Bar displays information about your current viewing operation, and is
divided into four areas:
Message Area Displays informational messages about options that you
select or about operations that you perform.
Cursor Location Displays the X,Y coordinates of the current cursor
location in points.
Toolbars
A toolbar is a frame containing a set of controls. Generally, toolbars are used to
provide quick access to specific commands or options. These commands or options
are usually also available in the menus. CimView uses a Standard toolbar.
21-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Send Sends a copy of the screen file to someone via
electronic mail.
This function sends a copy of the screen file that can
be opened and displayed in CimView.
To send a picture of the current screen contents, use
Alt+Print Screen to copy a bitmap picture of the
current window to the clipboard, then Paste the
bitmap into a mail message.
Recent screens Lists the most recent screens you have displayed in
the CimView window. You can redisplay any of
these screens just by clicking on them. The list will
hold up to nine screens.
Exit Exits the current CimView window.
21-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using the Help Menu
When you select the Help menu, the following drop-down menu is displayed:
Print Prints the screen. Unlike the Print menu item, it does
not display a dialog box first. The screen is
immediately printed.
Help Changes your cursor and allows you display Help for
selected objects, groups, buttons, menus, and screens.
Previous Displays the previous screen in this window.
21-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
This toolbar is a movable toolbar. You can either display it in a separate window
(also called a floating toolbar), or you can align it to one of the edges of the
CimView window at your discretion (this is also called a docked toolbar).
If you are using a floating toolbar, you can close the Toolbar window by clicking the
Window Menu button on the toolbar.
If you have closed the Toolbar window, you can restore it by clicking Toolbars on
the View menu. When the Options dialog opens, click the Standard toolbar, and
then click OK.
When you look at a screen in CimView, it consists of a set of objects. There are
many types of objects. Among them are:
• Text objects that display text information or point values.
• Graphic objects that represent facility resources and conditions.
• ActiveX controls.
Objects can be static, or they can be animated. CimView can display objects with
movement, rotation, fill, size, or color change animation.
21-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
An object can also be configured to perform procedures. A procedure may consist of
one or more of the following actions:
Absolute Setpoint Close Screen Execute Command Home Screen
Invoke Method Invoke Script Open Screen Overlay Screen
Previous Screen Ramp Setpoint Relative Setpoint Toggle Setpoint
Variable Setpoint Variable Assign
In addition to the actions that may be included in procedures, the Slider action may
be configured for object movement and Text objects may be configured for Setpoint
value animation (also known as in-place edit setpoints).
Consult with your CIMPLICITY system manager or project integrator about the
special features of the screens you will be using.
• Use the arrow keys to highlight the closest object in the direction of the
arrow key. Selection occurs only between active action objects.
If you are currently using a Slider setpoint, the arrows affect the
setpoint, not the selection of another action object.
21-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Setpoint Object Selected with the Keyboard
Once you have highlighted an object with a Slider setpoint action with the Tab,
Shift+Tab or arrow keys, do the following to perform the action:
1. To activate the arrow keys for the Slider setpoint action, press Enter.
2. Once the arrow keys are activated for the Slider setpoint action, you
will no longer be able to move the object with the mouse or use the left
mouse button to select other objects.
3. Use the Up and Down arrows for vertical slider actions, and use the
Left and Right arrows for horizontal slider actions. As you use the
arrow keys, the object will move in the direction you choose, and the
proposed setpoint value will be displayed in the Status Bar message
area.
To move the object by one pixel, press an arrow key. The direction of
the key defines the direction of the movement.
To move the object by ten (10) pixels, hold down the Ctrl key, then
press an arrow key.
4. Use the Esc key to cancel the slider action.
5. Use the Enter key to accept the slider action, and perform the setpoint.
The new value for the point will be displayed in the Status Bar.
Use the Toolbars properties to select the toolbar to be displayed in your CimView
window. You can also toggle the display of color buttons and ToolTips.
The Toolbars input box shows you the special toolbars available for CimView, and
lets you select the ones to display. Note that the only toolbar currently available is
the Standard toolbar.
The Color Buttons check box lets you enable or disable the display of toolbar
buttons in color.
The Show ToolTips check box lets you enable or disable the display of ToolTips
on the toolbars. When ToolTips are enabled and you move the cursor into a button
on the Toolbar, you will see the button name in a box next to the cursor, and a
description of the button in the Status Bar at the bottom of the window.
21-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Displaying CimView Help Information
Help information can be defined for a screen and for objects on the screen in
CimEdit. Help information, when you request it, can be displayed in one of three
ways, depending on how it was generated:
• Text information that was entered on the property sheets will be
displayed in a dialog box.
• If the text was placed in a text file, it will be displayed in a Notepad
window on your screen.
• If the text was placed in a Help file generated by the Help compiler, it
will be displayed in a Help window on your screen.
21-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Displaying CimView Object Properties
You can display object properties for non-static objects. Non-static objects have one
or more of the following configured:
• Animation
• Events
• Help
You cannot define or modify object properties in CimView, but you can display
them. To display object properties:
1. Move the mouse cursor to the object.
2. Hold down the right mouse button.
3. Select Properties from the drop-down menu.
When you are finished looking at the properties, click OK or Cancel to close the
dialog box and return to your screen.
For example, if you want to display your CimView screens in a window without a
Menu Bar and Title Bar, the command line would look like this:
cimview.exe /nomenutitle c:\cimplicity\projects\proj\ini.cim
If multiple CimView screens are launched from a single command line and
command line options are used, the first screen in the list is the primary window. For
example, if /alwaysmaximized is used, the first screen in the list will be
maximized, and all other screens will be displayed in their normal windows.
The following command line options can be associated with a CimView icon:
/alwaysmaximized
Displays the primary CimView window in a maximized state. You will not be
allowed to resize the primary window. The window will not rise to the top when you
click on it (this prevents it from obscuring other windows on your terminal screen).
This option is only applied if it is used with the first CimView window opened. This
window is known as the primary window. If used with subsequent open commands,
it will be ignored.
/geometry <width>x<height><±xoff><±yoff>
Sizes and positions the CimView window when it opens. The screen is sized to fit
the window. All fields are in pixels.
The arguments for this command line option are:
<width> specifies the window width.
<height> specifies the window height.
<+xoff> specifies the offset from the left edge of the terminal screen and
<-xoff> specifies the offset from the right edge of the terminal screen.
<+yoff> specifies the offset from the top edge of the terminal screen and
<-yoff> specifies the offset from the bottom of the terminal screen.
Example:
cimview.exe /geometry 200x200+100+200 C:\myproj\scr.cim
opens the screen in a 200x200 window that is 100 pixels from the left side of the
terminal screen and 200 pixels from the top edge of the terminal screen
/keypad
Displays a keypad window on the user’s screen whenever the user has to perform a
Variable Setpoint action in a procedure. To enter a new setpoint value, the user
clicks on the appropriate keys in the keypad window rather than entering them from a
keyboard.
This option is only applied if it is used with the first CimView window opened. This
window is known as the primary window. If used with subsequent open commands,
it will be ignored.
Example
cimview.exe /keypad C:\myproj\scr.cim
/noexit
Will not let you exit the primary CimView window.
The Exit menu item is removed from the File menu, and the Close menu item and
its Alt+F4 shortcut key are removed from the Control menu. Close Screen actions
are ignored in the primary window.
This option is only applied if it is used with the first CimView window opened. This
window is known as the primary window. If used with subsequent open commands,
it will be ignored.
Example:
cimview.exe /noexit C:\myproj\scr.cim
21-18 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
/nomenutitle
Removes the Menu Bar and Title Bar from the primary CimView window and all
subsequent windows that you open.
This option is applied to the new windows and also any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the option is disabled for those windows and any new windows opened from
within CimView.
Example:
cimview.exe /nomenutitle C:\myproj\scr.cim
/noopen
Lets you open only the CimView screens that are explicitly mentioned in Open
Screen and Overlay Screen actions. Open Screen and Overlay Screen actions that do
not specify a screen are ignored.
In addition, the Open and Open Window menu items and the file list are removed
from the File menu, and the File Open Toolbar button is disabled.
This option is applied to the new windows and also any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the option is disabled for those windows and any new windows opened from
within CimView.
Example:
cimview.exe /noopen C:\myproj\scr.cim
/noresize
Prevents you from resizing any CimView windows that you display.
This option is applied to the new windows and also any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the option is disabled for those windows and any new windows opened from
within CimView.
Example:
cimview.exe /noresize C:\myproj\scr.cim
/project <name>
Sets the base project to <name>.
The data for all unqualified points on the windows that you display will be requested
from the named project.
This option is applied to the new windows and also to any windows that are opened
from within CimView. If a later CimView command is executed without the
option, the previous value for the default project continues to be used.
Example:
cimview.exe /project myproj C:\myproj\scr.cim
/waitforproject <name>
Makes CimView wait for the project to start before opening the window
Example:
cimview.exe /waitforproj myproj C:\myproj\scr.cim
/zoomtobestfit
Initially places the primary CimView window in Zoom To Best Fit mode. All
subsequent windows are also displayed in this mode.
This option is applied to the new windows and also any windows that are opened
from within CimView.
Example:
cimview.exe /zoomtobestfit C:\myproj\scr.cim
21-20 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using the Point Control Panel
Getting Started
To open a Point Control Panel window, select the Point Control Panel icon in your
CIMPLICITY HMI menu.
The initial Point Control Panel window opens.
To display a new, empty list, select New from the File menu.
GFK-1180 22-1
To display a saved Point Control Panel document, select Open from the File menu,
or, if the document is in the list of recent files, just click on the file name in the list.
To print the current state of the Point Control Panel, select Print from the File
menu. If you want to see what your printout will look like, select Print Preview. If
you need to change the printer, paper type or page orientation, select Print Setup….
Point Control Panel To save a Point Control Panel document, select Save from the File menu. When
documents are saved with the the Save As dialog box opens, enter a file name for the file and select OK. By
extension .PPL default, Point Control Panel documents are placed in the main CIMPLICITY HMI
directory, but you can select another directory.
To exit the Point Control Panel, select Exit from the File menu.
To add points to the list, select Add… from the Edit menu.
To display the properties of a point, select it, then select Properties from the Edit
menu.
To delete a point from the list, select it and press Delete or select Delete from the
Edit menu.
To change the font colors for point alarming, select Colors from the Font menu.
You may see the following icons displayed next to points in the Point Control Panel:
This icon is displayed if the point is not valid.
This icon is displayed after you successfully disable alarming for a point.
This icon is displayed after you change the current alarms limits for a point.
Displaying Points
When you select Add… from the Edit menu or press Ctrl+A, the Select a Point
browser opens.
Select the project from which you want to display points. To request a list of all
points, just select Browse. To refine the list, you can enter search strings for Point
ID, Device ID, Resource, Point Type or Description, then select Browse.
When the list of points displays in the list box, select the ones you want to display,
then select OK.
The Select a Point browser closes and the Point Control Panel redisplays with the
points you selected. All the points you requested are automatically selected in the
Point Control Panel so that you can just look at them, and then delete them from the
view if you wish.
The current value, units and timestamp for each point are displayed in the Point
Control Panel. If a point is in an alarm condition, its text is displayed in the
appropriate color.
You can display point properties for each point in the list. You can also perform a
setpoint, enable/disable alarming and set new alarm limits for each point in the list.
22-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Displaying Point Properties
To display properties for a point, you can do one of the following:
• Double-click on the point in the list.
• Select the point, then select Properties from the Edit menu.
• Select the point then press Alt+Enter.
The Point Properties dialog box opens. Use this dialog box to view point details and
alarm information. You can also perform a setpoint, enable/disable alarming and set
new alarm limits.
Note
If the point has no alarming or has On update alarming, the Alarm property page
does not appear in the dialog box.
Details
This property page shows you the Point Type and Resource for the point, its access,
display limits, current value and units and password.
Use this property page to perform a setpoint on the point’s value. To do this, enter
the new value in the Set Value field and select Apply or OK. If you select Apply,
the dialog remains open. If you select OK, the dialog closes. In either case, the
Point Control Panel is updated to reflect your changes.
The contents of this property page depend on whether you are viewing an Analog or
Boolean point type.
• For Analog point types, this property page shows you whether alarming
is enabled for the point and the configured and current alarm and
warning limits.
• For Boolean point types, this property page shows you whether
alarming is enabled for this point and the configured alarm state.
Use the Alarm Enabled field to enable or disable alarming for the point. If you
disable alarming, the Disabled icon - - displays next to the point in the Point
Control Panel main window. If the point is already in an Alarm state and you disable
it, the state is reset to Normal. If you enable alarming for a point that is already in an
Alarm state, the alarm is generated.
Use the Current fields in the Alarm Limits section to change alarm limits. If you
change alarm limits, the Modified icon - - displays next to the point in the Point
Control Panel main window.
After you change alarm information on this page, you can select Apply or OK to
have the changes take place. If you select Apply, the dialog box remains open. If
you select OK, the dialog box closes. In either case, the Point Control Panel updates
to reflect your changes.
To return to configured alarm limits, select Restore Alarm Limits.
22-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Changing Font Colors
When you select Colors from the Font menu the Font Color dialog box opens.
You can set the foreground (text) and background colors for the following states:
Normal Points that are in normal state display with these colors
Warning Points that are in Warning High or Warning Low state
display with these colors
Alarm Points that are in Alarm High or Alarm Low state display
with these colors
Wait for response Points for which the Point Control Panel is waiting for a
response display with these colors.
To change a color, click the drop-down list button to the right of the color you want
to change. When the palette opens, select the basic color or custom color you want,
and then select OK.
After you have defined your display colors, select OK to close the Font Color dialog
box closes and redisplay the Point Control Panel in the colors you have selected.
Select Cancel to close the dialog box without making any changes.
Point Control Panel Enter the file name you want in the File name field, then select the full path name
documents are saved with the for the document. Select Save to save the document. The document is saved in the
extension .PPL directory you specify.
You can then select the document and create a shortcut for it on your desktop or in a
start menu.
22-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using the CIMPLICITY To
Windows Server (DDE)
GFK-1180 23-1
Microsoft Excel Example
The syntax for a CWSERV command in a Microsoft Excel spreadsheet, is:
=cwserv|point!<point_id>.<attribute>[n:mD]
where:
<point_id> is the CIMPLICITY Point ID whose data is being retrieved.
You may enter an unqualified or fully qualified (by project or
node name) Point ID.
<attribute> is the point attribute of interest. If you do not enter an attribute,
CWSERV uses "VALUE" as the default.
n:m is the range of array elements desired . If you do not enter a
range, CWSERV uses "[0]" as the default.
Enter "[n]" to specify a single element of an array.
D If you have requested a range of elements, use this field to
specify the display format. Enter "C" to display the elements in
a column, or "R" to display the elements in a row. If you do
not enter a display format, CWSERV uses "C" as the default.
23-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Point Topic Attributes
The following point attributes can be displayed:
• VALUE
• RAW_VALUE
• STATE
• TYPE
• LENGTH
• ELEMENTS
• SIZE
• DISP_FORMAT
• EU_LABEL
• ALARM_HIGH
• ALARM_LOW
• WARN_HIGH
• WARN_LOW
• DISP_HIGH
• DISP_LOW
• INIT_STATE
• ALARM_ENABLED
• WARN_ENABLED
VALUE
Displays the converted (EU) value of the point. If there is no conversion, the raw
value is displayed. If you do not enter an attribute in the CWSERV command, this is
the default attribute that is displayed.
RAW_VALUE
Displays the raw value of the point.
STATE
Displays the current state of the point.
The point’s current state depends on its point class and alarm conditions.
For all point classes, the states that can be displayed are:
NORMAL The point’s value is within normal limits, and no alarms
are outstanding.
UNAVAILABLE If the point is a device point, communications with the
device have failed, and the point can no longer be read.
If the point is a virtual point, one or more of the source
points that comprise this point is unavailable.
For Analog and APPL point classes, the additional states that can be displayed are:
ALARM HIGH The point’s value is greater than the high alarm limit.
ALARM LOW The point’s value is less than the low alarm limit.
WARNING HIGH The point’s value is greater than the warning high limit
23-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
WARNING LOW The point’s value is less than the warning low limit and
greater than the alarm low limit.
OUT OF RANGE The point is an Analog or APPL device point with
engineering units conversion, and its value exceeds one of
its conversion limits.
For the Digital (Boolean) point class, the additional states that can be displayed are:
ALARM The point’s value is in the alarm state.
WARNING You will only see this message if Enable Alarms has been
reset, Enable Warning is set, and the point’s value is in the
alarm state.
TYPE
Displays the point’s type. You will see one of the following:
• BOOLEAN
• BITSTRING
• OCTETSTRING
• CHARACTERSTRING
• UNSIGNED INTEGER 1
• UNSIGNED INTEGER 2
• UNSIGNED INTEGER 4
• INTEGER 1
• INTEGER 2
• INTEGER 4
• FLOATING POINT
• STRUCTURE
Note
OCTETSTRING points are not currently supported by CWSERV. If you try to
display such a point’s VALUE or RAW_VALUE attribute, "#NAME?" will be
displayed on the Excel spreadsheet.
LENGTH
Displays the length of the point. This field is only meaningful for the following point
types:
• BITSTRING
• OCTETSTRING
ELEMENTS
Displays the number of elements contained in the point.
SIZE
Displays the size of the data.
DISP_FORMAT
Displays the format used when displaying the point’s value in Alarm Viewer, Status
Log messages, or CimView.
ALARM_HIGH
Displays the Alarm High value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point’s value exceeds this number, the point is in ALARM HIGH state.
ALARM_LOW
Displays the Alarm Low value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point’s value is less than this number, the point is in ALARM LOW state.
WARN_HIGH
Displays the Warning High value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point’s value is greater than this number, but less than the Alarm High
number, the point is in WARNING HIGH state.
WARN_LOW
Displays the Warning Low value for the point. This field is only valid for the
following point types:
• ANALOG
• APPL
If the point’s value is less than this number, but greater than the Alarm Low number,
the point is in WARNING LOW state.
DISP_HIGH
Displays the high limit for the display value for this point. This field is only valid for
the following point types:
• ANALOG
• APPL
DISP_LOW
Displays the low limit for the display value for this point. This field is only valid for
the following point types:
• ANALOG
• APPL
23-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
INIT_STATE
Indicates whether the point is enabled or disabled. You will see one of the following
values:
0 The point is disabled
1 The point is enabled.
ALARM_ENABLED
Indicates whether high/low alarms are enabled or disabled for this point. You will
see one of the following values:
0 High/Low alarm messages are disabled for the point.
1 High/Low alarm messages are enabled for the point.
WARN_ENABLED
Indicates whether high/low warnings are enabled or disabled for this point.
0 High/Low warning messages are disabled for the point
1 High/Low warning messages are enabled for the point.
This dialog box will also be displayed if you open a spreadsheet that contains
CWSERV commands and the CWSERV server is not active.
Click Yes to start CWSERV.
This dialog box will appear every time you open the spreadsheet:
Click Yes to reconnect to CWSERV to access data. If CWSERV is not running, you
will be asked if you want to start it. Click Yes to start CWSERV.
If you are connecting to the project for the first time, or your login timeout has
expired, the CIMPLICITY Login dialog box for the project is displayed.
Enter your CIMPLICITY username and password and click OK. Your spreadsheet
will now start to display the CIMPLICITY data you requested in the CWSERV
commands.
CWSERV Icon
While the server is active, you will see this icon on your terminal screen:
23-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Modifying Point Data
You can write Excel macros to update setpoints in CIMPLICITY software from a
spreadsheet. These macros will use the DDE POKE request. You can use this
request to change the value or raw_value attributes of a CIMPLICITY point.
Important
Setpoint security is not enforced. A user can set any CIMPLICITY point
that has write access, regardless of the setpoint security restrictions
configured within the CIMPLICITY system. You must establish
appropriate operational practices and procedures to prevent undesired
setpoint operations, and users must follow these practices and
procedures carefully.
Macro Format
The format for a Microsoft Excel macro that performs a setpoint is:
• Enter the macro name on the first line.
• Enter channel=INITIATE("cwserv","point") on the second
line to open the CWSERV channel.
• Enter =POKE(channel, "<point_id>.<attribute>",
<sheet location> for each setpoint you want to perform.
• Enter =TERMINATE(channel) to close the channel.
• Enter =RETURN() to terminate the macro.
An example of such a macro is:
set_point
channel=INITIATE("cwserv","point")
=POKE(channel,"cwserv_virt.value",Sheet1!R17C3)
=TERMINATE(channel)
=RETURN()
Performance Considerations
When you perform a large number of DDE POKE requests from an application such
as Microsoft Excel, the DDE server application may fall behind. Under Excel, this
will cause some requests to timeout and fail.
23-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Sample Spreadsheets and Macros
Two spreadsheet and macro sets are given here. The first spreadsheet and macro
show you how to display all the attributes of a single point, and perform a setpoint on
that point. The second spreadsheet and macro show you how to display the raw
values for an array point and perform a setpoint on the entire array.
To change the setpoint, enter the new point value in cell R19C3, then click Set.
Array Point Example
The following spreadsheet was configured to display the raw values for
CWSERV_ARRAY, an array point with ten (10) elements, and to let a user perform
a setpoint on the array:
To create the display, cells R5C3 through R14C3 were selected, and the following
formula was entered:
=cwserv|point!’cwserv_array.raw_value[0:9c]’
To change the setpoint, enter the new values in R5C4 through R14C4, and click Set.
23-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Command Syntax for System Topic
The System topic contains information about CWSERV. You can display:
• Formats supported by CWSERV.
• System items supported by CWSERV.
• Topic supported by CWSERV.
• Help information about CWSERV.
Formats
CWSERV currently supports the CF_TEXT format.
To display format information on a Microsoft Excel spreadsheet:
1. Select one (1) cell in the spreadsheet.
2. Type the following formula in the cell and press Enter:
=cwserv|system!formats
The resulting display should look like this:
CF_TEXT
System Items
CWSERV currently supports four system items - Formats, Help, SysItems, and
Topics.
To display system item information on a Microsoft Excel spreadsheet:
1. Select four (4) rows in one column in the spreadsheet.
2. Type the following formula in the first cell and press
Ctrl+Shift+Enter.
=cwserv|system!sysitems
The resulting display should look like this:
Formats
Help
SysItems
Topics
Topics
CWSERV currently supports two topics - Point and System.
To display topic information on a Microsoft Excel spreadsheet:
1. Select two (2) rows in one column in the spreadsheet.
2. Type the following formula in the first cell and press
Ctrl+Shift+Enter.
=cwserv|system!topics
The resulting display should look like this:
System
POINT
23-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Error Messages
If the VALUE or RAW_VALUE field displays "******", there is a problem reading
the point data from the device.
If a field displays "#N/A", the attribute you requested does not contain a value.
If a field displays "#NAME?", you can have one of several problems; for example:
• You have entered an invalid Point ID or attribute name.
• The attribute is not supported by the point type.
• CWSERV does not support the point type for value displays.
When you see a "#NAME?" error in a field, check your project’s Status Log file for
detailed information on the cause of the problem.
23-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
System Utilities
GFK-1180 24-1
Using Show Users
Show Users is an interactive process that lets you show the users on the various
CIMPLICITY HMI projects running on your network.
24-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Show Users Menu Options
You can use the menu options to open a project, toggle the Toolbar and Status bar
displays, change display attributes, and access Help.
24-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Show Users Toolbar Buttons
The Toolbar buttons available to you are:
Open Opens a project.
24-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
To open a project window, you can do one of the following:
• Double-click on a project in the list.
• Select a project in the list, then select Open.
• Enter a project name in the Project field, a node name in the Node
field, and then select Open.
After you select the project, the Open dialog box closes, and you are prompted to log
in to the project.
After you have logged in to the project, a subwindow for the project is displayed in
the Show Users window. The title bar for the subwindow displays the Project name
and node name of the computer on which the project is running.
The subwindow for the project displays the User ID, Role, Node and Process ID of
every CIMPLICITY user that is logged in to that project. The information in the
subwindow updates as users log in and out of the project.
24-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using the Login Panel
The Login Panel is an interactive process that lets you monitor the state of all remote
and local connections on your computer. It shows the status of projects for which
there is an active connection. An active connection is made by an application on
your computer that is collecting point or alarm data.
You can use this process to:
• Logout of a CIMPLICITY HMI project
• Override the current login
• Change your CIMPLICITY user password
• Manage your saved logins
These actions do not require that you exit from any applications that are currently
running. For example, if you are a supervisor, you can now override the login and
privileges of an operator, log out, and return the system back to the operator’s logged
in state.
When you log out of a project, data collection and background processing continues.
However, any open CIMPLICITY HMI screens will no longer show point status.
For each project that users are logged into on this computer, the Node ID for the
project, Project ID, user name, login status, and type are displayed.
From this window, you can:
• Select a logged in project and log out.
• Select a logged out project and log in.
• Use the Edit menu to manage your saved logins.
24-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
The Help Menu
When you select the Help menu, the following drop-down list displays:
Logging in to a Project
To log in to a project:
1. Select the project from the list of projects (its status must be "Logged
out").
2. Select Login from the Project menu or click the Login button -
- on the Toolbar. The CIMPLICITY Login dialog box opens.
3. Enter the Username and Password for the user you want to be when
viewing screens for the project.
CIMPLICITY HMI software logs you in to the project as the user you designate. All
CimView screens connected to this project will now have their animation objects
enabled.
Note
The screen itself may change if visibility animation has been enabled for objects and
keyed to User ID and Role ID information.
24-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Changing Password
Note
The dialog box displays the current project and your User ID.
To change the password:
1. Enter the current password in the Old password field. As you type,
asterisks will display.
2. Enter the new password in the New Password field. As you type,
asterisks will display.
3. Enter the new password again in the Confirm field. As you type,
asterisks will display.
4. Select OK to accept the new password or select Cancel to not change
the password.
When you are through with this dialog box, select Close to close it and return to the
Login Panel window.
2. Select the project you want to apply the login to in the Project field.
Use the drop-down list button to display the list of available projects in
your enterprise.
3. Enter the username for the login in the User field.
4. Enter the password in the Password field and confirm it in the
Confirm field.
5. Select OK to activate the new saved login, or select Cancel to exit this
dialog box without saving the information you entered.
After you activate the new saved login, whenever you open a screen in this project,
you are automatically logged in to the project.
24-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Removing a Saved Login
To remove a login from the list of saved logins:
1. Select the login in the list.
2. Select Remove.
The login information is deleted from the Registry.
If you are currently displaying any screens that require this login, they are not
affected. If you exit a screen that requires the login, then try to reopen it, the
CIMPLICITY Login dialog box opens and you are asked for a username and
password.
You can use the Browse button to search for a project to start. Once you have
selected a project, you can:
• Select OK to start the project.
• Select Start as Viewer to start the project as a Viewer project.
When you start the project, the normal startup dialogs are displayed.
You can also select Cancel to close the dialog box without starting a project. When
the dialog box closes, the Program Control process terminates.
24-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Using CIMPLICITY Program Control
When the CIMPLICITY Program Control dialog box opens, you are given the
opportunity to connect to a project.
To connect to a project:
1. Click the drop-down list button to the right of the System input field.
A list of currently running projects that are broadcasting is displayed.
2. Select the project you want to connect to.
3. Select Connect.
4. If you are not currently logged in to the project, you are prompted for a
Username and Password.
The CIMPLICITY Program Control window redisplays with the list of process names
and statuses for the project you selected.
24-18 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
CIMPLICITY HMI Processes
The following table lists the Process IDs for all base system and product options for
CIMPLICITY HMI processes. The set of options running on a node depends on the
communication protocols, printers, and product options you have installed.
AMRP Alarm Management Resident Process
DA_RC Historical Data Analyzer Recalculation Process
DA_RP Historical Data Analyzer Resident Process
DL_RP Data Logger Resident Process
DYNCFG Dynamic Configuration Process
EM_EP Event Manager Event Processor
EM_RP Event Manager Resident Process
<node>_<port> Device Communications Interfaces
<node>_<printer_name> Alarm Manager Line Printer Process
<node>_PTDP_RP Point Management Virtual Point Resident Process
<node>_PTM<n>_RP Point Management Resident Process
PDC_DS Tracker - Decision Control Data Server
PRT_DC Tracker - Tracking Data Collector
PRT_DS Tracker - Tracking Data Server
PRT_GRD Tracker - Tracking Graphic Display
PTDL_RP Point Data Logger Resident Process
PTX_RP Point Translation Resident Process
UR_RP User Registration Resident Process
If the process starts successfully, its status in the process list changes from "Halted"
to "Running".
If the process stops successfully, its status in the process list changes from "Running"
to "Halted".
If the processes start successfully, their status in the process list changes from
"Halted" to "Running".
24-20 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Stopping All Running Processes
To stop all running process:
1. Select Stop All.
2. When the following dialog box opens, select Yes to confirm that you
want all processes to stop.
If the processes halt successfully, their status in the process list changes from
"Running" to "Halted".
GFK-1180 25-1
Using the Status Log Viewer
To display a Status Log, you can do one of the following:
• Select the Status Log icon from the CIMPLICITY HMI menu.
• In a project cabinet, select Status Log from the Tools menu.
• In a project cabinet, press Ctrl+L.
The CIMPLICITY Log Viewer window opens.
Remember that the Status Log file that is displayed depends on whether you initiated
the CIMPLICITY Log Viewer from a project or the CIMPLICITY HMI main menu.
The CIMPLICITY Log Viewer screen displays the following information for each
record that it finds in the status log file:
Date/Time The date and time the message was logged.
Status The type of message. This can be "Failure", "Warning" or
"Success".
Process The name of the process that generated the log message.
Procedure The name of the procedure that generated the log message.
Source A symbolic name for the error class.
Code The primary value used by software for expressing the type of error.
Reference A number (shown as a decimal integer) that can be used to
determine the location of the condition that caused the error.
Message An explanation of the condition that caused the log message.
Each entry in the list is preceded by a color-coded dot that corresponds to the Status
field entry. The correlations are:
• Red - Failure
• Yellow - Warning
• Green - Success
25-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
The Procedure, Source, Reference, and Code fields are primarily for GE Fanuc
use and should be reported if you are contacting GE Fanuc for troubleshooting
assistance.
The list of messages is initially sorted in descending order (newest to oldest) by
Date/Time. You can click on any of the column title buttons to sort the messages
alphanumerically by that message attribute. For example, if you want to view all the
messages generated by the MAC_PTDL process, click the Process button, and all
the messages generated by MAC_PTDL will be grouped together.
You can use the Menu functions, Toolbar buttons, and shortcut keys to:
• Select a log file to view.
• Clear the current log.
• Save the log file as a text file.
• Print the contents of the log file.
• Filter the log entries.
• Select the display order of messages.
• Find a particular message.
• Enable/disable live updates.
• Refresh the list when live updates are disabled.
25-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Find Next If you selected Find previously, this command locates the
next entry based on the information you entered. If you
have not entered any Find parameters, this command
locates the next entry in the log file.
Detail... Displays all of the detailed information for the selected log
message.
Live Update Automatically updates the Status Log list as messages are
generated. Note that you cannot display message details
when in this mode.
Refresh Refreshes the Status Log list on request. This option is
available when Live Update is disabled. In addition, you
can display message details when in this mode.
Toolbar Enables/Disables the display of the Toolbar at the top of
the screen.
Status Bar Enables/Disables the display of the Status Bar at the
bottom of the screen.
The Status Log Viewer can display CIMPLICITY HMI Status Log files of type
.CLG. You can search the directory structure on any drive you are connected to for
log files.
The default Status Log file name is COR_RECSTAT.CLG. Status Log files are
generally found in the log file for your main CIMPLICITY HMI log directory, and in
each of your project’s log directories.
To display a log file:
1. Locate the file in your CIMPLICITY HMI main log directory or a
project log directory.
2. Click OK.
3. The dialog box closes, and the file you selected is displayed in the
CIMPLICITY Log Viewer window.
25-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Displaying Status Log Message Details
To view all the details of a particular message, you can do one of the following:
• Double-click on the message.
• Select the message then press Ctrl+D.
• Select the message, and then select Detail from the View menu.
The Detail dialog box opens and displays the details for the message you selected.
To create a text file, select a pathname and file name for the text file and click OK.
The first line of the text file shows the computer name and the full path name for the
Status Log file.
25-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Printing the Status Log File
You can print all entries in a Status Log file, or selected pages.
To print the contents of the Status Log file you are currently displaying, select Print
from the Log menu. The Print dialog box opens.
25-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Filtering the Status Log Messages
A Status Log file can contain up to 1,000 messages. If you are looking for a
particular set of messages, you will find it useful to filter the file to display only the
messages that are currently of interest to you.
To initiate filtering, select Filter Entries from the View menu. The Filter System
Entries dialog box opens.
25-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
To locate the entry in the Status Log, click Find Next. The dialog box closes, and
the next message in the Status Log that matches the filter is highlighted. If no
message is found, the highlight remains at the current message.
Note
The Find and Find Next options will not wrap around the message list when they
reach either end.
For example, if you are searching Down and you are already at the end of the
message list, when you activate the search, you will not be asked if you wish to
continue from the beginning of the list.
To close the dialog box without finding a message, click Cancel.
To clear the filters, click Clear, and then click OK.
25-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
TCPRD<n> Series 90 TCP/IP redundancy where <n> is the port number.
W32RTR Message Router
In addition to these files, you may also find files for alarm log printers and device
communication drivers.
To view the contents of an .ERR or .OUT file:
1. Stop the project.
2. Use the Explorer to check for any non-zero length .ERR and .OUT
files in the project’s log directory.
3. Use Notepad to look at the contents of these files.
Global Parameters
The Global Parameters file is used to define parameters for the CIMPLICITY Base
System and options that override default parameters in the software.
Some global parameters can be changed through user interfaces in CIMPLICITY
HMI Configuration functions. You should not change these parameters manually.
Some global parameters can only be implemented or changed by editing the Global
Parameters file.
Of the global parameters that you implement manually, some are implemented for all
projects on the computer, and some are implemented for individual projects.
GFK-1180 26-1
2. Find the parameter you want to change, and make the change.
3. Save the modified file.
4. Exit the Notepad.
5. Type scpop glb_parms. A new binary version of the Global
Parameters file will be produced and put in the master directory.
6. Type exit to exit the Command Prompt window.
When you are ready to implement the change in the run-time system, you will have to
stop the project(s), perform a Configuration Update, and restart the project(s).
DBDL_DEVICE_CHECK_PERIOD
Use the Disk full scan rate (min) parameter in the Logging Properties dialog box
in Database Logging to change this parameter.
DB_QUEUE_SIZE
Use the Database queue size parameter in the Logging Properties dialog box in
Database Logging to change this parameter.
DOWNLD_PASSWD
Use the Set Point Password input area of the Point Properties dialog box in Point
Configuration to change this parameter.
GMR_HRTBT_TIMER
Use the Heartbeat Timer field of the TCP/IP Port Properties for a redundant Series
90 TCP/IP port.
GMR_MODE_ADDR
Use the Mode Address field of the TCP/IP Port Properties for a redundant Series
90 TCP/IP port.
PTDL_QUANTIZATION
Use the Point data logging scan rate input area of the Logging Properties dialog
box in Database Logger to change this parameter.
26-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
RTR_ACCEPT_CONN
Use the Accept Connections field of the CIMPLICITY Options dialog in the
CIMPLICITY program group to change this parameter.
RTR_DISABLE_BCAST
Use the Enable Project Broadcast field of the Project Properties dialog box in
the Configuration cabinet to change this parameter.
RTR_STANDALONE
Use the Stand Alone field of the CIMPLICITY Options dialog in the CIMPLICITY
program group to change this parameter.
SETPOINT_SECURITY
Use the Set Point Security field of the Point Properties dialog box in Point
Configuration to change this parameter.
STARTUP_TIMEOUT
Sets the number of minutes to wait before timing out when starting up a project.
Record format is:
STARTUP_TIMEOUT|3|<minutes>
SYSNAME
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The parameter contains the project name.
Record format is:
SYSNAME|1|<project_name>
CONNECT_DROP_PERIOD
The time in seconds before an inactive login connection is dropped by the project.
The time starts when all CIMPLICITY application windows have been exited. A
user who opens a CIMPLICITY application window during this time period will not
be required to log in to CIMPLICITY software again.
Record format is:
CONNECT_DROP_PERIOD|3|<period>
The default time in the distributed Global Parameters file is 600 seconds (10
minutes).
CONNECT_RETRY_PERIOD
Time in seconds to retry connection to a remote project.
Record format is:
CONNECT_RETRY_PERIOD|3|<period>
IPC_BCAST_INTERVAL
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The Router (IPC) System Name Broadcast Period in seconds.
Record format is:
IPC_BCAST_INTERVAL|1|<number>
26-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
IPC_QUEUE_SIZE
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The maximum number of messages buffered by the Router in its Router to
application queue. The first time a queue overflows, it logs the following message to
the Status Log:
Router to Application queue overflow on port <port_name>
Further queue overflows on the same port do not result in any more error messages.
When the queue overflows, if the new message is not a response required message, it
is dropped. If it is a response required message, it is enqueued by bumping the queue
size.
Record format is:
IPC_QUEUE_SIZE|1|<number>
REDUND_LINK_SLEEP
For Server Redundancy, you can use this parameter to make the Router wait a period
of time before creating the link to the slave node.
Record format is:
REDUND_LINK_SLEEP|3|<number>
RTR_MAX_OUTMESSAGE_COUNT
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The maximum number of messages buffered by the Router for a Router to Router
link. If the queue overflows, the Router drops new messages. When it drops the first
message, it logs the following error to the Status Log:
Router dropped offnode message to <remote_node_name>
Further dropping of messages to the same node do not result in additional error
messages as long as the remote node stays active.
If the entry does not exist, a default value of 1000 is used.
Record format is:
RTR_MAX_OUTMESSAGE_COUNT|3|<number>
ACK_TOUT
The time in minutes before an alarm is automatically acknowledged by the Alarm
Management Resident Process. If this parameter is defined, it is the default used for
Acknowledge Timeout in the Point and Alarm Alarm Options properties. If this
parameter is not defined, zero is used for the default.
Record format is:
ACK_TOUT|3|<minutes>
The default timeout in the distributed Global Parameters file is 0 (no automatic
timeout).
26-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
AM_RESET_ACK_STATE
In Alarm Management, when an alarm with the Acknowledge and Reset deletion
requirement have been acknowledged and transitions back to the Normal state, it is
automatically reset and deleted from the list of alarms. You can use this parameter to
reset the point’s Acknowledge state to "N" on this transition. This forces the user to
acknowledge the alarm again after it is reset.
Record format is:
AM_RESET_ACK_STATE|1|YES
AMLP_USE_GEN_TIME
For the Alarm Line Printer, when an alarm is acknowledged or deleted, this
parameter determines whether the generation time or the time of the acknowledge or
delete action is printer. If this parameter is not defined, the generation time is printed
by default.
Options are:
Y The generation time is printed.
N The time of the action (acknowledge or delete) is printed
Record format is:
AMLP_USE_GEN_TIME|1|<option>
CE_MAX_DELAY
For the Basic Control Engine, the maximum delay time in seconds after which a late
event will not be executed. For example, events may be delayed when there is a
heavy load on the system. If this parameter is not defined, the default is 60.
Record format is:
CE_MAX_DELAY|3|<time>
CE_MAX_THREADS
For the Basic Control Engine, the maximum number of simultaneous scripts. If this
parameter is not defined, the default is 30.
Record format is:
CE_MAX_THREADS|3|<number>
CE_THREAD_TIMEOUT
For the Basic Control Engine, the idle cache time in seconds before the threads are
freed. If this parameter is not defined, the default is 900 seconds.
Record format is:
CE_THREAD_TIMEOUT|3|<seconds>
The default timeout in the distributed Global Parameters file is 0 (no reset timeout).
DBDL_ABORT_TIMEOUT
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The delay in ticks before abort drops table in shutdown for the Database Logger
option.
Record format is:
DBDL_ABORT_TIMEOUT|1|<period>
DB_DEBUG
Enables the dumping of diagnostic information for the Database Logger to the
MAC_DL.out and MAC_PTDL.out files in your project’s log directory.
Record format is:
DB_DEBUG|1|<value>
26-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
DB_ENABLE_TRANSACTIONS
For the Database Logger, overrides the default database functionality as requested by
ODBC.
Options are:
Y Forces logging to use transactions.
N Forces logging to not use transactions.
Record format is:
DB_ENABLE_TRANSACTIONS|1|<option>
DB_QUEUE_OVERFLOW_DELAY
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
The delay in minutes between logging overflow errors for the Database Logger
option.
Record format is:
DB_QUEUE_OVERFLOW_DELAY|1|<period>
DB_TIMESTAMP_PRECISION
For the Database Logger, specifies an alternate timestamp precision for ODBC data
sources that do not accept the default provided by the CIMPLICITY Database
Logger.
Important
Do not configure this option unless instructed to by GE Fanuc support
personnel.
Record format is:
DB_TIMESTAMP_PRECISION|1|’<timestamp>’
where <timestamp> is the timestamp for your database. The timestamp must be
enclosed in single quotes as shown above. The format is case sensitive.
For more information on this parameter, see the Database Logger documentation.
DEL_OPT
The default requirements for alarm deletion. The options are:
A Acknowledged only
R Reset only
AR Acknowledge and reset
Record format is:
DEL_OPT|1|<option>
EMEP_BUF_SIZE
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
For the Basic Control Engine, defines the communications buffer size. This indicates
the count of pending messages that the Basic Control Engine will hold.
Record format is:
EMEP_BUF_SIZE|3|<value>
GSM_ANNUN_DIG_OFF
The color and blink state to be displayed when a digital point is low for Alarm State
color animation.
Record format is:
GSM_ANNUN_DIG_OFF|1|<color_number><blink>
26-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
GSM_ANNUN_DIG_ON
The color and blink state to be displayed when a digital point is high for Alarm State
color animation.
Record format is:
GSM_ANNUN_DIG_ON|1|<color_number><blink>
GSM_ANNUN_ALARM_H2
The color and blink state to be displayed when an analog point is in Alarm High state
for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_H2|1|<color_number><blink>
GSM_ANNUN_ALARM_H1
The color and blink state to be displayed when an analog point is in Warning High
state for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_H1|1|<color_number><blink>
GSM_ANNUN_ALARM_L1
The color and blink state to be displayed when an analog point is Warning Low state
for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_L1|1|<color_number><blink>
GSM_ASC_FONT_NAME
The name of the font to use for text on an ASCII (.ASC) screen. This must be a
TrueType font.
Record format is:
GSM_ASC_FONT_NAME|1|<name>
GSM_ASC_FONT_SIZES
A list of the 16 point sizes to use for the 16 text sizes in an ASCII (.ASC) file (GRE
text sizes 0 to 15, which are stored in the .ASC file as -1 to 14).
Record format is:
GSM_ASC_FONT_SIZES|1|<list>
GSM_ASC_SCALE
A floating-point number that represents the number of document units per world
coordinates when converting ASCII (.ASC) screens to .CIM format.
ASC files store screen information in floating point "world coordinates". The
screens are 100.0 world coordinates wide by 60.0 world coordinates high. Document
units in .CIM files are integers in TWIPS (twentieth of a point, 1440 TWIPS/inch).
Thus, if you want your .ASC screens to be about six inches wide on the display, you
should use a scale factor of (1440 doc. units/inch)*(6 inches/screen)/(100 world
coord./screen) which equals 86.4 doc. units/world coord.
Record format is:
GSM_ASC_SCALE|1|<value>
If this parameter is not defined, the default value is 86.4 doc. units/world coord.
26-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
GSM_CACHE_SIZE
As a default CimView keeps eight (8) prior screens in cache memory for faster
updates. If you require faster screen repaint times when switching between screens,
you can use this parameter to increase the cache size.
Note
Increasing this number uses additional memory and may have a negative effect on the
performance of other transactions.
Record format is:
GSM_CACHE_SIZE|1|<number>
GSM_EXPONENT_PRECISION
If a Text object on a CimView screen has "General" format and the number of digits
exceeds this parameter, then the number is displayed in scientific notation with that
number of significant digits.
For example, if you set GSM_EXPONENT_PRECISION to 3, the number 1234
displays as 1.23e+3.
Record format is:
GSM_EXPONENT_PRECISION|1|<number>
If this parameter is not defined, the default number of digits is 6. That is, if the
number exceeds six digits, it is displayed in scientific notation with 6 significant
digits.
GSM_SPCONFIRM_DEFAULT
Procedure dialog boxes contain two buttons: OK and Cancel. Action dialog boxes
contain three buttons: OK, Skip, and Cancel. The default button for both dialog
boxes is the OK button.
You can use this global parameter to select one of the other buttons to be the default
button in procedure and actin dialog boxes.
Record format is:
GSM_SPCONFIRM_DEFAULT|1|<selection>
where <red>, <green>, and <blue> are the red, green, and blue color indices
from 0 to 255. For example, RGB(0,0,0) is black and RGB(255,255,255) is
white.
If this parameter is not defined, the Text object displays the default text when the
point is unavailable, regardless of whether a last available value exists or not.
GSM_UNAVAIL_COLOR_KEY
Color index number (0 to 255) used to indicate an unavailable point value on
CimView screens.
Record format is:
GSM_UNAVAIL_COLOR_KEY|1|<number>
where <number> is a number from 0 to 255. The color associated with each
number is defined in RGB.DAT.
If this parameter is not defined, the default is 0 (black).
LOGIN_NOSAVE
Disables the "Save Password" capability on the CIMPLICITY Login dialog.
Options are:
Y Disable the "Save Password" capability.
N Enable the "Save Password" capability.
Record format is:
LOGIN_NOSAVE|1|<option>
LOGIN_RETRY_PERIOD
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Retry period in seconds for connecting to a project whose User Registration program
is down.
Record format is:
LOGIN_RETRY_PERIOD|3|<number>
26-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
LOG_OPT
Use this parameter to define the default logging conditions for an alarm. You can
choose any of the following:
G Alarm is generated
A Alarm is acknowledged
R Alarm is reset
D Alarm is deleted by a user.
Record format is:
LOG_OPT|1|<options>
MAX_STACKED
Use this parameter to define the default maximum number of occurrences of an alarm
that can be stacked in Alarm Viewer.
Record format is:
MAX_STACKED|3|<number>
MAX_TREND_BUF
Use this parameter to change the maximum number of point values a point buffers for
Trending. Point buffering is used when a chart is first displayed and there is some
initial data.
Note
Increasing this parameter will affect system performance.
Record format is:
MAX_TREND_BUF|3|<number>
where:
<num1> controls the amount/detail of diagnostic output. The value ranges from
0 to 9, where 0 means no debugging output, and 9 means the maximum amount
of debugging output.
<num2> is a value for NT operating systems that may handle output files in a
manner that prohibits multiple process access (as sometimes occurs with NT on
DEC Alpha platforms). This value controls approximately how often the output
file will actually be closed/re-opened, in seconds. A value of 0 (zero) means that
this period closing will not occur. Any non-zero value of less than 60 will be
forced to 60.
<num3> provides a number of seconds for an internal timer that rechecks the
parameters in the Global Parameters file. This value cannot be less than zero.
The default value is equivalent to five minutes.
DUMPPOINT initiates a one-shot dump of the Point Bridge internal information
regarding the state of points it is servicing. This parameter is only acted upon
once when any of the other arguments are changed, and the resulting change
leaves LEVEL with a non-zero value.
PROJECT_ID
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
This parameter is used by the Multiple Projects option and contains the one character
Project ID for the project.
Record format is:
PROJECT_ID|1|<name>
26-16 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
PTMDP_DO_EU_CONV
In Point Configuration, when you use a device Point ID in the Expression Editor for
virtual points, the raw value of the point is used by default. If you want to use the
engineering units value, you must enter EU_CONV(<point_id>) in the
expression.
Use this parameter to automatically convert Point ID values to engineering units
without having to use the EU_CONV function.
Options are:
0 Do not automatically convert Point ID values to engineering units in
expressions.
1 Automatically convert Point ID values to engineering units in expressions.
Record format is:
PTMDP_DO_EU_CONV|3|<option>
PTMRP
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Defines the default Point Manager to be used for point processing.
Record format is:
PTMRP|1|<number>
RAW_LIMIT_ALARM
Use this parameter to enable or disable the generation of alarms for point values that
are outside their raw limits. The options are:
YES Raw limit alarms are enabled.
NO Raw limit alarms are disabled
Record format is:
RAW_LIMIT_ALARM|1|<number>
REPEAT_TOUT
The time in minutes before an alarm is automatically repeated to all interested
processes by the Alarm Management Resident Process. If this parameter is defined,
it is the default used for Repeat Timeout in the Point and Alarm Alarm Options
properties. If this parameter is not defined, zero is used for the default.
Record format is:
REPEAT_TOUT|3|<minutes>
The default timeout in the distributed Global Parameters file is 0 (alarms are not
repeated).
SVC_RETRY_COUNT
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Sets the number of retries waiting for an external service to start up.
Record format is:
SVC_RETRY_COUNT|1|<number>
The default retry count in the distributed Global Parameters file is 30.
SVC_RETRY_DELAY
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Sets the delay in ticks between retries waiting for an external service to start up.
Record format is:
SVC_RETRY_DELAY|1|<number>
The default retry delay in the distributed Global Parameters file is 100 ticks.
26-18 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Parameters for Device Communications
The following global parameters are modified on a per-project basis for particular
Communications options.
Allen-Bradley Communications
ABETH_PLC_POLL_TIMEOUT ABETH_PLC_REQUEST_TIMEOUT
ABETH_PLC_RESPONSE_TIMEOUT
Allen-Bradley Data Highway Plus Communications
ABKT_AB_ADDRESSING
FloPro/FloNet Communications
FLOPRO_RESPONSE_TIMEOUT FLOPRO_STATIC_MODEL
Mitsubishi Serial Communication
COM<port>_TO
Modbus Plus Communications
SA85_DRIVER_TIMEOUT
OMRON Serial Communications
COM<port>_TO
OMRON TCP/IP Communications
<port>_OMRON_SA1 <port>_OMRON_SERVICE
<port>_OMRON_SNA <port>_TO
Series 90 TCP/IP Communications
GMR_NO_MASTER GMR_WRITE_ALL
GMR_SKIP_L_DOMAIN HCT_SKIP_L_DOMAIN
UNSO_TX_AREA_<n>
Smarteye Communications
<port>_LOG_WARNING <port>_POLL_LIMIT
<port>_MODE <port>_RESTART_AREA
SE_LABEL_LEN
26-20 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Logical Names
Logical names are used to override default values for the CIMPLICITY HMI Base
System and options.
Note
Logical names are not to be confused with environment variables. Logical names are
found in the log_names.cfg file, while environment variables are accessed
through the Control Panel.
Logical names that you may want to consider modifying for the Base System are:
CLIE_MAX_PTS Maximum number of Import/Export points.
Logical names that you may want to consider modifying for Allen-Bradley
Communications are:
ALL_UNSO Multi-point updates for all ports
<port>_ALL_UNSO Multi-point updates for specified port
PLC2_PROT_WRITE_ALL Enable protected writes to all PLC-2
devices
PLC2_PROT_WRITE_<port> Enable protected writes to all PLC-2
devices on the specified port
ABI_MAXDEF Maximum number of devices and
unsolicited data messages
Logical names that you may want to consider modifying for Modbus Plus
Communications are:
MD_QUERY_ALL Query command support for all devices
MD_QUERY_<device> Query command support for specified
device
MD_SKIP_GENREF_ALL Skip General Reference validation for all
devices
MD_SKIP_GENREF_<device> Skip General Reference validation for
specified device
Logical names that you may want to consider modifying for Mitsubishi TCP/IP
Communications are:
<prcnam>_UNSO_ALL_TYPES> Unsolicited point addresses are matched to
both their Hexadecimal and Decimal
format addresses.
<prcnam>_UNSO_DEC Unsolicited point addresses are matched to
their Decimal format addresses.
<prcnam>_UNSO_EITHER Unsolicited point addresses are matched to
either their Hexadecimal or Decimal
format addresses or both.
<prcnam>_UNSO_HEX Unsolicited point addresses are matched to
their Hexadecimal format addresses.
Where:
<logical_name> is the name of the logical
<type> is the type of logical (usually set to P for project)
<length> is the number of characters in <value>
<value> is the value to be assigned to the logical name.
You may use Notepad to edit the file.
To change a logical name in the Logical Names file for a project, select Command
Prompt from the Tools menu in the Configuration Cabinet for the project where
you want to change the parameter and do the following:
1. Type cd data.
2. Type notepad log_names.cfg.
3. Find the parameter you want to change, and make the change.
4. Exit the Notepad.
5. Type exit to exit the Command Prompt window.
When you are ready to implement the change in the run-time system, you will have to
stop and restart CIMPLICITY software.
26-22 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Base System Logical Name Descriptions
CLIE_MAX_PTS
If this logical name is not defined, the default maximum number of points that may
be imported or exported is 1000. You can use the CLIE_MAX_PTS logical to
increase the default number. An example of such an entry in log_names.cfg is:
CLIE_MAX_PTS|S|default|5|5000
.AMV
.cim
.CLG
.GEF
CFGCab Document
CimEdit
CimEdit.Documents
All file types starting with CIMPLICITY
CimView
CimView.Documents
Default Device Property Sheet
SNPDevice Property Sheet
TCP IP Device Property Sheet
VME Device Property Sheet
26-24 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Removing Windows NT Registry Information
For Windows NT, do the following:
1. Run the regedit registry program and delete the following:
CFGCab Document
CimEdit
CimEdit.Documents
All file types starting with CIMPLICITY
CimView
CimView.Documents
Default Device Property Sheet
GE Fanuc CIMPLICITY 7.0 Screen
SNPDevice Property Sheet
TCP IP Device Property Sheet
VME Device Property Sheet
GFK-1180 27-1
ODBC Configuration
By default, the CIMPLICITY HMI Database Logger uses the Microsoft Access
ODBC driver to write to Access format (.MDB) files. This is automatically
configured during CIMPLICITY HMI installation. You do not need to purchase or
configure additional software to use this driver.
For improved performance and network extensibility, you may wish to log to a third-
party database product such as Microsoft SQL Server or Oracle.
ODBC Drivers
ODBC Applications use an ODBC driver to communicate with database applications.
The drivers supported for use with the CIMPLICITY HMI Database Logger are:
Microsoft Access An entry-level database which requires no additional
software to use.
Microsoft Access is currently supported only for Intel-
based computers using Windows NT or Windows 95.
Microsoft SQL Server A high-performance database for larger applications.
You must purchase SQL Server to use this driver. In
addition, you must license your CIMPLICITY HMI
Database Logger option for use with SQL Server.
Microsoft SQL Server is currently supported for Intel-
based and DEC Alpha computers
Oracle A high-performance database for large applications.
You must purchase version 7.3 of Oracle and version
3.01 of INTERSOLV DataDirect ODBC Driver for
Oracle to use this driver.
Oracle is currently supported for Intel-based
computers running Windows NT or Windows 95.
27-2 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
If a driver is not supported for a particular platform, data sources will not be
configured for it.
Note
If you change the attributes of a data source, after you have configured Database
Logging to use that data source, you will need to go to the Logging Properties dialog
box and reselect the data source.
Moving Projects
If you copy a project to another computer, the ODBC configuration associated with
that project will not be automatically copied.
• If the project uses the default Microsoft Access data sources, you do not
need to make any changes to your configuration.
• If the project uses the SQL Server data source, you must configure a
new database and user account on the new target computer, then re-
open the Database Logger to rewrite the connect string.
• If the project uses custom data sources, these must be reconfigured on
the target machine.
27-4 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Configuring SQL Server
If the SQL server is not currently running:
1. Open the SQL Service Manager from the Start menu.
2. Start the MSSQLServer service from the dialog box.
You are now ready to register your SQL Server, construct a SQL device, construct a
SQL database, and create a SQL user.
To register your SQL Server:
1. From the SQL Server 6.5 menu, run the SQL Enterprise Manager.
2. Select Register Server from the Server menu to register your server
node. In the dialog box, enter the node name in the Server field. You
can use a Login ID of sa with the standard security option.
3. Click Register in the dialog box to complete your registration
To create a SQL device:
1. In the SQL Enterprise Manager, select Devices from the Manage
menu.
2. Click the New Device icon.
3. Enter the name, drive, path, and size of your database device.
To construct the SQL database:
1. In the SQL Enterprise Manager, select Databases from the Manage
menu.
2. Click the New Database icon.
3. Enter the name, device, and log device for your new database.
To create a SQL user:
1. In the SQL Enterprise Manager, select Logins from the Manage
menu.
2. Create a new user for CIMPLICITY logging, and make your new
database the default for that user.
3. Double-click the database to display its Permissions dialog box, and
give the logging account the Create Table, Create Stored
Procedure and Dump Transaction Log privileges.
Consult your SQL Server documentation for additional information.
27-6 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
• If you are logging to a specific database name rather than the
default:
• Select Options.
• Enter the database name in the Database Name field
6. Select OK on the ODBC SQL Server Setup dialog.
7. Select Close on the System Data Sources dialog.
8. Select Close on the Data Sources dialog.
Requirements
You must purchase the INTERSOLV DataDirect ODBC driver or Oracle (part
number DCNT100). Currently supported versions are:
• Version 3.01 - INTERSOLV DataDirect ODBC Driver for Oracle
• Version 7.3 - Oracle
Oracle databases can be supported on Intel-compatible computers with Microsoft
Windows NT v4.0 or Microsoft Windows 95.
The INTERSOLV ODBC driver and Oracle client software must be installed in the
same computer as the CIMPLICITY HMI software.
For Microsoft Windows NT v4.0, you must have the Allow Service to Interact
with Desktop option turned on for the CIMPLICITY HMI service. If you do not,
logging to the Oracle database will not work. To enable this option:
1. Open the Control Panel.
2. Open Services.
3. Double-click on CIMPLICITY Service from the list of services or
select Startup.... The Service dialog box opens.
4. In the Service dialog box, make sure that the System Account and
Allow Service to Interact with Desktop options are selected.
27-8 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
8. In the Logging Properties dialog box, go to the Alarm Logging and
Point Logging pages and select your newly created ODBC data source
as the ODBC data source.
You need to be aware of the following:
• Database aliases configured on the client node must also be configured
on the server node.
• The Oracle server’s IP address must be in the CIMPLICITY HMI
computer’s HOST file.
• In the ODBC data source for Oracle, enter the alias name in the Server
name field.
• All three of the Oracle services must be started on the Oracle server
node.
27-10 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Creating Tables
When a project is started, the Database Logger creates any tables you have
configured for that project based on the attributes you have specified. This means
you don’t have to know anything about databases to log data from your CIMPLICITY
project.
Specifically, when a project starts, the Database Logger will:
• Attempt to create or repair any missing or damaged databases.
• Create any missing tables.
• Create any missing columns in the tables.
Table Characteristics
The Database Logger tables have the following characteristics:
Column Definitions
A table can have, at most, 250 columns. The following columns are defined for each
type of log file:
• Data logging tables contain a timestamp and Point ID column, plus an
additional column for each table and point attribute you have selected.
The number of columns is independent of the number of points in the
table. For example, if you have a table that logs the point value and
previous value for all points configured for data logging, the table will
have four columns.
• Alarm, Event, and Application logging tables have columns that are
specific to that table, plus an additional column for each table attribute
you have selected. All table rows include a timestamp column and an
autoincrement sequence number that ensures that each row is unique.
• Group logging tables contain a timestamp column, plus an additional
column for each table and point attribute you have selected. For
example, if you have a table logging the value and alarm state of five
points, the table will have eleven columns.
Key Definitions
The following keys are defined for each type of log file:
• Group logging tables have a unique primary key index on the
timestamp column. If you have selected the project name table
attribute, the primary key index also includes the project name column.
• Data logging tables have a primary key index on the joined timestamp
and Point ID columns, and a secondary index on the timestamp alone.
If you have selected the project name table attribute, the primary key
index also includes the project name column.
• Alarm, Event, and Application logging tables have a primary key index
on the joined timestamp and sequence number columns, and a
secondary index on the timestamp alone. If you have selected the
project name table attribute, the primary key index also includes the
project name column.
Important
Since the Microsoft Access format does not support subsecond
timestamp data, you cannot log points to a Data or Group table at
subsecond rates. Attempting to do so will cause the duplicate-keyed
records to be dropped from the database.
27-12 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Database Disconnect Recovery
If the Database Logger loses its connection to a Microsoft Access or SQL Server
database, it generates a DB_CONN_DOWN alarm. When it successfully reconnects
to the database, the alarm is cleared. You can control the amount of time to wait
between connection requests, and you can control the amount of data to be saved
locally then forwarded to the database when the reconnection is made.
where <dbms_id> is the database’s DBMS ID, <date_stamp> is the date and
<time_stamp> is the time the file was created. For example:
POINT_960916_053151.SQL
27-14 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
How Maximum Number of Records Works
Once the maximum number of records have been stored, the Database Logger will
not store any more records until it can forward some of the currently stored records.
For example, you configure Store and Forward for a maximum of five records.
• After the Database Logger loses its connection to the database, it stores
five records and logs the "Number of stored records exceeded" message
to the Status Log:
• The Database Logger then reconnects to the database and is able to
forward three of the stored records before it loses its connection again.
• The Database Logger will now store three records and log the "Number
of stored records exceeded" message to the Status Log:
If the Database Logger is shut down, and there are still records in the storage files,
when the Database logger restarts, these records are not counted against the
maximum. Under these conditions, you can have more than the maximum number of
records stored to disk.
Note that the Alarm Logging and Point Logging databases have
separate records.
DB_ENABLE_TRANSACTIONS
If specified, this global parameter overrides the default database functionality as
requested by ODBC.
The record format is:
DB_ENABLE_TRANSACTIONS|1|<flag>
where <flag> is Y if you want to force logging to use transactions, or N if you want
to force logging to not use them.
If you are using SQL Server and have configured an Insert Trigger on a database
table, you will need to set this value to N.
27-16 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
DB_TIME_FORMAT
CIMPLICITY software uses the default Microsoft Access and SQL Server timestamp
format for your locale when it writes SQL statements.
If you are using Store and Forward and your database does not use the default
timestamp format, you need to define this global parameter. Enter the timestamp
format for your database so that time and date fields will be written correctly in the
Store and Forward files.
The record format is:
DB_TIME_FORMAT|1|<timestamp>
where <timestamp> is the timestamp format for your database. The format is case
sensitive:
• The year (Y), month (M) and hour (H) indicators must be in upper-case.
• The day (d), minutes (m), seconds (s) and ticks (t) indicators must be in
lower-case.
For example:
DB_TIME_FORMAT|1|dd\MMM\YYYY HHHH:mm:ss
To return to the default format, remove this record from the file.
DB_DEBUG
You can enable the dumping of diagnostic information for the Database Logger to the
MAC_DL.out and MAC_PTDL.out files in your project’s log directory.
The record format is:
DB_DEBUG|1|<value>
27-18 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
Security Features
Login Password
When you configure a User in a CIMPLICITY HMI project, you can:
• Select whether the user needs to enter a password in the CIMPLICITY
Login dialog box.
Passwords are stored in an encoded format and are not directly readable
by users.
• Set the password to expire after a given number of days.
When the password expires, the user will be required to change the
password on the next login to CIMPLICITY HMI.
• Configure a number of consecutive login failures.
When this number is reached, the user’s account is disabled and a
$LOGIN_FAILURE alarm is generated.
For more information on User Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System User’s Manual (GFK-1180).
GFK-1180 28-1
Role Privileges
You can assign one Role to each User in a CIMPLICITY HMI project. When you
configure a Role in a CIMPLICITY HMI project, you can grant users assigned the
Role permission to:
• Perform setpoints on CimView or Point Control Panel screens.
• Enable Dynamic Configuration for functions in the Configuration
Cabinet.
• Delete alarms from the Alarm Viewer window.
• Access the CIMPLICITY Program Control utility.
• Modify alarm setups in the Alarm Viewer window.
• Log setpoint events to the Event Log.
• Create Point by Address points in CimEdit screens.
• Trigger events in the Basic Control Engine User Interface (BCEUI).
• Stop, pause or resume scripts in the BCEUI.
For more information on Role Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System User’s Manual (GFK-1180).
Setpoint Security
You can use the Setpoint Security feature to enable or disable Setpoint Security for
all users that access your project. If you enable Setpoint Security, a user can perform
setpoints on only those points whose resources are in the user’s view.
For an Enterprise Server project, Setpoint Security is enforced against the rescue in
the Enterprise Server project if that project contains the same rescues as the provider
of the point. If the resource is not configured on the Enterprise Server project, then
Setpoint Security for the point is enforced against the remote project’s resource.
For more information on Point Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System User’s Manual (GFK-1180).
Setpoint Password
By default, run-time users have unrestricted access to the setpoint functions used by
CIMPLICITY HMI software. If you enable the Setpoint Password option and enter
a password, run-time users will be prompted for this password whenever they invoke
a setpoint function.
Setpoint functions include:
• Setpoint entries from the Point Control Panel.
• Absolute, Ramp, Relative, Toggle and Variable setpoint actions on
CimView screens.
If you include Setpoint functions in Basic Control Engine scripts, and you enable the
Setpoint Password option, you must include the password in the function call.
For more information on Point Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System User’s Manual (GFK-1180).
28-2 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Security Audit Trail
The Security Audit Trail lets you monitor user actions in your project. It consists of
a set of standard alarms that report on the following types of events:
• Point Control Panel alarm changes
• Setpoint downloads
• Dynamic configuration changes
• Project logins and logouts
These alarms are included in your project configuration. They are all configured for:
• Delete on Acknowledge
• No Manual Clear
• Log on Generate
• Acknowledge immediately
• No stacking
You can reconfigure the alarm characteristics to suit your needs.
For more information on Alarm Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System User’s Manual (GFK-1180).
By default, the Audit Trail alarms are logged in the Event Log table of the Database
Logger. You can choose whether you want to log each alarm. You can also choose
to log each alarm in the Event Log table or Alarm Log table. Finally, you can
generate a report of Audit Trail alarms from the Database Logger table.
For more information on Database Logger Configuration, see that chapter in the
CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual
(GFK-1180).
The alarm records the entity type being changed, the entity name being changed, the
CIMPICITY login user name of the user and the computer login user name of the
user.
Project Login/Logout
The $LOGIN_FAILURE alarm is generated when a user fails to log in to a
CIMPLICITY HMI project correctly and the number of consecutive login errors has
been reached. The alarm message contains the following information:
User ID <user_id> disabled, computer <computer_name>
The $LOGOUT alarm is generated when a user logs out of a CIMPLICITY HMI
project. The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged out
28-4 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Using the OEM Key
GFK-1180 29-1
CIMPLICITY License Agreement
The License Agreement dialog box displays the end user license agreement for
CIMPLICITY HMI software and gives you a chance to accept or refuse it.
29-2 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Stopping Running Projects
If OEM Key finds that CIMPLICITY HMI projects are running on your computer,
the OEM Key dialog box opens. This dialog box gives you the opportunity to exit
OEM Key or terminate the projects and activate OEM Key.
Select Cancel to exit OEM Key without stopping the running projects.
Select Stop CIMPLICITY HMI to terminate your running projects.
When the Next> button activates, select it to continue activating OEM Key. The
CIMPLICITY HMI OEM Key dialog box opens.
You can leave the dialog box open or minimize it while OEM Key is running.
You can select the Show status window check box to display the time left. This
status window displays on top of all the windows on your screen.
If you exit the dialog box or select Quit, the OEM Key terminates immediately.
29-4 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Remote Projects, Enterprise
Server and Point Bridge
Remote Projects
If your computer is on a network with other CIMPLICITY computers, you can
retrieve point information from projects running on the other computers in a variety
of ways:
• You can display CimView screens for other projects.
• You can display points from other computers on CimView screens
running in your project.
• You can collect data from points in projects on other computers.
• If you are using the Database Logger option, you can log points from
projects on other computers.
You need to define Remote Projects under the following conditions:
• You have defined points in Point Configuration that use the Point
Bridge to get their values from points in projects on other computers.
• You are using the Database Logger option and you are logging points
from projects on other computers.
In other words, if, when the project starts, the Point Bridge or Point Data Logger
need to get points from projects on other computers running CIMPLICITY projects,
you need to define remote projects. This is especially important if you are
configuring a CIMPLICITY project to start at boot time.
To define a remote project, double-click the Remote Projects icon in the
Configuration cabinet for your project.
The Configuration - Projects window opens.
GFK-1180 30-1
Creating A New Remote Project
To create a new remote project, you can do one of the following:
• Select New from the File menu.
• Click the New Item button on the Toolbar.
When you do, the New Project dialog box opens.
Enter the name of the remote project in the Project Name field and select OK. The
Remote Project dialog box opens. This dialog box consists of two pages.
• Use the General page to enter general information about the project.
• Use the Enterprise page to configure data and alarm collection for an
enterprise project.
When you are through, select OK to save the information, or select Cancel to close
the dialog box without making any changes.
30-2 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
General for Remote Project
If you want to use your current project as an Enterprise Server, you must define a
remote project for each project in your enterprise from when you want to concentrate
data or alarm information.
The Resource and Device are pre-configured. Users that want to view point and
alarm information from a remote project on an Enterprise Server must have the
remote projects Resource configured in their view.
Collect points Set this check box to collect point information from the
provider project. All points on the remote project that have
been configured as Enterprise Points are available to the
current project.
Points from remote projects are identified by Remote ID and
Point ID as \\<remote_id>\<point_id> for CimView
and Point Control Panel windows.
Collect alarms Set this check box to collect alarm information from the
provider project.
Only one level of concentration is supported. In other words, if you are connecting
to a remote project that has local and concentrated points, you will only be able to
collect local points from the remote project.
30-4 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Configuring Point Bridge Points
The Point Bridge is part of the Base System, and enables separate CIMPLICITY
systems to exchange point data. The system that is responsible for data collection of
the point data is called the source system. The system that runs the Point Bridge
process is called the destination system.
You should configure points that use the Point Bridge under the following
circumstances:
• You have a complex system architecture where users on Viewers need
to display points from Servers.
• You want to generate alarms on your Server for points on another
Server.
You will need to do the following to successfully use the Point Bridge:
1. Configure a Remote Project for the source system on the destination
system.
2. Configure the Point Bridge port.
3. Define a device for the Point Bridge port and make sure the Device
Name matches the Remote Project name.
4. Define the points you want to retrieve from the source system. Make
sure that the Point Address matches the source project’s point name.
The Point ID on the destination system does not have to match the Point ID on the
source system. The data types and number of elements of the two points do have to
match. When the source point changes value, the point value is updated on the local
system.
Both reading and writing of points are supported. If a point is configured for
WRITE access on both systems, a user on the Point Bridge system can set the value
of the Point Bridge point. The point on the source system is then updated.
Dynamic configuration of Point Bridge points is also supported.
Note
30-6 CIMPLICITY HMI for Windows NT and Windows 95 Base System User’s Manual GFK-1180
Site Wide Installation
GFK-1180 31-1
About Microsoft System Management Server (SMS)
The SMS system provides network administrators with a method for centrally
managing software and hardware for their corporate networks. The SMS system is
an easy-to-use, integrated system that:
• Maintains an inventory of the hardware, software and configuration of
computers across a corporate network.
• Distributes, installs, and updates software and files.
• Manages network applications (applications run over the network from
servers).
• Provides integrated support utilities that enable you to view diagnostic
information for remote clients and take direct control of clients.
• Provides an integrated network monitor utility that enables you to
monitor network data flow.
All these tasks can be done centrally with the SMS Administrator at a Microsoft
Windows NT-based client. The SMS system maintains a database containing system
information and inventory, carries out distribution and installation jobs, monitors the
progress of these jobs, and alerts you to important system events.
SMS lets you centrally manage your entire enterprise. Using SMS you can distribute
and install software on clients and servers across your corporate network, set up
network applications, automatically collect and maintain hardware and software
inventory, provide direct support to clients, and monitor your network.
When you distribute software to a site, the software is distributed to designated
servers at the site called distribution servers. From these distribution servers, users
can manually access and install the software on their clients. Or you can specify
commands to automatically run applications or install software from the distribution
servers to the clients.
When you set up a network application for shared use by groups of users, you
distribute software to the servers from which you want users to access the network
application. You also specify which groups of users have access to the network
application. When you set up the network application, the program item for the
application is automatically set up on the users’ computers. When users choose the
application, the network application is run from that server.
You can also specify scheduling times for distributing software to maximize the
efficiency of your system.
You can distribute software or set up network applications for the current site where
you have logged on with the SMS Administrator or for any site beneath the current
site. When you target other sites for software distribution or network application
setup, the SMS system can use NetBIOS transport protocols on a LAN, RAS (Async,
X.25, or ISDN communications link), or SNA LU 6.2 links (batch and interactive
mode) to transfer the software and instructions for installing that software to the
target sites. For fault tolerance and efficiency, you can also define alternate LAN,
RAS, or SNA addresses to other sites. You can also set scheduling and priority
management on each type of address.
31-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
How Client Package Distribution Works
In order to run a package command on target clients, SMS must perform three tasks:
• Send the package to the sites containing the target clients.
• Distribute the package to servers at those sites.
• Send the instructions for running the package command to the target
clients.
All of these tasks can be done with a single Run Command On Workstation job (as
described in this document). Alternatively, you can do each of these tasks
individually using separate Run Command On Workstation jobs.
When a job sends a package, SMS compresses all files and subdirectories in the
package’s source directory into a single compressed package file and transfers the
compressed file to the sites containing target clients. The compressed package file is
stored on the site server.
Once a package has been sent to a target site, the package is distributed to servers at
the target site. The SMS Despooler at the target site decompresses the compressed
package file into the package source directory’s original files and directory structure,
and places these files on the distribution servers in a subdirectory of the
SMS\LOGON.SRV\PCMPKG.SRC directory. The package source directory is
shared so that the client can have access to the directory.
31-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
CIMPLICITY HMI Site Wide Installation Procedure
Do the following to successfully perform a Site Wide Installation of CIMPLICITY
HMI for Windows NT and Windows 95 software:
1. Create the Application Source Directory
2. Create SMS Package for CIMPLICITY HMI installation
3. Create Job for CIMPLICITY HMI installation
If you have already created the Application Source Directory and copied the platform
files to it, and all you want to do is open the Select CIMPLICITY Options dialog box,
just run SMSSETUP.BAT in the Application Source Directory, and go to Step 4 of
these instructions.
Each product that has been modified will have an asterisk (*) in front of its name in
the Select Options for combo box.
31-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Creating SMS Package for CIMPLICITY HMI
installation
To create the SMS package for CIMPLICITY HMI installation:
1. Start SMS Administrator.
2. Open the Packages window.
3. From the File menu, select New.
The Package Properties dialog box opens.
4. Select Import.
The File Browser dialog box opens.
31-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
• Select Details.
The Job Details dialog box opens.
GFK-1180 32-1
About the Examples in this Document
The example in this document uses the following:
• A Server computer, named ALNT32, with:
• Microsoft Windows NT V4.0
• CIMPLICITY HMI Server software
• Modem
• Ethernet IP address of 3.26.5.134
• Two consecutive IP addresses - 3.26.5.143 and 3.26.5.144 - to be
used for the Remote Access Service configuration.
• A Client computer, named ALW085, with:
• Microsoft Windows 95
• CIMPLICITY HMI Viewer software
• Modem
Pictorially, the configuration looks like this:
32-2 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Before You Start
Before you configure your CIMPLICITY HMI Viewer and Server computers for
remote access, you need to have the following:
For the CIMPLICITY HMI Server (also referred to as the Server computer), you
need:
• Microsoft Windows NT version 4.0 (Workstation or Server) installed
• Ethernet installed
• A modem
• The Microsoft Windows NT operating system CD
For the CIMPLICITY HMI Viewer (also referred to as the Client computer), you
need:
• Microsoft Windows NT version 4.0 (Workstation or Server), or
Microsoft Windows 95 installed
• A modem
• The Microsoft Windows NT or Windows 95 operating system CD.
For both computers, you need to have the TCP/IP and NetBEUI protocols
configured. Both computers must also have the same version of CIMPLICITY HMI
software installed with valid licenses.
Finally, you will need to get two consecutive TCP/IP addresses from your Network
Administrator. You will be assigning these addresses to the Server and Client
modems when you configure the Remote Access Server.
1. Select Configure....
32-4 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
The Configure Port Usage dialog box opens.
For the Server, the minimum selection for Port Usage is Receive
calls only.
• Select the port usage you want for the modem.
• Select OK to return to the Remote Access Setup dialog box.
2. Select Network. The Network Configuration dialog box opens.
Make sure that NetBEUI and TCP/IP are selected for Server
Settings.
Note
If you selected Dial out and Receive calls in the Configure Port Usage dialog
box, make sure that NetBEUI and TCP/IP are also selected for Dial out
Protocols.
32-6 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
5. Select OK to close the Network Configuration dialog box and return to
the Remote Access Setup dialog box.
6. In the Remote Access Setup dialog box, select Continue... to return to
the Network dialog box.
7. Select OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.
32-8 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Client Setup (Windows NT)
For Client (CIMPLICITY HMI Viewer) computers running Windows NT, you need
to install the Remote Access Service. After you install the service, you will need to
configure Dial-Up Networking.
1. Select Configure....
For the Client, the minimum selection for Port Usage is Dial out
only
• Select the port usage you want for the modem.
• Select OK to return to the Remote Access Setup dialog box.
2. Select Network. The Network Configuration dialog box opens.
Make sure that NetBEUI and TCP/IP are selected for Dial out
Protocols.
Note
If you selected Dial out and Receive calls in the Configure Port Usage dialog
box, make sure that NetBEUI and TCP/IP are also selected for Server Settings.
You will also need to configure the NetBEUI and TCP/IP configurations.
3. Select OK to close the Network Configuration dialog box and return to
the Remote Access Setup dialog box.
4. In the Remote Access Setup dialog box, select Continue... to return to
the Network dialog box.
5. Select OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.
32-10 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Client Setup (Windows 95)
For Client (CIMPLICITY HMI Viewer) computers running Windows 95, first make
sure that the TCP/IP and NetBEUI protocols are installed.
To do this:
1. Open the Control Panel.
2. Double-click on the Network icon.
3. Select the Protocols tab.
4. Make sure the two protocols are installed.
Next, you will need to configure Dial-Up Networking.
To do this:
1. Open the Control Panel.
2. Double-click on the Add/Remove Programs icon.
3. In the Add/Remove Program Properties dialog box:
• Select the Windows Setup tab.
• Select Communications.
• Select Details... .
• In the Communications dialog box, select Dial-Up Networking,
and then select OK.
4. Select OK in the Add/Remove Program Properties dialog box.
The computer will start installing the Dial-Up Networking option. If it
needs to use the Microsoft operating system CD, the installation
procedure will prompt you for it.
After the installation completes, the system reboots.
After you install the Dial-Up Networking option, you will need to configure its
properties.
1. Open My Computer.
2. Double-click on the Dial-Up Networking icon.
3. Add an entry for the Remote Access Server you want to connect to.
32-12 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Configuring the HOSTS Files
The RAS connection does not support broadcast of CIMPLICITY HMI projects.
Therefore, the IP address and the node name of each computer (Server and Viewer)
must be configured in the hosts file of the other computer.
If you do not already have a hosts file configured on your computer, you can use
the hosts.sam sample file on your computer as a starting point.
• In Windows NT, you can find the hosts.sam file in
C:\WINNT35\system32\drivers\etc.
• In Windows 95, you can find the hosts.sam file in C:\WINDOWS.
Place the hosts file in the same directory as the hosts.sam file.
Note
Leave the localhost entry in the hosts file. The CIMPLICITY HMI Router
service needs this entry.
Server
The following is an example of a hosts file on a computer configured as a Remote
Access Server:
127.0.0.1 localhost
3.26.5.144 alw085 ALW085
3.26.4.37 albdv7 ALBDV7
148.93.40.68 oempm4 OEMPM4
192.35.39.34 ftp-gw
Use the TCP/IP address associated with the Client’s (in this case ALW085’s) modem
port.
Client
The following is an example of a hosts file on a computer configured as a Remote
Access Client:
127.0.0.1 localhost
3.26.5.134 alnt32 ALNT32
Note that there are only two entries, the one for localhost and the one for the
Remote Access Server computer. Use the TCP/IP address associated with the
Server’s Ethernet card, not the TCP/IP address associated with the Server’s RAS
connection.
Ping
After dialing in to the Server from the Client and establishing the connection, you
should be able to perform the following tests successfully.
Client Tests
You should be able to ping the Server computer by name from the Client computer.
For example:
C:\WINDOWS>ping alnt32
C:\WINDOWS>
Server Tests
You should be able to ping the Client computer by name from the Server computer.
For example:
C:\WINDOWS>ping alw085
C:\WINDOWS>
32-14 CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Accessing a CIMPLICITY HMI Project from a Client
The following are some notes on accessing screens and points from a Client
computer.
Internet
Company Ethernet
You can create Web documents containing textual CIMPLICITY HMI data values.
Users accessing these documents can view data and perform setpoints. The security
features of CIMPLICITY HMI restrict access to data and to the setpoint capabilities
of Internet connections as they do with standard multi-user systems.
GFK-1180 33-1
Web Server Requirements
Your Web Server computer must be an Intel Pentium PC and must have the
following installed:
• Microsoft Windows NT Server operating system, version 4.0 or later
• Microsoft Internet Information Server (IIS), version 3.0 or later
• Microsoft Internet Explorer, version 3.0 or later
We strongly recommend that you install and configure the Microsoft Internet
Information Server before you install the CIMPLICITY HMI Web Gateway.
Installation Procedure
To install the CIMPLICITY HMI Web Gateway on your Web Server:
1. Shut down all active processes before starting.
2. Insert the CIMPLICITY HMI CD in your CD-ROM drive.
If you have AutoPlay configured, the CIMPLICITY HMI Installation
Setup screen opens automatically. When you are asked if you want to
continue or cancel the installation, select Cancel.
3. Open the Windows NT Explorer.
4. Open the main folder for the CD-ROM.
5. Double-click the websetup icon in the main CD-ROM folder. The
Setup screen for the CIMPLICITY HMI Web Gateway installation
opens with the Welcome dialog box.
6. Select Next to continue. The Software Evaluation License Agreement
dialog box opens.
7. Select Yes to accept the terms and conditions of the software license.
The Choose Destination Location dialog box opens.
8. Select the directory where you want to install the CIMPLICITY HMI
Web Gateway (IIS) software. You should accept the default directory.
Select Next.
9. If you have not installed CIMPLICITY HMI software, you will be
asked where you want to install your CIMPLICITY HMI Viewer
software.
10. In the Choose Program Group dialog box, select the program group for
the CIMPLICITY HMI Web Gateway software, and then select Next.
The software begins to load.
When installation is complete, you are given an opportunity to register your
CIMPLICITY HMI Web Gateway software.
For CIMPLICITY HMI Web Gateway software to function correctly, you will need
to reboot your computer. The last dialog box gives you the opportunity to reboot
your computer immediately.
33-2 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
More about CIMPLICITY HMI Web Gateway
Components
When you install the CIMPLICITY HMI Web Gateway, the following components
are installed. (This assumes you have installed your Internet Information Server
published directories in C:\InetPub.)
• \InetPub\Scripts\CimGate.dll
This is the ISAPI extension for the Web Server. It processes requests
for CIMPLICITY point data. This file must exist in a directory to
which the browsing user has execute access.
Your HTML Web pages must refer to this directory, so it is
recommended that you leave the file in this default directory.
• \InetPub\wwwroot\CIMPLICITY\HMI\CimData.ocx
This is the CIMPLICITY Data ActiveX Control that makes it easy to
access CIMPLICITY point data from within an HTML Web page using
VBScript or JavaScript. This file must exist in a directory to which the
browsing user has read access.
Your HTML Web pages refer to this directory (using the CODEBASE
attribute of the OBJECT tag), so it is recommended that you leave the
file in this default directory.
• \InetPub\wwwroot\CIMPLICITY\HMI\*.html
These are sample Web pages you can use.
• \CIMPLICITY\HMI\...
This is a subset of the CIMPLICITY HMI Viewer installation.
Project Setup
Before the Web Gateway can communicate with a CIMPLICITY HMI project in
your enterprise, you must configure the project to permit access by the Web
Gateway. To do this:
1. Open the project’s Configuration cabinet.
2. Double-click on the Client icon.
3. Create a new client.
4. In the New Client dialog box, enter the name of the computer running
the Web Server, then select OK.
5. In the Client Properties dialog box,
• Select a default User ID that will give the Web Gateway
appropriate access to the project.
• Set the Trusted check box.
• Select OK.
33-4 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
2. Follow the directions on the Web document to perform the first set of
tests.
3. After you verify that the first set of tests work, proceed to the second set
of tests.
Error Messages
The first part of the error string contains one of the following error codes.
#ERROR!ARRAYNOTALLOWED
This error is returned if you try to use an element of an array point with the PointSet
method.
#ERROR!ARRAYOUTOFBOUNDS
This error usually indicates that the index specified for an array point was not valid.
It will also be returned if you specify an index for a non-array point or if you fail to
specify an index for an array point. In some cases, additional information will be
available following this message.
#ERROR!BADSERVERRESPONSE
This error is returned if the CimData control could not parse the response from the
CimGate extension. Examining the value of the DiagRawResponse property will
reveal the cause of the error.
#ERROR!CIMPLICITYNOTRUNNING
This error indicates that the CIMPLICITY HMI Viewer could not be started by the
CimGate extension.
33-6 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
#ERROR!INVALIDPOINTID
This error is returned by the CimData control if you pass an empty string for the
point ID parameter to the PointSet method.
#ERROR!NOTIMPLEMENTED
This error is returned by CimGate server when the PointMonitor method (which is
not implemented) is called.
#ERROR!NOTLICENSED
This error is returned when the CIMPLICITY HMI Web Gateway is not licensed.
The CIMPLICITY HMI Gateway must be licensed to use it beyond the trial period.
Run the CIMPLICITY HMI Registration program.
#ERROR!POINTIDSYNTAX
This error is returned when the string passed to PointGet or PointSet could not be
properly parsed as a point ID.
#ERROR!POINTUNAVAILABLE
This error is returned when the point may be unavailable for any number of reasons.
Generally, there will be additional information following this message indicating why
the point is unavailable. You may also want to look at the CIMPLICITY HMI Status
Log on the Web Server computer to help understand why the point is unavailable
#ERROR!SERVERNEEDSRESTART
This error indicates a condition in the CimGate server that requires the Web Server to
be restarted. Typically this occurs when the CIMPLICITY HMI Viewer (or project)
on the Web Server computer is shut down.
33-8 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
PointGet (Method)
Syntax PointGet ( strCimGateServer, arrPointID )
Description Returns an array of the values of the requested point IDs.
Parameters Parameter Description
strCimGateServer A String containing the location of the CimGate extension. The format of this
string is "computer/directory". For example, mycomputer/Scripts.
arrPointID A String or a one-dimensional array of Strings containing the Point IDs.
Comments You may not specify an array point, but you may specify an element of an array point (for example,
arrPointID(0) = "\\PROJ\ARRAYPT[2]"). Fully qualify the Point ID with a project. Do
not enclose the Point ID in single quotes.
The return value of the PointGet method is a two dimensional array.
• The first dimension has the same number of elements as the input array.
• The second dimension has two elements. Element 0 is a Boolean indicating the success
of the operation. Element 1 is either the point value or an error message.
To understand the format of the return value, assume arrPointID is the array of point IDs passed
in and arrResult is the return value. If arrResult(N,0) is True, then arrResult(N,1)
contains the value of the point specified by arrPointID(N). If arrResult(N,0) is False,
then arrResult(N,1) contains an error message.
If a point is configured with EU conversion, the converted value (not the raw value) of the point is
returned.
Example Using VBScript:
arrResult = ctrl.PointGet("mycomputer/Scripts", _
"\\proj\arraypt[2]")
If Not arrResult(0,0) Then
Alert arrResult(0,1)
End If
Dim arrPoints(1)
arrPoints(0) = "\\proj\temp"
arrPoints(1) = "\\proj\speed"
arrResult = ctrl.PointGet("mycomputer/Scripts", arrPoints)
If Not arrResult(0,0) Then
alert arrResult(0,1)
End If
If Not arrResult(1,0) Then
alert arrResult(1,1)
End If
33-10 CIMPLICITY® HMI for Windows NT and Windows 95 User's Manual GFK-1180
/keypad
CimView command line option 21-18
/noconfig
Alarm Viewer command line options 20-58
/noexit
GFK-1180 i
AboutBox About 12-1
Alarm viewer method 20-19 Alarm assignment 12-2
Absolute alarming 4-43 Alarm priorities 12-2
ACCESS 19-15 Blocking modes 12-2
Access filter 4-48 Configuring 12-4
ACCESS_FILTER 19-15 Modifying an alarm block group 12-7
Accessing a project from client Rules for 12-3
RAS 32-15 Alarm blocking group
ACK_TIMEOUT 19-15 Adding an alarm 12-6
ACK_TOUT 26-6 Creating 12-5
Acknowledging All Alarms 20-49 Modifying an alarm 12-6
Acknowledging an Alarm 20-48 Removing an alarm 12-6
Acknowledging and Resetting an Alarm 20-49 Alarm class configuration
Acknowledging the First Alarm 20-49 Audio support 8-4
Action Object Selected With the Mouse 21-12 Color assignments 8-5
Actions Creating a new alarm class 8-3
Device properties, CIMPLICITY HMI and Control Mapping colors in RGB.DAT 8-6
18-4 Alarm classes
Add project to list About 8-1
CIMPLICITY options 2-14 Configuring 8-1
Adding Alarm Configuration
Saved logins 24-14 Alarm Definition Properties - Non-Point Alarms 10-6
Adding A New Option 1-18 Alarm Configuration 10-1
Adding a new user to a resource 6-4 Alarm Definition Properties - Point Alarms 10-7
Adding a user to a resource 6-4 Creating A New Alarm Definition 10-5
Adding Alarm Comments 20-47 Alarm definition
Adding an alarm Alarm message variable run-time parameters 10-1
Alarm block group 12-6 Alarm Definition
Adding an Alarm printer 13-2 Alarm Options Properties 10-12
Adding the point to a logging table Alarm Definition Configuration
Database logger, from point configuration 16-8 Alarm Routing Properties 10-10
ADDR 19-15, 19-33 Alarm Definition Properties
ADDR_OFFSET 19-16 Absolute 10-8
ADDR_TYPE 19-16 Alarm Class 10-6, 10-7
Address 4-48, 4-50 Alarm Criteria 10-8
Address offset 4-48 Alarm Delay 10-9
Alarm 20-20 Alarm Message 10-6, 10-8
Point control panel, properties 22-4 Alarm Type 10-6
Alarm assignment Alarm Values 10-9
Alarm blocking 12-2 Deadband 10-9
Alarm Attributes Definition 10-7
Alarm Id 10-4 Description 10-6
Alarm Type 10-4 Deviation 10-9
Class Id 10-4 Help File 10-6, 10-10
Description 10-4 Logging 10-7
Message 10-4 Non-Point Alarms 10-6
Alarm audio support Point Alarms 10-7
About 11-1 Rate of Change 10-8
Beep configuration 11-4 String Index 10-8
Configuring 11-3 Alarm Definitions
Prioritizing alarms 11-1 Standard Alarms 10-2
Prioritizing alarms, examples 11-2 Alarm Filtering 20-46
Wave file configuration 11-4 Alarm functions
Alarm block group See Alarm blocking Expression editor 4-10
Alarm blocking Alarm high 4-48
GFK-1180 Index v
System architecture 1-2 Displaying a screen 21-10
System recommendations 1-3 Displaying Help Information 21-15
Transferring Licenses 1-20 Displaying Object Help 21-16
Upgrading 1-18 Displaying Object Properties 21-17
Using a Viewer 1-26 Displaying Screen Help 21-15
Version upgrades 1-19 Displaying Screen Properties 21-16
What you receive 1-1 Docking the Toolbar 21-9
CIMPLICITY Software Executing in-place edit setpoint actions 21-13
Copying a project to diskette 2-25 Executing Slider Setpoints 21-12
Creating a new project 2-1 File Menu 21-4
Creating a remote project 30-2 Floating the Toolbar 21-9
Dynamic update 2-22 Getting Started 21-1
How configuration updates are handled 2-22 Help Menu 21-7
Installing a project 2-11 Menu Bar 21-3
Logging in 2-24 Menus 21-4
New project options 2-1 OLE Controls 21-20
Opening a project 2-3 Scroll bars 21-3
Remote projects 30-1 Selecting action object with mouse 21-12
Setting project properties 2-5 Selecting objects with procedures 21-11
Setting Startup Options 2-12 Selecting setpoint object with keyboard 21-13
Using 2-1 Selecting setpoint object with mouse 21-12
Using the Project Wizard 2-7 Setting Window Options 21-14
What’s Running 2-21 Shortcut Keys 21-9
CIMPLICITY to Windows Server 23-1 Status Bar 21-3
Displaying point data 23-6 Title Bar 21-3
Point Topic Attributes 23-3 Toolbar Buttons 21-8
CIMPLICITY To Windows Server Toolbars 21-3
About 23-1 View Menu 21-5
Command syntax for System topic 23-12 Window buttons 21-3
Creating A DDE Share 23-14 Window Components 21-2
CWSERV Command Syntax 23-1 Window Pop-up Menu 21-8
CWSERV Icon 23-7 CimView autostart
Error Messages 23-14 Windows 95 2-16
Formats command syntax 23-12 CimView autostart, Windows 95
Help command syntax 23-13 Disabling Microsoft network login prompt 2-16
Implementing a Setpoint macro 23-9 Setting CIMPLICITY startup options 2-18
Macro format for modifying point data 23-8 CimView command line options
Microsoft Excel Example 23-2 /alwaysmaximized 21-17
Modifying Point Data 23-8 /geometry 21-18
Performance considerations 23-8 /keypad 21-18
Referencing CWSERV from a Networked NT Client /noexit 21-18
23-15 /nomenutitle 21-19
Remote Access of CWSERV on Windows NT 23-14 /noopen 21-19
Sample CWSERV Commands 23-2 /noresize 21-19
Sample spreadsheets and macros 23-10 /project <name> 21-19
Starting CWSERV 23-7 /wait 21-20
System command syntax 23-12 /waitforproject 21-20
Topics command syntax 23-12 /zoomtobestfit 21-20
Using with Microsoft Excel 23-6 clie
CIMPLICTIY options export command 19-10
Startup options 2-14 import command 19-7
CimView 21-1 CLIE See Import/Export
About 21-1 CLIE_MAX_PTS 26-23
Command Line Options 21-17 Client configuration
Control Menu 21-7 About 17-1
viii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Copying a table 16-30 Event logging, Overview 16-2
Creating tables 16-4, 27-11 File menu, Main window 16-13
Creating tables, Column definitions 16-5, 27-11 File menu, Table window 16-40
Creating tables, Key definitions 16-6, 27-12 Global parameters
Creating tables, Microsoft Access note 27-11 DB_DEBUG 27-17
Data logging, Overview 16-3 DB_ENABLE_TRANSACTIONS 27-16
Data point DB_TIME_FORMAT 27-17
Timed/gated logging 16-46 Global parameters’ 27-16
Data point, Alarm triggered logging 16-45 Group logging, Overview 16-3
Data point, Combining triggers 16-45 Group point, Array attributes 16-44
Data point, Data tiggered logging 16-45 Group point, Point attributes 16-43
Data point, Point properties 16-44 Group point, Point properties 16-43
Data report 16-54 Help menu, Main window 16-14
Data report, Clearing error log 16-56 Help menu, Table window 16-41
Data report, Generating 16-56 Install Microsoft Excel from Excel CD 16-49
Data report, Setting parameters 16-55 Install Microsoft Excel from Microsoft Office for
Database disconnect recover, Enabling store and Windows 95 CD 16-50
forward 27-14 Install sample reports 16-50
Database disconnect recover, Reconnect wait period Logging attributes for alarm event and application
27-13 tables 16-22
Database disconnect recover, Store and forward 27-13 Logging attributes, Group and data tables 16-23
Database disconnect recover, Store and forward - Logging attributes, Point attributes to be logged 16-23
changing defaults 27-15 Logging attributes, Table attributes to be logged
Database disconnect recover, Store and forward - 16-22, 16-24
maximum records 27-15 Logging conditions, Alarm triggered logging 16-20
Database disconnect recover, Store and forward Logging conditions, Data triggered logging 16-20
filenames 27-14 Logging conditions, Group and data tables 16-19
Database disconnect recovery 27-13 Logging conditions, Modify logging conditions 16-18
Default logging conditions, Alarm log table 16-18 Logging conditions, Timed/gated logging 16-21
Deleting a table 16-31 Logging properties, All tables 16-28
Displaying a table 16-39 Logging properties, Connect information 16-28
Edit menu, Main window 16-13 Logging properties, Store and forward 16-29
Edit menu, Table window 16-40 Maintenace actions, All tables 16-26
Entering from point configuration Maintenance actions, Command actions 16-27
Alarm logging 16-9 Maintenance actions, Export actions 16-26
Table Browser 16-10 Maintenance actions, Purge actions 16-27
Entering from point configuration, Adding the point to Maintenance events, All tables 16-24
a logging table 16-8 Maintenance events, Timed/gated maintenance events
Entering from point configuration, Creating a new 16-25
table 16-11 Maintenance events, Triggered maintenance events
Entering from point configuration, Displaying a table 16-25
list 16-10 Microsoft Access note 16-4
Entering from point configuration, Logging an alarm Notes on installing Microsoft Excel 16-49
16-9 ODBC configuration 27-2
Entering from point configuration, Modifying the ODBC configuration, Custom data sources 27-3
logging properties for the point 16-8 ODBC configuration, Data sources 27-2
Entering from point configuration, Modifying the ODBC configuration, Drivers 27-2
properties of a table 16-11 ODBC configuration, Microsoft Access data sources
Entering from point configuration, Point logging 27-4
dialog box 16-7 ODBC configuration, Moving projects 27-3
Entering from point configuration, Removing the ODBC configuration, Remote SQL Server data
point from all logging tables 16-8 sources 27-6, 27-7
Entering from point configuration, Removing the ODBC configuration, SQL Server client utilities,
point from one or more logging tables 16-8 Installing 27-6
Event list, Filtering 16-48 ODBC configuration, SQL Server configuration 27-5
GFK-1180 Index ix
ODBC configuration, SQL Server data source Window menu, Options 16-13
configuration 27-6 Window pop-up menu, Main window 16-14
ODBC configuration, SQL Server installation 27-4 Window pop-up menu, Table window 16-41
Oracle configuration 27-8 Database Logger 16-1
Oracle requirements 27-8 Entering from Point Configuration, Displaying table
Point list, Filtering 16-48 attributes 16-9
Point logging properties, Editing 16-42 Database logger, Combining triggers 16-20
Properties 16-34 Database logging, Managing
Properties, Alarm and point logging 16-36 About 27-1
Properties, Connect information 16-37 Database management
Properties, Database queue size 16-35 SQL server 27-9
Properties, Disk full scan rate 16-35 SQL server, Configuration additional locks 27-9
Properties, Maintenance action export path 16-36 SQL server, Handling transaction log 27-10
Properties, Parameters 16-34 SQL server, Truncating transaction log as
Properties, Point data logging scan rate 16-36 CIMPLICITY maintenance action 27-10
Properties, Store and forward 16-38 SQL server, Truncating transaction log as system
Reconciling a table 16-32 default 27-10
Reconciling a table, Creating database fields 16-33 Database queue size
Reconciling a table, Removing unused Microsoft Database logger, Properties 16-35
Access fields 16-33 Date format properties
Reconciling a table, Removing unused Oracle fields AMV OCX 20-14
16-33 Date/time format properties
Reconciling a table, Removing unused SQL Server Alarm printer configuration 13-6
fields 16-33 Date/time formats
Removing points from a table 16-42 Alarm printer configuration 13-7
Reporting 16-49 DB_CONN_DOWN 10-3
Reports, Automatic printing 16-60 DB_DEBUG 26-8, 27-17
Reports, Automatic printing, CimView triggers 16-62 DB_ENABLE_TRANSACTIONS 26-9, 27-16
Reports, Automatic printing, Maintenance action DB_QUEUE_OVERFLOW_DELAY 26-9
triggers 16-62 DB_QUEUE_SIZE 26-2
Reports, Automatic printing, Modifying DB_START_FORWARD 10-3
CIMPLCITIY service for 16-60 DB_TIME_FORMAT 27-17
Reports, Automatic printing, Script 16-61 DB_TIMESTAMP_PRECISION 26-9
Reports, Automatic printing, Triggering 16-62 DBDL_ABORT_TIMEOUT 26-8
Reports, Automatic printing,Event Manager triggers DBDL_DEVICE_CHECK_PERIOD 26-2
16-62 Declaring a Default Alarm Viewer Filter 20-54
Search string wildcards 16-4 Default logging conditions
Shortcut keys, Main window 16-15 Alarm log table 16-18
Starting from configuration cabinet 16-12 Default User 15-1
Starting from point configuration 16-7 Defining a resource
Table characteristics 16-5, 27-11 Properties 6-3
Table list, filtering 16-30 Defining point properties 4-54
Table menu, Options 16-40 Defining the Alarm Count Layout 20-28
Table properties 16-17 Defining the Alarm List Layout 20-31
Table, Creating 16-16 DEL_OPT 26-9
Toolbar buttons, Main window 16-15 Delete Alarm privilege 14-4
Toolbar buttons, Table window 16-42 Delete and acknowledge times, Modifying
Trend report 16-57 Alarm printer configuration 13-10
Trend report, Clearing error log 16-59 DELETE_REQ 19-22
Trend report, Generating 16-59 Deleting a table
Trend report, Setting parameters 16-58 Database logger 16-31
Types of log files available 16-1 Deleting a user from a resource 6-4
Using Oracle with 27-8 Deleting an Alarm 20-48
View menu, Main window 16-14 Deleting an Alarm Viewer Filter from the List 20-54
View menu, Table window 16-41 Deleting configuration data
GFK-1180 Index xi
Alarm viewer method 20-19 EMEP_BUF_SIZE 26-10
DoAcknowledge ENG_UNITS 19-23
Alarm viewer method 20-19 Enterprise properties
DoAckReset Remote project 30-4
Alarm viewer method 20-20 Enterprise server
DoCimviewScreen Set point security 4-52
Alarm viewer method 20-20 Equation
Docking a Toolbar Average points 4-20
CimView 21-9 Delta accum points 4-16
DoComments Equation points 4-13
Alarm viewer method 20-20 Equation w/override points 4-33
DoCustom<n> Histogram points 4-29
Alarm viewer method 20-20 Max capture points 4-22
DoDelete Min capture points 4-24
Alarm viewer method 20-20 Timer/counter points 4-27
DoHelp Trans-high accum points 4-32
Alarm viewer method 20-20 Value accum points 4-18
DONT_VERIFY_ESPOINT_FRID 26-10 EQUATION 19-24
DoRefresh Equation point
Alarm viewer method 20-21 Start condition for 4-14
DoReset Equation points 4-13
Alarm viewer method 20-21 Equation for 4-13
DoSetup Reset point for 4-14
Alarm viewer method 20-21 Trigger point for 4-14
DoToggle Equation w/override points 4-33
Alarm viewer method 20-21 Equation for 4-33
DoViewStack Reset point for 4-34
Alarm viewer method 20-21 Startup condition for 4-34
DOWNLD_PASSWD 26-2 Trigger point for 4-34
DSK2FLPY Error log, Clearing
Command format 1-12 Database logger, Alarm report 16-53
Dynamic configuration changes Database logger, Data report 16-56
Security audit trail 28-4 Database logger, Trend report 16-59
Dynamic Configuration privilege 14-4 Error messages
Dynamic Update 2-22 Web gateway 33-6
Alarm Class configuration 2-23 Web gateway, #ERROR!ARRAYNOTALLOWED
Alarm Printer configuration 2-23 33-6
Alarm String configuration 2-23 Web gateway, #ERROR!ARRAYOUTOFBOUNDS
Database Logger configuration 2-23 33-6
Device configuration 2-23 Web gateway, #ERROR!BADSERVERRESPONSE
Point configuration 2-23 33-6
Port configuration 2-23 Web gateway,
Remote Projects configuration 2-23 #ERROR!CIMPLICITYNOTRUNNING 33-6
Resource configuration 2-23 Web gateway, #ERROR!INVALIDPOINTID 33-7
Role configuration 2-23 Web gateway, #ERROR!NOTIMPLEMENTED 33-7
Web gateway, #ERROR!NOTLICENSED 33-7
E Web gateway, #ERROR!POINTIDSYNTAX 33-7
Web gateway, #ERROR!POINTUNAVAILABLE
Edit menu 33-7
Login panel 24-10 Web gateway, #ERROR!SERVERNEEDSRESTART
Edit Menu 33-7
Alarm Viewer 20-26 Error Messages 23-14
Efficiency with trigger points 4-41 EU_CONV function
Elements 4-50 Expression editor 4-7
ELEMENTS 19-23, 19-33, 23-4 EU_LABEL 23-5
xii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Event list, Filtering Modifying the current filter 20-51
Database logger 16-48 Modifying the resource list 20-52
Event logging Saving the current filter 20-54
Overview 16-2 Filtering Alarms by State 20-52
Example Filtering status log messages 25-11
Histogram points 4-29 Filtering the display list
Example, About Browser 3-3
RAS 32-2 Filtering the table list
Example, Remote configuration Database logger 16-30
CIMPLICITY HMI and Control 18-12 Finding status log messages 25-12
Examples, Adding a project Finding the next status log message 25-13
Alarm sound manager 11-8 Floating A Toolbar
Examples, Prioritizing alarms CimView 21-9
Alarm audio support 11-2 Fonts properties
Executing Actions AMV OCX 20-16
Object selected with the mouse 21-12 For Windows 95 on Intel processors
Executing Setpoints System requirements 1-4
In-place edit 21-13 For Windows NT on DEC Alpha
Object Selected with keyboard 21-13 System requirements 1-3
Object Selected With Mouse 21-12 Formats - CWSERV System Topic 23-12
Executing Slider Setpoints 21-12 Functional upgrades 1-18
Exiting program control 24-21 Further configuration
Export actions RAS, Windows NT server 32-7
Database logger, Maintenance actions 16-26 Windows NT client 32-10
Export procedure FW_CONV_EQ 19-24
Import/Export 19-10
Exporting configuration data 19-10 G
Expression editor, in point configuraiton
Scientific operations 4-11 GE Fanuc
Expression editor, in point configuration 4-6 Calling for authorization code 1-16
Alarm functions 4-10 General Configuration Information
Arithmetic operations 4-8 Alarm Viewer 20-39
Bitwise operations 4-9 General properties
EU_CONV_function 4-7 Alarm printer configuration 13-3
Logical operations 4-9 Device 5-4
Relation operations 4-10 Remote project 30-3
Getting started
Point control panel 22-1
F
Getting Started
Fields properties CimView 21-1
AMV OCX 20-4 Global parameters 26-1
File menu ACK_TOUT 26-6
Browser 3-3 AM_RESET_ACK_STATE 26-7
Login panel 24-10 AMLP_USE_GEN_TIME 26-7
File Menu CE_MAX_DELAY 26-7
Alarm Viewer 20-25 CE_MAX_THREADS 26-7
CimView 21-4 CE_THREAD_TIMEOUT 26-7
Filtering Alarm by Time 20-52 CLR_TOUT 26-8
Filtering alarms CONNECT_DROP_PERIOD 26-4
Loading a filter for display 20-51 CONNECT_RETRY_PERIOD 26-4
Filtering Alarms 20-50 Database logger 27-16
Creating a new filter 20-54 DB_DEBUG 26-8, 27-17
Declaring a default filter 20-54 DB_ENABLE_TRANSACTIONS 26-9, 27-16
Deleting a filter from the list 20-54 DB_QUEUE_OVERFLOW_DELAY 26-9
Modifying the class list 20-51 DB_QUEUE_SIZE 26-2
xiv CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Import options ALM_MSG 19-18
Device properties, CIMPLICITY HMI and Control ALM_ROUTE_OPER 19-18
18-3 ALM_ROUTE_SYSMGR 19-18
Import procedure ALM_ROUTE_USER 19-19
Import/Export 19-7 ALM_STR 19-19
Import, Process ALM_TYPE 19-19
CIMPLICITY HMI and Control 18-7 ANALOG_DEADBAND 19-19
Import, Rules BFR_COUNT 19-19
CIMPLCITIY HMI and Control 18-7 BFR_DUR 19-20
Import/Export 19-1 BFR_EVENT_PERIOD 19-20
Configuration Files 19-4 BFR_EVENT_PT_ID 19-20
Data file format 19-2 BFR_EVENT_TYPE 19-20
Deleting configuration data 19-12 BFR_EVENT_UNITS 19-20
Export field formats file 19-5 BFR_GATE_COND 19-20
Export procedure 19-10 BFR_SYNC_TIME 19-21
Exporting configuration data 19-10 CALC_TYPE 19-21
Field names 19-13 CONV_LIM_HIGH 19-21
Required 19-13 CONV_LIM_LOW 19-21
Field Names CONV_TYPE 19-22
Optional 19-13 DELETE_REQ 19-22
Import Field Defaults File 19-4 DESC 19-22
Importing additional roles 19-9 DEVIATION_PT 19-22
Importing configuration data 19-7 DEVICE_ID 19-22
Introduction 19-1 DISP_LIM_HIGH 19-23
Log file 19-6 DISP_LIM_LOW 19-23
Log file format 19-6 DISP_WIDTH 19-23
Log file name 19-6 ELEMENTS 19-23
Logicmaster 90 support 19-33 ENG_UNITS 19-23
Logicmaster Fields EQUATION 19-24
ADDR 19-33 FW_CONV_EQ 19-24
DESC 19-33 GR_SCREEN 19-24
ELEMENTS 19-33 INIT_VAL 19-24
PT_ID 19-33 JUSTIFICATION 19-25
PT_TYPE 19-33 LOCAL 19-25
Sample data file 19-2 MAX_STACKED 19-25
Sample Logicmaster File 19-33 POLL_AFTER_SET 19-25
Supported Logicmaster field names 19-33 PRECISION 19-26
Wildcards for delete 19-12 PROC_ID 19-26
Wildcards for export 19-11 PT_ENABLED 19-26
Import/Export Fields PT_ID 19-13
ACCESS 19-15 PT_ORIGIN 19-13, 19-27
ACCESS_FILTER 19-15 PT_SET_INTERVAL 19-27
ACK_TIMEOUT 19-15 PT_SET_TIME 19-27
ADDR 19-15 PT_TYPE 19-27
ADDR_OFFSET 19-16 PTMGMT_PROC_ID 19-26
ADDR_TYPE 19-16 RAW_LIM_HIGH 19-28
ALM_CLASS 19-16 RAW_LIM_LOW 19-28
ALM_CRITERIA 19-16 REP_TIMEOUT 19-28
ALM_DEADBAND 19-17 RESET_ALLOWED 19-28
ALM_DELAY 19-17 RESET_COND 19-29
ALM_HIGH_1 19-17 RESET_PT 19-29
ALM_HIGH_2 19-17 RESET_TIMEOUT 19-29
ALM_HLP_FILE 19-17 RESOURCE_ID 19-29
ALM_LOW_1 19-18 REV_CONV_EQ 19-30
ALM_LOW_2 19-18 ROLLOVER_VAL 19-30
GFK-1180 Index xv
SAFETY_PT 19-30 IPC_QUEUE_SIZE 26-5
SAMPLE_INTV 19-30
SAMPLE_INTV_UNIT 19-30 J
SCAN_RATE 19-31
TRIG_CK_PT 19-31 Job, Creating for CIMPLICITY HMI installation
TRIG_PT 19-31 Site wide installation 31-8
TRIG_REL 19-32 JUSTIFICATION 19-25
TRIG_VAL 19-32
UPDATE_CRITERIA 19-32 L
VARIANCE_VAL 19-32
VARS 19-33 Layout properties
Importing additional roles 19-9 Alarm printer configuration 13-5
Importing configuration data 19-7 LENGTH 23-4
Incorrect information conflicts Licenses
CIMPLICITY HMI and Control 18-11 Adding a new option 1-18
InetPub\Scripts\CimGate.dll 33-3 Diskette transfer 1-20
InetPub\wwwroot\CIMPLICITY\HMI\*.html 33-3 Functional upgrades 1-18
InetPub\wwwroot\CIMPLICITY\HMI\CimData.ocx Installing upgrade licenses 1-19
33-3 Network Transfer 1-20
INIT_STATE 23-6 Registering 1-15
INIT_VAL 19-24 Running without authorization 1-17
In-place edit setpoint actions 21-13 Transferring 1-20
Install Microsoft Excel Upgrading CIMPLICITY software 1-18
Excel CD, Database logger 16-49 Version upgrades 1-19
Microsoft Office for Windows 95 CD 16-50 Limits
Microsoft Office for Windows 95 CD, Database Array points 4-36
logger 16-50 Linear conversion 4-45
Install sample reports Loading an Alarm Viewer Filter for Display 20-51
Database logger 16-50 LOCAL 19-25
Installation procedure Log and error files
Web gateway 33-2 Viewing 25-1
Installing Log file format
Web gateway 33-1 Import/Export 19-6
Installing a Project 2-11 Log file name
Installing an Alarm Viewer screen 20-56 Import/Export 19-6
From Alarm Viewer 20-56 Log files
From the File Manager 20-57 Types of 16-1
Installing CIMPLICITY HMI software 1-6 LOG_OPT 26-15
Installing CIMPLICITY software From a Floppy Logging See Database logger
Distribution 1-14 Logging an alarm
Installing Microsoft Excel Database logger, from point configuration 16-9
Notes on, Database logger 16-49 Logging attributes
Installing SQL Server client utilities 27-6 Alarm, event and application tables 16-22
Installing the RAS Group and data tables 16-23
Windows NT client 32-9 Logging conditions, Group and data tables 16-19
Windows NT server 32-4 Logging In 2-24
Installing upgrade licenses 1-19 Logging in to a project
Integer vs. floating point engineering units Login panel 24-12
Custom conversion 4-46 Logging out of a project
Interval Login panel 24-12
Timer/counter points 4-27 Logging properties
Introduction All tables 16-28
CIMPLICITY software 1-1 Logical names 26-21
Site wide installation 31-1 CLIE_MAX_PTS 26-23
IPC_BCAST_INTERVAL 26-4 Editing the file 26-22
xvi CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Logical names, Base system Status log viewer 25-4
Descriptions 26-23 Menus
Logical operations Alarm Viewer 20-25
Expression editor 4-9 CimView 21-4
Logicmaster 90 support Microsoft Access
Import/Export 19-33 Note for Database logger 16-4
Login information Microsoft Access note
Deleting 26-23 Database logger’ 27-11
Help Menu 24-11 Microsoft Excel Example - CWSERV command 23-2
Login panel 24-9 Microsoft Excel, Install from Excel CD
Edit menu 24-10 Database logger 16-49
File menu 24-10 Microsoft Excel, Install from Windows 95 CD
Help Menu 24-11 Database logger 16-50
Logging in to a project 24-12 Microsoft Excel, Install from Windows 97 CD
Logging out of a project 24-12 Database logger 16-50
Managing saved logins 24-14 Microsoft System Management Server
Menu options 24-10 About 31-2
Password, changing 24-13 Min capture points 4-24
Project Menu 24-10 Equation for 4-24
Shortcut keys 24-11 Reset point for 4-24
Starting 24-9 Startup conditions for 4-25
Toolbar buttons 24-11 Trigger point for 4-24
View Menu 24-10 Modify Alarm Setups privilege 14-4
Login password Modify logging conditions
Security features 28-1 Database logger, Logging conditions 16-18
Login! Menu Modifying
Alarm Viewer 20-26 Alarm block group 12-7
LOGIN_RETRY_PERIOD 26-14 Modifying a device 5-5
Modifying an alarm
M Alarm block group 12-6
Modifying logging conditions for an alarm 16-47
Maintenance action export path Modifying Point Data in CWSERV 23-8
Database logger, Properties 16-36 Implementing a macro 23-9
Maintenance actions Macro Format 23-8
All tables 16-26 Performance considerations 23-8
Maintenance events Modifying table properties
All tables 16-24 Database logger, From point configuration 16-11
Managing saved logins 24-14 Modifying the Alarm Viewer Class List 20-51
Mapping colors in RGB.DAT Modifying the Alarm Viewer Resource List 20-52
Alarm class configuration 8-6 Modifying the Current Alarm Viewer Filter 20-51
Max capture points 4-22 Modifying the logging properties for the point
Equation for 4-22 Database logger, from point configuration 16-8
Reset point for 4-22 More about redundant alarm printers 13-8
Startup conditions for 4-23 MoveDownOneAlarm
Max caputre points Alarm viewer method 20-21
Trigger point for 4-22 MoveUpOneAlarm
MAX_STACKED 19-25, 26-15 Alarm viewer method 20-22
MAX_TREND_BUF 26-15 Mute sound
MCP_PROC_DOWN 10-3 Alarm sound manager 11-6
Menu Bar
CimView 21-3
N
Menu options
Browser 3-3 Naming an alarm viewer control 20-23
Login panel 24-10 Naming points 4-2
Show Users 24-3 Network options
xviii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Expression editor 4-6 Point configuration Properties - Device
General properties 4-55 Addressing 4-60
Integer vs. floating point engineering units for custom Analog Deadband 4-63
conversion 4-46 Device Id 4-59
Linear conversion 4-45 Domain Address 4-61
Naming points 4-2 Poll After Set 4-63
On update alarming 4-43 Scan Rate 4-63
Point bridge point configuration details 30-5 Trigger Settings 4-62
Rate of change alarming 4-44 Point configuration Properties - General
Reserved characters 4-2 Access 4-56
Reserved words 4-2 Availability trigger 4-57
Run-time notes for virtual points 4-35 Data Structure 4-55
Selecting a point class 4-3 Description 4-55
Set point password 4-52 Enable alarm 4-57
Set point security 4-51 Enable point 4-57
Setting run-time point properties 4-51 Enterprise point 4-57
Text point types 4-4 Logging 4-56
Trigger point update criteria 4-39 Point buffering 4-58
Types of alarming 4-43 Resource ID 4-55
Types of alarming - Absolute 4-43 Safety point 4-57
Types of alarming - Deviation 4-44 Point configuration Properties - View
Types of alarming - On update 4-43 Display Settings 4-69
Types of alarming - Rate of change 4-44 Format 4-68
Types of data conversion 4-45 Graphic Screen 4-70
Types of data conversion - Custom 4-46 Point configuration Properties - Virtual
Types of data conversion - Linear 4-45 Calculation Type 4-64
Using array points 4-35 Equation 4-65
Using the trigger functions 4-39 Interval 4-66
View Properties 4-68 Local 4-66
Virtual point calculation types 4-6 Point Manager 4-64
Virtual point interval trigger 4-42 Process Id 4-64
Virtual properties 4-64 Reset Point 4-65
Point configuration Properties - Alarm Rollover 4-66
Alarm Criteria 4-73 Start Time 4-66
Alarm Delay 4-74 Startup Conditions 4-66
Alarm Values 4-74 Trigger Point 4-65
Deadband 4-75 Variance 4-66
Definition 4-72 Point conflicts, Incorrect information
Help File 4-75 CIMPLICITY HMI and Control 18-11
Point configuration Properties - Alarm Option Point conflicts, New point
Acknowledge Timeout 4-78 CIMPLICITY HMI and Control 18-10
Deletion Requirements 4-78 Point conflicts, Resolving
Manual Reset Allowed 4-79 CIMPLICITY HMI and Control 18-9
Max Number Stacked 4-80 Point control panel
Repeat Timeout 4-77 About 22-1
Reset Timeout 4-79 Changing font colors 22-5
Point configuration Properties - Alarm Routing Displaying point properties 22-3
Adding A Role 4-76 Displaying point properties, Alarm 22-4
Creating A Role 4-77 Displaying point properties, Details 22-3
Displaying Role Attributes 4-76 Displaying points 22-2
Removing A Role 4-76 Getting started 22-1
Point configuration Properties - Conversion Saving the document 22-6
Conversion 4-70 Point control panel alarm changes
Custom Expressions 4-71 Security audit trail 28-3
Limits 4-71 Point data logging scan rate
xxii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Checking system output and error files 25-14 S
Project log files 25-1
System log files 25-1 SAFETY_PT 19-30
Viewing log files 25-1 Sample CWSERV Commands 23-2
Resource 4-50 Sample reports, Install
Resource Attributes Database logger 16-50
Alarm Mgr 6-2 Sample Spreadsheets and Macros for CWSERV 23-10
Description 6-2 Array point example 23-11
Resource ID 6-2 Single point example 23-10
Resource Type 6-2 SAMPLE_INTV 19-30
Resource configuration SAMPLE_INTV_UNIT 19-30
Adding a new user 6-4 Saved logins
Adding a user 6-4 Adding 24-14
Deleting a user 6-4 Managing 24-14
Resource definition 6-3 Removing 24-15
Viewing user properties 6-4 Saving the Alarm List Layout 20-41
Resource Configuration 6-1 Saving the Current Alarm Viewer Filter 20-54
Creating a resource 6-3 Saving the document
RESOURCE_ID 19-29 Point control panel 22-6
Resources Saving the status log as a text file 25-8
About 6-1 SCAN_RATE 19-31
Configuring 6-1 Scientific operations
REV_CONV_EQ 19-30 Expression editor 4-11
Role Attributes Screen Properties
Role Id 14-2 CimView 21-16
Role configuration Script control privilege 14-4
Creating a new role 14-3 Script, Creating for automatic report 16-61
Role properties 14-3 Scroll bars
Role Configuration 14-1 CimView 21-3
Role privileges Search string wildcards
Delete Alarm 14-4 Database logger 16-4
Dynamic Configuration 14-4 Searching for user information
Modify Alarm Setups 14-4 Show Users 24-8
Point by Address 14-4 Security audit trail
Process Control 14-4 Dynamic configuration changes 28-4
Script control 14-4 Point control panel alarm changes 28-3
Security features 28-2 Project login/logout 28-4
Set Point 14-4 Security features 28-3
Setpoint Audit Trail 14-4 Setpoint downloads 28-4
Trigger event 14-4 Security features
Role properties 14-3 About 28-1
Roles Login password 28-1
About 14-1 Role privileges 28-2
Configuring 14-2 Security audit trail 28-3
Rollover Security audit trail, Dynamic configuration changes
Delta accum points 4-17 28-4
ROLLOVER_VAL 19-30 Security audit trail, Point control panel alarm changes
RTR_ACCEPT_CONN 26-3 28-3
RTR_DISABLE_BCAST 26-3 Security audit trail, Project login/logout 28-4
RTR_MAX_OUTMESSAGE_COUNT 26-5 Security audit trail, Setpoint downloads 28-4
RTR_STANDALONE 26-3 Setpoint password 28-2
Running the Demo Project 1-22 Setpoint security 28-2
Running Without Authorization 1-17 SelectAllAlarms
Alarm viewer method 20-22
Selecting a point class 4-3
xxiv CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
$DYN_CFG 10-2 Process names 25-13
$GMR_DEV_DOWN 10-2 Saving status log as a text file 25-8
$GMR_POINT_DISCREPANCY 10-2 Selecting a log to view 25-6
$LOGON 10-2, 10-3 Selecting a printer 25-10
$LOGOUT 10-3 Shortcut keys 25-5
$REDUND_DEV_DOWN 10-3 Toolbar buttons 25-5
$RTR_LINK_DOWN 10-3 Using 25-2
AMSI_ALARM 10-3 View menu 25-4
DB_CONN_DOWN 10-3 Which status log file gets displayed 25-3
DB_START_FORWARD 10-3 Stop a project
MCP_PROC_DOWN 10-3 CIMPLICITY options 2-13
Start as a viewer Stopping a Project 1-25
CIMPLICITY options 2-13 Stopping a running process 24-20
Start project in list Stopping all running processes 24-21
CIMPLICITY options 2-14 Store and forward
Start time Database logger, Database disconnect recovery 27-13
Timer/counter points 4-27 Database logger, Logging properties 16-29
Starting A Halted Process 24-19 Database logger, Properties 16-38
Starting a project 1-24 Store and forward, Changing defaults, Database
Starting all halted processes 24-20 disconnect recovery 27-15
Starting CimView screens automatically at boot Store and forward, Enabling
Windows 95 2-16 Database logger, Database disconnect recovery 27-14
Starting CWSERV 23-7 Store and forward, Filenames
Starting the login panel 24-9 Database logger, Database disconnect recovery 27-14
Startup condition Store and forward, Maximum records
Delta accum points 4-18 Database logger, Database disconnect recovery 27-15
Equation point 4-14 Supported device protocols
Equation w/override points 4-34 CIMPLICITY HMI and Control 18-2
Global points 4-12 SVC_RETRY_COUNT 26-18
Histogram points 4-30 SVC_RETRY_DELAY 26-18
Trans-high accum points 4-32 SYSNAME 26-3
Startup conditions System - CWSERV System Topic 23-12
Average points 4-21 System Architecture 1-2
Max capture points 4-23 System boot options
Min capture points 4-25 CIMPLICITY options 2-15
Timer/counter points 4-28 System log and error files 25-1
Value accum points 4-19 System management 26-1
Startup options About 26-1
CIMPLICITY options 2-14 Deleting login information 26-23
Startup properites Global parameters See also Global parameters
Alarm sound manager 11-10 Device communications 26-19
startup.exe 2-26 Modified for all projects 26-4
STARTUP_TIMEOUT 26-3 Modified per project 26-6
STATE 23-3 Modified through configuration functions 26-2
Status Bar Global parameters, Editing 26-1
CimView 21-3 Global parameters, Sample File 26-20
Status log viewer Logical names, Descriptions 26-23
Displaying message details 25-7 Removing CIMPLICITY Software, Removing
Filtering messages 25-11 Windows 95 Registry Information 26-24
Finding messages 25-12 Removing CIMPLICITY Software, Removing
Finding the next message 25-13 Windows NT Registry Information 26-25
Help menu 25-5 Removing Registry Information 26-24
Log menu 25-4 System parameters
Menu options 25-4 Logical names See also Logical names
Printing the log file 25-9 Logical names, Editing the file 26-22
xxvi CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180
Trans-high accum points 4-32 Using array points 4-35
Value accum points 4-18 Using CIMPLICITY Software 2-1
Trigger point update criteria 4-39 Using CimView See CimView
Triggered maintenance events 16-25 Using client configuration 17-1
Troubleshooting Using CWSERV With Microsoft Excel 23-6
Web gateway 33-6 Using delta accum arrays 4-15
TYPE 23-4 Using the Alarm List Buttons 20-45
Types of alarming 4-43 Using the CIMPLICITY To Windows Server 23-1
Absolute alarming 4-43 Using the Project Wizard 2-7
Deviation alarming 4-44 Adding a new device 2-9
On update alarming 4-43 Adding a new point 2-10
Rate of change alarming 4-44 Adding a new port 2-7
Types of data conversion 4-45 Devices 2-8
Custom conversion 4-46 Modifying a device 2-9
Types of data Conversion Modifying a point 2-10
Integer vs. floating point engineering units for custom Modifying a port 2-8
conversion 4-46 Points 2-10
Linear conversion 4-45 Removing a device 2-9
Removing a point 2-10
U Removing a port 2-8
Step 1 of 3 2-7
Uninstall 1-21 Step 2 of 3 2-8
Unsolicited Step 3 of 3 2-10
Device point data collection 4-5 Using the Project WIzard
UPDATE_CRITERIA 19-32 Protocols and Ports 2-7
Upgrading CIMPLICITY software 1-18 Using the trigger functions 4-39
User Attributes Example 1 - device point interval trigger 4-41
Role Id 15-2 Example 2 - Efficiency 4-41
User Id 15-2 Example 3 - Virtual point interval trigger 4-42
User Name 15-2
User configuration 15-1
V
Creating a new user 15-4
Run-time login failures 15-3 validating project connections
Setting run-time user properties 15-3 Web gateway 33-4
User General Properties 15-5 Validating web connections
Password 15-5 Web gateway. 33-4
Password Needed 15-5 VALUE 23-3
Role 15-5 Value accum points 4-18
User Name 15-6 Equation for 4-18
User information Reset point for 4-19
Registering 1-15 Startup conditions for 4-19
User properties Trigger point for 4-18
Run-time 15-3 Variance
User Resource Properties 15-7 Delta accum points 4-17
Adding a single Resource 15-7 VARIANCE_VAL 19-32
Adding all Resource 15-7 VARS 19-33
Deleting a Resource 15-8 Version upgrades 1-19
Users View Alarms
About 15-1 Configuring the count color 20-29
Configuring 15-1 Configuring the count font 20-30
Default User 15-1 View menu
Roles and Privileges 15-1 Browser 3-3
Security 15-1 View Menu
View of Resources 15-1 Alarm Viewer 20-26
Using a Viewer 1-26 CimView 21-5
xxviii CIMPLICITY HMI for Windows NT and Windows 95 User’s Manual GFK-1180