Vous êtes sur la page 1sur 765

GE Fanuc Automation

CIMPLICITY Monitoring and Control Products

CIMPLICITY HMI
Base System
Users Manual
GFK-1180H

March 1999

GFL-002
Warning
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
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.

CIMPLICITY is a registered trademark of GE Fanuc Automation North America, Inc.


Windows, Windows NT, and Windows 95 are registered trademarks of Microsoft Corporation
Pentium is a registered trademark of Intel Corporation
DEC, AlphaServer and AlphaStation are trademarks of Digital Equipment Corporation

This manual was produced using Doc-To-Help, by WexTech Systems, Inc.

Copyright 1995-1998 GE Fanuc Automation North America, Inc.


All rights reserved

Preface

What This Manual Is For


This manual provides the information needed to correctly install, configure and
maintain CIMPLICITY software for process monitoring and supervisory control
applications. Use the manual in conjunction with whatever documentation
accompanies the specific computer hardware and monitoring devices at your facility..

Who This Manual Is For


This manual is intended for CIMPLICITY software users who should already have a
basic working knowledge of the facility environment - devices, computer hardware,
and networks - and of the Microsoft for Windows NT operating system.

How This Manual Is Organized


This manual is composed of the sections described below.
Chapter 1. Introduction: Introduces you to CIMPLICITY HMI and provides you
with distributor and technical support telephone numbers.
Chapter 2. Using the Workbench: Gives an overview of the Workbench layout and
describes how to take advantage of its numerous tools.
Chapter 3. Setting Up a CIMPLICITY Project: Discusses how to create and set
up a project in CIMPLICITY HMI.
Chapter 4. Understanding Points: Provides a brief overview for point naming rules
and point security.
Chapter 5: Quick Device Setup: Provides procedures to quickly set up a device in a
CIMPLICITY HMI project to begin collecting data from a PLC.
Chapter 6: Configuring Device Points: Provides procedures specific to configuring
device points.
Chapter 7: Configuring Virtual Points: Provides procedures specific to
configuring virtual points.
Chapter 8: Point View, Limits and Alarms: Provides procedures for configuring
views, limits and alarms for both virtual and device points.

GFK-1180H

iii

Chapter 9: Changing the Workbench Point Display: Describes the many ways to
change the point information displayed in the Workbench
Chapter 10: Using System Points: Describes the several points that are included in
CIMPLICITY HMI and can be used to display system information, including dates
and time.
Chapter 11: Point Cross Reference: Describes the CIMPLICITY HMI tool that
facilitates keeping track of where and how points are used.
Chapter 12. Device Configuration: Explains how to configure devices.
Chapter 13. Resource Configuration: Explains how to configure resources.
Chapter 14. Port Configuration: Explains how to configure ports.
Chapter 15. Alarm Class Configuration: Explains how to configure alarm classes.
Chapter 16. Alarm String Configuration: Explains how to configure alarm strings.
Chapter 17. Alarm Configuration: Explains how to configure alarms.
Chapter 18 Alarm Audio Support: Shows you how to configure audible alarms.
Chapter 19 Alarm Blocking: Shows you how to implement hierarchical alarm
blocking.
Chapter 20. Alarm Printer Configuration: Shows you how to configure a printer
to record alarm messages.
Chapter 21. Role Configuration: Explains how to configure roles.
Chapter 22. User Configuration: Explains how to configure users.
Chapter 23. Database Logger: Discusses the Database Logger option and how to
configure tables and reports.
Chapter 24. 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 25. Client Configuration: Shows you how to configure default logins for
CIMPLICITY HMI Viewers on client computers.
Chapter 26: Using CIMPLICITY HMI with CIMPLICITY Control: Shows you
how to import variables from a Control folder into points in an HMI project.
Chapter 27. Configuration Import/Export: Documents the Import/Export utility.
Chapter 28. Using the Alarm Viewer OCX: Documents how to use the Alarm
Viewer OCX in CimView to display alarm information.
Chapter 29. Alarm Viewer OCX Methods: Documents the methods you can use in
CimEdit and CimView in conjunction with the Alarm Viewer OCX.
Chapter 30. Using the Stand-Alone Alarm Viewer: Shows you how to use the
stand-alone Alarm Viewer to display alarm information.
Chapter 31. Using CimView: Explains the features of the graphic screen viewer.
Chapter 32. Using the Point Control Panel Shows you how to use the Point
Control Panel to display point information.
Chapter 33. Using the CIMPLICITY to Windows Server (DDE): Discusses how
to use CWSERV with third-party software such as Microsoft Excel spreadsheets.

iv

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Chapter 34. System Utilities: Describes the Show Users and Program Control
features of the System Utilities option.
Chapter 35. UsingMeasurement Units: Explains measurement units and how to
configure them.
Chapter 36. System Management: Discusses system management functions such as
Global Parameters and Logical Names: Changing them
CIMPLICITY HMI Software: Removing the software from a computer.
Security Features: Setting a Login Password, Role Privileges, Setpoint
Security, Setpoint Password and Security Audit Trail.
OEM Key: Using the OEM key to temporarily convert a Runtime license to a
Development license
Remote Projects, Point Bridge and Enterprise Server: Configuring remote
projects, point bridges to remote projects and enterprise server projects.
Site Wide Installation: Using the Microsoft Systems Management Server
(SMS) for site-wide installations of CIMPLICITY HMI software.
Chapter 37. Using CIMPLICITY HMI with Remote Access: Shows you how to
use the Remote Access features of Windows NT and Windows 95 to let users with
CIMPLICITY HMI Viewer software access project data through modems.
Chapter 38. CIMPLICITY HMI Web Gateway: Shows you how to use this
feature to let users access your CIMPLICITY HMI data over the Internet.
Appendix A. System Administrative Issues: Describes how to transfer
CIMPLICITY HMI licenses from one computer to another, do a floppy disk
installation and remove CIMPLICITY HMI from a system.
Appendix B. Resolving Problems: Discusses how to use the Status Log Viewer and
system log files to find an resolve problems.

GFK-1180H

Preface

Contents
Welcome to CIMPLICITY HMI

1-1

Welcome ................................................................................................................................ 1-1


Distributor Telephone Numbers............................................................................................. 1-1
Customer Support................................................................................................................... 1-2

Using the Workbench

2-1

About the Workbench ............................................................................................................ 2-1


Workbench at a Glance .......................................................................................................... 2-2
Opening the Workbench .......................................................................................... 2-2
Looking at the Workbenchs Components ............................................................... 2-3
Handling Multiple Open Windows .......................................................................... 2-4
Workbench Display Options .................................................................................................. 2-5
Expanding / Collapsing the Left Pane View ............................................................ 2-5
Changing the Right Pane View ................................................................................ 2-6
Selecting Records or Files to Display in the Right Pane.......................................... 2-7
Selecting Fields to Display in the Right Pane ........................................................ 2-11
Project Status........................................................................................................................ 2-14
Creating a New Project .......................................................................................... 2-14
Opening a CIMPLICITY HMI Project .................................................................. 2-16
Enabling the CIMPLICITY Project Wizard .......................................................... 2-18
Starting a CIMPLICITY HMI Project ................................................................... 2-20
Switching from One Project to Another................................................................. 2-20
Stopping a CIMPLICITY HMI Project ................................................................. 2-21
Updating a CIMPLICITY HMI Project ................................................................. 2-21
Record and File Configuration ............................................................................................. 2-24
Creating a New Record or File............................................................................... 2-25
Opening a Record or File for Modification............................................................ 2-26
Runtime Access.................................................................................................................... 2-28
Opening the CimView Screen................................................................................ 2-29
Opening Runtime Windows other than CimView.................................................. 2-30
Monitoring a Selected Point's Runtime Values ...................................................... 2-31
Dragging Points into the Point Control Panel ........................................................ 2-32

Setting Up a CIMPLICITY Project

3-1

Creating A New Project ......................................................................................................... 3-1


New Project Options ................................................................................................ 3-1
Opening a Project................................................................................................................... 3-3
Workbench Toolbar Buttons .................................................................................... 3-4
Workbench Shortcut Keys........................................................................................ 3-4
Setting Project Properties....................................................................................................... 3-5
Using the Project Wizard ....................................................................................................... 3-7
CIMPLICITY Project Wizard Step 1 of 3 ............................................................... 3-7

GFK-1180H

vii

CIMPLICITY Project Wizard Step 2 of 3 ............................................................... 3-8


CIMPLICITY Project Wizard Step 3 of 3 ............................................................. 3-10
Installing A Project............................................................................................................... 3-11
Setting CIMPLICITY Options ............................................................................................. 3-12
Setting CIMPLICITY Project Options................................................................... 3-12
Setting Startup Options .......................................................................................... 3-14
Starting CimView Screens Automatically on Windows 98/95............................... 3-16
Whats Running .................................................................................................................... 3-21
How Configuration Updates Are Handled............................................................................ 3-22
Dynamic Update..................................................................................................... 3-22
Logging In ............................................................................................................................ 3-24
Copying A Project to Diskette.............................................................................................. 3-25
CIMPLICITY Command Line Options................................................................................ 3-26

Understanding Points

4-1

About Points........................................................................................................................... 4-1


Categorizing Points .................................................................................................. 4-2
Naming Points.......................................................................................................... 4-3
Setpoint Security .................................................................................................................... 4-5
Opening the Point Setup Dialog Box ....................................................................... 4-5
Specifying Security for Points.................................................................................. 4-6

Quick Device Setup

5-1

About Quick Device Setup ..................................................................................................... 5-1


Enabling a Protocol in a CIMPLICITY HMI Project .............................................. 5-2
Adding a New Device .............................................................................................. 5-3

Configuring Device Points

6-1

About Device Point Configuration ......................................................................................... 6-1


New Device Points ................................................................................................................. 6-2
Basic Device Point Configuration .......................................................................................... 6-3
Selecting the Device Points Data Type................................................................... 6-3
Using Arrays ............................................................................................................ 6-6
Entering Addressing Specifications for the Device Point ........................................ 6-8
Advanced Device Point Configuration ................................................................................. 6-13
Configuring Advanced "General" Specifications for Device Points ...................... 6-13
Configuring Advanced Device Point Specifications .............................................. 6-18
Understanding the Trigger Function ...................................................................... 6-21
Point Conversions................................................................................................................. 6-26
Displaying the Conversion Tab.............................................................................. 6-26
Configuring Base Engineering Units for a Point.................................................... 6-27
Configuring the Conversion Type for a Device Point ............................................ 6-30
Device Point Quality Support at Runtime ............................................................................ 6-33

Configuring Virtual Points

7-1

About Virtual Point Configuration ......................................................................................... 7-1


New Virtual Points ................................................................................................................. 7-2
Basic Virtual Point Configuration .......................................................................................... 7-3
Selecting the Virtual Point's Data Type ................................................................... 7-3
Using Arrays ............................................................................................................ 7-5
Entering Initialization Specifications for a Virtual Point ......................................... 7-6
Specifying how Virtual Point Values are Stored...................................................... 7-8

viii

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Advanced Virtual Point Configuration................................................................................. 7-10


Entering Advanced General Specifications for Virtual Points ............................... 7-10
Configuring Advanced Virtual Calculations .......................................................... 7-15
Understanding the Trigger Function for Virtual Points.......................................... 7-34
Point Measurement Units ..................................................................................................... 7-3 6
Displaying the Conversion Tab.............................................................................. 7-36
Configuring Base Engineering Units for a Point.................................................... 7-36
About the Expression Editor ................................................................................................ 7-39
Alarm Functions..................................................................................................... 7-40
Arithmetic Operations............................................................................................ 7-41
Bitwise Operations................................................................................................. 7-42
Conversion Operation ............................................................................................ 7-43
Logical Operations................................................................................................. 7-43
Relational Operations............................................................................................. 7-43
Scientific Operations.............................................................................................. 7-44
Runtime Notes for Virtual Points ......................................................................................... 7-45

Configuring Point View, Limits and Alarms

8-1

About Point View, Limits and Alarms ................................................................................... 8-1


Point View.............................................................................................................................. 8-2
Associating a CimView Screen with a Point............................................................ 8-2
Configuring Analog Point Display Characteristics................................................. 8-3
Point Limits............................................................................................................................ 8-6
Displaying the Limits Tab........................................................................................ 8-6
Configuring Range Limits........................................................................................ 8-7
Configuring Setpoint Limits for a Point................................................................... 8-8
Alarms .................................................................................................................................... 8-9
Configuring the Basic Alarm Tab ............................................................................ 8-9
Displaying the Advanced Alarm Tabs ................................................................... 8-11
Configuring the Advanced Alarm Tab ................................................................... 8-12
Routing Alarms ...................................................................................................... 8-24
Setting Alarm Options............................................................................................ 8-25

Changing the Workbench Point Display

9-1

About the Workbench Point Display...................................................................................... 9-1


Customizing the Point List in the Workbench.......................................................... 9-1
Selecting Fields to Display in the Workbench ......................................................... 9-5

Using System Points

10-1

About System Points ............................................................................................................ 10-1


$LOCAL.COMPUTER.......................................................................................... 10-1
$LOCAL.WINUSER ............................................................................................. 10-1
$PROJECT.COMPUTER...................................................................................... 10-2
$PROJECT ............................................................................................................ 10-2
$PROJECT.AVAILABLE..................................................................................... 10-2
$PROJECT.LOGGEDIN ....................................................................................... 10-2
$PROJECT.DEVICES........................................................................................... 10-2
$PROJECT.USERS ............................................................................................... 10-3
$PROJECT.DATETIME ....................................................................................... 10-3
$PROJECT.DATE.YEAR ..................................................................................... 10-3
$PROJECT.DATE.MONTH ................................................................................. 10-3
$PROJECT.DATE.DAY ....................................................................................... 10-3

GFK-1180H

Contents

ix

$PROJECT.DATE.WEEKDAY ............................................................................ 10-4


$PROJECT.DATE.DAYOFYEAR........................................................................ 10-4
$PROJECT.DATE.WEEK .................................................................................... 10-4
$PROJECT.DATE.HOUR..................................................................................... 10-4
$PROJECT.DATE.HOUR12................................................................................. 10-4
$PROJECT.DATE.MINUTE ................................................................................ 10-5
$PROJECT.DATE.SECOND ................................................................................ 10-5
$PROJECT.DATE.SECOFDAY ........................................................................... 10-5
$PROJECT.DATE.AMPM.................................................................................... 10-5
$LOCAL.DATETIME ........................................................................................... 10-5
$LOCAL.DATE.YEAR ......................................................................................... 10-6
$LOCAL.DATE.MONTH ..................................................................................... 10-6
$LOCAL.DATE.DAY ........................................................................................... 10-6
$LOCAL.DATE.WEEKDAY................................................................................ 10-6
$LOCAL.DATE.DAYOFYEAR ........................................................................... 10-6
$LOCAL.DATE.WEEK ........................................................................................ 10-7
$LOCAL.DATE.HOUR......................................................................................... 10-7
$LOCAL.DATE.HOUR12..................................................................................... 10-7
$LOCAL.DATE.MINUTE .................................................................................... 10-7
$LOCAL.DATE.SECOND.................................................................................... 10-7
$LOCAL.DATE.SECOFDAY............................................................................... 10-8
$LOCAL.DATE.AMPM........................................................................................ 10-8
$USER.ALARMS.................................................................................................. 10-8
$ALARM.TOTAL ................................................................................................. 10-8
$ALARM.ACKED................................................................................................. 10-8
$ALARM.UNACKED........................................................................................... 10-9
$ALARM.ACTIVE................................................................................................ 10-9
$CLASS_<Alarm class name>.ALARMS ............................................................. 10-9
$CLASS_<Alarm class name>.UNACKED .......................................................... 10-9

Point Cross Reference

11-1

About Point Cross Reference ............................................................................................... 11-1


Opening the Point Cross Reference Window......................................................... 11-2
Building a Points Cross Reference Database ......................................................... 11-3
Viewing Points in the Point Cross Reference Window .......................................... 11-4
Focusing on One Point ........................................................................................... 11-9
Maintaining a Current Point Cross Reference Database ...................................... 11-11
Opening a Different CIMPLICITY HMI Project................................................. 11-13

Device Configuration

12-1

About Devices ...................................................................................................................... 12-1


Configuring Devices............................................................................................................. 12-1
Creating A New Device ......................................................................................... 12-3
Device General Properties ..................................................................................... 12-4
Device-Specific Properties..................................................................................... 12-5
Modifying A Device............................................................................................... 12-5

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Resource Configuration

13-1

About Resources ................................................................................................................ .. 13-1


Configuring Resources ......................................................................................................... 13-1
Creating A New Resource .................................................................................................... 13-3
Resource Definition ............................................................................................... 13-3

Port Configuration

14-1

About Ports .......................................................................................................................... 14-1


Configuring Ports ................................................................................................................. 14-1
Creating A New Port ............................................................................................................ 14-3
Port General Properties.......................................................................................... 14-4
Port-Specific Properties ......................................................................................... 14-4
Changing A Ports Protocol .................................................................................................. 14-5

Alarm Class Configuration

15-1

About Alarm Classes............................................................................................................ 15-1


Configuring Alarm Classes .................................................................................................. 15-1
Creating A New Alarm Class................................................................................. 15-3
Audio Support........................................................................................................ 15-4
Alarm Class Color Assignments........................................................................................... 15-5
Mapping Alarm Class Colors in RGB.DAT......................................................................... 15-6

Alarm String Configuration

16-1

About Alarm Strings ............................................................................................................ 16-1


Configuring Alarm Strings ................................................................................................... 16-2
Creating A New Alarm String Index...................................................................... 16-3

Alarm Configuration

17-1

About Alarms ....................................................................................................................... 17-1


Alarm Message Variable Run-time Parameters.................................................................... 17-1
Standard Alarms................................................................................................................... 17-2
Setting Run-Time Alarm Properties ..................................................................................... 17-4
More About Alarm Comments............................................................................... 17-4
Configuring Alarms.............................................................................................................. 17-5
Creating A New Alarm Definition ......................................................................... 17-6
Alarm Definition Properties for Non-Point Alarms ............................................... 17-7
Alarm Definition Properties for Point Alarms ....................................................... 17-9
Alarm Routing Properties .................................................................................... 17-12
Alarm Options Properties..................................................................................... 17-14

Using Alarm Audio Support

18-1

About Alarm Audio Support ................................................................................................ 18-1


About Prioritizing Alarms...................................................................................... 18-1
Configuring Alarm Audio Support....................................................................................... 18-3
About Alarm Sound Manager .............................................................................................. 18-5
Using the Alarm Sound Manager ......................................................................................... 18-5
Projects Properties ................................................................................................. 18-7
Option Properties ................................................................................................... 18-9
Startup Properties................................................................................................. 18-10

GFK-1180H

Contents

xi

Alarm Blocking Configuration

19-1

About Alarm Blocking ......................................................................................................... 19-1


Assigning Alarms ................................................................................................... 19-2
Choosing Blocking Modes ..................................................................................... 19-2
Assigning Alarm Priorities..................................................................................... 19-2
Alarm Blocking Rules............................................................................................ 19-3
Configuring Alarm Blocking ................................................................................................ 19-4
Creating an Alarm Block Group ............................................................................ 19-5
Adding an Alarm.................................................................................................... 19-6
Removing an Alarm ............................................................................................... 19-6
Modifying an Alarm............................................................................................... 19-7
Modifying an Alarm Block Group ......................................................................... 19-7

Alarm Printer Configuration

20-1

About Alarm Printer Configuration...................................................................................... 20-1


Adding an Alarm Printer ...................................................................................................... 20-2
Alarm Printer Properties....................................................................................................... 20-3
General Properties.................................................................................................. 20-3
Layout Properties ................................................................................................... 20-6
Date/Time Format .................................................................................................. 20-7
More about Redundant Alarm Printers................................................................................. 20-9
Additional Steps for Serial Printers .................................................................................... 20-10
Additional Steps for Network Printers ............................................................................... 20-11
Modifying the Size of the Alarm Queue............................................................................. 20-11
Choosing Delete and Acknowledge Times......................................................................... 20-12

Role Configuration

21-1

About Roles.......................................................................................................................... 21-1


Configuring Roles ................................................................................................................ 21-2
Creating A New Role ........................................................................................................... 21-3
Role Properties....................................................................................................... 21-3

User Configuration

22-1

About Users.......................................................................................................................... 22-1


Configuring Users ................................................................................................................ 22-1
Setting Run-Time User Properties........................................................................................ 22-3
What Happens at Run-Time................................................................................... 22-3
Creating a New User ............................................................................................................ 22-4
User General Properties ......................................................................................... 22-5
User Resource Properties ....................................................................................... 22-7

Database Logger

23-1

About the Database Logger .................................................................................................. 23-1


Types of Log Files Available ............................................................................................... 23-1
Alarm Logging ....................................................................................................... 23-2
Event Logging........................................................................................................ 23-3
Data Logging.......................................................................................................... 23-3
Group Logging....................................................................................................... 23-4
Application Logging .............................................................................................. 23-4

xii

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Creating Tables ................................................................................................................ .... 23-5


Microsoft Access Note........................................................................................... 23-5
Using Wildcards in Search Strings....................................................................................... 23-5
Table Characteristics............................................................................................................ 23-6
Column Definitions................................................................................................ 23-6
Key Definitions ...................................................................................................... 23-7
Entering from Point Configuration....................................................................................... 23-8
Point Logging......................................................................................................... 23-8
Alarm Logging..................................................................................................... 23-10
Using the Table Browser...................................................................................... 23-11
Starting from Your Projects Workbench ........................................................................... 23-13
Database Logger Window Menu Options ............................................................ 23-14
Using the Window Pop-Up Menu........................................................................ 23-16
Database Logger Toolbar Buttons ....................................................................... 23-17
Database Logger Shortcut Keys........................................................................... 23-17
Activating Dynamic Configuration ...................................................................... 23-18
Creating A New Table........................................................................................................ 23-19
Table Properties ................................................................................................................. 23-20
Default Logging Conditions for the ALARM_LOG Table .................................. 23-21
Logging Conditions for Group and Data Tables .................................................. 23-22
Logging Attributes for ALARM_LOG, EVENT_LOG and Application Tables . 23-25
Logging Attributes for Group and Data Tables.................................................... 23-26
Maintenance Events for All Tables...................................................................... 23-27
Maintenance Actions for All Tables .................................................................... 23-31
Logging Properties for All Tables........................................................................ 23-33
Filtering the Table List....................................................................................................... 23-35
Copying a Table ................................................................................................................. 23-36
Renaming A Table ............................................................................................................. 23-36
Deleting A Table ................................................................................................................ 23-37
Reconciling a Table............................................................................................................ 23-38
Creating Uncreated Database Fields .................................................................... 23-39
Removing Unused Microsoft Access Fields ........................................................ 23-39
Removing Unused SQL Server and Oracle Fields ............................................... 23-39
Database Logger Properties ............................................................................................... 23-40
Parameters............................................................................................................ 23-40
Alarm and Point Logging..................................................................................... 23-42
Displaying A Table ............................................................................................................ 23-45
Table Menu Options ............................................................................................ 23-46
Using The Window Pop-Up Menu ...................................................................... 23-48
Table Toolbar Buttons ......................................................................................... 23-48
Adding Points to A Table................................................................................................... 23-49
Removing Points from A Table.......................................................................................... 23-49
Editing Point Logging Properties ....................................................................................... 23-49
Group Table Point Properties .............................................................................. 23-50
Data Table Point Properties ................................................................................. 23-51
Alarm Log Table Point Properties ....................................................................... 23-54
Filtering the Point List........................................................................................................ 23-55
Filtering the Alarm or Event List ....................................................................................... 23-55
Reporting............................................................................................................................ 23-56
Notes on Installing Microsoft Excel..................................................................... 23-56
Installing the Sample Reports .............................................................................. 23-58
Alarm Report...................................................................................................................... 23-59
Setting Alarm Report Parameters......................................................................... 23-60
Generating an Alarm Report ................................................................................ 23-61
Clearing the Alarm Error Log .............................................................................. 23-61

GFK-1180H

Contents

xiii

Data Report ........................................................................................................................ 23-62


Setting Data Report Parameters ........................................................................... 23-63
Generating A Data Report.................................................................................... 23-64
Clearing the Data Error Log................................................................................. 23-64
Trend Report ...................................................................................................................... 23-65
Setting Trend Report Parameters ......................................................................... 23-66
Generating A Trend Report.................................................................................. 23-67
Clearing the Trend Error Log............................................................................... 23-67
Printing Reports Automatically .......................................................................................... 23-68
Modifying the CIMPLICITY Service for Automatic Printing ............................. 23-68
Creating a Script................................................................................................... 23-69
Triggering an Automatic Report .......................................................................... 23-70

Managing Database Logging

24-1

About Managing Database Logging ..................................................................................... 24-1


ODBC Configuration............................................................................................................ 24-2
ODBC Drivers ....................................................................................................... 24-2
ODBC Data Sources .............................................................................................. 24-2
Moving Projects ..................................................................................................... 24-3
About Custom Data Sources .................................................................................. 24-3
Configuring Microsoft Access Data Sources ......................................................... 24-4
Installing SQL Server............................................................................................. 24-4
Configuring Additional SQL Server Data Sources ................................................ 24-7
Oracle Configuration ............................................................................................................ 24-8
Requirements ......................................................................................................... 24-8
Using Oracle with CIMPLICITY HMI .................................................................. 24-8
Database Management for SQL Server ................................................................................ 24-9
Configuring Additional Locks................................................................................ 24-9
Handling the Transaction Log.............................................................................. 24-10
Creating Tables .................................................................................................................. 24-11
Microsoft Access Note......................................................................................... 24-11
Table Characteristics .......................................................................................................... 24-11
Column Definitions .............................................................................................. 24-11
Key Definitions .................................................................................................... 24-12
Database Disconnect Recovery .......................................................................................... 24-13
Reconnect Wait Period......................................................................................... 24-13
Store and Forward................................................................................................ 24-13
Database Logger Global Parameters .................................................................................. 24-16
Configuring a Database Logger Global Parameter............................................... 24-16
DB_DEBUG ........................................................................................................ 24-17
DB_ENABLE_TRANSACTIONS ...................................................................... 24-18
DB_TIME_FORMAT.......................................................................................... 24-18
DB_TIMESTAMP_FIELD.................................................................................. 24-18
DB_TIMESTAMP_FILTER ............................................................................... 24-19

xiv

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Client Configuration

25-1

About Client Configuration.................................................................................................. 25-1


Using Client Configuration .................................................................................................. 25-1
Creating A New Client ......................................................................................................... 25-2
Client Properties .................................................................................................... 25-3

Using CIMPLICITY HMI with CIMPLICITY Control

26-1

About CIMPLICITY HMI and CIMPLICITY Control........................................................ 26-1


Supported Device Protocols................................................................................................. 26-2
Device Properties................................................................................................... 26-2
Associating Folders with Devices .......................................................................... 26-5
Import Process...................................................................................................................... 26-7
Import Rules......................................................................................................................... 26-7
Resolving Point Conflicts..................................................................................................... 26-8
New Point Conflicts ............................................................................................... 26-9
Incorrect Information Conflict ............................................................................. 26-10
Remote Configuration ........................................................................................................ 26-11
Example ............................................................................................................... 26-11

Configuration Import/Export

27-1

Introduction.......................................................................................................................... 27-1
Import/Export Data File Format........................................................................................... 27-2
Sample Data File.................................................................................................... 27-2
Editing CSV Files in Notepad................................................................................ 27-3
Editing CSV Files in Excel .................................................................................... 27-3
Import/Export Configuration Files ....................................................................................... 27-4
Import Field Defaults (ie_deflds.cfg)..................................................................... 27-4
Export Field Formats (ie_formats.cfg)................................................................... 27-5
Import/Export Log File ........................................................................................................ 27-6
Import/Export Log File Name................................................................................ 27-6
Import/Export Log File Format.............................................................................. 27-6
Importing Configuration Data .............................................................................................. 27-7
Import Procedure ................................................................................................... 27-7
Importing in Dynamic Mode.................................................................................. 27-8
Importing Additional Roles.................................................................................... 27-9
Exporting Configuration Data ............................................................................................ 27-10
Export Procedure ................................................................................................. 27-10
Deleting Configuration Data .............................................................................................. 27-12
Specifying Wildcards for Delete.......................................................................... 27-12
Import/Export Field Names................................................................................................ 27-13
Required Fields .................................................................................................... 27-13
Optional Fields..................................................................................................... 27-13
Logicmaster 90 Support ..................................................................................................... 27-34
Sample Logicmaster File...................................................................................... 27-34

GFK-1180H

Contents

xv

Using the Alarm Viewer OCX

28-1

About the Alarm Viewer OCX ............................................................................................. 28-1


Configuration Overview......................................................................................... 28-1
Run-Time Overview............................................................................................... 28-2
Configuring an Alarm Viewer OCX in CimEdit .................................................................. 28-3
Configuring Alarm Viewer Control Properties..................................................................... 28-4
Fields...................................................................................................................... 28- 5
Buttons ................................................................................................................... 28-7
Projects ................................................................................................................ 28-10
Sort/Display ......................................................................................................... 28-11
Count Layout........................................................................................................ 28-15
Date Format ......................................................................................................... 28-16
Fonts..................................................................................................................... 28-18
Colors................................................................................................................... 28-19
Creating Custom Buttons.................................................................................................... 28-20
Example ............................................................................................................... 28-21
Viewing the Alarm List ...................................................................................................... 28-22
Selecting Alarms from the List............................................................................. 28-22
Using the Alarm List Buttons ............................................................................................. 28-23
Changing the Setup Parameters............................................................................ 28-23
Refreshing the Alarm List .................................................................................... 28-23
Toggling Between Lists ....................................................................................... 28-23
Displaying User Help ........................................................................................... 28-23
Viewing the Alarm Stack ..................................................................................... 28-24
Viewing Alarm Comments................................................................................... 28-24
Viewing the Alarms CimView Screen................................................................. 28-25
Acknowledging an Alarm..................................................................................... 28-25
Resetting an Alarm............................................................................................... 28-26
Deleting an Alarm ................................................................................................ 28-26
Acknowledging and Resetting an Alarm .............................................................. 28-26
Acknowledging the First Alarm ........................................................................... 28-27
Acknowledging All Alarms.................................................................................. 28-27
Filtering Alarms.................................................................................................................. 28-28
Specifying a Default Setup for a Project .............................................................. 28-29
Loading an Alarm Setup ...................................................................................... 28-29
Modifying the Current Alarm Setup..................................................................... 28-30
Saving the Current Setup...................................................................................... 28-33
Creating A New Alarm Setup............................................................................... 28-33
Deleting an Alarm Setup ...................................................................................... 28-34
Declaring a Default Alarm Setup ......................................................................... 28-34
Using Default Alarm Setups............................................................................................... 28-35

xvi

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Viewer Methods

29-1

About Alarm Viewer Methods ............................................................................................. 29-1


Naming an Alarm Viewer Control ......................................................................... 29-1
Creating an Invoke Method Action........................................................................ 29-2
Alarm Viewer Methods ........................................................................................................ 29-2
AboutBox Method ................................................................................................. 29-3
DoAckAll Method ................................................................................................. 29-3
DoAckFirst Method ............................................................................................... 29-3
DoAcknowledge Method ....................................................................................... 29-3
DoAckReset Method.............................................................................................. 29-3
DoCimviewScreen Method .................................................................................... 29-3
DoComments Method ............................................................................................ 29-4
DoCustom<n> Method .......................................................................................... 29-4
DoDelete Method................................................................................................... 29-4
DoHelp Method ..................................................................................................... 29-4
DoRefresh Method................................................................................................. 29-4
DoReset Method .................................................................................................... 29-5
DoSetup Method .................................................................................................... 29-5
DoToggle Method.................................................................................................. 29-5
DoViewStack Method............................................................................................ 29-5
MoveDownOneAlarm Method .............................................................................. 29-5
MoveUpOneAlarm Method ................................................................................... 29-6
PageDownAlarms Method ..................................................................................... 29-6
PageUpAlarms Method.......................................................................................... 29-6
SelectAllAlarms Method........................................................................................ 29-6
SelectPageAlarms Method ..................................................................................... 29-6
SelectTopAlarm Method........................................................................................ 29-6

Using the Stand-Alone Alarm Viewer

30-1

About the Stand-Alone Alarm Viewer ................................................................................. 30-1


Configuring a Stand-Alone Alarm Viewer ........................................................................... 30-2
Alarm Viewer Menus............................................................................................. 30-3
Alarm Viewer Toolbar Buttons.............................................................................. 30-4
Alarm Viewer Shortcut Keys ................................................................................. 30-4
Configuring an Alarm View ................................................................................................. 30-5
Defining the Alarm Count Layout.......................................................................... 30-5
Defining the Alarm List Layout ............................................................................. 30-9
Saving the Layout ................................................................................................ 30-20
Creating Custom Buttons ................................................................................................... 30-20
Example ............................................................................................................... 30-21
Logging In to the Alarm Viewer ........................................................................................ 30-22
Viewing the Alarm List ...................................................................................................... 30-23
Selecting Alarms .................................................................................................. 30-23
Using the Alarm List Buttons............................................................................................. 30-23
Changing the Setup Parameters............................................................................ 30-24
Refreshing the Alarm List .................................................................................... 30-24
Toggling Between Lists ....................................................................................... 30-24
Displaying User Help........................................................................................... 30-24
Viewing the Alarm Stack ..................................................................................... 30-25
Viewing Alarm Comments................................................................................... 30-25
Viewing the Alarms CimView Screen................................................................. 30-26
Acknowledging an Alarm .................................................................................... 30-26

GFK-1180H

Contents

xvii

Resetting an Alarm............................................................................................... 30-26


Deleting an Alarm ................................................................................................ 30-26
Acknowledging and Resetting an Alarm .............................................................. 30-27
Acknowledging the First Alarm ........................................................................... 30-27
Acknowledging All Alarms.................................................................................. 30-27
Filtering Alarms.................................................................................................................. 30-28
Loading an Alarm Viewer Setup for Display ....................................................... 30-29
Modifying the Current Alarm Viewer Setup ........................................................ 30-30
Saving the Current Alarm Viewer Setup .............................................................. 30-33
Creating A New Alarm Viewer Setup .................................................................. 30-33
Deleting an Alarm Viewer Setup from the List .................................................... 30-33
Declaring a Default Alarm Viewer Setup............................................................. 30-33
Printing Alarms .................................................................................................................. 30-34
Copying Alarms.................................................................................................................. 30-34
Creating an Alarm Viewer Document Shortcut .................................................................. 30-35
Creating a Shortcut from Alarm Viewer .............................................................. 30-35
Creating a Shortcut from the File Manager .......................................................... 30-36
Command Line Options...................................................................................................... 30-36

Using CimView

31-1

About CimView.................................................................................................................... 31-1


Getting Started...................................................................................................................... 31-1
Window Components ........................................................................................................... 31-2
CimView Menus .................................................................................................... 31-4
Using the Control Menu......................................................................................... 31-7
Using the Window Pop-Up Menu .......................................................................... 31-8
CimView Toolbar Buttons ..................................................................................... 31-8
CimView Shortcut Keys......................................................................................... 31-9
Displaying A CimView Screen........................................................................................... 31-10
Selecting Action Objects .................................................................................................... 31-11
Executing the Procedure ...................................................................................... 31-12
Executing Slider Setpoints ................................................................................... 31-12
In-Place Edit Setpoint Actions ............................................................................. 31-13
Setting CimView Window Options .................................................................................... 31-14
Displaying CimView Help Information.............................................................................. 31-15
Displaying CimView Screen Help ....................................................................... 31-15
Displaying CimView Object Help........................................................................ 31-16
Displaying CimView Screen Properties ............................................................................. 31-16
Displaying CimView Object Properties ............................................................................. 31-17
CimView Command Line Options ..................................................................................... 31-17
OLE Controls in CimView ................................................................................................. 31-21

Using the Point Control Panel

32-1

About the Point Control Panel.............................................................................................. 32-1


Getting Started...................................................................................................................... 32-1
Displaying Points ................................................................................................... 32-2
Displaying Point Properties.................................................................................... 32-3
Enabling and Disabling Manual Mode................................................................... 32-5
Changing Font Colors ............................................................................................ 32-6
Saving A Point Control Panel Document ............................................................... 32-7

xviii

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using the CIMPLICITY To Windows Server (DDE)

33-1

About The CIMPLICITY To Windows Server.................................................................... 33-1


Command Syntax for CWSERV .......................................................................................... 33-1
Microsoft Excel Example....................................................................................... 33-2
Point Topic Attributes .......................................................................................................... 33-3
Using CWSERV with Microsoft Excel ................................................................................ 33-6
Displaying Point Data ............................................................................................ 33-6
Starting CWSERV ................................................................................................. 33-7
Modifying Point Data............................................................................................. 33-8
Sample Spreadsheets and Macros ........................................................................ 33-10
Command Syntax for System Topic................................................................................... 33-12
Formats ................................................................................................................ 33-12
System Items ........................................................................................................ 33-12
Topics .................................................................................................................. 33-12
Help ..................................................................................................................... 33-13
Error Messages................................................................................................................... 33-14
Remote Access of CWSERV on Windows NT .................................................................. 33-14
Creating a DDE Share.......................................................................................... 33-14
Referencing CWSERV from a Networked NT Client.......................................... 33-15

System Utilities

34-1

About System Utilities ......................................................................................................... 34-1


Using Show Users ................................................................................................................ 34-2
Starting Show Users............................................................................................... 34-2
Show Users Menu Options..................................................................................... 34-3
Show Users Toolbar Buttons ................................................................................. 34-5
Show Users Shortcut Keys..................................................................................... 34-6
Changing View Options ......................................................................................... 34-6
Opening A Project in Show Users.......................................................................... 34-7
Searching for User Information.............................................................................. 34-8
Closing A Project View in Show Users ................................................................. 34-9
Using the Login Panel ........................................................................................................ 34-10
Starting the Login Panel....................................................................................... 34-10
Login Panel Menu Options .................................................................................. 34-11
Login Panel Toolbar Buttons ............................................................................... 34-12
Login Panel Shortcut Keys................................................................................... 34-12
Logging out of a Project ...................................................................................... 34-13
Logging in to a Project......................................................................................... 34-13
Changing Password.............................................................................................. 34-14
Managing Saved Logins....................................................................................... 34-15
Using Program Control ...................................................................................................... 34-17
Starting Program Control ..................................................................................... 34-17
Using CIMPLICITY Program Control ................................................................ 34-18
Orderly Startup and Shutdown............................................................................. 34-19
CIMPLICITY HMI Processes ............................................................................. 34-20
Starting A Halted Process .................................................................................... 34-20
Stopping A Running Process ............................................................................... 34-21
Starting All Halted Processes............................................................................... 34-21
Stopping All Running Processes .......................................................................... 34-22
Refreshing the Process List.................................................................................. 34-22
Releasing the Connection..................................................................................... 34-22
Exiting Program Control...................................................................................... 34-22

GFK-1180H

Contents

xix

Using Measurement Units

35-1

About Measurement Units.................................................................................................... 35-1


Configuring Measurement Systems and Units...................................................................... 35-2
To Start Measurement Units .................................................................................. 35-3
Adding a New Measurement System ..................................................................... 35-4
Copying a Measurement System ............................................................................ 35-5
Renaming a Measurement System.......................................................................... 35-5
Creating a Base Measurement Unit........................................................................ 35-6
Editing Base Measurement Unit Properties ........................................................... 35-7
Defining an Equivalent Unit................................................................................... 35-7
Copying a Measurement Unit................................................................................. 35-9
Renaming a Measurement Unit ............................................................................ 35-10
Deleting a Measurement Unit............................................................................... 35-10
Specifying the Active Measurement System ...................................................................... 35-11
Specifying the Active Measurement System From the Measurement Units
Configuration Window................................................................................... 35-11
Specifying the Active Measurement System From the Project Properties Dialog box35-12
Following a Few Guidelines............................................................................................... 35-13
Floating Point Numbers vs. Integers .................................................................... 35-13
Derived Points...................................................................................................... 35-15
CimEdit Management of Animated Objects......................................................... 35-16
CimView Scripts .................................................................................................. 35-17
Event Manager and Basic Control Engine ........................................................... 35-18

System Management

36-1

About System Management.................................................................................................. 36-1


Global Parameters ................................................................................................................ 36-1
Editing the File....................................................................................................... 36-2
Parameters Modified through Configuration Functions ......................................... 36-2
Parameters Modified for All Projects..................................................................... 36-5
Parameters Modified Per Project ........................................................................... 36-7
Parameters for Device Communications .............................................................. 36-20
Sample File .......................................................................................................... 36-21
Logical Names.................................................................................................................... 36-22
Editing the File..................................................................................................... 36-23
Base System Logical Name Descriptions............................................................. 36-24
Deleting Login Information................................................................................................ 36-24
Removing Registry Information ......................................................................................... 36-25
Removing Windows 95 Registry Information...................................................... 36-25
Removing Windows NT Registry Information .................................................... 36-26
Site Wide Installation ......................................................................................................... 36-27
About Microsoft System Management Server (SMS) ........................................................ 36-28
How Client Package Distribution Works ............................................................. 36-29
CIMPLICITY HMI Site Wide Installation Procedure........................................................ 36-31
Creating the Application Source Directory .......................................................... 36-31
Creating SMS Package for CIMPLICITY HMI installation ................................ 36-33
Creating Job for CIMPLICITY HMI Installation ................................................ 36-34
CIMPLICITY Security Features ........................................................................................ 36-36
Login Password.................................................................................................... 36-36
Role Privileges ..................................................................................................... 36-36
Setpoint Security .................................................................................................. 36-37
Setpoint Password ................................................................................................ 36-37
Security Audit Trail.............................................................................................. 36-38

xx

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

OEM Key ........................................................................................................................... 36-40


OEM Key Activated........................................................................................................... 36-40
CIMPLICITY License Agreement....................................................................... 36-41
Stopping Running Projects................................................................................... 36-42
Starting OEM Key ............................................................................................... 36-43
Terminating OEM Key ........................................................................................ 36-43
Remote Projects ................................................................................................................ . 36-44
Creating A New Remote Project.......................................................................... 36-45
Configuring Point Bridge Points ........................................................................................ 36-48
Point Bridge Point Configuration Details ............................................................ 36-48

Using CIMPLICITY HMI with Remote Access

37-1

About Remote Access .......................................................................................................... 37-1


About the Examples in this Document................................................................... 37-2
Before You Start .................................................................................................................. 37-3
Server Setup (Windows NT) ................................................................................................ 37-4
Installing the Remote Access Service .................................................................... 37-4
Further Configuration for the Server...................................................................... 37-7
Client Setup (Windows NT)................................................................................................. 37-9
Installing the Remote Access Service .................................................................... 37-9
Further Configuration for the Viewer .................................................................. 37-11
Client Setup (Windows 98/95) ........................................................................................... 37-11
Configuring the CIMHOSTS.TXT File ............................................................................. 37-13
Testing the Connection....................................................................................................... 37-13
Ping ...................................................................................................................... 37-13
Configuring CIMPLICITY Options on the Server ............................................................. 37-14
Networking Considerations ................................................................................................ 37-14
RAS Client has a network card configured .......................................................... 37-14
Limitations on RAS Support .............................................................................................. 37-15

CIMPLICITY HMI WebGateway

38-1

About the CIMPLICITY HMI WebGateway....................................................................... 38-1


Installing the CIMPLICITY HMI WebGateway.................................................................. 38-1
Web Server Requirements ..................................................................................... 38-2
Installation Procedure ............................................................................................ 38-2
More about CIMPLICITY HMI WebGateway Components ................................. 38-3
Project Setup ........................................................................................................................ 38-3
Testing the Connections ....................................................................................................... 38-4
Validating Project Connections ............................................................................. 38-4
Validating Web Connections ................................................................................. 38-4
Troubleshooting and Error Messages................................................................................... 38-6
Troubleshooting Custom HTML Pages ................................................................. 38-6
Error Messages ...................................................................................................... 38-6
CIMPLICITY HMI Web Data Applet ................................................................................. 38-8
setCaption (Method) .............................................................................................. 38-8
getCaption (Method).............................................................................................. 38-8
appendCaption (Method) ....................................................................................... 38-8
pointGet (Method) ................................................................................................. 38-8
pointSet (Method) ................................................................................................ 38-10
clearPoints (Method)............................................................................................ 38-10
setPointID (Method) ............................................................................................ 38-10
getPointValue (Method)....................................................................................... 38-11
getPointStatus (Method) ...................................................................................... 38-11

GFK-1180H

Contents

xxi

Appendix A - System Administrative Issues

A-1

About System Administrative Issues ..................................................................................... A-1


CIMPLICITY HMI License Transfer.................................................................................... A-1
Transferring a License from One Computer to Another.......................................... A-1
Transferring Licenses over a Network .................................................................... A-2
Diskette License Transfer........................................................................................ A-3
Floppy Disk Installation ....................................................................................................... . A-4
Using the Command Format ................................................................................... A-4
Creating a Floppy Distribution................................................................................ A-5
Creating A Replacement Floppy ............................................................................. A-5
Installing CIMPLICITY HMI From A Floppy........................................................ A-5
Removing CIMPLICITY HMI Software............................................................................... A-6
Removing CIMPLICITY HMI from Windows 95/98............................................. A-6
Removing CIMPLICITY HMI From Windows NT................................................ A-6

Appendix B - Resolving Problems

B-1

About CIMPLICITY HMI Log Files .................................................................................... B-1


System Log Files..................................................................................................... B-1
Project Log Files ..................................................................................................... B-1
Viewing Log Files................................................................................................... B-1
Using the Status Log Viewer ................................................................................................. B-2
Which Status Log File Gets Displayed ................................................................... B-3
Status Log Viewer Menu Options ........................................................................... B-4
Status Log Viewer Toolbar Buttons........................................................................ B-5
Status Log Viewer Shortcut Keys ........................................................................... B-5
Selecting a Status Log to View.............................................................................................. B-6
Displaying Status Log Message Details ................................................................................ B-7
Saving the Status Log as a Text File ..................................................................................... B-8
Printing the Status Log File ................................................................................................... B-9
Selecting a Status Log Printer ............................................................................................. B-10
Filtering the Status Log Messages ....................................................................................... B-11
Finding Status Log Messages .............................................................................................. B-12
Finding the Next Status Log Message................................................................... B-13
Process Names in Status Log ................................................................................ B-13
Checking System Output and Error Files ............................................................................ B-14
Checking Process Output and Error Files............................................................................ B-14
Backup Process Log Files ..................................................................................... B-15

Index

xxii

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Welcome to CIMPLICITY HMI


Welcome
Congratulations for selecting GE Fanuc Automations CIMPLICITY HMI product.
CIMPLICITY HMI provides you with an extraordinary number of tools that enable
you to configure the product precisely to your system requirements.
If you are a new user, take advantage of this Base System User'sOperation Manual
to familiarize yourself with the basic configuration steps. The chapters are ordered
according to how someone would set up a standard system. They begin with opening
the Workbench, which is at the center of CIMPLICITY HMI configuration
If you are an experienced user, check the manual to find out about the new
CIMPLICITY HMI features.
Read the Getting Started Manual to find out about all the CIMPLICITY HMI
documentation that GE Fanuc Automation offers.

Distributor Telephone Numbers


GE Fanuc Automation offers several options, in addition to the CIMPLICITY HMI
base product. You can learn more about these options in the demonstration that is
included on the CD. The Getting Started Manual describes how to run the
demonstration.
For more information about purchasing GE Fanuc products, call your distributor.
You can call the GE Fanuc Information Centers at the following numbers for the
location of your nearest GE Fanuc sales representative authorized distributor:

GFK-1180H

USA and Canada

(800) 648-2001

Europe

(352) 727979-1

Asia Pacific

(65) 566-4919

Latin America

(610) 437-7932

Mexico

(800) 989-1244

1-1

Customer Support
GE Fanuc takes pride in the high quality of CIMPLICITY HMI software. Great
emphasis has been placed on ensuring the quality of this system throughout
development and testing. However, the tremendous power that the software offers
may cause you to encounter problems or questions for your specific configuration.
If your CIMPLICITY software system is under warranty or is covered by a valid
support contract, you may obtain assistance and 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 HMI Hotline is available from 8 A.M. to 8 P.M. Eastern Time,
Monday through Friday, except for regularly scheduled USA holidays.

1-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using the Workbench


About the Workbench
Your CIMPLICITY HMI Workbench, which is at the center of your CIMPLICTY
project, provides you with the power you need to view, configure, organize, and
manage every component of your project through one easy to use window.
Among the many capabilities that are packed into the Workbenchs familiar Windows
NT and 95/98 interface is the capability for you to:

GFK-1180H

Select what information to display including:

A collapsed list of applications to an entire expanded


project view

A selected record or file listing that is associated with


an application to a list of all its associated records or
files.

The fields to display for the list of records or files

Easily handle any project, including:

Create a new project with the help of the


CIMPLICITY Project Wizard

Open an existing project

Start and stop a selected project

Maintain an updated configuration

Configure any area of your project by quickly opening the appropriate dialog
box to:

Create or add a new component to any application

Edit the configuration for any existing component

Access all runtime information directly through the Workbench including


viewing point values through a:

Point Control Panel into which you can drag and drop
selected points from the Workbench whenever you
want to quickly monitor them

Quick Trend Chart

CimView screens in which they are configured

2-1

Workbench at a Glance
Within the Windows NT and 95/98 familiar environment, CIMPLICITY HMIs
Workbench provides you with all the unique CIMPLICITY HMI Power Tools you
need to create and manage your project with maximum efficiency.

Opening the Workbench


You open the Workbench the same way you open any Windows NT and 95/98
application.
To open CIMPLICITY HMI Workbench:
1.

Select Start on the Windows NT and 95/98 menu bar.

2.

Select Programs.

3.

Select CIMPLICITY.

4.

Select the project you want to open.

The CIMPLICITY HMI Workbench appears.


CIMPLICITY HMI Workbench
First Opened
Expanded to view all points

2-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Tip: For quick access to the Workbench, place a shortcut of your projects .GEF file
on the Windows NT and 95/98 desktop.

Looking at the Workbenchs Components


You will recognize some of the Workbenchs tools from your Windows NT and
95/98 toolbars and file menus. You will find the others to be powerful CIMPLICITY
HMI additions.
Quick Overview of the CIMPLICITY HMI Workbench Features
Left to right:
w Dynamic update
w Stop project
w Start project

Left to right:
w Configuration update
w Status log
w Project properties Right pane
views
w Project wizard

Help

Search
Field
Properties chooser

Screens
Points

Application Folder
Objects in application
Expand the tree

Collapse the tree

Status bar
Files or records
associated with object

Fields chosen for display

When you glance at the Workbench you will see that:

CIMPLICITY applications appear as folders in the left pane. You can open
or close the folders, to view or hide their contents.

When you open the folder you will see the icon for an application. You can
expand any icon with subordinate icons to display them also.

When you select an icon in the left pane, one or more of its records or files
display in the right pane. You control what the list displays including the:

GFK-1180H

Files or records

Fields associated with the files or records

You can access many of the Workbenchs Power Tools on its tool bar. In
addition, you will find them in its menus, both on the menu bar, and popup
menus.

Using the Workbench

2-3

Tip: Place the cursor over any object in the Workbench to display a brief description
of what it does.
The status bar provides you with information that includes how many records are
retrieved, if the project is running, and if a specified task has been completed.

Handling Multiple Open Windows


Multiple Workbench windows of different CIMPLICITY HMI projects can be open at
the same time.
Changes that are made to a project on one screen, are immediately included in any
other open version of the project.
If changes are made to a project, which you are working with, on a different screen
from yours, you can easily refresh your view to make sure that what you are looking at
is current.
To open more than one Workbench window:
1.

Select File on the Workbench menu bar.

2.

Select New.

3.

Select Window.

File Drop Down Menu

When the Workbench is open on more than one screen you can keep your screen upto-date by refreshing the window.
To refresh the Workbench window:
Method 1
Press F5.
Method 2

2-4

1.

Select View on the Workbench menu bar.

2.

Select Refresh.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Workbench Display Options


The Workbench display can be as sparse or as detailed as you need. You can:

Expand or collapse how you view folders in the left pane

Change the right pane view to display

Detailed lists displaying selected fields

Simple lists

Large icons

Select what objects to view in the right pane

Choose the fields you want to view in the right pane

Expanding / Collapsing the Left Pane View


You can expand or collapse folders or icons that have subordinate icons the same way
you do in Windows NT and 95/98 Explorer.
To expand / collapse folders in the left pane:
Configuration Explorer Left Pane

Click to
expand the tree

Click to
collapse the tree

GFK-1180H

1.

Click the + to expand the tree.

2.

Click the to collapse it.

Using the Workbench

2-5

Changing the Right Pane View


Right pane view options emulate the Windows NT and 95/98 Explorer options,
including:

Detailed lists with field information

Lists of records or files

Large icons

To change the right pane view:


Method 1
1.

Select Edit on the Workbench menu bar.

2.

Select the View from the following choices:

Large Icons

List

Details

Tree

Method 2
Press the standard Windows NT and 95/98 button on the Workbench toolbar.
From left to right: List, Detail, Large
Icons and Tree View
The right pane view changes to reflect your choice.

2-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Different Views in the Right Pane


List
Detail

Large Icon

Tree

Selecting Records or Files to Display in the Right Pane


CIMPLICITY HMI offers you an efficient way to view:

All of the records or files associated with a selected icon

Only the records or file you need at any given time

In addition, you will find several tools to help you specify the required records or
files.

Procedure for Displaying All Records or Files for an Icon


The procedures for selecting to view all records or files for a selected icon are as
follows.

Note: Whether you view a list of records or of files depends on the icon you select in
the left pane.
For example, if you select Points in the left pane, you will view a list of records in
the right. If you select Screens in the left, you will view a list of files in the right.

GFK-1180H

Using the Workbench

2-7

To view all the records (or files) for a selected icon:


1.

Select an icon in the left pane.

2.

Tell CIMPLICITY HMI to automatically display all the records by either of


the following methods:
Method 1
A. Select View on the Workbench menu bar.
B. Select Autofill if there is no check mark on its left
side.
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Autofill from the popup menu if there is no
check mark on its left side.

CIMPLICITY HMI displays a list of all the existing records or files for the
selected icon when you use either method.

Procedure for Displaying Selected Records or Files


The procedures for displaying selected records or files for a selected icon are as
follows.

Note: Whether you view a list of records or of files depends on the icon you select in
the left pane.
For example, if you select Points in the left pane, you will view a list of records in
the right. If you select Screens in the left, you will view a list of files in the right.
To view selected records (or files) for a selected icon:
1.

Select an icon in the left pane.

2.

Display a Search dialog box using any of the following methods.


Method 1
A. Select View on the Workbench menu bar.
B. Select Search.
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Search.
Method 3
Press the Search button

on the Workbench toolbar.

The Search dialog box associated with the selected icon appears.

2-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Search Dialog Box Example


This dialog box is for points.

Enter one or more search


criteria

3.

Opens a Browser
window

Enter the name or associated information for the record(s) or file that you
want to display. What format the information (records, files) is in depends
on what you select in the left pane.

The records or files you specify will display in the right pane until you change
your specifications.

Tools for Finding the Names of Records or Files to List


CIMPLICITY HMI provides you with the appropriate search tool each time you need
help qualifying what records or files you want to list.
These tools include:

Browse windows for:

Alarms

Devices

Points

Ports

Roles

Resources

Users
Workbenchs Explore tool for all search windows that request a file name

Opening CIMPLICITY HMI Browse Windows


to open browsers
Throughout CIMPLICITY HMI you will find browse buttons
that help you find names or categories of records that are associated with a selected
icon. They all appear in the Workbench when you need them.

GFK-1180H

Using the Workbench

2-9

To open a browse window and find a selected object and/or category:


Click the browse button when it appears at the right of a field. The appropriate
Browse window will open.
Browser Window Example
This browser is for points.

Using the Workbenchs Explore Tool


To find a file by using the Workbenchs Explore tool:
1. Close the Search dialog box, if it is open.
2. Select Project on the Workbench menu bar.
3. Select Explore.
Project Drop Down Menu

A Windows NT and 95/98 Explorer window opens and displays the open
projects directory.

2-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

4. Use the Windows NT and 95/98 Explorer to find the type of files you are
looking for.
A. Open the folder with the file you are looking for. For
example, open the Screens folder for CimEdit files.
B. Select the file to include in the Workbenchs list.
5. Place the Windows NT and 95/98 Explorer window next to the Workbench.
6. Open the Search dialog box.
7. Type the name of the file in the Filename field.
The appropriate entry appears in the right pane of the Workbench.

Selecting Fields to Display in the Right Pane


There are one or more fields for any icon that, when displayed, help you determine
exactly what an icon represents. You can display as few or as many of these fields as
you want in the Workbenchs right pane list.
The procedures for two steps to configure the Workbench right pane fields are:
Step 1: Open the Field Chooser dialog box using any one of several methods.
Step 2: Select the fields to display (or remove from display).
Step 1: Open the Field Chooser dialog box:
1.

Select an icon in the left pane.

2.

Use any of the following methods to open the Field Chooser dialog box.
Method 1
A. Click the right mouse button in the right pane.
C. Select Field Chooser from the popup menu.
Popup

GFK-1180H

Using the Workbench

2-11

Method 2
A. Select View on the Workbench menu bar.
C. Select Field Chooser.
View Drop Down Menu

Method 3
Press the Field Chooser button

on the Workbench toolbar.

The appropriate Field Chooser dialog box opens when you use any of these
methods.
Step 2: Select the fields to display (or remove from display) in the
Workbench right pane.
Example: Three Field Chooser Dialog Boxes
Field Choosers for:
Users

Devices

Points

Moves field further


left in the pane
Moves field further
right in the pane

Fields that will not display

2-12

Fields that will display

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

3.

Select a field in the Available field column that you want to add to your
display.

4.

Press Add. The field will move over to the Display fields column.

4.

Select any field in the Display fields column that you do not want to display.

5.

Press Remove. The field will move over to the Available field column.

6.

Use the Move Up and Move Down buttons change a selected fields place in
the list.

7.

Move on the list

Moves the fields column to the:

Up

Left of the fields beneath it

Down
Right of the fields above it
Press OK. The fields display from left to right in the order you specified.

Note: The Remove button will be disabled if the field is required. The Move
Down or Move Up button will be disabled if a field that will be affected by the
move has to appear in the furthest left position.

GFK-1180H

Using the Workbench

2-13

Project Status
You can easily open, start, stop and do dynamic configuration for any of several
projects through the CIMPLICITY HMI Workbench.
The following procedures deal with these tasks:

Create a new project

Open a project

Start the project running

Specify Dynamic Configuration

Switch to another open project

Stop the project

Creating a New Project


To create a new project:
1.

Select File on the Workbench menu bar.


File Drop Down Menu

2-14

2.

Select New.

3.

Select Project.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The New Project dialog box opens.


New Project Dialog Box

Press to create the project

Enter a unique
project name

Selected options
display in the
Configuration
Cabinet

Browse to select the


projects path

4.

Open Network
configuration dialog
box

Enter a name for the project in the Project name field.


CIMPLICITY HMI automatically fills in the new subdirectory name.

5.

Select the options you want to be included in the project.

6.

Make sure the project is in the directory of your choice.


Note: Press Network if the project is on a network. The Windows NT and
95/98 Map Network Drive dialog box opens.

7.

Press Create.

CIMPLICITY HMI will create a new project.

GFK-1180H

Using the Workbench

2-15

Opening a CIMPLICITY HMI Project


You can work with as many open projects as your resources allow.
Step 1: Open an Open dialog box.
Step 2: Find the project and open it.
Step 1: Open an Open dialog box:
Method 1
1.

Select File on the Workbench menu bar.


File Drop Down Menu

2.

Select Open.

3.

Select Project.

Method 2
1.

Make sure nothing is selected in the right pane.

2.

Press Ctrl+O on the keyboard.

An Open dialog box opens when you use either method.

2-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Step 2: Find and open the CIMPLICITY HMI project:


Example: Selecting a Project to Open

1. Select the
project folder

2. Select the
.GEF file

GFK-1180H

1.

Select the folder that contains the project you want to open.

2.

Select the .GEF file.

3.

CIMPLICITY HMI opens the project. If the project needs to be updated, a


message box will display. The project will be updated and display once you
press OK. See Updating a CIMPLICITY HMI Project in this chapter.

Using the Workbench

2-17

Enabling the CIMPLICITY Project Wizard


CIMPLICITY HMI provides you with a CIMPLICITY Project Wizard to make it easy
for you to attach:

Attach protocols to ports / remove protocols from ports

Configure devices attached to your ports / remove devices from ports

Configure new points for the devices in your system / remove points from
your system

You can easily enable the wizard through the Workbench.


To enable the CIMPLICITY Project Wizard:
Method 1
1.

Select Project on the Workbench menu bar.

2.

Select Project on the Workbench toolbar.

3.

Select Project Wizard.


Project Drop Down Menu

Method 2
Press Ctrl+W on the keyboard.
The Project Wizard opens when you use either method. Follow the steps you need
to configure. At any point when you are finished, press Finish.

2-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Overview: CIMPLICITY Project Wizards 3 Steps

GFK-1180H

Attach communicaton protocols to a port.

Attach and configure devices to your ports.

Create new points and attach them to devices


on your system.

Using the Workbench

2-19

Starting a CIMPLICITY HMI Project


To start an open CIMPLICITY HMI project in the Workbench:
Method 1

Press the Run button

on the Workbench toolbar.

Method 2
1.

Select Project on the Workbench menu bar.

2.

Select Run.

Method 3
Press Ctrl+R on the keyboard.
Method 4
1.

Press Alt+P on the keyboard.

2.

Press R.

A CIMPLICITY Configuration dialog box opens asking you if it is ok to run the


project, when you use any method.
Continue
3.

Press OK.

The project starts running when you use any of these methods.

Switching from One Project to Another


To switch to another open project in the Workbench:
1.

Select File on the Workbench menu bar.

2.

Select Running projects list.

3.

Select the project you want from the extended menu.

File Drop Down Menu

Select a project

2-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Stopping a CIMPLICITY HMI Project


To stop a project:
Method 1
Press the Stop button on the Workbench toolbar.
Method 2
1.

Select Project on the Workbench menu bar.

2.

Select Stop.

Method 3
1.

Press Alt+P on the keyboard.

2.

Press S.

Updating a CIMPLICITY HMI Project


The Workbench provides you with several methods to make sure your projects
configuration is up to date. The methods fall into two basic categories:

Updating a project after a change is made

Dynamic Configuration

Project Update after a Change is Made


When you make any fundamental change in your project, such as adding a point,
and you are not using dynamic configuration, you have to update the
configuration before the change will take affect.
The Workbench provides you with:

Warnings that tell you if your project configuration is not up-to-date.

Easy procedures to make a project up-to-date, if it is not.

Method 1Update Warning Message


If a project needs to be updated when you start it, CIMPLICITY HMI will display a
message. When you press OK, CIMPLICITY HMI will update the configuration.

Method 2Display the Need Updatefield on the point list


1.

Select Points in the Workbench left pane.

2.

Open the Field Chooser dialog box. See Right Pane Field Selection in this
chapter.

GFK-1180H

Using the Workbench

2-21

3.

Add Need Update to the list of fields that will be displayed.

4.

Scan the list. If you see a:


1Do a Configuration Update
0Configuration for your points is up to date

To do a configuration update:
Method 1
1.

Select Project on the Workbench menu bar.


Project Drop Down Menu

Configuration Update is enabled.


Project needs update

2.

Configuration Update is disabled.


Project is current.

Select Configuration Update if it is enabled. If it is disabled the project is


up to date.

Method 2
1.

Press Alt+P on the keyboard.

2.

Press C.

The Workbench will do a configuration update, if it is needed.

Dynamic Configuration
If your user role has been assigned the option, dynamic update option is an efficient
way to make certain changes in project and have the project automatically updated.
The Workbench provides you with:

2-22

Some restrictions in dynamic configuration functionality, which you should


be aware of.

Easy procedures for dynamic configuration.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Important: There are some configuration procedures that have restricted


functionality in Dynamic Update mode. They are:
Application

In Dynamic Update Mode, You

Point Configuration

Cannot change:

Port Configuration

The calculation type for a Virtual point

The service for a Virtual point

May only modify:

Remote Projects

Base scan rate

Enable/Disable state of the port

Retry count

Cannot create or modify remote projects in


Dynamic Update mode.

To do dynamic configuration:
Method 1

Press the Dynamic button

on the Workbench toolbar.

Method 2
1.

Select Tools on the Workbench menu bar.

2.

Select Dynamic.

Method 3
1.

Press Alt+T on the keyboard.

2.

Press D.

If a password is required a password dialog box will open when you use any of these
methods. If a password is not required or if you enter the correct password, you will
be able to dynamically configure the project.
When you activate Dynamic Configuration, CIMPLICITY HMI updates your
projects configuration automatically. You dont have to return to the Workbench and
do a project update in order for your changes to take affect.

GFK-1180H

Using the Workbench

2-23

Record and File Configuration


The CIMPLICTY HMI Workbench provides you with an efficient environment in
which to create or add new components to your project.
You can also open any application that is associated with an icon in the left pane. For
example, if you use Microsoft Access as a database logger, you can open it directly
through the Workbench.
The appropriate New configuration tool opens for any selected icon.
For:

What Opens

Screens

A new screen

The following:

A related New dialog box


Points
Devices
Ports
Users
Roles
Resources
Remote projects
Clients

2-24

Script

Script window

Project status log

Notepad

System status log

Microsoft Excel

Scripts

Blank script window

For the Database Logger

Microsoft Access

Options

Option window, e.g. Action Calendar

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Creating a New Record or File


You can add a new component to any icon in the left pane of your project through the
Workbench. When you do, you will see it listed as a record or file in the right pane
when the icon is selected.
To create a new record or file:
1.

Select the icon in the left pane.

2.

Do any of the following:


Method 1
Double click the icon.
Method 2
A. Select File on the Workbench menu bar.
B. Select New.
C. Select Object.

GFK-1180H

Using the Workbench

2-25

File Drop Down Menu

Method 3
A. Press ALT+F.
The drop down File menu opens.
B. Press N.
C. Press O.
Method 3
Press Ctrl+N on the keyboard.
A new screen or appropriate new dialog box opens when
you use any of these methods.
Tip: If you want to use only the keyboard, you can also press the Arrow Up and/or
Arrow Down key to select the icon in the left pane of the Workbench.

Opening a Record or File for Modification


You can access any file, Properties dialog box or application to edit any component in
your project through the Workbench.
To select a record or file to be modified:
1.

Select the associated application in the Workbench right pane.

2.

Select the object to be changed or edited in the right pane.

Method 1
Press Alt+Enter on the keyboard.
Method 2

2-26

3.

Select Edit on the Workbench menu bar.

4.

Select Properties.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Method 3
3.

Press Alt+E.

4.

Select Properties.

Method 4
3.

Click the right mouse button.


A popup menu displays with menu items that reflect the selected object.

4.

Choose the menu item that will be one of the following:


Choose the menu item
For

To display
Edit

Screens

CimEdit screen

Properties
Points

Properties Point dialog box

Devices

Device dialog box

Ports

Port Properties dialog box

Users

User Properties dialog box

Roles

Roles dialog box

Resources

Resource Definition dialog box

Measurement Units

Measurement Unit Configuration


window

Event Editor

Event Editor Window

Alarm Sound Manager

Alarm Sound Manager Dialog Box

Open
Script

Script window

Project status log

Notepad

System status log

Microsoft Excel

Database Logger

Microsoft Access

Action Calendar

Action Calendar

Popups

GFK-1180H

Using the Workbench

2-27

Runtime Access
The Workbench provides you with access to all of CIMPLICITY HMI runtime
monitoring tools.
This includes letting you

Open any CimView screen

Review the status of a selected point from several different vantage points,
including a:
Point Control panel. When it is opened you can deal
with it the same way you would any open Point
Control Panel when it is opened.

Quick Trend chart to view its trend information

CimView screen on which the point appears

Take advantage of its drag and drop capability by opening a Point Control
Panel and dragging and dropping selected points from the Workbench to
monitor in the panel.

Open the associated window for any runtime monitoring tools, including:

2-28

Alarm ViewerAlarm Viewer window

Point Control PanelPoint Control Panel window

Login PanelLogin Panel window

Show UsersShow Users window


Open the dialog box for any runtime monitoring tools, including:

Alarm Sound Manager Alarm Sound Manager dialog


box

Process ControlProcess Control dialog box

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Opening the CimView Screen


You can open any CimView screen in your project and keep it open to
monitor the data for which it is designed.
To open a CimView screen through the Workbench:
1.

Make sure your project is running. See Starting a CIMPLICITY HMI Project
earlier in this chapter.

2.

Select CimView in the left pane of the Workbench.

3.

Select a screen in the right pane.

4.

Do one of the following:


Method 1
Double click your selection.
Method 2
A. Select File on the Workbench menu bar.
B. Select Open.
C. Select Object.

GFK-1180H

Using the Workbench

2-29

Method 3
A. Click the right mouse button.
B. Select Open from the popup menu.
Method 4
Press Crt+O on the keyboard.
The CimView screen you selected opens when you use any method.

Opening Runtime Windows other than CimView


Any runtime window can be opened directly through the Workbench. This includes
windows for the:

Alarm Viewer

Point Control Panel

Login Panel

Show Users

To open runtime windows:


1.

Select the runtime icon in the left pane that you want to monitor.

2.

Double click it or use any of the other methods available to open a runtime
window. See Opening the CimView Screen in this chapter.
The icons window opens displaying the data from the project that was
opened last.

3.

2-30

Review the information or change the project through the windows File
menu.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Monitoring a Selected Points Runtime Values


The Workbench gives you access to several CIMPLICITY HMI features that keep
track of a selected points runtime status and values.
They include opening a:

Point Control panel that displays the selected point (if you have user access).
Once opened, you can deal with it the same as you would any open Point
Control Panel.

Quick Trend chart to view the points trend information

CimView screen which was selected in the Point Properties dialog box.

Example: Monitoring a Runtime Point through the Workbench

Quick Trend

Popup menu for selected point


CimView

Point Control Panel

GFK-1180H

Using the Workbench

2-31

To view a points runtime values through the Workbench:


1.

Select Points in the Workbenchs left pane.

2.

Select the point you want to track in the right pane.

3.

Click the right mouse button.

4.

Select one o the following:


To open a:
Point Control Panel

Point Control panel displaying the selected


point
If allowed, you can set the point through the
panel.

Quick Trends

Quick Trend chart that trends the selected


point
You can then manipulate the chart, including
changing the axis limits, line color and add
other lines.

*.cim screens

Open any CimView screen that includes the


point in its configuration.
The object you select opens displaying at least the selected points values.

Dragging Points into the Point Control Panel


Selecting several points to monitor during runtime has never been easier. You simply
open a Point Control Panel and drag your selections into it.
To view runtime data by dragging and dropping points into the Point
Control Panel:
1.

Select Points in the Workbenchs left pane.

2.

Select the points you want to monitor in the right pane.

3.

Open a runtime window. See Opening a CimView Screen.

4.

Hold the mouse button down and drag the selected items into the blank
window.
If any of the dragged items already exist in the open window, the Workbench
displays a message and does not duplicate them.

5.

Release the mouse button.


CIMPLICITY HMI displays runtime information for the selected points.

2-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Example: Dragging Points from the Configuration Cabinet into an Open Control Panel

Open the Point Control panel

2
Select points in the Configuration Cabinet.
Drag them into the Point Control panel

CIMPLICITY HMI does not add


points that are already in the panel
Press OK.

GFK-1180H

The Point Control panel displays


the original points + all the
nonduplicated dragged points.

Using the Workbench

2-33

Setting Up a CIMPLICITY Project

Creating A New Project


To create a new local or remote project, select the New Project icon in the
CIMPLICITY HMI menu.

The project creation procedure displays a series of dialog boxes that let you:

Select the project type, name, and path.

Set project properties.

Use the project wizard to do initial configuration of ports, devices, and


points for the new project.

When the creation procedure is complete, select Install from the File menu to install
the project in a folder.

New Project Options


When you create a new project, the New Project dialog box opens.

GFK-1180H

3-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 Workbench for the project is created, and the Project
Properties dialog box opens to display the Options properties.

3-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Opening a Project
When you select a CIMPLICITY projects shortcut menu option from the Start
menu, the CIMPLICITY Workbench for the project opens.

You can use the menu options in the Workbench 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.

GFK-1180H

Setting Up a CIMPLICITY Project

3-3

Workbench Toolbar Buttons


The Toolbar buttons available to you are:
New

Creates a new project.

Open

Opens another project in this window.

Copy Project

Copies the current project to a new project.

Dynamic

Enables/disables dynamic configuration


updates.

Stop

Stops the running project.

Run

Runs the stopped project.

Configuration Update

Updates run-time configuration data.

Settings

Changes project settings.

Project Wizard

Runs the Project Wizard.

Workbench Shortcut Keys


You can also use various combinations of keystrokes in the Workbench to perform
commonly used functions:

3-4

Ctrl+N

Creates a new project.

Ctrl+O

Opens another project in this window.

Ctrl+C

Copies the current project to a new project.

Ctrl+R

Runs the stopped project.

Ctrl+W

Runs the Project Wizard.

Ctrl+L

Displays the Status Log for the project.

Alt+Spacebar

Displays the Control Menu.

Alt+F4

Closes the project window.

Ctrl+Esc

Displays the system Task List window.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

The General properties you can change are:

GFK-1180H

Project Type

If you want to change the project type, enter the new


type in this field. Use the drop-down list button to the
right of the input field to display the list of currently
available project types and select the one you want.

Project Name

If you want to change the project name, enter the new


name in this field.

Options

Select the options you want for this project from the list
of available options. Set the check box to select an
option. Otherwise, clear the check box.

Protocols

Select the device communication protocols you want to


use for this project from the list of available protocols.
Set the check box to select an option. Otherwise, clear
the check box.

Setting Up a CIMPLICITY Project

3-5

Options Properties

The Options properties you can change are:


Enable project broadcast

Set this box if you want to broadcast the project


name on the network.
When you broadcast the project name, users on
other nodes that request point data can use the
project name in fully qualified points. Otherwise,
they can only use the node name in fully qualified
points.

Computer name

Select the computer the project is to run on when


the project is started.
For all installations, you may run the project on
your computer.

Startup timeout

Enter the number of minutes to wait for the


project to start.
The default is 10 minutes.

3-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

CIMPLICITY Project Wizard Step 1 of 3


The CIMPLICITY Project Wizard Step 1 of 3 dialog box lets you select the
communication protocols you wish to attach to ports on the computer for this project.

Use this dialog box to:

Add new ports.

Remove a currently configured port.

Modify the protocol information for a port.

Select Next to move to the next page of the Project Wizard.

Select Close to close the Project Wizard and make no further changes.

Select Finish to close the Project Wizard and accept all changes.

Adding A New Port


To add a new port to the project configuration:
1.

Select the protocol you want to select from the Available Protocols list.

2.

Select Add->.

The New Port dialog box opens for the port you are adding. For more information
on adding a port, see Creating A New Port.

GFK-1180H

Setting Up a CIMPLICITY Project

3-7

Removing A Port
Note
You will not be allowed to delete a port unless all points and devices for that port
have been deleted.
To remove a currently configured port from the project configuration:
1.

Select the port you want to delete from the Configured Ports list.

2.

Select Remove. You will be asked if you want to delete the selected
object.

3.

Select Yes to delete the port.

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.

CIMPLICITY Project Wizard Step 2 of 3


The CIMPLICITY Project Wizard Step 2 of 3 dialog box lets you select the devices
you wish to attach to ports for this project.

Use this dialog box to:

3-8

Add new devices.

Remove a currently configured device.

Modify the protocol information for a device.

Select Next to move to the next page of the Project Wizard.

Select Back to move to the previous page of the Project Wizard.

Select Close to close the Project Wizard and make no further changes.

Select Finish to close the Project Wizard and accept all changes.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Setting Up a CIMPLICITY Project

3-9

CIMPLICITY Project Wizard Step 3 of 3


The CIMPLICITY Project Wizard Step 3 of 3 dialog box lets you configure points
for devices that you have configured for this project.

Use this dialog box to:

Add new points.

Remove a currently configured point.

Modify the properties for a point.

Select Back to move to the previous page of the Project Wizard.

Select Close to close the Project Wizard and make no further changes.

Select Finish to close the Project Wizard and accept all changes.

Adding A New Point


To add a new point to the project configuration:
1.

Select the device you want to select from the Available Devices list.

2.

Select Add->.

The New Point dialog box opens for the point you are adding. For more information
on adding a device, see Creating A New Point.

Removing A Point
To remove a currently configured point from the project configuration:
1.

Select the point you want to delete from the Configured Points list.

2.

Select Remove. You will be asked if you want to delete the selected
object.

3.

Select Yes to delete the point.

Modifying A Point
To modify a currently configured point for the project:
1.

Select the point you want to modify from the Configured Ports list.

2.

Select Modify.

The Point Properties dialog box for the selected point opens. For more information
on modifying point properties, see Creating A New Point.

3-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Installing A Project
Once you create a project, you will want to install it in a folder for easy access. In
the Workbench 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.

GFK-1180H

Setting Up a CIMPLICITY Project

3-11

Setting CIMPLICITY Options


To configure CIMPLICITY options, or to start or stop projects, select the
CIMPLICITY Options menu item from the CIMPLICITY HMI menu.
The CIMPLICITY Options dialog box opens.
Use this dialog box to:

Halt a currently running project on your Server.

Start a project on your Server.

Start a project as a Viewer.

Select a default project to be run on your Server.

You can also:

Display the currently running projects on Servers in your network.

Halt a currently running project on a Server in your network.

Start a project on a Server in your network (subject to restrictions).

Setting CIMPLICITY Project Options

Use the Projects property page to display, start, and stop projects on a computer.

3-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

CIMPLICITY software supports


running multiple projects on a single
computer.

When you open the CIMPLICITY Options dialog box, it is connected to your
computer and shows you the currently running projects as well as the projects
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.

Connecting to Another Computer


Important
You can only connect to a project on a remote computer in Windows NT.
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.

Stop a Running Project


You may stop any project that is currently running the computer to which you are
currently connected.
To halt a running project:
1.

Select the project in the Running projects list.

2.

Select Stop. A confirmation dialog box opens.

3.

Select Yes to confirm that you want to proceed with the shutdown.

After the project is halted, the project is removed from the Running projects list.

GFK-1180H

Setting Up a CIMPLICITY Project

3-13

Add a Project to the Projects List


You may add projects to the Projects list. To do this:
1.

Select Add. The Open dialog box opens.

2.

Use the Open dialog box to search for the project (.gef) file you want.
When you find it, select OK.

The project you select is added to the Projects list.

Start a Project in the Projects List


To start a project in the Projects list:
1.

Select the project.

2.

Select Start.

3.

Verify that you want to start the project.

The project you select is started. When startup is complete, the project name is listed
in the Running projects list.

Setting Startup Options

Use the Startup Options property page to

3-14

Set the network options for the computer.

Select projects to start when the computer starts.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

System Boot Options


The projects in this list are projects on your computers local drive that you want to
start when the computer boots.
To add a project to the list, select Add. The CIMPLICITY Default Project dialog
box opens.

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:

GFK-1180H

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.

Setting Up a CIMPLICITY Project

3-15

Starting CimView Screens Automatically on


Windows 98/95
On a Windows 98/95 computer, you can configure a CIMPLICITY HMI project to
automatically start at system boot and display an initial CimView screen. To do this
you will need to:

Disable the Microsoft Network Login prompt

Set the CIMPLICITY startup options to start a project and load an


initial CimView screen.

Disabling the Microsoft Network Login Prompt


To disable the Microsoft Network Login prompt:

3-16

1.

Log on to Windows 98/95 with a User ID that is identical to the


CIMPLICITY User ID. For example, if your CIMPLICITY project is
configured for the user ADMINISTRATOR, log in to Windows 98/95
as ADMINISTRATOR.

2.

Open the Control Panel and select the Passwords icon. The Passwords
Properties dialog box opens.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

GFK-1180H

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.

7.

In the Primary Network Logon field, select Windows Logon.

8.

Select OK. You are prompted to reboot your system so that changes
will take effect. After you have rebooted, you will no longer be
prompted to log on.

Setting Up a CIMPLICITY Project

3-17

Setting CIMPLICITY Startup Options


Select CIMPLICITY Options from the CIMPLICITY shortcut menu. The
CIMPLICITY Options dialog box opens.
1.

Select the Startup Options page.

2.

In the Network Options box, select whether you want to start a standalone 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 98/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
shortcuts command line.

3-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The CimView Setup 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 screens
startup options:
Always Maximized
This option always maximizes the initial window to fill
the users 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.

GFK-1180H

Setting Up a CIMPLICITY Project

3-19

No Open
This option prevents users from opening CimView
screens not explicitly identified in Open Screen or
Overlay Screen procedures.
Open and Open Window menu items are removed from
the File menu and the File Open toolbar button is
disabled.
No Resize
This option prevents users from resizing CimView
windows that are displayed.
Captive Mode
This option displays the primary CimView window in
captive state. When the use opens this CimView
screen, the Explorer shuts down. Other screens are
displayed on top of the primary window and the user
will not be able to go below the primary window.
Touch Active
Keeps CimView screens currently being displayed
swapped in. Without this flag, only documents in the
cache are touched periodically to keep them swapped
into memory.
Touch Dynamic
Keeps CimView screens with many dynamic objects
swapped into memory.
Touch Static
Keeps CimView screens with many static objects
swapped into memory.
No Point Targets
Prevents the point target, e.g. point control panel and
quick trends, from being available from point view or
the right mouse menu
For more information about these options, see the CIMPLICITY
HMI for Windows NT and Windows 98/95 CimEdit Operation
Manual (GFK-1396).
F.

If you want to pre-load the screen cache with selected files, enter
the name of the cache file in the Cache File field. You can also
select Browse to the right of this field to search for the cache file
you want.

G. Select OK to save your changes and return to the CIMPLICITY


Options dialog box, or select Cancel to close the Dialog dialog box
and return to the CIMPLICITY Options dialog box without making
any changes.
4.

3-20

Select OK to save the startup options and close the CIMPLICITY


Options dialog box.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Whats 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.
If you are on a Viewer, the only process running in the Resident Process layer is the
Router.

GFK-1180H

Setting Up a CIMPLICITY Project

3-21

How Configuration Updates Are Handled


CIMPLICITY software configuration information is held in files in the projects
master and data directories. Run-time functions use information from
configuration files in the data directory, while configuration functions use
information in the master directory.
By separating run-time and configuration information in this manner, you can modify
your configuration information while CIMPLICITY software is running, and update
your run-time system as appropriate.
There are times, however, when you want to update configuration information and
have the updated information immediately available to the run-time system. In
CIMPLICITY software, you have the option to update your run-time system by using
the Dynamic Update option.
When Dynamic mode is unavailable, or disabled, all configuration updates are made
to files in the projects master directory. When configuration data is updated, the
new entries are immediately available to other configuration functions, but they are
not normally available to run-time functions. In order to update your run-time
configuration, you must:
1.

Shutdown your project.

2.

Select Configuration Update from the Project menu for the project
or click the Configuration Update button on the Toolbar. Note that
the menu option and Toolbar button are disabled if the project is
running.

3.

Restart your project.

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.

3-22

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Point Configuration
If you are modifying a point in Dynamic Update mode, you cannot change:

The calculation type for a Virtual point

Port Configuration
In Dynamic Update mode, you may only modify:

Base scan rate

Enable/Disable state of the port

Retry count

Remote Projects
You cannot create or modify remote projects in Dynamic Update mode.

GFK-1180H

Setting Up a CIMPLICITY Project

3-23

Logging In
Two levels of logins are available when you use CIMPLICITY software.
1.

The Microsoft Windows NT or Windows 98/95 login screen that is


presented when you start your computer.

2.

The CIMPLICITY login screen that is presented when you select a


CIMPLICITY user application (Alarm Viewer, CimEdit, CimView,
or CWSERV) document.

You have a great deal of flexibility in determining when and how users will log in to
CIMPLICITY software. The basic rules are:

On a Server, if you define a CIMPLICITY username and password that


match the username and password users enter when they log in to
Microsoft Windows NT or Windows 98/95, whenever users log in to
Microsoft Windows NT or Windows 98/95, they are automatically
logged in to CIMPLICITY software.

If you do not do the above, users will be presented with a CIMPLICITY


User Login dialog box when they select their first CIMPLICITY user
application (Alarm Viewer, CimEdit, CimView, or CWSERV).

After a user exits all open CIMPLICITY applications, the login remains
active for a certain period of time (determined by the CIMPLICITY
system manager). If a user opens a CIMPLICITY application during
this period of time, the user will not need to log in and the previous
username and password remain active. If a user opens a CIMPLICITY
application after this period of time expires, the user will have to log in
again.

If a user is displaying a CimView screen that has points from remote


projects, the user will have to log in to each of those projects unless you
define common usernames across all projects.

If a user opens a CIMPLICITY application for a project where a


Remote Project has been defined and the username and password
information are available for users as well as resident processes, the
user will automatically be logged in.

When you log in to CIMPLICITY software, you will be asked for a username and
password, and whether you want to save the username and password for future
logins. If you are on a Viewer, and are connecting to a project on another
CIMPLICITY for Windows NT computer in your network, you will also be asked if
you want to automatically connect to the selected project whenever the Viewer is
rebooted.
If you set the Save Username + Password check box, whenever you select any
documents in the project, you will automatically be logged in to the project with the
saved username and password.
If you set the Reconnect at Startup check box, you are automatically connected
to the project used by the document whenever CIMPLICITY software is started on
your computer.

3-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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
projects \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 projects 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.

GFK-1180H

Setting Up a CIMPLICITY Project

3-25

CIMPLICITY Command Line Options


You can use the STARTUP.EXE command to start and stop local and remote
projects from a command prompt.
The command format is
startup.exe [<option>]

where the options are:


/help or -help or /? or -? to display help information for this command line option.

/start <project> or -start <project> to start a project on the local computer.


/stop <project> or -stop <project> to stop a project on the local computer.
Important
The /rstart and /rstop options only work on Windows NT
/rstart <project> or -rstart <project> <computer> to start a project on a
remote computer. For example:
startup.exe /rstart z:projects\cimpdemo\cimpdemo.gef alnt04

/rstop <project> or -rstop <project< <computer> to stop a project on a remote


computer. For example:
startup.exe /rstop z:projects\cimpdemo\cimpdemo.gef alnt04

3-26

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Understanding Points

About Points
CIMPLICTIY HMI collects or calculates point data which it distributes to:

CimView screens

Alarm Viewer screens

Alarm printers

Logging tables

Other CIMPLICITY HMI software options

The collection and distribution of point data is handled by the Point Management subsystem.
Its primary functions are to:

Update the point database as point values change.

Generate point alarms when limits are exceeded.

Make point data available to CIMPLICITY HMI software applications.

Synthesize new point values by arithmetically combining other points.

Note: You can limit a users ability to set point to only those points whose resources are in
the users view. See "Setpoint Security" in this chapter for more information.

GFK-1180H

4-1

Categorizing Points
CIMPLICITY HMI provides you with the tools to configure any point to exactly your
specifications. Even though there are several options during configuration, your starting
choices for any given point are very simple.
The point value:

Comes from one of two Point (Source) Types

Is classified as one of three Point Classes

Point (Source) Type


CIMPLICITY HMI provides you with two basic source types:

Device pointsread from and/or write to devices

Virtual pointsdo not directly originate from devices.


There are two types of virtual points:

Global points have values that are generated by an application


such as CimView. These values are shared by multiple
CIMPLICITY HMI software applications.

Calculated points are generated from arithmetic or logical


expressions that modify or combine one or more numeric
points. These values may then be shared by multiple
CIMPLICITY HMI software applications.

Point Class
Points can be one of three classifications. You select the class based on how the point will be
used. The point classes are:

4-2

Analog integer or floating points

Boolean

Text

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Naming Points
Each point you create in your project has a unique Point ID. A Point ID may contain:

Up to 32 characters

Any combination of upper-case letters and numbers

Special characters, with some restrictions

There are some reserved words and reserved characters, which you are better off not using. If
you decide to use reserved words or characters for a Point ID:

You must enclose the Point ID in single quotes when you use it in an expression or
equation.

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 When Naming Points


The following are reserved words in CIMPLICITY HMI software. Avoid using 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.

GFK-1180H

Understanding Points

4-3

Reserved Characters
Guidelines for reserved characters in Point IDs include:
Do not use

| $
Brackets ( [ ] )

Avoid using

+- * ? \ / [ ] < > " :


The Expression Editor and other software can
misinterpret these

Use carefully

Any other special character (such as @, #, %,


etc.) on the keyboard
A Point ID started with a number (0-9).
You must enclose the Point ID in single quotes when
used in a point expression or equation..

Use freely

The underscore character ( _ )


The period (.)

4-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Setpoint Security
You can limit a users ability to set points to only those points whose resources are in
the users view. You do this in the Project Properties dialog box.

Opening the Point Setup Dialog Box


To open the Point Setup Dialog box:
Method 1
1.

Select Project on the Workbench menu bar.

2.

Select Properties.

Method 2
1.

Press Alt+P on the keyboard.

2.

Press P.

The Point Setup dialog box opens when you use either method.

GFK-1180H

Understanding Points

4-5

Specifying Security for Points


You have a lot of versatility in CIMPLICITY HMI for defining which users can access which
points. You lay the groundwork in the Point Setup dialog box.
Point Setup Dialog Box: Security Section
Check to restrict users
setpoint access
Check to require a password
for setpoint functions
Enter a password

To set security criteria in the Point Setup dialog box:


1.

(Optional) Select Set Point Security to enable Set Point Security for all users who
access your project.
If Set Point Security is enabled a user can perform setpoints on only those points
whose resources are in the users view.
Example
RESOURCE_1 is an authorized resource for USER_X.

2.

If:

POINT_A has been defined for RESOURCE_1 and Set


Point Security is enabled.

Then:

USER_X can perform setpoints on POINT_A.

If :

RESOURCE_1 is not an authorized resource for USER_X


and Set Point Security is enabled.

Then:
USER_X cannot perform setpoints on POINT_A.
(Optional) Configure Enable Setpoint Password to restrict access to the setpoint
functions. The CIMPLICITY HMI default is unrestricted access.
A. Select Set Point Password.
B. Enter the password that will be used to perform setpoint
actions in the Password input field.
C. Re-enter the password in the Confirm Password input field
to confirm it.

Guidelines for an Enterprise server:


If an Enterprise Server project contains the same resources as the provider of a point, then
Setpoint Security for the point is enforced against the resource in the Enterprise Server
project. If the resource is not configured on the Enterprise Server project, then Setpoint
Security for the point is enforced against the remote projects resource.
You can use the DONT_VERIFY_ESPOINT_FRID global parameter to change this behavior.
If you set this global parameter to "Y", then Setpoint Security for all points from a given
provider are enforced against the resource names configured on the provider. This means that
a setpoint against any of these points with resources not configured on the Enterprise Server
project will always fail (because a resource that is not configured cannot be in the users view).

4-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Quick Device Setup


About Quick Device Setup
CIMPLICITY HMI provides you with the tools to quickly include devices in your project and
then create basic device points that immediately begin to monitor your systems.
To do this quick setup, you:
1.

Set up your hardware by:


A. Connecting your device to a CIMPLICITY HMI server
B. Setting up the appropriate devcom (device communication)
according to the See the CIMPLICITY HMI for Windows NT and
Windows 95 Device Communications Manual (GFK-1181) for
details on the addressing supported for your particular device and
protocol.

2.

Make the devcom / protocol available to your CIMPLICITY HMI project.

3.

Add the device to your CIMPLICITY HMI project

4.

Configure a device point.

Note: These procedures are meant to help you quickly set up a device. Other chapters in the
CIMPLICITY HMI Base Users Manual provide depth descriptions of each part of the
process.

GFK-1180H

5-1

Quick Install for a Device Point

2. Enable the devices protocol.


.

1. Connect a device to a server.


OPERATOR INTERFACE

F1
BATT.

F2
M SG .

ESC

F1

XFER

SRCH

RUN
STO P

SET

ABC
4
JKL

DEF
5

M NO

STU

VWX

+/

F2
v

SW1

M O N SW3
O

R
9

G HI
6

PQ R
3
YZ-

ENTER

SW 5

SW 2
SW 4
SW 6

SW 7

SW 8

SW 9

SW 10

SW 1 1

SW 12

SW13 SW14
O N / O FF

IBM Compatible

4. Configure a
device point.

3. Add the device to the


CIMPLICITY HMI project.

This chapter provides you with a an overview of how to:


1.

Make sure the protocol you are using is enabled

2.

Add the device to your CIMPLICITY HMI project. If the appropriate port for the
device has not been setup, you can set it up when you add the device to your project.

See the "Configuring Device Points" chapter, in this manual, when your device is included in the
project and you are ready to configure a basic device point.

Enabling a Protocol in a CIMPLICITY HMI Project


When you installed CIMPLICITY HMI you selected communication protocols for
installation.
When you created a new project, you selected which installed protocols should be included in
the project (in the New Project dialog box).
You can make sure that the protocol you want to use is, in fact, enabled in the Project
Properties dialog box.
To enable a protocol for a project:
1.

Select Project on the Workbench menu bar.

2.

Select Properties.
The Project dialog box opens.

3.

5-2

Select the General tab.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

4.

Scroll up and/or down in the Protocols box to find the protocol that will be used.

5.

Check the protocols check box if it is not already checked.

The protocol is now enabled.

Note: If the protocol does not appear in the Protocol box, use the CIMPLICITY HMI
installation CD to add the protocol.

Adding a New Device


When you become accustomed to working with CIMPLICITY HMI and you need to enter
your own specifications to every aspect of the project, the tools are easily accessible.
CIMPLICITY HMI also provides the tools for you to quickly make a straightforward, basic
connection.
You can do an in depth configuration that includes adding users, roles, resources, a well as a
port and a device. See the chapters in the CIMPLICITY HMI for Windows NT and 95/98 Base System
Users Manual GFK-1180" for each configuration application.

You can also quickly add a device to a project in two to four steps.
Step 1: Open the New Device dialog box.
Step 2: Select a protocol for the devices port. (If a port doesnt already exist.)
Step 3: Configure the devices port. (If a port doesnt already exist.)
Step 4: Configure the device.

GFK-1180H

Quick Device Setup

5-3

Step 1: Open the New Device dialog box.


1.

Open the Equipment folder in the left pane of the Workbench.

2.

Select Devices in the left pane.

3.

Open the New Device dialog box. Two of the several methods are:
Method 1Using the mouse
Double click the left mouse button.
Method 2Using the keyboard
Click Ctrl+N on the keyboard.
The New Device dialog box opens.

4.

Enter a unique name in the Device field.

5.

Enter the port, if it is configured and go to Step 4.


Go to Step 2 if you need to configure a port.

5-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Step 2: Select a protocol for the devices port:

Open New Port


dialog box.
Select a Port
Browser

1.

Click the Port popup button, if no ports have been created.

2.

Select New.
The New Port dialog box appears.

3.

Select the Protocol you are using.


A port associated with the protocol appears in the drop down Port field with any
others, if there are any, available for selection.

4.

Select another port, if the one that appears is not the one you want.

5.

Click OK.
The Port Properties dialog box opens.

GFK-1180H

Quick Device Setup

5-5

Step 3: Configure the devices port:


1.

Select the General tab of the Port Properties dialog box.

Example: Port PropertiesDialog Box with TCP/IP Protocol


Protocol tab depends on selected protocol

General tab (for


all ports)

2.

3.

Enter the interval length between scans in the Scan Rate field. The time type options
are:

Seconds

Minutes

Hours

Enter the number of times CIMPLICITY HMI should retry scanning the device if a
communications error is encountered in the Retry Count field.
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.

4.

Check the Enable checkbox to enable communications on this port.

5.

Click OK.
A filled in New Device dialog box appears.

5-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Step 4: Configure the new device:

1.

Click OK when the New Device dialog box has the device and port filled in.
The Device dialog box appears.
Example: Device PropertiesDialog Box with TCP/IP Protocol
Protocol tab depends on selected protocol

General tab (for


all ports)

$SYSTEM
$MAC_FR
$PTM_FR

Included in
CIMPLICITY HMI

2.

(Optional) Enter a Description of the device using up to 40 characters.

3.

Choose a Resource from three that come with CIMPLICITY HMI.


A. $SYSTEMSystem Resource
B. $MAC_FRSystem Events
C. $PTM_FRPoint Management Info

GFK-1180H

4.

Select the type of device from the Model Type drop-down list. The list of available
model types depends on the protocol.

5.

Select the device's Protocol tab.

Quick Device Setup

5-7

6.

7.

Either:

Check the Enabled checkbox

Select the Yes radio button for the Enabled option.

The method depends on the protocol.


Enter the required information on the devices Protocol tab. Required entries depend
on the protocol you are using. See the CIMPLICITY HMI for Windows NT and Windows
95 Device Communications Manual (GFK-1181) for details on the addressing supported for
your particular device and protocol.

Now you can configure device points that collect data from and/or send data to the device that
is now enabled in your CIMPLICITY HMI project. See the "Configuring Device Points" chapter
in this manual.

5-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring Device Points

About Device Point Configuration


You have just attached a device to a server and want to create points to communicate to it for
monitoring and control purposes. To do this you:
1.

Create a new device point

2.

Enter basic specifications to get the point communication up and running.

3.

4.

Configure a points data type

Configure a points address on the device

(Optional) Begin advanced configuration in order to take advantage of


CIMPLICITY HMI software capabilities and refine the point communication.

Specify safety and availability triggers

Enter criteria to create a trend history

Configure advanced CIMPLICITY HMI device settings

Specify measurement unit and conversion criteria

(Optional) Continue advanced configuration to unleash the spectrum of


CIMPLICITY HMI monitoring powers.

Specify range and setpoint limits (Analog points)

Configure View formats

Configure alarms

This chapter provides information for 1-4. See the Configuring Point Limits, Views and Alarms
chapter in this manual to do the configuration listed in 4.

Note: CIMPLICITY HMI provides you with a Manual Mode feature that enables a user to
disconnect a points values from a device and set them manually. See the "Device Point Quality
Support at Runtime" section in this chapter for details about this feature.

GFK-1180H

6-1

New Device Points


When you create a new device point you select the:

Point type

Device for the point

Classification of the point

To create a new device point:


Method 1
1.

Select Points in the left pane of the Workbench.

2.

Double click the left mouse button.

Method 2
1.

Select Points in the left pane of the Workbench.

2.

Select File.

3.

Select New.

4.

Select Object.

Method 3
1.

Select Points in the left pane of the Workbench.

2.

Press Ctrl+N on the keyboard.

Method 4
1.

Select a point in the right pane.

2.

Click the right mouse button.

3.

Select New from the popup menu.

The New Point dialog box opens when you use any method.
New Device point

Device name

Select one class

6-2

CIMPLICITY HMI Users ManualMarch 1999

Device popup
Device browser

GFK-1180H

4.

Enter a unique Point ID.

5.

Select Device as the point type.

6.

Specify the Device associated with the point.

7.

Select a point Class(ification).


Your device point can be one of three classifications:

8.

Analog

Boolean

Text

Press OK.

The Point Properties dialog box opens.

Basic Device Point Configuration


Once the device is enabled in your CIMPLICITY HMI project, you can start communications
by defining a basic device point. To do this, you:

Select the device points data type

Configure device addressing

Selecting the Device Points Data Type


You find the device points data type choices on the General tab of the Point Properties dialog
box. The data type choices available to you for a device point depend on the type you selected
when you created it.

Note: Values read from or written to a device point will be forced into the specified type.
Example
Reading an SINT point value, which is 8-bits, from a 16-bit register will truncate the high
order byte, and the sign will not be maintained.
Writing an INT point, which is 16-bits, to an 8-bit register will do the same.
To enter general basic information for a device point:

GFK-1180H

1.

Select the General tab of the Point Properties dialog box.

2.

(Optional) Enter a description up to 40 characters. This description:

Displays when you position the cursor over the point in the
Workbench

Can be entered in the Point browser when you want to find and
display or use the point

Configuring Device Points

6-3

3.

Select one Data Type from the drop down list that appears for the point type you
selected:
Analog Points
General TabBasic ViewAnalog Point

w DINT
w INT
w REAL
w SINT
w UDINT
w UINT
w USINT
w 3D_BCD
w 4D_BCD

Array=
More than 1

Check to prohibit
setpoint use

DINT

4 byte (32 bit) ranging from -2,147,483,648 to +


2,147,483,647.

INT

Integers ranging from -32,768 to +32,767.

REAL

Floating-point numbers.

SINT

Integers ranging from -128 to +127.

UDINT

Unsigned integers ranging from 0 to 4,294,967,295.

UINT

Unsigned integers ranging from 0 to 65,535.

USINT

Unsigned integers ranging from 0 to 255.

3D_BCD

3-digit binary coded, 2 byte (16 bit) unsigned integer


ranging from 0 to 999

4D_BCD

4-digit binary coded, 2 byte (16 bit) unsigned integer


ranging from 0 to 9999

Important: Configure a 3D_BCD or 4D_BCD Point Bridge type point as a UINT point. The
BCD data types are used by the devcom to convert binary data coming from a PLC. When the
Point Bridge receives data from the source system, BCD conversion has already occurred.
Performing BCD conversion again on data will cause it to be converted twice, and, as a result,
give incorrect values.

6-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Boolean Points

BOOL

A one digit Boolean point with a value of 0 or 1.

BYTE

8-bits of data

WORD

16 bits of data

DWORD

32 bits of data

Text Points
General TabBasic ViewText Point

w STRING
w STRING_20
w STRING_8
w STRING_80

4.

Array=
More than 1

Check to prohibit
setpoint use

STRING

A one-character alphanumeric

STRING_20

A 20-character alphanumeric string

STRING_8

An 8-character alphanumeric string

STRING_80
Enter:

An 80-character alphanumeric string

The number of array elements, if the point is an array

One (1) if the point is not an array

See "Using Arrays" in this section.

5.

GFK-1180H

Check the Read Only check box to prohibit the ability to use the point as a setpoint.

Configuring Device Points

6-5

Using Arrays
CIMPLICITY software lets you define single points and array points. Using array points is
one way to provide more efficient data collection. An array point can represent one instance
of several process variables, or several instances of one process variable.

A point contains one (1) element.

An array contains more than one element.

Note: You specify an array in the Point Properties dialog box, General tab, Element field.

Important: Array points are not supported by all CIMPLICITY software functions. Support
for array points is as follows:

6-6

CimEdit

You can configure objects to display array elements and


use them for movement or animation

CimView

Array elements can be displayed, and can control


movement or animation.

Alarm Viewer

Alarms cannot be generated for array points.

Database Logger

You can log individual array elements.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Array Limits for Device Points


The maximum size of an array point depends on the device type being used, the memory type
being addressed, and the type of point. The maximum size of an array point for each device
type is:
Device type

Maximum size

Virtual

1600 bytes

CCM2

250 bytes

Genius datagram

128 bytes

Series 90 TCP/IP

950 bytes

SNP and SNPX

200 bytes

Allen-Bradley Communications

1000 bytes

Data Highway Plus

1000 bytes

Applicom

250 bytes

DDE

1000 bytes

FloPro/FloNet

240 bytes

Johnson Controls N2

16 bytes

Mitsubishi A-Series Serial

1000 bytes

Mitsubishi TCP/IP

512 bytes

Modbus Plus

1000 bytes

Modbus RTU

1000 bytes

Modbus TCP/IP

512 bytes

OMRON Host Link

1000 bytes

OMRON TCP/IP

1000 bytes

Seriplex

480 bytes

Sharp TCP/IP

1000 bytes

Siemens TI

250 bytes

Smarteye Electronic Assembly

250 bytes

Square D SY/MAX

250 bytes

The Smarteye and DDE Client protocols do not support array points.
Values read from or written to a device point are forced into the correct type of the point.
This may affect the array size. For example, if you have defined an analog point with type
INT for a point on a CCM2 device in Register memory, the maximum array size will be 125
elements because each point in the array is put into a separate 16-bit register. Check the
appropriate Device Communications documentation for further information.

GFK-1180H

Configuring Device Points

6-7

Entering Addressing Specifications for the Device Point


The main purpose of the basic Device tab is to define where the point is located in a device
and how the point is to be updated. These specifications are made in the Addressing box.

Note: Addressing is used for most GE Fanuc device communications options, and for devices
created via the Device Communications Toolkit API that use custom addressing.
This section describes criteria for customized addressing. There is another type of addressing,
standard addressing. However, it is rarely used. For further information on addressing for the
protocol and device, see the CIMPLICITY HMI for Windows NT and Windows 95 Device
Communications Manual (GFK-1181).

Procedure for Basic Device Custom Addressing


The address information the device tab requests is the same for all device point types. Your
selections depend on the device and protocol you have specified.

Device Addressing: Customized


.

To configure device addressing:


1.

Select the Device tab of the Point Properties dialog box.


The Device ID that you selected in the New Point dialog box appears in the Device
ID field.

Device TabBasic ViewUpdate Criteria

Boolean
points only

Entry depends on
protocol

Availability depends on
protocol:
On Change
On Scan
On Demand On Scan
On Demand On Change
Unsolicited
Poll Once

2.

6-8

Enter the Address that is consistent with the selected protocol. For further
information on addressing for the protocol and device, see the CIMPLICITY HMI for
Windows NT and Windows 95 Device Communications Manual (GFK-1181).

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

3.

(For Boolean points only) Enter an Address Offset (bit offset) if the first bit of the
points data is not the first bit of the address. Address offsets start at 0, which is the
least significant bit.
Example
A digital point is located in the third (3rd) bit of Register 5 on a Series 90-70
The Address is "%R5"

4.

The Address Offset is "2".


Choose one of the following (The Addressing box displays one or all choices
depending on the device you select):
A. Device Dataif the address you enter is for a device point.
B. Diagnostic Dataif the address you enter is for a diagnostic
point
See "Entries for Diagnostic Points Used with Devices".

C. Ethernet Global Dataif the address you enter is for


Ethernet global data.
5.

Specify the Update Criteria when data for the point is passed from the device
communications processor to the point database. Available selections depend on the
protocol you are using.
Point is updated when
On Change (Default
Data Collected:

At a regular interval.
The interval equals the base scan rate for the port on
which the device is located multiplied by the scan rate
for the point.

Value Updated:

Only when the value changes.


This is an efficient criterion.

On Scan
Data Collected:

At a regular interval.
The interval equals the base scan rate for the port on
which the device is located multiplied by the scan rate
for the point.

Value Updated:

The points value is updated at the points scan


interval, whether or not the value changes.
Because this can increase system load, it is
recommended that you use On Scan sparingly or not
at all.

On Demand On Scan

GFK-1180H

Data Collected:

Whenever the points value is needed by an


application.

Value Updated:

At the points scan interval, whether or not the value


changes.

Configuring Device Points

6-9

On Demand On Change
Data Collected:

Whenever the points value is needed by an


application.

Value Updated:

Only when the value changes.

Unsolicited
Value Updated:

Whenever the device communications receives data


from the PLC, it immediately sends it to
CIMPLICITY Point Management whether or not the
points 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.

Unsolicited On Change
Value Updated:

Whenever the device communications receives data


from the PLC, it evaluates the point and sends it to
CIMPLICITY Point Management only it the points
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
Data Collected:

Polled once when the device communications enabler


starts up.

Thereafter, it may be updated by unsolicited data


from the device. If you select Poll After Set, it will
also be updated after a user performs a Setpoint on
the point.
Once the updated data is in the point database, it is available to all that need it

6-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Entries for Diagnostic Points Used with Devices


The CIMPLICITY HMI device communication enablers (devcoms) 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 device communication enabler may also provide protocol-specific data.

Note: Diagnostic points are not available for the Point Bridge.
To view diagnostic data, configure device points that correspond 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 ports base scan rate, displayed in CimView screens, trended,
logged, alarmed, etc.

Important: You cannot write to diagnostic points. Always configure them for Read access.

GFK-1180H

Configuring Device Points

6-11

To create a diagnostic point when the enabler uses custom addressing:


1.

Select the Diagnostic data check box.

2.

Enter one of the following values as the text address of the diagnostic data in the
Address field.
Address
$TRANSMISSIONS
$RESPONSES
$FAILURES
$RETRIES
$DEVICE_DOWN
$DEVICE_UP

Data Type
UDINT
UDINT
UDINT
UDINT
BOOL
BOOL

Description
Number of messages sent
Number of messages received
Number of communication failures
Number of retries
Device up status
Device down status

Domain Address: Standard


Note: Standard addressing is very rarely used. However, if it is the Addressing box changes
to the Domain Address box.

To enter standard addressing specifications:

6-12

1.

Select the Domain Type that represents the type of device memory from which the
point is coming.

2.

Enter the starting address for the point in the Domain Offset field. The address
depends on the addressing conventions for the individual device.

3.

(Active only for Bool points) Enter Bit Offset if the first bit of the points data is
not the first bit of the address. Address offsets start at "0", and are numbered from
right to left.

4.

Select the Update Criteria. See "Device Addressing: Customized"

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Advanced Device Point Configuration


Once your basic device point is up and running, you can add to and refine your configuration
in order to take advantage of the CIMPLICITY HMIs diagnostic and monitoring powers.
You can

Enter criteria to create a trend history

Specify safety and availability trigger

Configure advanced CIMPLICITY HMI device settings

Configure measurement units and conversions

This section describes what to enter for these advanced device point specifications.
See "Setting Point Limits and Alarms" in this manual for information on how to enter the advanced
specifications that unleash the spectrum of CIMPLICITY HMI monitoring powers.

Specify View formats (Analog points)

Specify range and setpoint limits (Analog points)

Configure alarms

Configuring Advanced "General" Specifications for Device Points


There are several general choices you can make to add to your device points configuration.
They include:
For analog, Boolean or text points

Enabling the point or associated alarm See "Setting Point Limits and Alarms" in this
chapter for information about configuring an alarm.

Selecting a point to be a safety point

Selecting a point to be an availability trigger

Making logging specifications

For analog and Boolean points


Entering trend history criteria

GFK-1180H

Configuring Device Points

6-13

Advanced General Tab in the Point Properties Dialog Box


To enter advanced general information, you have to put the General tab of the Point
Properties dialog box into advanced mode.
To put the General tab of the Point Properties dialog box in advanced mode:
on the basic General tab. If the tab is in
Press the Advanced button
advanced view, the Basic button will display.
Advanced Device tab on Point Properties dialog box

Scan rate selected

Trigger point selected

The available selections on the General tab depend on what point type you are configuring.
The following procedure begins with entries for any point type and continues through entries
for the analog/Boolean point types only.

6-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Device Point and Alarm Enabled


When you configure a point, you have control over when the point itself and/or its alarm
should be active in your CIMPLICITY HMI project. You also can make it available to other
projects.
To enable or disable a device point and/or its alarm
For Analog, Boolean and Text points
1.

Check any or all of the following check boxes:

Enable Point

Enables the point at runtime

Enable Alarm

Enables the points alarm

Enable Enterprise

3.

Allows data to be exported to the Enterprise


server so it will be available to other projects
Enter the Resource ID associated with the point. Users who 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.

Safety Points
The status of a safety point controls whether or not a setpoint is permitted. You can select a
safety point on the advanced General tab of the Point Properties dialog box.
At runtime if the:
Safety Point is

Setpoint on the Point is

Available and
evaluates to a non-zero value

Permitted

Available and
evaluates to zero

Not permitted

Unavailable

Not permitted

To specify a safety point:


Select a point for the Safety Point field. The point can be:
A. Digital or analog
B. Device or virtual

GFK-1180H

Configuring Device Points

6-15

Availability Triggers
An Availability Trigger determines the validity of the point you are configuring and provides
a "device healthy" signal for points that are tied to intermediate devices during runtime. You
can select an Availability Trigger on the General tab of the Point Properties dialog box
At runtime if the:
Availability Trigger

Configured Point is

Evaluates to a non-zero value

Available

Evaluates to zero

Unavailable

To specify an Availability Trigger: .


Select a point for the Availability Trigger field. The point can be digital or analog.

Trend History
For Analog and Boolean points on the General tab of the Point Properties dialog box
CIMPLICITY HMI can compile a trend history for analog and Boolean points. All you have
to do is specify the amount of time that data should be retained and the maximum number of
samples that should be included.
To make specifications for trending data:
Enter the Trend History specifications for checked Max Duration and/or Max Count
check boxes to have CIMPLICITY HMI save information as follows.

Max Duration

The amount of most recent time to be saved. Select


one of the following:
Seconds
Minutes
Hours
Days

Max Count
The number of n values to be saved
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..

6-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Point buffering lets you allocate a buffer for a point and save a number of the most
recent values. This feature is currently being supported only for the Trending option.
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.
Max Count of 10, the buffer contains the 10 most recent values (that is, the
values for the last 50 seconds).
Max Duration and Max Count, the buffer contains the 10 most recent values.
Note: Point buffering is not supported for Enterprise Server points.

Point Data and Alarm Logs


You can select to log a device points data and / or alarms in the advanced General tab of the
Point Properties dialog box.

To enable data and/or alarm logging::


1.

Check the Log Data and/or Log Alarm check boxes in the Logging box.

2.

Press Settings to open the Point Logging dialog box.

3.

Select the table to which the data will be logged. See the "Database Logger" chapter in
this manual for information about configuring log tables.

GFK-1180H

Configuring Device Points

6-17

Configuring Advanced Device Point Specifications


When you configured the basic Device tab you defined where the point is located in a device
and how the point is to be updated.
You can add to these specifications by including CIMPLICITY HMI settings.
These settings include adding:

Trigger settings

Scan rate

Analog deadband

Important: Domains for programmable controllers in CIMPLICITY HMI software are sized
when the project starts. If you dynamically reconfigure domain sizes on the programmable
controller, you must restart the project to access points at the new domain offsets.

Advanced Device Tab Displayed in the Point Properties Dialog


Box
To enter advanced device information, you have to put the Device tab of the Point Properties
dialog box into advanced mode.
To put the Device tab of the Point Properties dialog box in advanced mode:
on the basic Device tab. If the tab is in
Press the Advanced button
advanced view, the Basic button will display.
Advanced Device tab on Point Properties dialog box

Scan rate selected

Trigger point selected

6-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Trigger Settings for a Device Point


If you add a trigger setting, the point you are configuring is updated only when the trigger
condition evaluates to TRUE.
A trigger setting includes a Trigger point, which minimizes the system resources that are
required for reading device points by triggering the read only when specified conditions are
met.
Example
You are configuring a point that requires an update for logging purposes.

If the update needs to be hourly, but the device is being scanned every quarter hour
for other purposes:
Use a device Trigger Point that is configured with a one-hour scan rate. See "On
Scan" in the "Configuring Device Points" chapter in this manual.

If the update needs to occur when a particular condition changes:


Use a Device point that represents the condition and is configured to be updated On
Change

To configure trigger settings for a device point:


1.

Enter the Point ID, in the Trigger Point field, 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.
Select a Point
Point popup
browser

2.

None
Equal
Greater Than
Greater Than Equal
Less Than Equal
Less Than
On Change

Select, in the Relation field, how the trigger point will be evaluated.
Your choices are:

GFK-1180H

Choice

Trigger is active when the trigger points


value:

None

Triggering will not occur.

Equal

Equals Value.

Greater Than

Is greater than Value.

Greater Than Equal

Is greater than or equal to Value.

Less Than Equal

Is less than or equal to Value.

Less Than

Is less than Value.

Configuring Device Points

6-19

3.

On Change
Whenever the Trigger Point is changed.
Enter the Value the Trigger Point will be compared with to determine if the trigger
condition has been met.

The trigger condition is evaluated each time the trigger point is polled, so effectively, this
point is polled at the trigger points scan rate while the trigger condition is true.

Scan Rate
Enter the frequency at which the CIMPLICITY device communications option will read this
points data, based on the ports Base Rate.
The Base Rate is the minimum rate at which device points can be polled on the port. The
Scan Rate is a multiple of the Base Rate.
Example
The Base Rate is 5 seconds
The Scan Rate is set to "3"
The point is scanned every 15 seconds.
When you define Trigger Settings for a point, enter 0 (zero) in the Scan Rate field.

Analog Deadband
An Analog Deadband filters 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.

Therefore, the Analog Deadband can make 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.

Poll After Set


Poll After Set specifies when CIMPLICITY HMI will read a setpoint value.
Your options for the Poll After Set check box are:
Check box status

CIMPLICITY HMI will read the points value

Check

Immediately after a Setpoint is done to it.

Clear

On the next scan or when the trigger condition for the


point is set to "TRUE".

Important: The Point Bridge does not support Poll After Set. If you are defining a Point
Bridge point, clear this check box.

6-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Understanding the Trigger Function


The trigger function lets you configure points so that device data is updated only when the
trigger point is updated.
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.

Trigger points can be used 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.

The Update Criteria for the trigger point determines when triggered reads take place. The
criteria can either be when the trigger point value changes or when it is scanned.

Example Overview of Trigger Point Update Options for Device


Points
You are configuring a point that requires an update for logging purposes.

If the update needs to be hourly:


Use a device Trigger Point that is configured with a one-hour scan rate. See "On
Scan" in the "Configuring Device Points" chapter in this manual.

If the update needs to occur when a particular condition changes:


Use either a:

GFK-1180H

Device point that represents the condition and is configured to


be updated On Change

Virtual point that represents the condition

Configuring Device Points

6-21

Example using Scanned and On Change Trigger Point Values


A digital point (D1) and an analog point (A1) are configured with a scan rate of 3 seconds.
Option 1: Over a period of 30 seconds, the two point values vary as follows:

6-22

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Option 2: Update Criteria for D1 is set to On Scan, and A1 is configured so that it is a triggered
point that will be read when D1 is HIGH, CIMPLICITY HMI reads:
A1 as follows:

In other words, CIMPLICITY HMI reads A1 at the 3, 6, 15, 18, and 24 second marks because
the value of D1 was HIGH at those times.

GFK-1180H

Configuring Device Points

6-23

Option 3: When the Update Criteria for D1 is set to On Change, the values for A1 will vary as
follows:

In other words, CIMPLICITY HMI reads A1 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.

Example of a 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.

6-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Example of Efficiency through Trigger Points


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.

GFK-1180H

Configuring Device Points

6-25

Point Conversions
CIMPLICITY HMI software lets you select the base engineering units for an analog device
point and then specify a linear or custom conversion. You do this on the Conversion tab that
appears in the Advanced General tab group.

Displaying the Conversion Tab


To display the Conversion tab:

6-26

on the General tab.

1.

Press the Advanced button

2.

Select the Conversion tab that appears if you are configuring an analog point.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring Base Engineering Units for a Point


Fill in the Measurement units field to define the units that CIMPLICITY HMI converts to and
/ or from the projects base measurement units.
To configure the base engineering units for a point:
Method 1
1.

Click the Popup Menu button to the right of the Unit field.

2.

Select the name of the base engineering units from the list of available measurement
units. When you do this, the label for the unit is automatically put in the Label field.

Method 2
Click the Browser button to the right of the Unit field to find the measurement unit in the
Select A Measurement Unit Browser

GFK-1180H

Configuring Device Points

6-27

Method 3
1.

Click the Pop-up Menu button to the right of the Unit field.

2.

Select New.
The New Measurement dialog box opens.

3.

Enter a new measurement label.


The Measurement Unit Properties dialog box appears.

4.

(Optional) Enter a description.

5.

Enter the label that will appear when the measurement unit is selected.

6.

Press Apply.
The new unit is added to the list of available units.

6-28

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Method 4
Leave the base units for the point blank and enter your own label in the Label field.
The unit appears in the Unit field when you use Methods 13.

Note: If you select a unit of measurement on the Conversion tab, and the project has an active
measurement system at runtime, the base engineering units for the point are automatically
converted to the corresponding units in the active measurement system.
If there is no active measurement system, the base engineering units are used. If the project
has an active measurement system at runtime, no further point conversion takes place.
Example
The point's value represents degrees F.
You leave the Unit field blank.
The active measurement system uses metric units.
No conversion from degrees F to degrees C takes place at runtime.
CIMPLICITY HMI supports the following types of Engineering Unit (EU) conversions for
analog points.
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.

GFK-1180H

Configuring Device Points

6-29

Configuring the Conversion Type for a Device Point


There are two types of conversion methods you can use for point conversion:

Linear

Custom

Linear Conversion
When you use linear conversion, you specify base and converted values that CIMPLICITY
HMI uses to calculate runtime conversions..
To configure linear conversion:
1.

Select the Conversion tab in the Point Properties dialog box

2.

Select Linear.

3.

Enter two valid Raw values in the First and Second fields.

4.

Enter two Converted values in the First and Second fields. These are engineering
unit values that correspond to the first and second raw values you entered.

CIMPLICITY HMI uses these four values to calculate the linear conversion for the point. The
conversion formula is:

where:
EU value = the Engineering Units value
R1 = First raw value
R2 = Second raw value
C1 = First converted value
C2 = Second converted value
Raw value = the value read from the device.
CIMPLICITY HMI uses the inverse of this expression to convert Setpoint values entered by
users to raw values for downloading to the device.

6-30

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Custom Conversion
Custom conversion provides you with the ability to specify specific forward and backward
conversion expressions.
To configure custom conversion for a device points:
1.

Select the Conversion tab in the Point Properties dialog box.

2.

Select Custom.

3.

Enter a Forward expression that CIMPLICITY HMI will use to convert the raw
data to engineering units
Use the placeholder %P to indicate the point value in the expression. %P is the raw
value of the point.

4.

Enter a Reverse expression that CIMPLICITY HMI will use to convert setpoint
values from engineering units to raw data
Use the placeholder %P to indicate the point value in the expression. %P is the
engineering units value of the point.

Valid operators are:


Arithmetic operators

+ - / * (

Logical operators

AND, NOT, OR, XOR

Bitwise operators

BAND, BNOT, BOR, BXOR

Relational operators
Example

LT, GT, EQ, LE, GE, NE

A conversion 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
The Reverse expression is:

(%P/2.5)*10.0

Important: The numeric operands you use in the Forward expression are assumed to be
integers unless you include decimal points in them. Once the expression processor sees an
operand with a decimal point, it will process the rest of the expression using floating-point
arithmetic

GFK-1180H

Configuring Device Points

6-31

Example
A conversion that calls for the raw data to be divided by 2, then multiplied by 10.
The raw value for the point is 3.
You could enter any one of the following expressions. However, the Expression Processor
interprets each expression differently, as follows:
Expression

Result

(%P/2)*10

(3/2)*10 = (1)*10 = 10

Because integer arithmetic was used throughout, the result is an integer.


(%P/2)*10.0

(3/2)*10.0 = (1)*10.0 = 10.0

Because integer arithmetic was used in the first operation of these two
expressions, the operation (3/2) gives the result 1 instead of 1.5.
(%P/2.0)*10

(3/2.0)*10 = (1.5)*10 = 15.0

Because (3/2.0) is processed using floating point arithmetic, the rest of


the expression will be processed using floating point arithmetic, even
thought 10 is entered as an integer.
(%P/2.0)*10.0

(3/2.0)*10.0 = (1.5)*10.0 = 15.0

Because (3/2.0) is processed using floating-point arithmetic, the rest of


the expression will be processed using floating-point arithmetic.

6-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Device Point Quality Support at Runtime


CIMPLICITY HMI provides the capability for a user to take a device point that may or may
not be currently available and put it in manual mode. The user can then set the points value.
This is particularly useful if a point is attached to equipment that is known to be
malfunctioning and, as a result, creates a problem in other areas of the system. This indicator
enables a user to separate the point from that equipment and set the point to a known good
value that preserves the systems integrity.
Example
A temperature sensor that reports temperatures, which are acted upon by CIMPLICITY
HMI applications to initiate temperature control actions, fails. To continue the high
temperature setting, a user with Modify Manual Mode privilege places the point that
reflects the errant sensor in manual override mode. The user then sets a value that causes
the application to cease the unnecessary temperature control procedures. This allows
users who are knowledgeable of their CIMPLICITY HMI application implementation to
make emergency, temporary adjustments to their systems operation. Consequently the
application does not have to anticipate and provide for handling of all possible failures in
its implementation.
Quality support for manual mode includes the storage of data values for points that are placed
in manual mode. This means that when you stop a project, then restart it CIMPLICITY HMI
takes all the points that it finds in manual mode and restores them to their last known values.
Retrieved point value types can include any one of the following values:

Set in manual mode

That came from the PLC and was not reset in manual mode

That is unavailable, if it was unavailable when the project stopped

CIMPLICITY HMI allows access to manual mode wherever you can reference an attribute for
a device point. Access includes:

Turning manual mode on and off in the CIMPLICITY HMI Point Control Panel
See "Using the Point Control Panel" chapter in this manual for a description.

Using available point quality attributes in

Scripts

Expressions in CimEdit or Custom PTMAPI applications

See the "Monitoring Point Attributes" chapter in the "CIMPLICITY HMI CimEdit Operation
Manual" GFK-1396 for details about the manual mode point attributes.

GFK-1180H

Configuring Device Points

6-33

Configuring Virtual Points

About Virtual Point Configuration


Virtual points provide you with the ability to calculate and report data that is independent of
any one device.
On a very basic level the virtual point can be available to receive a value from a variety of
sources across your projects, e.g. scripts or C++ programs. Once the point exists, you can use
it wherever the use is consistent with its formatting.
On a more advanced level, the value of the virtual point can be derived from a calculation that
you specify during configuration. This calculation can include the value of one or more virtual
points. To do this you:
1.

Create a new virtual point.

2.

Enter basic specifications to create an available virtual point.

3.

4.

Select the virtual points data type

Enter initialization specifications

(Optional) Begin advanced configuration in order to take advantage of


CIMPLICITY HMI software capabilities and refine the point communication.

Specify safety and availability triggers

Enter criteria to create a trend history

Configure advanced CIMPLICITY HMI virtual calculations

Specify measurement units

(Optional) Continue advanced configuration to unleash the spectrum of


CIMPLICITY HMI monitoring powers.

Specify range and setpoint limits (Analog points)

Configure View formats

Configure alarms

This chapter provides information for 1-3. See the Configuring Point Limits, Views and Alarms
chapter in this manual to do the configuration listed in 4.

GFK-1180H

7-1

New Virtual Points


When you create a new virtual point you select the:

Point type

Classification of the point

To create a new virtual point:


Method 1
1.

Select Points in the left pane of the Workbench.

2.

Double click the left mouse button.

Method 2
1.

Select Points in the left pane of the Workbench.

2.

Select File.

3.

Select New.

4.

Select Object.

Method 3
1.

Select Points in the left pane of the Workbench.

2.

Press Ctrl+N on the keyboard.

Method 4
1.

Select a point in the right pane.

2.

Click the right mouse button.

3.

Select New from the popup menu.

The New Point dialog box opens when you use any method.
New Virtual Point

Select one class

4.

7-2

Enter a unique Point ID.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

5.

Select a point Class(ification).


Your virtual point can be one of three classifications:

6.

Analog

Boolean

Text

Press OK.

The Point Properties dialog box opens.

Basic Virtual Point Configuration


To make a new virtual point available for use in your CIMPLICITY HMI project, you can
start by defining a basic virtual point. To do this, you simply:

Select the virtual points data type

Enter initialization specifications

Selecting the Virtual Points Data Type


The data type choices available to you for a virtual point depend on the type you selected
when you created it.
Also, availability of a particular point type for a device analog point depends on the
communications protocol and device. See the CIMPLICITY HMI for Windows NT and
Windows 95 Device Communications Manual (GFK-1181) for details on what point types are
supported for your particular device and protocol.
To enter general basic information for an analog point:

GFK-1180H

1.

Select the General tab of the Point Properties dialog box.

2.

(Optional) Enter a description up to 40 characters. This description:

Displays when you position the cursor over the point in the
Workbench

Can be entered in the Point browser when you want to find and
display or use the point

Configuring Virtual Points

7-3

3.

Select one Data Type from the drop down list that appears for the point type you
selected:
Analog Points
General TabBasic ViewAnalog Point

w DINT
w INT
w REAL
w SINT
w UDINT
w UINT
w USINT

Array=
More than 1

Check to prohibit
setpoint use

DINT

4 byte (32 bit) ranging from -2,147,483,648 to +


2,147,483,647

INT

Integers ranging from -32,768 to +32,767.

REAL

Floating-point numbers.

SINT

Integers ranging from -128 to +127.

UDINT

Unsigned integers ranging from 0 to 4,294,967,295.

UINT

Unsigned integers ranging from 0 to 65,535.

USINT

Unsigned integers ranging from 0 to 255.

Boolean Points
General TabBasic ViewBoolean Point

7-4

BOOL
BYTE
WORD
DWORD

Array=
More than 1

Check to prohibit
setpoint use

BOOL

A one digit Boolean point with a value of 0 or 1.

BYTE

8-bits of data

WORD

16 bits of data

DWORD

32 bits of data

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Text Points
General TabBasic ViewText Point

4.

STRING
STRING_20
STRING_8
STRING_80

Array=
More than 1

Check to prohibit
setpoint use

STRING

A one-character alphanumeric

STRING_20

A 20-character alphanumeric string

STRING_8

An 8-character alphanumeric string

STRING_80
Enter:

An 80-character alphanumeric string

The number of array elements, if the point is an array

One (1) if the point is not an array

See "Using Arrays" in this section.

5.

Check the Read Only check box to prohibit the ability to use the point as a setpoint.

Using Arrays
CIMPLICITY software lets you define single points and array points. Using array points is
one way to provide more efficient data collection. An array point can represent one instance
of several process variables, or several instances of one process variable.

A point contains one (1) element.

An array contains more than one element.

Note: You specify an array in the Point Properties dialog box, General tab, Element field.

Important: Array points are not supported by all CIMPLICITY software functions. Support
for array points is as follows:

GFK-1180H

CimEdit

You can configure objects to display array elements


and use them for movement or animation

CimView

Array elements can be displayed, and can control


movement or animation.

Alarm Viewer

Alarms cannot be generated for array points.

Database Logger

Individual array elements can be logged.

Configuring Virtual Points

7-5

Entering Initialization Specifications for a Virtual Point


There are several choices for specifying a point value when a virtual point becomes active.
Values can be initialized for both points and arrays.

Analog and Boolean Virtual Points Initialization


To specify initialization for a non-text point:
1.

Select the Virtual tab.

Virtual TabBasic View


Boolean point example

Analog point example

None
Initialized
Saved
Saved or Initialized

Basic selection

2.

Specify the source for the initial value of this point when the software is started up or
reset. Choices include:
None

No reset/startup condition is defined.

Initialized

A constant value entered in the Initial Value field is


initialized.
Each element in the array is initialized to the Initial
Value.
Example
A UINT point:
Is an array of 4
Has an Initial Value of "58"
Each element in the array is initialized to "58".

Saved

The last saved value of the point when the project is


stopped. When points are saved is specified in the
Project Properties dialog box, Settings tab.
Choices are:

Saved or Initialized

Every time a point changes.

When the project shuts down normally.

The last saved value of the point if there is one;


otherwise the constant entered in the Initial Value
field.

See "Specifying How Virtual Points are Stored", in this chapter, if you choose Saved as the
initialization value.

7-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

3.

(Displays if Initialized is selected in the Initialization field) Enter the Initial Value
for the point at initialization, before any data is generated by its component point(s).

4.

The Calculation TypeNone is the basic configuration default. See "Configuring


Points: Advanced" in this manual for information about other calculations

Text Virtual Points Initialization


Point initialized values can be specified for points and arrays.
To enter initialization information for a virtual text point:
1.

Select the Virtual tab of the Point Properties dialog box.

Virtual TabBasic ViewText Points

2.

None
Initialized
Saved
Saved or Initialized

Specify the source for the initial value of this point when the software is started up or
reset. Choices include:
None

No reset/startup condition is defined.

Initialized

A constant value entered in the Initial Value field


(C) is initialized.

Saved

The last saved value of the point when the project


starts. The type of value is specified in the Project
Properties dialog box, Settings tab.
Choices are:

Saved or Initialized

Every time a point changes.

When the project shuts down normally.

The last saved value of the point if there is one;


otherwise the constant entered in the Initial Value
field.

See "Specifying How Virtual Points are Stored", in this chapter, if you choose Saved as the
initialization value.

GFK-1180H

Configuring Virtual Points

7-7

3.

(Displays if Initialized is selected in the Initialization field) Enter the Initial Value
for the point at initialization, before any data is generated by its component point(s).
For multi-character strings,
Each element in the array is initialized to the Initial Value.
Example
A String array:

Is an array of 4

Has an Initial Value of "ABCDEFGH"

Each element in the array is initialized to "ABCDEFGH".

For single character string arrays,


Each element in the array is initialized with the corresponding character in the Initial
Value field.
Example
A String array:

Is an array of 8

Has an initial value of "ABCDEFGH"

STRING[0] is set to "A"

STRING[1] is set to "B", etc.

Note: When working with initialization values for string arrays, if:

Too many elements are given in Initial Value, the string truncates at the number of
elements.

The Initial Value does not specify enough elements, the remaining elements of the
string are initialize to the Null character.

Specifying how Virtual Point Values are Stored


If you choose Saved or Saved or Initialized for the point initialization value (on the
Virtual tab of the Point Properties dialog box) you have to specify how CIMPLICITY HMI
stores the last known good value for all virtual points in your project.
You do this in the projects Point Setup dialog box.
Open the Point Setup dialog box:
Method 1
1.

Select Project on the Workbench menu bar.

2.

Select Properties.

Method 2

7-8

1.

Press Alt+P on the keyboard.

2.

Press P.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The Point Setup dialog box opens when you use either method.

Select how CIMPLICITY HMI should store values:


1.

(Optional) Select one of the following:


Select

To Save the last know good value of:

On point update

Each saved virtual point in your project whenever its


value updates.
When the saved virtual points in your project change
at a rapid pace, this option causes the Point Manager
to consume more computer resources. This is
because each point change is written to disk as it
occurs.

On project shutdown

2.

The saved virtual points in your project to disk when


you shut down the project normally.

This option improves disk performance since the


Point Manager no longer needs to access the disk
every time a saved point changes. However, if your
project terminates abnormally, the last known good
values will not be saved.
(Optional) Select Compact on project startup to compact the saved virtual point
storage when the project starts up. If you select this option, the Point Manager
removes all points in the saved point storage that no longer exist in the projects runtime configuration, and then compresses the storage to make optimum use of disk
space.
It is recommended that you use this option only while you are developing your
project. Once you have a stable point configuration, it is no longer necessary to
compact the saved virtual point storage.

GFK-1180H

Configuring Virtual Points

7-9

Advanced Virtual Point Configuration


Once your basic point is up and running, you can add to and refine your configuration in order
to take advantage of the CIMPLICITY HMIs diagnostic and monitoring powers.
You can

Enter criteria to create a trend history

Specify safety and availability trigger

Configure a derived point with advanced CIMPLICITY HMI calculations

This section describes what to enter for these advanced virtual point specifications.
See "Setting Point Limits and Alarms" in this manual for information on how to enter the advanced
specifications that unleash the spectrum of CIMPLICITY HMI monitoring powers.

Configure View formats

Specify range and setpoint limits (Analog points)

Configure alarms

Entering Advanced General Specifications for Virtual Points


To enter advanced general information, you have to put the General tab of the Point
Properties dialog box into advanced mode.
To put the General tab of the Point Properties dialog box in advanced mode:
Press the Advanced button
view, the Basic button will display.

7-10

on the basic General tab. If the tab is in advanced

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The available selections on the General tab depend on what point type you are configuring.
The following procedure begins with entries for any point type and continues through entries
for the analog/Boolean point types only.

Virtual Point and Alarm Enabled


When you configure a point, you have control over whether the point itself and/or its alarm
should be enabled in your CIMPLICITY HMI project. You also can make it available to other
projects.
To enable or disable a virtual point and/or its alarm:
For Analog, Boolean and Text points
1.

GFK-1180H

Check any or all of the following check boxes:

Enable Point

Enables the point at runtime

Enable Alarm

Enables the points alarm

Enable Enterprise

Allows data to be exported to the Enterprise


server so it will be available to other projects

Configuring Virtual Points

7-11

2,

Enter the Resource ID associated with the point. Users who 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.

Safety Points
The status of a safety point controls whether or not a setpoint is permitted. You can select a
safety point on the advanced General tab of the Point Properties dialog box.
To specify a safety point:
Select a point for the Safety Point field. The point can be:
A. Digital or analog
B. Device or virtual

At runtime if the:
Safety Point is

Setpoint on the Point is

Available and
evaluates to a non-zero value

Permitted

Available and
evaluates to zero

Not permitted

Unavailable Not permitted

Availability Triggers
An Availability Trigger determines the validity of the point you are configuring and provides
a "device healthy" signal for points that are tied to intermediate devices during runtime.
To specify an availability trigger:
Select a point for the Availability Trigger field. The point can be digital or analog.

At runtime if the:

7-12

Availability Trigger

Configured Point is

Evaluates to a non-zero value

Available

Evaluates to zero

Unavailable

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Trend History
CIMPLICITY HMI can compile a trend history for analog and Boolean points. All you have
to do is specify the amount of time that data should be retained and the maximum number of
samples that should be included.
To make specifications for trending data:
Enter the Trend History specifications for checked Max Duration and/or Max Count
check boxes to have CIMPLICITY HMI save information as follows.

Max Duration

The amount of most recent time to be saved. Select


one of the following:

Seconds

Minutes

Hours

Days

Max Count
The number of n values to be saved
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.
Point buffering lets you allocate a buffer for a point and save a number of the most
recent values. This feature is currently being supported only for the Trending option.
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.

Max Count of 10, the buffer contains the 10 most recent


values (that is, the values for the last 50 seconds).

Max Duration and Max Count, the buffer contains the 10


most recent values.

Note: Point buffering is not supported for Enterprise Server points.

GFK-1180H

Configuring Virtual Points

7-13

Point Data and Alarm Logs


You can select to log a device points data and / or alarms in the advanced General tab of the
Point Properties dialog box.

To enable data and/or alarm logging:


1.

Check the Log Data and/or Log Alarm check boxes in the Logging box.

2.

Press Settings to open the Point Logging dialog box.

3.

Select the table to which the data will be logged. See the "Database Logger" chapter in
this manual for information about configuring log tables.

7-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring Advanced Virtual Calculations


In addition to defining an initialization value for a virtual point (basic configuration), you can
select one of several calculations types to have CIMPLICITY HMI calculate a value for the
point. Each calculation type requires different information from you. :
The calculation types are:

Equation Analog and Boolean

Delta Accum

Value Accum

Average

Max Capture

Min Capture

Trans-High Accum

Timer/Counter

Histogram

Equation w/ Override

Tip: A Local checkbox displays on the advanced Virtual tab for every calculation choice
except none. Check the Local check box to tell CIMPLICITY HMI not to report the value of
the point 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.

Notes: Almost all of the calculations allow you to enter a trigger point.
For Equation points, you only need Saved and Initial values for Delta Accum and Delta
Value points. This is because all other Equation points are validated at startup and any
saved or initial value is immediately overwritten.
A Trigger point minimizes 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.
Example
You are configuring a point that requires an update for logging purposes.

If the update needs to be hourly:


Use a device Trigger Point that is configured with a one-hour scan rate. See "On
Scan" in the "Configuring Device Points" chapter in this manual.

GFK-1180H

Configuring Virtual Points

7-15

If the update needs to occur when a particular condition changes:


Use either a:

Device point that represents the condition and is configured to


be updated On Change

Virtual point that represents the condition

Equation Points
Equation points are available for both analog and Boolean virtual points.
CIMPLICITY HMI uses the expression you specify in the Expression field to
update the points value.
To configure an equation point:
1.

Select Equation in the Calculation field.

3.

Enter an Expression that calculates the value of the Equation point. The
expression may contain one or more Point IDs as well as constant values, operations
and functions.

Rules for defining an expression are:


A. Avoid introducing loops (circular references between points)
in your expressions.
A simple example of what to avoid is:
VIRTUAL_PT1 = DEVICE_PT + VIRTUAL_PT2
VIRTUAL_PT2 = DEVICE_PT + VIRTUAL_PT1
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.
B. Use proper formatting for array points.
Example of the correct format
VIRTUAL_PT1 = DEVICE_PT[0] / 2.0
C. Use proper formatting for Point IDs with reserved words.
Point IDs that are reserved words, or contain spaces, arithmetic operators,
parentheses, or that begin with a non-alphabetic character must be placed in
single quotes when used in an expression.
Example
VIRTUAL_PT2 = DEVICE_PT:0 * WARNING_LOW

7-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

3.

(Optional) Enter a Trigger point.


If a Trigger point is:

The value of the Equation point is updated


whenever:

Defined

The value of the Trigger Point is updated.

Not defined

4.

One of the source points in the Expression field is


updated.
(Optional) Enter a Reset point.
Updating a Reset point causes the Equation point value to be reset.
At runtime, the value of the Equation point is reset as follows:
If :

And:
The Current
An Initial Equation
value of the
Point value is
Expression is
When the Trigger Point is not defined

Then:

1 Not defined
Available
2 Defined
Unavailable
3 Defined
Available
4 Not defined
Unavailable
When the Trigger Point is defined

Current value
Initial value
Current value
Zero (0)

1
2

Initial value
Zero (0)

Defined
Not defined

The Equation point


value is reset to the:

Delta Accum Points


A Delta Accum point captures the accumulation of positive increments in a source point. A
decrement in the source point value is also considered to be an incremental delta.
A Delta Accum point:

Adds the difference between the current and previous values of the expression that you
specify in the Expression field to the current value of the Delta Accum point.

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 =

GFK-1180H

Delta Accum + (rollover value + 1) - previous


value + current value

Is first updated after the first two expression updates are received.

Continues to have Delta values added until a Reset Condition is reached.

Configuring Virtual Points

7-17

Example
Note: A rollover value, which is used in this example, is the maximum acceptable value
for a Delta Accum point. When this value is incremented by one (1) unit, the Delta
Accum point rolls over to zero (0).
1.

A Delta Accum configured with a Rollover value of 1000 receives a change from 100 to
999.
The current value of the Delta Accum point is 899 based on the formula described
above.
(1000) + 999 100 = 899

2.

The source point changes from 999 to 20.


The current delta changes to 22 based on the formulas calculation:
(1000 + 1) - 999 + 20 = 22

To configure a Delta Accum calculation:


1.

Select Delta Accum in the Calculation field on the Virtual tab.

2.

(Required) Enter an expression that calculates the value of the Delta Accum point.
The expression may contain one Point ID along with constant values, operations, and
functions.

Note: When the expression for a Delta Accum point goes unavailable, and then
comes back as available, the delta between the value right before the point went
unavailable and the value right after it comes back as available is not accumulated.
3.

(Required) Enter the maximum acceptable delta value that can be added to the Delta
Accum point value in the Variance field.
If the delta value is greater than the Variance value, the:
A. Delta Accum point continues counting.
B. Current delta value is not added.
C. System logs the following message to the Status Log with
Success status:

4.

7-18

Variance value exceeded for accumulator point :


<point_id>
Enter the maximum acceptable delta value that can be added to the virtual point in
the Variance field. Values greater than this number will not be added to the
accumulator point, and the system will log a message to the Status Log.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

5.

(Optional) Enter the maximum acceptable value for the Delta Accum point in the
Rollover field. When this value is incremented by one (1) unit, the Delta Accum
point rolls over to zero (0)

6.

(Optional) Specify a Trigger point. The Delta Accum point updates whenever the
Trigger Point is updated.

7.

If a Trigger point is:

The value of the Delta Accum point is


updated whenever:

Defined

The value of the Trigger Point is updated.

Not defined
The source point in the Expression field is updated.
(Optional) Enter the Point ID of a Reset point.
Updating a Reset point causes the Delta Accum point value to be reset.
At runtime, the value of the Delta Accum point is reset as follows:
If:

And:

Then:

An Initial Delta
Accum Point
Value is

The Current
value of the
Expression is

The Delta Accum point


value is reset to the:

When the Trigger Point is not defined


1
2
5
4

Not defined
Defined
Defined
Not defined

Available
Unavailable
Available
Unavailable

When the Trigger Point is defined


1 Defined
2 Not defined
Example

Zero (0)
Initial value
Initial value
Zero (0)
Initial value
Zero (0)

A Rollover point has a:

Specified value of 99

Current value of 97

If a new value of 3 is received, the delta is calculated as:


(100 - 97) + 3 = 6
If you do not specify a Rollover value, the size of the data type for the expression is
used as the default Rollover value.
Example
If the source point has an INT point type, the maximum acceptable value for the
Delta Accum point is 32767.
If you do specify a Rollover Value, when the current value of the source point is less
than its previous value, the following message is logged to the Status Log with
Success status:
Rollover occurred for accumulator point : <point_id>

GFK-1180H

Configuring Virtual Points

7-19

Delta Accum Array Configuration


When you configure an array point as a Delta Accum point:

The first element of the array adds the difference between the current and previous
values of the source Point ID that you specify in the Expression field to the current
value of the element.

Each additional element of the array is used to store the delta accumulator value for a
different subgroup of the array.

A selector point, which is defined in the Safety Point field, determines which subgroup
element of the array is updated. The selector point must have a value from 1 to N-1, where N
is the number of elements in the array.
Example
An array Delta Accum point tacks production counts for the

Total number of parts produced in a shift

Number of parts produced in each hour of the eight-hour shift

The Delta Accum array point is called COUNTS with 9 Elements (one for the total shift
count, and one for each hour of the shift). The elements are defined as follows:
Element

Description

COUNTS[0]

Shift total production count

COUNTS[1]

First hour production count

COUNTS[2]

Second hour production count

COUNTS[3]

Third hour production count

COUNTS[4]

Fourth hour production count

COUNTS[5]

Fifth hour production count

COUNTS[6]

Sixth hour production count

COUNTS[7]

Seventh hour production count

COUNTS[8]
A Safety Point called HOUR:

Eighth hour production count

Varies from 1 to 8, depending on the hour of the shift.

Determines which subgroup element gets updated along with COUNTS[0]. For
example, if HOUR=4, COUNTS[0] and COUNTS[4] are updated.

If HOUR is less than 1 or greater than 8, no elements in the array are updated.

7-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Value Accum Points


A Value Accum point adds the current value of the source Point ID that you specify in the
Expression field to the current value of the Value Accum point.
Values continue to be added until a Reset Condition is reached.
To configure a Value Accum calculation:
1.

Select Value Accum in the Calculation field on the Virtual tab.

2.

Enter an Expression that calculates the value of the Value Accum point. The
expression may contain one or more Point IDs along with constant values,
operations, and functions.

3.

Enter the Point ID of a Trigger Point that will cause the Value Accum point to be
updated at run-time.
The Value Accum point updates whenever the Trigger Point is updated.
If you do not define a Trigger Point, the Value Accum point updates whenever
the value of the source point in the Expression field changes.

4.

(Optional) Enter the Point Id of a Reset Point.


Updating a Reset point causes the Value Accum point to be reset.
At runtime, the value of the Value Accum point is reset as follows:
If:
An Initial Value
Accum Point Value
is

And:
The Current
value of the
Expression is

Then:
The Value Accum point
value is reset to the:

When the Trigger Point is not defined


1
2
3
4

Not defined
Defined
Defined
Not defined

Available
Unavailable
Available
Unavailable

Zero (0)
Initial value
Initial value
Zero (0)

When the Trigger Point is defined


1
2

GFK-1180H

Not defined
Defined

Configuring Virtual Points

Zero (0)
Initial value

7-21

Average Points
An Average point maintains the average value for the source Point ID that you specify in the
Expression field. This virtual point can be a signed or unsigned integer, or a floating-point
number.
The average is calculated as the accumulation of the deviation from the average point data,
divided by the number of samples taken. The calculation is:
average - average + (source - average) / sample_count
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 Real point type for your Average point.
To configure an average calculation:
1.

Select Average in the Calculation field of the Virtual tab:

2.

Enter an expression that calculates the value of the Average point. The expression
may contain one or more Point IDs as well as constant values, operations, and
functions.
(Optional) Enter a Point ID for a Trigger Point.

7-22

Trigger Point

The Value of the Average Point is Updated


When the:

Defined

Trigger Point is updated.

Not defined

Value of the source point in the Expression field is


updated.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

3.

Enter a Point ID for a Reset Point.


Updating a Reset point causes the Average point to be reset.
At runtime, when the Reset Point updates, the value of the Average point is
reset as follows:
If:
An Initial
Average Point
Value is

And:
The Current
value of the
Expression is

Then:
The Average point value
is reset to the:

When the Trigger Point is not defined


1
2
3
4

Not defined
Defined
Defined
Not defined

Available
Unavailable
Available
Unavailable

Current value
Initial value
Average
Zero (0)

When the Trigger Point is defined


1
2

Defined
Not defined

Initial value
Zero (0)

Max Capture Points


A Max Capture point maintains the maximum encountered point value for the source Point
ID that you specify in the Expression field.
The maximum value is determined by comparing the current source point value with the value
stored in the Max Capture point. If the current value is greater, it is stored as the new Max
Capture point value.
To configure a Max Capture point:

GFK-1180H

1.

Select Max Capture in the Calculation field on the Virtual tab.

2.

(Required) Enter an expression that calculates the value of the Max Capture point.
The expression may contain one or more Point IDs along with constant values,
operations, and functions.

Configuring Virtual Points

7-23

3.

(Optional) Enter a Point ID for a Trigger Point.


Trigger Point

The Value of the Max Capture Point is


Updated When the:

Defined

Trigger Point is updated.

Not defined

4.

Value of the source point in the Expression field is


updated.
Enter a Point ID for a Reset Point.
Updating a Reset point causes the Max Capture point to be reset.
At runtime, when the Reset Point updates, the value of the Max Capture point is
reset as follows:
If;
An Initial Max
Capture Point
Value is

And:
The Current
value of the
Expression is

Then:
The Max Capture point
value is reset to the:

When the Trigger Point is not defined


1
2
3

Not defined
Defined
Defined

Available
Unavailable
Available

Not defined

Unavailable

Current value
Initial value
Whichever has the Max
value
Smallest possible value
for the point type. e.g.
for INT the value is 32768

When the Trigger Point is defined


1
2

Defined
Not defined

Initial value
Smallest possible value
for the point type. e.g.
for INT the value is 32768

Note: When a

Startup condition is Saved.

Reset point is defined

Trigger point is defined

Then the Max Capture point will only reset to the equation value after the reset point is
activated, followed by the trigger point being activated.

7-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Min Capture Points


A Min Capture point maintains the minimum encountered point value for the source Point ID
that you specify in the Expression field.
The minimum value is determined by comparing the current source point value with the value
stored in the Min Capture point. If the current value is smaller, it is stored as the new Min
Capture point value.
To configure a Min Capture point:
1.

Select Min Capture in the Calculation Type field on the Virtual tab.

2.

(Required) Enter an expression that calculates the value of the Min Capture point.
The expression may contain one or more Point IDs as well as constant values,
operations, and functions.

3.

(Optional) Enter a Point ID for a Trigger Point.


Trigger Point

The Value of the MinCapture Point is


Updated When the:

Defined

Trigger Point is updated.

Not defined

4.

Value of the source point in the Expression field is


updated.
Enter a Point ID for a Reset Point.
Updating a Reset point causes the Min Capture point to be reset.

GFK-1180H

Configuring Virtual Points

7-25

At runtime, when the Reset Point updates, the value of the Min Capture point is
reset as follows:
If:
An Initial Min
CaptureValue is

And:
The Current
value of the
Expression is

Then:
The Min Capture point
value is reset to the:

When the Trigger Point is not defined


1
2

Not defined
Defined

Available
Unavailable

Defined

Available

Not defined

Unavailable

Current value
Max possible value for
the point type. E.g. for
INT the value is +32767
Whichever has the Min
value
Initial value

When the Trigger Point is defined


1
2

Defined
Not defined

Initial value
Max possible value for
the point type. E.g. for
INT the value is
+32767for INT the value

Trans-High Accum Points


A Trans-High Accum point accumulates the number of times the Expression 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 Expression and
the point type of the Trans-High Accum point.
For example:

7-26

If the Trans-High Accum point type is DINT and the Expression 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 Expression 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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To configure a Trans High Accum point:


1.

Select Trans_High Accum in the Calculation Type field on the Virtual tab.

2.

(Required) Enter the Expression to be monitored for transitions. The expression


may contain one or more Point IDs along with constant values, operations and
functions.

3.

(Optional) Enter a Point ID for a Trigger Point.


Trigger Point

The Value of the MinCapture Point is


Updated When the:

Defined

Trigger Point is updated.

Not defined

4.

Value of the source point in the Expression field is


updated.
Enter a Point ID for a Reset Point.
Updating a Reset point causes the Trans High Accum point to be reset.
At runtime, when the Reset Point updates, the value of the Trans High Accum
point is reset as follows:
If:
An Initial
Trans High Accum
Value is

And:
The Current
value of the
Expression is

Then:
The Trans High Accum
point value is reset to
the:

When the Trigger Point is not defined


1
2
3
4

Not defined
Defined
Defined
Not defined

Available
Unavailable
Available
Unavailable

Zero (0)
Initial value
Initial value
Zero (0)

When the Trigger Point is defined


1
2

GFK-1180H

Defined
Not defined

Configuring Virtual Points

Initial value
Zero (0)

7-27

Timer/Counter Points
A Timer/Counter point records the following data in three array elements:

A count of the number of times the Expression has transitioned from the LOW
state to the HIGH state since the project started or since the Timer/Counter point
was reset.
The Expression is in its:

LOW state if its value is less than or equal to zero

HIGH state if its value is greater than zero

The accumulated duration of all HIGH states, stored in seconds.

Zero (0) or the time of the last transition to HIGH.


While the Expression is in the:

LOW state, this field contains zero

HIGH state, this field contains the time the Expression


transitioned to the HIGH state.

Time is stored in the number of seconds since 00:00:00 on January 1, 1970 GMT (Greenwich
Mean Time). If you computers clock is set for another time zone, this value is translated
accordingly. For example, if your computers clock is set for Eastern Standard Time, the base
time is 19:00:00 31 December 1969.
To configure a Timer/Counter point:
1.

Select the General tab of the Point Properties dialog box.

2.

Select a Point Type of UDINT

3.

Select an array size of 3 Elements


At run-time, the value of the Expression determines how information is stored in
the array.

When the Expression transitions from its LOW state to its


HIGH state:
The first element of the array is incremented.
The third element of the array is set to the current system time

4.

7-28

The Interval timer starts.


While the Expression remains in its HIGH state, the
duration time in its second element is increased at every
Interval.

When the Expression transitions from its HIGH state to its


LOW state, the third array element is set to zero.

While the Expression remains in its LOW state, no elements


of the array are updated.

Select the Virtual tab.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

5.

Select Timer/Counter in the Calculation Type field.

6.

(Required) Enter an Expression in the Expression field.


The expression may contain one or more Point IDs along with constant values,
operations, and functions. This expression serves as the "edge trigger" for the
Timer/Counter.

7.

Enter a Start Time to be a base start time for the Interval.


The format is hh:mm:ss, where hh is the hour, mm is the minute, and ss is the
second value.
If you have a large number of Timer/Counter points being updated at a high
frequency, system performance can be adversely affected. You can use Start Time
to distribute their updates to different times and reduce the impact on system
performance

8.

Enter the time Interval between the Timer/Counter point updates while the
Expression value remains HIGH. The format is hh_ss_mm where hh is the
number of hours, mm is the number of minutes, and ss is the number of seconds.
Example
Three Timer/Counter points are updating every 15 seconds
You can define their start times as follows to distribute system load:
Point ID

Start Time

Point1

00:00:05

Point2

00:00:10

Point3
00:00:15
You want to update the Timer/Counter point every ten minutes while the
expression is in the HIGH state.
Enter 00:10:00 in the Interval field to update each Timer/Counter every ten minutes
from the time it started.
Point ID

While the expression remains high, will


Update Every 10 minutes in the hour
beginning at:

Point1

00:00:05

Point2

00:00:10

Point3
00:00:15
When the Expression value goes HIGH, the values in the Timer/Counter point
are updated. After that, the updates are done every ten minutes.

GFK-1180H

Configuring Virtual Points

7-29

9.

Enter a Point ID that will cause the Timer/Counter point to be Reset.


At run-time, when the Reset Point updates, the elements of the Timer/Counter
point are reset to zero (0).

Histogram Points
A Histogram point records the frequency at which the value of the source point, identified in
the Expression 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:

Minimum of the point values received

Maximum of the point values received

Total number of samples received

Sum of the values of all samples received

Number of sample values that were less than the lower limit of the point range
(underflow bucket)

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.
To configure a Histogram:

7-30

1.

Select Histogram in the Calculation Type field on the Virtual tab.

2.

(Required) Enter an expression that calculates the value of the Histogram point.
The expression may contain one or more Point IDs along with constant values,
operations, and functions.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

3.

(Optional) Enter a Point ID for a Trigger point.


Trigger Point

The Value of the Histogram is Updated When


the:

Defined

Trigger Point is updated.

Not defined

4.

Value of the source point in the Expression field is


updated.
(Optional) Enter a Point ID for a Reset point.
Updating a Reset point causes the Histogram value to be reset.
At run-time, when the Reset Point updates, the value of the Histogram array is
reset as follows:
If:
An Initial
Histogram Value is

And:
The Current
value of the
Expression is

Then:
Each Array element of
the Histogram is reset
to:

When the Trigger Point is not defined


1
2
3
4

Not defined
Defined
Defined
Not defined

Available
Unavailable
Available
Unavailable

Zero (0)
Initial value
Initial value
Zero (0)

When the Trigger Point is defined


1 Defined
Initial value
2 Not defined
Zero (0)
A point called CYCLE_TIME is expected to have a value between 50 and 100, and you want
to track the frequency at which values occur within five intervals.
Create a Histogram point called HIST_CYCLE_TIME with:
Display Low

50

Display High

100

Elements

11

Expression

CYCLE_TIME

The eleven elements of this point contain the following information, where X is the number of
point value samples:

GFK-1180H

Configuring Virtual Points

7-31

Element

Contents

HIST_CYCLE_TIME[0]

X<50

HIST_CYCLE_TIME[1]

60<X50

HIST_CYCLE_TIME[2]

70<X60

HIST_CYCLE_TIME[3]

80<X70

HIST_CYCLE_TIME[4]

90<X80

HIST_CYCLE_TIME[5]

100X90

HIST_CYCLE_TIME[6]

100<X

HIST_CYCLE_TIME[7]

Number of samples

HIST_CYCLE_TIME[8]

Sum of all sample values

HIST_CYCLE_TIME[9]

Minimum of the point values received

HIST_CYCLE_TIME[10]

Maximum of the point values received

(underflow bucket)

(overflow bucket)

Equation w/Override Points


An Equation w/Override point is similar to an Equation point. It uses the expression you
specify in the Expression field to update the points 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 Expression changes and the Expression is
recalculated, or until an application supplies a new value for the point.
To configure an equation w/override point:
1.

Select Equation w/Override in the Calculation field on the Virtual tab.

2.

(Required) Enter an Expression that calculates the value of the Equation


w/Override point. The expression may contain one or more Point IDs along with
constant values, operations and functions.

Rules when defining an Expression:


A. Avoid introducing loops (circular references between points)
in your expressions.
A simple example of what to avoid is:
VIRTUAL_PT1 = DEVICE_PT + VIRTUAL_PT2
VIRTUAL_PT2 = DEVICE_PT + VIRTUAL_PT1
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.

7-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

B. Use proper formatting for array points.


Example
VIRTUAL_PT1 = DEVICE_PT[0] / 2.0
C. Use proper formatting for Point IDs with reserved words.
Point IDs that are reserved words, or contain spaces, arithmetic operators,
parentheses, or that begin with a non-alphabetic character must be placed in
single quotes when used in an Expression.
Example
3.

VIRTUAL_PT2 = DEVICE_PT:0 * WARNING_LOW


(Optional) Enter a Point ID for a Trigger point.
Trigger Point

The Value of the Equation w/Override is


Updated When the:

Defined

Trigger Point is updated.

Not defined

4.

Value of the source point in the Expression field is


updated.
(Optional) Enter a Point ID for a Reset point.
Updating a Reset point causes the Equation w/Override point value to be reset.
At runtime, the value of the Equation /w Override point is reset as follows:
If:
An Initial Equation
w/Override Point
Value is

And:
The Current
value of the
Expression is

Then:
The Equation
w/Override point value
is reset to the:

When the Trigger Point is not defined


1
2
3
4

Not defined
Defined
Defined
Not defined

Available
Unavailable
Available
Unavailable

Current value
Current value
Current value
Zero (0)

When the Trigger Point is defined


1
2

GFK-1180H

Defined
Not defined

Configuring Virtual Points

Initial value
Zero (0)

7-33

Understanding the Trigger Function for Virtual Points


This section applies to the trigger point that is located on the advanced Virtual tab or tab in the
Point Properties dialog box.
The trigger function lets you configure virtual points so they are updated only when the
trigger point is updated. This minimizes 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 virtual points, a trigger point may be either a device point or a virtual point.
The Update Criteria for the trigger point determines when triggered reads take place. The
criteria can either be when the trigger point value changes or when it is scanned.

Example Overview of Trigger Point Update Options for Virtual


Points
You are configuring a point that requires an update for logging purposes..

If the update needs to be hourly:


Use a device Trigger Point that is configured with a one-hour scan rate. See "On
Scan" in the "Configuring Device Points" chapter in this manual.

If the update needs to occur when a particular condition changes:


Use either a:

7-34

Device point that represents the condition and is configured to


be updated On Change

Virtual point that represents the condition

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Example - Virtual Point Interval Trigger


The points WIDGET_ACCUM and NUT_ACCUM accumulate the number of widgets and
nuts made during a shift. Data needs to be captured from these points at the end of each shift.
To do this configure three virtual points called SHIFT_NUMBER, WIDGET_COUNT, and
NUT_COUNT
On the Virtual property page for SHIFT_NUMBER, select Global for the Calculation
Type. The value in SHIFT_NUMBER changes whenever a shift ends.
The Virtual properties for WIDGET_COUNT are:

WIDGET_COUNT will read the value in WIDGET_ACCUM whenever SHIFT_NUMBER


changes.
The Virtual properties for NUT_COUNT are:

NUT_COUNT will read the value in NUT_ACCUM whenever SHIFT_NUMBER changes.

GFK-1180H

Configuring Virtual Points

7-35

Point Measurement Units


CIMPLICITY HMI software lets you select the base engineering units for virtual point. You
do this on the Conversion tab that appears in the advanced General tab group.

Displaying the Conversion Tab


To display the Conversion tab::
on the General tab.

1.

Press the Advanced button

2.

Select the Conversion tab that appears if you are configuring an analog point.

Configuring Base Engineering Units for a Point


Fill in the Measurement units field to define the units that CIMPLICITY HMI converts to and
/ or from the projects base measurement units.:.
To configure the base engineering units for a point
Method 1

7-36

1.

Click the Popup Menu button to the right of the Unit field.

2.

Select the name of the base engineering units from the list of available measurement
units. When you do this, the label for the unit is automatically put in the Label field.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Method 2
Click the Browser button to the right of the Unit field to find the measurement unit in the
Select A Measurement Unit Browser

Method 3
1.

Click the Pop-up Menu button to the right of the Unit field.

2.

Select New.
The New Measurement dialog box opens.

3.

Enter a new measurement label.


The Measurement Unit Properties dialog box appears.

4.

(Optional) Enter a description.

5.

Enter the label that will appear when the measurement unit is selected.

6.

Press Apply.
The new unit is added to the list of available units.

GFK-1180H

Configuring Virtual Points

7-37

Method 4
Leave the base units for the point blank and enter your own label in the Label field.
The unit appears in the Unit field when you use Methods 13.

Note: If you select a unit of measurement on the Conversion tab, and the project has an active
measurement system at runtime, the base engineering units for the point are automatically
converted to the corresponding units in the active measurement system.
If there is no active measurement system, the base engineering units are used. If the project
has an active measurement system at runtime, no further point conversion takes place.
Example
The point's value represents degrees F.
You leave the Unit field blank.
The active measurement system uses metric units.
No conversion from degrees F to degrees C takes place at runtime.
CIMPLICITY HMI supports the following types of Engineering Unit (EU) conversions for
analog points.
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.

7-38

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

About the Expression Editor


There are several places in CimEdit where you enter an expression as part of your
configuration.
Whenever you are asked to enter an expression, you can take advantage of the convenient
Expression dialog box to create the expression and easily find any Point IDs or variables
that you want to include.
To create an expression:
Method 1
Click the

button to the right of an Expression input field

Method 2
Select Edit Expression from the Pop-up menu
Either method opens the Edit Expression dialog box.
Continue
1.

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.

2.

Insert a Point ID or variable either after the operator or between parentheses, if they
appear with an operator.

Note: An expression can be up to 300 characters long.


Edit Expression Dialog Box

Input box

Point ID
popup

Points
Configuration
dialog box
New Point
dialog box

Double click an
available
operator

GFK-1180H

Configuring Virtual Points

7-39

Tip: Use the Point IDs..., Edit Point and New Point buttons to browse through
existing points, edit a selected point or create a new point.
Operations are divided into the following areas:

Alarm functions

Arithmetic

Bitwise

Conversion

Logical

Relational

Scientific

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

7-40

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Arithmetic Operations
Arithmetic operations supported by the Expression Editor are:
+

Addition

Subtraction

Multiplication

Division
The result of dividing two integers in an expression will
be an integer. If you want a floating point result, multiply
the numerator by 1.0 before dividing.
For example, POINTA is set to 6 and POINTB is set to 4.
The result of the expression POINTA/POINTB is 1,
while the result of the expression
(POINTA*1.0)/POINTB is 1.5.

SQR

Takes the square root of an expression.


The format for this operation is SQR expr.

ABS

Takes the absolute value of an expression.


The format for this operation is ABS (expr).
For example, ABS (-2.6) return 2.6.

MIN

Returns the minimum value of two expressions.


Format is (expr1) MIN (expr2).
For example, 3 MIN 4 returns 3.

MAX

Returns the maximum value of two expressions.


Format is (expr1) MAX (expr2).
For example, 3 MAX 4 returns 4.

MOD

Returns the modulus value of an expression.


Format is (expr1) MOD (expr2).
For example, 9 MOD 8 returns a value of 1.

RND

Rounds a floating-point expression to the nearest integer.


Format is RND (expr).
For example, RND (2.6) returns a value of 3 and RND (2.6) returns a value of -3.

TRUNC

Truncates a floating-point expression to its integer value.


Format is TRUNC (expr).
For example, TRUNC (2.6) returns a value of 2, and
TRUNC (-2.6) returns a value of -2.

FLR

GFK-1180H

Configuring Virtual Points

Rounds a floating-point expression to the nearest integer


that is smaller than the expression.

7-41

Format is FLR (expr).


For example, FLR (2.6) returns a value of 2, and FLR (2.6) returns a value of -3.
CEIL

Rounds a floating-point expression to the nearest integer


that is larger than the expression.
Format is CEIL (expr).
For example, CEIL (2.3) returns a value of 3 and CEIL (2.3) returns a value of -2.

Bitwise Operations
You can use Boolean, integer or floating point number for bitwise operations. If a
number/expression is in floating point, it is rounded off to the nearest integer for these
operations.
Bitwise operations supported by the Expression Editor are:
BAND

Performs a bitwise AND of two expressions.


Format is <expr1> AND <expr2>.

BOR

Performs a bitwise OR of two expressions.


Format is <expr1> OR <expr2>.

BNOT

Performs a bitwise NOT of an expression.


Format is NOT <expr>.

BXOR

Performs a bitwise XOR of two expressions.


Format is <expr1> XOR <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.

7-42

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Conversion Operation
VAL

Convert a variable that consists of numbers in text string


format to a numeric format that can be included in
calculations.

Logical Operations
You can use Boolean, integer or floating point numbers for logical operations. If an
expression has a non-zero value, it is TRUE; if the value is zero (0), it is FALSE.
Logical operations supported by the Expression Editor are:
AND

Performs a logical AND of two expressions.


Format is <expr1> AND <expr2>.

OR

Performs a logical OR of two expressions.


Format is <expr1> OR <expr2>.

NOT

Performs a logical NOT of an expression.


Format is NOT <expr>.

XOR

Performs a logical XOR of two 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.

Relational Operations
Relational operations supported by the Expression Editor are:
LT

Less Than or Below


Format is (expr1) LT (expr2).

GT

Greater Than or Above.


Format is (expr1) GT (expr2).

EQ

Equal To
Format is (expr1) EQ (expr2).

LE

Less Than or Equal To


Format is (expr1) LE (expr2).

GE

Greater Than or Equal To


Format is (expr1) GE (expr2).

NE

Not Equal To
Format is (expr1) NE (expr2).

GFK-1180H

Configuring Virtual Points

7-43

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)

X^Y

Raise a value to a power.


The format for this operation is <value> ^
(<power>).

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)

7-44

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Runtime 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 not within the range values specified by the Point Type
for the virtual point. For example, an INT point has a range between -32768 and +32767.
For Equation and Equation w/Override types, when the expression evaluates to an out of
range or overflow condition, the following message is logged to the Status Log with a
Failure status:
Result from expression is out of range.

Point <point_id>

The value of the virtual point becomes unavailable and remains that way until the Expression
once more evaluates to a valid value.
All other calculation types keep their last available value
If the enabler uses standard addressing, do the following to specify a diagnostic point:
1.

Select the Diagnostic data check box.

2.

Select the domain type in the Domain type field.

3.

Enter the correct offset for the point in the Domain offset field.

Use the following values to configure diagnostic data for devices with standard addressing:
Description
Number of messages sent
Number of messages received
Number of communication failures
Number of retries
Device up status
Device down status

GFK-1180H

Configuring Virtual Points

Data
Type
UDINT
UDINT
UDINT
UDINT
BOOL
BOOL

Domain Type
Standard Diag. Double Words
Standard Diag. Double Words
Standard Diag. Double Words
Standard Diag. Double Words
Standard Diagnostic Bits
Standard Diagnostic Bits

Domain
Offset
0
1
2
3
0
1

7-45

Configuring Point View, Limits


and Alarms
About Point View, Limits and Alarms
CIMPLICITY HMI provides you with extensive advanced point configuration capabilities for
both virtual and device points. You can configure:
A Point View

Associate a CimView screen with any point so you can quickly review its status
through the Workbench.

Configure an analog points display characteristics for applications such as CimView

Point Limits

Specify the display range limits in applications such as CimView

Specify setpoint limits

Alarms for points

GFK-1180H

Enter a basic alarm message

Do advanced alarm configuration including:

A detailed alarm definition

An alarm class that prioritizes the points alarm

Criteria for evaluating the alarm values

Alarm limit values

An alarm delay

A deadband that defines the tolerance for alarm conditions

A help file

Specify how alarms are routed

Set alarm options

8-1

Point View
For any point that you configure, you can select a CimView screen name that will appear on
that points popup menu in the Workbench.
You can also configure analog point display characteristics for CIMPLICITY HMI
application such as CimView.
You do this on the View tab of the Point Properties dialog box.

Associating a CimView Screen with a Point


You specify a screen name on the View tab of the Point Properties dialog box.
To specify a screen name to display on a points popup menu in the
Workbench:
1.

Press the Advanced button

2.

Select the View tab that appears.

on the General tab.

Boolean, text

analog

3.

8-2

Select a Screen from the selection in the drop down menu. Your options include
CimView screens that are in the project directory.

The name of the screen you select will appear on the points
popup menu in the Workbench. The screen will appear when it
is selected.

The screen will display when a user selects this point in the
Alarm Viewer and clicks Screen.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring Analog Point Display Characteristics


You can configure an analog points justification, width and Display High/Display Low limits
on the View tab of the Point Properties dialog box

View Tab Displayed


To display the View tab:
1.

Press the Advanced button

2.

Select the View tab that appears.

on the General tab.

You can specify an analog points justification when it displays in standard CIMPLICITY
HMI software, such as CimView.
To select an analog points justification:
Select the left, right or zero radio button. :
LeftPoint display is left justified
RightPoint display is right justified
ZeroPoint display is right justified and zero filled

GFK-1180H

Configuring Point View, Limits and Alarms

8-3

Analog Point Display Width


Enter the minimum number of spaces you want to use to display the point in the Width field
that is on the .

The width specification never causes a value to be truncated. If the number of characters in the
output value is greater than the specified width, or if a width is not given, all characters of the
value are printed (subject to the precision specification).
If the number of characters in the output value is less than the specified width, blanks are
added to the left or right of the values, depending on whether the flag (for left alignment) is
specified, until the minimum width is reached.
If the width is prefixed with 0, zeros are added until the minimum width is reached.
For analog real points and points with Engineering Units conversion
1.

Enter the PRECISION number of digits to be displayed to the right of the decimal
point in field.

2.

Select Fixed, Scientific or Compact for the format TYPE. The result of your
choice is as follows:
Format Type

Points Value displays in CimView in

Fixed

Fixed format using the Width and Precision


information you specify. The default is 6 if precision
is not specified.
Example
Width = 7
Precision =3
The point display uses 7 places with 3 of the places
after the decimal point.
10 displays as 10.000.

Scientific

Scientific format using the Width and Precision


information you specify. The default is 6 if precision
is not specified.

Compact

Fixed or Scientific format based on Precision


information Precision information determines the
exponent to start displaying in Scientific format.
Example
Precision = 5.
The value 100,000 displays as 1e+005.
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.

8-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Note: For integer point types, Decimal is the only format type.

Guide for enabling analog display configuration: When you configure an object that
uses the point in CimView, you have to enable the Justification and Width configuration in
CimEdit. You do this on the Text tab of the Object Properties dialog box in CimEdit, in the
Display Format field. See "CIMPLICITY HMI CimEdit Manual" GFK-1396 for more information.

Analog Display Low and Display High Limits


Display low and Display high graphics limits are used by CimView and Trending..

CimView uses graphics limits as maximum/minimum limits for:

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 points display limits are used instead. If
these limits are not specified either, default values of 0 (minimum) and 100 (maximum) are
used.
Trending uses the graphics limits to determine the Y-axis limits for the point.

GFK-1180H

Configuring Point View, Limits and Alarms

8-5

The display limits must be within the range limits you specify on the Limits properties page.
Limit

Enter the:

Display High

Upper bound for the display. If the point value is greater


than this value, this Display High value displays.

Display Low

Lower bound for the display. If the point value is less


than this value, this Display Low value displays

Important: Make sure the display limits are within range limits that you set. See "Range
Limits" in this chapter.

Point Limits
You can specify range and setpoint limits for both device and virtual analog points on the
Limits tab that appears in the Advanced General tab group.

Displaying the Limits Tab


The Limits tab is available for a points advanced general configuration.
To display the Limits tab:
on the General tab of the Point Properties

1.

Press the Advanced button


dialog box.

2.

Select the Limits tab that appears if you are configuring an analog point.

Limits Tab

Exclude
meaningless data
Define range for
allowed setpoints

8-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring Range Limits


Range limits can be very useful if you want to exclude meaningless data from CIMPLICITY
HMI functions.
To specify range limits:
1.

Select the Limits tab.

3.

Enter the low and high limits for the converted value of the point.

Values below the low range limit and above the high range limit will display as the
point unavailable value.
Example
A PLC gives raw data in counts from 0 to 1000.
The raw data represents temperatures between -500 C and +500 C.
Values above 200 C or below -200 C are considered to be out of range.

If the points value is:

Below -200 C, the points unavailable value displays

Above 200C, the points unavailable value displays

Between -200 C and +200 C, its current value displays.

Unavailable Values during Runtime


When the project is running, values equaling or exceeding the range limits are handled as
follows:

GFK-1180H

If a range limit is exceeded at runtime and the RAW_LIMIT_ALARM global


parameter is not set to "YES", the last good point value displays until the point
comes back within raw limits.

If a raw limit is exceeded at runtime and the RAW_LIMIT_ALARM global


parameter is set to "YES":

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.

Configuring Point View, Limits and Alarms

8-7

If a range 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.

If the RAW_LIMIT_ALARM global parameter is set to "YES", an alarm is


generated when a points value first exceeds its range limits. When the point value
returns to within its range limits, the Alarm State will be set to Normal.

Configuring Setpoint Limits for a Point


The purpose of setpoint limits is to only allow setpoint entries within a specified range of
values.
To configure setpoint limits:
1.

Select the Limits tab.

2.

Enter the Low and High limits in the Setpoint box.

If a user enters a value below the low setpoint limit or above the high setpoint limit, the value
will not be accepted.

Important: The setpoint limits must be within the range limits.

8-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarms
You can set alarms for analog and Boolean points.
Point Management provides you with a

Basic Alarm tab option if you want to do a quick basic alarm configuration.

An advanced alarm configuration in which you can precisely specify what messages
should display, when and who has access. The tabs for the configuration are

Alarm (advanced view)

Alarm Routing

Alarm Options

Configuring the Basic Alarm Tab


If you want to have a simple alarm message display when a points value equals or exceeds
one or more of four limits that you enter, you only need to do a basic alarm configuration.
Basic alarm configuration is the same for Analog and Boolean points, regardless of whether
they are device or virtual points. If you choose to display alarms, the limits you specify, of
course, are different for Analog and Boolean points.
To do basic alarm configuration (overview):
1.

Select the Alarms tab.


One field displays.
Alarm TabBasic ViewFirst Opened

GFK-1180H

2.

Enter a basic Alarm Message. See "Basic Alarm Message" in this section.

3.

Specify Alarm Limits. See "Specifying Alarm Limits" in this section.

Configuring Point View, Limits and Alarms

8-9

Basic Alarm Message


Enter a message in the Alarm Message 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.

Note: Using several of the available variables can involve advanced configuration.
To enter a basic alarm message:
Enter an Alarm Message in the Alarm Message field.

You can type in the variables or select them from the fields popup menu. See "Alarm Definition"
in this chapter.

Basic Alarm Limits


If you enter an alarm message, you have to specify at least one alarm limit. When an alarm
limit is reached, CIMPLICITY HMI displays the alarm message in the Alarm Viewer.
The type of limits you enter depend on whether you are configuring an analog or Boolean
point.
Alarm TabBasic ViewLimits
Analog point

Boolean point

8-10

Enter 1 to 4 limits for an analog point.

Select either one (1) or zero (0) for a Boolean point.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Displaying the Advanced Alarm Tabs


If you want to do an advanced configuration you need to display all of the available Alarm
tabs. They are:

Alarm (advanced view)

Alarm Routing

Alarm Options

To display the advanced group of alarm tabs:


1.

Make an entry in the Alarm Message field, if the field is blank.


The Advanced button appears.

2.

Press the Advanced

button.

The Advanced Alarm tab appears.

A detailed alarm definition can be entered or changed and be given an assigned Alarm Class
and string index.

GFK-1180H

Configuring Point View, Limits and Alarms

8-11

Configuring the Advanced Alarm Tab


The advanced Alarm tab provides you with the ability to enter:

A detailed alarm definition

An alarm class that prioritizes the points alarm

Criteria for evaluating the alarm values

Alarm limit values

An alarm delay

A deadband that defines the tolerance for alarm conditions

A help file

Alarm Definition
You can configure a basic I/O alarm message in the Alarm tabs basic view. It is in the
advanced view that you enter a definition that CIMPLICITY HMI uses to trigger exactly the
alarm message you want based on calculated criteria. The Definition box includes specifying
an alarm:

8-12

Message with optional variables

Class

String

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To define an advanced alarm message:


1.

Enter a message in the Alarm Message 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.

Alarm TabBasic ViewMessage with Variables

Entries
%ID
%VAL
%EU
%STATE
%LIMIT
%DEV_ID
%DEV_VAL
%DEV_AMT

You can type in the variables or select them from the fields popup menu. Type them all as
capital letters (CAPS).

2.

Variable

Displays the:

%ID

Point ID

% LIMIT

Alarm limit that was exceeded

%VAL

Point value (converted to engineering units if


applicable.)

%EU

Engineering Units label

% STATE

Alarm string for the String Index

%DEV_ID

Point ID of the deviation point

%DEV_VAL

Value of the deviation point

%DEV_AMT

Difference between the current point value and the


deviation point value

%%
Actual percent sign in the message.
Enter an Alarm Class to group alarms with similar characteristics. An alarms class
determines the order in which it appears relative to other alarms in Alarm Viewer.
You can prioritize classes in the Alarm Class Configuration dialog box.

If you specify an Alarm Class, you must specify an Alarm Message.


3.

GFK-1180H

Enter a String Index number to identify the alarm text, if you are using %STATE
in your alarm message.

Configuring Point View, Limits and Alarms

8-13

When %STATE is used:


1. Enter the String Index

Select an Alarm String


browser
Alarm String popup

2. The associated
text appears
as the Alarm
Limits

Example of an Alarm Message


An alarm is configured:
String for Warning High is "WARNING"
Alarm High Limit = 350
String for Alarm High is "EMERGENCY"
Warning High limit = 400
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

Alarm Class Configuration


You can configure Alarm classes that display alarm state colors and/or emit a specified sound
by following the procedures for steps.
The steps are:
Step 1: Describe the Alarm Class
Step 2: Select colors for the alarm
Step 3: Select sound for the alarm
Step 1: Describe a new alarm class:
1.

Press the Popup button


to the right of the Alarm Class field on the Alarm tab of
the Properties dialog box.

2.

Select New on the popup menu.

3.

Select the Alarm Class tab.


The Alarm Class Configuration dialog box appears.

8-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

4.

Name the new class in the Class ID field.

5.

(Optional) Describe the class.

6.

Select a priority number in the Order field. CIMPLICITY HMI gives alarms with a
one-(1) order number the highest priority.

Step 2: Select colors for the Alarm Class:


Select the Foreground and Background colors for the alarm class that should be
displayed in Alarm Viewer, for:

GFK-1180H

Normal State

Alarm State

Acknowledged State

Configuring Point View, Limits and Alarms

8-15

Step 3: Select sound for the alarm:


1.

(Optional) Select the Audio tab.

Alarm Tab: Basic to Advanced


Wave path and file

Beep
specifications

Test

2.

Check the Audio Support checkbox.

3.

Select either Wave or Beep.


Wave files

A. Click the browser button

to the right of the File field.

B. Find the .WAV file you want to use in the Windows Open
dialog box.

8-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Beep

A. Enter a Frequency between 37 and 32767. The higher the


number the higher the pitch.
B. Enter the Duration of the beeps.
C. Enter the No of beeps that will beep in the duration time.
Test either type of sound with the Test button.
You can edit your class by simply selecting Edit on the popup menu.

Alarm Criteria
You can select one of the following methods for evaluating the alarm values:

GFK-1180H

Alarm Criteria

Used to

Absolute

Detect when the value of a point is too high or too


low

Deviation

Detect when the value of a point deviates too far from


that of a second point.

On Update

Generate an alarm whenever the points value is


updated.

Rate of Change

Detect either a faster or slower than expected change


in the value of a point.

Configuring Point View, Limits and Alarms

8-17

Absolute Alarming
Absolute alarms are used to detect when the value of a point is too high or too low.
To configure absolute alarming:
1.

Select Absolute in the Alarm Type field on the advanced Alarm tab.

2.

Enter at least one and up to four values in the Alarm Limits fields.

Each time the points value is updated, its current value is compared with the alarm
values. An alarm is generated when the points 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, the Point Manager resets alarms for the point.

8-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Deviation Alarming
Deviation alarming is used to detect when the value of a point deviates too far from that of a
second point.
To configure deviation alarming:
1.

Select Deviation in the Alarm Type field on the advanced Alarm tab.

2.

Define the values in the Alarm Limits fields based on the deviation from the norm:
The text definition depends on the string you select in the String Index field on the
same tab. Make sure that:

High (Full) is larger than Warning High (Almost Full)

Low (Empty) is larger than .Warning Low (Almost)

Empty is larger
than Almost

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.
On Update Alarming
On Update alarming is used to generate an alarm whenever the points value is updated.

If you choose the On Update alarm criteria, you cannot define Alarm Values. Each time the
points value is updated, an alarm is generated.

GFK-1180H

Configuring Point View, Limits and Alarms

8-19

Rate of Change Alarming


Rate of Change alarming detects either a faster or slower than expected change in the value
of a point.
To configure rate of change alarming:
1.

Select Rate of Change in the Alarm Type field on the advanced Limits tab.

2.

Select the time interval from:

3.

Seconds

Minutes

Hours

Enter the length of the interval between sampling the point 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

4.

Define the values for the Alarm Limits.

5.

Make sure Alarm Delay has not been checked.

An alarm is generated when the difference between the current value of the point and its value
at the last sample interval exceeds an alarm limit. The current point is not evaluated for an
alarm condition each time the value changes. An alarm is generated under these conditions:
Alarm

Generates alarms for:

Alarm High

Faster than expected changes

Warning High

Faster than expected changes

Alarm Low

Slower than expected changes

Warning Low
In the Alarm Limits, you can specify:

8-20

Slower than expected changes

Values that are

To check for:

Positive

Increasing values

Negative

Decreasing values.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Use the following table as a guide:


Alarm Limit
Alarm High
Alarm High
Warning High
Warning High
Warning Low
Warning Low
Alarm Low
Alarm Low

Rate of Change
value is ...
Alarm High
Alarm High
Warning High
Warning High
Warning Low
Warning Low
Alarm Low
Alarm Low

Limit Value
Positive
Negative
Positive
Negative
Positive
Negative
Positive
Negative

Point value is ....


Increasing too fast
Decreasing too fast
Increasing too fast
Decreasing too fast
Increasing too slowly
Decreasing too slowly
Increasing too slowly
Decreasing too slowly

Alarm Limit Values Overview


Enter the values you want for alarm limits in these fields. The evaluation of alarm limits
depends on the Alarm Criteria you select
Alarm Type
Absolute

Define an upper and lower alarm limit and an upper and lower
warning limit for the point value.

Rate of Change

Specify positive alarm limits to check for increasing values and


negative alarm limits to check for decreasing values.
The high values are used to detect faster than expected changes,
and the low limits are used to detect slower than expected changes.

Deviation

Specify the deviation from the norm, Where The

High limit Is larger than the Warning High limit

Low limit is larger than the Warning Low limit

Example: Alarm Limits


Absolute or
Rate of Change

Lo-1 is larger
than Lo-2

GFK-1180H

Configuring Point View, Limits and Alarms

Deviation

Empty is larger
than Almost

8-21

Alarm Delay
Alarm Delay delays the display of the alarm on Alarm Viewers and other Alarm Management
Interested Processes unless the point remains in an alarm state for the configured interval.
The Alarm Delay feature is only available when you select Absolute alarming. If you select
the Delay Alarms check box, the Interval fields represent the length of the delay before the
alarm is reported.
When an alarm condition is
detected for a point and if:

The Point Manager sends the information

No Alarm delay is configured Immediately to the Alarm Manager and all other Point
Management Interested Processes such as CimView and
the Event Manager.
An Alarm delay is configured: After the delay time generates the Alarm Delay. This
means that Alarm Delay applies to all the Point
Management Interested Processes such as CimView, Point
Control Panel and the Event Manager, the Alarm Viewer
and other Alarm Management Interested Processes, such
as the Alarm Printer, that are serviced by the Alarm
Manager.
To specify the length of an alarm delay:
1.

Check the Alarm delay checkbox.

2.

Select for the time length one of the following:

Seconds

Minutes

Hours

3.

Select seconds or minutes.

4.

Enter the length of the selected time.

When the alarm condition is detected for the point the:

8-22

Point Manager sends the information immediately to the Alarm Manager and all
other Point Management Interested Processes such as CimView and the Event
Manager.

Alarm Manager generates the Alarm Delay. This means that Alarm Delay only
applies to the Alarm Viewer and other Alarm Management Interested Processes, such
as the Alarm Printer, that are serviced by the Alarm Manager

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Deadband
A deadband defines the tolerance for alarm conditions.
The deadband cushions the generation of alarms when a point value fluctuates at an alarm
limit.
Example
A high alarm limit is 100.
A deadband is 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.
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.
Example
A point has a:

High alarm limit of 100

Warning high limit of 90.

Deadband of 2

When the points value:

Is 100, the point is in Alarm High state

Falls below 98, the state changes to Warning High (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.

GFK-1180H

Configuring Point View, Limits and Alarms

8-23

Routing Alarms
The Alarm Routing properties let you select the Roles that can view any alarms generated by
this point.
You can:
Assign available roles to view alarms.
Remove roles from viewing alarms
Create new roles to select.

Roles Assigned to View Alarms


To assign the roles for viewing alarms generated by a selected point:
1.

Select the Alarm Routing tab in the Point Properties dialog box.

2.

Select a user role in the Available Roles column that can view the alarms.

3.

Press Add. The role will move over to Configured Roles For Alarm column.

4.

Select any roles in the Configured Roles for Alarm column that should not view the
alarms.

Roles Removed from Viewing Alarms

8-24

1.

Select the Alarm Routing tab in the Point Properties dialog box.

2.

Press Remove. The role will move over to the Available Roles column.

3.

Press OK. The fields display from left to right in the order you specified.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

News Roles Created that are Available to View Alarms


To create a new role:
1.

Press New.
The New Role dialog box opens.

2.

Enter the new Role ID.

3.

Select OK.
The Role Properties dialog box opens if the Role ID you entered is valid.

4.

Enter the properties you want for this role

5.

Select OK to create the new Role and return to the Alarm Routing properties.

Setting Alarm Options


You can determine how, when, and for what time period alarms will be displayed and reset on
the Alarm Options tab.
Entries include

GFK-1180H

Automatic actions

Manual reset permission

Deletion requirements

Maximum stacked alarms

Configuring Point View, Limits and Alarms

8-25

You have the ability in CIMPLICITY HMI to enter your specifications for each stage in the
sequence.

Important: If you have not defined an alarm for the point, any information you enter on this
page is not saved when you select OK.

Automatic Actions
Automatic actions on the Alarm Options tab include:

Alarm Repeats

Automatic acknowledgements

Automatic reset

Alarm Repeats
Auto repeat, on the Alarm Options tab, 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.
In particular, the Alarm Line Printer (AMLP) is an interested process. Setting a repeat
timeout will cause the points alarm to be reprinted on the Alarm Line Printer until it is
cleared.

8-26

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To specify the auto repeat:


Select None or Timed in the Auto Repeat field.
None
The alarm will not be repeated.
Timed
Select the number of minutes between alarms, in the minutes field that appears.

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.
Alarm Acknowledgements
An alarm can be acknowledged manually or automatically
Alarm acknowledgement is configured on the Alarm Options tab of the points Properties
dialog box.
To configure automatic alarm acknowledgement:
Select None, Immediate or Timed to specify how the Alarm Manager should react to
an alarm.
None
There is no automatic acknowledgement. Instead a user has to manually reset the alarm.
Immediate
CIMPLICITY HMI immediately acknowledges the alarm.
Timed
Enter the number of minutes, in the minutes field that appears, that the Alarm Manager
should wait before automatically acknowledging the 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.

GFK-1180H

Configuring Point View, Limits and Alarms

8-27

Reset Procedures
An alarm can be reset:

Manually

Automatically

Because the condition causing the alarm no longer exists, and the process that
detected the alarm condition automatically reset the alarm.

Alarm reset configuration is done on the Alarm Options tab of the points Properties dialog
box.
To allow the alarm reset to be reset manually:
Check the Manual Reset Allowed checkbox.
To configure automatic alarm reset:
Select None, Immediate or Timed in the Auto Reset field.:
None
The alarm can only be manually reset.
Immediate
The Alarm Manager immediately resets the alarm. If you select this option, the alarm will not
repeat.
Timed
Enter the number of minutes, in the minutes field that appears, that the Alarm Manager should
wait before automatically resetting the alarm .

Alarm Deletion
The Deletion Requirements are the conditions that must exist in order for an alarm to be
deleted (removed from the system).
If you select both check boxes on the Alarm Options tab of the points Properties dialog box,
the alarm will not be deleted until it is acknowledged and reset (these actions may occur in
any order).

8-28

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Maximum (Alarm) Stack


You can configure an alarm so that the states it passes through, once it is generated, can be
kept or stacked until the alarm is deleted.
Users in the Alarm Viewer can display this stack.
When the alarm is deleted, all occurrences of the stacked alarm are deleted.
To specify a maximum alarm stack:
Enter a number between 0 and 20 in the Maximum Stack field on the Alarm Options tab of the
points Properties dialog box..

Zero (0) means that the alarm will not be stacked.


At run-time, as occurrences are generated for the alarm they fill the stack. When the
Maximum Stacked value is reached, the oldest alarm occurrence is deleted from the stack
as each new occurrence is generated.

GFK-1180H

Configuring Point View, Limits and Alarms

8-29

Changing the Workbench Point


Display

About the Workbench Point Display


The Workbench provides you with a central location in which you can:

Display a list of all points or selected points in your project

Display selected fields associated with the points

Note: You can also use the Workbench to monitor runtime behavior, including:

Open the Point Control Panel to monitor and control runtime point behavior

Display a Quick Trend chart for a selected point

Customizing the Point List in the Workbench


You can display a list of all of the points in your project or selected points in the right pane of
the Workbench.

All Points Displayed in the Workbench


To view all the points in a project:
1.

Select Points in the left pane of the Workbench.

2.

Tell CIMPLICITY HMI to automatically display all the points by either of the
following methods:
Method 1
A. Select View on the Workbench menu bar.
B. Select Autofill if there is no check mark on its left side.

GFK-1180H

9-1

Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Autofill from the popup menu if there is no check mark
on its left side.
CIMPLICITY HMI displays a list of all the existing points when you use either method.

Note: Points with a $ as the first character in the name are system points and cannot be
changed or removed.

Selected Points Displayed in the Workbench


It is very likely that you will want to display just one point or a type of points in the right pane
of the Workbench. CIMPLICITY HMI provides you with the tools to display precisely what
you need.
To view a list of selected points in the Workbench:
1.

Select Points in the left pane.

2.

Display a Search dialog box using any of the following methods.


Method 1
A. Select View on the Workbench menu bar.
B. Select Search.
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Search.
Method 3
Press the Search button

on the Workbench toolbar.

The Point search dialog box appears.

9-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Examples: Point Search Dialog Box

Specify what
point to list

Use wild cards for any


entry:
?one character
*multiple characters

Opens a
Browser window

Specify one or more


criteria

Enter a description that


appears in a points
Properties dialog box,
General tab, Description field.

3.

Enter one of the following


A. An existing Point ID
B. Device ID, Resource and/or Point Type
C. Description that appears in a points Properties dialog box,
General tab, description field

For tips on using wild card characters, click


Tip: Using wild card characters
Wild cards can help you filter your display even if you do not know the exact name for the
criteria you are using. Use either a * or a ?.
Enter a * in the following positions: when you enter any search criteria:
*Position Relative
to Entered Characters

To Display Any Points that:

After

Begin with the entered characters, e.g. F_ Tank*

Before

End with the entered characters, e.g. *Tank

Between
Begin and end with the entered characters, e.g. F*1
Enter a ? to display any points that contain the characters you enter, in addition to one
character per ?, in the position that the ? is entered, e.g. ?_Tank?
The point or points you specify will display in the right pane until you change your
specifications.

GFK-1180H

Changing the Workbench Point Display

9-3

Browser Windows as Search Aids


CIMPLICITY HMI provides you with Browser windows from which you can select the
Device ID, Resource or Point Type that you want to use as criteria for selecting what points to
display.
To use Browser windows to specify point display criteria:
1.

Click the Browser button to the right of the Device ID, Resource or Point Type field
in the Point Search dialog box.
The appropriate Browser window opens.

Example: Browser Windows


Resource Browser

Enter criteria to
filter the display

Double click one


item to select it

2.

Enter criteria in the filter fields to reduce the display list.

3.

Double click the item you want to use as a filter.


The item appears in the appropriate Point search dialog box field.

9-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Selecting Fields to Display in the Workbench


There are one or more fields for points that, when displayed, help you determine exactly what
a point represents . You can display as few or as many of these fields as you want in the
Workbenchs right pane list.

Note: Two useful fields that display the point status are:
Needs Update

Displays a one (1) if a point configuration has


changed and the project needs a configuration update.

Modified

Displays the date when the point was last modified

Field Selection
Use the Field Chooser dialog box to select the point fields that will display in the right pane of
the Workbench.
To select the point fields to display in the right pane:
1.

Select Points in the left pane.

2.

Use any of the following methods to open the Field Chooser dialog box.
Method 1
A. Click the right mouse button in the right pane.
B. Select Field Chooser from the popup menu.
Popup

GFK-1180H

Changing the Workbench Point Display

9-5

Method 2
A. Select View on the Workbench menu bar.
B. Select Field Chooser.
View Drop Down Menu

Method 3
Press the Field Chooser button

on the Workbench toolbar.

The Field Chooser dialog box for points opens when you use any of these methods.
Example: Field Chooser Dialog Box for Points

Indicates if point has


changed and project
needs configuration
update

Shows when point


was last modified
Moves field further
left in the pane
Moves field further
right in the pane

Fields that will not display

9-6

Fields that will display

3.

Select a field in the Available field column that you want to add to your display.

4.

Press Add. The field will move over to the Display Fields column.

5.

Select any field in the Display fields column that you do not want to display.

6.

Press Remove. The field will move over to the Available field column.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

7.

8.

Use the Move Up and Move Down buttons change a selected fields place in the list.
Move on the list

Moves the fields column to the:

Up

Left of the fields beneath it

Down
Right of the fields above it
Press OK. The fields display from left to right in the order you specified.

Field Definitions
Most of the field names state exactly what the field is. However, for reference, following is a
brief explanation of all the fields available for display.
Field

To Display

Access Filter

"E" if the point is an Enterprise point.

Address

Actual-starting address of the point within a device (for


device points)
See the CIMPLICITY HMI for Windows NT and Windows 95
Device Communications Manual (GFK-1181) for details on the
addressing supported for your particular device and protocol.

Address Offset

Offset in memory from the first bit of the point Address


that marks the start of the point data (for device points).

Alarm High

High alarm value for the point

Alarm Low

Low alarm value for the point

Data Length

Data length associated with the data type chosen.

Data Type ID

Point type used for the point from one of the following
values:
0Boolean type point
1Integer type point
2APPL type point
3Text type point
4Unsigned 8-bit integer type point
5Unsigned 16-bit integer type point
6Unsigned 32-bit integer type point
7Signed 8-bit integer type point
8Signed 16-bit integer type point
9Signed 32-bit integer type point
10Floating point type point

Description

Brief information about the point.

Device ID

Source of the point data with one of the following values:


<device name>The name of the device that is
supplying the point data.
$GLOBALIndicates that the point is a Global derived
point.
$DERIVEDIndicates that the point is a Calculated
derived point.

GFK-1180H

Changing the Workbench Point Display

9-7

Display Format

Format used for the point in CimView.


Display Limits Options
If no limits are set for
an expression when there is horizontal/vertical movement,
rotation/fill or horizontal/vertical scaling in CimView and
a point is the single point used in the expression:
Display LimitsUpper and lower limits
Display Limits HighUpper limit
Display Limits LowLower limit

Elements

Number of elements that make up a point. A number


greater than one (1) means the point is an array point.

Has EU

Identifies whether or not Engineering Units (EU)


conversion is being done for the point Displaying either:
0No EU conversion
1Linear or custom conversion is enabled

Modified

Displays the date when the point was last modified

Need Update

Displays either:
1the point has been modified and the project needs a
configuration update.
0the project is up to date.

Point Class

Class selected for the point; displays one of the following:


0Analog class
1Digital class
3Text class
4Application class

Point Origin

Origin of the point, displays one of the following:


0Calculated derived point
1Device point
2Global derived point

Point Type

Type of point (e.g. UINT, INT)

Resource

Resource associated with the point

Warning High

High warning value for the point.

Warning Low

Low warning value for the point

Note: The Remove button will be disabled if the field is required. The Move Down or
Move Up button will be disabled if a field that will be affected by the move has to appear in
the furthest left position.

9-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using System Points

About System Points


CIMPLICITY HMI provides you with several system points that you can use any where in
your project including:

Event Manager

CimEdit

CimView

Point Control Panel

Each system point, which is Read Only, is automatically updated by CIMPLICITY HMI.
The default update time is every 60 seconds. To see the value of any one, all you have to do is
select it for display.
The points are:

$LOCAL.COMPUTER
Point Type

Local Point

Data Type

STRING (15)

Access

Read Only

Description

Local Computer Name

$LOCAL.WINUSER

GFK-1180H

Point Type

Local Point

Data Type

STRING (20)

Access

Read Only

Description

Windows user name

10-1

$PROJECT.COMPUTER
Point Type

Server Point

Data Type

STRING (15)

Access

Read Only

Description

Server Computer Name

$PROJECT
Point Type

Server Point

Data Type

STRING (20)

Access

Read Only

Description

Project name

$PROJECT.AVAILABLE
Point Type

Local Point

Data Type

BOOL

Access

Read Only

Description

Project availability (0-Not Available,1-Available)

$PROJECT.LOGGEDIN
Point Type

Local Point

Data Type

BOOL

Access

Read Write

Description

Login status
0: Logged out || !$PROJECT.AVAILABLE
1: Logged in && $PROJECT.AVAILABLE

$PROJECT.DEVICES

10-2

Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Number of devices online

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

$PROJECT.USERS
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Number of users

$PROJECT.DATETIME
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Server Date and Time in seconds from 1/1/1970

$PROJECT.DATE.YEAR
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current year (1970-2039)

$PROJECT.DATE.MONTH
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current month (1-12)

$PROJECT.DATE.DAY

GFK-1180H

Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current day in the month (1-31)

Using System Points

10-3

$PROJECT.DATE.WEEKDAY
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current day in the week (1-7)

$PROJECT.DATE.DAYOFYEAR
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current day in the year (1-366)

$PROJECT.DATE.WEEK
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current week in the year (1-52)

$PROJECT.DATE.HOUR
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current hour in the day (0-23)

$PROJECT.DATE.HOUR12

10-4

Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Current hour in the day (1-12)

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

$PROJECT.DATE.MINUTE
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Minutes past the hour (0-59)

$PROJECT.DATE.SECOND
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Second past the minute (0-59)

$PROJECT.DATE.SECOFDAY
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Second past midnight (0-86399)

$PROJECT.DATE.AMPM
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

0- AM, 1- PM

$LOCAL.DATETIME

GFK-1180H

Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Local Date and Time in seconds from 1/1/1970

Using System Points

10-5

$LOCAL.DATE.YEAR
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current year (1970-2039)

$LOCAL.DATE.MONTH
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current month (1-12)

$LOCAL.DATE.DAY
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current day in the month (1-31)

$LOCAL.DATE.WEEKDAY
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current day in the week (1-7)

$LOCAL.DATE.DAYOFYEAR

10-6

Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current day in the year (1-366)

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

$LOCAL.DATE.WEEK
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current week in the year (1-52)

$LOCAL.DATE.HOUR
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current hour in the day (0-23)

$LOCAL.DATE.HOUR12
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Current hour in the day (1-12)

$LOCAL.DATE.MINUTE
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Minutes past the hour (0-59)

$LOCAL.DATE.SECOND

GFK-1180H

Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Second past the minute (0-59)

Using System Points

10-7

$LOCAL.DATE.SECOFDAY
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Second past midnight (0-86399)

$LOCAL.DATE.AMPM
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

0- AM, 1- PM

$USER.ALARMS
Point Type

Local Point

Data Type

Integer

Access

Read Only

Description

Alarm count by user

$ALARM.TOTAL
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Alarm count

$ALARM.ACKED

10-8

Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Alarms acknowledged

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

$ALARM.UNACKED
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Alarms unacknowledged

$ALARM.ACTIVE
Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Active Alarm count

$CLASS_<Alarm class name>.ALARMS


Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Alarm count by class

$CLASS_<Alarm class name>.UNACKED

GFK-1180H

Point Type

Server Point

Data Type

Integer

Access

Read Only

Description

Unacknowledged alarm count by class

Using System Points

10-9

Point Cross Reference

About Point Cross Reference


The same point may be used in several different parts of your project, in several different
ways. Therefore, when you modify its properties, it is important to know how the modification
will affect instances where it occurs in the project.
The Point Cross Reference window in CIMPLICITY HMI provides you with a quick way to
find where and how a point is being used in your projects subsystems, including:

Database Logger

Event Manager

Point Configuration

Scripts

When you open the Point Cross Reference window for the first time you need to build a
PtXRef database for the points in the project you are running
When that is done, the three basic issues to address are how you:
1.

View a list of points using different view options.

2.

Focus on one point to:

3.

Review where it is located and how it is used

Make modifications

Maintain the PtXRef database.

If you need to work with a different CIMPLICITY HMI project from the one that is currently
open, you can easily open the other CIMPLICITY HMI project through the Point Cross
Reference window.

GFK-1180H

11-1

Opening the Point Cross Reference Window


The Point Cross Reference window has its own icon in the Workbench.
To open the Point Cross Reference window:
Method 1From the Workbench
1.

Expand the Points folder in the left pane of the Workbench.

2.

Double click the Point Cross Reference icon.

Method 2From the Windows NT and 95/98 Start menu


1.

Click Start on the Windows NT and 95/98 menu bar.

2.

Select CIMPLICITY.

3.

Select the Point Cross Reference icon.


An Open dialog box appears for you to select a CIMPLICITY HMI project.

4.

Select a CIMPLICITY HMI project.

The result of using either method depends on the status of the projects PtXref database.
If the PtXRef database has:

Been built and all of its subsystems are up-to-date, the Point Cross Reference
window opens, displaying the list of points in the PtXRef database.

Not been built, a blank Point Cross Reference window appears.

Been built but all of its subsystems are not up-to-date, an Update PtXRef Database
dialog box appears.

Build PtXref Database Dialog Box

Systems that need


to be updated

11-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To update the PtXRef Database before the PtXRef Point Explorer window
opens:
Simply press the Yes button.

Building a Points Cross Reference Database


When you open the Point Cross Reference window for the first time, it will be blank. In order
to display the points in your project and information about those points, you have to build a
database. The database includes any one or all of the available subsystems. You can choose
which subsystems will be included.
Blank Point Cross Reference Window

Open existing point Cross


Reference database

Build new Point Cross


Reference database

To build a Points Cross Reference database:


Method 1
1.

Press the Build button

on the Point Cross Reference tool bar.

Method 2
1.

Select PtXRef on the Point Cross Reference menu bar.

2.

Select Build.

Both Methods Continued


A list of subsystems (areas) in you project appears, when you use either method.
Selections in this list can be changed at any time.

GFK-1180H

1.

Select the subsystems to be included in the PtXRef database.

2.

Press OK.

Point Cross Reference

11-3

CIMPLICITY HMI builds a PtXRef database of all the points in your project that appear
in the subsystems you select.
Build PtXref Database Dialog Box

Selected substystems
selected

Scripts not selected

Viewing Points in the Point Cross Reference Window


The Point Cross Reference layout provides you with a clear way to view current information
about the points in your PtXRef database.
You view the list of points in the left pane.
When you select a point, you can view its location and associated information in text or tree
view in the right pane.

Point Cross Reference Window Panes Overview


You have the option to work with either two or three panes in the Point Cross Reference
window.

Three Views in the Point Cross Reference Window

List of points

Text only
Full view
Tree view

11-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The left pane displays a list of points in the project. You can view:

All points

Only used points

The right pane can display both a tree and text view or each alone. When you select a point in
the list of points and look at the:
Tree View

A tree displays:

Where the point appears in the areas included in the


PtXRef database

In what context the point is used

From this display you can open a configuration window


that is related to the instance you select
Text View

A full text description displays:

Where the point appears in the areas included in the


PtXRef database

In what context the point is used

Note: A list of points displays in the left pane for all views.

GFK-1180H

Point Cross Reference

11-5

Point Cross Reference List of Points


Information listed in left pane of the Point Cross Reference window includes the:

Point TypeWhether the point is valid or invalid.


An invalid point is still being used in the system. However, it has been deleted from
the point database that you view in the Point Configuration window. As a result, in
reality, it does not exist.

Number of times the point occurs in the PtXRef database

Point ID

Point Cross Reference Left Pane


Invalid
point type

Valid point
type

Title bar

Point ID

Point count

To re-sort the lists in the left pane of the Point Cross Reference window:
Click the title bar on top of the list that you want as the primary sort.
The list you select will be sorted in ascending order. Information on the other two lists will
stay with the associated items in the primary sort.

11-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

View Options Dialog Box


It is in the View Options dialog box that you specify your viewing preferences.
To open the View Options dialog box:
Method 1
Click the View Options button

on the Point Cross Reference toolbar.

Method 2
1.

Select View on the Point Cross Reference menu bar.

2.

Select Options.

In either case, the Views tab of the Options dialog box appears.
Views Tab in Options Dialog Box

Tree view enabled

Left pane sorted


by Point ID
Only used points
will display

Select how you want the Point Cross Reference window to display information.
The options are:
Sort on

When checked sorts by the checked option:


Point TypeWhether the point is valid (included in the
Points database) or invalid (appears in the system but is
not included in the Points database that appears in the
Point Configuration window).
Ref CountNumeric order based on how many times the
point appears in the PtXRef database
Point IDAlphabetical order

GFK-1180H

Show only used points

When checked, the left pane displays only the points that
are currently being used in your project

Enable Tree /Text View

CIMPLICITY HMI displays either or both views,


whatever is checked.

Point Cross Reference

11-7

Subsystems Options Dialog Box


You can easily change which subsystems should be included in the Point Cross Reference
display.
To change the subsystems that are included in the Point Cross Reference
display:
1.

Select View on the Point Cross Reference menu bar.

2.

Select Options. The Options dialog box appears.

3.

Select the Subsystems tab.

4.

Check the check box to the left of each subsystem you want to include.
Build PtXRef Database Dialog Box

Event Manager
selected
Scripts not selected

Screen Refresh
If more than one location can make changes to points, these changes may be made when you
are using the Point Cross Reference window. You can refresh the view periodically to keep it
up to date.
To refresh the view in the Point Cross Reference window:
1.

Select PtXRef on the Point Cross Reference menu bar.

2.

Select Refresh.

CIMPLICITY HMI scans the point table and displays the current information.

11-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Focusing on One Point


When you select a point in the left pane of the Point Cross Reference window you can:

View where it is located in the PtXRef database and look at the display in the right
pane to see how it is being used.

Make modifications to that point by selecting an item in the right pane

Point Review
Once you have selected which views (Tree and/or text) in which you want information
displayed in the Point Cross Reference dialog box, you can easily review that information by
simply selecting the appropriate Point ID.
Views Tab in Options Dialog Box

Selected point

GFK-1180H

Point Cross Reference

Tree view

Subsystem

Point use

Text view

11-9

Using Tree View to review information


In Tree view, you expand or collapse the tree the same as you do in Windows Explorer.
Information on the tree is listed by:

Subsystem (for examplePoint Configuration)

Use in the subsystem (For exampleDerived)

To review information about a point instance through tree view:


1.

Select the point in the left pane of the Point Cross Reference window.

Method 1
2.

Right click the object that represents the point instance you want to review in the
right pane of the Point Cross Reference window.

3.

Select Properties from the popup menu..


A properties window that applies to the point instance you selected displays.

Method 2
2.

Select View on the Point Cross Reference menu bar.

3.

Select Properties.

Method 3
Press Alt+Enter on the keyboard.

Note: If the object you select has no properties, that selection will not be available when you
click the right mouse button.
Using Text View to review information
In Text view, scroll through the list in the right pane of the Point Cross Reference window to
view the information. Depending on where the point is being used, you will see:

11-10

Points

Resource ID, Elements, Description

Scripts

What scripts are using the point

Event

What events are using the point

Screens

In what screens the point appears

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Point Modification
When you decide to modify a point or an instance where the point is being used, you can open
the appropriate window to do this.
To make modifications through the Point Cross Reference window:
1.

Select the point you want to modify in the left pane of the Point Cross Reference
window.

2.

Go to the tree view pane.

3.

Select the instance you want to modify.

4.

Select Open.

The related window that contains the information you want to modify opens, as follows:
Selected Instance

Related Window or Dialog Box that Opens

Events

Event Editor window

Events as Actions

Event Editor dialog box for that action

Events as Events

Event Editor dialog box for that event

Scripts

Program EditorBasic1 empty window

Specific Script

Program EditorBasic1 with the appropriate script

Points

Point - Configuration window

PointsDerived

Point - Configuration dialog box for that point

Specific Derived Point

Point Configuration dialog box for that point

Screens

CimEdit screen

Specific Screen
Database Logger

CimEdit screen for that point


Database Logger Configuration window

Maintaining a Current Point Cross Reference Database


In addition to letting you refresh your view while you are working in the Point Cross
Reference window, CIMPLICITY HMI provides you with two options that enable you to do
the following.

Add more subsystems to and build (augment) the PtXRef database

Rebuild the entire PtXRef database

To add more subsystems to and build the PtXRef database:


Method 1

GFK-1180H

1.

Press the Build button

2.

The Build PtXRef Database dialog box appears.

3.

Check the subsystems you want to include in the database.

Point Cross Reference

on the Point Cross Reference tool bar.

11-11

Method 2
1.

Select PtXRef on the Point Cross Reference menu bar.

2.

Select Build.

3.

The Build PtXRef Database dialog box appears.

4.

Check the subsystems you want to include in the database.

CIMPLICITY HMI adds and displays the selected subsystems when you use either method.
Build PtXref Database Dialog Box

Selected substystems
selected

Scripts not selected

To rebuild the PtXRef database:


1.

Select PtXRef on the Point Cross Reference menu bar.

2.

Select Rebuild All.

If the PtXRef database needs to be rebuilt, the following dialog box appears providing you
with the rebuild status.

11-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Opening a Different CIMPLICITY HMI Project


If you decide to use a different project from the one that is open, you can open it in the Point
Cross Reference window.
To open a different CIMPLICITY HMI project:
Method 1
1.

Press the Open button

on the Point Cross Reference toolbar.

An Open dialog box appears.


2.

Select the project you want to open.

3.

Build the PtXRef database, if it does not exist.

Method 2
1.

Select Project on the Point Cross Reference menu bar.

2.

Select Open.
An Open dialog box appears.

3.

Select the CIMPLICITY HMI project you want to open.

4.

Build the PtXRef database, if it does not exist.

Note: You can find and open a CIMPLICITY HMI project from the last databases you
opened listed on the Project drop menu.

GFK-1180H

Point Cross Reference

11-13

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 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 projects Workbench.
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-1180H

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

12-

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

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Enter the following information to define the new device:


Device

Enter the name of the new device in this field.

Port

Enter the name of the devices port in this field.


You can click the Browser button - to the right of the
Port input field to open the Select A Port Browser and use it
to select the port.
You can also use the Window Pop-up menu or the Pop-up
menu button - to create a new port, edit the current port,
or browse for another port.

Select OK to continue configuring the new device. The Device Properties dialog
box for the new device opens. You will need to enter information for the General
and device-specific properties.
When you are finished defining the device properties, select OK to close the Device
Properties dialog box and create the new device, or select Cancel to close the dialog
box without creating the new device.

GFK-1180H

Device Configuration

12-3

Device General Properties

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.
You can click the Browser button - to the right of this
input field to open the Select a Port Browser and use it to select
another port.
You can also use the Window Pop-up menu or the Pop-up
menu button - to create a new port, edit the current port, or
browse for another port.

Description

Enter up to 40 characters of explanatory text about the device.

Resource

Enter the name of the devices resource in this field.


Remember, only the users that are assigned this resource will be
able to see device alarms.
You can click the Browser button - to the right of this
input field to open the Select A Resource Browser and use it to
select the resource.
You can also use the Window Pop-up menu or the Pop-up
menu button to create a new resource, edit the current
resource, or browse for another resource.

Model Type

12-

Select the type of device from the drop-down list. The list of
model types depends on the protocol.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Device-Specific Properties
The device-specific properties depend on the type of device you are configuring. See
the CIMPLICITY HMI 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 devices 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.

GFK-1180H

Device Configuration

12-5

Resource Configuration

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 projects
Workbench.
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-1180H

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

13-2

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

CIMPLICITY HMI Base Users ManualMarch 1999

GFK-1180H

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


Resource

GFK-1180H

Resource Configuration

The list of users that can view alarm or point information for
this resource.

13-3

The users currently assigned this resource are displayed in the Users for this
Resource box. Users currently not assigned this resource are displayed in the
Available Users box. You can add users, delete users, view and modify user
properties, or create new users.
When you are through entering information, you can select OK to close the dialog
box and create the new resource, or you can select Cancel to close the dialog box
without creating the new resource.

Adding A User To A Resource


To add a user to the list that can view this resource:
1.

Select the user in the Available Users box.

2.

Select Add.

The new user appears in the Users for this Resource box.

Deleting A User From A Resource


To delete a user from the list that can view this resource:
1.

Select the user in the Users for this Resource box.

2.

Select Remove.

The user appears in the Available Users box.

Viewing User Properties


To view (and possible modify) the properties for a user:
1.

Select the user in either the Available Users or Users for this
Resource box.

2.

Select Properties.

The User Properties dialog box for the selected user opens. You can view and
modify the General and Resources properties for the selected user.

Adding A New User


To add a new user:

13-4

1.

Select New. The New User dialog box will open.

2.

Enter the new user name in the User ID field.

3.

Select OK. The User Properties dialog box for the new user will be
displayed.

4.

Enter the General and Resources properties for the new user.

CIMPLICITY HMI Base Users ManualMarch 1999

GFK-1180H

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 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 projects Workbench.
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.

GFK-1180H

14-1

If you have not selected the Display search criteria at startup option, the
Configuration - Port window opens with a list of all configured ports.

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:

14-2

Create a new port.

Change the window display attributes.

Change startup options.

Modify a port.

Delete a port.

Display a filtered list of ports

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Enter the following information to define the port:


Node

If Node is not grayed out, you will need to select the node name of
the computer where the port is located.
To select a node, click the drop-down list button the right of the input
field to display the list of available nodes, then click the name of the
node where the port is located.

Protocol

The protocols available to you will depend on the node you select,
and the device communication protocols available on that node.
To select a protocol, click the drop-down list button to the right of
the input field to display the list of available protocols, then click the
protocol you want to use.

Port

The ports available to you will depend on the node and protocol you
select.
To select a port, click the drop-down list button to the right of the
input field to display the list of available ports for the protocol, then
click the port you want to use.

Select OK to continue configuring the new port. The Port Properties dialog box for
the new port opens. You will need to enter information for the General and portspecific properties.
When you are finished defining the port properties, select OK to close the Port
Properties dialog box and create the new port, or select Cancel to close the dialog
box without creating the new port.

GFK-1180H

Port Configuration

14-3

Port General Properties

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.

14-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Changing A Ports 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
ports protocol is:

GFK-1180H

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.

Port Configuration

14-5

Alarm Class Configuration

About Alarm Classes


You can group Alarms with similar characteristics by Class. You can then assign an
order or priority to each Alarm Class. The order is a number from 0 to 99, where 0 is
the highest priority and 99 is the lowest priority.
If you assign the same order to more than one class, the classes are alphabetized
within the order. For example, if you assign order 0 to the HIGH, MEDIUM and
LOW classes, the alphabetized class order is HIGH, LOW, MEDIUM.
An alarms class determines the order in which it appears relative to other alarms in
Alarm Viewer. For example, all alarms with priority 0 will display first, followed
by alarms with priority 1, etc.

Configuring Alarm Classes


To configure alarm classes, double-click the Alarm Classes icon in your projects
Workbench.
If you have selected the Display search criteria at startup option, the Alarm
Class Search dialog box opens. Select the filtering criteria you want, and then select
OK to open the Configuration - Alarm Class window with the filtered list of alarm
classes.

GFK-1180H

15-1

If you have not selected the Display search criteria at startup option, the
Configuration - Alarm Class window opens with a list of all configured alarm
classes.

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.

15-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Alarm Class Configuration

15-3

Normal State
You can select the foreground (text) and background colors for displaying alarms in
this class in Alarm Viewer that are in the Normal state.
Default colors are White for the text and Black for the background.

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.

15-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Class Color Assignments


The default mappings for Alarm Colors are:
Number

GFK-1180H

Red

Green

Blue

Color

Black

255

Red

255

Lime

255

Blue

128

Maroon

128

Green

128

128

Purple

255

255

255

White

128

128

Teal

128

128

128

Gray

10

128

128

Olive

11

32

64

64

Dark

12

224

176

160

Rose

13

255

255

Fuchsia

14

255

255

Aqua

15

255

255

Alarm Class Configuration

Yellow

15-5

Mapping Alarm Class Colors in RGB.DAT


If you need to define an RGB.DAT file for one or more of the following reasons:

You want to change any of the default colors (0 through 95)

You want to add more colors to the default table (indexes 96 through
255 are available for this purpose)

You are importing screens from a CIMPLICITY System-I/U, -D/V, H/U or -RS/U system that do not used the default color mappings.

you need to be aware that indexes 0 through 15 in the RGB.DAT file are the default
colors used by Alarm Class configuration, Alarm State animation and Color Index
animation. If you change the colors in indexes 0 through 15 of the RGB.DAT file,
you need to change to colors displayed in the Alarm Class dialog box to match them.
To change the colors, create an AM_COLORS.CFG file in the same directory as
your RGB.DAT file. The first line in the file must contain only the |-* characters.
Each succeeding line contains an index number (0 through 15) followed by a vertical
bar ( | ) and the color name.
The following is an example of an AM_COLORS.CFG file (the colors listed in this
sample file match the default colors):
|-*
0|Black
1|Red
2|Lime
3|Blue
4|Maroon
5|Green
6|Purple
7|White
8|Teal
9|Gray
10|Olive
11|Dark
12|Rose
13|Fuchsia
14|Aqua
15|Yellow

Use the same RGB.DAT and AM_COLORS.CFG files for all projects. The file that
is used to display colors is the file for the project that Alarm Viewer or CimView
was started in, not the file for the project where the Alarm Classes or CimView
screens were configured.

15-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm String Configuration

About Alarm Strings


You use Alarm Strings to name alarm states. An alarm state is displayed in an Alarm
when %State is included in the alarm message. Alarm messages are configured in
the Point and Alarm definition functions.
For analog points, you can define up to four alarm values for a point. Each value
corresponds to an alarm state, and each state has a corresponding alarm string:

When the points value is greater than or equal to the Alarm High
value, it is in the Alarm High state, and the Alarm High Msg will be
displayed in the %State field.

When the points value is greater than or equal to the Warning High
value, and less than the Alarm High value, it is in the Warning High
state, and the Warning High Msg will be displayed in the %State
field.

When the points value is less than or equal to the Warning Low
value, and greater than the Alarm Low value, it is in the Warning Low
state, and the Warning Low Msg will be displayed in the %State
field.

When the points value is less than or equal to the Alarm Low value, it
is in the Alarm Low state, and the Alarm Low Msg will be displayed
in the %State field.

When the points value is less than the Warning High value and
greater than the Warning Low value it is in the Normal state, and
"NORMAL" will be displayed in the %State field.

For digital points, only one alarm state can be defined. That is, a digital point is in
alarm when it is either "1" or "0". Otherwise, the points value is in the Normal state.
Also, note the following:

GFK-1180H

If the alarm value is "1", the Alarm High Msg is displayed in the
%State field when the point is in alarm.

If the alarm value is "0", the Warning High Msg is displayed in the
%State field when the point is in alarm.

16-1

For example, the following alarm message has been configured for an analog point:
Temp Alarm - Temp: %STATE

The analog point references the following set of alarm strings:


Alarm High

Warning High

Warning Low

Alarm Low

VERY HOT

HOT

COLD

VERY COLD

and has values defined for the Alarm High, Warning High, Warning Low, and
Alarm Low alarm limits.
If the value of the analog point is above the Alarm High value, the text of the Alarm
message will be
Temp Alarm - Temp: VERY HOT

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.

Configuring Alarm Strings


To configure alarm strings, double-click the Alarm Strings icon in your projects
Workbench.
If you have selected the Display search criteria at startup option, the Alarm
String Search dialog box opens. Select the filtering criteria you want, and then select
OK to open the Configuration - Alarm String window with the filtered list of alarm
strings.
If you have not selected the Display search criteria at startup option, the
Configuration - Alarm String window opens with a list of all configured alarm
strings.

16-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Creating A New Alarm String Index


To create a new Alarm String Index, 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 String Index dialog box opens.

GFK-1180H

Alarm String Configuration

16-3

Enter information in the in this dialog box to create a new Alarm String Index.
Select OK to close the Alarm String Index dialog box and create a new Alarm String
Index.
Select Cancel to close the Alarm String Index dialog box without creating a new
Alarm String Index.

Alarm String Index


This field initially contains the next available Alarm String Index. You can use that
index or enter a new, unique index number for the new set of Alarm Strings.
The number must be from 1 to 99 and cannot conflict with an existing Alarm String
Index.

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.

16-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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
points, use the Configure Points
function.

Use Configure Alarm Definitions to configure alarm definitions for alarms generated
by custom software or to modify alarms for CIMPLICITY HMI system events or
product options.

Alarm Message Variable Run-time Parameters


Variable run-time parameters determine the display of field data. Possible
parameters that you can include in an alarm message are:
Parameter

Description

%ID

Displays the Point ID.

%VAL

Displays the point value (converted to engineering units if


applicable).

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

The contents of each variable message field are determined when the alarm is
generated.
Note
You may see alarms in the list whose messages include variables such as %d, %s, or
%o. These alarms are system alarms whose messages may not be modified.

GFK-1180H

17-1

Standard Alarms
A set of standard event alarms is included in your base configuration. These alarms
are not associated with any CIMPLICITY Point IDs. They may be modified, but
they should never be deleted. They 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.

17-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

$LOGIN_FAILURE
Specified user failed to log in to the specified CIMPLICITY project.
$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.

GFK-1180H

Alarm Configuration

17-3

Setting Run-Time Alarm Properties


You can use the Alarm Properties dialog box to change the run-time properties for
alarms in your project.
To access the run-time alarm properties, you can do one of the following:

Click the Alarm icon in your projects Workbench, hold down the right
mouse key and select Setup from the drop-down menu.

Select Setup from the Edit menu in the Configuration - Alarm


window.

The Alarm Properties dialog box opens.

The Store alarm comments option lets you enable or disable the saving of alarm
comments beyond the actual life of the alarm. If you want to save alarm comments
beyond the actual life of alarms, select the Store alarm comments check box. If
you do not want to save alarm comments, clear the check box.
Click OK to close the dialog box and save your changes, or click Cancel to close
the dialog box without implementing any changes.

More About Alarm Comments


At run-time, users can record comments for an alarm while the alarm is being
displayed in the Alarm Viewer. Normally, these comments are deleted when the
alarm is deleted. The Store alarm comments option lets you save the 20 most
recent alarm comments in a disk file in the projects alarm_help directory.
After you clear the Store alarm comments check box, users can only view the
comments entered while the alarm exists. Any comments that exist in the alarms
comment file in the alarm_help directory are not viewable.
Please note the following:

17-4

Each comment can contain up to 720 characters.

Up to 20 comments are stored in an alarm comment file. When the 21st


comment is placed in the file, the first (oldest) comment is removed.

If you intend to use the Store alarm comments option, make sure
that the alarm_help directory is writable.

If you want a comment to be associated permanently with an alarm, put


it in the alarms help file.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring Alarms
To configure an alarm, double-click the Alarms icon in your projects Workbench.
If you have selected the Display search criteria at startup option, the Alarm
Definitions Search dialog box opens. Select the filtering criteria you want, and then
select OK to open the Configuration - Alarm Definitions window with the filtered
list of alarms.
If you have not selected the Display search criteria at startup option, the
Configuration - Alarm Definitions window opens with a list of all configured alarms.

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

GFK-1180H

Alarm Configuration

17-5

The 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

Creating A New Alarm Definition


To create a new alarm definition, 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 Alarm dialog box opens.

Enter the name of the new alarm in the Alarm ID field and click 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:

17-6

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Definition Properties for Non-Point Alarms

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. Alarms with similar characteristics can be
grouped by class and classes can be prioritized. When a user sorts alarms by Class in
the Alarm Viewer, the alarms class determines the order in which this alarm appears
relative to other alarms.

You can click the Browser button - to the right of the input field to
use the Select an Alarm Class Browser to select the Class ID.

You can click the Pop-up menu button - to browse for an Alarm
Class, edit an existing Alarm Class or create a new Alarm Class for the
alarm.

Alarm Type
Select a valid alarm type from the drop-down list. The alarm type you select
determines the alarm message format.
For detailed information on Alarm Types, see the CIMPLICITY HMI Integrators
Toolkit Operation Manual (GFK-1461).

GFK-1180H

Alarm Configuration

17-7

Help Files
Enter the name of an optional Help file that users can display in the Alarm Viewer
by clicking Help. You can enter a file name of up to eight (8) characters. If you
wish, you may use the same Help File for several alarms.
The Help file is a text file you create with a text editor (for example, Notepad). The
file can contain up to sixty (60) lines of ASCII text. Each line can have a maximum
of 70 characters. The Help file must be in the projects alarm_help directory.

Alarm Message
Enter the text of the alarm message in this field. An alarm message consists of any
combination of fixed text, and variable run-time parameters (see page 17-1). The
total display length for all fixed text and variable parameters is 80 characters.

Logging
If Database Logging is installed on your computer, you can select the Log Alarm
check box to enable logging for this alarm. If you enable logging, you can then click
Settings... to define the logging parameters for the alarm. Clear the Log Alarm
check box to disable logging for this alarm.

17-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Definition Properties for Point Alarms

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 points value goes into an alarm state.
Alarm Class

An alarms class determines the order in which it appears


relative to other alarms in Alarm Viewer. You can group
alarms with similar characteristics by class. You can also
prioritize classes so that all the alarms in the highest priority
class appear first in a users Alarm Viewer.
Enter an Alarm Class in this field. You can also:
Click the Browser button - to the right of the input
box to use the 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.
An alarm message consists of any combination of fixed text,
and variable run-time parameters (see page 17-1). The total
display length for all fixed text and variable parameters is 78
characters.

GFK-1180H

Alarm Configuration

17-9

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 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.
Use the string index to display the text for an alarm state in an
alarm 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 is 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

17-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Criteria
You can select one of the following methods for evaluating the alarm values:
See Types of Alarming in Chapter 5, "Point Configuration", for details on Alarm
Criteria.
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.

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:
Click the Browser button - to the right of the input
box to use the Select Port Browser to display a list of
Point IDs and select one.
Click the Pop-up menu button - to create a new Point
ID, modify the current Point ID, or browse for a Point ID.

Alarm Values
Enter the values you want for alarm limits in these fields. The evaluation of alarm
limits depends on the Alarm Criteria you select.

GFK-1180H

For Absolute alarming, you can define an upper and lower alarm limit
and an upper and lower warning limit for the point value.

For Rate of Change alarming the high values are used to detect faster
than expected changes, and the low limits are used to detect slower than
expected changes. Specify positive alarm limits to check for increasing
values and negative alarm limits to check for decreasing values.

For Deviation alarming, you can define an upper and lower alarm limit
and an upper and lower warning limit for the difference between the
value of this point and the Deviation point.

For digital points, you can choose to alarm when the point value is 0 or 1.

Alarm Configuration

17-11

Alarm Delay
The Alarm Delay feature is only available when you select Absolute alarming. If
you set the Delay Alarms check box, the Interval fields represent the length of the
delay before the alarm is reported. This means an alarm will not be generated unless
the point remains in an alarm state for the configured interval.

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 points alarm
state changes each time the point value goes from 99 to 100 or 100 to 99. If a
deadband of 5 is defined, the point will go into the alarm state when its value reaches
100, and will stay in the alarm state until the value drops below 95.

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 projects 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. You can use Notepad to create an Alarm Help file.
If you wish, you may use the same Help File for several points.

Alarm Routing Properties

17-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Click Add.

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.

Click Remove.

Modifying A Role
To view (and possibly modify) the properties for a particular role:
1.

Select the role.

2.

Click Properties. The Role Properties dialog box for the selected
role opens.

Adding A New Role


To add a new role:

GFK-1180H

1.

Click New. The New Role dialog box opens.

2.

Enter the new Role ID in the Role ID field.

3.

Click OK. The Role Properties dialog box for the selected role opens.

4.

Select the privileges you want for the new role.

5.

Click OK to create the new role and close the Role Properties dialog
box.

Alarm Configuration

17-13

Alarm Options Properties

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.

Select the Manual Reset Allowed check box if you want to let users
manually reset the alarm. The alarm can also be reset by the
application that detected the alarm condition and by the Alarm Manager
when an Automatic Reset is defined.
If you clear the Manual Reset Allowed check box, the alarm can
only be reset by the application detecting the alarm condition or by the
Alarm Manager when an Automatic Reset is defined.

17-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Select this check box to delete the alarm when it is


acknowledged.

Reset

Select this check box to delete the alarm when it is reset.

If you select both check boxes, the alarm will not be deleted until it has been
acknowledged and reset.

GFK-1180H

Alarm Configuration

17-15

Acknowledge Timeout
Use these fields to control how the alarm will be acknowledged.
Time

Select this radio button and enter the number of minutes in the
Minutes input field for the Alarm Manager to wait before
automatically acknowledging the alarm.
The user may acknowledge the alarm before the time period
expires.
Note

The actual number of minutes that the Alarm Manager will wait before automatically
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.
Immediate

Select this radio button if you want the Alarm Manager to


automatically acknowledge the alarm when it is generated.

Never

Select this radio button if the alarm is never to be


automatically acknowledged.

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.

17-16

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using Alarm Audio Support

About Alarm Audio Support


You can configure an alarm class to use audio alarming whenever an alarm in that
class is generated. You can use a wave (.WAV) file or a beep. The sound is played
until the Alarm Stop condition is met for all the alarms from the configured class.
To generate an audio alarm from a wave file, your computer needs:

A sound card to generate the sound

A sound system, such as a speaker or headset, to make the sound


audible

To generate an audio alarm with the beep, your computer needs the system beep (you
can also generate a beep from a sound card, but it is not required). If you do have a
sound card, you can configure the frequency, duration and number of beeps. If you
do not have a sound card:

For Windows NT, you can configure the frequency, duration and
number of beeps.

For Windows 98/95, you can configure the number of beeps.

Audio alarms are prioritized by two keys, alarm class priority and project priority.
You can select one of these keys to be the primary key for prioritization.

About Prioritizing Alarms


The Alarm Sound Manager can only play one sound at a time. You can configure the
Alarm Sound Manager to prioritize alarms by Alarm Class or Project priority. You
determine Alarm Class priorities when you configure Alarm Classes. You determine
Project priorities when you connect to projects in the Alarm Sound Manager
window.
When you prioritize alarms by Alarm Class, the determination of the highest priority
alarm is:

GFK-1180H

The sound for first alarm for the highest priority Alarm Class is played
first.

If alarms exist for the same Alarm Class in more than one project, then
the highest priority alarm for the highest priority project is played first.

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

PROJ1

ALM1A

ALM1B

PROJ2

ALM2A

ALM2B

PROJ3

ALM3A

ALM3B

Alarm Class

Priority

Alarm Class

Priority

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

18-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 projects Workbench.

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:

GFK-1180H

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.

Using Alarm Audio Support

18-3

Wave File Configuration


To configure a wave file for audio alarming:
1.

Click the Wave file radio button to use a wave (.WAV) file when the
alarm sounds.

2.

Enter the name of the save file in the File name field. You can use the
browser button to browse for a wave file for this field.

You can specify logical names in the file name, such as SITE_ROOT and BSM_ROOT
in the path name for the wave file. These are expanded into actual directory names
when the file is used. For example, SITE_ROOT:\sounds\high.wav refers to
the file high.wav in the sounds directory within the HMI projects directory.
You can also use a special variable called WIN_DIR, which expands to the Windows
NT/98/95 directory.

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 98/95:

Remember, 1000 milliseconds equals 1


second.

Enter the Frequency of the sound. Select a value between 37 and


32767 Hertz.

Enter the Duration of the sound in milliseconds. Select a value


between 1 and 10000 milliseconds.

For both Windows NT and Windows 98/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.

18-4

Use the Delay field to enter the delay between the beeps in
milliseconds. Select a value between 0 and 10000 milliseconds.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Using the Alarm Sound Manager


When the Alarm Sound Manager is running, you can see its icon on the Windows
Taskbar.

You can click on the icon to open the Alarm Sound Manager window.

The Alarm Sound Manager window displays the current alarm.

GFK-1180H

Using Alarm Audio Support

18-5

The items on the lower part of the Alarm Sound Manager window are available at all
times.

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.

Turning Sound On and Off


You can set the Mute check box to temporarily shut off sound play. When you shut
off sound play, the Windows Taskbar icon for the Alarm Sound Manager changes to
this:

Saving the Current Configuration


After you have configured the Alarm Sound Manager window properties to your
liking, you can save your configuration, and then recall it whenever you open this
window.
To save all the changes you have made in the current Alarm Sound Manager session,
select Save profile....
To retrieve a previously saved profile and display it in the current Alarm Sound
Manager session, select Load Profile.

Using the Window Buttons


To minimize the window, select Minimize.
To exit the Alarm Sound Manager, select Exit. Remember that if you do this, audio
alarming stops and the icon for the Alarm Sound Manager no longer appears on the
Windows Taskbar.
To display the Help window for Alarm Sound Management, select Help.

18-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Using Alarm Audio Support

18-7

Examples:
For example, if you connect to PROJ1 with priority 3, PROJ2 with priority 2, and
PROJ3 with priority 1, then the list of projects looks like this:
PROJ3
PROJ2
PROJ1
If you connect to PROJ1 with priority 3, PROJ2 with priority 1 and PROJ3 with
priority 1, then the list of projects looks like this:
PROJ2
PROJ3
PROJ1
This project ordering is used by the Alarm Sound Manager to help determine which
sound plays first at run-time.

Deleting a project
To delete a project, select it and click on the Delete button.

18-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Option Properties

The Options page lets you:

Select which priority to check first when concurrent alarms are


received. You can select Alarm Class or Project.

Specify the alarm sound/beep stop condition. You can select one of the
following:

Acknowledge only - the alarm sound/beep stops when the alarm


is acknowledged.

Reset only - the alarm sound/beep stops when the alarm is reset.

Both Ack and Reset - the alarm sound/beep stops when the
alarm is acknowledged and reset.

Either Ack or Reset - the alarm sound/beep stops when the


alarm is acknowledged or reset.

Configure the Project default priority to be used when adding new


projects to the current session. This value must be greater or equal to 0
(zero).
The higher the number, the lower the priority (this means that 0 is the
highest priority).

Specify whether you want the alarm sound/beep to be repeated.


If you set the Repeat sound/beep checkbox, the sound/beep is
repeated every ten (10) seconds until the stop sound/beep condition is
satisfied.
If you clear the Repeat sound/beep check box, each alarm
sound/beep is played only once.

GFK-1180H

Using Alarm Audio Support

18-9

While you are displaying this property page, you still have access to the alarm
information at the bottom of the window.

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.

18-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Blocking Configuration

About Alarm Blocking


Monitoring and control systems do an excellent job of informing operators of
problem conditions through alarms. However, there are times when operators can be
overwhelmed by numerous alarms that are the result of one major problem. For
example, when a process conveyor stops, it affects all machines feeding into it. The
operator needs to know that the major problem is the stopped conveyor and not waste
valuable time looking through all the other resulting alarms. Alarm Blocking lets you
configure a hierarchy of alarms for your process so users see the important alarms
first.
Alarm Blocking lets you:

Logically group alarms into blocking groups.

Select a run-time blocking mode for each blocking group.

Assign a priority level to each alarm in a blocking group.

Each Alarm Blocking group works independently. This means that the high priority
alarms in one group do not block the high priority alarms in another group.
Before you implement Alarm Blocking, you need to plan how you want to group and
prioritize your alarms for your project. You need to decide:

The number of blocking groups you need.

Which alarms are to be assigned to each blocking group.

How the alarms are to be prioritized in each blocking group.

How to handle the display of equal priority alarms in each blocking


group.

Alarms that you do not assign to Alarm Blocking groups are not affected by Alarm
Blocking.

GFK-1180H

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

Choosing Blocking Modes


You can select one of two blocking modes for each Alarm Blocking group that you
create.

If you select Peer Blocking mode, only the first alarm in a set of alarms
with equal priority displays.

If you select Non-Peer Blocking mode, all alarms in a set of alarms with
equal priority display.

Assigning Alarm Priorities


You need to assign each alarm in an Alarm Blocking group a number from 0 to
32767. The higher the number you enter, the higher the priority of the alarm. For
example, alarm XXX with priority 100 blocks alarm YYY with priority 10. You can
assign the same priority number to more than one alarm in an Alarm Blocking group.
The priority of an alarm and the blocking mode of the group determine whether the
alarm is blocked or not.

19-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Alarm Blocking Configuration

19-3

Configuring Alarm Blocking


To configure alarm blocking, double-click the Alarm Blocking icon in your projects
Configuration Cabinet.
If you have selected the Display search criteria at startup option, the Alarm
Block Group Search dialog box opens. Select the filtering criteria you want, and
then select OK to open the Alarm Blocking Group - Configuration window with the
filtered list of alarm groups.
If you have not selected the Display search criteria at startup option, the Alarm
Blocking Group - Configuration window opens with a list of all configured alarm
groups.

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:

19-4

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

GFK-1180H

Alarm Blocking Configuration

19-5

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.
You can change an alarm on the list by directly editing
its Alarm ID, Priority or Resource ID or by selecting
the Alarm ID and pressing Set attributes.
To delete an alarm from the list, select it and press
Delete.

Select OK to close the Alarm Blocking dialog box and create the new Alarm block
group. Select Cancel to close the Alarm Blocking dialog box without creating a new
Alarm block group.

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.

19-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Modifying an Alarm
You can modify an alarms 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.

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. Nonpoint alarms will be assigned the new Resource ID.

Modifying an Alarm Block Group


To modify an Alarm block group, you can double-click the Alarm block group you
want to modify. Alternatively, you can select the Alarm block group you want to
modify, 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 Alarm Blocking dialog box opens. The fields
contain the groups current configuration information. You can:

Modify the group description.

Change the Peer block status.

Add alarms to the list.

Remove alarms from the list.

Change alarm names, priorities and Resource IDs on the list.

Select OK to close the Alarm Blocking dialog box and modify the information for the
selected Alarm group.
Select Cancel to close the Alarm Blocking dialog box without modifying the Alarm
group.

GFK-1180H

Alarm Blocking Configuration

19-7

Alarm Printer Configuration

About Alarm Printer Configuration


You can configure a serial or parallel printer in CIMPLICITY HMI software that
prints alarms and/or events as they occur. You may also configure an alarm printer
to write to a file, rather than to a device. You may configure a local or network
printer as the alarm printer. If your project includes the Host Redundancy option,
you may configure a redundant alarm printer.
Important
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 projects
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-1180H

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

Page Width

The page width in characters.

Page Length

The page length in lines.

The list of alarm printers is initially sorted by Name. 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 printer.

Change the window display attributes.

Change startup options.

Modify an alarm printer.

Delete an alarm printer.

Display a filtered list of alarm printers

Adding an Alarm Printer


To add a new alarm printer, you can do one of the following:

Select New from the File menu.

Select New Item on the Toolbar.

Press Ctrl+N.

After you initiate the request, the New Alarm Log Printer dialog box opens.

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.

20-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Alarm Printer Configuration

20-3

Alarm Logging Options


These options are available only when you select the Log alarms check box.
Use these fields to specify the types of alarms, and alarms classes that will be printed
on this alarm printer:
Generated alarms
Set this check box to log messages when alarms are generated.
Acknowledged alarms
Set this check box to log messages when alarms are acknowledged.
Reset alarms
Set this check box to log messages when alarms are reset.
Deleted alarms
Set this check box to log messages when alarms are deleted.
All alarm classes
Set this check box to log messages for all alarm classes. When you do, the
Alarm Class input field will be grayed out.
Alarm Class
This field is available when you clear the All alarm classes check box.
If you want log alarms for a particular Alarm Class, enter that class name in this
field. You can also:

20-4

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Output
Enter the device name for the alarm printer. You can:

Enter the name of a local port on the projects 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 projects \log directory.

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.

Enter the path for a file on a network disk (for example,


\\nt001\proj1\alarms).

You can associate more than one alarm printer with a network printer or file on a
network disk. If you use a network printer or file, you should clear the Print
header field in the Layout property page.

GFK-1180H

Alarm Printer Configuration

20-5

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.

20-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Page Length
Enter the number of lines per page that can be printed. The number must be an
integer between 1 and 999.

Page Width
Enter the number of characters that can be printed on a line. The number must be an
integer between 80 and 132.

Redundant Alarm Printing


This field is enabled if your project has the Host Redundancy option.
Set this check box if you want both the Master and Slave computers to print alarms.
Clear this check box if you only want the Master computer to print alarms

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.

GFK-1180H

Alarm Printer Configuration

20-7

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.

Constructing Date and Time Formats


To construct date formats, use the following information:
m

Numeric month with no leading zero.

mm

Numeric month with leading zero.

mmm

Short text month.

mmmm

Long Text month.

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.

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.
To construct time formats, use 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.

Minutes with no leading zero.

MM

Minutes with leading zero.

Seconds with no leading zero.

SS

Seconds with leading zero.

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

20-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

More about Redundant Alarm Printers


In a redundant configuration, both the Master and Slave computer have the same
configuration. When you perform a Configuration Update, the configuration data for
the project on the Master computer is copied to the project on the Slave computer.
The information you enter in the Redundant alarm printing and Output fields
determine where alarms will be printed.
First lets take a redundant configuration where each computer has a local line printer
(LPT1) configured. The primary computer is COMP1 and the secondary computer is
COMP2.

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, lets look at a redundant configuration with a network line printer


(\\ABC\NET1). The primary computer is COMP1 and the secondary computer is
COMP2.

If you enter \\ABC\NET1 in the Output field and select the


Redundant alarm printing check box, the Master project on
COMP1 sends alarm messages to \\ABC\NET1 and the Slave project on
COMP2 sends alarm messages that it generates while in standby mode
to \\ABC\NET1. This may result in duplicate messages.
If you select this option, disable the Print header field.

GFK-1180H

Alarm Printer Configuration

20-9

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.

Additional Steps for Serial Printers


If you are configuring a serial printer, its printer baud rate, parity, and data length
will have to be set each time your system is rebooted. You can do this by creating a
file called cimp_port.bat in the top-level directory on the disk where your
project is located. The file will be called by the Alarm Printer program when it
initiates printing on the printer. The file contains:
@echo off
mode <port> baud=<rate> parity=<set> data=<n> stop=<m>

where
<port>

is the serial port to which the printer is connected.

<rate>

is the baud rate of the printer.

<set>

is the parity used by the printer.

<n>

is the number of data bits.

<m>

is the number of stop bits.

For example, if you have a printer on COM1: port that communicates at 9600 baud,
no parity, 8 data bits and 1 stop bit, the file would look like this:
@echo off
mode COM1: baud=9600 parity=n data=8 stop=1

If you have more than one serial printer, you will need one mode line per printer.
To create this file:

20-10

1.

Open a Notepad window.

2.

Enter the printer configuration information according to the above


template.

3.

Save the file called cimp_port.bat in the top-level directory on the


disk where your project is located.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Additional Steps for Network Printers


When you print directly to a network printer the Alarm Page functionality does not
print alarm messages as they happen, by default. Instead, it waits until there is a full
page of alarms to send to the printer. :
If you want to print the current set of unprinted alarms:
1.

Select Tools on the Workbench menu bar.

2.

Click Command Prompt.


A DOS window opens in the CIMPLICITY HMI project directory.

3.

Type amlp_flush.exe.
The alarms will be printed.

You can also initiate amlp_flush.exe from scripts within the CIMPLICITY HMI
environment. This will trigger printing whenever the specified conditions (for
example an alarm going off) are met.

Modifying the Size of the Alarm Queue


The Alarm Line Printer program (AMLP) assumes that there is no restriction for the
size of the alarm message queue. If the output device is disabled, a virtual memory
overflow can result.
You can use the AMLP_MAX_QUEUE global parameter to restrict the size of the
alarm message queue.
For detailed information on editing the global parameter file, see "Global
Parameters" under System Management.
The record format for AMLP_MAX_QUEUE is:
AMLP_MAX_QUEUE|3|<number>

where <number> is the maximum number of messages in the queue.


After you implement this global parameter, if the output device is disabled and the
number of alarms in the alarm queue exceeds the value you specify, the alarm
message:
The alarm dropped has exceeded the configured size of alarm
queue

is generated.
To return to the default queue size, remove the AMLP_MAX_QUEUE record from
the Global Parameters file.

GFK-1180H

Alarm Printer Configuration

20-11

Choosing Delete and Acknowledge Times


The Alarm Line Printer program (AMLP) assumes that the time to be printed when
an alarm is acknowledged or deleted is the time the alarm was generated.
You can use the AMLP_USE_GEN_TIME global parameter to select whether you
want the generation time or the action (acknowledge or delete) time to be printed.
The record format for AMLP_USE_GEN_TIME is
AMLP_USE_GEN_TIME|1|<option>

where <option> is:


Y if you want the generation time printed when the alarm is acknowledged or
deleted.
N if you want the time of the action (acknowledge or delete) to be printed.
To return to the default time printing, remove the AMLP_USE_GEN_TIME record
from the Global Parameters file.

20-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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:

GFK-1180H

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.

21-1

Configuring Roles
To configure a role, double-click the Roles icon in your projects Workbench.
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:

21-2

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

CIMPLICITY HMI Users ManualMarch1999

GFK-1180H

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 roles 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. Check the
check box for each privilege you want to assign to a role.

GFK-1180H

Role Configuration

21-3

Role

Users Assigned This Role Can:

General Privileges
Dynamic Configuration

Enable Dynamic Configuration from functions in the


Workbench.

Process Control

Use the CPC (CIMPLICITY Program Control)


utility to start and stop CIMPLICITY HMI
processes.

Event Manager Privileges


Trigger Event

Trigger events in the Event Manager from the


Basic Control Engine user interface.

Script Control

Stop, pause, or resume scripts in the Event Manager


from the Basic Control Engine user interface.

Alarms Privileges
Delete Alarms

Delete alarms from the Alarm Viewer.

Modify Alarm Setups

Modify alarm setups in Alarm Viewer.

Points Privileges
Set Point

Perform setpoints from CimView screens that


contain Setpoint actions.

Setpoint Audit Trail

Have a $DOWNLOAD event recorded in the Event


Log for each setpoint that is generated.

Point by Address

Create points and expressions in CimEdit that use


Point by Address points.

Modify Manual Mode

Place a point in manual mode when the


MANUAL_MODE point quality attribute is
configured on a CimView screen. See the
"Monitoring Point Attributes" chapter in the
"CIMPLICITY HMI CimEdit Manual" GFK-1396
for more information about MANUAL_MODE.

More on the Setpoint Audit Trail


When you enable the Setpoint Audit Trail, the information sent to your Event Log
can provide a detailed audit trail of which users set which setpoints. However, the
audit trail imposes significant overhead (20 times slower) since a record is logged in
the database for each setpoint. This is particularly noticeable when a user performs
setpoints in a loop in the Program Editor.
If you do not require an audit trail for setpoints, it is recommended that you disable
the Setpoint Audit Trail option (this is the default).

21-4

CIMPLICITY HMI Users ManualMarch1999

GFK-1180H

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
Privileges

A user is assigned a role. Each role in your CIMPLICITY HMI


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
Resources

A users view determines the resource data to which the user has
access. Alarms for resources outside a users view will not appear
on the users 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 projects Workbench.
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-1180H

22-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 users 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:

22-2

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

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 projects Workbench, 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.

To disable automatic account disabling, select No account disable.


To enable automatic account disabling,
1.

Select Account Disable.

2.

Enter the number of failed login attempts before disabling the account.

Select OK to close the dialog box and save your changes, or select Cancel to close
the dialog box without implementing any changes.

What Happens at Run-Time


If Account Disable is selected and the user fails to login after the specified number
of failures, the account is automatically disabled and a $LOGIN_FAILURES event is
generated.
To re-enable the account, the system administrator needs to dynamically re-enable
the user account. To do this:

GFK-1180H

1.

Open the User Configuration application.

2.

Select Dynamic mode.

3.

Re-enable the user account.

User Configuration

22-3

Creating a New User


To create a new user, 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 User 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 users 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.

22-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

User General Properties

The General properties let you define the following for a new user.
Note
If you change a users configuration dynamically, the user must log out then log back
in for the changes to take effect.

Role
Enter the users 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 role, or Browser for another role.

- to create a new role, edit the current

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.

GFK-1180H

User Configuration

22-5

Password and Confirm Password


This input box and the Confirm Password input box can only be accessed when
the Password Needed check box is set.
Enter the users password in this input box, and then re-enter it in the Confirm
Password input box. Asterisks are displayed in place of the characters you type.
If, at some future date, you clear the Password Needed check box, the
Password input box will retain the original password, but the user does not need to
enter it when logging in.
At run-time, the following rules also apply to user passwords:

A user is prompted to change the password when the current password


expires.

A user can change the password from the CIMPLICITY Login Panel.

A user can use the ChangePassword command in the Basic Control


Engine to change the password in CimView.

In a Server Redundancy configuration, a user can only change the


password when the Primary computer is running.

User Name
Enter the users 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 users 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.

22-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 users resources dynamically, the user must log out then log back in
to access the changed resources.

Adding A Single Resource


To add a resource to the users list:
1.

Enter a valid Resource ID in the input box. You can click the Browser
button - to the right of the input field to use the Select A Resource
Browser and use it to select the Resource ID. You can also use the
Pop-up Menu button - to create a new Resource ID, edit the
current Resource ID, or browse for another Resource ID.

2.

Select Add.

The new resource will appear in the Resources box.

Adding All Resources


To add all the currently configured resources to the users list, select Add All. All
the resources appear in the Resources box.

GFK-1180H

User Configuration

22-7

Deleting A Resource
To delete a resource from the users list:
1.

Select the resource in the Resources box.

2.

Select Delete.

The resource is removed from the Resources box.


You can also use the Shift and Ctrl keys in combination with the mouse to select
more than one resource for deletion.

22-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Database Logger

About the Database Logger


The Database Logger option lets you log alarms, events, and point values to a
database, then retrieve the information for reports via a wide variety of ODBCcompliant applications. (ODBC stands for Open Data Base Connectivity.)
You dont need to know about SQL or database internals to configure logging tables.
Simply select the items you want to log and conditions under which you want to log
them. You can log individual points in detail, or you can group points together for
trend analysis. In addition, you can define multiple tables with different logging
conditions and attributes to meet different needs within your facility.
The Database Logger option uses the standard ODBC interface to log your
production data. This interface supports both the Microsoft Access and Microsoft
SQL Server databases.
You can enter the Database Logger configuration transactions from Point
Configuration or from the Database Logging icon in the CIMPLICITY Workbench.

Types of Log Files Available


CIMPLICITY software organizes logging into the following categories:

GFK-1180H

Alarm Logging

Event Logging

Data Logging

Group Logging

Application Logging

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

23-2

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

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

$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 points 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.

GFK-1180H

Database Logger

23-3

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

23-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Microsoft Access Note


To successfully create or repair tables, the Database Logger requires an exclusive
lock on the Access database. If another application is using the Access database, the
Database Logger cannot exclusively lock the database, and it will terminate. If this
happens, the following message will be logged in the Status Log for the project:
Unable to repair database
This problem occurs, for example, if a user is running reports on the Access database
while a project is being started.

Using Wildcards in Search Strings


You can use the following wildcards in the Database Logger user interface:
*

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 tables that start with "M" and end with "X", enter
M*X in the Table Identifier 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
tables whose first character is "M" and third character is "X",
enter M?X in the Table Identifier 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.
If a Browser button is available to the right of an input field, you can click it and use
the Browser to select the filter.
If you are calling ODBC functions directly, you cannot use the * and ? wildcards.
The underscore ( _ ) character is the only available wildcard. Use it to search for any
character in this place in a string.
If you are calling SQL functions directly, you can use the * and ? wildcards.

GFK-1180H

Database Logger

23-5

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.

The number of columns you can actually have in a group table depends on the type
of data you are storing. A record being added to the database can have at most 2 KB
of data. With overhead, 2 KB amounts to approximately 222 8-byte floating-point
numbers. (Points with Engineering Units conversion are stored in floating point
format.)
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.

23-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Database Logger

23-7

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

23-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Adding the Point to a Logging Table


To add the point to another logging table:
1.

Select Add....

2.

The Table Browser dialog box opens. Select the table or tables where
you want to add the point, then select OK to return to the Point
Logging dialog box.

3.

When you return to the Point Logging dialog box, the table(s) that you
selected are added to the list. You must confirm the additions in order
to have them take effect. Select Cancel to cancel the additions, or
select OK to confirm them.

Modifying the Logging Properties for the Point


To change the logging properties for the point in a particular table:
1.

Select the table.

2.

Select Modify....

3.

The Table Properties dialog box for the point opens. Make your
modifications, and then select OK to return to the Point Logging dialog
box.

4.

When you return to the Point Logging dialog box, the modifications
you have made to the point have already taken place. Note that the
Cancel button has changed to a Close button to indicate that you
cannot undo the modifications.

Removing the Point from One or More Logging Tables


To remove the point from a logging table:
1.

Select the tables from which you want to remove the point. The tables
that you select will be highlighted.

2.

Select Remove.

3.

You will be asked to verify the removal request. Select Cancel to


cancel the request, or select OK to proceed.

4.

When you return to the Point Logging dialog box, the table(s) that you
selected are deleted from the list. You must confirm the deletions in
order to have them take effect. Select Cancel to cancel the deletions,
or select OK to confirm them.

Removing the Point from All Logging Tables


To remove the point from all logging tables:

GFK-1180H

1.

Select Remove All

2.

You will be asked to verify the removal request. Select Cancel to


cancel the request, or select OK to proceed.

3.

When you return to the Point Logging dialog box, all logging tables
that contain the point are deleted from the list. You must confirm the
deletions in order to have them take effect. Select Cancel to cancel
the deletions, or select OK to confirm them.

Database Logger

23-9

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.

Displaying Table Attributes


You can use the Table attributes button to display and modify the table properties
for the ALARM_LOG and EVENT_LOG tables. To display the table properties for
the table to which the alarm is currently being logged:

23-10

1.

Select Table attributes. The Table Properties dialog box for the
selected table opens. Make your modifications, and then select OK to
return to the Alarm Logging dialog box.

2.

When the Alarm Logging dialog box redisplays, the table has been
modified. Note that the Cancel button has changed to a Close button
to indicate that you cannot cancel the modification of the table.

3.

Select Close to close the dialog box without making any other
changes. Before you select OK, make sure that you are logging the
alarm to the correct table.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using the Table Browser

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.

Displaying A Table List


The dialog box initially displays a blank list of tables. You can choose to display the
list of all logging tables, or you can filter the list according to table identifier and/or
table type.
To display a table list:
1.

Enter information in the Table Identifier field. You can leave this
field blank, or you can enter a full or partial table name. If you are
entering a partial table name, you can use the following wildcards:
? - Matches exactly one character.
* - Matches zero or more arbitrary characters.

2.

Select a Table Type. You can display all table names, or you can
select a particular type of table. When you click the Select button for
this field, your choices are:
ALL - displays all group and data table names.
DATA - displays all data table names.
GROUP - displays all group table names.

3.

GFK-1180H

Select Browse to display the list of tables.

Database Logger

23-11

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.

Modifying the Properties of A Table


The Modify Table... button is only available when you select a single table from
the list. To modify the properties of a table:

23-12

1.

Select the table from the list.

2.

Select Modify Table....

3.

The Table Properties dialog box for the selected table opens. Make
your modifications, and then select OK to return to the Table Browser
dialog box.

4.

When the Table Browser dialog box redisplays, the table has been
modified. Note that the Cancel button has changed to a Close button
to indicate that you cannot undo the modification of the table.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Starting from Your Projects Workbench


Double-click the Database Logger icon in your projects Workbench to initiate the
configuration function.

The CIMPLICITY Database Logger Configuration window opens.

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:

GFK-1180H

Add a new Group or Data table.

Copy the information for a selected table to a new table.


Delete a table.

Modify a tables properties.

Open a table.
Add points to a table.

Modify logging properties.

Display a filtered list of tables.

Database Logger

23-13

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.

The File Menu


When you select the File menu, the following drop-down list displays:

The File menu functions are:


New Table...

Creates a new group or data table.

Open Table...

Displays the contents of the currently selected table.

Copy Table...

Copies the current table and its contents to a new table.

Delete Table

Deletes the currently selected table.

Exit

Exits the Data Logger function.

The Edit Menu


When you select the Edit menu, the following drop-down list displays:

The Edit menu functions are:


Table Properties...

Displays and modifies the properties of the currently


selected table.

Add Alarms...

Adds alarms to the Alarm Log or Event Log table.

Add Points...

Adds points to a Data Log or Group Log table.

Reconcile Table...

Opens the Reconcile Table dialog box.

Logging Properties... Displays and modifies Data Logger properties.

23-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The View Menu


When you select the View menu, the following drop-down list displays:

The View menu functions are:


Toolbar

Enables/disables the display of the Toolbar.

Status Bar

Enables/disables the display of the Status Bar.

Filter...

Filters the list of log tables.

The Help Menu


When you select the Help menu, the following drop-down list displays:

The Help menu functions are:

GFK-1180H

Help Topics

Displays the Help Contents for the Database


Logger.

About Database Logger

Displays the current version number for


Database Logger.

Database Logger

23-15

Using the Window Pop-Up Menu


The Window Pop-up Menu is available when you are working with at Database
Logger.

Use one of the following methods to access this menu:

With no tables selected, hold down the right mouse button. You can
then select the general menu options.

Select a table and hold down the right mouse button. You can then
select general or table related menu options.

The menu functions are:


Open

Opens the selected table.

New...

Opens the New Table dialog box and lets you create a
new table.

Rename...

Opens the Rename Table dialog box and lets you rename
the table.

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

Opens the Select A Point or Select a Alarm Definition


dialog box and lets you select points for the table.

Logging Properties... Opens the Logging Properties dialog box.

23-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Database Logger Toolbar Buttons


The Toolbar buttons on the CIMPLICITY Database Logger Configuration window
will perform the following functions:
New Table

Creates a new data or group table.

Open Table

Displays the contents of the currently


selected table.

Delete Table

Deletes the currently selected table.

Copy Table

Copies the current table and its contents to


a new table.

Add Item

Adds points or alarms to the selected


table.

Table Properties

Displays and modifies the properties of


the currently selected table.

Logging Properties

Displays and modifies Data Logger


properties.

Filter Items

Filters the list of visible items.

Dynamic Configuration

Enables automatic configuration updates


during runtime.

About Database Logger

Displays program information, version


number and copyright.

Database Logger Shortcut Keys


You can use the following shortcut keys to initiate commonly used functions:

GFK-1180H

Ctrl+N

Creates a new group or data table.

Ctrl+C

Copies the current table and its contents to a new table.

Ctrl+O

Displays the contents of the currently selected table.

Database Logger

23-17

Activating Dynamic Configuration


You can dynamically configure several logging properties through the Database
Logger. You can:

Add and remove points from data log tables.

Modify table and point logging attributes in data log tables.

Modify logging conditions in data log tables. This includes the default
logging conditions in the table and the logging conditions of individual
points.

Add and remove points from group log tables.

Modify table and point logging attributes in group log tables. This
includes the default point attributes in the table and the point attributes
of individual points.

Modify logging conditions in group log tables.

Add and remove alarms from ALARM_LOG and EVENT_LOG tables.

Modify logging conditions in ALARM_LOG and EVENT_LOG tables.


That includes the default logging conditions in the table and the logging
conditions of individual alarms.

To activate dynamic configuration in the Database Logger:

Press the Dynamic button

on any tables toolbar.

When you activate Dynamic Configuration, CIMPLICITY HMI updates your


projects configuration automatically. You dont have to return to the Workbench
and do a project update in order for your changes to take affect.

23-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Creating A New Table


When you create a new log table, the New Table dialog box opens.

To create a new data or group table:


1.

Enter the name of the new table in the Table identifier input field.
The name can contain alphanumeric characters (A thorough Z, 0
through 9) and underscores ( _ ). The name should be no longer than
16 characters. If you enter more than 16 characters, the name will
automatically be truncated to the first 16 characters when you select
OK. You cannot use the name of a currently existing table when you
create a new table.

2.

Select the type of table you want.

3.

Select OK to create the table, or select Cancel to cancel the proposed


creation. When you select OK, the Table Properties dialog box opens.

You can only create new group and data log tables. Only one Alarm table (called
ALARM_LOG) and one Event table (called EVENT_LOG) table exist in the Data
Logger. You cannot delete these tables, and you cannot create additional Alarm or
Event tables.

GFK-1180H

Database Logger

23-19

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.

23-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Default Logging Conditions for the ALARM_LOG


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.

Modifying Logging Conditions


To change the default logging conditions:

GFK-1180H

1.

Set the check box for each event that you want to log.

2.

Clear the check box for each event that you do not want to log.

3.

Select OK.

Database Logger

23-21

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.

23-22

Use the Browser button search for a Point ID.

Use the Pop-up Menu button for an existing Point ID.

- to open the Select A Point Browser and

CIMPLICITY HMI Users ManualMarch 1999

- to create a new Point ID or browse

GFK-1180H

Table Data Triggered Logging


Select this option if you want to log data when the trigger points value changes.
To select this type of logging:
1.

Set the On point value update check box.

2.

Enter the Point ID of the trigger point in the Point field.

You can combine data triggered logging with alarm triggered logging.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.

Table Alarm Triggered Logging


Select this option if you want to log data when the trigger point goes into the selected
alarm state.
To select this type of logging:
1.

Set the Alarm triggered logging check box.

2.

Set the check box for each alarm state that you want to trigger logging.

3.

Enter the Point ID of the trigger point in the Point alarm field.

For this option to work successfully, you must define alarm limits for the trigger
point. For example, if you select a Point ID and choose its Alarm High state, logging
in the table will occur each time the point enters the Alarm High state.
You can combine alarm triggered logging with data triggered logging.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.

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:

GFK-1180H

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.

Database Logger

23-23

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.

23-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Logging Attributes for ALARM_LOG, EVENT_LOG


and Application Tables

The Logging Attributes property page for ALARM_LOG, EVENT_LOG or any


application table displays the current table attributes that will be logged to the table.
Select Use Defaults to reset the Logging Attributes to their default values. The
default is to log the Project Name.

Table Attributes to be Logged


You can log any of the following table attributes:
Project Name

Log the name of the CIMPLICITY HMI project.

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.

GFK-1180H

Database Logger

23-25

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.

Point Attributes to be Logged


You can log any of the following point attributes:

23-26

Point Value

Log the points current value.

Previous Value

Log the previous value recorded in this table for this


point.

Raw Value

Log the points raw value.

Alarm State

Log the points current alarm state.

Resource

Log the points Resource ID.

Time Last Logged

Log the time the point was last logged in this table.

Engineering Units

Log the points engineering units.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Table Attributes to be Logged


You can log any of the following table attributes:
Project Name

Log the name of the CIMPLICITY HMI project.

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.

Maintenance Events for All Tables

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.

GFK-1180H

Use the Browser button search for a Point ID.

Use the Pop-up Menu button for an existing Point ID.

Database Logger

- to open the Select A Point Browser and


- to create a new Point ID or browse

23-27

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.

Timed/Gated Maintenance Events


You can select any of the following timed/gated maintenance events:
Periodic

Maintenance actions will be executed at the time interval


specified.
Valid intervals are DAYS, HOURS, and MINUTES.

Synchronized

Maintenance actions will be executed at the time of day


specified.

On digital point state If a periodic time interval is specified, maintenance


actions will be executed when the digital point you
choose is in the selected state.
If a periodic time interval is not specified, the
maintenance actions will be executed when the digital
point transitions to the selected state, or any time the
digital point transitions (if transition is selected).
Valid states are HIGH, LOW, and TRANSITION.

23-28

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Notes on Timed/Gated Logging and Timed/Gated


Maintenance

Timed/gated events for both maintenance and logging contain three options that can
be used either separately or combined. The following is a summary of the behavior
for each possible combination.
Periodic only

Logging/Maintenance actions will be executed at


the time interval specified.

Synchronized only

Logging/Maintenance actions will be executed at


the time of day specified.

On digital point state (gated) only


HIGH

Logging/Maintenance actions will be executed


when the digital point you choose transitions to
the HIGH state.

LOW

Logging/Maintenance actions will be executed


when the digital point you choose transitions to
the LOW state.

TRANSITION

Logging/Maintenance actions will be executed


when the digital point you choose transitions to
either the HIGH or LOW state.

Periodic/Synchronized

Logging/Maintenance actions will be executed


periodically at the specified time interval
(period) beginning at the specified time of the
day (synchronization).

Periodic/On digital point state (gated)

GFK-1180H

HIGH

Logging/Maintenance actions will be executed


when the digital point you choose transitions to
the HIGH state and then periodically at the
specified time interval while the digital point you
choose stays in the HIGH state.

LOW

Logging/Maintenance actions will be executed


when the digital point you choose transitions to
the LOW state and then periodically at the
specified time interval while the digital point you
choose stays in the LOW state.

Database Logger

23-29

TRANSITION

Logging/Maintenance actions will be executed


when the digital point you choose transitions to
either the HIGH or LOW state and then
periodically at the specified time interval while
the digital point you choose stays in the HIGH or
LOW state.

Synchronized/On digital point state (gated)


HIGH

Logging/Maintenance actions will be executed at


the time of day specified if the digital point you
choose is in the HIGH state.

LOW

Logging/Maintenance actions will be executed at


the time of day specified if the digital point you
choose is in the LOW state.

TRANSITION

Logging/Maintenance actions will be executed at


the time of day specified if the digital point you
choose is in the HIGH or LOW state.

Periodic/Synchronized/On digital point state (gated)

23-30

HIGH

Logging/Maintenance actions will be executed


periodically at the specified time interval
(period) beginning at the specified time of the
day (synchronization) if the digital point you
choose is in the HIGH state.

LOW

Logging/Maintenance actions will be executed


periodically at the specified time interval
(period) beginning at the specified time of the
day (synchronization) if the digital point you
choose is in the LOW state.

TRANSITION

Logging/Maintenance actions will be executed


periodically at the specified time interval
(period) beginning at the specified time of the
day (synchronization) if the digital point you
choose is in the HIGH or LOW state.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Maintenance Actions for All Tables

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:

GFK-1180H

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.

Database Logger

23-31

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:

3.

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.

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.

Use the Compact database action with great caution. Compacting a Microsoft
Access database requires the database file not be used by any process, otherwise the
action fails and waits to be executed during the next maintenance event. Due to this
restriction, the Database Logger terminates all communication with the Microsoft
Access database while the compact action occurs. This means that the logger queues
may overflow depending on how fast items are being logged and the size of the
logger queue.

23-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Logging Properties for All Tables

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.

GFK-1180H

Database Logger

23-33

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

Store and Forward


To configure Store and Forward for this table, set the Enable Store and Forward
check box.
After you enable this feature, use the radio buttons to select between unlimited or
limited storage of database records.
Unlimited
Click this radio button if you want the
Database Logger to store an unlimited
number of records when its connection to
the database is down.
The number of records actually stored is
determined by the amount of time the
connection is lost and by the amount of free
disk space you have.
Max number of stored records

Click this radio button if you want to select


the number of records the Database Logger
will store when its connection to the
database is down.
Enter a number between 1 and
4,294,967,295.

23-34

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Filtering the Table List


To filter the list of tables in the Database Logger window, select Filter... from the
View menu.
The Filter Tables dialog box opens.

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

GFK-1180H

Database Logger

23-35

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.

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.

23-36

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Database Logger

23-37

Reconciling a Table
You can use the Reconcile option on the Edit menu to show the differences
between the current CIMPLICITY HMI table configuration and the logging
database.
When you select Reconcile from the Edit menu, the Reconcile Table dialog box
opens.

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

23-38

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Creating Uncreated Database Fields


To create fields in the database for new fields in the configuration:
1.

Select the fields you want to create.


Uncreated fields display this icon:
You can use the Shift and Ctrl keys to select multiple fields, or you
can select Select Uncreated to select all the uncreated fields in the
table.

2.

Select Create.
After the fields are created in the database, their icons change to:

Removing Unused Microsoft Access Fields


To remove unused fields from the database table:
1.

Select the fields you want to remove.


Unused fields display this icon:
You can use the Shift and Ctrl keys to select multiple fields, or you
can select Select Unused to select all the unused fields in the table.

2.

Select Remove.

After the unused fields are removed from the database, their icons change to:

Removing Unused SQL Server and Oracle Fields


SQL Server and Oracle do not directly support dropping columns in a database table.
To delete unused columns, you must:
1.

Copy the table to a temporary table.

2.

Drop the table from the database.

3.

Recreate the table with the fields you wish to use.

4.

Copy the data from the temporary table to the new table.

5.

Delete the temporary table.

Consult your SQL Server or Oracle documentation for details on how to do this.

GFK-1180H

Database Logger

23-39

Database Logger Properties


The Logging Properties dialog box lets you define logging parameters, and specify
the type of database driver that interfaces with the Database Logger option.
Benchmark tests on a 60 MHz Pentium PC show that the following data rates can be
sustained for group tables with 200 points:
Microsoft Access

3.5 writes/second

On-node SQL Server 18 writes/second


A write is defined as a single log event on a table. The data rate is relatively
independent of the number of points logged to a table, and of the number of tables
being logged to. For example, using a SQL Server, you can log to 18 tables in one
second, or you can perform 3 log events on 6 tables in one second. Because of this
characteristic, a group table can log data faster than a data table with the same
number of points. (If a Group table holds 200 points, 18 writes/sec to that table gives
a data rate of 3600 points/sec.)
Note
Smaller groups log faster than larger groups. However, one large group logs faster
than two that are half as big do.

Parameters

23-40

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Disk full scan rate (min)


If any of your tables use the "Disk Full" maintenance event, you should know that
the disk is not continuously monitored for this condition. Instead, the disk is
monitored at the rate specified by this field.)
The "Disk Full" condition is only useful for Microsoft Access databases. The SQL
Server forces preallocation of disk space for data tables.

Database queue size


This field controls the queue of logged data for each table. Enter a queue size that
will support worst-case logging during activity bursts. For example, if 10 points are
being logged to the DATA_LOG table, you should have a queue size of at least 10 in
case their logging conditions all occur simultaneously.
A message is logged to your projects Status Log whenever the database queue for a
table overflows, and additional write requests are dropped until there is room in the
queue for them.
If you are doing more logging than can be supported by the benchmarked data rate
for the database, increasing the size of the database queue will not resolve the
problem of lost data.
Increasing the size of the Database Logger queue will increase the amount of
memory used by the database logger. Since each table preallocates memory for the
queue, this growth will take place at startup time. For each additional entry in the
queue, the following additional memory will be used:

GFK-1180H

Alarm Log Table

200 bytes per entry.

Event Log Table

200 bytes per entry.

Data Tables

Size of logged data plus 36 bytes.

Group Tables

Size of logged data plus 36 bytes.

Database Logger

23-41

Point data logging scan rate (ticks)


This scan rate is the worst-case scan rate at which the Point Data Logger will submit
data for logging. The value you enter here should be faster than the fastest table scan
rate. Enter the scan rate in ticks. (100 ticks = 1 second)
This value should be faster than the fastest table scan rate, and large enough so that
all the data for a PLC scan comes into the database together.)

Maintenance action export path


The export path defines the directory that holds the files created by table
maintenance export and purge actions. This pathname is validated when the
Parameters page is closed.
The default value of SITE_ROOT:\ARC places the data into the ARC subdirectory
of the project. You may use the logical directory name SITE_ROOT to specify a
different subdirectory of your project, or use any other full path specification such as
D:\EXPORT.

Alarm and Point Logging

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:

23-42

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.
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.
If you are using an Oracle Database, you may
see the ODBC data source that you created for
Oracle.
If you are using Microsoft Access, you need to
be aware that there are file locking issues for
both logging and reporting if you select the same
Microsoft Access data source for both the Alarm
and Point logging pages. To avoid these
problems, always select separate data sources for
Alarm and Point logging pages.

GFK-1180H

Database Logger

23-43

If you are using SQL Server or Oracle, these file


locking issues do not exist. You may configure
both the Alarm and Point logging pages to the
same SQL Server data source.
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 an 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 seconds (continuous retries) and 24 hours.

Store and Forward


Enter information in the following fields:
Enable Store and Forward
Set this check box to enable the Store and
Forward feature.
After you enable the feature, use the radio
buttons to select between unlimited or
limited storage of database records.
Unlimited

Click on this radio button if you want the


Database Logger to store an unlimited
number of records while its connection to
the database is down. The number of
records actually stored is determined by the
amount of time the connection is lost and by
the amount of free disk space you have.

Max number of stored records

Click on this radio button if you want to


select the number of records the Database
Logger will store when its connection to the
database is down.
Enter a number between 1 and
4,294,967,295.

23-44

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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:

GFK-1180H

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.

Database Logger

23-45

Table Menu Options


You can use the menu options to add points to the table, delete points from the table,
display and modify table and point properties, toggle the Toolbar and Status Bar
display, filter the table list, and access Help.

The File Menu


When you select the File menu, the following drop-down list displays:
For Data and Group tables For Alarm and Event tables

The File menu options are:


Add Points...

For Data and Group logs, adds points to the


table.

Add Alarms...

For Alarm and Event logs, adds alarms to the


table.

Remove Point

Removes the selected point from the table.

Remove Alarm

Removes the selected alarm from the table.

Close Table

Closes the table and returns to the main Data


Logger window.

The Edit Menu


When you select the Edit menu, the following drop-down list displays:Menu
For Data and Group tables For Alarm and Event tables

The Edit menu options are:

23-46

Point Properties...

For Data and Group logs, displays and modifies the


logging properties of the selected point.

Alarm Properties...

For Alarm and Event logs, displays and modifies the


logging properties of the selected alarm.

Table Properties...

Displays and modifies the properties of the table.

Reconcile Table...

Reconciles the current table with the database.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The View Menu


When you select the View menu, the following drop-down list displays:

The View menu options are:


Toolbar

Enables/disables the Toolbar display.

Status Bar

Enables/disables the Status Bar display.

Filter...

Filters the list of points in the table.

The Help Menu


When you select the Help menu, the following drop-down list displays:

The Help menu options are:

GFK-1180H

Help Topics

Opens the Help Contents for the Database


Logger

About Database Logger

Displays the current version number for


Database Logger.

Database Logger

23-47

Using The Window Pop-Up Menu


The Window Pop-up Menu is available when you are working with at Database
Logger table.
For Data and Point tables For Alarm and Event tables

Use one of the following methods to access this menu:

With no items selected, hold down the right mouse button. You can
then select the table related menu options.

Select an item in the table and hold down the right mouse button. You
can then select item or table related menu options.

The menu functions are:


Remove

Removes the selected point.

Properties...

Opens the Properties dialog box for the selected point.

Add Points...

For Data and Group logs, opens the Select A Point


Browser and lets you select points to be added to the
table.

Add Alarms...

For Alarm and Event logs, opens the Select A Alarm


Definition Browser and lets you select alarms to be added
to the table.

Table Properties...

Opens the Properties dialog box for the table.

Close

Closes the table.

Table Toolbar Buttons


The Toolbar buttons available to you are:

23-48

Close Table

Closes the table and return to the main


window.

Remove Items

Removes selected points or alarms from


the table.

Add Item

Adds points or alarms to the table.

Item Properties

Displays and modifies the logging


properties for the selected point or alarm.

Table Properties

Displays and modifies the properties of


the table.

Filter Items

Filters the list of points or alarms in the


table.

About Database Logger

Displays program information, version


number and copyright.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Adding Points to A Table


The Select A Point dialog box opens when you add a new point to a data or group
table. Use this dialog box, which is part of the Browser, to generate a list of points
from which you can select a point (or points) to add to the table. For more
information on the Point Browser, see "Using CIMPLICITY Configuration
Windows" in this manual.

Removing Points from A Table


To remove a point from a table:
1.

Select the point.

2.

Select Remove Point from the File menu or click the "Remove
Point" button on the Toolbar. A confirmation message box opens.

3.

Select OK in the confirmation message box to verify that you want the
point removed or select Cancel to cancel your request.

The point list updates after the confirmation message box closes.

Editing Point Logging Properties


You can modify the logging properties for each point in a logging table. The
properties that you can modify depend on the table type:

GFK-1180H

For points in group tables, you can modify each points Logging
Attributes.

For points in data tables, the Alarm Log table, and the Event Log table,
you can modify each points Logging Conditions.

Database Logger

23-49

Group Table Point Properties

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.

Point Attributes to be Logged


You can log any of the following point attributes:

23-50

Point Value

Log the points current value.

Previous Value

Log the points previous value.

Alarm State

Log the points current alarm state.

Engineering Units

Log the points engineering units.

Raw Value

Log the points raw value.

Time Last Logged

Log the time the point was last logged.

Resource

Log the points Resource ID.

SQL Field Prefix

This is the prefix for the column in the SQL


database, and must be unique for each point in
the table. The default is the Point ID.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Array Attributes to be Logged


This attribute is available only when you are entering an array point into a table.
Log array elements

Select the elements to be logged. To log all


elements, press All. You can use commas and
dashes in your list as delimiters.
Examples:
To log the first, third and fifth elements of an
array, type 1,3,5
To log the first through fifth elements, and the
tenth element of an array, type 1-5,10

Data Table Point Properties

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.

GFK-1180H

Database Logger

23-51

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 search for a Point ID.

Use the Pop-up Menu button for an existing Point ID.

- to open the Select A Point Browser and


- to create a new Point ID or browse

Point Data Triggered Logging


Select this option if you want to log data when the trigger points value changes.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.

Point Alarm Triggered Logging


Select this option if you want to log data when the trigger point goes into the selected
alarm state.
For this option to work successfully, you must define alarm limits for the trigger
point. For example, if you select a Point ID and choose its Alarm High state, logging
into the table will occur every time the point enters the Alarm High state.
If you do not define any logging conditions under Timed/Gated Logging, then data
will only be logged into the table when the trigger occurs.

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:

23-52

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Point Timed/Gated Logging


Timers and gates determine the logging interval for the point. You can choose one
or more of the following events
Periodic

Set this check box when you want to log point


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 or SECONDS.

Synchronized

Set this check box when you want to log point


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:

GFK-1180H

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.

Database Logger

23-53

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.

Modifying Logging Conditions for an Alarm


To change the default logging conditions for an alarm:

23-54

1.

Set the check box for each event that you want to log.

2.

Clear the check box for each event that you do not want to log.

3.

Select OK. The points logging conditions update, and the dialog box
closes.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Filtering the Point List

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

Filtering the Alarm or Event List

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 youve entered.
Select Cancel to cancel the filter function.
To display all the alarms in the table, put an asterisk (*) in the Alarm Identifier
field.

GFK-1180H

Database Logger

23-55

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.

Notes on Installing Microsoft Excel


Generally, installing Microsoft Excel is a straightforward process. However you
must perform additional steps when loading Microsoft Excel from an Excel CD, a
Microsoft Office for Windows 95 CD or a Microsoft Office for Windows 97 CD in
order to successfully generate reports.

Installing from an Excel CD


When you install Microsoft Excel from an Excel CD in Office 95 or Office 97, make
sure that you select the Microsoft Query Add-in in the Add-ins section.
CIMPLICITY software expects xlodbc.xla and xlodbc32.dll to be in the
C:\msoffice\excel\library\msquery directory. After you finish
installing Microsoft Excel, do the following:
1.

Locate xlodbc.xla and xlodbc32.dll.

2.

Create the path C:\msoffice\excel\library\msquery.

3.

Copy xlodbc.xla and xlodbc32.dll from their current directory


to the new path.

If you do not do this, a "Path not found" error message displays when you attempt to
open any of the report files.

23-56

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Installing from Microsoft Office for Windows 95 CD


When you install Microsoft Excel, do the following to install the Microsoft Query
Add-in:
1.

Select Converters, Filters and Data Access.

2.

Click Change Option.

3.

Select Data Access.

4.

Click Change Option.

5.

Select MS Query. It is not necessary to select any of the ODBC drivers


at this point, as they will be installed with your CIMPLICITY HMI
software.

6.

Continue with your installation.

If you do not do this, a Path not found error message displays when you attempt to
open any of the report files.

Installing from Microsoft Office for Windows 97 CD


When you install Microsoft Excel, do the following to install the Microsoft Query
Add-in:
1.

Select Data Access.

2.

Click Change Option.

3.

Select Microsoft Query. It is not necessary to select any of the ODBC


drivers at this point, as they will be installed with your CIMPLICITY
HMI software.

4.

Continue with your installation.

If you do not do this, a Path not found error message displays when you attempt to
open any of the report files.

GFK-1180H

Database Logger

23-57

Installing the Sample Reports


Before you can use the sample reports on your computer, you must first configure
them for use with your installation of Microsoft Excel (purchased separately). You
must have installed the MSQuery Add In with this product. If you do not install the
MSQuery Add In, when you attempt to open any of the report files, a Path not
found error message displays.
Microsoft Excel Version 7 does not require additional configuration for the reports.
If you have an older version of Microsoft Excel, perform the following additional
steps:
1.

From Excel, open the report file.

2.

From the Tools menu, select Add Ins...

3.

Use the Browse button to select the XLODBC.XLA add-in; it will be


located in the LIBRARY\MSQUERY subdirectory of your Excel
installation.

4.

Replace any existing XLODBC.XLA add-in, if you are prompted to do


so.

5.

Save your updated report.

Repeat these steps for all three report files. You will need to do this only once for
each report.

23-58

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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:

GFK-1180H

Set parameters.

Generate the report.

Clear the error log.

Database Logger

23-59

Setting Alarm Report Parameters


To set report parameters, click Set Parameters. The Set Report Parameters dialog
box opens with the tunable parameters for this report.

Enter information in the following fields to configure your report parameters:


ODBC Table

Select the table for which to generate the report. You


may select the ALARM_LOG or EVENT_LOG table.

Alarm Class

Enter an optional alarm class identifier to filter the report.


If no class is specified, all alarms will be included.

Start Time

Enter an optional start time for the report. If no time is


specified, the earliest data will be included.

End Time

Enter an optional end time for the report. If no time is


specified, the latest data will be included.

Data Source

Select the ODBC data source to be used in generating the


report. This should be the same data source that was used
to log the data. If an appropriate data source is not visible
in the drop-down list, you may browse for one.

To save your parameters, click OK. To cancel your changes, click Cancel.
If you save your spreadsheet after setting the report parameters, the parameters will
be available the next time you run the report.

23-60

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Clearing the Alarm Error Log


If an error occurs during report Generation, it will be reported on the status display
and added to the Error Log worksheet.
Once you have resolved any errors, click Clear Error Log to delete the error
messages from the Error Log worksheet. If you save your spreadsheet without
deleting any error messages from the error log, these messages will remain the next
time you open the report.

GFK-1180H

Database Logger

23-61

Data Report
This report provides the ability to report on Data tables that you have configured,
including the default DATA_LOG table. Because Data tables contain individual
points on each row, you may filter the report by Point ID to view only the point you
wish to see. In addition, you may filter the report by timestamp.
When you open the SQLDATA.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:

23-62

Set parameters.

Generate the report.

Clear the error log.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Enter information in the following fields to configure your report parameters:


Database Table

Enter the table for which to generate the report.


You can enter the name of a CIMPLICITY Data
table or enter DATA_LOG for the default Data
table.

Point ID

Enter an optional point identifier for the report.


If no identifier is specified, all points will be
included.

Start Time

Enter an optional start time for the report. If no


time is specified, the earliest data will be
included.

End Time

Enter an optional end time for the report. If no


time is specified, the latest data will be included.

Data Source

Select the ODBC data source to be used in


generating the report. This should be the same
data source that was used to log the data. If an
appropriate data source is not visible in the dropdown list, you may browse for one.

To save your parameters, click OK. To cancel your changes, click Cancel.
If you save your spreadsheet after setting the report parameters, the parameters will
be available the next time you run the report.

GFK-1180H

Database Logger

23-63

Generating A Data 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 data report contains a column for each attribute in the table. These may be named
as follows:
timestamp

The time that the point was logged.

POINT_ID

The point identifier of the point being logged

project

The name of the CIMPLICITY HMI project logging the


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

_VAL

The current value of the point being logged.

_TIME

The timestamp of the previous time the point was logged.

_RAW

The raw value of the point being logged.

_RES

The resource of the point being logged.

If you save your spreadsheet after generating a report, the data will be available the
next time you view the report.

Clearing the Data Error Log


If an error occurs during report Generation, it will be reported on the status display
and added to the Error Log worksheet.
Once you have resolved any errors, click Clear Error Log to delete the error
messages from the Error Log worksheet. If you save your spreadsheet without
deleting any error messages from the error log, these messages will remain the next
time you open the report.

23-64

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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:

GFK-1180H

Set parameters.

Generate the report.

Clear the error log.

Database Logger

23-65

Setting Trend Report Parameters


To set report parameters, click Set Parameters. The Set Report Parameters dialog
box opens with the tunable parameters for this report.

Enter information in the following fields to configure your report parameters:


Database Table

The table for which to generate the report. Enter the name of
a CIMPLICITY Group table.

Start Time

Enter an optional start time for the report. If no time is


specified, the earliest data will be included.

End Time

Enter an optional end time for the report. If no time is


specified, the latest data will be included.

Data Source

Select the ODBC data source to be used in generating the


report. This should be the same data source that was used to
log the data. If an appropriate data source is not visible in the
drop-down list, you may browse for one.

To save your parameters, click OK. To cancel your changes, click Cancel.
If you save your spreadsheet after setting the report parameters, the parameters will
be available the next time you run the report.

23-66

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Clearing the Trend Error Log


If an error occurs during report Generation, it will be reported on the status display
and added to the Error Log worksheet.
Once you have resolved any errors, click Clear Error Log to delete the error
messages from the Error Log worksheet. If you save your spreadsheet without
deleting any error messages from the error log, these messages will remain the next
time you open the report.

GFK-1180H

Database Logger

23-67

Printing Reports Automatically


Important
You can only use this feature with Microsoft Access and SQL Server
databases.
You can use OLE automation from CIMPLICITY HMI scripts to trigger the running
and printing of reports from Microsoft Excel spreadsheets that you have configured
to produce reports.
The CIMPLICITY HMI script may be:

Triggered by Database Logger Maintenance Events

Triggered by any event in the Event Manager

Attached to an object a user can trigger on a CimView screen

To implement this feature, you will need to:


1.

Configure the CIMPLICITY Service to access a printer.

2.

Create a script to generate the report and print it.

3.

Create an action to trigger the script.

Modifying the CIMPLICITY Service for Automatic


Printing
The CIMPLICITY service needs access to a user-defined printer to print reports. To
grant this access:
1.

From the Start menu, select the Control Panel.

2.

In the Control Panel, activate Services.

3.

In the Services dialog box, double-click on the CIMPLICITY Service.

4.

In the Service dialog box, under Log On As:, select This Account:.

5.

Select a CIMPLICITY user account.

6.

If the account requires a password, enter the password and confirm it.

7.

Select OK to accept your changes and close the Service dialog box.

8.

Select OK to close the Services dialog box.

9.

Close the Control Panel.


Note

If no one is logged in to the account you select here, when the script executes, no
printers will be available. The report will be generated, but it will not be printed.

23-68

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

GFK-1180H

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.

Database Logger

23-69

Triggering an Automatic Report


There are many ways to trigger a script to run and print a report from Database
Logger tables. The following are some suggestions.

Using Database Logger Maintenance Actions


To trigger a report automatically from a maintenance action:
1.

Open the Database Logger in the projects Workbench.

2.

Open the property sheets for the table.

3.

On the Maintenance Events page for the table, specify the event(s) you
want to trigger the script.

4.

On the Maintenance Actions page for the table, check Run program,
then enter the fill path and name of the executable you created from the
script.

5.

Select OK to save your changes and close the property sheets.

The report automatically generates and prints whenever any of the maintenance
events you specified occur.

Using the Event Manager


To trigger a report automatically from an event:
1.

Open the Event Editor in the projects Workbench.

2.

Create any event you wish to trigger the report.

3.

Create an action for this event to run the script.

The report automatically generates and prints whenever the event occurs.
Using a CimView screen:To let users trigger a report from a CimView screen:
Open the screen in CimEdit.
1.

Select or create the object you want to trigger the report.

2.

Display the objects property sheets.

3.

On the Script property page, select Edit.

4.

In the Edit Script window, enter a script that will trigger the report.
You can generate the report directly, or trigger an event that invokes an
action that generates the report.

5.

Close the Edit Script window.

6.

Open the Events property page.

7.

Create a new event and assign it a new procedure.

8.

In the Procedure Information dialog box, create an Invoke Script action


and specify the script you created.

9.

Select OK to save the new procedure information.

10. Select OK to save the objects properties.


When a user executes the event you configured, the report automatically generates
and prints.

23-70

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Managing Database Logging

About Managing Database Logging


This chapter covers the following system management topics for the Database
Logger:

Installing ODBC drivers and configuring data sources.

Installing Oracle drivers and configuring data sources

Managing the database for the SQL Server

How tables are created.

Table characteristics

Controlling database disconnect recovery

Using Database Logger global parameters


Important

The Microsoft Access ODBC driver is only supported on Intel-based


computers. You must purchase SQL Server and the Database Logger
option to log data on a DEC Alpha-based computer. SQL Server
requires Windows NT Server.
(Each line on a trend control is a separate connection to the SQL database.
Thus, the SQL server is required because it has unlimited connections.)

GFK-1180H

24-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 thirdparty 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 Intelbased computers using Windows NT or Windows
98/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 Intelbased and DEC Alpha computers

Oracle

A high-performance database for large applications.


You must purchase Oracle and INTERSOLV
DataDirect ODBC Driver for Oracle to use this driver.
Oracle is currently supported for Intel-based
computers running Windows NT or Windows 98/95.

ODBC Data Sources


An ODBC Data Source is a specific configuration of an ODBC driver. When you
install the CIMPLICITY HMI Database Logger, several data sources are
automatically configured:

24-2

CIMPLICITY Alarm Logging

A data source which uses the Microsoft


Access driver to log to CIMPLOG.MDB
in your distribution ARC directory.

CIMPLICITY Point Logging

A data source which uses the Microsoft


Access driver to log to
POINTLOG.MDB in your distribution
ARC directory.

CIMPLICITY SQL Server Logging

A data source which uses the Microsoft


SQL Server driver to log to an on-node
(local) SQL Server.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 reopen the Database Logger to rewrite the connect string.

If the project uses custom data sources, these must be reconfigured on


the target machine.

About Custom Data Sources


You may configure additional data sources on your computer, or customize the data
sources that are configured by CIMPLICITY installation. However, you must
observe the following restrictions:

If you want to trend Logged or Logged


Point data that is stored in a remote
database, you must add a custom data
source to the database.

GFK-1180H

Use only supported ODBC drivers. Other drivers may not meet the
data requirements of CIMPLICITY software.

Because CIMPLICITY runs as a service, it must use system data


sources.

Remember that data sources are not part of your CIMPLICITY project,
and will not automatically follow a project that is taken to a different
node.

Be aware of any driver-specific restrictions (below) which may apply.

Managing Database Logging

24-3

Configuring Microsoft Access Data Sources


To configure an ODBC data source for use with the Microsoft Access file format,
perform the following steps:
1.

Run the ODBC Administrator (from the ODBC program group) or


select the ODBC option from the Windows NT Control Panel.

2.

Click System DSN to select the list of System Data Sources.

3.

Click Add... to add a new data source.

4.

Select the Microsoft Access Driver from the list, and click OK.

5.

Enter a unique Data Source Name. Use any combination of letters,


numbers, and white space; but avoid punctuation characters.

6.

Enter a Data Source Description, if desired.

7.

Click Select... button to select an existing database file, or click


Create... to create a new .MDB file.

8.

In the Select Database or New Database dialog, specify a file name,


and click OK.

9.

From the ODBC Microsoft Access Setup dialog, click Options.

10. Verify that Exclusive is not checked.


11. Configure separate data sources for CIMPLICITY Point Logging and
Alarm Logging.
Note
Due to file locking issues in the Microsoft Access driver, you must never request
Exclusive access to a database that is used by CIMPLICITY for logging. In
addition, the Point Logging and Alarm Logging data sources must refer to different
database files.

Installing SQL Server


You can purchase SQL Server from Microsoft. Before you install and configure the
database, you will need to decide which computer will run the SQL Server database.
The computer does not have to be your CIMPLICITY HMI computer. If you plan to
access the SQL Server database from other computers on your network, you will
need to purchase a SQL Server Client license for each of those computers.
Install the SQL Server on the computer where you want to run the SQL Server
database. When you are prompted regarding network options, be sure to select
TCP/IP networking if you are going to be accessing the database from an off-node
CIMPLICITY HMI server or viewer. See the SQL Server documentation for more
details on installing the software.
After you finish installing the software, reboot your computer. You are now ready to
start configuring the SQL Server. After you configure the SQL Server, you can
install the SQL Server Client Utilities on any other computers that will be logging
data to or reading data from the SQL Server database.

24-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

GFK-1180H

Managing Database Logging

24-5

Configuring SQL Server Data Source


After your SQL Server database and user account are created, you can enter the
account and password in the Logging Properties dialog box for Alarm Logging and
Point Logging. Perform the following steps:
1.

From the Configuration cabinet, use the right button to obtain the
popup menu for the Database Logger product option. Select Logging
Properties.

2.

On the Alarm Logging page, select the CIMPLICITY SQL Server


Logging data source from the list of ODBC data source names.

3.

Specify the SQL Server User ID and password in the space provided.

4.

Repeat steps 2 and 3 for the Point Logging page.

5.

Click OK to save your changes.

Note that you may use the same SQL Server Data Source for both pages of this
dialog.

Installing SQL Server Client Utilities


Reading is done by any applications, For each computer where you will be logging to or reading data from an off-node
such as Trending and SPC, which need
SQL Server, you will need to install the SQL Server Client Utilities. Follow the
to access logged data.

directions in the SQL Server documentation to do this.

Remember to select TCP/IP Networking on your SQL Server client computers (GE
Fanuc recommends that you use TCP/IP networking to connect to the remote SQL
Server database).
You will also need to purchase a SQL Server Client license for each computer where
you install the SQL Server Client Utilities.
Finally, you will need to configure the remote SQL Server data sources for each of
these computers.

Configuring Remote SQL Server Data Sources


If you are logging to or reading data from an off-node SQL Server, do the following
to modify the CIMPLICITY data sources:

24-6

1.

Open the 32bit ODBC Administrator in the ODBC program group

2.

In the Data Sources dialog, select System DSN. The System Data
Sources dialog box opens

3.

In the System Data Sources dialog box, select CIMPLICITY SQL


Sever Logging (SQL Server) in the list of data sources.

4.

Select Setup. The ODBC SQL Server Setup dialog box opens.

5.

In the ODBC SQL Server Setup dialog box:

Enter the SQL Servers computer name in the Server field.

Specify the SQL Server computers TCP/IP address as the


Network Address.

Enter DBMSSOCN as the Network Library.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Configuring Additional SQL Server Data Sources


If you need to create a SQL Server data source in addition to the standard
CIMPLICITY data source, do the following on the SQL Server Client computer:
1.

Open the 32bit ODBC Administrator in the ODBC program group

2.

In the Data Sources dialog, select System DSN. The System Data
Sources dialog opens

3.

In the System Data Sources dialog, select Add. The Add Data Source
dialog opens.

4.

In the Add Data Source dialog, select the ODBC driver for the data
source.

5.

Select OK. The ODBC SQL Server Setup dialog box opens.

6.

In the ODBC SQL Server Setup dialog, enter the name of the data
source in the Data Source Name field.

7.

In the ODBC SQL Server Setup dialog box:

8.

9.

Enter the SQL Servers computer name in the Server field.

Specify the SQL Server computers TCP/IP address as the


Network Address.

Enter DBMSSOCN as the Network Library.

If you are logging to a specific database name rather than the default:

Select Options.

Enter the database name in the Database Name field

Select OK on the ODBC SQL Server Setup dialog.

10. Select Close on the System Data Sources dialog.


11. Select Close on the Data Sources dialog.

GFK-1180H

Managing Database Logging

24-7

Oracle Configuration
Requirements
You must purchase the INTERSOLV DataDirect ODBC driver for Oracle.
Oracle databases can be supported on Intel-compatible computers with Microsoft
Windows NT v4.0 or Microsoft Windows 98/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.

Using Oracle with CIMPLICITY HMI


To prepare the Oracle database for use with CIMPLICITY HMI projects:
1.

Install the INTERSOLV ODBC Driver for Oracle. Follow the


directions in the INTERSOLV documentation to do this.

2.

Install the Oracle client utilities (either Administrator or User). Follow


the directions in the INTERSOLV documentation to do this.

3.

Use SQL*Net Easy Configuration to configure a database alias to


match the configured alias on the Oracle server.
Remember that the database alias is case sensitive.
If you do not know what database alias to use, ask your database
administrator or look up the alias configuration from SQL*Net
configuration on the Oracle server directly.

4.

Configure the CIMPLICITY Service to interact with the desktop.

5.

Create a new system ODBC data source for Oracle.


The server name should be the alias name you created in SQL*Net
Easy Configuration.

6.

Select Database Logger in your projects Configuration Cabinet.

7.

In the Database Logger window, select Logging properties from


the Edit menu.

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:

24-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Database aliases configured on the client node must also be configured


on the server node.

The Oracle servers IP address must be in the CIMPLICITY HMI


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

Database Management for SQL Server


This section contains information on procedures for configuring additional locks and
truncating the Transaction Log.

Configuring Additional Locks


If the SQL Server generates an error that looks like this on rollover:
Error #S1000 SQLSERVER has run out of locks. Re-run your command
when
you can do the following to increase the number of locks:
1.

Open the SQL Enterprise Manager in the Microsoft SQL Manager


program group.

2.

From the Server menu, select SQL Server, then Configure. The
Server Configuration/Options dialog opens.

3.

In the Server Configuration/Options dialog, select the Configuration


page.

4.

Find locks in the list.

5.

Increase the number of locks.

6.

Select OK.

7.

Exit the SQL Enterprise Manager.

The change takes place the next time the SQL Server is restarted.

GFK-1180H

Managing Database Logging

24-9

Handling the Transaction Log


All SQL Server transactions are logged to the Transaction Log file. The Transaction
Log contains an audit trail by default and can grow to be quite large. To conserve
disk space consider doing one of the following:

Use a truncated Transaction Log by default

Use a CIMPLICITY maintenance action truncate the Transaction Log


periodically

Truncating the Log as a System Default


To make the Transaction Log truncated by default:
1.

Open the SQL Enterprise Manager in the Microsoft SQL Manager


program group.

2.

From the Manage menu, select Databases. The Manage Databases


dialog opens.

3.

In the Manage Databases dialog, double click on the database used by


the CIMPLICITY Database Logger. The Edit Database dialog opens.

4.

In the Edit Database dialog, select the Options page.

5.

Select the Truncate Log on Checkpoint option.

6.

Select OK.

7.

Close the Manage Databases dialog.

The change takes place the next time the SQL Server is restarted.

Truncating the Log as a CIMPLICITY Maintenance Action


To define a CIMPLICITY Maintenance Action that periodically truncates the
Transaction Log:
1.

Open the Database Logger in the CIMPLICITY program group.

2.

Select a table from the list of tables.

3.

Open the Table Properties dialog for the table.

4.

Select the Maintenance Actions page.

5.

In the Command Action field, enter:


dump transaction DATABASENAME with no_log
This command will dump the Transaction Log without saving the log.
If you want to save the log to a file, see your SQL Server
documentation on how to do this.

6.

Select the Maintenance Events page.

7.

Configure the event that will trigger the action.

This change takes place the next time you update the projects configuration and then
restart the project.

24-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Microsoft Access Note


To successfully create or repair tables, the Database Logger requires an exclusive
lock on the Access database. If another application is using the Access database, the
Database Logger cannot exclusively lock the database, and it will terminate. If this
happens, the following message will be logged in the Status Log for the project:
Unable to repair database
This problem occurs, for example, if a user is running reports on the Access database
while a project is being started.

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:

GFK-1180H

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.

Managing Database Logging

24-11

Points with Engineering Units


conversion are stored in floating
point format

The number of columns you can actually have in a group table


depends on the type of data you are storing. A record being added to
the 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.

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.

24-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Reconnect Wait Period


The DB_CONN_DOWN alarm is not
stacked by default, but you can
change it in Alarm Configuration.

You can use the Reconnect wait period to define the amount of time to wait
between connection requests whenever the Database logger loses its connection to
the database. Each time a reconnect request fails, a DB_CONN_DOWN alarm is
generated.
You can define a separate wait period for the Alarm Logging and Point Logging.
After the database connection is reestablished, if you have also enabled the Store
and forward feature, all of the stored data is automatically forwarded to the
database.

Store and Forward


The Store and Forward feature is available for both Microsoft Access and SQL
Server databases. This feature lets you write records for Alarm Logging and Point
Logging to storage files whenever the Database Logger loses its connection to the
database.
When the Database Logger successfully reconnects to the database and Store and
Forward is enabled when the Database Logger starts, the Database Logger checks
for stored data files (that is, .SQL files) in the storage directory. If it finds files, it
generates a DB_START_FORWARD alarm then checks the files for stored data. If
there is no stored data in the files, the Database Logger logs the following message
to the Status Log:
No forward data found in <store_path>
and clears the DB_START_FORWARD alarm.
If there is data to forward, the Database Logger goes through each file and forwards
the data to the database. When all the data has been forwarded, or if the Database
Logger loses its connection to the database, it clears the DB_START_FORWARD
alarm and stops processing the storage files.
Note
Stored data and new logged data are sent in parallel to the database, and all
Maintenance actions are ignored while data is being stored.
After a file is forwarded to the database, the Database Logger sends the following
message to the Status Log:
Forward: <file_name> succ: <no_suc> fail <no_fail>
If there are failures, the following message will also be logged:
Forward: See log <filename> for errors.

GFK-1180H

Managing Database Logging

24-13

If the Database Logger cannot process a SQL statement in a storage file, it generates
a log file with the same name as the storage file and the extension .LOG. The log
file contains the statement forwarded to the database and the error message returned
by the database.
If the Database Logger encounters no problems when forwarding data, no .LOG file
is generated.
Note
If you have Store and Forward enabled and storage files exist when you shut
down the Database Logger and you then disable Store and Forward, the Database
Logger will not forward records from the storage files when it restarts.
You can open a storage file and examine its contents in, for example, Notepad.

Enabling Store and Forward


When you enable this feature, you can choose to store an unlimited, or a maximum
number of records in the storage file for the database. You can define separate
storage options for Alarm Logging and Point Logging.

If you choose to store unlimited records, the Database Logger continues


to save data records until it runs out of disk space. The following
message is then logged in the Status Log:
Unable to write to store and forward file, <filename>
and the Database Logger continues to try to save additional records.

If you choose to store a maximum number of records, the Database


Logger saves the configured number of records then stops, and the
following message is logged to the Status Log
Number of stored records exceeded maximum <max_no>

The records are stored in one or more files in a storage directory. The number of
files depends on the maximum number of records you select and the maximum
number of records per file.

Store and Forward File Names


For Alarm Logging and Point Logging storage files, the default directory is
%SITE_ROOT%\arc, and the default maximum number of records per file is 100.
The filenames for the storage files have the following format:
<dbms_ID>_<date_stamp>_<time_stamp>.SQL

where <dbms_id> is the databases DBMS ID, <date_stamp> is the date and
<time_stamp> is the time the file was created. For example:
POINT_960916_053151.SQL

24-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Changing Directory and Record Defaults


The default directory for Store and Forward files is %SITE_ROOT%\arc, and
the default number of records per file is 100. You can change both of these defaults.
Important
Please consider carefully when changing the maximum number of
records per stored file. Setting too high a number will result in
unmanageable files, while setting too low a number will cause
excessive disk I/O.
1.

In your projects Configuration program group, select Command


Prompt from the Tools menu.

2.

At the command prompt type:


cd master
idtpop dbms_def
notepad dbms_def.idt

The file looks like this:


|-* IDT file generated by IDTPOP utility v1.0
* RECORD: DBMS_DEF ODBC Database Definitions
*
0 DBMS_ID
Name of the database/service for logging
*
1 driver
ODBC name of DMBS driver
*
2 connect_string
Connection string for ODBC driver
*
3 wait_period
reconnect wait period
*
4 wait_units
reconnect wait period units
*
5 store_forward
0=off 1=on
*
6 store_path
path of stored file
*
7 recs_per_file
max recs per stored file
*
8 limited
0=unlimited store else max num of recs
*
$LOGGING|Microsoft Access Driver <*.mdb>|DSN=CIMPLICITY Alarm Logging;UID=admin;DBQ=BSM_ROOT:\arc\CIMPLOG.MDB|-1|0|0||100|0.000000
$LOGGING|Microsoft Access Driver <*.mdb>|DSN=CIMPLICITY Point Logging;UID=admin;DBQ=BSM_ROOT:\arc\POINTLOG.MDB|-1|0|0||100|0.000000

Note that the Alarm Logging and Point Logging databases have
separate records.

GFK-1180H

Managing Database Logging

24-15

3.

To define a new path for the stored records for a database, enter the
pathname in the store_path field for the database. You can set a
different path for each database.

4.

To define a new maximum number of records per stored file for a


database, enter the new maximum in the recs_per_file field for
the database. You can set a different maximum for each database.

5.

Exit Notepad and save the updated file.

6.

Enter the following commands to regenerate the data file and close the
command window:
scpop dbsm_def
exit

In order for this change to take effect, you must shut down your project, perform a
Configuration Update, and then restart the project.

24-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Database Logger Global Parameters


The following global parameters are available for the Database Logger.

DB_DEBUG

DB_ENABLE_TRANSACTIONS

DB_TIME_FORMAT

DB_TIMESTAMP_FIELD

DB_TIMESTAMP_FILTER

Configuring a Database Logger Global Parameter


To configure a Database Logger global parameter:
1.

Open the HMI project through the Workbench.

2.

Select Tools on the menu bar.

3.

Select Command Prompt A command prompt window will open.


Make sure that you type all commands through that command prompt
window.

4.

From the command prompt, type the following commands:


cd master
idtpop glb_parms

5.

Edit the glb_parms.idt file located in the HMI projects master


subdirectory. If you have an editor which can be launched through the
command prompt (e.g. Notepad), just type it through the command
prompt:
notepad glb_parms.idt

6.

At the end of the file, add the correct line for the global parameter you
are adding.
Example
DB_TIMESTAMP_FIELD|1|field name

where field name is the name you want to give to the timestamp field
(e.g. DATETIME if you want the field to be uppercase).
Note: Refer to your database documentation for any field naming restrictions.
7.

Save the file and close your editor.

8.

From the command prompt, type the following command:


scpop glb_parms

9.

Select Project on the Configuration Cabinet menu bar.

10. Select Configuration Update to update the runtime configuration


before running the project.
You are now ready to run the project.
For detailed information on editing the global parameters file, see "Global
Parameters" under System Management in this manual

GFK-1180H

Managing Database Logging

24-17

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 projects log directory.
The record format is:
DB_DEBUG|1|<value>

where <value> can be any combination of:


0

Stop dumping diagnostic information

Print full syntax of ODBC error messages (this is the default)

Print details of database connection when established

Print syntax of ODBC statements if they fail

Rename/keep Store and Forward files after loading them

4096

Print application-specific details

If you do not define DB_DEBUG, the default is to print the full syntax of ODBC
error messages. Since ODBC errors should happen infrequently, this is unlikely to
cause problems with disk space.
You must explicitly specify a value of 0 (zero) to stop dumping diagnostic
information to the log files.
If you need additional information, a value of 7 (1+2+4) is recommended.
If you also want to keep the Store and Forward files after loading them, a value of 15
(1+2+4+8) is recommended.
There are additional undocumented values that should only be used by GE Fanuc
engineers as they send a great number of messages to the MAC_DL.out and
MAC_PTDL.out that could quickly fill your available disk space.

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.

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:

24-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

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_TIMESTAMP_FIELD
By default, all database logger tables have a timestamp field, which specifies the date
and time of each logged transaction. This field is unique, as it is part of the tables
primary key. The name of this field defaults to timestamp for all database logger
tables.
timestamp is a lower case string.
Certain database client applications have problems accessing lowercase field names
from an Oracle DBMS. The DB_TIMESTAMP_FIELD global parameter can be used in
a CIMPLICITY HMI project to override the default timestamp field name used by
the database logger. This allows you to specify an uppercase field name for the
timestamp field.
Since DB_TIMESTAMP_FIELD is a global parameter, it only affects the HMI project
where it is configured.
When you use the DB_TIMESTAMP_FIELD global parameter, make sure that you
drop all affected tables before running the HMI project. Otherwise, the database
logger will not be able to recreate them with the new timestamp field name specified
by the DB_TIMESTAMP_FIELD global parameter.
Using DB_TIMESTAMP_FIELD modifies the timestamp field in the following tables
for the project where DB_TIMESTAMP_FIELD is used:
1.

Alarm Management tables (ALARM_LOG and EVENT_LOG)

2.

Event manager table EM_LOG

3.

Point management tables (both data and group log tables)

4.

SPC tables

5.

HDA tables

6.

Tracker tables

The format for the DB_TIMESTAMP is:


DB_TIMESTAMP_FIELD|1|field name

where field name is the name you want to give to the timestamp field
(e.g. DATETIME if you want the field to be uppercase).

GFK-1180H

Managing Database Logging

24-19

DB_TIMESTAMP_FILTER
DB_TIMESTAMP_FILTER that allows either rounding or truncation of all
timestamps in records logged by database logging. This includes the Point , Alarm
and Event Logging, SPC, Tracker and the Historical Data Analyzer.
The format for DB_TIMESTAMP_FILTER is either:
DB_TIMESTAMP_FILTER|1|A

where A is the precision in milliseconds that specifies rounding the timestamp


up or down.
DB_TIMESTAMP_FILTER|1|-A

where -A is the precision in milliseconds that specifies truncating the timestamp.


Example
If a timestamp filter of 30000 is specified, the following timestamps will be logged
as follows:
DB_TIMESTAMP_FILTER|1|30000

Actual Timestamp

Logged Timestamp

3/1/99 12:22:37.730

3/1/99 12:22:30.000

3/1/99 14:37:24.102

3/1/99 14:37:30.000

3/1/99 23:59:51.107

3/2/99 00:00:00.000

If a timestamp filter of -30000 is specified, the following timestamps will be logged


as follows:
DB_TIMESTAMP_FILTER|1|-30000

24-20

Actual Timestamp

Logged Timestamp

3/1/99 12:22:37.730

3/1/99 12:22:30.000

3/1/99 14:37:24.102

3/1/99 14:37:00.000

3/1/99 23:59:51.107

3/1/99 23:59:30.000

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Client Configuration

About Client Configuration


You can use the Client Configuration utility to configure default logins for
CIMPLICITY HMI Viewers on Client computers.
You can configure a CIMPLICITY HMI Viewer on a Client computer to
automatically log in to a Server project. The projects Client Configuration provides
a default login on a per-Client computer basis. When A CIMPLICITY HMI Viewer
on the Client accesses project data from the Server (by opening a CimView screen,
for example), the Viewer is automatically logged in to the project.
You can also configure a Client to use the Windows Logon Username as the default
user for logging in to a CIMPLICITY HMI project. When you check the Trusted
option, a user on a Client computer automatically logs in to the CIMPLICITY HMI
project if their Windows Logon Username matches a CIMPLICITY HMI User ID in
the project.

Using Client Configuration


To start Client Configuration, double-click the Client icon in the Configuration
cabinet. The Client - Configuration window opens.

GFK-1180H

25-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 a client.

Copy the information for a selected client to a new client.

Delete a client.

Display a filtered list of clients

Creating A New Client


To create a new client, 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 Client dialog box opens.

Enter the name of the computer for the new client, then select OK. The Client
Properties dialog box opens.

25-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Client Properties

You can select either or both of the client options.

If you enter just the Default User ID, all users from the Client
computer are automatically logged in with the default User ID.

If you just set the Trusted check box, only those users whose
Windows Logon Username match a CIMPLICITY User ID in the
project are automatically logged in. All other users will have to enter a
User ID and Password (if required) in the CIMPLICITY Login dialog
box.

If you select both options, those users whose Windows Logon


Username match a CIMPLICITY User ID in the project are
automatically logged in with that User ID. Otherwise, users are
automatically logged in with the default User ID.

When you are finished defining the client properties, select OK to close the Client
Properties dialog box and create the new client properties, or select Cancel to close
the dialog box without creating the new 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 create a new user or browse for an existing user.

- to

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-1180H

Client Configuration

25- 3

Using CIMPLICITY HMI with


CIMPLICITY Control

About CIMPLICITY HMI and CIMPLICITY Control


CIMPLICITY Control provides you with PLC programming and configuration.
When you create a folder in the CIMPLICITY Control Workbench, you can
configure and program Series 90 PLC hardware, create ladder logic programs and
create variables that are mapped to PLC reference addresses. Since CIMPLICITY
HMI points can also be mapped to PLC reference addresses as well, a Control
variable has properties that are common with a HMI point.
CIMPLICITY Control and HMI work together to provide you with configuration
options that let you import variables from a Control folder into points in an HMI
project.
Note
You must have both CIMPLICITY Control and CIMPLICITY HMI installed on your
computer.
When CIMPLICITY Control and CIMPLICITY HMI are both installed in a
computer, a CIMPLICITY Control Workbench icon is placed in your projects
Workbench.
To open the CIMPLICITY Control Workbench, just double-click or open the
CIMPLICITY Control icon.

GFK-1180H

26-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 projects devices and Control folders. A device can have associations
with multiple folders. However, a folder can only be associated with one of the
projects 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.

26-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Using CIMPLICITY HMI with CIMPLICITY Control

26-3

On configuration update
Select this check box to import points for all devices associated with Control folders
during configuration update for those folders that have changed since the last import.
Use common point properties on modify
Select this check box to use common point properties during a modify operation or
keep the common point properties that the point already has in the HMI project.

Common Point Properties


Each point in a CIMPICITY HMI project must be associated with a resource.
CIMPLICITY Control does not have the concept of a resource, therefore you need to
define a common resource that will be used for all data retrieved from CIMPLICITY
Control for this project.
To select a resource, click the drop-down list button in the Resource field and
select the Resource ID you want to use.
To select the type of access you want points to have, click the radio button for Read
only or Read/write. If you select Read only, the HMI project can only read data
from the points. If you select Read/write, the project reads data from and writes
data to the points.
Select the Enable point check box if you want the points you import to be enabled.
If points are enabled, they are scanned and their values are available to HMI
applications.

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.

26-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Creating a New Association


Select New to create a new association. When you do, the New Association dialog
box opens.

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 projects devices.

GFK-1180H

Using CIMPLICITY HMI with CIMPLICITY Control

26-5

Select OK to add the association to the list of associations. The dialog box closes
and the list in the CIMPLICITY Association Server dialog box updates.

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.

26-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

If a point is removable and the device configuration has the delete


option selected, it is deleted from the project.

Using CIMPLICITY HMI with CIMPLICITY Control

26-7

4.

If a point exists in the project but it is a virtual point or does not belong
to the device associated with the folder being imported, a new point
conflict occurs.

5.

If the point information imported from Control is incomplete or


incorrect, an incorrect information conflict results for that particular
point.

Please note that the import process only identifies point conflicts between folders and
projects. It does not identify conflicts between folders associated with the same
device.
Example:
A device can be associated with folders A and B. Both folders can contain the same
exportable variables. When the import occurs, the last folder to be imported
modifies the imported information from the previous folder because the points are
considered modifiable since they belong to the same device. To prevent this situation
from happening you can use the folder name prefix option to add a prefix to each
Point ID thus preventing folder to folder conflicts from occurring.

Resolving Point Conflicts


When conflicts occur during import, the CIMPLICITY Control Point Import
Conflicts dialog box opens and displays the list of conflicts.

Two types of conflicts can occur:

New point conflicts

Incorrect information conflicts


Note

Conflicts do not need to be resolved in order for the import to continue.

26-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To display the Resolve Conflict dialog box for a point and resolve a point conflict, do
one of the following:

Double-click on the point in the list.

Select the point in the list, then select Resolve.

Select OK to import the resolved points.


Select Cancel to cancel the import of resolved points.

New Point Conflicts


A new point conflict occurs when the point exists in the project but does not belong
to the device associated with the folder being imported.

To solve the conflict, you can take one of the following actions:

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

GFK-1180H

Using CIMPLICITY HMI with CIMPLICITY Control

26-9

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:

Dont import the point.

Correct the points 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.

26-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Remote Configuration
Control configuration options are only supported in the computer where associations
are created. This is because the Association Servers storage is local to the computer.
In order to perform point imports from remote computers you need to configure
associations properly in each remote computer.

A project path in an association needs to be the path by which the


project is opened.
For example, if a computer opens a project through HMI as
X:\project\project.gef, the project's associations in that
computer must also be configured as X:\project\project.gef.
If another computer opens the same project as
Y:\project\project.gef, the project's associations in that
computer must be configured as Y:\project\project.gef.

A folder path in an association needs to be exactly the same for all


computers.
For example, if project.gef has an association with folder
F:\folder\folder.ef7, all computers must have their
associations configured with the same folder path and must be able to
open the folder through that same path as well. This is because the
import process will have to access the folder through the path given by
the association.

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

ComputerB

HMI and Control installed


Drive E: mapped to its own C drive (\\ComputerB\C$)
Drive F: mapped to \\ComputerA\C$
Contains C:\folder\folder.ef7
Configured associations:
F:\project\project.gef with
E:\folder\folder.ef7

GFK-1180H

Using CIMPLICITY HMI with CIMPLICITY Control

26-11

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 projects associations configured.
If you open the project from ComputerB and perform a point import, it will also be
performed because the computer has the projects 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.

26-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuration Import/Export

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.
Third Party
Applications

Import/Export

Point/Alarm
Configuration
Files

Import/Export
Configuration
Files
CSV Files in
SNF format

Log File

In addition to reading and writing information in the CIMPLICITY HMI point


database and CSV files, Import/Export uses information in the Import/Export
configuration files to determine default field data, and writes informational, warning,
and error messages to a log file.

GFK-1180H

27-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 thirdparty 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.

Sample Data File


An example of a CSV file in SNF format follows. This file modifies the alarm limits
of a subset of device points. These points are assumed to already be configured in
the CIMPLICITY HMI database.

** FIELD NAMES is a physical record consisting of a single line. It is shown here


as multiple lines for readability within the documentation.

27-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Editing CSV Files in Excel


When using Excel to edit a CSV file, keep the following guidelines in mind:

GFK-1180H

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.

Initial blanks at the start of a field are ignored. If you want initial
blanks, you must edit the file with Notepad and enclose the field in
double quotes.

A field that contains a comma does not need to be enclosed in double


quotes. For 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:

Configuration Import/Export

27-3

Import/Export Configuration Files


There are two configuration files in your project data directory that are read by
Import/Export when it starts up:

The ie_deflds.cfg file contains import field defaults.

The ie_formats.cfg file contains export field formats.

You may modify these configuration files through any text editor, independent of
Import/Export.

Import Field Defaults (ie_deflds.cfg)


The ie_deflds.cfg file in your projects data directory contains information
about default values that Import/Export will assign to point configuration fields when
importing data for new points. This file is a CSV file that uses the SNF format.
An initial version of ie_deflds.cfg is included in your software distribution,
and looks like this:
## Shared Name File
## CIMPLICITY IMPORT/EXPORT -- Default Points Configuration
##
PT_ID, PT_ORIGIN, PT_TYPE, ACCESS, ADDR_TYPE, ALM_CRITERIA,
ALM_ROUTE_OPER, ALM_ROUTE_SYSMGR, ALM_ROUTE_USER, ALM_TYPE,
ANALOG_DEADBAND, CALC_TYPE, CONV_TYPE, ELEMENTS, JUSTIFICATION,
LOCAL, POLL_AFTER_SET, PT_ENABLED, RESET_ALLOWED, SAMPLE_INTV,
SAMPLE_INTV_UNIT, SCAN_RATE, UPDATE_CRITERIA, VARIANCE_VAL, VARS
##
IE_DEV_ANALOG,D,INT,R,FQ,ABS,0,0,0,,0,,NO,1,LEFT,,0,1,0,0,SEC,1,OC,,1
##
IE_DEV_DIGITAL,D,BOOL,R,FQ,,0,0,0,AL,,,,1,LEFT,,0,1,0,0,SEC,1,OC,,1
##
IE_DEV_TEXT,D,STRING,R,FQ,,0,0,0,,,,,1,LEFT,,0,1,0,0,SEC,1,OC,,1
##
IE_VIRT_ANALOG,G,INT,RW,,ABS,0,0,0,,,EQU,,1,LEFT,0,,1,0,0,SEC,,,0,1
##
IE_VIRT_DIGITAL,G,BOOL,RW,,,0,0,0,AL,,EQU,,1,LEFT,0,,1,0,0,SEC,,,0,1
##
IE_VIRT_TEXT,G,STRING,RW,,,0,0,0,,,EQU,,1,LEFT,0,,1,0,0,SEC,,,0,1
##

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
Do not change information in the PT_ID, PT_ORIGIN, or PT_TYPE fields
of records in this file.
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.

27-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Export Field Formats (ie_formats.cfg)


The ie_formats.cfg file in your project data directory defines the Field Names
records you will be using to generate export files. This file is a CSV file that uses the
SNF format. The first field in each record is the name of the format, and the
remaining fields are the field names to be exported when that format is specified.
An initial version of ie_formats.cfg is included in your software distribution,
and looks like this:
##
## CIMPLICITY IMPORT/EXPORT -- Export Format Configuration
##
Full Set, PT_ID, ACCESS, ACK_TIMEOUT, ADDR, ADDR_OFFSET, ADDR_TYPE,
ALM_CLASS, ALM_CRITERIA, ALM_DEADBAND, ALM_DELAY, ALM_HIGH_1,
ALM_HIGH_2, ALM_HLP_FILE, ALM_LOW_1, ALM_LOW_2, ALM_MSG,
ALM_ROUTE_OPER, ALM_ROUTE_SYSMGR, ALM_ROUTE_USER, ALM_STR,
ALM_TYPE, ANALOG_DEADBAND, CALC_TYPE, CONV_LIM_HIGH, CONV_LIM_LOW,
CONV_TYPE, DELETE_REQ, DESC, DEVIATION_PT, DEVICE_ID, DISP_LIM_HIGH,
DISP_LIM_LOW, DISP_WIDTH, ELEMENTS, ENG_UNITS, EQUATION, FW_CONV_EQ,
GR_SCREEN, INIT_VAL, JUSTIFICATION, LOCAL, MAX_STACKED,
MEASUREMENT_UNIT_ID, POLL_AFTER_SET, PRECISION, PROC_ID,
PTMGMT_PROC_ID, PT_ENABLED, PT_ORIGIN, PT_SET_INTERVAL, PT_SET_TIME,
PT_TYPE, RANGE_HIGH, RANGE_LOW, RAW_LIM_HIGH, RAW_LIM_LOW,
REP_TIMEOUT, RESET_ALLOWED, RESET_COND, RESET_PT, RESET_TIMEOUT,
RESOURCE_ID, REV_CONV_EQ, ROLLOVER_VAL, SAFETY_PT, SAMPLE_INTV,
SAMPLE_INTV_UNIT, SCAN_RATE, SETPOINT_HIGH, SETPOINT_LOW, TRIG_PT,
TRIG_REL, TRIG_VAL, UPDATE_CRITERIA, VARIANCE_VAL, VARS
##
Logicmaster Export, PT_ID, ADDR, DESC, PT_TYPE
##

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 all the


fields in the Full Set plus additional
unsupported fields.

Select one of the formats in this file when you export data. If you do not select a
format, an internal format is used.

GFK-1180H

Configuration Import/Export

27-5

Changing Information in ie_formats.cfg


You can modify a current format or add additional export formats to
ie_formats.cfg with a text editor.
To add a new default format to the file:

Do not modify the Full Set or


Logicmaster Export definitions.

1.

Add a new line to the file.

2.

Enter the name of the new format, followed by a comma. Make sure
that the format name is unique.

3.

Enter the list of field names that you want to export. Use a comma to
separate the names.

You can modify an existing format by either adding or deleting field names from its
definition record.

Import/Export Log File


Any errors or warnings incurred by Import/Export will be logged to a file in the
directory pointed to by the logical LOG_PATH, which is typically your projects log
subdirectory.
After importing or exporting data, check the Import/Export Log file for errors. Since
it is an ASCII file, you can use any available text editor to read it. The messages are
self-explanatory, but if you need further information, be sure to check the Status Log
file.

Import/Export Log File Name


The name of the log file is based on the current PRCNAM. The PRCNAM
environment variable must be set. If you do not set the environment variable, you
will get an error message and the utility will exit.
The file will be named IE<prcnam>.log, where <prcnam> is the value assigned
to PRCNAM. Only one user at a time may run with the same PRCNAM, so each
PRCNAM has its own log file. Each time a new session of Import/Export begins, the
log file (IE<prcnam>.log or the default IElog.log) is closed and a new one is
started. The log file is in the directory specified by the logical, LOG_PATH.

Import/Export Log File Format


Every message written to the log file is timestamped and includes the type of message
(error, warning or informational). The date is shown in the first message of the file
and the time appears on each message.
For example, you may see messages that look like the following:
08:30:14 INFO:
Starting application Mar 11 1994.
08:38:15 Warning: Length of point GEF_DEMO_REAL_REAL_LONG_NAME with
prefix xxxxxxxx is too long - truncated
10:29:53 ERROR:
No DEVICE_ID specified for device Point DEMO_COS

27-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

In the above example:

Point IDs may have up to 32


characters

The INFO message tells you when the application (in this case, import)
started.

The WARNING message tells you that the prefix that you are adding to
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.

Importing Configuration Data


Through a PLC programming application or third party software package, you can
create a SNF format file containing point configuration data. Since only a subset of
CIMPLICITY HMI point fields may be contained in the file, you may also need to
modify the ie_deflds.cfg file to specify default values for additional fields.
Once you have configured the ie_deflds.cfg file and created the SNF format
import file, you are ready to use Import/Export to import your configuration data into
the CIMPLICITY HMI point database. When you import the data, you can also
specify filter criteria to be applied to points in the file.
The import function will process each record in the input file. If it finds an invalid
data field, it discards the record and reports the error to a log file, and then continues
processing with the next record in the file.
Any data that exceeds the maximum length of the field it is being imported into is
truncated. This truncation is reported as a warning and does not keep the record from
being imported, unless the resulting truncated data is invalid.

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 projects data subdirectory is recommended.
You should always use the .csv extension with this filename.

GFK-1180H

Configuration Import/Export

27-7

Option names are case sensitive and


must be entered as defined.

The optional arguments for the import command are:


Argument

Description

-D <device_id>

A valid Device ID in the CIMPLICITY HMI database.


For each device point in the import file that does not have
a Device ID, add the Device ID indicated by this
argument.
If no Device IDs are specified in the import file, this
option will set all device points in the import file to the
specified Device ID.
This option will not override Device IDs already present
in the import file. Those IDs will remain unchanged.

-R <resource_id>

A valid Resource ID in the CIMPLICITY HMI database.


For each Point ID in the import file that does not have a
Resource ID, add the Resource ID indicated by this
argument.
If no Resource IDs are specified in the import file, this
option will set all points in the import file to the specified
Resource ID.
This option will not override Resource IDs already
present in the import file. Those IDs will remain
unchanged.

-Pa <prefix>

Add prefix_ to the start of each Point ID in the input


file.

-y

Perform the import in dynamic mode if the project is


running. Allows you to import point information without
restarting the project.

For example:
clie import myfile.csv -R RESOURCE1

imports the point data from MYFILE.CSV and use RESOURCE1 as the Resource ID
for any records that do not have a Resource ID defined.

Importing in Dynamic Mode


Dynamic mode import lets you import point information without shutting down and
restarting a project. To perform an import in dynamic mode you must use the
command line option y as described in the following example:
clie import myfile.csv -y

The CIMPLICITY Login dialog box will ask you to log into the project if you have
not done so.
If you attempt a dynamic import while the project is not running, the import will
continue in static mode and display the following warning message:
Project must be running to use dynamic configuration.

27-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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
## File created at: 15:33:35 on 6/21/95
##
TEST_ANALOG,DOER,FIXER
TEST_DIGITAL,FIXER

GFK-1180H

Configuration Import/Export

Ver.

1.0

27-9

Exporting Configuration Data


When exporting data, you must first determine which points to export and what file
to export them to. You can also specify filter criteria from which a list of points is
created.
You can define formats in ie_formats.cfg and identify which fields to export to
a file. Therefore, it is not necessary to export all the possible fields in every file.
The list of points is automatically exported to the file you specify. You can then edit
the file with a spreadsheet program, simple text editor, etc. After modifying the data,
you can use the Import/Export Utility to import the data back into the CIMPLICITY
HMI point database.

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 projects data subdirectory is recommended.
You should always use the .csv extension with this filename.
Option names are case sensitive and
must be entered as defined.

The optional arguments for the export command are:


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

-Sp <point_id>

A full or partial Point ID.


Export data for Point IDs that match the string you
specify.

27-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

A full or partial Device ID. You can use the * and ?


wildcard characters when specifying a partial Device ID.

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

Specifying Wildcard Characters for Export


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 a list of
resources that start with "M" and end with "X", enter M*X in
the Resource 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
resources whose names are three characters long, and whose
first character is "M" and third character is "X", enter M?X in
the Resource 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.

GFK-1180H

Configuration Import/Export

27-11

Deleting Configuration Data


You can use the clie utility to delete point information from the CIMPLICITY
HMI database.
To delete CIMPLICITY HMI point data, do the following:
1.

Start a command shell in the project from which you want to export
data.

2.

At the system prompt, invoke the following command:

$ clie delete <point_id> [/NOCONFIRM]

where:
<point_id> is the Point ID you want to delete. You can use the wildcard
characters, ? and *, to delete sets of Point IDs.
The optional argument for the delete command is:
Argument

Description

/NOCONFIRM

Deletes the requested points without prompting you to confirm


the deletion.

If you choose to confirm the deletion, you are prompted like this:
> clie delete D?I*
Starting Import/Export - logging to LOG_PATH:IC169.log
Do you want to DELETE <DRIVE_CONVEY1>
(Y)es (N)o (A)ll
y
Do you want to DELETE <DRIVE_CONVEY2>
n
Number of points Deleted = 1
Successful completion - Review LOG_PATH:IC169.log log file for
messages.
>

Specifying Wildcards for Delete


You can use the wildcards as follows:
*

Use this wildcard to search for any number of characters at this


point in the string. For example, if you want to delete all
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 delete all 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 Point ID
string with an asterisk, only those Point Ids that match your request exactly will be
deleted.

27-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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:
All
Device
Global (virtual)
Derived (virtual)
All field names and enumerated data are case-insensitive.

GFK-1180H

Configuration Import/Export

27-13

The optional field names are:


ACCESS

BFR_SYNC_TIME

PT_SET_INTERVAL

ACCESS_FILTER

CALC_TYPE

PT_SET_TIME

ACK_TIMEOUT

CONV_LIM_HIGH

PT_TYPE

ADDR

CONV_LIM_LOW

RANGE_HIGH

ADDR_OFFSET

CONV_TYPE

RANGE_LOW

ADDR_TYPE

DELETE_REQ

RAW_LIM_HIGH

ALM_CLASS

DESC

RAW_LIM_LOW

ALM_CRITERIA

DEVIATION_PT

REP_TIMEOUT

ALM_DEADBAND

DEVICE_ID

RESET_ALLOWED

ALM_DELAY

DISP_LIM_HIGH

RESET_COND

ALM_HIGH_1

DISP_LIM_LOW

RESET_PT

ALM_HIGH_2

DISP_WIDTH

RESET_TIMEOUT

ALM_HLP_FILE

ELEMENTS

RESOURCE_ID

ALM_LOW_1

ENG_UNITS

REV_CONV_EQ

ALM_LOW_2

EQUATION

ROLLOVER_VAL

ALM_MSG

FW_CONV_EQ

SAFETY_PT

ALM_ROUTE_OPER

GR_SCREEN

SAMPLE_INTV

ALM_ROUTE_SYSMGR

INIT_VAL

SAMPLE_INTV_UNIT

ALM_ROUTE_USER

JUSTIFICATION

SCAN_RATE

ALM_STR

LOCAL

SETPOINT_HIGH

ALM_TYPE

MAX_STACKED

SETPOINT_LOW

ANALOG_DEADBAND

MEASUREMENT_UNIT_ID

TRIG_CK_PT

BFR_COUNT

POLL_AFTER_SET

TRIG_PT

BFR_DUR

PRECISION

TRIG_REL

BFR_EVENT_PERIOD

PROC_ID

TRIG_VAL

BFR_EVENT_PT_ID

PTMGMT_PROC_ID

UPDATE_CRITERIA

BFR_EVENT_TYPE

PT_ENABLED

VARIANCE_VAL

BFR_EVENT_UNITS

PT_ORIGIN

VARS

BFR_GATE_COND

27-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

ACCESS
Point Type

Device

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

All

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

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Acknowledge Timeout

Description

Time in minutes before the points alarm is


automatically acknowledged. Valid values are:
-1 = No auto acknowledge
0 = Acknowledge immediately
>0 = Minutes to wait for automatic acknowledge

ADDR

GFK-1180H

Point Type

Device

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.

Configuration Import/Export

27-15

ADDR_OFFSET
Point Type

Device

Maximum Field Length

Integer

CIMPLICITY Field Name

Address Offset

Description

Offset in memory from the first bit of the Point


address. For Analog, APPL, and Text point
types, this field must be zero.

ADDR_TYPE
Point Type

Device

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

All

Maximum Field Length

5 characters

CIMPLICITY Field Name

Alarm Class

Description

The Alarm Class ID to be used for the points


alarms. The Alarm Class ID must already be
defined in the CIMPLICITY database.

ALM_CRITERIA
Point Type

All

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

27-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

ALM_DEADBAND
Point Type

All

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

All

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 SAMPLE_INTV and
SAMPLE_INTV_UNIT.

ALM_HIGH_1
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Warning High

Description

High warning limit

ALM_HIGH_2
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Alarm High

Description

High alarm limit

ALM_HLP_FILE

GFK-1180H

Point Type

All

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

Configuration Import/Export

27-17

ALM_LOW_1
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Warning Low

Description

Low warning limit

ALM_LOW_2
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Alarm Low

Description

Low alarm limit

ALM_MSG
Point Type

All

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

All

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

All

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.

27-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

ALM_ROUTE_USER
Point Type

All

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

All

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

All

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

Device

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

GFK-1180H

Point Type

All

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.

Configuration Import/Export

27-19

BFR_DUR
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Point Buffering Max Duration

Description

The longest time between the first value and last


value buffered for Trending. If left zero, then
duration is not used as a limiting factor when
buffering data.

BFR_EVENT_PERIOD
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name


Description

Not currently implemented

BFR_EVENT_PT_ID
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name


Description

Not currently implemented.

BFR_EVENT_TYPE
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name


Description

Not currently implemented.

BFR_EVENT_UNITS
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name


Description

Not currently implemented.

BFR_GATE_COND
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name


Description

27-20

Not currently implemented.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

BFR_SYNC_TIME
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name


Description

Not currently implemented.

CALC_TYPE
Point Type

Derived (virtual)

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

Device

Maximum Field Length

Integer

CIMPLICITY Field Name

Converted Value (second)

Description

Second converted value used for linear


conversion.

CONV_LIM_LOW

GFK-1180H

Point Type

Device

Maximum Field Length

Integer

CIMPLICITY Field Name

Converted Value (first)

Description

First converted value used for linear conversion.

Configuration Import/Export

27-21

CONV_TYPE
Point Type

Device

Maximum Field Length

2 characters

CIMPLICITY Field Name

Conversion Type

Description

Point EU conversion type. Valid values are:


NO = None
LC = Linear conversion
CS = Custom conversion

DELETE_REQ
Point Type

All

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

All

Maximum Field Length

40 characters

CIMPLICITY Field Name

Description

Description

Description of point

DEVIATION_PT
Point Type

All

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

27-22

Point Type

Device

Maximum Field Length

32 characters

CIMPLICITY Field Name

Device ID

Description

Device where the point data originates. Must be


a configured Device ID.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

DISP_LIM_HIGH
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Disp. Limit (hi)

Description

Largest value to display in CimView screens.

DISP_LIM_LOW
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Disp. Limit (low)

Description

Smallest value to display in CimView screens.

DISP_WIDTH
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Display Width

Description

Number of spaces for display of point value in


CimView.

ELEMENTS
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Elements

Description

Number of discrete elements in the points data


array. This is determined by the points
configured data type.

ENG_UNITS

GFK-1180H

Point Type

All

Maximum Field Length

8 characters

CIMPLICITY Field Name

Eng. Units

Description

Units that the data represents.

Configuration Import/Export

27-23

EQUATION
Point Type

Derived (virtual)

Maximum Field Length

72 characters

CIMPLICITY Field Name

Equation

Description

Specifies how the value is calculated.


If CALC_TYPE is DAC, VAC, AVG, MAX, or
MIN, this field must contain the source Point ID.
If CALC_TYPE is EQU, enter a mathematical
formula, the result of which is the value of this
point. See Equation Operations for the list of
valid operators.

FW_CONV_EQ
Point Type

Device

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

All

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

27-24

Point Type

Derived (virtual)/Global (virtual)

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

JUSTIFICATION
Point Type

All

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

Derived (virtual)/Global (virtual)

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

All

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

MEASUREMENT_UNIT_ID

GFK-1180H

Point Type

All

Maximum Field Length

32 characters

CIMPLICITY Field Name

Measurement Unit ID

Description

The base measurement unit ID configured for the


point.

Configuration Import/Export

27-25

POLL_AFTER_SET
Point Type

Device

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

PRECISION
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Precision

Description

Number of decimal places in display.

PROC_ID
Point Type

Derived (virtual)/Global (virtual)

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

Derived (virtual)/Global (virtual)

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

Device

Maximum Field Length

Boolean

CIMPLICITY Field Name

Enabled

Description

Determines if the point is enabled or disabled.


Valid values are:
0 = Disabled
1 = Enabled

27-26

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

PT_ORIGIN
Point Type

All

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

Device

Maximum Field Length

Time.
The format is HH:MM:SS for the interval,
where:
HH=Hour
MM=Minutes
SS=Seconds

CIMPLICITY Field Name


Description

Interval
The interval at which the Timer/Counter point
will be updated while the Expression value
remains HIGH.

PT_SET_TIME
Point Type

Derived (virtual)

Maximum Field Length

Time.
The format is HH:MM:SS for the base start time,
where:
HH=Hour
MM=Minutes
SS=Seconds

CIMPLICITY Field Name


Description

GFK-1180H

Configuration Import/Export

Set Time
Base start time for the Timer/Counter point
interval.

27-27

PT_TYPE
Point Type

All

Maximum Field Length

16 characters

CIMPLICITY Field Name

Type

Description

Identifies type and length of point data. Must be


a configured point type.

RANGE_HIGH
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Range Limit (hi)

Description

The maximum value allowed for this point.

RANGE_LOW
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Range Limit (low)

Description

The minimum value allowed for this point.

RAW_LIM_HIGH
Point Type

Device

Maximum Field Length

Integer

CIMPLICITY Field Name

Raw Value (second)

Description

Second raw value used for linear conversion.

RAW_LIM_LOW

27-28

Point Type

Device

Maximum Field Length

Integer

CIMPLICITY Field Name

Raw Value (first)

Description

First raw value used for linear conversion.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

REP_TIMEOUT
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Repeat Timeout

Description

Time in minutes before the points 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

All

Maximum Field Length

Boolean

CIMPLICITY Field Name

Reset Allowed

Description

Determines if a user can reset the points alarm.


Valid values are:
0 = User cannot reset the alarm
1 = User can reset the alarm

RESET_COND
Point Type

Derived (virtual)/Global (virtual)

Maximum Field Length

2 characters

CIMPLICITY Field Name

Reset/Startup Cond

Description

Search sequence for source of initial value.


Valid values are:
N = Unavailable
N = Use INIT_VAL
A = Use saved value
I = Saved and init

RESET_PT

GFK-1180H

Point Type

Derived (virtual)

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.

Configuration Import/Export

27-29

RESET_TIMEOUT
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Reset Timeout

Description

Time in minutes before this points alarm is


automatically reset. Valid values are:
-1 = No automatic reset
0 = Reset automatically
>0 = Minutes before automatic reset

RESOURCE_ID
Point Type

All

Maximum Field Length

16 characters

CIMPLICITY Field Name

Resource ID

Description

Resource ID for this point. Must be a configured


Resource ID.

REV_CONV_EQ
Point Type

Device

Maximum Field Length

72 characters

CIMPLICITY Field Name

Reverse Engineering Expression

Description

Arithmetic expression used to convert


engineering units value to raw data for setpoints.
See Equation Operations for the list of valid
operators.

ROLLOVER_VAL

27-30

Point Type

Derived (virtual)

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

SAFETY_PT
Point Type

All

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

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Alarm Delay Interval (value)

Description

For Rate of Change alarms, the frequency with


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

SAMPLE_INTV_UNIT
Point Type

All

Maximum Field Length

3 characters

CIMPLICITY Field Name

Alarm Delay Interval (units)

Description

The type of units for SAMPLE_INTV.


Valid values are:
SEC = Seconds
MIN = Minutes
HR = Hours

SCAN_RATE

GFK-1180H

Point Type

Device

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.

Configuration Import/Export

27-31

SETPOINT_HIGH
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Setpoint Limit (hi)

Description

The maximum value a point is allowed to be set.

SETPOINT_LOW
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Setpoint Limit (low)

Description

The minimum value a point is allowed to be set.

TRIG_CK_PT
Point Type

All

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

Device/Derived (virtual)

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.

27-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

TRIG_REL
Point Type

Device

Maximum Field Length

2 characters

CIMPLICITY Field Name

Relation

Description

Determines how the trigger is evaluated. Valid


values are:
NO = No Trigger
OC = On Change
EQ = Equal
LT = Less Than
GT = Greater Than
LE = Less Than or Equal
GE = Greater Than or Equal

TRIG_VAL
Point Type

Device

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

Device

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

GFK-1180H

Point Type

Derived (virtual)

Maximum Field Length

Number

CIMPLICITY Field Name

Variance value

Description

Accumulator variance value.

Configuration Import/Export

27-33

VARS
Point Type

All

Maximum Field Length

Integer

CIMPLICITY Field Name

Vars

Description

Number of process variables represented by this


point.

Logicmaster 90 Support
Logicmaster fields map to the following field names in the Shared Name File:
Logicmaster
Field

Field Name

reference

ADDR

nickname

PT_ID

description

DESC

length

ELEMENTS

type

PT_TYPE

blockname => add to ADDR string (for example: %Lxxxxx,block).


timer and pid are not supported by CIMPLICITY HMI software at this time.

Sample Logicmaster File


The following is an example of a Logicmaster file:
## Shared Name File Ver. 1.0
## File created by: GE FANUC -- CIMPLICITY Ver.
## File created at: 09:05:30 on 6/22/1993
##
PT_ID,ADDR,DESC,PT_TYPE
##
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
TEMP2,%A00002,Boiler temp thermocouple #2 ,int

27-34

CIMPLICITY HMI Users ManualMarch 1999

3.

Header

}Field Names

Records

GFK-1180H

Using the Alarm Viewer OCX

About the Alarm Viewer OCX


Alarms are used by CIMPLICITY HMI software to call the users attention to
abnormal conditions in the enterprise. Each alarm in CIMPLICITY HMI software is
uniquely identified by its Resource ID, Alarm ID and Reference ID. The Alarm
Viewer OCX control lets users monitor and respond to alarms occurring in your
enterprise from a CimView screen.

Configuration Overview
When you configure Alarm Viewer OCX controls in CimEdit you can:

GFK-1180H

Determine the fields to be displayed.

Configure the button layout and captions.

Create custom buttons and specify their command strings.

Select the projects from which you want users to view alarms.

Determine the initial sort order for the alarm display.

Specify the alarm count layout, date format, fonts, and colors to be
used.

Implement Alarm Viewer methods on the CimEdit screen for the


Alarm Viewer OCX control.

Specify whether the control starts in Static or Dynamic mode.

28-1

Run-Time Overview
At run-time, you can open a CimView screen containing an Alarm Viewer OCX
and:

Display the list in Static or Dynamic mode.

Modify the state of existing alarms.

Record comments about alarm conditions.

View the help files for existing alarms.

Filter the alarm list to display only those alarms that have certain
characteristics.

More about Static Mode


In Static display mode, the Alarm Viewer OCX control presents you with a current
list of alarms when you open the CimView screen. This list remains until you do one
of the following:

Acknowledge or reset alarms that are configured to be deleted on


acknowledge or reset.

Click Refresh to display an updated list of alarms when the alarm


count display changes to the Unseen Alarm Count color.

More about Dynamic Mode


In Dynamic display mode, the Alarm Viewer OCX control presents you with a
current list of alarms when you open the CimView screen. This list is updated
automatically whenever a new alarm in your view is generated or whenever the status
of an existing alarm changes.

28-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring an Alarm Viewer OCX in CimEdit


To configure an Alarm Viewer OCX control in CimEdit, do one of the following:

On the OLE toolbar, click the AMV button.


A new Alarm Viewer OCX 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
OCX control and click the left mouse button to fix it. The Insert
Object dialog box opens.

2.

On the ActiveX page, select CIMPLICITY AMV Control.

3.

Select OK. A new Alarm Viewer OCX control opens at the


position you selected in your CimEdit screen.

The Alarm Viewer OCX control looks like this initially:

GFK-1180H

Using the Alarm Viewer OCX

28-3

Once the Alarm Viewer OCX control is in CimEdit, you may:

Click once on the control to activate its borders. You can now resize
the control or move it using the borders. You can also click the right
mouse button to display and select items from a pop-up menu.

Click outside the control to deactivate its border, and then double-click
on the control to display the CIMPLICITY AMV Control Properties
dialog and configure the Alarm Viewer. You can also click the right
mouse button to display and select items from a pop-up menu.

Configuring Alarm Viewer Control Properties


After you create an Alarm Viewer OCX control on your CimEdit screen, you can
display and change its properties.
To access the CIMPLICITY AMV Control Properties dialog box, you can do one of
the following:

Click outside the control to deactivate its border, and then double-click
the Alarm Viewer OCX control.

Select the Alarm Viewer OCX control, then select CIMPLICITY AMV
Control Object from the Edit menu. This shows a cascading menu.
Select Properties from the cascading menu.

Select the Alarm Viewer OCX control, click the right mouse button,
and then select CIMPLICITY AMV Control Object from the pop-up
menu. This shows a cascading menu. Select Properties from the
cascading menu.

If you do any of the following, you will display the Object Properties dialog box for
the Alarm Viewer OCX control:

From the Edit menu, select Properties.

On the Format toolbar, click the Properties button.

From the pop-up menu displayed when you click the right mouse
button, select Properties.

The CIMPLICITY AMV Control Properties dialog box includes the following tabbed
pages:
Tab
Fields
Buttons
Projects
Sort/Display
Count Layout
Date Format
Fonts
Colors

28-4

Description
Selects the fields you want to display in an alarm message and
the order in which you want to display them.
Changes the button layout and captioning.
Defines the projects the control connects to.
Defines the run-time sort order and display options.
Selects the count information to be displayed and the order and
orientation in which to display it.
Chooses how the date and time will be displayed in alarm
messages.
Selects the font type, style and size used for alarm, button,
count, date, and status text.
Defines the colors used by all elements in the control.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Fields
Use the Fields properties to select the fields you want to display in alarm messages
and the order in which you want to display them.

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").
Select the check box for each field you want to display.
Once you select a field, you can:

Use Row Up and Row Down to configure its row in the alarm
message.

Use Position Left and Position Right to configure its column


position in the row.

Use Modify to configure its length and title in the Alarm Viewer OCX.

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.

GFK-1180H

Using the Alarm Viewer OCX

28-5

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.

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.

28-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Buttons
Use the Buttons properties to change the button layout and captioning used for the
Alarm List.

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.

Select the check box for each button you want to use.
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:

GFK-1180H

Button

Description

Help

Displays the help file for an alarm. See page 28-23 for more
information.

Setup

Displays the Alarm Setup dialog. See page 28-23 for more
information.

Refresh

Updates the alarm list. See page 28-23 for more information.

View Stack

Displays the stacked alarms for the selected alarm. See page
28-24 for more information.

Comments

Displays the Alarm Comments dialog. See page 28-24 for


more information.

Toggle

Toggles the display between the Static and Dynamic alarm


lists. See page 28-23 for more information.

Ack

Acknowledges the currently selected alarms. See page 28-25


for more information.

Using the Alarm Viewer OCX

28-7

Reset

Resets the currently selected alarms. See page 28-26 for more
information.

Delete

Deletes the currently selected alarms. See page 28-26 for


more information.

Ack and Reset

Acknowledges and resets the currently selected alarms. See


page 28-26 for more information.

Ack First

Acknowledge first alarm in the alarm list. See page 28-27 for
more information.

Ack All

Acknowledge all alarms in the alarm list. See page 28-27 for
more information.

CimView Screen

Displays the CimView screen associated with the currently


selected alarm. See page 28-25 for more information.

Custom1-8

Lets you define up to eight custom buttons that you can use to
integrate external applications with the Alarm Viewer. See
page 28-20 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 select a button, you can:

Use Row Up and Row Down to configure its row in the button pane.

Use Position Left and Position Right to configure its position in the
row.

Use Modify to configure its caption and description. If you are


configuring a custom button, you can also configure its command
string.

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.

28-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Modify
Select the Alarm List button that you want to modify, then click Modify. The Button
Caption dialog box opens.

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.

GFK-1180H

Using the Alarm Viewer OCX

28-9

Projects
Use the Projects properties to select the projects from which you want to view
alarms.

You can add projects to the list, remove projects from the list, connect to the local
project and specify the alarm setup for each project in the list.

Adding a Project
To add a project to the list:
1.

Click Add Project. The Select Project dialog box open.

2.

In the Select Project dialog box opens, select the project you want from
the list of available projects.

3.

Click OK. The Select Project dialog box closes and the project is
added to the list in the Projects properties.

Deleting a Project
To delete a project from the list:
1.

Select the project from the list.

2.

Click Delete Project.

3.

When you are asked to verify the deletion, click OK.

Connecting to a Local Project


To connect to the local project, select the Connect to Local Project check box.
When a user opens the CimView screen containing this Alarm Viewer OCX control,
the control automatically connects to the currently running local project and opens
the CIMPLICITY Login dialog box for user login.

28-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Selecting a Default Alarm Setup


The default alarm setup applies to all users displaying the CimView screen containing
this Alarm Viewer OCX control. To specify an alarm setup for a project in the list:
1.

Double-click on the project name in the list. The Project Settings


dialog box opens.

2.

Enter the Alarm Setup filter name you want to use in the Alarm setup
field.

3.

Click OK to close the Project Settings dialog box and return to the
Projects properties.

Sort/Display
Use the Sort/Display properties to define the sort order of alarms, and toggle the
display of the field titles, status box, and beginning display mode. You can also
enable/disable access to the popup runtime context menu via the right mouse button,
and enable/disable primary sort key changes with the left mouse button in the title bar
area.

GFK-1180H

Using the Alarm Viewer OCX

28-11

You can define the following:

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 option button if you want to sort the primary key in
ascending order.

Descending

Select this option button if you want to sort the primary key in
descending order.

For the secondary sort key:

28-12

Then

Click the drop-down list button to the right of the input field
and select the secondary sort key.

Ascending

Select this option button if you want to sort the primary key in
ascending order.

Descending

Select this option button if you want to sort the primary key in
descending order.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 sort criteria you want from the drop-down list boxes, and choose a desired
direction with the corresponding radio buttons.
If you select Allow title bar sort changes, run-time users can click on a field in
the title bar to sort the list of alarms by that criteria.

GFK-1180H

Using the Alarm Viewer OCX

28-13

Display
You can toggle the display of the following:
Field Titles

Select this check box to display the field titles at the top of the
alarm list.
Clear the check box to eliminate the display.

Status Box

Select this check box to display project status information.


Clear the check box to eliminate the display.

Begin in Static

Select this check box to begin the Alarm Viewer display in


Static Display mode.
Clear the check box to begin the display in Dynamic Display
mode.

Allow Runtime Popup Menu


Select the Allow runtime popup menu check box if you want users to access the
run-time popup menu. If you clear this check box, the run-time popup menu is
disabled.

Allow Title Bar Sort Changes


Select the Allow title bar sort changes check box if you want users to be able to
click on a field in the title bar to sort the list of alarms.
When a user clicks on the column title at run-time:

28-14

If the column selected is not currently the primary key, it will be


selected as the primary key.

If the column selected is already the primary key, the direction of the
sort will be reversed.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Count Layout
Use the Count/Layout properties to select the alarm count information to be
displayed and the order and orientation in which to display it.

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 lefthand corner of the Alarm Viewer.

Select the Top of Screen check box to display the alarm information
in the upper left corner of the Alarm Viewer.

Select 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 option button to display the alarm count


information fields side by side in the order you specify.

Select the Vertical option button to display the alarm count


information fields one on top of the other in the order you specify.

Fields
You can choose whether or not to display:

Alarm count
Alarm date
Alarm time

Use the Move Up and Move Down buttons in this area to order the count, date,
and time display to your liking.

GFK-1180H

Using the Alarm Viewer OCX

28-15

Date Format
Use the Date Format properties to choose how the date and time will be displayed in
alarm messages.

You can define the following:

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.

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.

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.

28-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Minutes with no leading zero.

MM

Minutes with leading zero.

Seconds with no leading zero.

SS

Seconds with leading zero.

TT

Hundredths of seconds with leading zeros.

Thousandths of seconds with no leading zero.

TTT

Thousandths of seconds with leading zeros.

P, A, p, or a

AM/PM indicator.

For example, if you enter HHHH:MM:SS:TTT p, the sample time will be


13:05:06:085 PM.
You may use colons, spaces or any other delimiter of your choice to separate the date
fields.

GFK-1180H

Using the Alarm Viewer OCX

28-17

Fonts
Use the Fonts properties to change the font type, style and size used for text displays
in the Alarm List.

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:

28-18

1.

Select the text you want to change.

2.

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

Click OK to save your changes or click Close to close the Font dialog
box and return to the CIMPLICITY AMV Control Properties dialog
box.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Using the Alarm Viewer OCX

28-19

Creating Custom Buttons


If you wish to integrate an external application with the Alarm Viewer OCX control,
you can configure a custom button in your Alarm Viewer OCX control. When a user
selects an alarm, then clicks on this button, the application launches with the
parameters that you configured.
To configure a custom button:
1.

Select the button on the Button Layout properties.

2.

Click Modify....

3.

In the Command: field, enter the command line you wish to execute
when the button is pressed.

4.

Click OK.

You may include any of the following parameter, which will be substituted with
characteristics of the selected alarm, in your command:
Parameter

Value

%DATETIME

Alarm Generation date and time

%DT

same as %DATETIME

%DATE

Alarm Generation date

%TIME

Alarm Generation time

%ID

Alarm Identifier of the selected alarm

%CLASS

Alarm class of the selected alarm

%RESOURCE

Factory resource of the selected alarm

%RES

same as %RESOURCE

%REFERENCE

Alarm reference identifier for the selected alarm

%REF

same as %REF

%MESSAGE

Alarm message for the selected alarm

%MSG

same as %MESSAGE

%STATE

Current alarm state of the selected alarm

%ACK

"Y" or "N", if selected alarm is acknowledged

The following additional parameters do not require the user to select an alarm:

28-20

Parameter

Value

%%

An embedded percent sign

%USER

User ID of the user invoking the command

%PRODUCT

CIMPLICITY HMI distribution directory

%CIM

same as %PRODUCT

%DIRECTORY

CIMPLICITY HMI project directory

%DIR

same as %DIRECTORY

%PROJECT

CIMPLICITY HMI project name

%PRJ

same as %PROJECT

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Example
By default, 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.

Click Modify to open the Button Caption dialog box.

3.

Type Notes... in the Button Caption field.

4.

Type Edit Alarm notes for a selected alarm in the


Description field.

5.

Type NOTEPAD %DIR\NOTES\%ID.TXT in the Command String


field.

The completed dialog box looks like this:

When a user clicks this button, a new Notepad window opens 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.

GFK-1180H

Using the Alarm Viewer OCX

28-21

Viewing the Alarm List


After you have configured a CimEdit screen with an Alarm Viewer OCX control,
you can use CimView to open the screen and display alarms.
You can use the buttons at the bottom of the alarm list to perform various other
functions.
Throughout this document, buttons are In general, the Alarm List buttons are activated as follows:
referred to by their default captions.
You may have defined other captions
The Setup, Refresh, and Toggle buttons, if defined, are available at
for some or all of your Alarm List
all times if they have been configured on your Static display.
buttons, but the functions they perform
The Help, View Stack, Comments, Ack, Reset, Delete, Ack and
do not change.

Reset, and CimView Screen buttons, if defined, are only active


when you select an alarm from the list.

The Ack First and Ack All buttons are active if any alarms are
displayed.

Selecting Alarms from the List


There are several ways for you to select one or more alarms from the list:

28-22

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

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using the Alarm List Buttons


When you use the Alarm List buttons:

If you click on an active button, the action associated with the button
executes.

If you click on a disabled button, nothing happens.

If you move your mouse off the Alarm Viewer button without releasing
the mouse button, the action associated with the Alarm Viewer button
will not be invoked.

Changing the Setup Parameters


Normally, all alarms for the roles assigned to your CIMPLICITY User ID are
displayed in the Alarm Viewer OCX control. There are times, however, when you
want to display certain subsets of alarms. This is called alarm filtering.
Alarm filters are set up through the Alarm Setups dialog box. The filtering options
let you filter alarms by:
Alarm Class
Resource ID
Time
Alarm State
You may select one or more of these options to filter the alarm list. When you click
Setup, the Alarm Setups dialog box opens. For more information, see page 28-28

Refreshing the Alarm List


Click Refresh to update the Static Alarm list with the latest alarms.

Toggling Between Lists


Click Toggle to switch between the Static Alarm list and the Dynamic Alarm list.
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.

Displaying User Help


To display help information for an alarm:
1.

Click the alarm in the list.

2.

Click Help.

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.

GFK-1180H

Using the Alarm Viewer OCX

28-23

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 alarms 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. For example:

To view an alarms 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.

Viewing Alarm Comments


Up to twenty (20) comments can be associated with a current alarm. A comment is
several lines of text that can be entered by any user that can view the alarm.
Comments are available for viewing until the alarm is deleted from the system, unless
the Store alarm comments configuration option has been selected.
If an alarm has comments, and the Comments field is being displayed, you will see
the letter C in the Comment field. For example:

To view an alarms comments:


1.

Click the alarm in the list.

2.

Click Comments.

The Alarm Comments dialog box opens. You can use this dialog box to view the
current list of comments, add comments, or delete comments.
Click Done to close the Alarm Comments dialog box.
If you are adding comments for the first time to a Static alarm list, click Refresh to
update the list and display the letter C in the Comment field.

28-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Adding Alarm Comments


To add a comment to the comment list:
1.

Click Add Comment. The Add Comment dialog box opens.

2.

Enter your comment in the input field.

3.

When you are through, click OK to close the dialog box and return to
the Alarm Comments dialog box.

Your comment now appears at the top of the list of comments along with the time
and date that the comment was entered.

Deleting Alarm Comments


To delete a comment from the comment list:
1.

Click on the comment you want to delete.

2.

Click Delete Comment.

Note that you need the Delete Alarms privilege to use the Delete Comment
button.

Viewing the Alarms CimView Screen


When an alarm (or point) is configured, it can be associated with a CimView screen.
Click CimView Screen to display the CimView screen defined for the alarm.
If no screen is defined for the alarm, an appropriate message will be displayed.

Acknowledging an Alarm
You can acknowledge an alarm to inform other users that you have seen the alarm
and, if necessary, are working on resolving the condition that set off the alarm.
If an alarm is not listed as acknowledged, the condition may still exist and should be
investigated.
To acknowledge an alarm (or a group of alarms):
1.

Select the alarm(s).

2.

Click Ack.

When you acknowledge an alarm, its acknowledge state changes from N to Y. The
alarm remains in the alarm list until its deletion requirements have been met.

GFK-1180H

Using the Alarm Viewer OCX

28-25

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 generated again
until the condition that triggered the alarm returns to within its acceptable limits and
then goes back out of the acceptable limits.
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. The alarm
remains in the alarm list until its deletion requirements have been met.

Deleting an Alarm
Deletion requirements are defined
during alarm configuration.

Normally, alarms are automatically deleted when their deletion requirements have
been met. An alarm will have one of the following deletion requirements:

Acknowledge

Reset

Acknowledge and Reset

If your CIMPLICITY User role has 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.

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 generated again until the condition that triggered the alarm returns
to within its acceptable limits and then goes back out of the acceptable limits.
To simultaneously acknowledge and reset an alarm (or a group of alarms):
1.

Select the alarm.

2.

Click Ack and Reset.

When you acknowledge and reset an alarm, it will be removed from the alarm list.

28-26

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Acknowledging the First Alarm


You can acknowledge the first alarm in the alarm list. To do this:

Click Ack First.

The alarms acknowledge state changes from N to Y. The alarm remains in the alarm
list until its deletion requirements have been met.

Acknowledging All Alarms


You can acknowledge all alarms currently in the alarm list. To do this

Click Ack All.

The acknowledge state of all the alarms on the list changes from N to Y. Alarms
remain in the alarm list until their deletion requirements have been met.

GFK-1180H

Using the Alarm Viewer OCX

28-27

Filtering Alarms
You can click the Setup button to open the Alarm Setups and filter alarms. Alarm
filtering lets you look at particular groups of alarms on your alarm list. The Alarm
Setup options let you:

Select a setup for a project in the Alarm List display.

Modify the current setup.

Save the current setup.

Create a new setup.

Delete setups from the list.

Declare one of the setups to be the default setup.

To initiate alarm filtering, click Setup.

When the Alarm Setups dialog box opens, the first project in the list of projects
whose alarms you are monitoring displays in the Project field, and its current setup
displays in the Setup field.
Note
After you open the CimView screen containing the Alarm Viewer OCX control, the
first time you open the Alarm Setups dialog box, the current Setup for each project
is the default setup.
For more information on default alarm setups, see page 28-35.

28-28

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The list of setups you can use to filter the projects you are monitoring is displayed
below the Setup field. There are three types of alarm setups:
<<UNFILTERED>> This is the standard default setup. When it is loaded, a user
can view all alarms available to the users CIMPLICITY HMI
User ID.
Project setups

Setups that start with the "$" character are project setups.
Project setups can be loaded and modified by any user logged
in to the project. However, the users role must have the
Modify Alarm Setups privilege to save or delete project
setups.

User setups

Setups that do not start with the "$" characters are only
available to users that log in with the same CIMPLICITY HMI
User ID as the user that created them. These users can modify,
save and delete the setups.

To close the dialog box and return to the Alarm List display, click Done.

Specifying a Default Setup for a Project


If you are connecting to more than one project in the Alarm Viewer OCX control,
you can set a default Setup for each project on the Projects property page in the
CIMPLICITY AMV Control Properties dialog box.
See page 28-10 for details on how to do this.

Loading an Alarm Setup


To load an alarm setup:
1.

Click on the setup in the list that you want to use. The setup name
displays in the Setup field.

2.

Click Load.

The alarm setup loads and the Alarm List is refiltered and redisplayed.
Note
You must load a filter in order to modify it.

GFK-1180H

Using the Alarm Viewer OCX

28-29

Modifying the Current Alarm Setup


When you click Modify Current, the Modify Setup dialog box opens.
You can modify the classes, resources, time filter, and state filter of the current alarm
setup.

Modifying the Setup Class List

The Classes properties displays the list of current alarm classes and indicates which
ones are used in the alarm setup.
Select 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. You
can also:

28-30

Click Add All to select all classes.

Click Remove All to clear all classes.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Modifying the Alarm Setup Resource List

The Resources properties displays the list of current resources, and indicates which
ones are used in the alarm setup.
Select 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. You can also:

GFK-1180H

Click Add All to select all resources.

Click Remove All to clear all resources.

Using the Alarm Viewer OCX

28-31

Modifying Alarm Setup Time and State Filters

The Time and State filter properties display the current status of the Time and State
filters for the alarm setup.
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
Status

Description

Alarm

Display points in alarm state that have not been acknowledged.

Alarm

Display points in alarm state that have been acknowledged.

Normal

Display points that have returned to a normal state, but have


not been acknowledged.

Select the check box for each state you want to include in the alarm setup.

28-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Saving the Current Setup


To modify and save an existing alarm setup:
1.

Select the alarm setup from the list, or use the current alarm setup.

2.

If the alarm setup you want to use is not the current alarm setup:
A. Click Load.
The alarm setup loads and the Alarm Setups dialog box closes.
B. Click Setup again to reopen the Alarm Setups dialog box.

3.

Click Modify Current.

4.

Use the Modify Setup dialog box to set your new filter options

5.

Click OK.

Creating A New Alarm Setup


To create a new alarm setup:
1.

Select the alarm setup you want to use as the basis for your new alarm
setup, or use the current alarm setup.

2.

If the alarm setup you want to use is not the current alarm setup:
A. Click Load.
The filter loads and the Alarm Setups dialog box closes.
B. Click Setup again to reopen the Alarm Setups dialog box.

3.

Click Modify Current.

4.

Use the Modify Setup dialog box to set your new alarm setup options.

5.

Click OK.

6.

On the Alarm Setups dialog box, enter the new alarm setup name in the
Setup field.

7.

If you have the Modify Alarm Setups privilege, you can create a
project setup or a user setup. If you do not have the privilege, you can
only create a user setup.

8.

Click Save.

The new alarm setup will be added to the list of available setups.

GFK-1180H

Using the Alarm Viewer OCX

28-33

Deleting an Alarm Setup


To delete an alarm setup from the list:
1.

Click the setup name in the list in the Alarm Setups dialog box. The
name will appear in the Setup field.
If you have the Modify Alarm Setups privilege, you can delete
project and user setups. If you do not have the privilege, you can only
delete your user setups.

2.

Click Delete. The alarm setup will be removed from the list of
available setups.

Declaring a Default Alarm Setup


When you install CIMPLICITY
software, the default alarm setup is
<<UNFILTERED>>.

You can select a default alarm setup in the Alarm Setups dialog box. This default
alarm setup will be used if:

No default alarm setup for the project is defined in the CIMPLICITY


AMV Control Properties dialog box.

The default alarm setup for the project in the CIMPLICITY AMV
Control Properties dialog box does not exist in your Alarm Setups list.

To declare a default alarm setup:


1.

Click on the alarm setup in the list in the Alarm Setups dialog box.

2.

Click Make Default.

For more information on default alarm setups, see page 28-35.

28-34

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using Default Alarm Setups


When you configure an Alarm Viewer OCX control in CimEdit, you can select a
default alarm setup for the project in the Projects property page of the CIMPLICITY
AMV Control Properties dialog box. This default alarm setup applies to all users that
open the CimView screen.
When you view an Alarm Viewer OCX control in CimView, you can use the Setup
button to create project and user alarm setups for a project. You can also select one
of those setups to be the default setup for the project. This default alarm setup
applies to all users that open the CimView screen with your CIMPLICITY User ID.
The default alarm setup that is used when a user opens the CimView screen depends
on the following:
1.

If an alarm setup was specified for the Alarm Viewer on the Projects
property page of the CIMPLICITY AMV Control Properties dialog box,
and if the alarm setup exists in the Alarm Setups list for the users
CIMPLICITY User ID, then it is used as the default alarm setup
whenever the user opens the CimView screen.

2.

If an alarm setup was specified for the Alarm Viewer on the Projects
property page of the CIMPLICITY AMV Control Properties dialog box,
and the alarm setup does not exist in the Alarm Setups list for the users
CIMPLICITY User ID, then:

3.

GFK-1180H

If a default setup for the project is defined in the Alarm Setups


dialog box for the CIMPLICITY User ID, then that default setup is
applied to the alarm list for the project.

If no default setup is defined for the project in the Alarm Setups


dialog box, then no filtering is applied to the alarm list for the
project.

If no alarm setup was specified for the Alarm Viewer on the Projects
property page of the CIMPLICITY AMV Control Properties dialog box,
then:

If a default setup is defined for the project in the Alarm Setups


dialog box for the CIMPLICITY User ID, then that default setup is
applied to the alarm list for the project.

If no default setup is defined for the project in the Alarm Setups


dialog box, then no filtering is applied to the alarm list for the
project.

Using the Alarm Viewer OCX

28-35

Alarm Viewer Methods

About Alarm Viewer Methods


The Alarm Viewer methods operate on Alarm Viewer OCX controls in a CimView
screen. They give you access to the button functions used by the control so that you
can invoke the button functions from other objects on your CimView screen.
To implement an Alarm Viewer method, you need to:

Name the Alarm Viewer OCX control you want to use for the method.

Create an Invoke Method action for the screen object and select the
Alarm Viewer method you want to invoke.

When a user clicks on the object at run-time, the button function executes.

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.

GFK-1180H

29-1

Creating an Invoke Method Action


You can create an Invoke Method action for any object or group for which you can
define procedures in your CimEdit screen.
When you select the Invoke Method action, the center of the dialog box changes to
look like this:

You will need to enter information in the following fields:


Control name

Select the named Alarm Viewer control for which you


want to invoke the method.

Method

Select the method you want to implement.

Confirmed

This feature is currently not implemented.

None of the Alarm Viewer methods use the advanced features of method invocation.
Therefore, the Advanced... button is disabled for all Alarm Viewer methods.

Alarm Viewer Methods


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

29-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 in the CIMPLICITY Alarm Viewer controls
alarm list. 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 CIMPLICITY Alarm Viewer controls
alarm list. 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.

DoAckReset Method
This method acknowledges and resets the currently selected alarm(s) in the alarm list
on the CIMPLICITY Alarm Viewer control. It is equivalent to the Ack and Reset
button in the Alarm Viewer control.
When you configure the DoAckReset 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.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
When you configure the DoCimviewScreen method, the Advanced... button is
not activated because no further parameters are required for this method.

GFK-1180H

Alarm Viewer Methods

29-3

DoComments Method
This method opens the Alarm Comments dialog box for the currently selected alarm
in the CIMPLICITY Alarm Viewer controls alarm list so that users can view, add, or
delete comments for the alarm. It is equivalent to the Comments button in the
Alarm Viewer control.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
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 controls alarm list. It is equivalent to the Help
button in the Alarm Viewer control.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
When you configure the DoHelp method, the Advanced... button is not activated
because no further parameters are required for this method.
Important: The DoHelp Method only works in static mode. It does not work in
dynamic mode.

DoRefresh Method
This method refreshes Static Alarm list in the CIMPLICITY Alarm Viewer control
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.

29-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

DoReset Method
This method lets a user reset the currently selected alarm(s) in the CIMPLICITY
Alarm Viewer controls alarm list. It is equivalent to the Reset button in the Alarm
Viewer control. A reset alarm will not be generated 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 CIMPLICITY 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.
At run-time, the user must select only one alarm for this method to work. If the user
selects more than one alarm, the method will not execute.
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 highlights the next alarm in the CIMPLICITY Alarm Viewer controls
alarm list. If the current alarm is the last alarm on the page but not the last in the list,
this method moves the list up to highlight the next alarm. It is equivalent to the down
arrow on a users keyboard.
When you configure the MoveDownOneAlarm method, the Advanced... button
is not activated because no further parameters are required for this method.

GFK-1180H

Alarm Viewer Methods

29-5

MoveUpOneAlarm Method
This method highlights the previous alarm in the CIMPLICITY Alarm Viewer
controls alarm list. If the current alarm is the first alarm on the page but not the first
alarm in the list, this method moves the list down to highlight the previous alarm. It
is equivalent to the up arrow on a users keyboard.
When you configure the MoveUpOneAlarm 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 CIMPLICITY Alarm Viewer controls
alarm list, this method displays the next page of alarms. It is equivalent to the Page
Down button on the users 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 CIMPLICITY Alarm Viewer controls
alarm list, this method displays the previous page of alarms. It is equivalent to the
Page Up button on the users 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 CIMPLICITY Alarm Viewer controls alarm
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 in the CIMPLICITY
Alarm Viewer control.
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 from the current page displayed in the
CIMPLICITY Alarm Viewer control 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.

29-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using the Stand-Alone Alarm


Viewer

About the Stand-Alone Alarm Viewer


Alarms are used by CIMPLICITY HMI software to call the users attention to
abnormal conditions in the enterprise. Each alarm in CIMPLICITY HMI software is
uniquely identified by its Resource ID, Alarm ID and Reference ID. You can use the
stand-alone CIMPLICITY Alarm Viewer to monitor and respond to alarms occurring
in your enterprise.
You can:

Configure alarm views.

Display current alarms.

Modify the state of existing alarms.

Enter comments about an existing alarm.

Receive instructions on how to resolve alarm conditions.

Filter the alarm list to display only those alarms that have certain
characteristics.

You can use the stand-alone CIMPLICITY Alarm Viewer to display alarms in two
modes:

Static display mode

Dynamic display mode

In Static display mode, when you open a CIMPLICITY Alarm Viewer document, you
are presented with a current list of alarms. This list remains in the window until you:

Acknowledge or reset alarms that are configured to be deleted on


acknowledge or reset.

Click Refresh to display an updated list of alarms when the alarm


count changes to the Unseen Alarm Count color.

In Dynamic display mode, the alarm display is updated automatically whenever a


new alarm in your view is generated or when the status of an existing alarm changes.

GFK-1180H

30-1

Configuring a Stand-Alone Alarm Viewer


To display alarms, double-click the Alarm Viewer icon from your projects cabinet.
When you select the Alarm Viewer icon, the initial CIMPLICITY Alarm Viewer
window opens.

You can use the Menu functions, Toolbar buttons, and shortcut keys to:

30-2

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm Viewer Menus


You can use the menu options to access Alarm Viewer configuration files, copy
alarms from the CIMPLICITY Alarm Viewer window to the Clipboard, toggle the
display of the Toolbar and Status bar, configure a new Alarm Viewer screen, and
access Help.

The File Menu


The File menu functions are:
New

Creates a new Alarm View.

Open

Opens an Alarm Viewer screen in your currently active


CIMPLICITY Alarm Viewer window.

Save

Saves the current Alarm View.

Save As

Saves the current Alarm View. Use this menu item when you
want to specify the pathname of the saved file.

Install

Installs an Alarm Viewer icon for the Alarm View in the


program group of your choice. The name under the icon will
be the name of the Alarm View.

Print

Prints the current Alarm View.

Print Preview

Displays the current Alarm View in print format.

Print Setup

Defines the printer, page size, and orientation for your print
requests.

Exit

Exits the CIMPLICITY Alarm Viewer.

The Edit Menu


The Edit menu functions are:
Copy

Copies the alarms you select to the Clipboard.


You can then paste the alarm information in another
application such as a mail message, or a Microsoft Word
document.

The View Menu


The View menu functions are:
Toolbar

Enables/disables the display of the Toolbar buttons at the top


of the CIMPLICITY Alarm Viewer window.

Status Bar

Enables/disables the display of the Status bar at the bottom of


the CIMPLICITY Alarm Viewer window.

The Login! Menu


When you select the Login! menu, the CIMPLICITY Login dialog box opens. Use
this dialog box to log in to a project and display its alarms.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-3

The Configure Menu


The Configure menu functions are:
Count Layout

Opens the Alarm Count Configuration dialog box. This


dialog box lets you determine how alarm count information
will be displayed in an Alarm Viewer screen.

List Layout

Opens the Alarm List Configuration dialog box. This dialog


box lets you determine how the information for individual
alarms will be displayed in an Alarm Viewer screen.

The Help Menu


The Help menu functions are:
Index

Opens the Help Search dialog box.

Using Help

Opens the Help Contents window for Alarm Viewer.

About AMV

Displays the version number and copyright information for the


CIMPLICITY Alarm Viewer.

Alarm Viewer Toolbar Buttons


The Toolbar buttons available to you are:
New

Creates a new alarm view document.

Open

Opens an existing alarm view document.

Save

Saves the current alarm view document

Copy

Copies the selection and put it on the Clipboard.

Print

Prints the active alarm view document.

Help

Displays Help for clicked on buttons, menus and windows.

Alarm Viewer Shortcut Keys


You can use the following shortcut keys to initiate commonly used functions:

30-4

Ctrl+N

Creates a new Alarm Viewer screen.

Ctrl+O

Opens an Alarm Viewer screen.

Ctrl+S

Saves the current Alarm Viewer screen.

Ctrl+P

Prints the current window.

Ctrl+C

Copies the alarms you select to the Clipboard.

F1

Opens the Help window

Alt+Spacebar

Displays the Control menu.

Alt+Print Screen

Captures the current window to the clipboard.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring an Alarm View


When you configure a CIMPLICITY Alarm Viewer document, you must enter
information for the Alarm Count layout, and the Alarm List layouts for the Static
Alarm list and the Dynamic Alarm list.
To configure the Alarm Count, select Count Layout from the Configure menu.
To configure the Static and Dynamic Alarm lists, select List Layout from the
Configure Menu.

Defining the Alarm Count Layout


The Alarm Count display tells you how many alarms have been generated, and the
time and date of the most recently generated alarms. You have complete flexibility
on how to display this information on the Alarm Viewer screen.
Use the Alarm Count Configuration dialog box to select:

The layout of the count information

The colors in which to display the text

The font type and size of the display

Configuring the Count Layout


Use the Layout properties to select the count information to be displayed and the
order and orientation in which to display it.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-5

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 or not 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.

30-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring the Count Color


Use the Colors properties to change the colors for the unseen and seen alarm counts.

You can define the following colors for the alarm count display:
Unseen Alarm Count The color of the alarm count when new alarms are
generated and you have not yet viewed them.
Seen Alarm Count

The color of the alarm count after you have viewed the
current set of alarms.

Background

The background color for the alarm count display.

Click Color... to use the Color dialog box to select the color you want for the
display.
Note
If you select a dithered color, its solid component will be used, not the color you
selected. To see the components of a dithered color, click Define Custom
Colors>> in the Colors dialog box.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-7

Configuring the Count Font


Use the Fonts properties to change the font type, style, and size for the count and for
the date/time fields.

You can define the following:


Count Font
The current font name and size are displayed. To change the count font, click
Font... to display the Font dialog box. Use the dialog box to configure the font
type, style, and size to be used for the count field.
Date/Time Font
The current font name and size are displayed. To change the date/time font, click
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.

30-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Defining the Alarm List Layout


Use the Alarm List Configuration dialog box to configure the Alarm List for the
Static Alarm list and the Dynamic Alarm list. You can decide which fields to
display, and the order in which to display them, the list background color, the text
font, and which action buttons to display, and the order in which to display them.

Selecting Alarm List Fields


Use the Fields properties to select the fields you want to display in each alarm
message and the order in which you want to display them.

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

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-9

Static Alarm Fields


After you select Static, 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.
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.

30-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-11

Selecting Alarm List Color and Font


Use the Color and Font properties to change the font type, style, and size used for
the Alarm List.

Font
The current font name and size are displayed. To change the alarm list font, click
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, click Color... to display the Color dialog box. Use the dialog box to
configure the background color you want for the alarm list.

30-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-13

You will need to use the vertical scroll bar to the right of the table to see all of the
buttons. The following is a complete list:

30-14

Button

Description

Help

Displays the help file for an alarm. See page 30-24 for more
information.

Setup

Displays the Alarm Setup dialog box. See page 30-24 for
more information.

Refresh

Updates the alarm list. See page 30-24 for more information.

View Stack

Displays the stacked alarms for the selected alarm. See page
30-25 for more information.

Comments

Displays the Alarm Comments dialog box. See page 30-25 for
more information.

Toggle

Displays the Dynamic Alarm list. See page 30-24 for more
information.

Ack

Acknowledges the current alarm. See page 30-26 for more


information.

Reset

Resets the current alarm. See page 30-26 for more


information.

Delete

Deletes the current alarm. See page 30-26 for more


information.

Ack and Reset

Acknowledges and resets the current alarm. See page 30-27


for more information.

Ack First

Acknowledge first alarm. See page 30-27 for more


information.

Ack All

Acknowledge all alarms. See page 30-27 for more


information.

CimView Screen

Displays the CimView screen associated with the alarm. See


page 30-26 for more information.

Custom1-8

Lets you define up to eight custom buttons that you can use to
integrate external applications with the Alarm Viewer. See
page 30-20 for more information.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 30-24 for more
information.

Setup

Displays the Alarm Setups dialog box. See page 30-24 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.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-15

Modify
Select the Alarm List button that you want to modify, then click Modify. The
Button Caption dialog box opens.

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.

30-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

You must choose a connection mode. Window placement is optional.


Connection
These option buttons let you select the type of system connection to be made when a
user requests the Alarm Viewer screen. Select one of the following:
Connect to Local Project
Always connects to the node on which the user is running.
Browse for project when connecting
The user is presented with a dialog box that can be used to select the project to
when Alarm Viewer is to be connected.
Select project now
Enter the project to which Alarm Viewer will connect when it displays this
Alarm List.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-17

Window Placement
If you do not select these options, other Use these check boxes to define what happens to the Alarm Viewer window when
windows may overwrite the window,
new alarms are received. Your choices are:
and it will not pop to the top when new
alarms are received.
Always On Top

Select this check box if you want the window to always be on top of other
windows.
Pop to Top on new Alarms
Select this check box if you want the window to redisplay on top of other
windows when new alarms are received.

Alarm Message Date/Time Format


Use the Date/Time Format properties to choose how the date and time will be
displayed in alarm messages.

30-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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
mm
mmm
mmmm
d
dd
ddd
dddd
y
yy
yyyy

Numeric month with no leading zero.


Numeric month with leading zero.
Short text month.
Long Text month.
Numeric day with no leading zero.
Numeric day with leading zero.
Short text day of the week.
Long text day of the week.
Last two digits of year. For digits 00 through 09, only the last
digit is displayed.
Last two digits of year. For digits 00 through 09, both digits
are displayed.
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
HH
HHH
HHHH
M
MM
S
SS
TT
T
TTT
P, A, p, or a

Hours based on a twelve-hour clock with no leading zero.


Hours based on a twelve hour clock with leading zero.
Hours based on a 24-hour clock with no leading zero.
Hours based on a 24-hour clock with leading zero.
Minutes with no leading zero.
Minutes with leading zero.
Seconds with no leading zero.
Seconds with leading zero.
Hundredths of seconds with leading zeros.
Thousandths of seconds with no leading zero.
Thousandths of seconds with leading zeros.
AM/PM indicator.

For example, if you enter HHHH:MM:SS:TTT p, the sample time will be


13:05:06:085 PM.
You may use colons, spaces or any other delimiter of your choice to separate the date
fields.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-19

Saving the Layout


After you have defined the alarm list layouts for the Static and Dynamic displays,
you can select Save or Save As... from the File menu to save them.

Creating Custom Buttons


If you wish to integrate an external application with the Alarm Viewer, you can
configure a custom button in your Alarm Viewer document. When a user selects
an alarm, then clicks on this button, the application launches with the parameters that
you configured.To configure a custom button:
1.

Select the button on the Button Layout properties.

2.

Click Modify....

3.

In the Command: field, enter the command line you wish to execute
when the button is pressed.

4.

Click OK.

You may include any of the following parameter, which will be substituted with
characteristics of the selected alarm, in your command:
Parameter

Value

%DATETIME

Alarm Generation date and time

%DT

same as %DATETIME

%DATE

Alarm Generation date

%TIME

Alarm Generation time

%ID

Alarm Identifier of the selected alarm

%CLASS

Alarm class of the selected alarm

%RESOURCE

Factory resource of the selected alarm

%RES

same as %RESOURCE

%REFERENCE

Alarm reference identifier for the selected alarm

%REF

same as %REFERENCE

%MESSAGE

Alarm message for the selected alarm

%MSG

same as %MESSAGE

%STATE

Current alarm state of the selected alarm

%ACK

"Y" or "N", if selected alarm is acknowledged

The following additional parameters do not require the user to select an alarm:

30-20

Parameter

Value

%%

An embedded percent sign

%USER

User ID of the user invoking the command

%PRODUCT

CIMPLICITY distribution directory

%CIM

same as %PRODUCT

%DIRECTORY

CIMPLICITY project directory

%DIR

same as %DIRECTORY

%PROJECT

CIMPLICITY project name

%PRJ

same as %PROJECT

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 box 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 Alarm ID of
the selected alarm determines the filename.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-21

Logging In to the Alarm Viewer


When you select the Login! menu option, and no project is running on your
computer, the Select Project dialog box opens. You can use this dialog box to select
a project to connect to or start.
If a project is running on your computer, the CIMPLICITY Login dialog box opens.

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

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.

30-22

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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
A number 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, 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.

Using the Alarm List Buttons


In general, the Alarm List buttons are activated as follows:

The Setup, Refresh, and Toggle buttons, if defined, are available at


all times if they have been configured on your Static display.

The Help, View Stack, Comments, Ack, Reset, Delete, Ack


and Reset, and CimView Screen buttons, if defined, are only active
when you select an alarm from the list.

The Ack First and Ack All buttons are active if any alarms are
displayed.

In the following sections of this chapter, the buttons will be referred to by their
default captions. You may have defined other captions for some or all of your Alarm
List buttons, but the functions they perform do not change.
When you click on a button, a brief description of that button is displayed on the
Status Bar. If you move your mouse off the Alarm Viewer button without releasing
the mouse button, the action associated with the Alarm Viewer button will not be
invoked.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-23

Changing the Setup Parameters


Normally, all alarms for the roles assigned to your CIMPLICITY User ID are
displayed on the Alarm Viewer screen. There are times, however, when you want to
display certain subsets of alarms. This is called alarm filtering.
Alarm filters are managed through the Alarm Setups dialog box. The filtering
options let you filter alarms by:
Alarm Class
Resource ID
Time
Alarm State
You may select one or more of these options to filter the alarm list. When you click
Setup, the Alarm Setups dialog box opens. For more information, see page 30-27.

Refreshing the Alarm List


Click Refresh to update the Static Alarm list with the latest alarms.

Toggling Between Lists


Click Toggle to switch between the Static Alarm list and the Dynamic Alarm list.
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.

Displaying User Help


To display help information for an alarm:
1.

Click the alarm in the list.

2.

Click Help.

The Alarm Operator Help dialog box displays all the information associated with the
alarm at the top of the dialog box. 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.

30-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 alarms 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. For example:

To view an alarms 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.

Viewing Alarm Comments


Up to twenty (20) comments can be associated with a current alarm. A comment is a
line of text that can be entered by any user that can view the alarm. Comments are
available for viewing until the alarm is deleted from the system, unless the Store
alarm comments configuration option has been selected.
If an alarm has comments, and the Comments field is being displayed, you will see
the letter C in the Comment field. For example:

To view an alarms comments:


1.

Click the alarm in the list.

2.

Click Comments.

The Alarm Comments dialog box opens.

Adding Alarm Comments


To add a comment to the list click Add Comment.
Click Done to close the dialog box and return to the Alarm Viewer screen.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-25

Viewing the Alarms CimView Screen


When an alarm (or point) is configured, it can be associated with a CimView screen.
Click CimView Screen to display the CimView screen defined for the alarm.
If no screen is defined for the alarm, an appropriate message will be displayed.

Acknowledging an Alarm
You can acknowledge an alarm to inform other users that you have seen the alarm
and, if necessary, are working on resolving the condition that set off the alarm.
If an alarm is not listed as acknowledged, the condition may still exist and should be
investigated.
To acknowledge an alarm (or a group of alarms):
1.

Select the alarm(s).

2.

Click Ack.

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
during alarm configuration.

Normally, alarms are automatically deleted once they have been successfully
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.

30-26

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Acknowledging the First Alarm


You can acknowledge the first alarm in the alarm list. To do this:

Click Ack First.

Acknowledging All Alarms


You can acknowledge all alarms currently in the alarm list. To do this:

GFK-1180H

Click Ack All.

Using the Stand-Alone Alarm Viewer

30-27

Filtering Alarms
You can click the Setup button to open the Alarm Setups and filter alarms. Alarm
filtering lets you look at particular groups of alarms on your alarm list. The Alarm
Setup options let you:

Load a setup for the Alarm List display.

Modify the current setup.

Save the current setup.

Create a new setup.

Delete setups from the list.

Declare one of the setups to be the default setup.

To initiate alarm filtering, click Setup.

When the Alarm Setups dialog box opens, the current setup displays in the Setup
field.

30-28

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The list of setups you can use to filter the projects you are monitoring is displayed
below the Setup field. There are three types of alarm setups:
<<UNFILTERED>> This is the standard default setup. When it is loaded, a user
can view all alarms available to the users CIMPLICITY HMI
User ID.
Project setups

Setups that start with the "$" character are project setups.
Project setups can be loaded and modified by any user logged
in to the project. However, the users role must have the
Modify Alarm Setups privilege to save or delete project
setups.

User setups

Setups that do not start with the "$" characters are only
available to users that log in with the same CIMPLICITY
HMI User ID as the user that created them. These users can
modify, save and delete the setups.

To close the dialog box and return to the Alarm List display, click Done.
To close the dialog box and return to the Alarm List display, click Done.

Loading an Alarm Viewer Setup for Display


To load a setup for display:
1.

Click on the setup in the list that you want to use. The setup name
displays in the Setup field.

2.

Click Load.

The setup loads and the Alarm List is refiltered and redisplayed.
Note
You must load a setup in order to modify it.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-29

Modifying the Current Alarm Viewer Setup


When you click Modify Current, the Modify Setup dialog box opens.
You can modify the classes, resources, time filter, state filter, and sort order of the
current setup.

Modifying the Alarm Viewer Class List

The Classes properties displays the list of current alarm classes and indicates which
ones are used in the setup. 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.

30-30

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Modifying the Alarm Viewer Resource List

The Resources properties displays the list of current resources, and indicates which
ones are used in the setup. 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.

Modifying Alarm Setup Time/State/Sort Filters

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-31

The Time/State/Sort properties display 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
Status

Alarm

Display points in alarm state that have not been


acknowledged.

Alarm

Display points in alarm state that have been acknowledged.

Normal

Display points that have returned to a normal state but have


not been acknowledged.

Description

Set the check box for each state that you want to filter for.
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 option button next to the sort order you want to use.

30-32

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Saving the Current Alarm Viewer Setup


To modify and save an existing setup:
1.

Select the setup from the list, or use the current setup.

2.

If the setup you want to use is not the current setup, click Load. The
setup will be loaded and the Alarm Setups dialog box closes. Click
Setup again to reopen the dialog box.

3.

Click Modify Current.

4.

Use the Modify Setup dialog box to set your new setup options, and
click OK.

Creating A New Alarm Viewer Setup


To create a new setup:
1.

Select the setup you want to use as the basis for your new setup, or use
the current setup.

2.

If the setup you want to use is not the current setup, click Load. The
setup loads and the Alarm Setups dialog box closes. Click Setup
again to reopen the dialog box.

3.

Click Modify Current.

4.

Use the Modify Setup dialog box to set your new setup options, and
click OK.

5.

On the Alarm Setups dialog box, enter the new setup name in the
Setup field and click Save. The new setup name will be added to the
list of available setups.

Deleting an Alarm Viewer Setup from the List


To delete a setup from the list:
1.

Click the setup name in the list. The name will appear in the Setup
field.

2.

Click Delete. The setup name will be removed from the list.

Declaring a Default Alarm Viewer Setup


When you install CIMPLICITY
software, the default setup is
<<UNFILTERED>>.

The default setup is the setup that the Alarm Viewer uses to initially display the
Alarm List.
To declare a default setup:
1.

Click on the setup name in the list.

2.

Click Make Default.

If you want to find out the name of your current default setup, do the following:
1.

Start the Alarm Viewer.

2.

Click Setup.

The setup that appears in the Setup field is the default setup.

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-33

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

30-34

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Creating an Alarm Viewer Document Shortcut


Once you have saved a CIMPLICITY Alarm Viewer document, you can create a
shortcut for the document in the Start menu or on the desktop. Users can then
display the document by clicking on the shortcut.

Creating a Shortcut from Alarm Viewer


To create a shortcut for a CIMPLICITY Alarm Viewer document while you are
viewing it:
1.

Open the screen in the Alarm Viewer.

2.

From the File menu, select Install. The Create Shortcut dialog box
opens.

Menus in the Start menu are represented as folders

GFK-1180H

3.

Select the folder where you want to place the shortcut.

4.

Click OK. The shortcut is placed in the selected folder.

Using the Stand-Alone Alarm Viewer

30-35

Creating a Shortcut from the File Manager


You can use the File Manager to install a shortcut for a CIMPLICITY Alarm Viewer
document. 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.

Command Line Options


Once you have installed an Alarm Viewer shortcut, you can add arguments to the
command line to control user access.
To add arguments to the command line for an icon:
1.

Click the Alarm Viewer shortcut to select it.

2.

Click the right mouse button to open the Windows pop-up menu.

3.

Select Properties... from the Windows pop-up menu. The Properties


dialog box for the screen opens.

4.

Insert the option (or options) you want between the executable name
and the Alarm Viewer screen name in the Target input field on the
Shortcut properties page.

For example, if you have created an Alarm Viewer screen and you do not want
users to reconfigure the count layout or list layout, you can change the command line
for the screens Alarm Viewer icon from this:
amv.exe C:\cimplicity\projects\proj\view.AMV

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:

30-36

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

/noopen
Does not allow the user to open any other files from this Alarm Viewer screen.
The New and Open menu items and the file list are removed from the File menu.
The File Open toolbar button is disabled.
Example:
amv.exe /noopen C:\myproj\view.amv

/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

GFK-1180H

Using the Stand-Alone Alarm Viewer

30-37

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:

GFK-1180H

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.

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

31-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 doesnt fit in the
window.
Use the horizontal scroll bar to move the screen back and forth if it doesnt 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.

GFK-1180H

Using CimView

31-3

CimView Menus
The Menu Bar displays the menus that you will use to control most of your work in
CimView. The options are:
File

Use this menu to open or print screens, and to exit CimView.

View

Use this menu to display the toolbars, replace the current screen
with the previous or home screen, or change view magnification.

Help

Use this menu to get Help on using CimView.

The File Menu


When you select the File menu, the following drop-down menu is displayed:

The File menu functions are:


Open...

Opens a new screen in the current CimView


window.
This function is not available if your CimView
screen has been installed with /noopen.

Open Window...

Opens a screen in a new CimView window.


This function is not available if your CimView
screen has been installed with /noopen.

Flush Cached Screens

Flushes the cached screens from memory.


The screen cache lets CimView retrieve the most
recently replaced screens from memory rather than a
disk file. Flushing the cache will force CimView to
retrieve these screens from their disk files rather than
from memory. This is useful if a screen has been
updated recently and you want to make sure you are
looking at the most recent version.

31-4

Print...

Prints the current CimView screen.

Print Setup...

Defines the printer, page size, and orientation for


your print requests.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

The View Menu


When you select the View menu, the following drop-down menu is displayed:

The View menu functions are:


Toolbars...

Enables/disables the display of the Standard Toolbar


buttons.

Status Bar

Enables/disables the display of the Status Bar at the


bottom of the CimView window.

Menu/Title Bar

Enables/disables the display of the Title and Menu


bars at the top of the CimView window.
To restore their display, click the right mouse button,
then click Menu/Title Bar. You can also use
Alt+Spacebar to display the Control menu and select
View Menu/Title.

GFK-1180H

Using CimView

31-5

Full Screen

Changes the window size to use the full screen area to


display the current CimView screen. When you do
this, the Title Bar, Menu Bar, Status Bar, and Toolbar
will all be disabled.
To change from Full Screen mode to normal mode,
you can press the Esc key. You can also click the
right mouse button, then click Full Screen, or you
can use Alt+Spacebar to display the Control menu
and select Restore.
To display the Menu and Title bars in Full Screen
mode, click the right mouse button, then click
Menu/Title Bar, or you can use Alt+Spacebar to
display the Control menu and select View
Menu/Title.

31-6

Previous Screen

Replaces the current screen with the previous screen.

Home Screen

Replaces the current screen with the first screen that


was displayed when you entered this CimView
session.

Zoom 50%

Resizes the screen in the window to 50% of its normal


size.

Zoom 100%

Resizes the screen in the window to its normal size.

Zoom 200%

Resizes the screen in the window to double its normal


size.

Zoom to Best Fit

Resizes the screen to fit the window.

Zoom...

Displays the Zoom dialog. Use the dialog boxs radio


buttons or the Percent input field to select a zoom
factor for the screen.

Size Window to Zoom

Resizes the window to fit the screen.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using the Help Menu


When you select the Help menu, the following drop-down menu is displayed:

The Help menu functions are:


Contents

Displays the Contents page for CimView help.

Search for Help On

Displays the Search dialog box for CimView help.

How to Use Help

Displays the How to Use Help file.

On Screen

Displays the application help file for the current


CimView screen.

About CimView

Displays information about the current version of


CimView.

Using the Control Menu


To access the Control menu, click the right mouse button on the Title Bar or press
Alt+Spacebar. The following drop-down menu is displayed:

The Control menu functions are:

GFK-1180H

Restore

If the window is currently an icon, restores the window.


Otherwise, the item is unavailable.

Move

Lets you move the window around on the terminal screen.

Size

Lets you resize the window.

Minimize

Reduces the window to an icon.

Maximize

Resizes the window to use the entire terminal screen.

Close

Closes the current window. You will be prompted to save


any changes.

Using CimView

31-7

Using the Window Pop-Up Menu


To access the Window Pop-up menu, press the right mouse button anywhere on the
CimView screen. The following drop-down menu is displayed.

The Window Pop-up menu functions are:


Menu/Title Bar

Toggles the display of the Menu Bar and Title Bar in the
window. A check mark appears to the left of this option if
the Menu Bar and Title Bar are being displayed.

Full Screen

Toggles the window size between normal and full screen.


A check mark appears to the left of this option if Full
Screen mode is being used.

Help

Displays user-defined Help for the screen or currently


selected group or object.

Properties

Opens the Properties dialog.


If the cursor is on the CimView screen background, the
screen properties are displayed.
If the cursor is pointing to an object or group that is nonstatic, the properties for the object or group are displayed.

CimView Toolbar Buttons


The Toolbar buttons available to you are:
Icon

31-8

Menu Item

Description

Open Window

Opens an existing CimView screen in a new window.

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.

Home Screen

Displays the home screen in this window.

Full Screen

Toggles Full Screen mode.

Zoom 100

Zooms the screen to 100%.

Zoom to Fit

Zooms the screen to fit the window.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Floating the CimView Toolbar


To display the toolbar as a floating toolbar:
1.

Move the cursor to a blank spot in the toolbar.

2.

Hold down the mouse button and drag the toolbar to any spot on your
terminal screen that is not a dockable location.

3.

Release the mouse button.

Docking the CimView Toolbar


To dock a floating toolbar:
1.

Move the cursor to a blank spot on the toolbar.

2.

Hold down the mouse button and drag the toolbar to the edge of the
CimView window where you want to put the toolbar.

3.

Release the mouse button.

CimView Shortcut Keys


You can use the following shortcut keys to initiate commonly used functions:

GFK-1180H

Ctrl+O

Opens an existing screen in the current window.

Ctrl+P

Prints the current window.

Alt+Enter

Opens the Screen Properties dialog box.

Alt+Print Screen

Captures the current window to the clipboard.

F1

Opens the Help window.

Alt+Spacebar

Displays the Control menu. This menu is especially


useful if you have disabled the Menu/Title Bar. You can
use the Control menu to restore the display of the
Menu/Title bar.

Using CimView

31-9

Displaying A CimView Screen


You can display a screen in many ways. Some of these are:
Outside of CimView:

Click Start on the Task Bar, select Programs, select CIMPLICITY


HMI, and then select CimView. A dialog opens, allowing you to select
the screen to display.

Double-click the icon for the screen in a folder or on the desktop.

Within CimView:

Click on a screen object that has been configured to let you access
another screen.

Press a key sequence that has been configured to let you access another
screen.

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.

31-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Selecting Action Objects


An object that has mouse events (also referred to as an action object) is one that
meets one or more of the following criteria:

A mouse down event is defined.

A mouse up event is defined.

A slider setpoint is defined.

An in-place edit setpoint is defined.

The object is an OLE object that has a primary verb that does not
modify the object (for example, an embedded sound that you click on to
play).

When you move the mouse around the screen, action objects on the screen are
highlighted with a rectangle when the mouse moves over them.
Alternatively, you may locate action objects by pressing the Tab, Shift+Tab or
arrow keys on the keyboard.

Use Tab to highlight the next object in the tab-order. If no object is


currently highlighted, the first object in the tab-order will be selected.

Use Shift+Tab to highlight the previous object in the tab-order. If no


object is currently highlighted, the last object in the tab-order will be
selected.
Note

The tab-order of the objects is specified when the screen is created. Consult with
your CIMPLICITY system manager or project integrator about the tab-order.

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.

GFK-1180H

Using CimView

31-11

Executing the Procedure


Once you have highlighted an action object, you can use the left mouse button or the
Enter key to invoke the actions associated with the On mouse down and On
mouse up events assigned to the object.

When you press the mouse button or the Enter key, the action
associated with the On mouse down event will be executed.

When you release the mouse button or the Enter key, the action
associated with the On mouse up action will be executed.

Executing Slider Setpoints


The method you use to execute a Slider setpoint depends on whether you selected the
object with the mouse, an arrow key, or the keyboard.
Note
When you use a Slider setpoint, you may be setting different points in the horizontal
and vertical directions

Setpoint Object Selected with the Mouse


Once you have highlighted an object with a Slider setpoint action with the mouse, do
the following to perform the action:
1.

Move the mouse cursor over the object.

2.

Hold down the left mouse button and move the object in the direction
(vertical and/or horizontal) you want for the setpoint value. As you
move the object, the proposed setpoint value will be displayed in the
Status Bar message area.

3.

Release the left mouse button. The new value for the point will be
displayed in the Status Bar.

If the object is also configured with mouse down and mouse up action procedures,
they execute appropriately.
If you want to cancel the Slider setpoint action, move the mouse cursor off the object,
then release the left mouse button, or press the Esc key and release the button.

31-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

In-Place Edit Setpoint Actions


You can use the mouse cursor or the Tab or Shift+Tab keys to highlight an object
with an in-place setpoint action. Once you have highlighted the object, do the
following to perform the action:
1.

Press Enter or click the object with the left mouse button to activate
the object for editing.

2.

Enter the new value for the setpoint.


You can use Ctrl+Z to undo a single level of editing.
You can cancel editing without making any changes to the setpoint, by
pressing Esc, or moving the cursor away from the object and clicking
the left mouse button.

3.

GFK-1180H

Press Enter or Tab to perform the setpoint. If you press Tab, the next
action object is automatically highlighted.

Using CimView

31-13

Setting CimView Window Options


You can define the following options for a screen in CimView window:

Toolbar to be displayed

To access the Options dialog box, select Toolbars... from the View menu.

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.

31-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Displaying CimView Screen Help


You can display help information for a screen in one of several ways:
You can:

Click On Screen from the Help menu. If On Screen is grayed out,


there is no help information for the screen.

Or you can:
1.

Click the Help button on the Toolbar.

2.

Move the Help cursor to the screen background (that is, away from any
objects on the screen).

3.

Click the left mouse button. The help information for the screen will be
displayed. If there is no help information for the screen, a "No help
defined for this screen" dialog box is displayed.

Or you can:

GFK-1180H

1.

Move the cursor to the screen background (that is, away from any
objects on the screen).

2.

Click the right mouse button. The window pop-up menu will appear.

3.

Click Help in the pop-up menu. The help information for the screen
will be displayed. If Help is grayed out in the pop-up menu, there is no
help information for the screen.

Using CimView

31-15

Displaying CimView Object Help


You can display help for an object in one of several ways.
You can:
1.

Click the Help button on the Toolbar.

2.

Move the Help cursor to the object.

3.

Click the left mouse button. The help information for the object will be
displayed. If there is no help information for the object, a "No help
defined for this object" dialog box is displayed.

Or you can:
1.

Move the cursor to the object.

2.

Click the right mouse button. The window pop-up menu will appear.

3.

Click Help in the pop-up menu. The help information for the object
will be displayed. If Help is grayed out in the pop-up menu, there is no
help available for the object.

Displaying CimView Screen Properties


You cannot define or modify screen properties in CimView, but you can display
them. You will be able to show:

Line and fill style, colors, and patterns for the screen.

The screen size.

Object help information for the screen.

Events configured for the screen.

Screen ambient properties.

The list of point defined for the screen and the objects associated with
them.

Variable IDs used by the screen.

Procedures defined for the screen.

To display screen properties:


1.

Hold down the right mouse button.

2.

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.

31-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

CimView Command Line Options


When a CimView screen is installed in a program group, arguments can be added to
command line for its icon to control user access. The command line can also be used
to launch multiple CimView screens from the icon.
The command line format is:
cimview.exe <option> <pathname> [<pathname>...]

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.

GFK-1180H

Using CimView

31-17

Example:
cimview.exe /alwaysmaximized C:\myproj\scr.cim

/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 users 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

/LoadScript
Enables a common script file to be shared among all screens loaded in CimView.
Functions that are included in this common file will be loaded when CimView is first
run, and will be callable as if they were included in the Basic code for the local
screen.
If the /LoadScript argument is specified for a file after CimView is already
running, its contents will be appended to the list of common functions with the lowest
precedence.
Example:
/LoadScript scriptFileName

where
scriptFileName is a file specification) to specify a common script file. (Multiple
/LoadScript options can be given on the command line.)

See the "Using CimEdit Scripts" chapter in the CIMPLICITY HMI CimEdit
Operation ManualGFK1396 for more information about /LoadScript.

31-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

/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

/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

/noPointTargets
Prevents the point targets, e.g. Point Control Panel and quick trends, from being
available from Point View or the right mouse menu.

/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

GFK-1180H

Using CimView

31-19

/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

/wait [<time>]
Makes CimView wait for the Router to start before opening the screen. Note that
CimView does not try to start the Router. The Router must be started by another
method. Typically this option is used when configuring CimView to start at boot or
when the user logs in to Windows.
You can specify a time, in seconds, to wait. The screen opens at the end of the time,
regardless of the state of the router. If you do not specify a time, CimView waits
forever.
Example:
cimview.exe /wait 60 C:\myproj\scr.cim

/waitforproject <name>
Makes CimView wait for the project to start before opening the window
Example:
cimview.exe /waitforproject 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

31-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

OLE Controls in CimView


OLE Controls such as the CIMPLICITY Trend Control, define their own behavior.
Mouse events in the area defined for the control are caught by the control, and the
response is defined by the control.
For example, an OLE control may not highlight areas that you can click on when the
mouse moves over them.
If you click the right mouse button over the control, the pop-up menu for the control
(if defined) is displayed, not the CimView pop-up menu.
An embedded OLE object (other than a control) is highlighted with a slashed border.
To activate an embedded OLE control, you must double-click the object.

GFK-1180H

Using CimView

31-21

Using the Point Control Panel

About the Point Control Panel


The Point Control Panel lets you:

View the current point values for points in any project in your
enterprise.

Perform setpoints on points you are displaying.

Enable/disable alarms for points you are displaying.

Change the alarm limits for points you are displaying.

Save a Point Control Panel document and redisplay it at a later time.

Getting Started
To open the Point Control Panel:
1.

Expand the Runtime folder in the CIMPLICITY HMI Workebench.

2.

Double click Point Control Panel in the left pane or right pane
(when the Point Control Panel is selected in the left pane).
The Point Control Panel opens.

GFK-1180H

32-1

To display a new, empty list, select New from the File menu.
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
documents are saved with the
extension .PPL

To save a Point Control Panel document, select Save from the File menu. When
the Save As dialog box opens, enter a file name for the file and select OK. By
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.

32-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

GFK-1180H

Using the Point Control Panel

32-3

Alarm

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.

32-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Enabling and Disabling Manual Mode


In the Point Control Panel you can easily make use of the CIMPLICITY HMI manual
mode feature. Manual mode enables a user to take a device point that may or may not
be currently available and put it in manual mode. The user can then set the points
value. This is particularly useful if a point is attached to equipment that is known to
be malfunctioning and, consequently, creates a problem in other areas of the system.
By Enabling Manual Mode, a user can separate the point from that equipment and set
the point to a known good value that preserves the systems integrity.
Example
A temperature sensor that reports temperatures, which are acted upon by
CIMPLICITY HMI applications to initiate temperature control actions, fails. To
continue the high temperature setting, a user with Modify Manual Mode privilege
places the point that reflects the errant sensor in manual override mode. The user then
sets a value that causes the application to cease the unnecessary temperature control
procedures. This allows users who are knowledgeable of their CIMPLICITY HMI
application implementation to make emergency, temporary adjustments to their
systems operation. Consequently, the application does not have to anticipate and
provide for handling of all possible failures in its implementation.
To reset a points value in manual mode:
1.

Select the point that needs to be put in manual mode.

2.

Click Edit on the Point Control Panel menu bar.

3.

Click Enable Manual Mode.


The point is no longer reporting data from the PLC.
An icon appears to the left of the Point ID, indicating that the point is in
manual mode. Double click the Point ID.
The Point Properties dialog box appears.

4.

Enter a new value for the point in the Set Value field.

The point will continue to funciton in the CIMPLICITY HMI using the set value.

GFK-1180H

Using the Point Control Panel

32-5

To disable manual mode:


1.

Select a point that is in manual mode.

2.

Click Edit on the Point Control Panel menu bar.

3.

Click Disable Manual Mode.


The point resumes collecting data from the PLC. The icon to the left of
the Point ID disappears.

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.

32-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Saving A Point Control Panel Document


To save a Point Control Panel document, select Save or Save As from the File
menu. The Save As dialog box opens.

Point Control Panel


documents are saved with the
extension .PPL

Enter the file name you want in the File name field, then select the full path name
for the document. Select Save to save the document. The document is saved in the
directory you specify.
You can then select the document and create a shortcut for it on your desktop or in a
start menu.

GFK-1180H

Using the Point Control Panel

32-7

Using the CIMPLICITY To


Windows Server (DDE)

About The CIMPLICITY To Windows Server


The CIMPLICITY to Windows Server (CWSERV) lets you access CIMPLICITY
point data from other Microsoft Windows products such as Microsoft Excel.
CWSERV uses the Microsoft standard of Dynamic Data Exchange (DDE). With
CWSERV, you can use your favorite software package that supports DDE to
monitor, analyze, report, or modify CIMPLICITY point data.

Command Syntax for CWSERV


Generally, a DDE command consists of three elements - the name of the service
being used, the topic, and the item.
For the CIMPLICITY to Windows Server:

The service is CWSERV.

The topics supported are POINT and SYSTEM. Use the Point topic to
display CIMPLICITY point information. Use the System topic to
display CWSERV system information.

The items supported for the POINT topic correspond to various point
attributes such as value, alarm limits, and point state.

The items supported for the SYSTEM topic are FORMATS,


SYSITEMS, TOPICS, and HELP.

The format of a particular DDE command depends on how it has been implemented
in the application where you are using it.

GFK-1180H

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

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.

Sample CWSERV Commands


This syntax will display the value of the point "ANALOG_POINT":
=cwserv|point!analog_point

This syntax will display the current state of the point "ANALOG_POINT":
=cwserv|point!analog_point.state

This syntax will display the sixth through tenth values of the array point
"ARRAY_POINT" in a row:
=cwserv|point!array_point.value[5:9R]

This syntax will display the value of the point "ANALOG_POINT" in the "TEST"
project:
=cwserv|point!\\test\analog_point.value

33-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 points current state depends on its point class and alarm conditions.
For all point classes, the states that can be displayed are:
NORMAL

The points 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:

GFK-1180H

ALARM HIGH

The points value is greater than the high alarm limit.

ALARM LOW

The points value is less than the low alarm limit.

WARNING HIGH

The points value is greater than the warning high limit


and less than the alarm high limit.

Using the CIMPLICITY To Windows Server (DDE)

33-3

WARNING LOW

The points 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 points 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 points value is in the
alarm state.

TYPE
Displays the points 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 points 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 points value in Alarm Viewer, Status
Log messages, or CimView.

33-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

EU_LABEL
Displays the engineering units label for the point. The label can be up to eight (8)
characters long.

ALARM_HIGH
Displays the Alarm High value for the point. This field is only valid for the
following point types:

ANALOG
APPL

If the points 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 points 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 points 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 points 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:

GFK-1180H

ANALOG
APPL

Using the CIMPLICITY To Windows Server (DDE)

33-5

INIT_STATE
Indicates whether the point is enabled or disabled. You will see one of the following
values:
0

The point is disabled

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.

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

High/Low warning messages are enabled for the point.

Using CWSERV with Microsoft Excel


You can use CWSERV on a Microsoft Excel spreadsheet to display point
information, and to update setpoints in the CIMPLICITY point database.

Displaying Point Data


To display CIMPLICITY point information in a Microsoft Excel spreadsheet:
1.

Select the cell where you want the point information to appear.

2.

Enter the CWSERV formula in the cell, then press Enter.

For example, to display the raw value for the point CWSERV_VIRT, you would
type:
=cwserv|point!cwserv_virt.raw_value

To display an array in a Microsoft Excel spreadsheet:


1.

Select a range of cells (horizontal or vertical) where you want the point
information to appear.

2.

Enter the CWSERV formula, and enclose the point information within
single quotes, then press Ctrl+Shift+Enter.

For example, to display the raw values for the ten-item array CWSERV_ARRAY in a
column on your spreadsheet, you would type
=cwserv|point!cwserv_array.raw_value[0:9c]

33-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Starting CWSERV
The first time you enter point information into a spreadsheet, the following dialog
box will be displayed:

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:

GFK-1180H

Using the CIMPLICITY To Windows Server (DDE)

33-7

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

You can enter any number of POKE commands in the macro.


If you are performing setpoints on an array, you can use one POKE command to set
multiple array values. For example, if you want to set an array of ten items from
information in a column on the spreadsheet, you can use a POKE command like this:
=POKE(channel,"cwserv_array.raw_value[0:9]",Sheet1!R4C4:R13C4)

This command will take the values in rows 4 through 13 of column 4 of the
spreadsheet and use them to set the first 10 values in the CWSERV_ARRAY point.

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.

33-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To avoid this condition, insert delays in your setpoint macros as follows:


ManyPoints
channel=INITIATE("cwserv","point")
=POKE(channel,"point001.value",Sheet1!D4)
=POKE(channel,"point002.value",Sheet1!D5)
=POKE(channel,"point003.value",Sheet1!D6)
=POKE(channel,"point004.value",Sheet1!D7)
=WAIT(NOW() + "00:00:01")
=POKE(channel,"point005.value",Sheet1!E4)
=POKE(channel,"point006.value",Sheet1!E5)
=POKE(channel,"point007.value",Sheet1!E6)
=POKE(channel,"point008.value",Sheet1!E7)
=WAIT(NOW() + "00:00:01")
=POKE(channel,"point009.value",Sheet1!F4)
=POKE(channel,"point010.value",Sheet1!F5)
=POKE(channel,"point011.value",Sheet1!F6)
=POKE(channel,"point012.value",Sheet1!F7)
=TERMINATE(channel)
=RETURN()

Depending on the performance and configuration of your computer, your delay


requirements may vary.

Implementing A Macro
You will need to do the following to implement a macro that performs a setpoint and
assign it to a button:
1.

Select a location on your spreadsheet where you want to enter the


points setpoint value. Make a note of the sheet name and cell location.

2.

If you have not already done so, select Toolbars from the View menu
and activate the Drawing toolbar.

3.

Select Record Macro from the Tools menu on your spreadsheet.

4.

Select Record New Macro from the Record Macro submenu. The
Record New Macro dialog box will open.

5.

Enter your new macro name in the Macro Name input box.

6.

Click Options.

7.

Select This Workbook from the Store In input box.

8.

Select MS Excel 4.0 Macro from the Language input box.

9.

Click OK. A new Macro sheet will be created and the macro name will
be placed in the first cell (R1C1) of the sheet.

10. Select Record Macro from the Tools menu.


11. Select Stop Recording from the Record Macro submenu.
12. Enter your commands in the cells under the macro name on the Macro
page.
13. Go back to your sheet.
14. Select Create Button from the Drawing toolbar.
15. Create a button on the spreadsheet. When you do this, the Assign
Macro dialog box will open.
16. Select the setpoint macro from the Assign Macro dialog box.
Whenever a user enters the setpoint in the cell referenced by the macro, then clicks
the button, the setpoint value will be sent to CIMPLICITY software.

GFK-1180H

Using the CIMPLICITY To Windows Server (DDE)

33-9

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.

Single Point Example


The following spreadsheet was configured to display all available point attributes for
CWSERV_VIRT, and to let the user perform a setpoint on that point.

The formulas that appear in cells R5C3 through R17C3 are:

33-10

R5C3

=cwserv|point!cwserv_virt.value

R6C3

=cwserv|point!cwserv_virt.state

R7C3

=cwserv|point!cwserv_virt.disp_format

R8C3

=cwserv|point!cwserv_virt.eu_label

R9C3

=cwserv|point!cwserv_virt.alarm_high

R10C3

=cwserv|point!cwserv_virt.warn_high

R11C3

=cwserv|point!cwserv_virt.warn_low

R12C3

=cwserv|point!cwserv_virt.alarm_low

R13C3

=cwserv|point!cwserv_virt.disp_high

R14C3

=cwserv|point!cwserv_virt.disp_low

R15C3

=cwserv|point!cwserv_virt.alarm_enabled

R16C3

=cwserv|point!cwserv_virt.warn_enabled

R17C3

=cwserv|point!cwserv_virt.init_state

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The following macro is the one associated with the Set button above.
set_point
channel=INITIATE("cwserv","point")
=POKE(channel,"cwserv_virt.value",Sheet1!R19C3)
=TERMINATE(channel)
=RETURN()

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]

and Ctrl+Shift+Enter was pressed.


Note
You must press Ctrl+Shift+Enter when entering a formula for a range of cells on
the spreadsheet. If you press Enter, only the first cell of the range will contain data.
In the case of array points, this means that only the first array elements value is
displayed.
The following macro is the one associated with the Set button above.
Array
channel=INITIATE("cwserv","point")
=POKE(channel,"cwserv_array.raw_value[0:9]",Sheet1!R5C4:R14C4)
=TERMINATE(channel)
=RETURN()

To change the setpoint, enter the new values in R5C4 through R14C4, and click Set.

GFK-1180H

Using the CIMPLICITY To Windows Server (DDE)

33-11

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

33-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Help
You can display descriptive information about CWSERV. This information tells you
how to display information, and lists the System and Point topic attributes.
To display information about CWSERV on a Microsoft Excel spreadsheet:
1.

Select 38 rows in one column in the spreadsheet.

2.

Type the following formula in the first cell and press


Ctrl+Shift+Enter.
=cwserv|system!help

The resulting display should look like this:


CIMPLICITY to Windows Server (CWSERV):
0
This server provides clients with access to current CIMPLICITY point data.
The topics supported include SYSTEM and POINT.
0
The SYSTEM topic gives information about this server.
Supported items under the SYSTEM topic include the following:
Formats: Lists all supported formats.
SysItems: Lists all items supported under the SYSTEM topic.
Topics: Lists all supported Topics.
Help: Provides information about this server.
0
The items under the POINT topic are in the following format:
point_id.attr[start:endR]
point_id = tag name of the point [REQUIRED],
attr = type of point data desired [default = VALUE],
start and end = beginning and ending indices of an array point [default = 0], and
R = Row formatting for array elements (tab deliminated) [default = Column (<CR><LF> deliminated)].
0
Supported items under the POINT topic include the following:
VALUE:
Point data value. (converted).
RAW_VALUE: Point raw data value (non-converted).
STATE:
Current state of the point.
TYPE:
Data type.
LENGTH:
Length of point data.
ELEMENTS: Number of elements in the point for an array point.
SIZE:
Size of point data.
DISP_FORMAT: Display format.
EU_LABEL: Engineering units label.
ALARM_HIGH: High alarm limit.
ALARM_LOW: Low alarm limit.
WARN_HIGH: High warning limit.
WARN_LOW: Low warning limit.
DISP_HIGH: High display limit.
DISP_LOW: Low display limit.
INIT_STATE: Initial state of point.
ALARM_ENABLED:1 if the alarm is currently enabled.
WARN_ENABLED: 1 if the warning limits are currently enabled.

GFK-1180H

Using the CIMPLICITY To Windows Server (DDE)

33-13

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 projects Status Log file for
detailed information on the cause of the problem.

Remote Access of CWSERV on Windows NT


You can access CWSERV from a networked NT system using Microsoft NetDDE.
This requires that you first set up a DDE Share on the Server node where CWSERV
is running. Then, when referencing CWSERV through DDE on the client, you must
be sure to indicate that you are using NetDDE. The following are a few notes to help
in this operation.

Creating a DDE Share


To create a DDE Share on the server node:
1.

Open a command prompt and type:


start DDEShare

33-14

2.

When the DDE Share window opens, select DDE Shares from the
Shares menu.

3.

Select Add a Share. A DDE Share Properties dialog opens.

4.

Enter CWSERV$ as the Share Name.

5.

For all three Application Name boxes, enter CWSERV.

6.

For all three Topic Name boxes, enter POINT.

7.

Select the Allow Start Application checkbox.

8.

Select the Is Service checkbox.

9.

Select OK.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Referencing CWSERV from a Networked NT Client


Once you have setup the DDE Share on the server and CWSERV is running, you can
access CWSERV from a client node. The syntax is slightly different than if
CWSERV were running locally. The Service or Application name becomes the node
name together with NDDE$. The topic name is the DDE Share name you just
created. The Item name remains the same as it would locally.
Service/Application name:
Topic name:

\\nodeName\NDDE$
CWSERV$

Example in Microsoft Excel


When accessing CWSERV from EXCEL, you must put the Service/Application and
Topic names in single quotes because of the $ characters.
To access the value of the point, GEF_DEMO_ASETPT, from the node ALBP64,
type the following:
\\albp64\ndde$|CWSERV$!GEF_DEMO_ASETPT.value

GFK-1180H

Using the CIMPLICITY To Windows Server (DDE)

33-15

System Utilities

About System Utilities


You can access the System Utilities after you install and license the System Utilities
option. The utilities are:

Show Users

Login Panel

Program Control

Use Show Users to see what users are logged on to the various CIMPLICITY HMI
projects running on your network.
Use Login Panel to log in and out of CIMPLICITY HMI projects on the computer
and monitor saved logins.
Use Program Control to view, start, and stop processes for a project.

GFK-1180H

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

Starting Show Users


To start Show Users, select the Show Users icon from the CIMPLICITY HMI menu.
If no project is running on the computer, the Select CIMPLICITY Project dialog box
opens. Use this dialog box to start a project.

At this point, you can start as a Viewer, or select a project to start.


If a project is already running, or after you start a project or start as a Viewer, the
Show Users window opens.

From this window, you can

34-2

Select all projects or a particular project to display.

Search for users.

Access Help.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.
The menu options are:

Project Menu

View Menu

Help Menu

The Project Menu


When you select the Project menu, the following drop-down list displays:

The Project menu functions are:


Open

Opens a new project on the network.

Recent Project

Displays the list of recently opened projects and lets you select one.

Exit

Exits Show Users.

The View Menu


When you select the View menu, the following drop-down list displays:

The View menu functions are:

GFK-1180H

Toolbar

Enables/disables the display of the Toolbar.

Status Bar

Enables/disables the display of the Status bar.

Options...

Selects options from the Options dialog box.

System Utilities

34-3

The Help Menu


When you select the Help menu, the following drop-down list displays:

The Help menu functions are:


Contents

Opens the Contents page for the Show Users help file.

Search for Help On

Opens the Index page for the Show Users help file.

How to Use Help

Opens the Contents page for the Show Users help file.

About ShowUser...

Displays the current version number for the Show Users


utility.

The Search Menu


When you have one or more projects open in this window, the Search menu is
available. When you select the Search menu, the following drop-down list displays:

The Search menu functions are:

34-4

Search

Displays the Search dialog box.

Next

Displays the next line of user information that meets the search
criteria.

Previous

Displays the previous line of user information that meets the


search criteria.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The Window Menu


When you have one or more projects open in this window, the Window menu is
available. When you select the Window menu, the following drop-down list
displays:

The Window menu functions are:


Cascade

Cascades the currently open project windows.

Tile Horizontally

Tiles the currently open project windows horizontally.

Tile Vertically

Tiles the currently open project windows vertically.

Arrange Icons

Arranges the icons for all minimized project windows.

Close All

Closes all project windows.

Open Projects

Displays the list of all opened projects in Show Users. To


activate the display of a project in this list, just click on it.

Show Users Toolbar Buttons


The Toolbar buttons available to you are:

GFK-1180H

Open

Opens a project.

Close

Closes the active session.

Search

Searches for a User.

Search Next

Searches for the next User.

Search Previous

Searches for the previous User.

Tile Windows

Tiles windows horizontally.

Tile Windows

Tiles windows vertically.

Cascade Windows

Cascades windows.

System Utilities

34-5

Show Users Shortcut Keys


You can use the following shortcut keys to initiate commonly used functions:
Ctrl+O

Opens a project.

Ctrl+S

Opens the Search dialog box.

Ctrl+N

Finds the next entry that matches the criteria in the Search
dialog box.

Ctrl+P

Finds the previous entry that matches the criteria in the


Search dialog box.

Alt+Print Screen

Captures the contents of the current window to the


clipboard.

F1

Opens the Help window.

Shift+F1

Invokes the Help cursor.

Alt+F4

Closes the current window. You will be prompted to save


any changes.

Ctrl+Esc

For Windows 98/95, opens the Start Menu on the taskbar.


For Windows NT, opens the Task List dialog box.

Changing View Options


To display and modify the View options for Show Users, click Options... from the
View menu. The Options dialog box opens.

You can select the following options:

If you set the On user login check box, a sound plays whenever a
user logs in to any CIMPLICITY project that you are viewing.
If you clear the check box, no sound plays when users log in to
CIMPLICITY projects that you are viewing.

If you set the On user logout check box, a sound plays whenever a
users logs out of any CIMPLICITY project that you are viewing.
If you clear the check box, no sound plays when users log out of
CIMPLICITY projects that you are viewing.

When you are through selecting the options you want, select OK to close the dialog
box and save your changes, or select Cancel to close the dialog box without
implementing any changes.

34-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Opening A Project in Show Users


If the project that you want to display is in the list of projects in the Project menu,
click on it. You will be prompted to login to the project. After you login, a
subwindow for the project will be displayed in the Show Users window.
Otherwise, to open a project, you can do one of the following:

Select Open from the Project menu.

Press Ctrl+O.

Click the Open icon on the toolbar.

When the Open dialog box opens, it displays a list of currently running projects that
are broadcasting.

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.

GFK-1180H

System Utilities

34-7

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.

Searching for User Information


You can use the Search function to look for a specific User ID, Role, Node or
Process in the currently active subwindow in Show Users. To initiate a search, do
one of the following:

Select Search... from the Search menu.

Click the Search icon on the toolbar.

Press Ctrl+S.

The Search dialog box opens with the current search criteria.

34-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

You can search the list of users in a project by:

User ID

Role

Node

Process

Any combination of the above

You can use the drop-down list buttons to the right of each field to display and select
previous search filters.
Select Close to close the dialog box and do no further searching.
Select Find to find the first user in the currently active subwindow that matches the
search criteria.
Select Next or press Ctrl+N to find the next user in the currently active subwindow
that matches the search criteria.
Select Previous or press Ctrl+P to find the previous user in the currently active
subwindow that matches the search criteria.

Closing A Project View in Show Users


To close a project subwindow in Show Users, select the projects subwindow and
then do one of the following:

GFK-1180H

Double-click on the Control button for the project.

Click the Close icon on the toolbar.

Select Close from the Project menu.

System Utilities

34-9

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

Starting the Login Panel


To start the Login Panel, select the Login Panel icon from the CIMPLICITY HMI
menu.
The Login Panel window opens.

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:

34-10

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Login Panel 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.
The menu options are:

File

Project

View

Help

The File Menu


When you select the File menu, the following drop-down list displays:

The File menu functions are:


Exit

Exits the Login Panel.

The Edit Menu


When you select the Edit menu, the following drop-down list displays:

The Edit menu functions are:


Saved Logins

Opens the Saved Logins dialog box.

The Project Menu


When you select the Project menu, the following drop-down list displays:

The Project menu functions are:

GFK-1180H

Login

Opens the Login dialog box for the selected project.

Logout

Logs you out of the selected project.

Change Password

Allows you to change your password for the selected


project.

System Utilities

34-11

The View Menu


When you select the View menu, the following drop-down list displays:

The View menu functions are:


Toolbar

Enables/disables the display of the Toolbar.

Status Bar

Enables/disables the display of the Status bar.

The Help Menu


When you select the Help menu, the following drop-down list displays:

The Help menu functions are:


Help Topics

Opens the Help window for the Login Panel.

About LoginPanel

Displays the current version number for the Login Panel


utility.

Login Panel Toolbar Buttons


The Toolbar buttons available to you are:
Login

Opens the Login dialog box for the selected


project.

Logout

Logs you out of the selected project.

About

Displays the title, version number and copyright


information for the Login Panel

Login Panel Shortcut Keys


You can use the following shortcut keys to initiate commonly used functions:
F1

Opens the Help window.

Shift+F1

Invokes the Help cursor.

Alt+F4

Closes the current window. You will be prompted to save


any changes.

Ctrl+Esc

For Windows 98/95, opens the Start Menu on the taskbar.


For Windows NT, opens the Task List dialog box.

34-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Logging out of a Project


To log out of a project:
1.

Select the project from the list of projects (its status must be "Logged
in").

2.

Select Logout from the Project menu or click the Logout button - on the Toolbar.

CIMPLICITY HMI software logs out the project. All CimView screens that have
animation objects that use points from this project will disable the objects.

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.

GFK-1180H

System Utilities

34-13

Changing Password
Note
In a Server Redundancy configuration, changing the password is only supported
when the Primary computer is on line.
To change your CIMPLICITY Users Password for a project:
1.

Select the project from the list of projects (its status must be "Logged
in").

2.

Select Change Password from the Project menu

The Change Password dialog box opens.

The dialog box displays the current project and your User ID.
To change the password:

34-14

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Managing Saved Logins


If you set the Save Username + Password check box in the CIMPLICITY Login
dialog box when you log in to a CIMPLICITY HMI screen, the Username and
Password information is saved in your Registry. In the future, whenever you open
any CIMPLICITY HMI screen that requires that username and password, you are
automatically logged in to CIMPLICITY HMI software.
To remove or add these logins, select Saved Logins from the Edit menu. The
Saved Logins dialog box opens.

When you are through with this dialog box, select Close to close it and return to the
Login Panel window.

Adding a Saved Login


To add a login to the list of saved logins:
1.

Select Add.... The Add Saved Login dialog box opens.

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.

GFK-1180H

System Utilities

34-15

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.

34-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using Program Control


Program Control is an interactive process that lets you start, stop, and display the
current state of CIMPLICITY HMI processes. This section describes the functions
available in Program Control and procedures for running it.

Starting Program Control


To start CPC, double-click the Program Control icon in the CIMPLICITY program
group.
In order to access the CIMPLICITY Program Control dialog box, you must have a
project (Server or Viewer) running on your computer. If no project is currently
running on your computer, the Select CIMPLICITY Project dialog box opens.

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.

GFK-1180H

System Utilities

34-17

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.

34-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Once you are connected to a project, you can:

Start a halted process.

Stop a running process.

Start all halted processes.

Stop all running processes.

Refresh the process list.

Release the connection to the project.

Exit CPC.
Important

This is not the recommended way to start or stop CIMPLICITY HMI


software. You should only use CIMPLICITY Program Control to start
and stop processes if you have been instructed to do so by GE Fanuc
support personnel, or if you are testing an API application. In the latter
case, you should only be starting and stopping your API application.

Orderly Startup and Shutdown


The order in which some processes should be started and stopped is critical to their
operation. If you are attempting to start or stop individual processes, and you want to
make sure you are doing so in an orderly manner, you can check the master.mcp
file in your projects master directory. This file lists, in correct order, the files that
are started up for your project.
For example, the master.mcp file for the Cimpdemo project on a computer whose
Node ID is master, looks like this:

GFK-1180H

System Utilities

34-19

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

Starting A Halted Process


To start a halted process:
1.

Select the process name in the list.

2.

Select Start Process.

3.

When the cpc dialog box opens, select Yes to confirm that you want
this process to start.

If the process starts successfully, its status in the process list changes from "Halted"
to "Running".

34-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Stopping A Running Process


To stop a running process:
1.

Select the process name in the list.

2.

Select Stop Process.

3.

When the cpc dialog box opens, select Yes to confirm that you want
this process to stop.

If the process stops successfully, its status in the process list changes from "Running"
to "Halted".

Starting All Halted Processes


To start all halted processes:
1.

Select Start All.

2.

When the cpc dialog box opens, select Yes to confirm that you want all
processes to start.

If the processes start successfully, their status in the process list changes from
"Halted" to "Running".

GFK-1180H

System Utilities

34-21

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

Refreshing the Process List


The process list shows you the process statuses at the time you connected to the
project. These statuses are only updated automatically when you perform a startup or
shutdown operation. If you have been displaying the list for a while, you can select
Refresh to display the current status of all processes on the list.

Releasing the Connection


If you want to look at another project using CIMPLICITY Program Control:
1.

Select Release to release your connection to the current project.

2.

Select another project from the list of projects.

3.

Select Connect.

Exiting Program Control


All you need to do to release your connection to a project and exit CIMPLICITY
Program Control is to select Exit.

34-22

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Using Measurement Units

About Measurement Units


As a system engineer, you can use the Measurement Units feature to convert an
entire project from one unit of measurement to another (for example Fahrenheit to
Centigrade)all at once. In fact, you can convert the measurement units for part of
the project, a special area in the project, or the entire project, whatever is required at
the time. The scope of the conversion depends solely on the measurement unit that
will be converted and the points assigned to it.
One of the obvious advantages of this straightforward feature is that it can save you
valuable time. For example

When a project for an international company needs to be configured to


operate in several countries that adhere to different measurement
systems, you can use Measurement Units to quickly convert the entire
project, to as many different measurement units, as necessary.

When a project has several points that need to be converted and that
have the same equivalents, you can use Measurement Units to specify
the conversion in one place, at one time, for all the involved points.

Measurement Units conversion complements CIMPLICITY HMIs other conversion


feature, Engineering Unit (EU) conversion. Each serves a particular need. Both offer
a wide range of conversion options.
EU conversion provides an exact way to specify a conversion for an individual point.
(The EU conversion feature is in the Conversion tab of the Point Properties dialog
box.)
Measurement Units provides an efficient way to specify a conversion for a specific
unit of measurement.
For example, a PLC is hooked up to five different thermometers, each of
which uniquely expresses temperature in counts. The system engineer
configures each thermometer as a point and uses the EU conversion to
create each points unique conversion equation. Each equation converts the
counts to Fahrenheit.

GFK-1180H

35-1

If the same PLC configuration needs to be used in a country that measures


temperature in Centigrade, every Fahrenheit measurement must be
converted. In this situation, the system engineer uses the Measurement
Units feature. The engineer specifies only one configuration in one window,
the Measurement Units window, to convert all five points from Fahrenheit
to Centigrade. In addition, this one configuration will convert any other
points in the project to which Fahrenheit is assigned.
To setup for a project wide conversion, you need to:

Configure measurement systems and units.

Specify an active measurement system for the project to use at runtime.

Follow a few guidelines.

When the setup is completed and the configuration is updated, the project data
automatically displays the correct units and labels for the specified measurement
system.

Configuring Measurement Systems and Units


Use the Measurement Units Configuration window to configure the main elements in
the measurement systems and units functionality.
To create your conversion equivalents, you will:

35-2

Start Measurement Units.

Add a new measurement system (if the one you want does not exist).

Create a base measurement unit, by defining a set of base units and


their corresponding labels in the Measurement Units Configuration
window.

Edit base measurement unit entries, if necessary.

Define an equivalent unit for each base measurement unit, by


specifying the label, display format and conversion equations to be
used for each.

Select the correct Base Unit ID for each point in Point Configuration.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

To Start Measurement Units


To start the configuration program, double-click on the Measurement Units icon in
the CIMPLICITY HMI projects configuration cabinet. The Measurement Units
Configuration window opens

The main window contains two panes.

The left pane displays the current list of base measurement units.

The right pane displays unit equivalent details for the particular
measurement system you are working with. You will see a tab in this
pane for each measurement system configured for this project.

Use the Measurement Units window to:

GFK-1180H

Create, modify and delete base measurement units.

Create, modify and delete measurement systems.

Select the active measurement system for the project.

Define equivalence between units.

Using Measurement Units

35-3

Adding a New Measurement System


To add a new measurement system to the right pane:
1.

Select New System from the File menu.


The New Measurement System dialog box opens.

2.

Enter the name of your measurement system in the System ID field


and click OK.
The Measurement System Properties dialog box opens.

Measurement System Properties Defined


Use the Measurement System Properties dialog box to define the display label for the
measurement system. You can also use this dialog box to make the measurement
system the active system when the project starts.

1.

Enter an optional description in the Description field.

2.

Enter an optional display label in the Display label field.

3.

Check the Use at runtime check box if you want this measurement
system to be the active system when the project starts.

4.

Click Enter.

The tab for the new measurement system is added in the right pane.
If Unit IDs exist in the left pane, you will see default values in the Equivalent
Unit ID, Forward Equation, Reverse Equation, Justification and Type
fields.

35-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Copying a Measurement System


To copy a measurement system:
1.

Move the cursor to the tab of the measurement system you want to
copy.

2.

Click the right mouse button.

3.

Select Copy... from the pop-up menu.


The Copy Measurement System dialog box opens.

4.

Enter the name of the new measurement system in the Destination


field.

5.

Click OK.

A new measurement system tab will be created with the name you specified.
If there are existing Unit IDs in the left pane, you will see default values in the
Equivalent Unit ID, Forward Equation, Reverse Equation, Justification
and Type fields for the new measurement system.

Renaming a Measurement System


To rename a measurement system:
1.

Move the cursor to the tab of the measurement system you want to
rename.

2.

Click the right mouse button.

3.

Select Rename from the pop-up menu.


The Rename Measurement System dialog box opens.

4.

Enter the new name of the measurement system in the Destination


field.

5.

Click OK

The measurement system tab will change to the name you specify.

GFK-1180H

Using Measurement Units

35-5

Creating a Base Measurement Unit


To create a new base measurement unit ID:
1.

Do one of the following to start:

Select New Unit from the File menu.

Press Ctrl+N.

In the left pane, click the right mouse button and select New
from the pop-up menu.

The New Measurement Unit dialog box opens.

2.

Enter the name of your base unit in the Unit ID field and click OK.
The Measurement Unit Properties dialog box opens.

Measurement Unit Properties Defined


Use the Measurement Unit Properties dialog box to enter the display label for the
measurement unit.

1.

Enter an optional description in the Description field.

2.

Enter an optional display label in the Display label field. This


display label is automatically selected when a user selects the Unit ID
for a point in Point Configuration.

3.

Click Enter.

The new base Unit ID is added to the end of the list in the left pane. Equivalent
entries are also made in each system you currently have in the right pane.
If you currently have measurement systems defined in the right pane, default values
for the new base unit are automatically entered in the Equivalent Unit ID,
Forward Equation, Reverse Equation, Justification and Type fields for all
the measurement systems.

35-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Editing Base Measurement Unit Properties


There are several ways to rename any Unit ID, description or label.
The fastest way is to:
1.

Position your mouse over what you want to change.

2.

Click twice.

You can now type in your changes.


If you prefer, you can open the Measurement Units Properties dialog box and edit
the description and display label for a base unit. Do one of the following:

Select Unit Properties from the Edit menu.

Press Ctrl+P.

In the left pane, select the base unit, click the right mouse button and
select Properties from the pop-up menu.

Defining an Equivalent Unit


Use the Unit on System dialog box to define (or edit) the information for an
equivalent unit. Do one of the following to open the dialog box:

Click twice in any field in the right pane to edit the field

Select Unit Equivalence from the Edit menu.

Press Ctrl+E.

In the right pane, select the equivalent unit, click the right mouse button
and select Equivalence from the pop-up menu.

The Unit on System dialog box appears.

You can edit any of the following fields in the right pane or in the dialog box:

GFK-1180H

Using Measurement Units

35-7

Equivalent Unit ID
Enter the Unit ID you want to use when the measurement system is active. The Unit
ID may or may not match any other Unit IDs in the configuration.

Forward Equation
Enter the equation to be used by Point Management to convert the base value to its
equivalent in this measurement system.
For example, if point XYZs base value is in inches and you want to display it in
centimeters, use the forward expression %P*2.54001.
If the points base value is the same as its converted value, just put %P in the field.

Reverse Equation
Enter the equation to be used by Point Management to convert the equivalent in this
measurement system to its base value.
For example, if point XYZs base value is in inches and its equivalent value is in
centimeters, use the reverse expression %P/2.54001.
If the points base value is the same as its converted value, just put %P in the field.

Justification
This field is used to align the display of point value.
By default, the project uses the justification you specify when you configure a point.
Select the justification you want to use when displaying the points value on
CimView screens when this measurement system is active, as long as the
Configured option is selected for the CimView object display properties. You can
select one of the following:
Left
Right
Zero

Left justifies the value display


Right justifies the value display
Zero fills the value display

Width
This field represents the number of spaces you want to dedicate to the display of the
point value.
By default, the project uses the display width you specify when you configure a
point.
If you want to use a different display width for all points that use this Unit ID, enter
it in this field.

Precision
This field represents the number of digits to be displayed to the right of the decimal
point.
By default, the project uses the precision you specify when you configure a point.
If you want to use a different precision for all points that use this Unit ID, enter it in
this field.

35-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Type
This field determines the format type used when the point value is displayed.
By default, the project uses the display type you specify when you configure a point.
If you want to use a different display for all points that use this Unit ID, enter it in
this field. Use the drop-down list button to select one of the following:
Fixed

All points that use the Unit ID are displayed in fixed format
using the Width and Precision information you specify. If
you do not specify the Precision, the default is 6.
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. In this case, 10 displays as 10.000.

Scientific All points that use the Unit ID are displayed in scientific
format using the Width and Precision information you
specify. If you do not specify the precision, the default is 6.
Compact

All points that use the Unit ID are displayed 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.

Copying a Measurement Unit


To copy a measurement unit:
1.

Click on the measurement unit you want to copy.

2.

Click the right mouse button.

3.

Select Copy... from the pop-up menu.


The Copy Measurement Unit dialog box opens.

4.

Enter the name of the new measurement unit in the Destination field.

5.

Click OK.
The Measurement Unit Properties dialog box opens.

6.

Fill in the description label for the new measurement unit.


Click
box.

7.

GFK-1180H

for details on using the Measurement Unit Properties dialog

Click OK.

Using Measurement Units

35-9

A new measurement unit will be created with the name you specified.
Equivalent measurement units are also created for each measurement system in the
right pane.

Renaming a Measurement Unit


To rename a measurement unit in the left pane:
1.

Click the measurement unit in the left pane that you want to rename.

2.

Click the right mouse button.

3.

Select Rename from the pop-up menu.


The Rename Measurement Unit dialog box opens.

4.

Enter the new name of the measurement unit in the Destination field.

5.

Click OK

The measurement unit name in the left pane will change to the name you specify.

Deleting a Measurement Unit


You can specify whether or not you want to be prompted before deleting
measurement units.
To be prompted before deleting measurement units:
1.

Select Tools on the Measurement Unit toolbar.

2.

Select Options.
The Options dialog box opens.

3.

Check Prompt before deleting items.

4.

Click OK.

To delete a measurement unit in the left pane:


1.

Click the measurement unit in the left pane that you want to delete.

2.

Select Edit on the Mesurement Unit menu bar.

3.

Select Delete Unit.

A Measurement Unit Configuration dialog prompt appears if you chose to


be prompted.

35-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

4.

Click Yes.

The measurement unit is deleted.

Specifying the Active Measurement System


You can specify an active measurement system in the Measurement Units
Configuration window or in the Project Properties dialog box in the projects
Configuration cabinet. The active measurement system is the measurement system
used at runtime.

Specifying the Active Measurement System From


the Measurement Units Configuration Window
If you want to set the active measurement system in the Measurement Units
Configuration window:
1.

Open the Measurement System Properties dialog box for the


measurement system you want to make active.

2.

Select the Use at runtime check box.


When you select this check box for one measurement system, it is
automatically cleared on all other measurement systems, and the
Measurements tab on the Project Properties dialog box is updated to
reflect your choice.
If you clear the check box for all measurement systems, only the base
conversions are used, and the active measurement system displayed in
the Project Properties dialog box is <None>.

3.

Click OK.

When the project starts, this will be the active measurement system.

GFK-1180H

Using Measurement Units

35-11

Specifying the Active Measurement System From


the Project Properties Dialog box
If you want to set the active measurement system in the Project Options dialog box:
1.

Open the Project Properties dialog box in the projects Configuration


cabinet.

2.

Click the Measurement tab in the dialog box.

3.

Click the drop-down list button to the right of the Active


Measurement System field and select the new active measurement
system.
When you select the measurement system, its Use at runtime check
box in the Measurement Systems Properties dialog box is selected, and
the check boxes for all other measurement systems are cleared.
If you select <None>, only the base conversions are used

4.

35-12

Click OK.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Following a Few Guidelines


Because of the dynamic nature of the Measurement Units conversion, make sure that
your project configuration adheres to these guidelines before you activate your first
Measurement Units conversion. After that, use these guidelines to configure new
points, objects and functions.
The main thing to keep in mind is that CIMPLICITY HMI makes its conversion by
finding points that have a specified base measurement unit and converting them to an
equivalent measurement unit. Therefore any constant value that is not associated
with a base measurement unit will not get converted.
Understanding these concepts is crucial for correctly displaying animations in
CimView. In addition, understanding that background Basic Control Engine
functions executed by the Event Manager always adhere to the base measurement,
will help you avoid unnecessary and incorrect script editing.
For more detail, read:

Floating Point Numbers vs. Integers

Derived Points

Event Manager and Basic Control Engine

CimEdit Management of Animated Objects

CimView Scripts

Floating Point Numbers vs. Integers


The active measurement system always uses floating-point numbers for values of
points that have conversion to that system. When you use Measurement Units
conversion, internal calculations respond to whether you define a point as an integer
or a floating point.
The key to deciding whether to define a point as an integer or floating point is to
determine how much precision that point requires. A floating point gives you the
highest degree of precision.
Here is a brief description of the process.
You define a point as an integer type and assign it a base measurement unit. At
runtime the active measurement system causes that base measurement unit to convert
to its equivalent unit.
When you set the points value (a setpoint), the points value is reverse converted
from the active measurement unit into the base measurement unit. If the point is:

GFK-1180H

An integer, in order to fit the reverse converted value into the integer
specification, the conversion process rounds off the floating value that
was the result of the reverse conversion to the nearest integer.

A floating point, it will be able to hold the floating value that was the
result of the reverse conversion.

Using Measurement Units

35-13

When the point is displayed, the value is forward converted from the base
measurement unit into the active measurement unit. If the point is:

An integer, the forward conversion will use the rounded value in its
calculations. The displayed value will reflect that rounding.

A floating point will hold the floating value that was the result of the
reverse conversion. The displayed value will equal the value at which
you set the point.

In many cases, the rounding effect is totally acceptable. When it is not, use floatingpoint types.

Guideline
For points that need to have the highest level of precision and use Measurement
Units conversion, use the floating point type instead of the integer point type.

Example
Point XYZ is a point with a base unit ID of inches that requires the highest level of
precision. Its initial value is 10 inches.
You use Metric as the active measurement system. As a result, XYZs value displays
as centimeters.
You want to perform a setpoint on XYZ.
Dont
Define XYZ as an integer.
If you then perform a setpoint on XYZ and set it to 26.924 cm.:

26.924 cm. is reverse converted to 10.60 inches.

Because XYZ is an integer, 10.60 is rounded up to 11 inches.

11 inches is forward converted to 27.94 cm.

The point value displays as 27.94 cm.

Do
Define XYZ as a floating-point type.
When you then perform a setpoint on XYZ and set it to 26.924 cm., the internal
conversion is able to store 10.6 inches. As a result, the point, which is the same value
it was set to, displays as 26.924 cm.

35-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Derived Points
By default, when a derived point expression uses a device point, it uses the raw
(unconverted) value of the device point.
When a derived point value is calculated:
1.

Constants are assumed to be in the base units for the point.

2.

The base units for all points in the expression are used.

3.

The result is then converted to the current active measurement system


units for the derived point.

Guideline
Assign a base Unit ID for a derived point that is consistent with the base Unit IDs of
the points in its expression and use constants that are consistent with the base Unit
ID for the derived point.
If you are using Measurement Units and want your derived points to be calculated
correctly, you need to use the Engineering Units (EU) value for device points in your
derived point expressions. You can do this in one of two ways:

Set the PTMDP_DO_EU_CONV global parameter to one (1) to


automatically use the EU value of device points in all derived point
expressions.

Use the EU_CONV function for every device point you use in a
derived point expression to convert the device points to their EU
values.

Example
SOURCE is a device point with a Base Unit ID of inches.
DEST is a derived point with an expression: SOURCE+10.0 (inches).
The value of SOURCE is 1 inch.
You will use Measurement Units conversion to convert the project from inches to
centimeters.
Dont

Assign DEST a measurement unit of centimeters in the Point


Properties box Conversion tab, which is different from SOURCEs
assigned measurement unit, inches.

Leave DESTs measurement unit (in the Conversion tab) blank.

In either case you are creating an inconsistent condition which may produce
confusing results after conversion.
Do
Assign DEST a base measurement unit of inches in the Point Properties box
Conversion tab.
The expression, SOURCE+10.0, will be calculated as 1 inch +10 (inches) = 11
inches
Because DEST has a base measurement unit of inches, it will be included in the
Measurement Unit conversion and will display as 27.94 centimeters.

GFK-1180H

Using Measurement Units

35-15

CimEdit Management of Animated Objects


You can configure animation for any object in CimEdit, to be viewed through
CimView. However, because CimView is a display process, it is crucial that it
reflects the active measurement system.
Animation capabilities in CimEdit include:

Color animation

Movement
Rotation/fill

Scaling

Objects configured for each of these capabilities will take expressions, including
minimum and maximum values. However, when you need to do a conversion, it is
important to take into account how CimView deals with an expressions
minimum/maximum values and their related high/low values.
When CimView processes an objects animation expression, it first looks for
minimum and maximum values specified within the object properties. If it finds
them, it uses them. Because these values are attached to the object, not a point with a
measurement unit, CimView uses the values as entered, independent of the
measurement unit.
Second, if the minimum and maximum fields in the objects Properties dialog box are
blank and the animation expression is a single Point ID, CimView looks for Display
low and Display high values configured in the View tab of the Point Configuration
Properties box. If the Display low and Display high fields:

Are blank, CimView defaults to a constant minimum of 0 and


maximum of 100, independent of the measurement unit.

Contain values, CimView uses those values. Because they are


correctly associated with the points measurement unit, the values will
be converted to the active measurement unit at runtime.

For more information on display limits see the following chapters in the
CIMPLICITY HMI CimEdit Operation manual:

Object Properties chapter (GFK-1396)

Point Configuration chapter (GFK-1180).

For more information on display limits see the following chapters in the
CIMPLICITY HMI CimEdit Operation manual:

35-16

Object Properties chapter (GFK-1396)


Point Configuration chapter (GFK-1180).

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Guidelines
If you want to guarantee that your animation will properly adjust to measurement
system changes at runtime, make sure that for every animation expression using a
single point ID in your CimView screens, the:

Minimum and Maximum fields in CimEdit are blank so the point


display limits are used.

Display low and Display high fields are filled, in the View tab of the
Point Properties dialog box.

Example
Using the U.S. Customary system as the active measurement system, you want to
move an object from a lowest value (0 inches) on the left of the screen to a highest
value (100 inches) on the right of the screen, as the points value changes.
You then change the active measurement system from U.S. Customary to Metric. As
a result, the measurement units are converted from inches to centimeters
Dont
Specify 0 (inches) as the expression minimum value and 100 (inches) as the
expression maximum value in the objects configuration window.
If the point in the animation expression has a base value of 8 inches (displayed as
27.32 cm.), it will cause CimView to incorrectly place the animated object within
the 0-100 limits because it thinks the 0-100 limits are centimeters. Because the range
is incorrect, CimView will display the value too far to the right. (The range should
be 0-254 cm.)
Do
Leave the objects fields blank and enter 0 in the points Display low, 100 in its
Display high field in Point Configuration.
If the point in the animation expression has a value of 8 inches (displayed as 27.32
cm.), CimView will properly place the animated object within the limits, because
they are converted to centimeters. (0-100 is now 0-254.)

CimView Scripts
CimView uses Basic scripts, which can, among many other things, use the runtime
value of a point.
When you use point values within scripts, the values correspond to the active
measurement system. Therefore, if you compare or manipulate values with other
values that are constant, you will most likely run into trouble if you switch active
measurement systems. This is because your constant numbers will stay the same, but
the point values will most likely change due to unit equivalence.

Guidelines
You have to take into consideration that the point values will vary depending on the
active measurement system. Therefore, make sure that values in the script are all
relative; conversely, that there are no absolute values in the script.

GFK-1180H

Using Measurement Units

35-17

Event Manager and Basic Control Engine


The Event Manager, which is a background process, sees point values in the points
base measurement unit. Because it is a background process, the users will never see
the values it is working with. They only see the action, for example, an alarm going
off, that has been triggered by the event.
This means, for example, that if you need an alarm to go off when the water in a tank
reaches a certain level, the alarm will go off when the water reaches that level, no
matter what measurement system is being used.
Of course, you can also associate Events with internal functions, such as timing.
These functions are unaffected by any conversion.

Guidelines
When you specify point values in the Event Editor, enter them for the base
measurement unit. The actions you specify will occur when the point value for the
event, such as Point Equals, is reached.
Dont change anything in the Event Manager configuration if you are changing the
active measurement system.

Example
You have a point called WaterLevel and you have an action that gets triggered when
the level reaches 100 inches. Your base unit is inches and the project is converted to
centimeters.
Do
Dont do anything.
When you use the Metric system as the active measurement system, the event will
not get triggered until the level hits 254 centimeters, which is equivalent to 100
inches. The Event Manager internally sees the value as 100 inches and triggers the
event properly.

35-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

System Management

About System Management


There are several procedures that you may need to use over time to manage your
CIMPLICITY HMI projects.
These procedures include:

Modifying CIMPLICITY HMI Global Parameters

Modifying CIMPLICITY HMI logical names

Removing Login information

Deleting CIMPLICITY HMI information for the Registry

Configuring site wide installation for Enterprise network architecture

Implementing security features

Activating an OEM key

Defining remote projects

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-1180H

36-1

Editing the File


To change a global parameter, select Command Prompt from the Tools menu in
the Workbench for the project where you want to change the parameter, then do the
following:
1.

Enter the following commands in the Command Prompt window:


cd <dir>
idtpop glb_parms
notepad glb_parms.idt
where <dir> is the directory where you need to make the changes.
For global parameters that apply to all projects, this will be
%BSM_ROOT%data. For all other global parameters, this will be
%SITE_ROOT%master.

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).
Note: the Global Parameters file that is used on a Viewer is located in the
CIMPLICITY installation directory in a subdirectory called data (e.g.,
c:\cimplicity\hni\data).

Parameters Modified through Configuration


Functions
The following global parameters are manipulated by configuration interfaces and
should not be changed manually.
DB_QUEUE_SIZE

RTR_ACCEPT_CONN

DBDL_DEVICE_CHECK_PERIOD

RTR_DISABLE_BCAST

DOWNLD_PASSWD

RTR_STANDALONE

GMR_HRTBT_TIMER

SETPOINT_SECURITY

GMR_MODE_ADDR

STARTUP_TIMEOUT

PTDL_QUANTIZATION

SYSNAME

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.

36-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

DT_UPD_INTERVAL
Sets the interval in seconds to update a Projects Date & Time system points.
Record format is:
DT_UPD_INTERVAL|3|<seconds>

If you do not configure this parameter, the default timeout is 10 seconds.

FIRST_WEEK_DAYS
Sets the minimum number of days in a week in the current year required to qualify
for the first week of the year.
Record format is:
FIRST_WEEK_DAYS|3|<days>
If you do not configure this parameter, the default number of days is 1.

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.

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 Workbench to change this parameter.

GFK-1180H

System Management

36-3

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>

If you do not configure this parameter, the default timeout is 10 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>

36-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Parameters Modified for All Projects


The following global parameters are applied to all projects on a computer. They
have to be modified in the Global Parameters file in the %BSM_ROOT%data
directory of each computer where you want them to apply:
CONNECT_DROP_PERIOD

IPC_QUEUE_SIZE

CONNECT_RETRY_PERIOD

REDUND_LINK_SLEEP

IPC_BCAST_INTERVAL

RTR_MAX_OUTMESSAGE_COUNT

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>

The default time in the distributed Global Parameters file is 90 seconds.


Note
Entering a value of less than 30 seconds is not recommended.

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>

The default in the distributed Global Parameters file is 90 seconds.

GFK-1180H

System Management

36-5

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>

If the parameter is not defined, a default value of 50 is used.

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>

where <number> is the number of seconds to wait.


If you do not use this parameter, the default value is 5 seconds.

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>

The default count in the distributed Global Parameters file is 1000.

36-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Parameters Modified Per Project


The following global parameters are applied to individual projects. They are
modified in the Global Parameters file in the projects %SITE_ROOT%master
directory:
ACK_TOUT

GSM_ASC_FONT_SIZES

AM_RESET_ACK_STATE

GSM_ASC_SCALE

AMLP_USE_GEN_TIME

GSM_CACHE_SIZE

CE_MAX_DELAY

GSM_EXPONENT_PRECISION

CE_MAX_THREADS

GSM_SPCONFIRM_DEFAULT

CE_THREAD_TIMEOUT

GSM_STALE_COLOR_KEY

CLR_TOUT

GSM_UNAVAIL_COLOR_KEY

DBDL_ABORT_TIMEOUT

LOGIN_NOSAVE

DB_DEBUG

LOGIN_RETRY_PERIOD

DB_ENABLE_TRANSACTIONS

LOG_OPT

DB_QUEUE_OVERFLOW_DELAY

MAX_STACKED

DB_TIMESTAMP_PRECISION

MAX_TREND_BUF

DEL_OPT

PB_DIAGS

DONT_VERIFY_ESPOINT_FRID

PROJECT_ID

EMEP_BUF_SIZE

PTMDP_DO_EU_CONV

GSM_ANNUN_DIG_OFF

PTMRP

GSM_ANNUN_DIG_ON

RAW_LIMIT_ALARM

GSM_ANNUN_ALARM_H2

REPEAT_TOUT

GSM_ANNUN_ALARM_H1

SHORT_FILENAMES

GSM_ANNUN_ALARM_L1

SVC_RETRY_COUNT

GSM_ANNUN_ALARM_L2

SVC_RETRY_DELAY

GSM_ASC_FONT_NAME

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

GFK-1180H

System Management

36-7

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

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>

36-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

CLR_TOUT
The time in minutes before an alarm is automatically reset by the Alarm Management
Resident Process. If this parameter is defined, it is the default used for Reset
Timeout in the Point and Alarm Alarm Options properties. If this parameter is not
defined, zero is used for the default.
Record format is:
CLR_TOUT|3|<minutes>

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>

The default time in the distributed Global Parameters file is 50 ticks.

DB_DEBUG
Enables the dumping of diagnostic information for the Database Logger to the
MAC_DL.out and MAC_PTDL.out files in your projects log directory.
Record format is:
DB_DEBUG|1|<value>

Where <value> can be any combination of:


0

Stop dumping diagnostic information

Print full syntax of ODBC error messages

Print details of database connection when established

Print syntax of ODBC statements if they fail

Rename/keep store and forward files after loading them

4096

Print application-specific details

If you do not define DB_DEBUG, the default is to print the full syntax of ODBC
error messages. Since ODBC errors should happen infrequently, this is unlikely to
cause problems with disk space.
You must explicitly specify a value of 0 (zero) to stop dumping diagnostic
information to the log files.
If you need additional diagnostic information, a value of 7 (1+2+4) is recommended.
Additional undocumented values should only be used by GE Fanuc engineers as they
send a great number of messages to MAC_DL.out and MAC_PTDL.out that could
quickly fill your available disk space.

GFK-1180H

System Management

36-9

DB_ENABLE_TRANSACTIONS
For the Database Logger, overrides the default database functionality as requested by
ODBC.
Options are:
Y

Forces logging to use transactions.

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>

The default time in the distributed Global Parameters file is 30 minutes.

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

Reset only

AR

Acknowledge and reset

Record format is:


DEL_OPT|1|<option>

The default requirement in the distributed Global Parameters file is AR.

36-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

DONT_VERIFY_ESPOINT_FRID
Changes the behavior of Setpoint Security for Enterprise Server points.
The options are:
Y

Setpoint Security for all points from a given provider are enforced against
the Resource IDs as configured on the provider.
This means that a setpoint against any of these points with resources not
configured on the Enterprise Server project will always fail since a resource
that is not configured cannot be in a users view.

If an Enterprise Server project contains the same Resource IDs as a given


provider, then Setpoint Security for points from the provider are enforced
against the Enterprise Server Resource IDs.
If a resource for a given point is not configured on the Enterprise Server,
then Setpoint Security for that point is enforced against the remote projects
resource.

Record format is:


DONT_VERIFY_EXPOINT_FRID|1|<flag>

If the parameter is not defined, the default is "N".

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>

If this parameter is not defined, the default value is 10.

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>

where <color_number> is a number from 0 to 15 and <blink> is YES or NO.


The color associated with each number is defined in RGB.DAT.
If this parameter is not defined, the default is color 7, no blinking.

GFK-1180H

System Management

36-11

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>

where <color_number> is a number from 0 to 15 and <blink> is YES or NO.


The color associated with each number is defined in RGB.DAT.
If this parameter is not defined, the default is color 6, no blinking.

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>

where <color_number> is a number from 0 to 15 and <blink> is YES or NO.


The color associated with each number is defined in RGB.DAT.
If this parameter is not defined, the default is color 15, no blinking.

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>

where <color_number> is a number from 0 to 15 and <blink> is YES or NO.


The color associated with each number is defined in RGB.DAT.
If this parameter is not defined, the default is color 14, no blinking.

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>

where <color_number> is a number from 0 to 15 and <blink> is YES or NO.


The color associated with each number is defined in RGB.DAT.
If this parameter is not defined, the default is color 10, no blinking.

36-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

GSM_ANNUN_ALARM_L2
The color and blink state to be displayed when an analog point is in Alarm Low state
for Alarm State color animation.
Record format is:
GSM_ANNUN_ALARM_L2|1|<color_number><blink>

where <color_number> is a number from 0 to 15 and <blink> is YES or NO.


The color associated with each number is defined in RGB.DAT.
If this parameter is not defined, the default is color 13, no blinking.

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>

If this parameter is not defined, the default is MS Console.

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>

If this parameter is not defined, the default values are:


112, 140, 168, 280, 364, 560, 602, 602, 602, 602, 602, 602, 602, 602, 602, 602

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.

GFK-1180H

System Management

36-13

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 <selection> is OK, Skip or Cancel.


If you select a default that is not available in the dialog box, CimView uses the OK
button as the default.

36-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

GSM_STALE_COLOR_KEY
If a point being displayed in a Text object on a CimView screen is unavailable and
there is last available data, you can set the GSM_STALE_COLOR_KEY parameter
to display the value in that color rather than displaying the default text. If no last
available data exists, the default text is displayed.
Record format is:
GSM_STALE_COLOR_KEY|1|RGB(<red>,<green>,<blue>)

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.

Enable the "Save Password" capability.

Record format is:


LOGIN_NOSAVE|1|<option>

If the parameter is not defined, the "Save Password" capability is enabled.

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>

The default in the distributed Global Parameters file is 15 seconds.

GFK-1180H

System Management

36-15

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

Alarm is acknowledged

Alarm is reset

Alarm is deleted by a user.

Record format is:


LOG_OPT|1|<options>

The default in the distributed Global Parameters file is no logging 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>

The default in the distributed Global Parameters file is 0 (zero).

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>

If you do not define this parameter, the default maximum is 200.

36-16

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

PB_DIAGS
Use this parameter to enable/disable Point Bridge diagnostics.
Record format is
PB_DIAGS|1|LEVEL=<num1>,FILECLOSE=<num2>,DBGCHK_SECS=<num3>,
DUMPPOINT

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>

GFK-1180H

System Management

36-17

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.

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>

The default in the distributed Global Parameters file is MASTER_PTM0_RP.

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>

The default in the distributed Global Parameters file is YES.

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

36-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

SHORT_FILENAMES
Important
Do not modify this option unless instructed to by GE Fanuc support
personnel.
Enable or disable support for short (8 characters or less) filenames. The options are:
YES

This option is enabled. Users cannot use filenames greater than 8


characters.

NO

This option is disabled. Users can use any length filenames.

Record format is:


SHORT_FILENAMES|1|<option>

The default option in the distributed Global Parameters file is NO.

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.

GFK-1180H

System Management

36-19

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

36-20

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Sample File
The following is a sample GLB_PARMS.IDT file:
|-* IDT file generated by IDTPOP utility v1.0
* RECORD: GLB_PARMS SYSTEM GLOBAL PARAMETERS
*
*
0 PARM_ID
Global Parameter Identifier
*
1 parm_type
CH-0,S-1,IS-2,I-3,BT-4,WRD-5,LG-6,BL-7
*
2 parm_value Parameter Value up to 80 chars
*
ACK_TOUT|3|0
CLR_TOUT|3|0
CONNECT_DROP_PERIOD|3|600
CONNECT_RETRY_PERIOD|3|90
DBDL_ABORT_TIMEOUT|1|50
DBDL_DEVICE_CHECK_PERIOD|1|30
DB_QUEUE_OVERFLOW_DELAY|1|30
DB_QUEUE_SIZE|1|20
DEL_OPT|1|AR
DOWNLD_PASSWD
DYN_CFG|1|YES
GSM_UNAVAIL_COLOR_KEY|1|0
IPC_BCAST_INTERVAL|1|90
LOGIN_RETRY_PERIOD|3|15
LOG_OPT|1|
MAX_STACKED|3|0
PTDL_QUANTIZATION|1|100
PTMRP|1|MASTER_PTM0_RP
RAW_LIMIT_ALARM|1|YES
REPEAT_TOUT|3|0
RTR_ACCEPT_CONN|1|Y
RTR_DISABLE_BCAST|1|Y
SETPOINT_SECURITY|1|NO
SHORT_FILENAMES|1|NO
SVC_RETRY_COUNT|1|30
SVC_RETRY_DELAY|1|100
SYSNAME|1|MMI_ONE

GFK-1180H

System Management

36-21

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:

36-22

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

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

DC_CONNECT_MS

Change the number of milliseconds to wait


for a connection to be established between
poll checks.

DC_CONNECT_URETRY_CNT

Change the number of retries to re-establish


communications between poll checks.

DC_TCP_POLLS_MS

Change the number of milliseconds in the


polling interval.

DCQ_DEAD_TIME

Change the number of seconds to wait


before declaring a device dead.

MMAX_SYNC_TICKS

Changes how long (in ticks) to wait for a


synchronous response from a device, once
the request has been made of the device.

MSYNC_TICKS

Changes how long to wait for a


synchronous response from a device, once
the request has been made of the device.

Logical names that you may want to consider modifying for SNP Communications
are:
BSM$SNP_T1_TIME

Controls the time between SNP messages.

BSM$SNP_ATTACH_DELAY

Controls the time delay before SNP attach


messages.

Editing the File


Entries in the log_names.cfg file are in the following format:
<logical_name>|<type>|default|<length>|<value>

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

GFK-1180H

System Management

36-23

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

Deleting Login Information


When a user logs in to a project, the user is given the opportunity to save the
Username and Password used. When a user logs in to a project from a Viewer, the
user is also given the opportunity to request that the login occur automatically when
the system reboots.
You can use the Login Panel utility to delete saved login information from the
System Registry.

36-24

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Removing Registry Information


Important
It is possible to cause serious damage to your operating system by
using RegEdit and RegEdt32. Be careful not to delete anything that is
not listed in these instructions.
After CIMPLICITY software has been removed from your computer (either manually
or via the Uninstall utility on Windows NT or the Add/Remove applet on Windows
NT), it may be necessary for you to remove registry information. The following
sections detail what you need to do to accomplish this for Windows 95 and
Windows NT systems.

Removing Windows 95 Registry Information


For Windows 95, run regedit, and do the following:
1.

Open HKEY_CURRENT_USERS, open Software, and delete GE


Fanuc Automation.

2.

Open HKEY_CLASSES_ROOT, and delete the following:

.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

GFK-1180H

System Management

36-25

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

2.

Run RegEdt32 and delete the following:


\\HKEY_CURRENT_USER\Software\GE Fanuc Automation
\\HKEY_LOCAL_MACHINE\Software\GE Fanuc Automation

36-26

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Site Wide Installation


CIMPLICITY HMI Site Wide Installation is for Enterprise Network Architecture. It
takes advantage of the features of the Microsoft Systems Management Server (SMS)
You must know the following about the Microsoft Systems Management Server
before starting site wide installation:

How to Install SMS Server and SMS Client

How to create a Package

How to Create a Job

How to remove a Package

SMS Software Management

This document has two sections.

The first section is about the Microsoft Systems Management Server


(SMS). It briefly explains what SMS is and how it can be used for
software distribution.
For more information about SMS, please see the Microsoft Systems
Management Server documentation in the Microsoft Developers
Network Books Online.

GFK-1180H

The second section of this document explains the procedure of site wide
installation. CIMPLICITY HMI software provides some tools for
making site wide installation procedure easier. This section gives step
by step instructions to use them.

System Management

36-27

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.

36-28

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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
packages 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 directorys 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.

GFK-1180H

System Management

36-29

The server where the package directory is shared is called the distribution server
because it serves as a distribution point for the package source directory. When a
user selects a package command line using the Package Command Manager, the
Package Command Manager connects to the package share of the distribution server
for the package share. The Package Command Manager then runs the package
command using the package share as the current directory.
Once a package has been distributed to servers at a site, the packages command can
be run at clients in the site. From the list of computers specified in the Job Target for
the job, the Despooler at the target site creates an instruction file for each target client
for running the package command. The SMS Maintenance Manager replicates these
instruction files to all logon servers at the site.
When the user at the client starts the Windows environment or explicitly starts the
Package Command Manager, the Package Command Manager checks a logon server
for package command instructions (the Package Command Manager checks for
incoming jobs at an interval specified in the Options dialog box.). The package
command is made available to the user according to the instructions specified by the
Run Workstation Command settings for the job.

36-30

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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

Creating the Application Source Directory


Note
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.
To create the Application Source Directory on your SMS server:

GFK-1180H

1.

Insert CIMPLICITY CD-ROM into CD-ROM drive of SMS server.

2.

From File Manager/ Start Menu run SMSSETUP.BAT on the


CD-ROM. The Setup dialog box opens.

3.

In the Setup dialog box:

In Select platform, select the platforms on which CIMPLICITY


HMI for Windows NT and Windows 95 is to be installed.

In the Target Path, enter the name of the Application Source


Directory. The default directory is c:\cimpsms.

Make sure that the system has enough disk space.

Select OK to copy the files to the Application Source Directory.

System Management

36-31

After the files are copied, the Select CIMPLICITY Options dialog box
opens automatically.

4.

In the Select CIMPLICITY Options dialog box:

Check the Upgrade box if you want to allow an upgrade during


installation.

Now do the following for each product you want to install:

Select the product type in the Select Options for combo box.
All options for that product will be displayed.

Select the CIMPLICITY options you want to install.

Select Apply.
Note

Each product that has been modified will have an asterisk (*) in front of its name in
the Select Options for combo box.

5.

36-32

After you have selected all the product options to be updated,


select Close to close the dialog box.

Share the Application Source Directory with the same name (for
example, the share name for c:\cimpsms is CIMPSMS).

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

5.

In the File Browser dialog box:

In the File Name box, select CIMPLCT.PDF.

Select OK.

The File Browser dialog box closes and the Package Properties dialog
box redisplays.

GFK-1180H

System Management

36-33

6.

In the Package Properties dialog box, select Workstations.


The Setup Package for Workstations dialog box opens.

7.

In the Setup Package for Workstations dialog box:

In the Source Directory box, enter the location of the


Application Source Directory. You can use the Browser button to
the right of the box to find it.

Select Close.

Creating Job for CIMPLICITY HMI Installation


To create the job for CIMPLICITY HMI for Windows NT and Windows 95
installation:
1.

In the SMS Administrator, open the Job window.

2.

From the File menu, select New.


The Job Properties dialog box opens.

3.

In the Job Properties dialog box:

36-34

Enter a meaningful comment in the Comment box (for example,


CIMPLICITY 3.1 Installation)

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Select Details.
The Job Details dialog box opens.

4.

In the Job Details dialog box:

In the Package box, select the CIMPLICITY 3.1 package.

In the Job Target box, select an appropriate job target.

In the Run Workstation Command, select the type of setup.

Select all other applicable options.

Select OK.

This will create a job for CIMPLICITY HMI Site wide installation
5.

GFK-1180H

Once the job is executed, this package can be deleted.

System Management

36-35

CIMPLICITY Security Features


CIMPLICITY HMI software lets you implement the following security features:

Login Password

Role Privileges

Setpoint Security

Setpoint Password

Security Audit Trail

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 users 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 Users Manual (GFK-1180).

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

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 Users Manual (GFK-1180).

36-36

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 users 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 projects resource.
For more information on Point Configuration, see that chapter in the CIMPLICITY
HMI for Windows NT and Windows 95 Base System Users 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 Users Manual (GFK-1180).

GFK-1180H

System Management

36-37

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 Users 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 Users Manual
(GFK-1180).

Point Control Panel Alarm Changes


The Point Control Panel alarm change alarms record the type of change, the Point ID
being changed, the CIMPICITY login user name of the user, the computer login user
name of the user and the computer name.
The $ALARM_DISABLED alarm is generated when a user disables alarming for a
point. The alarm message contains the following information:
Alarm detection disabled for: <point_id> by <user_id>
(<OS_user> @ <computer_name>)

The $ALARM_ENABLED alarm is generated when a user enables alarming for a


point. The alarm message contains the following information:
Alarm detection enabled for: <point_id> by <user_id>
(<OS_user> @ <computer_name>)

The $ALARM_MODIFIED alarm is generated when a user modifies the alarm limits
for a point. The alarm message contains the following information:
Alarm limits modified for: <point_id> by <user_id>
(<OS_user> @ <computer_name>)

The $ALARM_RESTORED alarm is generated when a user restores the alarm


limits for a point. The alarm message contains the following information:
Alarm limits restored for: <point_id> by <user_id>
(<OS_user> @ <computer_name>)

36-38

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Setpoint Downloads
A user can download setpoints from:

CimView screens

The Point Control Panel

Recipes

Setpoints can also be downloaded from Basic Control Engine scripts


The $DOWNLOAD alarm is generated when a user downloads a setpoint or a
recipe. The alarm message contains the following information:
<point_id> <value> <user_id> (<OS_user> @ <computer_name>)

Dynamic Configuration Changes


A user can enable Dynamic Configuration only if the role the user is assigned has
been granted that privilege.
The $DYN_CFG alarm is generated each time a user makes a configuration change
while Dynamic Configuration enabled. The alarm message contains the following
information:
<type> <name> changed by <user_id> (<OS_user> @
<computer_name>)

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 $LOGIN alarm is generated when a user successfully logs in to a CIMPLICITY


HMI project. The alarm message contains the following information:
User ID <user_id> @ <computer_name> logged on

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

GFK-1180H

System Management

36-39

OEM Key
The OEM Key is designed to allow OEMs and Integrators to maintain installed
CIMPLICITY HMI Runtime systems for their customers. It lets you temporarily
convert a CIMPLICITY HMI Runtime System License on a computer to a
CIMPLICITY HMI Development System License.
When you activate OEM Key on a computer, you must stop all projects that are
currently running on the computer.
While OEM Key is active on a computer:

The Development System License only applies to projects running on


the computer.

Projects that you start on the computer cannot access data from or
provide data to other CIMPLICITY HMI projects.

OEM Key terminates at the end of two hours. You can terminate it earlier by exiting
the OEM Key application. When OEM Key terminates, all running projects are
stopped.

OEM Key Activated


To activate OEM Key:
1.

Open the Explorer or a Command Prompt window

2.

Locate the CIMPLICITY HMI exe directory.


(If you accepted the default location for CIMPLICITY HMI software
during installation, it is C:\CIMPLICITY\HMI\exe.)

3.

Run oemkey.exe.

The CIMPLICITY License Agreement dialog box opens.

36-40

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

If you select No, OEM Key terminates.


To accept all the terms of the license agreement, select Yes. The next dialog box
that opens depends on your computer status:

GFK-1180H

If any projects are running, the OEM Key dialog box opens.

If no projects are running, the CIMPLICITY HMI OEM Key dialog box
opens.

System Management

36-41

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.

36-42

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Starting OEM Key


The CIMPLICITY HMI OEM Key dialog box shows you the time left on OEM Key.

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.

Terminating OEM Key


OEM Key terminates at the end of two hours. You can terminate it earlier by exiting
the CIMPLICITY HMI OEM Key dialog box. When OEM Key terminates:

It displays a dialog box warning you that it will stop all running
projects.

It stops all running projects.

It converts your temporary Development System License back to your


Runtime System License.

You can now restart your projects.

GFK-1180H

System Management

36-43

Remote Projects
If, when a 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.
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 Workbench
for your project.
The Configuration - Projects window opens.

36-44

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

GFK-1180H

System Management

36-45

General for Remote Project

In the General property page, enter information in the following fields:


CIMPLICITY User Id

Enter the CIMPLICITY User ID for the remote


project login.

Password

Enter the password, if any, for the remote


project login.

Reenter Password

If you are entering a password, re-enter it here


to confirm it.

Enable

Set this check box to enable the login.


If you clear the check box, the login will not be
made.

Resident Process Use Only

Set this check box if you only want resident


processes to automatically log in to remote
projects. Users will still have to log in at the
Application level.
If you clear this check box, users will not have
to log in at the Application level, and they are
automatically given the same privileges as the
CIMPLICITY User ID for the remote login.

36-46

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Enterprise 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.
In the Enterprise property page, 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.
Enter the following information:
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.

GFK-1180H

System Management

36-47

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 projects 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
Diagnostic points are not available for the Point Bridge.

Point Bridge Point Configuration Details


The standard features of CIMPLICITY device points such as alarming and logging
apply to Point Bridge points.
Points configured incorrectly will remain in an unavailable state. The Point Bridge
Device Communications process will generate error messages regarding
configuration errors. These can be found in the projects Status Log and the PB.ERR
file.
The local point and the associated remote (source) point must have identical Point
Class, Data Type, and number of Elements.

36-48

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

The fields described below have configuration values that are unique to or have
special meaning for Point Bridge communications:
Device

For CIMPLICITY HMI for Windows NT and Windows 95


systems, enter the project name on the source system where
the Point Translation process is running.
For other CIMPLICITY systems, enter the node name of the
source system where the Point Translation process is running.

Point ID

Enter the name by which the point will be referenced in this


system. This does not need to match the Point ID on the
source system, but it can if desired.

Access

Specify if the Point Bridge process can set the value of a point
on a source system.
WRITE access is only valid if it is configured for the point on
the Point Bridge system and on the source system.

GFK-1180H

Update Criteria

Only UNSOLICITED updates are supported.

Address

Enter the Point ID of the point on the source system.

Poll After Set

Clear this check box. Point Bridge does not support this
feature.

System Management

36-49

Using CIMPLICITY HMI with


Remote Access

About Remote Access


You can use the Remote Access features of Windows NT and Windows 98/95 to let
users with CIMPLICITY HMI Viewer software on a Client computer access
CIMPLICITY HMI project data on a Server computer through modems.

This document shows you how to:

GFK-1180H

Install and configure the Remote Access Service on Server computers


running Windows NT.

Install and configure the Remote Access Service on Client computers


running Windows NT.

Install and configure Dial-Up Networking on Client computers running


Windows 98/95.

Configure the cimhosts.txt file for the Server computer.

Test the connection between the Server and Client computers.

37-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 98/95

CIMPLICITY HMI Viewer software

Modem

Pictorially, the configuration looks like this:

37-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 98/95 installed

A modem

The Microsoft Windows NT or Windows 98/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.

GFK-1180H

Using CIMPLICITY HMI with Remote Access

37-3

Server Setup (Windows NT)


For a Server computer running Windows NT and the CIMPLICITY HMI Server, you
need to install the Remote Access Service. After you install the service, you will
need to configure the Remote Access Server for automatic startup and grant users
logging in from Client computers dial-in privilege.

Installing the Remote Access Service


To install the Remote Access Service:
1.

Open the Control Panel.

2.

Double-click on the Network icon.

3.

In the Network dialog box, select the Services property sheet.

4.

In the Services property sheet, click Add.

5.

In the Select Network Service dialog box, select Remote Access


Service from the list of services, then click OK.
The computer will start installing the Remote Access Service. If it
needs to use the Microsoft operating system CD, the installation
procedure will prompt you for it.
In addition, if you have not yet installed your modem driver, the
installation procedure will guide you through that installation.

After the software installation completes, the Remote Access Setup dialog box opens
automatically.

37-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

1.

Click Configure....
The Configure Port Usage dialog box opens.

For the Server, the minimum selection for Port Usage is Receive
calls only.

2.

Select the port usage you want for the modem.

Click OK to return to the Remote Access Setup dialog box.

Click Network. The Network Configuration dialog box opens.

Make sure that NetBEUI and TCP/IP are selected for Server
Settings.

GFK-1180H

Using CIMPLICITY HMI with Remote Access

37-5

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

Click Configure... for NetBEUI.

In the RAS Server NetBEUI Configuration dialog box:

4.

Select the type of client access you want. If the Server does not
have a Network Interface Card (NIC) installed you must select the
This computer only option. Otherwise RAS will fail to start.

Click OK to close the dialog box and return to the Network


Configuration dialog box.

Click Configure... for TCP/IP.


The RAS Server TCP/IP Configuration dialog box opens.

37-6

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

In RAS Server TCP/IP Configuration dialog box:

Under Allow remote TCP/IP clients to access, select the


access option you want. If the Server does not have a Network
Interface Card (NIC) installed you must select the This
computer only option. Otherwise RAS will fail to start.

Select Use static address pool, and enter the two consecutive
IP addresses you requested from your Network Administrator in
the Begin and End fields. The Begin address is assigned to the
modem on the Server, and the End address is assigned to the
Client.
Note

It is also possible to select Use DHCP to assign remote TCP/IP client


addresses to perform the allocation of IP Addresses.

Click OK to close the dialog box and return to the Network


Configuration dialog box.

5.

Click 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, click Continue... to return to


the Network dialog box.

7.

Click OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.

Further Configuration for the Server


After you configure the Remote Access Server, you will need to configure it for
automatic startup, and grant users logging in from Client computers dial-in privilege.

Configuring Automatic Startup


The Remote Access Server is installed with Startup Type set to Manual. To
change to Automatic on the Windows NT computer that will act as the Server for
remote access:
1.

Open the Control Panel.

2.

Double-click on the Services icon.

3.

In the Services dialog box:

4.

GFK-1180H

Double-click on the Remote Access Server service.

In the Service dialog box, select Automatic for the Startup


Type.

Click OK to close the dialog box and return to the Services dialog
box.

Click Close to close the Services dialog box.

Using CIMPLICITY HMI with Remote Access

37-7

Granting Client Dial-in Permission


To grant dial-in permission to users on Client computers:
1.

From the Start menu, select Administrative Tools.

2.

From Administrative Tools, open the Remote Access Admin


program. The Remote Access Admin window opens.
Note

If you see the message "Remote Access Service is not started on the selected server",
you need to start up the service.
3.

From the Users menu, select Permissions.


The Remote Access Permissions dialog box opens.

4.

In the Remote Access Permissions dialog box:

Make sure that all the users who will be dialing in as clients have
Dialin permission.

Click OK to return to the Remote Access Admin window.

Your Server is now set up.


Before the CIMPLICITY Viewer will be able to list projects running on the network
you will need to either start a CIMPLICITY Project or the CIMPLICITY Viewer on
the RAS server.

37-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Installing the Remote Access Service


To install the Remote Access Service on a Windows NT computer:
1.

Open the Control Panel.

2.

Double-click on the Network icon.

3.

In the Network dialog box, select the Services property sheet.

4.

In the Services property sheet, click Add.

5.

In the Select Network Service dialog box, select Remote Access


Service from the list of services, then click OK.
The computer will start installing the Remote Access Service. If it
needs to use the Microsoft operating system CD, the installation
procedure will prompt you for it.
In addition, if you have not yet installed your modem driver, the
installation procedure will guide you through that installation.

After the software installation completes, the Remote Access Setup dialog box opens
automatically.

GFK-1180H

Using CIMPLICITY HMI with Remote Access

37-9

1.

Click Configure....
The Configure Port Usage dialog box opens.

For the Client, the minimum selection for Port Usage is Dial out
only

2.

Select the port usage you want for the modem.

Click OK to return to the Remote Access Setup dialog box.

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

37-10

3.

Click 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, click Continue... to return to


the Network dialog box.

5.

Click OK to close the Network dialog box. The system will finish
configuring the Remote Access Server and reboot the computer.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Further Configuration for the Viewer


After you install the Remote Access Server, you will need to configure the Dial-Up
Networking option.
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.

If the RAS client does not have a Network Interface Card (NIC) be sure to enable the
option Use default gateway on remote network in the phone book
entry for each RAS server that you will connect to.

Client Setup (Windows 98/95)


For Client (CIMPLICITY HMI Viewer) computers running Windows 98/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:

4.

Select the Windows Setup tab.

Select Communications.

Click Details... .

In the Communications dialog box, select Dial-Up Networking,


and then click OK.

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

GFK-1180H

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.

Using CIMPLICITY HMI with Remote Access

37-11

Lastly, you need to configure your network properties.


1.

Open the Control Panel.

2.

Double-click the Network icon. The Network dialog box opens.

3.

Select the Configuration tab. Note that NetBEUI->Dial-Up Adapter


and TCP/IP->Dial-Up Adapter now appear in the list of network
components.

4.

Select TCP/IP -> Dial-Up Adapter and display its properties. You
need to do the following:

Disable DNS Configuration.

Leave Gateway blank.

For WINS Configuration, select DHCP for WINS


Resolution.

Select Obtain and IP address Automatically.

For Bindings, select Client for Microsoft Networks.

For Advanced, select none.

5.

Select the Identification tab and enter a name (9 characters or less) for
the computer.

6.

Click OK to close the Network dialog box and save your changes.

Your Client is now set up for remote access.

37-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configuring the CIMHOSTS.TXT File


CIMPLICITY HMI software needs to be configured on the RAS Server to exclude
the IP address used by the RAS server. You do this by specifying the IP address
configured for the RAS serverss NIC (Network Interface Card) in the
cimhosts.txt file.
You can find a sample version of the cimhosts.txt file, called
cimhosts_sample.txt in the directory etc below the directory where
CIMPLICITY HMI was installed.
Place the cimhosts.txt file in the same directory as the
cimhosts_sample.txt file.
The following is an example of a cimhosts.txt file on a computer configured as
a Remote Access Server:
3.26.5.134 alnt32

If the RAS server does not have a NIC then place the following entry in the
cimhosts.txt file:
127.0.0.1 alnt32

Testing the Connection


You can use the ping utility on both the Server and Client computers to test the
connection after you dial in to the Server from the Client.

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 address from the Client computer.
For example:
C:\WINDOWS>ping 3.26.5.134
Pinging 3.26.5.134 with 32 bytes of data:
Reply
Reply
Reply
Reply

from
from
from
from

3.26.5.134:
3.26.5.134:
3.26.5.134:
3.26.5.134:

bytes=32
bytes=32
bytes=32
bytes=32

time=103ms TTL=128
time=101ms TTL=128
time=101ms TTL=128
time=99ms TTL=128

C:\WINDOWS>

GFK-1180H

Using CIMPLICITY HMI with Remote Access

37-13

Server Tests
You should be able to ping the Client computer by address from the Server computer.
For example:
C:\WINDOWS>ping 3.26.5.144
Pinging 3.26.5.144 with 32 bytes of data:
Reply
Reply
Reply
Reply

from
from
from
from

3.26.5.144:
3.26.5.144:
3.26.5.144:
3.26.5.144:

bytes=32
bytes=32
bytes=32
bytes=32

time<10ms TTL=32
time=1ms TTL=32
time=1ms TTL=32
time<10ms TTL=32

C:\WINDOWS>

Configuring CIMPLICITY Options on the Server


In the CIMPLICITY Options dialog box under Startup Options, select the Accept
connections option.
For projects to be listed by the CIMPLICITY Viewer you must select the Project
broadcast option.

Networking Considerations
If the IP addresses used by the RAS server are for a different network than the one
for the server on which the CIMPLICITY HMI project is running, you may need to
establish routes from the CIMPLICITY HMI project computer to the RAS link
network. You can use the Windows NT route.exe program to do this. For more
information on using the Windows NT route.exe command, refer to the Windows
NT Command Reference section of the Windows NT Help file (WINHLP32.EXE).

RAS Client has a network card configured


If the RAS client is connected to a local network with a NIC and you are using RAS,
the destination host is located using the following process:
1.

37-14

If you have enabled the Use default gateway on remote network


option in the TCP/IP options of the RAS PhoneBook entry used to dial
the remote network:

If the destination IP address is on the same subnet as your


computers NIC, the packets are sent via the NIC.

If the destination IP address is not on the same subnet as your


computers NIC, the packets are sent via your RAS connection to
the default gateway assigned by the RAS server.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

2.

If you have not enabled the Use default gateway on remote


network option in the TCP/IP options of the RAS PhoneBook entry
used to dial the remote network:

If the destination IP address is on the same subnet as your


computers assigned RAS IP address, the packets are sent via the
RAS connection.

If the destination IP address is not on the same subnet as your


computers assigned RAS IP address, the packets are sent via your
computers NIC.

For example, if your LAN is divided into two Class C subnets, 1.1.1.x and 1.1.2.x,
and you configure your computer on the 1.1.1.x subnet to use RAS with the Use
default gateway on remote network option enabled, all packets you send to the
1.1.2.x subnet will be sent via the RAS connection and not your computers NIC.
To route packets correctly, use the Windows NT route.exe command to add a
static route to your TCP/IP route table that will instruct Windows NT to send packets
intended for the 1.1.2.x subnet to a router on the 1.1.1.x subnet. For more
information on using the Windows NT route.exe command, refer to the Windows
NT Command Reference section of the Windows NT Help file (WINHLP32.EXE).

Limitations on RAS Support


You need to be aware of the following:

GFK-1180H

It will take up to 10 seconds for a list of CIMPLICITY projects to be


received by the RAS client.

You will not be able to use a computer running CIMPLICITY HMI


Computer Cabling Redundancy as the RAS server.

Connection speeds below 4800 Baud are not supported.

You can have only one RAS connection from a RAS client to a RAS
server at a time. A RAS server can handle multiple RAS clients.

Using CIMPLICITY HMI with Remote Access

37-15

CIMPLICITY HMI WebGateway

About the CIMPLICITY HMI WebGateway


You can use the CIMPLICITY HMI WebGateway to let users access your
CIMPLICITY HMI data over the Internet. From the office, home or anywhere else
in the world, CIMPLICITY HMI data is only a phone call away.
This product option is configured to work with your Microsoft Internet Server. Users
gain access to data on CIMPLICITY HMI nodes through this gateway.

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.

Installing the CIMPLICITY HMI WebGateway


The CIMPLICITY HMI WebGateway consists of an extension module for your Web
Server and a Java applet for your Web Browser computers.
The installation program installs both of these modules on your Web Server
computer. The Java applet is automatically downloaded to Web Browser computers
as needed.

GFK-1180H

38-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 4.0 or later; or Netscape


Navigator, version 4.04 or later

We strongly recommend that you install and configure the Microsoft Internet
Information Server before you install the CIMPLICITY HMI WebGateway.

Installation Procedure
To install the CIMPLICITY HMI WebGateway 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 WebGateway 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
WebGateway (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 WebGateway software, and then select Next.
The software begins to load.
When installation is complete, you are given an opportunity to register your
CIMPLICITY HMI WebGateway software.
For CIMPLICITY HMI WebGateway software to function correctly, you will need to
reboot your computer. The last dialog box gives you the opportunity to reboot your
computer immediately.

38-2

CIMPLICITY HMI User's ManualMarch 1999

GFK-1180H

More about CIMPLICITY HMI WebGateway


Components
When you install the CIMPLICITY HMI WebGateway, 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.jar
This is the CIMPLICITY Data Java Applet 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 APPLET 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 WebGateway can communicate with a CIMPLICITY HMI project in your
enterprise, you must configure the project to permit access by the WebGateway. To
do this:

GFK-1180H

1.

Open the projects 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 WebGateway appropriate


access to the project.

Set the Trusted check box.

Select OK.

CIMPLICITY HMI WebGateway

38-3

Testing the Connections


After you install the WebGateway and configure clients for your projects, you need
to verify that:

The WebGateway can see project data.


Web documents can read data from and write data to projects.

Validating Project Connections


To validate that the WebGateway can read and write CIMPLICITY HMI project
data:
1.

Open the Point Control Panel.

2.

Display some points from projects where you have declared the
WebGateway a client.

3.

Verify that the points are updating correctly, and that you can perform
setpoints.

If you do this successfully, you know that the connections between the projects and
the WebGateway are working correctly.

Validating Web Connections


To validate that Web documents can access the WebGateway:
1.

Open the
http://<mycomputer>/CIMPLICITY/HMI/Validate.html
URL, where <mycomputer> is the name of the Web Server
computer.
If you have trouble opening the HTTP URL, try opening the file from
the Web Server computer using the fully qualified path name (for
example,
C:\InetPub\wwwroot\CIMPLICITY\HMI\Validate.html).
The Validation document opens at the first set of tests.

38-4

CIMPLICITY HMI User's ManualMarch 1999

GFK-1180H

GFK-1180H

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.

CIMPLICITY HMI WebGateway

38-5

Troubleshooting and Error Messages


If you are encountering problems, first try using the
CIMPLICITY\HMI\Validate.html page that was installed on your Web
Server to diagnose problems.
If you encounter an error, an error string is returned. The first part of the string (up
to the first space) contains an error code. After the first space, there may be
additional information. You can use the following VBScript lines to remove the
additional information and simplify the error message:
If strResult <> "" Then
intPos = InStr(strResult, " ")
If intPos > 0 Then
strResult = Left(strResult, intPos-1)
End If
End If

Troubleshooting Custom HTML Pages


Q:

I get the error "Object doesnt support this property or method" when
looking at page in Internet Explorer.

A:

The applet may not been installed. If you wrote your own HTML file, the
method for the applet may be misspelled, or the name for the applet (in the
<APPLET> tag) does not match the name used in your script.

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

38-6

CIMPLICITY HMI User's ManualMarch 1999

GFK-1180H

#ERROR!INVALIDPOINTID
This error is returned by the CimData applet 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 WebGateway 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.

#ERROR!URLEXCEPTION
This error indicates a problem with the URL constructed from the Web Server name,
point IDs, and values supplied. One such problem might be that the Web Server
specified is not the same as the host from which the Java data applet was loaded,
which is a security requirement imposed by many web browsers.

GFK-1180H

CIMPLICITY HMI WebGateway

38-7

CIMPLICITY HMI Web Data Applet


The CIMPLICITY HMI Web Data Applet is generally invisible. During testing you
may wish to make the size of the applet big so that you can see the caption it
displays. For released pages you will want to set the size of the applet to something
small (0 or 1 pixels).

setCaption (Method)
Syntax

setCaption(String capString)

Description

Places a specified string in the applets text area.

Parameters

capString the string to display

Comments

The caption is useful to display while testing pages.

Example

Using JavaScript:
document.MyApplet.setCaption("Paint Shop Data")

getCaption (Method)
Syntax

String getCaption()

Description

Retrieves a string from the applet's text area.

Return Value

The current contents of the applets caption text area.

Comments

The raw input and output are displayed in the appets text area, and can be retrieved for diagnostic
purposes using this method.

Example

Using JavaScript:
myText = document.MyApplet.getCaption()

appendCaption (Method)
Syntax

appendCaption(String capString)

Description

Adds a specified string to the end of the text in the applet's text area.

Parameters

capString the string to display

Comments

The caption is useful to display while testing pages. This method adds informative text without
removing any existing caption information.

Example

Using JavaScript:
document.MyApplet.appendCaption("Paint Shop Data")

pointGet (Method)
Syntax

38-8

pointGet(String cimGate)

CIMPLICITY HMI User's ManualMarch 1999

[buffered form]

GFK-1180H

String pointGet(String cimGate, String


pointID)

[unbuffered,
single-point form]

Description

Retrieves value(s) for the specified CIMPLICITY point(s). The first form of pointGet retrieves
values for all point IDs currently held in applet storage, and places the values retrieved into the
applets internal storage. The second form is a shortcut for retrieving a single point value.

Parameters

Parameter

Description

cimGate

A String containing the location of the CimGate extension. The format of this
string is "computer/directory". For example, mycomputer/Scripts.

pointID

A String containing the Point ID.

Return Value

The first form of this method returns nothing. The second form returns the point status string (see
below).

Comments

Use the second form of this function when you only need to retrieve a single point value. The
second form of this method clears any proir content of the applets internal storage before
proceeding.
If an error occurs during any WebGateway transaction, the point status string (obtainable via
getPointStatus) will be E, and the point value retrieved will be an extended error string. If the
transaction completed normally, the point status string will be a string indicating the points data
type.
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.
If a point is configured with EU conversion, the converted value (not the raw value) of the point is
returned.

Example

Using JavaScript:
<applet name=MyApplet
archive=CimData.jar
code=com.gefanuc.hmi.CimData.CimDataApplet.class
height=0
width=0>
</applet>
<form name=MyForm>
Temp: <input name=temp type=text value=><br>
Speed: <input name=speed type=text value=><br>
</form>
document.MyApplet.clearPoints();
document.MyApplet.setPointID(0, \\\\proj\\temp)
document.MyApplet.setPointID(1, \\\\proj\\speed)
document.MyApplet.pointGet("mycomputer/Scripts")
if (getPointStatus(0) = E) {
alert Error: + document.MyApplet.getPointValue(0);
}
else {
document.MyForm.temp.value = document.MyApplet.getPointValue(0);
}
if (getPointStatus(1) = E) {
alert Error: + document.MyApplet.getPointValue(1);
}
else {
document.MyForm.speed.value = document.MyApplet.getPointValue(1);
}

GFK-1180H

CIMPLICITY HMI WebGateway

38-9

See Also

clearPoints, setPointID, getPointStatus, getPointValue, pointSet

pointSet (Method)
Syntax

String pointSet(String cimGate, String pointID, String pointValue)

Description

Sets the specified CIMPLICITY point to the specified value.

Parameters

Parameter

Description

cimGate

A String containing the location of the CimGate extension. The format of this
string is "computer/directory". For example, mycomputer/Scripts.

pointID

A String containing the Point ID.

pointValue

The String representation of the value to be assigned.

Return Value

The point status string generated by the operation.

Comments

Since the CimGate extension only supports setting one point at a time, only a single-point form of
this method is required. Note that this method clears any proir content of the applets internal storage
before proceeding. See pointGet for error reporting information.

See Also

pointGet

clearPoints (Method)
Syntax

clearPoints()

Description

Empties the applets internal point ID and value storage.

Comments

The WebGateway Data Applets internal storage holds point IDs and values, allowing you to specify
more than one point before invoking a transaction with the WebGateway. Making one server
request for multiple values is generally more efficient than retrieving values with separate
transactions. Use this method to clear the applets storage before specifying point IDs to retrieve.

See Also

setPointID, getPointID, setPointValue, getPointValue

setPointID (Method)
Syntax

setPointID(int pointIndex, String pointID)

Description

Stores a point ID for subsequent transaction(s).

Parameters

Parameter

Description

pointIndex

the zero-based integer storage index at which to store the point ID

pointID

the point ID to place in the applets internal storage

Comments

Call this method repeatedly, with consecutive integer indices for each point ID, to load the applets
internal storage before making a transaction.

See Also

pointGet

38-10

CIMPLICITY HMI User's ManualMarch 1999

GFK-1180H

getPointValue (Method)
Syntax

String getPointValue(int pointIndex)

Description

Retrieves a point value or error string from the applets internal storage after a pointGet transaction.
See pointGet for more details.

Parameters

Parameter

Description

pointIndex

the zero-based integer storage index of the point value to retrieve

Return Value

The point value corresponding to the supplied index, or an extended error string if an error occurred
during the transaction.

See Also

pointGet

getPointStatus (Method)
Syntax

String getPointStatus(int pointIndex)

Description

Use this method to retrieves a status string from the applets internal storage after a transaction. The
status string for a point requested, referred to by pointIndex, contains E if the transaction was
unsuccessful for that point. See pointGet for more details.

Parameters

Parameter

Description

pointIndex

the zero-based integer storage index of the point status string to retrieve

Return Value

The status string corresponding to the supplied index.

See Also

pointGet

GFK-1180H

CIMPLICITY HMI WebGateway

38-11

Appendix A - System
Administrative Issues
About System Administrative Issues
This appendix provides the procedures to:

Transfer a license from one computer to another

Create and implement installation from a floppy disk

Remove CIMPLICITY HMI software from a system

CIMPLICITY HMI License Transfer


You can transfer licenses:

From one computer to another

Through a network

Via diskette

Transferring a License from One Computer to Another


CIMPLICITY HMI software must be installed on your target computer before you transfer the
licenses.
To transfer your CIMPLICITY HMI license from one computer to another:
1.

Select CIMPLICITY on the Windows Start menu.

2.

Select HMI.

3.

Select Registration.
.
The Registration Instructions dialog box opens.

GFK-1180H

4.

Click Transfer Authorization.

5.

Select Next to continue with registration.

A-1

You may transfer CIMPLICITY HMI software licenses to another computer without
contacting GE Fanuc for a new System Authorization Code. The Registration program
provides utilities that let you transfer your system licenses, key code, and authorization codes
to another computer via diskette. If you are running Microsoft Windows NT on both
computers, you may transfer the licenses over the network

Important: 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.

Transferring Licenses over a Network


Important: Both computers have to be running Microsoft Windows NT for you to do a
network transfer of licenses.
To transfer licenses over a network:
1.

Make sure that you can write to the Windows directory of the target computer.

2.

On the source computer (the one that is authorized):


A. Map the root directory of the target computer as a network
drive.
B. Select CIMPLICITY on the Windows Start menu.
C. Select HMI.
D. Select Registration.
.
E. Proceed to the CIMPLICITY Registration Transfer dialog box.
F.

Select Transfer via Network.

The Open dialog box opens.


G. Select the Cim.exe file from the WINNT40 directory,
H. Select OK.
When Registration completes, the target system is registered to run CIMPLICITY HMI
software, and the source system is no longer registered.

A-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Diskette License Transfer


You can even transfer your CIMPLICITY HMI license via a diskette.
To transfer licenses via diskette:
On the target computer:
1.

Select CIMPLICITY on the Windows Start menu of the target computer (the one that
is not yet authorized).

2.

Select HMI.

3.

Select Registration.
.
The Registration Instructions dialog box opens.

5.

Proceed to the Registration Transfer Using Floppy Diskette dialog box.

5.

Insert a formatted diskette into the floppy drive.

6.

Select Register the Diskette in the Registration Transfer Using Floppy Diskette
dialog box

6.

Select Next.

7.

Remove the diskette from the target computer.

Continue on the source computer (the one that is authorized).


8.

Insert the diskette into the floppy drive.

9.

Run the Registration program.

10. Proceed to the Registration Transfer Using Floppy Diskette dialog box.
11. Select Authorize the Diskette in the CIMPLICITY Registration Transfer Using
Floppy Diskette dialog box.
12. Select Next.
13. Remove the diskette from the source computer.
Remember, at this point in the procedure, CIMPLICITY HMI software is no longer
registered on the source computer.
Continue on the target computer:
14. Insert the diskette in the floppy drive.
15. Run the Registration program.
16. Proceed to the Registration Transfer Using Floppy Diskette dialog box.
17. Select Authorize the system from the Authorized diskette.
18. Select Next.
When the utility completes, the target computer is registered to run CIMPLICITY
HMI software.

GFK-1180H

Appendix A - System Administrative Issues

A-3

Floppy Disk Installation


You can use the DSK2FLPY utility to create a floppy disk distribution of CIMPLICITY HMI
software from the CD-ROM distribution. You can also use this utility to create a replacement
floppy for one of the diskettes. ).

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

Using the Command Format


The full command format for the DSK2FLPY utility is:
DSK2FLPY [-n<disk_no>] [-t<target_drive>] [?]
The optional arguments are:
-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:.

A-4

Use this argument to access Help for the DSK2FLPY utility.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

3.

For Intel processors the directory is I386.

4.

For DEC Alpha processors the directory is ALPHA.

5.

Select Run from the File menu.

6.

If you need to enter additional arguments (such as the target floppy drive), include
them on the Command Line, then click OK or press Enter. You will be prompted
to insert each diskette (dont forget to mark the diskette with its sequence number
before inserting it in the floppy drive

Creating A Replacement Floppy


You can use the DSK2FLPY program to create a replacement floppy diskette if one of your
distribution diskettes is bad.
To create a single floppy disk:
1.

Insert the CIMPLICITY HMI Distribution CD in its drive.

2.

Use the Explorer to locate DKS2FLPY.EXE in the correct directory for your
platform.

3.

Select Run from the File menu.

4.

Type DSK2FLPY -n<disk_no> on the Command Line, then click OK or press


Enter.

Installing CIMPLICITY HMI From A Floppy


To install CIMPLICITY HMI software from a floppy distribution:
1.

Make sure you have the correct distribution (Intel or Alpha) for your target platform.

2.

Insert the first diskette in the floppy drive.

3.

Use the Explorer to locate setup.exe on the diskette.

4.

Run setup.exe. You will be prompted to insert the rest of the diskettes as they are
needed.

Note: 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.

GFK-1180H

Appendix A - System Administrative Issues

A-5

Removing CIMPLICITY HMI Software


The instructions for removing CIMPLICITY HMI software from Windows 95/98 and
Windows NT systems are below.

Note: Before you remove CIMPLICITY HMI software from your computer, you should save
any projects that you dont want to lose. You can save them on diskette, or in a nonCIMPLICITY directory.

Removing CIMPLICITY HMI from Windows 95/98


CIMPLICITY HMI software is removed from a Windows 95/98 system the same way any
other software is removed.
To remove CIMPLICITY HMI from a Windows 95/98 system:
1.

Select Start on the Windows menu bar.

2.

Select the Add/Remove applet on the Control Panel.

3.

Select CIMPLICITY HMI.

4.

Select Add/Remove.

5.

Reboot your computer after the software is removed.

Removing CIMPLICITY HMI From Windows NT


CIMPLICITY HMI software is removed from a Windows NT system the same way any other
software is removed.
To remove CIMPLICITY HMI from a Windows NT system:

A-6

1.

Select Start on the Windows menu bar.

2.

Select Settings.

3.

Select the Control Panel.

4.

Open the Add/Remove Programs icon.

5.

Select CIMPLICITY HMI from the list of programs

6.

Select Add/Remove.

7.

Reboot your computer after the software is removed.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Appendix B - Resolving Problems

About CIMPLICITY HMI Log Files


CIMPLICITY HMI software consists of a large number of interrelated programs.
Not all programs are run interactively by users. The non-interactive programs,
therefore, cannot report problems directly to a users terminal. Instead, they use the
various log files available on the system.

System Log Files


You can find the system log files in the log directory under your main CIMPLICITY
HMI directory. All system messages are logged to these files.
These files include:

The system Status Log file (COR_RECSTAT.CLG)

The w32rtr.out and w32rtr.err files for the Router

Project Log Files


You can find these log files in your projects log directory. All messages related to a
project are logged to these files.
These files include:

The Status Log file (COR_RECSTAT.CLG)

.OUT and .ERR files for all CIMPLICITY HMI processes other than
user processes

.OUT_<n> and .ERR_<n> backup files for all CIMPLICITY HMI


processes other than user processes

Viewing Log Files


Use the Status Log viewer process to view information in the Status Log files for
projects or the system.
Use the Notepad to view the information in .OUT, .OUT_<n>, .ERR, and .ERR_<n>
files for projects.

GFK-1180H

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

B-2

Red - Failure

Yellow - Warning

Green - Success

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Which Status Log File Gets Displayed


After you install CIMPLICITY HMI software, the first time you display the Status
Log, the file that is displayed will be:

The system Status Log if you select the Status Log icon from the
CIMPLICITY HMI main menu.

The project Status Log, if you select Status Log from the Tools
menu or press Ctrl+L in the Workbench for a project.

From that point on:

GFK-1180H

If you select the Status Log icon from the CIMPLICITY HMI main
menu, the last Status Log file you looked at (project or system) will
automatically be displayed.

If you select Status Log from the Tools menu or press Ctrl+L in the
Workbench for a project, the projects Status Log file will automatically
be displayed.

Appendix B - Resolving Problems

B-3

Status Log Viewer Menu Options


You can use the menu options to select and print log files, filter log entries, find a
particular entry, toggle live updates, refresh the list, and access Help.

The Log Menu

The Log menu functions are:


View System Log

Displays the system log file.

Select Log

Selects the log file you want to view.

Clear Current Log

Clears all messages from the current log file.

Save as Text...

Saves the current contents of the Status Log file as a text


file.

Print...

Prints the contents of the Status Log file to a printer.

Print Preview...

Shows you what your print request will look like.

Print Setup...

Configures the printer, form, and page setup for your


Status Log print request.

Exit

Exits the Status Log function.

The View Menu

The View menu functions are:

B-4

All Entries

Displays all entries in the Status Log.

Filter Entries...

Filters the entries by Status, Process, Procedure, Source,


Reference, or Code.

Find...

Locates an entry based on the Status, Process, Procedure,


Source, Reference, and Code information that you enter.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 Help Menu

The Help menu functions are:


Help Topics

Displays the main Help window for the Status Log


Viewer.

About Log Viewer...

Displays program information, version number, and


copyright for Status Log Viewer.

Status Log Viewer Toolbar Buttons


The Toolbar buttons available to you are:
Open

Selects a log file to view.

Save

Saves the active document.

Print

Prints the active document.

Status Log Viewer Shortcut Keys


Perform commonly used functions. The following are the more commonly used
functions that are available for your use:

GFK-1180H

Ctrl+P

Prints the contents of the Status Log file.

F3

Finds the next Status Log message that fits the search criteria.

Ctrl+D

Displays details for the selected message.

Ctrl+L

Enables/Disables Live Updates.

Ctrl+R

Refreshes the display.

Appendix B - Resolving Problems

B-5

Selecting a Status Log to View


Your CIMPLICITY HMI system contains a System Status Log file. It also contains a
Project Status Log file for each project that you create. You can select any of these
files for display.
To select a log file to view, you can do one of the following:

Select View System Log from the Log menu to display the System
Status Log file.

Select Select Log from the Log menu to search for a log file to open.

If you do the latter, the Find CIMPLICITY Log File dialog box opens.

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 projects log directories.
To display a log file:

B-6

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.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

This dialog box displays the following information:

GFK-1180H

Date

The date the message was generated.

Time

The time the message was generated.

Status

The status of the message. This can be "Failure", "Warning",


or "Success".

Code

The primary value used by the software for expressing the type
of error.

PID

The Process ID of the process that logged the message. The


number is displayed in both decimal and hexadecimal format.

Process

The name of the process that logged the message.

Procedure

The name of the software module that logged the message.

Source:

A numeric representation of the error class.

Reference

A number passed by the procedure to assist in determining the


location of the condition that caused the error.

Error Message

An explanation of the condition that caused the message to be


logged.

Appendix B - Resolving Problems

B-7

If you are contacting GE Fanuc for troubleshooting assistance about a particular


message or set of messages, the information in these fields is of critical importance:

Status
Code
Process
Procedure
Source
Reference
Error Message

From this dialog box you can:

Select Next to display the next message in the log file. If you are at the
last message in the file, you will be asked if you want to continue from
the beginning.

Select Previous to display the previous message in the log file. If you
are at the first message in the file, you will be asked if you want to
continue from the end.

Select Close to close the dialog box and return to the Log Viewer
screen.

Saving the Status Log as a Text File


The Status Log files are binary files, and cannot be viewed directly. You can,
however, copy the contents of a Status Log file to a text file that you can view with
Notepad.
To save the contents of a Status Log file in a text file, select Save As Text from the
Log menu. The Save As dialog box opens.

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.

B-8

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

The dialog box options are:


Name

Displays the name of the currently selected printer. You can


click the drop-down list button to the right of the input field
and select from the list of available printers.

Print Range

Select All to print all Status Log messages, or select Pages


and enter a page range to print selected pages.

Copies

Enter the number of copies you want printed in this input field.

Print to file

Set this check box if you want to save the printout in a file in
addition to printing.

To display and change printer properties, click Properties.


To print the status log click OK. To cancel the print request, click Cancel.
The header line on each page of the printout shows the computer name, the full path
name for the Status Log file and a page number.

GFK-1180H

Appendix B - Resolving Problems

B-9

Selecting a Status Log Printer


You can select a printer, form and orientation for your Status Log printout.

To set up your printer configuration, select Print Setup from the Log
menu.

The Print Setup dialog box opens.

The dialog box options are:


Name

Displays the currently selected printer. You can click the


drop-down list button to the right of the input field to display
the list of available printers and select one of them.

Size

Displays the currently selected paper size. You can click the
drop-down list button to the right of the input field to display
a list of available paper sizes and select one of them.

Source

Displays the currently selected paper source. You can click


the drop-down list button to the right of the input field to
display a list of available paper sources and select one of
them.

Orientation

Click the orientation you want. Select Portrait for vertical


orientation, or Landscape for horizontal orientation.

To save the printer configuration, click OK.


To close the dialog box without making any changes, click Cancel.
For more configuration options, click Properties.
To connect to another printer on the network, click Network.

B-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

The dialog box options are:


Status

Lets you enable/disable filtering for message status. You may select
one or more status types.
If you select no status types, you will see no messages.

Process

Lets you enable/disable filtering by process name. Click the dropdown list to the right of the input field to display the list of
processes currently in the log file that you can select.

Procedure

Lets you select the procedure name(s) to filter for. You can enter an
entire procedure name, or the first n characters.

Source

Lets you enable/disable filtering by source name. Click the dropdown list to the right of the input field to display the list of sources
currently in the log file that you can select.

Reference

Lets you select a reference number to filter for. You must enter the
exact reference number.

Code

Lets you select a code to filter for. You must enter the exact code.

You may use any combination of filter entries in your filter request.
To filter the Status Log, click OK. The Log Viewer screen redisplays with the
filtered list of messages. If no messages match the filter you requested, the screen is
blank.
To close the dialog box without filtering, click Cancel.
To clear filtering and redisplay all Status Log messages, click Clear, and then click
OK.

GFK-1180H

Appendix B - Resolving Problems

B-11

Finding Status Log Messages


If you are looking for a particular message or set of messages, you may find it useful
to use the Find and Find Next options to perform the search.
To initiate finding a message, select Find from the View menu.
The Find System Entry dialog box opens.

The dialog box options are:


Status

Lets you search for messages by status. You may select one or
more status types.
If you select no status types, no messages will be found.

Process

Lets you search for messages by process name. Click the dropdown list to the right of the input field to display the list of
processes currently in the log file that you can select.

Procedure

Lets you search for messages by procedure name. You can enter an
entire procedure name, or the first n characters.

Source

Lets you search for messages by source name. Click the drop-down
list to the right of the input field to display the list of sources
currently in the log file that you can select.

Reference

Lets you search for messages by reference number. You must enter
the exact reference number.

Code

Lets you search for messages by code. You must enter the exact
code.

Direction

You can choose the direction to search in from your current location
in the Status Log. Click Up to search previous messages. Click
Down to search next messages.

You may use any combination of filter entries in your filter request.

B-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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.

Finding the Next Status Log Message


Once you have set the filters in the Find System Entry dialog box and found the first
message that matched the filters, you can select Find Next from the View menu, or
press F3 to find the next message in the configured direction that matches the filter.
If the filter has been cleared, Find Next will find the next message down in the list.

Process Names in Status Log


Processes that log messages in the Status Log include:
AB_ETH<n> Allen-Bradley Ethernet where <n> is the port number
Alarm Viewer session where <n> is the session number
AV<n>
Configuration
CfgCab
Serial Devcomm where <n> is the port number
COM<n>
CIMVIEW session where <n> is the session number
CM<n>
CWSERV session where <n> is the session number
CW<n>
Alarm Manager
MAC_AM
Data Logger
MAC_DL
Dynamic Configuration Manager
MAC_DYN
Basic Control Engine
MAC_EMRP
Point Data Logger
MAC_PTDL
Derived Point Processor
MAC_PTDP
Point Manager
MAC_PTM
Point Translator
MAC_PTX
Point Bridge
PB
Tracker Decision Control Data Server
PDC_DS
Master Control Program
PM_MCP
Tracker Data Collector
PRT_DC
Tracker Data Server
PRT_DS
Tracker Graphic Display
PRT_GRD
Series 90 Ethernet where <n> is the port number
TCPIP<n>
TCP/IP Redundancy where <n> is the port number
TCPRD<n>
Message router
W32RTR
GFK-1180H

Appendix B - Resolving Problems

B-13

Checking System Output and Error Files


In the main CIMPLICITY HMI log directory, you will find the current set of
w32rtr.out and w32rtr.err files for the Router. These files may contain
additional information if you are experiencing problems with your CIMPLICITY
HMI software.
Important
You can only examine these files while the Router is not running. If you
stop the Router, all projects on the computer also stop.
To view the contents of a w32rtr.out or w32rtr.err file:
1.

Stop the Router.

2.

Use the Explorer to check for any non-zero length .ERR and .OUT
files in the main log directory.

3.

Use Notepad to look at the contents of these files.

Checking Process Output and Error Files


In the log directory for a project, you will find a set of current and backup .ERR and
.OUT files. These files may contain additional information if you are experiencing
problems with your CIMPLICITY software.
Note
You can only examine .OUT and .ERR files while the project is not running. You
can examine backup .OUT and .ERR files while the project is running.
Some of the basic CIMPLICITY filenames and their associated programs are:

B-14

Filename

Associated Process

AB_ETH<n>

Allen-Bradley Ethernet device communications where <n> is the


port number

COM0<n>

Serial device communications where <n> is the port number

MAC_AM

Alarm Manager

MAC_DL

Data Logger

MAC_DYN

Dynamic Configuration

MAC_EMRP

Basic Control Engine

MAC_PTDL

Point Data Logger

MAC_PTDP

Virtual Point Processor

MAC_PTM

Point Manager

MAC_PTX

Point Translation

MAC_UR

User Registration

PB

Point Bridge

PCIM<n>

Genius device communications where <n> is the port number

TCPIP<n>

Series 90 TCP/IP device communications where <n> is the port


number.

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

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 projects log directory.

3.

Use Notepad to look at the contents of these files.

Backup Process Log Files


Each process can have up to two backup .OUT and .ERR files in the log directory.
The backup files contain additional information about the programs for the last two
times that the project was started. You will be able to look at the backup log files
while the project is running. The .OUT_1 and .ERR_1 files contain newer
information than the .OUT_2 and .ERR_2 files.

GFK-1180H

Appendix B - Resolving Problems

B-15

Index

#
#ERROR!ARRAYNOTALLOWED 38-6
#ERROR!ARRAYOUTOF BOUNDS 38-6
#ERROR!BADSERVERRESPONSE 38-6
#ERROR!CIMPLICITYNOTRUNNING 38-6
#ERROR!INVALIDPOINTID 38-7
#ERROR!NOTIMPLEMENTED 38-7
#ERROR!NOTLICENSED 38-7
#ERROR!POINTIDSYNTAX 38-7
#ERROR!POINTUNAVAILABLE 38-7
#ERROR!SERVERNEEDSRESTART 38-7
#ERROR!URLEXCEPTION 38-7

$
$ALARM.ACKED 10-8
$ALARM.ACTIVE 10-9
$ALARM.TOTAL 10-8
$ALARM.UNACKED 10-9
$ALARM_DISABLED 17-2
$ALARM_ENABLED 17-2
$ALARM_MODIFIED 17-2
$ALARM_RAWLIM 17-2
$ALARM_RESTORED 17-2
$AM_STATUS 17-2
$CLASS_<Alarm class name>.ALARMS 10-9
$CLASS_<Alarm class name>.UNACKED 10-9
$DEV_DOWN 17-2
$DEVICE 17-2
$DEVICE_DOWN 17-2
$DEVICE_FAILOVER 17-2
$DL_FILE_FULL 17-2
$DOWNLOAD 17-2
$DYN_CFG 17-2
$GMR_POINT_DISCREPANCY 17-2
$LOCAL.COMPUTER 10-1
$LOCAL.DATE.AMPM 10-8
$LOCAL.DATE.DAY 10-6
$LOCAL.DATE.DAYOFYEAR 10-6

GFK-1180H

$LOCAL.DATE.HOUR 10-7
$LOCAL.DATE.HOUR12 10-7
$LOCAL.DATE.MINUTE 10-7
$LOCAL.DATE.MONTH 10-6
$LOCAL.DATE.SECOFDAY 10-8
$LOCAL.DATE.SECOND 10-7
$LOCAL.DATE.WEEK 10-7
$LOCAL.DATE.WEEKDAY 10-6
$LOCAL.DATE.YEAR 10-6
$LOCAL.DATETIME 10-5
$LOCAL.WINUSER 10-1
$LOGON 17-3
$LOGOUT 17-3
$PROJECT 10-2
$PROJECT.AVAILABLE 10-2
$PROJECT.COMPUTER 10-2
$PROJECT.DATE.AMPM 10-5
$PROJECT.DATE.DAY 10-3
$PROJECT.DATE.DAYOFYEAR 10-4
$PROJECT.DATE.HOUR 10-4
$PROJECT.DATE.HOUR12 10-4
$PROJECT.DATE.MINUTE 10-5
$PROJECT.DATE.MONTH 10-3
$PROJECT.DATE.SECOFDAY 10-5
$PROJECT.DATE.SECOND 10-5
$PROJECT.DATE.WEEKDAY 10-4
$PROJECT.DATE.YEAR 10-3
$PROJECT.DATETIME 10-3
$PROJECT.DDATE.WEEK 10-4
$PROJECT.DEVICES 10-2
$PROJECT.LOGGEDIN 10-2
$PROJECT.USERS 10-3
$REDUND_DEV_DOWN 17-3
$RTR_LINK_DOWN 17-3
$USER.ALARMS 10-8

%
%% 8-13
%DEV_AMT 8-13
%DEV_VAL 8-13
%EU 8-13
%ID 8-13
%LIMIT 8-13
%STATE 8-13
%VAL 8-13

.
.GEF
File 2-16

/
/alwaysmaximized
CimView command line option 31-17
/geometry
CimView command line option 31-18
/keypad
CimView command line option 31-18
/LoadScript
CimView command line option 31-18
/noconfig
Alarm viewer command line options 30-37
/noexit
CimView command line option 31-19
/nomenutitle
CimView command line option 31-19
/noopen
Alarm viewer command line options 30-37
CimView command line option 31-19
/noresize
CimView command line option 31-19
/project <name>
CimView command line option 31-20
/wait 31-20
/waitforproject
CimView command line option 31-20
/zoomtobestfit
CimView command line option 31-20

{
{Procedure
Quick enable of a protocol for a project 5-2

3
3D_BCD 6-4

4
4D_BCD
Device point 6-4

A
About
Alarm audio support 18-1
Alarm blocking 19-1
Alarm printer configuration 20-1
Alarm sound manager 18-5
Alarms 17-1
AMV OCX 28-1
AMV OCX methods 29-1
CIMPLICITY HMI and Control 26-1
CIMPLICITY HMI log files B-1

ii

Client configuration 25-1


Database logger 23-1
Database logging, Managing 24-1
Devices 12-1
Measurement units 35-1
Microsoft System Management Server 36-28
Point control panel 32-1
Ports 14-1
RAS 37-1
Resources 13-1
Roles 21-1
Security features 36-36
Stand-alone alarm viewer 30-1
System Utilities 34-1
WebGateway 38-1
About Alarm Strings 16-1
About CimView 31-1
About System management 36-1
About the CIMPLICITY To Windows Server 33-1
About Users 22-1
AboutBox
Alarm viewer method 29-3
Absolute Alarming 8-18
Access
Runtime monitoring 2-28
ACCESS 27-15
Access to Manual Mode 6-33
ACCESS_FILTER 27-15
ACK_TIMEOUT 27-15
ACK_TOUT 36-7
Acknowledgement
Automatic for alarms 8-27
Acknowledging all alarms
Alarm viewer 30-27
AMV OCX 28-27
Acknowledging an alarm
Alarm viewer 30-26
AMV OCX 28-25
Acknowledging and resetting an alarm
Alarm viewer 30-27
AMV OCX 28-26
Acknowledging the first alarm
Alarm viewer 30-27
AMV OCX 28-27
Action Object Selected With the Mouse 31-12
Actions
Device properties, CIMPLICITY HMI and Control
26-4
Activate
Dynamic configuration 23-18
Dynamic configuration 2-23
Active Measurement System
About 35-11
Defining in Measurement Units 35-11
Defining in Project Properties 35-12

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Add
Fields to display 2-13
Subsystems to PtXRef database 11-11
Add project to list
CIMPLICITY options 3-14
Adding
Saved logins 34-15
Adding a new user to a resource 13-4
Adding a user to a resource 13-4
Adding alarm comments
Alarm viewer 30-25
AMV OCX 28-25
Adding an alarm
Alarm block group 19-6
Adding an Alarm printer 20-2
Adding the point to a logging table
Database logger, from point configuration 23-9
ADDR 27-15, 27-34
ADDR_OFFSET 27-16
ADDR_TYPE 27-16
Address
Custom for a diagnostic point 6-12
Specifications for a device point 6-8
Standard domain 6-12
Addressing
Procedure for 6-8
Advance
Device point configuration 6-13
Advanced
Alarm tabs 8-11
Device specifications for device points 6-18, 7-15
General specifications for device points 6-13
General specifications for virtual points 7-10
Virtual point configuration 7-10
Alarm 29-4
Enabled for a device point 6-15
Enabled for a virtual point 7-11
Logs for device points 6-17
Logs for virtual points 7-14
Point control panel, properties 32-4
Alarm assignment
Alarm blocking 19-2
Alarm Attributes
Alarm Id 17-5
Alarm Type 17-5
Class Id 17-5
Description 17-5
Message 17-5
Alarm audio support
About 18-1
Beep configuration 18-4
Configuring 18-3
Prioritizing alarms 18-1
Prioritizing alarms, examples 18-2
Wave file configuration 18-4

GFK-1180H

Index

Alarm block group See Alarm blocking


Alarm blocking
About 19-1
Alarm assignment 19-2
Alarm priorities 19-2
Blocking modes 19-2
Configuring 19-4
Modifying an alarm block group 19-7
Rules for 19-3
Alarm blocking group
Adding an alarm 19-6
Creating 19-5
Modifying an alarm 19-7
Removing an alarm 19-6
Alarm class configuration
Audio support 15-4
Color assignments 15-5
Creating a new alarm class 15-3
Mapping colors in RGB.DAT 15-6
Alarm classes
About 15-1
Configuring 15-1
Alarm comments
More about 17-4
Alarm configuration
Setting run-time alarm properties 17-4
Alarm Configuration
Alarm Definition Properties - Non-Point Alarms 17-7
Alarm Configuration 17-1
Alarm Definition Properties - Point Alarms 17-9
Creating A New Alarm Definition 17-6
Alarm definition
Alarm message variable run-time parameters 17-1
Alarm Definition
Alarm Options Properties 17-14
Alarm Definition Configuration
Alarm Routing Properties 17-12
Alarm Definition Properties
Absolute 17-11
Alarm Class 17-7, 17-9
Alarm Criteria 17-11
Alarm Delay 17-12
Alarm Message 17-8, 17-9
Alarm Type 17-7
Alarm Values 17-11
Deadband 17-12
Definition 17-9
Description 17-7
Deviation 17-11
Help File 17-8, 17-12
Logging 17-8
Non-Point Alarms 17-7
Point Alarms 17-9
Rate of Change 17-11
String Index 17-10

iii

Alarm Definitions
Standard Alarms 17-2
Alarm filtering
Changing setup parameters 28-23
Alarm list, Filtering
Database logger 23-55
Alarm logging
Database logger properties 23-42
Overview 23-2
Alarm logging dialog box
Database logger, From point configuration 23-10
Alarm message
Variable run-time parameters 17-1
Alarm message date/time format
Alarm viewer 30-18
Alarm Options Properties 17-14
Acknowledge Timeout 17-16
Deletion Requirements 17-15
Repeat Timeout 17-15
Reset Timeout 17-16
Alarm printer configuration 20-1
About 20-1
Adding an alarm printer 20-2
Additional steps for serial printers 20-10
Alarm printer properties 20-3
Date/time format properties 20-7
Date/time formats 20-8
Delete and acknowledge times 20-12
General properties 20-3
Layout properties 20-6
Modifying queue size 20-11
More about redundant alarm printers 20-9
Alarm priorities
Alarm blocking 19-2
Alarm properties
Run-time 17-4
Alarm report
Database logger 23-59
Database logger, Generating 23-61
Database logger, setting parameters 23-60
Alarm Report
Database logger, Clearing error log 23-61
Alarm Routing Properties 17-12
Adding a new Role 17-13
Adding a Role 17-13
Modifying a Role 17-13
Removing a Role 17-13
Alarm setups
Changing at run-time 30-24
Changing sort order 30-32
Creating 28-33
Creating a new setup 30-33
Declaring a default setup 28-34, 30-33
Default for project 28-29
Default, using 28-35

iv

Deleting 28-34
Deleting a setup from the list 30-33
Filtering by state 28-32
Filtering by time 28-32, 30-32
Loading 28-29, 30-29
Modifying 28-30, 30-30
Modifying the class list 28-30, 30-30
Modifying the resource list 28-31, 30-31
Saving 28-33
Saving the current setup 30-33
Alarm setups, Filterying by State 30-32
Alarm sound manager
About 18-5
Adding a project 18-7
Adding a project, Examples 18-8
Deleting a project 18-8
Option properties 18-9
Profile, saving and loading 18-6
Project properties 18-7
Startup properties 18-10
Turning sound on and off 18-6
Using 18-5
Window buttons, using 18-6
Alarm String Configuration 16-1
Creating A New Alarm String 16-3
Alarm Strings
About 16-1
Configuring 16-2
Alarm table point
Point properties 23-54
Alarm triggered logging
Database logger, Logging conditions 23-23
Alarm viewer
Acknowledging all alarms 30-27
Acknowledging an alarm 30-26
Acknowledging the first alarm 30-27
Adding alarm comments 30-25
Alarm message date/time format 30-18
Alarm setups 30-28
Changing setup parameters 30-24
Command line options 30-36
Command line options - /noconfig 30-37
Command line options - /noopen 30-37
Configure menu 30-4
Configuring an alarm view 30-5
Configuring the count color 30-7
Configuring the count font 30-8
Configuring the count layout 30-5
Copying alarms 30-34
Creating a document shortcut 30-35
Creating a new setup 30-33
Creating a shortcut from 30-35
Creating a shortcut from the file manager 30-36
Creating custom buttons 30-20
Creating custom buttons, Example 30-21

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Declaring a default setup 30-33


Defining the alarm count layout 30-5
Defining the alarm list layout 30-9
Deleting a setup from the list 30-33
Deleting an alarm 30-26
Displaying user help 30-24
Edit menu 30-3
General configuration information 30-17
Help menu 30-4
Loading a setup for display 30-29
Logging in 30-22
Login menu 30-3
Menus 30-3
Modifying the class list 30-30
Modifying the current setup 30-30
Modifying the resource list 30-31
Modifying time/state/sort filters 30-32
Printing alarms 30-34
Refreshing the alarm list 30-24
Resetting an alarm 30-26
Saving the current setup 30-33
Saving the layout 30-20
Selecting alarm list color and font 30-12
Selecting alarm list fields 30-9
Selecting alarms 30-23
Shortcut keys 30-4
Static alarm list button layout 30-13
Toggling between lists 30-24
Toolbar buttons 30-4
Using the alarm list buttons 30-23
View menu 30-3
Viewing alarm comments 30-25
Viewing the alarm list 30-23
Viewing the alarm stack 30-25
Viewing the alarms CimView screen 30-26
Alarm Viewer
Acknowledging and resetting an alarm 30-27
File menu 30-3
Alarm viewer methods See AMV OCX methods
AboutBox method 29-3
Creating an Invoke Method action 29-2
DoAckAll method 29-3
DoAckFirst method 29-3
DoAcknowledge method 29-3
DoAckReset method 29-3
DoCimviewScreen method 29-3
DoComments method 29-4
DoDelete method 29-4
DoHelp 29-4
DoRefresh 29-4
DoReset 29-5
DoSetup 29-5
DoToggle 29-5
DoViewStack 29-5
MoveDownOneAlarm 29-5

GFK-1180H

Index

MoveUpOneAlarm 29-6
naming an alarm viewer control 29-1
PageDownAlarms 29-6
PageUpAlarms 29-6
SelectAllAlarms 29-6
SelectPageAlarms 29-6
SelectTopAlarm 29-6
Alarm Viewer OCX See AMV OCX
ALARM_ENABLED 33-6
ALARM_HIGH 33-5
ALARM_LOW 33-5
Alarms
About 17-1
Absolute 8-18
Advanced tab 8-11
Basic limits 8-10
Basic message 8-10
Class and alarm message 8-13
Class configuration 8-14
Configuring 17-5
Deadband 8-23
Define advanced message 8-13
Definition 8-12
Delay 8-22
Deletion 8-28
Deviation 8-19
Help file 8-23
Maximum stack 8-29
On update 8-19
Rate of change 8-20
Removing roles 8-24
Repeats 8-26
Roles assigned to 8-24
Routing 8-24
Setting options 8-25
All subsystems
Option button 11-4
ALM_CLASS 27-16
ALM_CRITERIA 27-16
ALM_DEADBAND 27-17
ALM_DELAY 27-17
ALM_HIGH_1 27-17
ALM_HIGH_2 27-17
ALM_HLP_FILE 27-17
ALM_LOW_1 27-18
ALM_LOW_2 27-18
ALM_MSG 27-18
ALM_ROUTE_OPER 27-18
ALM_ROUTE_SYSMGR 27-18
ALM_ROUTE_USER 27-19
ALM_STR 27-19
ALM_TYPE 27-19
am_colors.cfg 15-6
AM_RESET_ACK_STATE 36-8
amlp_flush.exe 20-11

AMLP_MAX_QUEUE 20-11
AMLP_USE_GEN_TIME 20-12, 36-8
AMSI_ALARM 17-3
AMV OCX
About 28-1
Acknowledging all alarms 28-27
Acknowledging an alarm 28-25
Acknowledging and resetting an alarm 28-26
Acknowledging the first alarm 28-27
Adding alarm comments 28-25
Alarm setups 28-28
Buttons properties 28-7
Changing setup parameters 28-23
Colors properties 28-19
Configuration overview 28-1
Configuring 28-3
Configuring control properties 28-4
Count layout properties 28-15
Creating a new alarm setup 28-33
Creating custom buttons 28-20
Creating custom buttons, Example 28-21
Date format properties 28-16
Deleting alarm comments 28-25
Deleting an alarm 28-26
Displaying user help 28-23
Dynamic mode, About 28-2
Fields properties 28-5
Fonts properties 28-18
Projects properties 28-10
Refreshing the alarm list 28-23
Run-time overview 28-2
Selecting alarms from the list 28-22
Sort/display properties 28-11
Static mode, About 28-2
Toggling between lists 28-23
Using the alarm list buttons 28-23
Viewing alarm comments 28-24
Viewing the alarm list 28-22
Viewing the alarm stack 28-24
AMV OCX methods
About 29-1
Configuring 29-2
AMV OCXViewing the alarms CimView screen 28-25
Analog
Virtual point initialization 7-6
Analog Deadband 6-20
ANALOG_DEADBAND 27-19
appendCaption (Method)
WebGateway, Web data applet 38-8, 38-10
Application logging
Overview 23-4
Application source directory, Creating
Site wide installation 36-31
Arithemtic
Operators and custom conversion 6-31

vi

Arithmetic
Operators for expressions 7-41
Array
Limits for device points 6-7
Array Point Example - CWSERV 33-11
Arrays 6-6
And histogram points 7-30
Device arrays in CimEdit 6-6
Device arrays in CimView 6-6
Device arrays in database logger 6-6
Using for device points 6-6
Using for virtual points 7-5
Virtual arrays in Alarm Viewer 7-5
Virtual arrays in CimView 7-5
Virtual arrays in Database Logger 7-5
Virtual arrays in kCimEdit 7-5
Associate
CimView screen with a point 8-2
Associating folders with devices
CIMPLICITY HMI and Control 26-5
Association, Creating new
CIMPLICITY HMI and Control 26-5
Association, Deleting
CIMPLICITY HMI and Control 26-6
Association, Editing
CIMPLICITY HMI and Control 26-6
Automatic
Reset for an alarm 8-28
Automatic Actions
For alarms 8-26
Availability Triggers
For device points 6-16
For virtual points 7-12
Average Points 7-22

B
Base Engineering Units
For a device point 6-27
For a virtual point 7-36
Base Rate
And scan rate 6-20
Basic
Alarm limits 8-10
Device custom addressing 6-8
Device point configuration 6-3
Virtual point configuration 7-3
Basic Control Engine
Guideline for measurement units 35-18
Beep configuration
Alarm audio support 18-4
Before you start
RAS 37-3
Begin
Point cross reference 11-2

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

BEU
For a device point 6-27
For a virtual point 7-36
BFR_COUNT 27-19
BFR_DUR 27-20
BFR_EVENT_PERIOD 27-20
BFR_EVENT_PT_ID 27-20
BFR_EVENT_TYPE 27-20
BFR_EVENT_UNITS 27-20
BFR_GATE_COND 27-20
BFR_SYNC_TIME 27-21
Bitwise
Operators and custom conversion 6-31
Operators for expressions 7-42
Blank
Point cross reference window 11-3
Blocking modes
Alarm blocking 19-2
Blocking rules
Alarm blocking 19-3
BOOL 6-5
Boolean
Virtual point initialization 7-6
Browse
Open window 2-9
Browser Windows
Point search aids in the Workbench 9-4
Buffering
For device points 6-17
For virtual points 7-13
Build
Point cross reference database 11-3
Button
Build PtXRef database 11-3
View options 11-7
Buttons properties
AMV OCX 28-7
BYTE 6-5

C
CALC_TYPE 27-21
Calculation
Average points 7-22
Delta accum array 7-20
Delta accum points 7-17
Equation 7-16
Equation w/override points 7-32
Historgram 7-30
Max capture point 7-23
Min capture point 7-25
Timer/counter point 7-28
Trans high accum point 7-27
Value accum point 7-21

GFK-1180H

Index

Capabilities
Workbench 2-1
Categorize points 4-2
CE_MAX_DELAY 36-8
CE_MAX_THREADS 36-8
CE_THREAD_TIMEOUT 36-8
Change
Point through point cross reference window 11-11
Project in point cross reference window 11-13
Select existing record or file 2-26
Changing font colors
Point control panel 32-6
Changing the alarm setup
Alarm viewer 30-24
Changing the AMV OCX setup parameters 28-23
Changing view options
Show Users 34-6
Characters
Reserved when naming points 4-4
Check Box
Enable tree text view 11-7
Show only used points 11-7
Sort on 11-7
Choose
Fields 2-11
Cimedit Management of Animated Objects
Guideline for measurement units 35-16
CIMHOSTS.TXT
Configuring for RAS 37-13
CIMPLCIITY HMI and Control
Device properties, Actions 26-4
Device properties, Common point properties 26-4
Device properties, Import options 26-3
CIMPLICITY HMI
Customer support 1-2
Diskette license transfer A-3
Floppy disk installations A-4
Network license transfer A-2
Site wide installation procedure 36-31
CIMPLICITY HMI and Control
About 26-1
Associating folders and devices 26-5
Creating a new association 26-5
Device properties, Control 26-2
Import process 26-7
Import rules 26-7
Point conflicts, Incorrect information 26-10
Point conflicts, New point 26-9
Point conflicts, Resolving 26-8
Remote configuration 26-11
Remote configuration, Example 26-11
Supported device protocols 26-2
CIMPLICITY HMI and CONTROL
Deleting an association 26-6

vii

CIMPLICITY HMI and Control, Editing an


association 26-6
CIMPLICITY HMI processes 34-20
CIMPLICITY HMI web data applet 38-8
CIMPLICITY HMI WebGateway See WebGateway
CIMPLICITY options
Add project to list 3-14
Connecting to a computer 3-13
Network options 3-15
Setting 3-12
Start as viewer 3-13
Start project in list 3-14
Stop a project 3-13
System boot options 3-15
CIMPLICITY options, Server
RAS 37-14
CIMPLICITY software
Removing A-6
Removing from Windows 95/98 A-6
Removing from Windows NT A-6
CIMPLICITY Software
Copying a project to diskette 3-25
Creating a new project 3-1
Creating a remote project 36-45
Dynamic update 3-22
How configuration updates are handled 3-22
Installing a project 3-11
Logging in 3-24
New project options 3-1
Opening a project 3-3
Remote projects 36-44
Setting project properties 3-5
Setting Startup Options 3-12
Using 3-1
Using the Project Wizard 3-7
Whats Running 3-21
CIMPLICITY to Windows Server 33-1
Displaying point data 33-6
Point Topic Attributes 33-3
CIMPLICITY To Windows Server
About 33-1
Command syntax for System topic 33-12
Creating A DDE Share 33-14
CWSERV Command Syntax 33-1
CWSERV Icon 33-7
Error Messages 33-14
Formats command syntax 33-12
Help command syntax 33-13
Implementing a Setpoint macro 33-9
Macro format for modifying point data 33-8
Microsoft Excel Example 33-2
Modifying Point Data 33-8
Performance considerations 33-8
Referencing CWSERV from a Networked NT
Client 33-15

viii

Remote Access of CWSERV on Windows NT 33-14


Sample CWSERV Commands 33-2
Sample spreadsheets and macros 33-10
Starting CWSERV 33-7
System command syntax 33-12
Topics command syntax 33-12
Using with Microsoft Excel 33-6
CIMPLICTIY options
Startup options 3-14
CimView 31-1
About 31-1
Associate a screen with a point 8-2
Command Line Options 31-17
Control Menu 31-7
Displaying a screen 31-10
Displaying Help Information 31-15
Displaying Object Help 31-16
Displaying Object Properties 31-17
Displaying Screen Help 31-15
Displaying Screen Properties 31-16
Docking the Toolbar 31-9
Executing in-place edit setpoint actions 31-13
Executing Slider Setpoints 31-12
File Menu 31-4
Floating the Toolbar 31-9
Getting Started 31-1
Help Menu 31-7
Menu Bar 31-3
Menus 31-4
OLE Controls 31-21
Opening a screen 2-29
Screen for a selected point 2-32
Scroll bars 31-3
Selecting action object with mouse 31-12
Selecting objects with procedures 31-11
Selecting setpoint object with keyboard 31-13
Selecting setpoint object with mouse 31-12
Setting Window Options 31-14
Shortcut Keys 31-9
Status Bar 31-3
Title Bar 31-3
Toolbar Buttons 31-8
Toolbars 31-3
View Menu 31-5
Window buttons 31-3
Window Components 31-2
Window Pop-up Menu 31-8
CimView autostart
Windows 95 3-16
CimView autostart, Windows 95
Disabling Microsoft network login prompt 3-16
Setting CIMPLICITY startup options 3-18

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

CimView command line options


/alwaysmaximized 31-17
/geometry 31-18
/keypad 31-18
/LoadScript 31-18
/noexit 31-19
/nomenutitle 31-19
/noopen 31-19
/noresize 31-19
/project <name> 31-20
/waitforproject 31-20
/zoomtobestfit 31-20
CimView Scripts
Guideline for measurement units 35-17
Class
For alarms 8-13
clearPoints (Method)
WebGateway, Web data applet 38-10
clie
export command 27-10
import command 27-7
CLIE See Import/Export
CLIE_MAX_PTS 36-24
Client configuration
About 25-1
Client properties 25-3
Creating a new client 25-2
Using 25-1
Client package distribution
How it works 36-29
Client properties
Client configuration 25-3
Client setup
RAS, Windows 95 37-11
RAS, Windows NT 37-9
Closing a project view
Show Users 34-9
CLR_TOUT 36-9
Collapse
Left pane view 2-5
Color assignments
Alarm class configuration 15-5
Colors properties
AMV OCX 28-19
Combining point triggers 23-52
Combining triggers
Database logger 23-23
Command actions
Database logger, Maintenance actions 23-32
Command Format
DSK2FLPY A-4
Command Line Argument
/wait 31-20
Command line options
Alarm viewer 30-36

GFK-1180H

Index

startup.exe 3-26
Command Line Options
CimView 31-17
Command Syntax for System Topic 33-12
Formats 33-12
Help 33-13
System 33-12
Topics 33-12
Common point properties
Device properties, CIMPLICITY HMI and Control
26-4
Compact
Width for an analog point 8-4
Components
WebGateway 38-3
Workbench 2-3
Computer
Transfer license from one to another A-1
Configuration
Device point overview 6-1
Dynamic 2-22
Dynamic for port 2-23
Dynamic restrictions for point 2-23
Update 2-22
Virtual point overview 7-1
Configuration Cabinet
Shortcut Keys 3-4
Toolbar Buttons 3-4
Configuration Import/Export See Import/Export
Configuration overview
AMV OCX 28-1
Configure menu
Alarm viewer 30-4
Configuring a stand-alone alarm viewer 30-2
Configuring additional locks
SQL Server 24-9
Configuring alarm audio support 18-3
Configuring alarm blocking 19-4
Configuring Alarm Strings 16-2
Configuring Alarms 17-5
Configuring AMV OCX in CimEdit 28-3
Configuring AMV OCX methods 29-2
Configuring an alarm view
Alarm viewer 30-5
Configuring automatic startup
RAS, Windows NT server 37-7
Configuring devices 12-1
Configuring point bridge points 36-48
Configuring ports 14-1
Configuring Resources 13-1
Configuring roles 21-2
Configuring the count color
Alarm viewer 30-7
Configuring the count font
Alarm viewer 30-8

ix

Configuring the count layout


Alarm viewer 30-5
Connect
Quick device connect for a project 5-3
Connect information
Database logger, Logging properties 23-33
Database logger, Properties 23-43
CONNECT_DROP_PERIOD 36-5
CONNECT_RETRY_PERIOD 36-5
Connecting to a computer
CIMPLICITY options 3-13
Contacting your distributor 1-1
Control Menu
CimView 31-7
Control properties
Actions 26-4
Common point properties 26-4
Device properties, CIMPLICITY HMI and
Control 26-2
Import options 26-3
CONV_LIM_HIGH 27-21
CONV_LIM_LOW 27-21
CONV_TYPE 27-22
Conversion
Custom for a device point 6-31
Custom for a virtual point 7-36
Device points 6-26
Linear for a device point 6-31
Linear for a virtual point 7-36
Operators for expressions 7-43
Tab for device points 6-26
Tab for virtual points 7-36
Converted values
Linear device point conversion 6-30
Copying A Project to Diskette 3-25
Copying a table
Database logger 23-36
Copying alarms
Alarm viewer 30-34
Count layout properties
AMV OCX 28-15
Create
Floppy disk distribution A-5
Floppy Disk Distribution A-4
New device point 6-2
New project 2-14
New record or file 2-25
New virtual point 7-2
Replacement Floppy A-4
Creating
Alarm block group 19-5
Alarm class 15-3
Port 14-3
Role 21-3
Creating a DDE Share 33-14

Creating a document shortcut


Alarm viewer 30-35
Creating A New Alarm Definition 17-6
Creating a new alarm setup
AMV OCX 28-33
Creating A New Alarm String 16-3
Creating a new client 25-2
Creating a new device 12-3
Creating a New Project 3-1
Options 3-1
Creating A New Remote Project 36-45
Creating a new setup
Alarm viewer 30-33
Creating a new table
Database logger, from point configuration 23-12
Creating a new user 22-4
Creating a resource 13-3
Creating a shortcut, From file manager
Alarm viewer 30-36
Creating a shortcut, While viewing document
Alarm viewer 30-35
Creating a table
Database logger 23-19
Creating an Invoke Method action 29-2
Creating custom buttons
Alarm viewer 30-20
AMV OCX 28-20
AMV OCX, Example 28-21
Creating custom buttons, Example
Alarm viewer 30-21
Creating tables
Database logger 23-5, 24-11
Database logger, Column definitions 23-6, 24-11
Database logger, Key definitions 23-7, 24-12
Critera
For an alarm 8-17
Criteria
Update for a device point 6-9
CSV file format 27-2
Custom Conversion for a device point 6-31
Custom Conversion for a virtual point 7-36
Custom HTML pages, Troubleshooting
WebGateway 38-6
Customer support 1-2
Customize
Workbench point list 9-1
CWSERV
Command Syntax 33-1
Command syntax for System topic 33-12
Creating a DDE Share 33-14
Displaying Point Data 33-6
Error Messages 33-14
Formats command syntax 33-12
Help command syntax 33-13
Icon 33-7

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Implementing a Setpoint macro 33-9


Macro format for modifying point data 33-8
Microsoft Excel Example 33-2
Modifying Point Data 33-8
Performance considerations 33-8
Point Topic Attributes 33-3
Referencing from a Networked NT Client 33-15
Remote Access of CWSERV on Windows NT 33-14
Sample Commands 33-2
Sample spreadsheets and macros 33-10
Spreadsheet example with array point 33-11
Spreadsheet example with single point 33-10
Starting 33-7
System command syntax 33-12
Topics command syntax 33-12
Using with Microsoft Excel 33-6
CWSERV Attributes
ALARM_ENABLED 33-6
ALARM_HIGH 33-5
ALARM_LOW 33-5
DISP_FORMAT 33-4
DISP_HIGH 33-5
DISP_LOW 33-5
ELEMENTS 33-4
EU_LABEL 33-5
INIT_STATE 33-6
LENGTH 33-4
RAW_VALUE 33-3
SIZE 33-4
STATE 33-3
TYPE 33-4
VALUE 33-3
WARN_ENABLED 33-6
WARN_HIGH 33-5
WARN_LOW 33-5

D
Data
Logs for device points 6-17
Logs for virtual points 7-14
Data logging
Overview 23-3
Data report
Database logger 23-62
Database logger, Clearing error log 23-64
Database logger, Generating 23-64
Database logger, Setting parameters 23-63
Data table point
Point properties 23-51
Data triggered logging
Database logger, Logging conditions 23-23

GFK-1180H

Index

Data Type
3D_BCD 6-4
4D_BCD 6-4
Bool 6-5
BYTE 6-5
Device point 6-4
DINT 6-4
DWORD 6-5
INT 6-4
REAL 6-4
SINT 6-4
STRING 6-5
STRING_20 6-5
STRING_8 6-5
UDINT 6-4
UINT 6-4
USINT 6-4
Virtual point 7-4
WORD 6-5
Database
Point cross reference 11-3
Database disconnect recover
Database logger 24-13
Database disconnect recover, Enabling store and
forward 24-14
Database disconnect recover, Reconnect wait
period 24-13
Database disconnect recover, Store and forward 24-13
Database disconnect recover, Store and forward maximum records 24-15
Database disconnect recover, Store and forward
filenames 24-14
Database disconnect recover, Store and forwared changing defaults 24-15
Database logger 23-1, 23-36
About 23-1
Adding points to a table 23-49
Alarm list, Filtering 23-55
Alarm logging, Overview 23-2
Alarm point, Modifying logging conditions 23-54
Alarm point, Point properties 23-54
Alarm report 23-59
Alarm report, Clearing error log 23-61
Alarm report, Generating 23-61
Alarm report, Setting parameters 23-60
Application logging, Overview 23-4
Copying a table 23-36
Creating tables 23-5, 24-11
Creating tables, Column definitions 23-6, 24-11
Creating tables, Key definitions 23-7, 24-12
Creating tables, Microsoft Access note 24-11
Data logging, Overview 23-3
Data point
Timed/gated logging 23-53
Data point, Alarm triggered logging 23-52

xi

Data point, Combining triggers 23-52


Data point, Data tiggered logging 23-52
Data point, Point properties 23-51
Data report 23-62
Data report, Clearing error log 23-64
Data report, Generating 23-64
Data report, Setting parameters 23-63
Database disconnect recover, Enabling store and
forward 24-14
Database disconnect recover, Reconnect
wait period 24-13
Database disconnect recover, Store and forward 24-13
Database disconnect recover, Store and forward changing defaults 24-15
Database disconnect recover, Store and forward maximum records 24-15
Database disconnect recover, Store and forward
filenames 24-14
Database disconnect recovery 24-13
Default logging conditions, Alarm log table 23-21
Deleting a table 23-37
Displaying a table 23-45
Edit menu, Main window 23-14
Edit menu, Table window 23-46
Entering from point configuration
Alarm logging 23-10
Table Browser 23-11
Entering from point configuration, Adding the point to
a logging table 23-9
Entering from point configuration, Creating a new
table 23-12
Entering from point configuration, Displaying a table
list 23-11
Entering from point configuration, Logging an
alarm 23-10
Entering from point configuration, Modifying the
logging properties for the point 23-9
Entering from point configuration, Modifying the
properties of a table 23-12
Entering from point configuration, Point logging
dialog box 23-8
Entering from point configuration, Removing the
point from all logging tables 23-9
Entering from point configuration, Removing the
point from one or more logging tables 23-9
Event list, Filtering 23-55
Event logging, Overview 23-3
File menu, Main window 23-14
File menu, Table window 23-46
Global parameters
DB_DEBUG 24-17
DB_ENABLE_TRANSACTIONS 24-18
DB_TIME_FORMAT 24-18
Global parameters 24-16
Group logging, Overview 23-4

xii

Group point, Array attributes 23-51


Group point, Point attributes 23-50
Group point, Point properties 23-50
Help menu, Main window 23-15
Help menu, Table window 23-47
Install Microsoft Excel from Excel CD 23-56
Install Microsoft Excel from Microsoft Office for
Windows 95 CD 23-57
Install sample reports 23-58
Logging attributes for alarm event and application
tables 23-25
Logging attributes, Group and data tables 23-26
Logging attributes, Point attributes to be logged 23-26
Logging attributes, Table attributes to be
logged 23-25, 23-27
Logging conditions, Alarm triggered logging 23-23
Logging conditions, Data triggered logging 23-23
Logging conditions, Group and data tables 23-22
Logging conditions, Modify logging conditions 23-21
Logging conditions, Timed/gated logging 23-24
Logging properties, All tables 23-33
Logging properties, Connect information 23-33
Logging properties, Store and forward 23-34
Maintenace actions, All tables 23-31
Maintenance actions, Command actions 23-32
Maintenance actions, Export actions 23-31
Maintenance actions, Purge actions 23-32
Maintenance events, All tables 23-27
Maintenance events, Timed/gated maintenance
events 23-28
Maintenance events, Triggered maintenance
events 23-28
Microsoft Access note 23-5
Notes on installing Microsoft Excel 23-56
ODBC configuration 24-2
ODBC configuration, Custom data sources 24-3
ODBC configuration, Data sources 24-2
ODBC configuration, Drivers 24-2
ODBC configuration, Microsoft Access data
sources 24-4
ODBC configuration, Moving projects 24-3
ODBC configuration, Remote SQL Server data
sources 24-6, 24-7
ODBC configuration, SQL Server client utilities,
Installing 24-6
ODBC configuration, SQL Server configuration 24-5
ODBC configuration, SQL Server data source
configuration 24-6
ODBC configuration, SQL Server installation 24-4
Oracle configuration 24-8
Oracle requirements 24-8
Point list, Filtering 23-55
Point logging properties, Editing 23-49
Properties 23-40
Properties, Alarm and point logging 23-42

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Properties, Connect information 23-43


Properties, Database queue size 23-41
Properties, Disk full scan rate 23-41
Properties, Maintenance action export path 23-42
Properties, Parameters 23-41
Properties, Point data logging scan rate 23-42
Properties, Store and forward 23-44
Reconciling a table 23-38
Reconciling a table, Creating database fields 23-39
Reconciling a table, Removing unused Microsoft
Access fields 23-39
Reconciling a table, Removing unused Oracle
fields 23-39
Reconciling a table, Removing unused SQL Server
fields 23-39
Removing points from a table 23-49
Reporting 23-56
Reports, Automatic printing 23-68
Reports, Automatic printing, CimView triggers 23-70
Reports, Automatic printing, Maintenance action
triggers 23-70
Reports, Automatic printing, Modifying
CIMPLCITIY service for 23-68
Reports, Automatic printing, Script 23-69
Reports, Automatic printing, Triggering 23-70
Reports, Automatic printing,Event Manager
triggers 23-70
Search string wildcards 23-5
Shortcut keys, Main window 23-17
Starting from configuration cabinet 23-13
Starting from point configuration 23-8
Table characteristics 23-6, 24-11
Table list, filtering 23-35
Table menu, Options 23-46
Table properties 23-20
Table, Creating 23-19
Toolbar buttons, Main window 23-17
Toolbar buttons, Table window 23-48
Trend report 23-65
Trend report, Clearing error log 23-67
Trend report, Generating 23-67
Trend report, Setting parameters 23-66
Types of log files available 23-1
Using Oracle with 24-8
View menu, Main window 23-15
View menu, Table window 23-47
Window menu, Options 23-14
Window pop-up menu, Main window 23-16
Window pop-up menu, Table window 23-48
Database Logger 23-1
Entering from Point Configuration, Displaying table
attributes 23-10
In point cross reference 11-1
Database logger, Combining triggers 23-23
Database logging, Managing

GFK-1180H

Index

About 24-1
Database management
SQL server 24-9
SQL server, Configuration additional locks 24-9
SQL server, Handling transaction log 24-10
SQL server, Truncating transaction log as
CIMPLICITY maintenance action 24-10
SQL server, Truncating transaction log as system
default 24-10
Database queue size
Database logger, Properties 23-41
Date format properties
AMV OCX 28-16
Date/time format properties
Alarm printer configuration 20-7
Date/time formats
Alarm printer configuration 20-8
DB_CONN_DOWN 17-3
DB_DEBUG 24-17, 36-9
DB_ENABLE_TRANSACTIONS 24-18, 36-10
DB_QUEUE_OVERFLOW_DELAY 36-10
DB_QUEUE_SIZE 36-3
DB_START_FORWARD 17-3
DB_TIME_FORMAT 24-18
DB_TIMESTAMP_PRECISION 36-10
DBDL_ABORT_TIMEOUT 36-9
DBDL_DEVICE_CHECK_PERIOD 36-2
Deadband
And alarms 8-23
Declaring a default alarm setup
AMV OCX 28-34
Declaring a default setup
Alarm viewer 30-33
Default alarm setups
Using 28-35
Default logging conditions
Alarm log table 23-21
Default User 22-1
Defining a resource
Properties 13-3
Defining the alarm count layout
Alarm viewer 30-5
Defining the alarm list layout
Alarm viewer 30-9
DEL_OPT 36-10
Delay
Alarms 8-22
Delete Alarm privilege 21-4
Delete and acknowledge times, Modifying
Alarm printer configuration 20-12
DELETE_REQ 27-22
Deleting a setup from the list
Alarm viewer 30-33
Deleting a table
Database logger 23-37

xiii

Deleting a user from a resource 13-4


Deleting alarm comments
AMV OCX 28-25
Deleting an alarm
Alarm viewer 30-26
AMV OCX 28-26
Deleting an alarm setup
AMV OCX 28-34
Deleting configuration data
Import/Export 27-12
Deleting login information 36-24
Deletion
Alarms 8-28
Delta Accum Array 7-20
Delta Accum Points 7-17
Derived Points
Guideline for measurement units 35-15
DESC 27-22, 27-34
Description
Of Workbench parts 2-4
Details
Point control panel, properties 32-3
DEV_ID 8-13
Deviation 8-19
DEVIATION_PT 27-22
Device
Point configuration overview 6-1
Device configuration
Creating a new device 12-3
Device specific properties 12-5
General properties 12-4
Modifying a device 12-5
Device Configuration 12-1
Device General Properties
Description 12-4
Model Type 12-4
Resource 12-4
Device Point
Restrictions 6-20
Device properties
Control for CIMPLICITY HMI and Control 26-2
Device specific properties 12-5
Device status 6-11
DEVICE_ID 27-22
Devices
About 12-1
Devices configuration 12-1
Diagnostic
Point when the enabler uses custom addressing 6-12
Points used with devices 6-11
Dialog Box
Field chooser 2-12
New project 2-15
Search 2-8
View options 11-7

xiv

DINT 6-4
Disable
Device point 6-15
Device point alarm 6-15
Virtual point 7-11
Virtual point alarm 7-11
Disabling the Microsoft network login prompt
Windows 95, CimView autostart 3-16
Disk full scan rate
Database logger, Properties 23-41
Diskette
Replacement A-4
DISP_FORMAT 33-4
DISP_HIGH 33-5
DISP_LIM_HIGH 27-23
DISP_LIM_LOW 27-23
DISP_LOW 33-5
DISP_WIDTH 27-23
Display
Advanced group of alarm tabs 8-11
Fields in right pane 2-11
Files 2-7
Options in Workbench 2-5
Records 2-7
View tab 8-3
Workbench 2-3
Display High/Low
Analog point limits 8-6
Displaying a Screen
CimView 31-10
Displaying a table
Database logger 23-45
Displaying a table list
Database logger, from point configuration 23-11
Displaying CimView Help Information 31-15
Displaying CimView Object Help 31-16
Displaying CimView Object Properties 31-17
Displaying CimView Screen Help 31-15
Displaying CimView Screen Properties 31-16
Displaying Point Data with CWSERV 33-6
Displaying point properties
Point control panel 32-3
Displaying point properties, Alarm
Point control panel 32-4
Displaying point properties, Details
Point control panel 32-3
Displaying points
Point control panel 32-2
Displaying status log message details B-7
Displaying table attributes
Database logger, from point configuration 23-10
Displaying user help
Alarm viewer 30-24
AMV OCX 28-23
Distribution

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Floppy disks A-5


Distributors
Phone numbers 1-1
DoAckAll
Alarm viewer method 29-3
DoAckFirst
Alarm viewer method 29-3
DoAcknowledge
Alarm viewer method 29-3
DoAckReset
Alarm viewer method 29-3
DoCimviewScreen
Alarm viewer method 29-3
Docking a Toolbar
CimView 31-9
DoComments
Alarm viewer method 29-4
DoCustom<n>
Alarm viewer method 29-4
DoDelete
Alarm viewer method 29-4
DoHelp
Alarm viewer method 29-4
Domains
For programmable controllers dynamically
reconfigured 6-18
DONT_VERIFY_ESPOINT_FRID 36-11
DoRefresh
Alarm viewer method 29-4
DoReset
Alarm viewer method 29-5
DoSetup
Alarm viewer method 29-5
DoToggle
Alarm viewer method 29-5
DoViewStack
Alarm viewer method 29-5
DOWNLD_PASSWD 36-3
Drag
Points into Point Control Panel 2-32
DSK2FLPY
Command format A-4
DWORD 6-5
Dynamic
Configuration 2-22
Remote Project configuration restrictions 2-23
Update
Point configuration 2-23
Port configuration 2-23
Dynamic Configuration
Begin 23-18
Begin 2-23
Dynamic configuration changes
Security audit trail 36-39
Dynamic Configuration privilege 21-4

GFK-1180H

Index

Dynamic mode, About


AMV OCX 28-2
Dynamic Update 3-22
Database Logger configuration 2-23, 3-23
Point configuration 3-23
Port configuration 3-23
Remote Projects configuration 3-23

E
Edit
Point through point cross reference window 11-11
Select existing record or file 2-26
Edit menu
Alarm viewer 30-3
Login panel 34-11
ELEMENTS 27-23, 27-34, 33-4
EMEP_BUF_SIZE 36-11
Empty
Point cross reference window 11-3
Enable
Analog display configuration guide 8-5
Device point 6-15
Device point alarm 6-15
Virtual point 7-11
Virtual point alarm 7-11
Enable Tree Text View
Check box 11-7
ENG_UNITS 27-23
Enterprise properties
Remote project 36-47
Enterprise Server
And Setpoint security guidelines 4-6
Equal
Trigger point 6-19
EQUATION 27-24
Equation Points 7-16
Equation w/override points 7-32
Error log, Clearing
Database logger, Alarm report 23-61
Database logger, Data report 23-64
Database logger, Trend report 23-67
Error messages
WebGateway 38-6
WebGateway,
#ERROR!ARRAYNOTALLOWED 38-6
WebGateway,
#ERROR!ARRAYOUTOFBOUNDS 38-6
WebGateway,
#ERROR!BADSERVERRESPONSE 38-6
WebGateway,
#ERROR!CIMPLICITYNOTRUNNING 38-6
WebGateway, #ERROR!INVALIDPOINTID 38-7
WebGateway, #ERROR!NOTIMPLEMENTED 38-7
WebGateway, #ERROR!NOTLICENSED 38-7

xv

WebGateway, #ERROR!POINTIDSYNTAX 38-7


WebGateway,
#ERROR!POINTUNAVAILABLE 38-7
WebGateway,
#ERROR!SERVERNEEDSRESTART 38-7
WebGateway, #ERROR!URLEXCEPTION 38-7
Error Messages 33-14
EU
And linear conversion 6-30
EU_LABEL 33-5
Event list, Filtering
Database logger 23-55
Event logging
Overview 23-3
Event Manager
Guideline for measurement units 35-18
In point cross reference 11-1
Example, About
RAS 37-2
Example, Remote configuration
CIMPLICITY HMI and Control 26-11
Examples, Adding a project
Alarm sound manager 18-8
Examples, Prioritizing alarms
Alarm audio support 18-2
Executing Actions
Object selected with the mouse 31-12
Executing Setpoints
In-place edit 31-13
Object Selected with keyboard 31-13
Object Selected With Mouse 31-12
Executing Slider Setpoints 31-12
Exiting program control 34-22
Expand
Left pane view 2-5
Explorer
Use to find a file 2-10
Export actions
Database logger, Maintenance actions 23-31
Export procedure
Import/Export 27-10
Exporting configuration data 27-10
Expression
And timer/counter points 7-29
Editor 7-39
For equation w/override points calculation 7-32
Rules for defining for an equation point 7-16

F
Failures 6-11
Field
Chooser 2-11
Need update 2-21
Select for display 2-13

xvi

Select in right pane 2-11


Field Chooser
Open dialog box 2-11
Fields
Definitions for fields displayed in the Workbench 9-7
To display in the Workbench 9-5
Fields properties
AMV OCX 28-5
File
Create new 2-25
Find 2-10
Finding its name 2-9
Select for display 2-7
Select to edit 2-26
File menu
Alarm viewer 30-3
Login panel 34-11
File Menu
CimView 31-4
Filtering alarms See Alarm setups under Alarm viewer.
See Alarm setups
Filtering status log messages B-11
Filtering the table list
Database logger 23-35
Find
A file 2-10
A record or file 2-8
Name of file or record 2-9
Finding status log messages B-12
Finding the next status log message B-13
First Converted Value
And linear conversion 6-30
Fixed
Width for an analog point 8-4
Floating A Toolbar
CimView 31-9
Floating Point Vs. Integer
Guideline for measurement units 35-13
Floppy Disk
Distribution A-5
Installation A-4
Installations A-4
Replacement A-4
Floppy Diskette
Using to install CIMPLICITY A-5
Flush
Alarms printed on network printer 20-11
Folder
Expand in left pane 2-5
Fonts properties
AMV OCX 28-18
Formats - CWSERV System Topic 33-12
Forward
Custom device point conversion 6-31
Functions

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Alarm 7-40
Further configuration
RAS, Windows NT server 37-7
Windows NT client 37-11
FW_CONV_EQ 27-24

G
GE FANUC
Hotline 1-2
General
Basic virtual point information 6-3, 7-3
General configuration information
Alarm viewer 30-17
General properties
Alarm printer configuration 20-3
Device 12-4
Remote project 36-46
getCaption (Method)
WebGateway, Web data applet 38-8
getPointStatus (read only property)
WebGateway, Web data applet 38-11
getPointValue (read only property)
WebGateway, Web data applet 38-11
Getting started
Point control panel 32-1
Getting Started
CimView 31-1
Global parameters 36-1
ACK_TOUT 36-7
AM_RESET_ACK_STATE 36-8
AMLP_USE_GEN_TIME 36-8
CE_MAX_DELAY 36-8
CE_MAX_THREADS 36-8
CE_THREAD_TIMEOUT 36-8
CLR_TOUT 36-9
CONNECT_DROP_PERIOD 36-5
CONNECT_RETRY_PERIOD 36-5
Database logger 24-16
DB_DEBUG 24-17, 36-9
DB_ENABLE_TRANSACTIONS 24-18, 36-10
DB_QUEUE_OVERFLOW_DELAY 36-10
DB_QUEUE_SIZE 36-3
DB_TIME_FORMAT 24-18
DB_TIMESTAMP_PRECISION 36-10
DBDL_ABORT_TIMEOUT 36-9
DBDL_DEVICE_CHECK_PERIOD 36-2
DEL_OPT 36-10
Device communications 36-20
DONT_VERIFY_ESPOINT_FRID 36-11
DOWNLD_PASSWD 36-3
Editing 36-2
EMEP_BUF_SIZE 36-11
GMR_HRTBT_TIMER 36-3
GMR_MODE_ADDR 36-3

GFK-1180H

Index

GSM_ANNUN_ALARM_H1 36-12
GSM_ANNUN_ALARM_H2 36-12
GSM_ANNUN_ALARM_L1 36-12
GSM_ANNUN_ALARM_L2 36-13
GSM_ANNUN_DIG_OFF 36-11
GSM_ANNUN_DIG_ON 36-12
GSM_ASC_FONT_NAME 36-13
GSM_ASC_FONT_SIZES 36-13
GSM_ASC_SCALE 36-13
GSM_CACHE_SIZE 36-14
GSM_EXPONENT_PRECISION 36-14
GSM_SPCONFIRM_DEFAULT 36-14
GSM_STALE_COLOR_KEY 36-15
GSM_UNAVAIL_COLOR_KEY 36-15
IPC_BCAST_INTERVAL 36-5
IPC_QUEUE_SIZE 36-6
LOG_OPT 36-16
LOGIN_RETRY_PERIOD 36-15
MAX_STACKED 36-16
MAX_TREND_BUF 36-16
Modified for all projects 36-5
Modified per project 36-7
Modified through configuration functions 36-2
PROJECT_ID 36-17
PTDL_QUANTIZATION 36-3
PTMDP_DO_EU_CONV 36-18
PTMRP 36-18
RAW_LIMIT_ALARM 36-18
REDUND_LINK_SLEEP 36-6
REPEAT_TOUT 36-18
RTR_ACCEPT_CONN 36-3
RTR_DISABLE_BCAST 36-3
RTR_MAX_OUTMESSAGE_COUNT 36-6
RTR_STANDALONE 36-4
Sample File 36-21
SETPOINT_SECURITY 36-4
SHORT_FILENAMES 36-19
STARTUP_TIMEOUT 36-4
SVC_RETRY_COUNT 36-19
SVC_RETRY_DELAY 36-19
SYSNAME 36-4
GMR_HRTBT_TIMER 36-3
GMR_MODE_ADDR 36-3
GR_SCREEN 27-24
Granting client dial-in permission
RAS, Windows NT server 37-8
Greater Than
Trigger point 6-19
Greater Than Equal
Trigger point 6-19
Group logging
Overview 23-4
Group table point
Point properties 23-50
GSM_ANNUN_ALARM_H1 36-12

xvii

GSM_ANNUN_ALARM_H2 36-12
GSM_ANNUN_ALARM_L1 36-12
GSM_ANNUN_ALARM_L2 36-13
GSM_ANNUN_DIG_OFF 36-11
GSM_ANNUN_DIG_ON 36-12
GSM_ASC_FONT_NAME 36-13
GSM_ASC_FONT_SIZES 36-13
GSM_ASC_SCALE 36-13
GSM_CACHE_SIZE 36-14
GSM_EXPONENT_PRECISION 36-14
GSM_SPCONFIRM_DEFAULT 36-14
GSM_STALE_COLOR_KEY 36-15
GSM_UNAVAIL_COLOR_KEY 36-15

H
Handling transaction log
SQL server 24-10
Help - CWSERV System Topic 33-13
Help File
And alarms 8-23
Help menu
Alarm viewer 30-4
Help Menu
CimView 31-7
Histogram Point 7-30
Hotline
Phone numbers 1-2
How client package distribution works 36-29
How Configuration Updates Are Handled 3-22
Dynamic Update 3-22

I
Icon
Point cross reference 11-2
ie_deflds.cfg 27-4
Changing information in 27-5
ie_formats.cfg 27-5
Changing information in 27-6
Import options
Device properties, CIMPLICITY HMI and Control
26-3
Import procedure
Import/Export 27-7
Import, Process
CIMPLICITY HMI and Control 26-7
Import, Rules
CIMPLCITIY HMI and Control 26-7
Import/Export 27-1
Configuration Files 27-4
Data file format 27-2
Deleting configuration data 27-12
Export field formats file 27-5
Export procedure 27-10

xviii

Exporting configuration data 27-10


Field names 27-13
Required 27-13
Field Names
Optional 27-13
Import Field Defaults File 27-4
Importing additional roles 27-9
Importing configuration data 27-7
Introduction 27-1
Log file 27-6
Log file format 27-6
Log file name 27-6
Logicmaster 90 support 27-34
Logicmaster Fields
ADDR 27-34
DESC 27-34
ELEMENTS 27-34
PT_ID 27-34
PT_TYPE 27-34
Sample data file 27-2
Sample Logicmaster File 27-34
Wildcards for delete 27-12
Wildcards for export 27-11
Import/Export Fields
ACCESS 27-15
ACCESS_FILTER 27-15
ACK_TIMEOUT 27-15
ADDR 27-15
ADDR_OFFSET 27-16
ADDR_TYPE 27-16
ALM_CLASS 27-16
ALM_CRITERIA 27-16
ALM_DEADBAND 27-17
ALM_DELAY 27-17
ALM_HIGH_1 27-17
ALM_HIGH_2 27-17
ALM_HLP_FILE 27-17
ALM_LOW_1 27-18
ALM_LOW_2 27-18
ALM_MSG 27-18
ALM_ROUTE_OPER 27-18
ALM_ROUTE_SYSMGR 27-18
ALM_ROUTE_USER 27-19
ALM_STR 27-19
ALM_TYPE 27-19
ANALOG_DEADBAND 27-19
BFR_COUNT 27-19
BFR_DUR 27-20
BFR_EVENT_PERIOD 27-20
BFR_EVENT_PT_ID 27-20
BFR_EVENT_TYPE 27-20
BFR_EVENT_UNITS 27-20
BFR_GATE_COND 27-20
BFR_SYNC_TIME 27-21
CALC_TYPE 27-21

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

CONV_LIM_HIGH 27-21
CONV_LIM_LOW 27-21
CONV_TYPE 27-22
DELETE_REQ 27-22
DESC 27-22
DEVIATION_PT 27-22
DEVICE_ID 27-22
DISP_LIM_HIGH 27-23
DISP_LIM_LOW 27-23
DISP_WIDTH 27-23
ELEMENTS 27-23
ENG_UNITS 27-23
EQUATION 27-24
FW_CONV_EQ 27-24
GR_SCREEN 27-24
INIT_VAL 27-24
JUSTIFICATION 27-25
LOCAL 27-25
MAX_STACKED 27-25
MEASUREMENT_UNIT_ID 27-25
POLL_AFTER_SET 27-26
PRECISION 27-26
PROC_ID 27-26
PT_ENABLED 27-26
PT_ID 27-13
PT_ORIGIN 27-13, 27-27
PT_SET_INTERVAL 27-27
PT_SET_TIME 27-27
PT_TYPE 27-28
PTMGMT_PROC_ID 27-26
RANGE_HIGH 27-28
RANGE_LOW 27-28
RAW_LIM_HIGH 27-28
RAW_LIM_LOW 27-28
REP_TIMEOUT 27-29
RESET_ALLOWED 27-29
RESET_COND 27-29
RESET_PT 27-29
RESET_TIMEOUT 27-30
RESOURCE_ID 27-30
REV_CONV_EQ 27-30
ROLLOVER_VAL 27-30
SAFETY_PT 27-31
SAMPLE_INTV 27-31
SAMPLE_INTV_UNIT 27-31
SCAN_RATE 27-31
SETPOINT_HIGH 27-32
SETPOINT_LOW 27-32
TRIG_CK_PT 27-32
TRIG_PT 27-32
TRIG_REL 27-33
TRIG_VAL 27-33
UPDATE_CRITERIA 27-33
VARIANCE_VAL 27-33
VARS 27-34

GFK-1180H

Index

Importing additional roles 27-9


Importing configuration data 27-7
Incorrect information conflicts
CIMPLICITY HMI and Control 26-10
InetPub\Scripts\CimGate.dll 38-3
InetPub\wwwroot\CIMPLICITY\HMI\*.html 38-3
InetPub\wwwroot\CIMPLICITY\HMI\CimData.jar
38-3
INIT_STATE 33-6
INIT_VAL 27-24
Initialization
Specifications for a virtual point 7-6
Text points 7-7
Initialized
Initialization option 7-6
In-place edit setpoint actions 31-13
Install Microsoft Excel
Excel CD, Database logger 23-56
Microsoft Office for Windows 95 CD 23-57
Microsoft Office for Windows 95 CD, Database
logger 23-57
Install sample reports
Database logger 23-58
Installation
CIMPLICITY HMI from a floppy diskette A-5
From a floppy disk A-4
Using floppy disks A-4
Installation procedure
WebGateway 38-2
Installing
WebGateway 38-1
Installing a Project 3-11
Installing Microsoft Excel
Notes on, Database logger 23-56
Installing SQL Server client utilities 24-6
Installing the RAS
Windows NT client 37-9
Windows NT server 37-4
INT 6-4
Interval
Timer/counter point 7-28
Introduction
Site wide installation 36-27
Invalid Point
In point cross reference 11-6
IPC_BCAST_INTERVAL 36-5
IPC_QUEUE_SIZE 36-6

J
Job, Creating for CIMPLICITY HMI installation
Site wide installation 36-34
Justification
For an analog point 8-3
JUSTIFICATION 27-25

xix

L
Layout properties
Alarm printer configuration 20-6
Left
Justification for an analog point 8-3
Left Pane
Changing the view 2-5
Create new record or file from 2-25
In point cross reference window 11-6
LENGTH 33-4
Less Than
Trigger point 6-19
Less Than Equal
Trigger point 6-19
License
Transfer A-1
Transfer from one computer to another A-1
Licenses
Diskette transfer A-3
Network Transfer A-2
Limitations
RAS 37-15
Limits
Analog display 8-5
Array limits for device points 6-7
Basic alarm 8-10
Range 8-7
Setpoint 8-8
Tab 8-6
Linear Conversion for a device point 6-30
Linear Conversion for a virtual point 7-36
List
All files for an object 2-8
All points displayed in the Workbench 9-1
All records for an object 2-8
Customize point list in the workbench 9-1
Points in point cross reference 11-6
Resorting in point cross reference 11-6
Select points in the Workbench 9-2
Selected files for an object 2-8
selected records for an object 2-8
Loading an alarm setup
AMV OCX 28-29
Loading an alarm setup for display
Alarm Viewer 30-29
LOCAL 27-25
Log and error files
Viewing B-1
Log file format
Import/Export 27-6
Log file name
Import/Export 27-6
Log files
Types of 23-1

xx

LOG_OPT 36-16
Logging See Database logger
Logging an alarm
Database logger, from point configuration 23-10
Logging attributes
Alarm, event and application tables 23-25
Group and data tables 23-26
Logging conditions, Group and data tables 23-22
Logging in
Alarm viewer 30-22
Logging In 3-24
Logging in to a project
Login panel 34-13
Logging out of a project
Login panel 34-13
Logging properties
All tables 23-33
Logical
Operators and custom conversion 6-31
Operators for expressions 7-43
Logical names 36-22
CLIE_MAX_PTS 36-24
Editing the file 36-23
Logical names, Base system
Descriptions 36-24
Logicmaster 90 support
Import/Export 27-34
Login information
Deleting 36-24
Help Menu 34-12
Login panel 34-10
Edit menu 34-11
File menu 34-11
Help Menu 34-12
Logging in to a project 34-13
Logging out of a project 34-13
Managing saved logins 34-15
Menu options 34-11
Password, changing 34-14
Project Menu 34-11
Shortcut keys 34-12
Starting 34-10
Toolbar buttons 34-12
View Menu 34-12
Login password
Security features 36-36
Login! menu
Alarm viewer 30-3
LOGIN_RETRY_PERIOD 36-15

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

M
Maintain
PtXRef database 11-11
Maintenance action export path
Database logger, Properties 23-42
Maintenance actions
All tables 23-31
Maintenance events
All tables 23-27
Managing saved logins 34-15
Manual
Reset for an alarm 8-28
Manual Mode
Description 6-33
Mapping colors in RGB.DAT
Alarm class configuration 15-6
Max 7-13
Max Capture Point 7-23
Max Count
For a device point trend history 6-16
For a virtual point trend history 7-13
Max Duration
For a device point trend history 6-16
MAX_STACKED 27-25, 36-16
MAX_TREND_BUF 36-16
MCP_PROC_DOWN 17-3
Measurement System
Adding 35-4
Copying 35-5
Defining properties 35-4
Renaming 35-5
Measurement Systems
Configuring 35-2
Measurement Unit
Copying 35-9
Defining properties 35-6
Editing properties 35-7
Equivalent unit definition 35-7
Equivalent unit id 35-8
Forward equation 35-8
Justification 35-8
Precision 35-8
Renaming 35-10
Reverse equation 35-8
Type 35-9
Width 35-8
Measurement Units
About 35-1
Active measurement system, about 35-11
Configuring 35-2
Creating 35-6
Guidelines 35-13
Guidelines, Basic control engine 35-18

GFK-1180H

Index

Guidelines, CimEdit management of animated


objects 35-16
Guidelines, CimView scripts 35-17
Guidelines, Derived points 35-15
Guidelines, Event manager 35-18
Guidelines, Floating point vs. integer 35-13
Starting 35-3
MEASUREMENT_UNIT_ID 27-25
Menu Bar
CimView 31-3
Menu options
Login panel 34-11
Show Users 34-3
Status log viewer B-4
Menus
Alarm viewer 30-3
CimView 31-4
Message
Advanced alarm 8-13
Basic alarm 8-10
Microsoft Access
Note for Database logger 23-5
Microsoft Access note
Database logger 24-11
Microsoft Excel Example - CWSERV command 33-2
Microsoft Excel, Install from Excel CD
Database logger 23-56
Microsoft Excel, Install from Windows 95 CD
Database logger 23-57
Microsoft Excel, Install from Windows 97 CD
Database logger 23-57
Microsoft System Management Server
About 36-28
minCapture Point 7-25
Modify
Open record or file for editing 2-26
Points through the point cross reference window
11-11
PtXRef database 11-11
Modify Alarm Setups privilege 21-4
Modify logging conditions
Database logger, Logging conditions 23-21
Modify Manual Mode Privilege 21-4
Modifying
Alarm block group 19-7
Modifying a device 12-5
Modifying an alarm
Alarm block group 19-7
Modifying logging conditions for an alarm 23-54
Modifying Point Data in CWSERV 33-8
Implementing a macro 33-9
Macro Format 33-8
Performance considerations 33-8
Modifying table properties
Database logger, From point configuration 23-12

xxi

Modifying the class list


Alarm viewer 30-30
Modifying the current setup
Alarm viewer 30-30
AMV OCX 28-30
Modifying the logging properties for the point
Database logger, from point configuration 23-9
Modifying the resource list
Alarm viewer 30-31
Modifying the setup class list
AMV OCX 28-30
Modifying the setup resource list
AMV OCX 28-31
Monitor
Points runtime values 2-31
Runtime 2-28
More about redundant alarm printers 20-9
MoveDownOneAlarm
Alarm viewer method 29-5
MoveUpOneAlarm
Alarm viewer method 29-6
Multiple Open Windows 2-4
Mute sound
Alarm sound manager 18-6

N
Name
Finding 2-9
New project 2-15
Naming an alarm viewer control 29-1
Naming Points 4-3
Reserved words 4-3
Need Update
Point field 2-21
Network options
CIMPLICITY options 3-15
Network Printer
Flushing alarms 20-11
Networking considerations
RAS 37-14
RAS, Client has network card configured 37-14
New
Creating new device points 6-2
Creating virtual points 7-2
Project 2-14
Quick device setup 5-3
Record or file 2-25
New point conflicts
CIMPLICITY HMI and Control 26-9
New Project Options 3-1
None
Initialization option 7-6
Trigger point 6-19

xxii

O
Object
Display in left pane 2-5
ODBC configuration 24-2
Custom data sources 24-3
Data sources 24-2
Drivers 24-2
Microsoft Access data sources 24-4
Moving projects 24-3
Remote SQL Server data sources 24-6, 24-7
SQL Server client utilities, Installing 24-6
SQL Server data source, Configuring 24-6
SQL Server, Configuring 24-5
SQL Server, Installation 24-4
OLE Controls in CimView 31-21
On and Off
Manual mode 6-33
On Change
Trigger point 6-20
On Demand On Change 6-10
On Demand On Scan 6-9
On Scan 6-9
On Update alarming 8-19
Open
CIMPLICITY HMI browse windows 2-9
CimView screen 2-29
Different project in point cross reference
window 11-13
Field chooser dialog box 2-11
Multiple windows 2-4
Point cross reference 11-2
Point setup dialog box 4-5
Project 2-16
Quick Trend 2-32
Runtime windows 2-30
Workbench 2-2
Opening a project 3-3
Show Users 34-7
Operations
Overview for expressions 7-40
Operators
Arithmetic for expressions 7-41
Bitwise for expressions 7-42
Conversion for expressions 7-43
Logical for expressions 7-43
Relational
For expressions 7-43
Scientific for expressions 7-44
Valid for custom conversion 6-31
Option Button
All subsystems 11-4
Selected subsystems 11-4
Option properties
Alarm sound manager 18-9

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Options
For alarms 8-25
Options Button
Select subsystems 11-12
Oracle
Using with database logger 24-8
Oracle configuration
Database logger 24-8
Oracle requirements
Database logger 24-8
Out of Range 7-45
Output and error files
System, Checking B-14
Output and error files, Project
Checking B-14
Overview
Advanced 7-10
Advanced device point configuration 6-13
Advanced device point specifications 6-18, 7-15
Alarm limit values 8-21
Alarms 8-9
Device point configuration 6-1
Expression operations 7-40
Point class 4-2
Point Cross Reference 11-1
Point cross reference window panes 11-4
Point type 4-2
Point View 8-2
Point view - limits and alarms 8-1
Quick device setup 5-1
Runtime access 2-28
Trigger update options for device point example 6-21
Trigger update options for virtual point example 7-34
Understanding points 4-1
Virtual Points 7-1
Workbench 2-1
Workbench point display 9-1

P
PageDownAlarms
Alarm viewer method 29-6
PageUpAlarms
Alarm viewer method 29-6
Pane
Left 2-5
Right 2-6
Panes
In point cross reference window 11-4
Left in point cross reference window 11-6
Workbench 2-3

GFK-1180H

Index

Parameters
Database logger properties 23-41
Database logger, Alarm report 23-60
Database logger, Data report 23-63
Database logger, Trend report 23-66
Password, Changing
Login panel 34-14
Phone numbers
Distributors 1-1
Phone Numbers
Hotline 1-2
Ping
RAS, Testing the connection 37-13
Ping, Client
RAS, Testing the connection 37-13
Ping, Server
RAS, Testing the connection 37-14
Point
Dynamic configuration restrictions 2-23
Invalid 11-6
Monitoring runtime values 2-31
Point alarm triggered logging 23-52
Point attributes to be logged 23-26
Point bridge
Configuring points 36-48
Point configuration details 36-48
Point Bridge
Device point restrictions 6-11
Point by Address privilege 21-4
Point configuration
Configuring point bridge points 36-48
Point bridge point configuration details 36-48
Point Configuration
In point cross reference 11-1
Point conflicts, Incorrect information
CIMPLICITY HMI and Control 26-10
Point conflicts, New point
CIMPLICITY HMI and Control 26-9
Point conflicts, Resolving
CIMPLICITY HMI and Control 26-8
Point control panel
About 32-1
Changing font colors 32-6
Displaying point properties 32-3
Displaying point properties, Alarm 32-4
Displaying point properties, Details 32-3
Displaying points 32-2
Getting started 32-1
Saving the document 32-7
Point Control Panel
Drag points into 2-32
Open 2-32
Point control panel alarm changes
Security audit trail 36-38
Point Cross Reference

xxiii

Build database 11-3


Open 11-2
Overview 11-1
Points list 11-6
View options 11-7
Window panes 11-4
Point data logging scan rate
Database logger, Properties 23-42
Point data triggered logging 23-52
Point list, Filtering
Database logger 23-55
Point logging
Database logger properties 23-42
Point logging dialog box
Database logger, From point configuration 23-8
Point logging properties
Editing 23-49
Point timed/gated logging 23-53
Point Topic Attributes 33-3
ALARM_ENABLED 33-6
ALARM_HIGH 33-5
ALARM_LOW 33-5
DISP_FORMAT 33-4
DISP_HIGH 33-5
DISP_LOW 33-5
ELEMENTS 33-4
EU_LABEL 33-5
INIT_STATE 33-6
LENGTH 33-4
RAW_VALUE 33-3
SIZE 33-4
STATE 33-3
TYPE 33-4
VALUE 33-3
WARN_ENABLED 33-6
WARN_HIGH 33-5
WARN_LOW 33-5
Points
Focusing on in point cross reference 11-9
Lists in point cross reference 11-6
Type in point cross reference 11-7
Viewing in cross reference 11-5
Points, Adding to table
Database loger 23-49
Points, Removing from table
Database logger 23-49
Poll After Set 6-20
Poll Once 6-10
POLL_AFTER_SET 27-26
Port
Dynamic configuration 2-23
General properties 14-4
Port specific properties 14-4
Quick setup for a project 5-3

xxiv

Port Attributes
Description 14-2
Node 14-3
Port Id 14-2, 14-3
Protocol 14-3
Protocol Id 14-2
Port configuration
Changing protocols 14-5
Creating a new port 14-3
Port Configuration 14-1
Port General Properties
Description 14-4
Enable 14-4
Retry Count 14-4
Scan Rate 14-4
Ports
About 14-1
Configuring 14-1
Position
Of field in right pane 2-13
PRECISION 27-26
Print
Alarms on network printer additional steps 20-11
Printing alarms
Alarm viewer 30-34
Printing the status log file B-9
Prioritizing alarms
Alarm audio support 18-1
Prioritizing alarms, examples
Alarm audio support 18-2
PROC_ID 27-26
Procedure
Alarm class configuration 8-14
Associate a CimView screen with a point 8-2
Basic alarm configuration 8-9
Begin dynamic configuration 2-23
Begin dynamic configuration in the Database Logger
23-18
Configrue max capture point calculation 7-23
Configuration update 2-22
Configure a delta accum calculation 7-18
Configure a histogram calculation 7-30
Configure a min capture point calculation 7-25
Configure a timer/counter point 7-28
Configure a transhigh accum point 7-27
Configure absolute alarms 8-18
configure an equation point 7-16
Configure an equation w/override poinst 7-32
Configure automatic alarm acknowledgement 8-27
configure automatic alarm reset 8-28
Configure average calculation 7-22
Configure BEU for a device point 6-27
Configure BEU for a virtual point 7-36
Configure custom conversion for a device point 6-31
Configure deviation alarming 8-19

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Configure linear conversion for a device point 6-30


Configure manual alarm reset 8-28
Configure rate of change alarming 8-20
Configure setpoint limits 8-8
configure trigger settings for a device point 6-19
Configure value accum calculation 7-21
Create 7-2
Create a new role to view alarms 8-25
Create an expression 7-39
Create new device point 6-2
Create new project 2-14
Create new record or file 2-25
Creating diagnostic point using custom
addressing 6-12
Define an advanced alarm message 8-13
Device addressing 6-8
Display 8-3
Display the conversion tab for device points 6-26
Display the conversion tab for virtual points 7-36
Display the Limits tab 8-6
Drag points into Point Control Panel 2-32
Enable data and/or alarm logging for device
points 6-17
Enable data and/or alarm logging for virtual
points 7-14
Enable or disable a device point and/or its alarm 6-15
Enable or disable a virtual point and/or its alarm 7-11
Enter basic alarm message 8-10
Enter standard addressing specifications 6-12
General basic information for a device point 6-3
General basic information for an analog point 7-3
Initialization for analog and Boolean virtual
points 7-6
Open a CimView screen 2-29
Open prject 2-16
Open runtime window 2-30
Open the point setup dialog box 4-5
Put device tab in Advanced mode 6-18
Put general tab for device points in advanced
mode 6-14
Put general tab for virtual points in advanced
mode 7-10
Quick device setup for a project 5-3
Run project 2-20
Select an analog point justication 8-3
Select fields to display 2-11
Select point fields to display in the Workbench 9-5
Select record or file to be changed 2-26
Set security criteria for points 4-6
Specify a maximum alarm stack 8-29
Specify a safety point for a device point 6-15
Specify a safety point for a virtual point 7-12
Specify an auto alarm repeat 8-27
Specify an availability trigger for a device point 6-16
Specify an availability trigger for a virtual point 7-12

GFK-1180H

Index

Specify length of an alarm delay 8-22


Specify range limits 8-7
Specify trending data a virtual point 7-13
Specify trending data for a device point 6-16
Store virtual point values 7-8
View a points runtime values 2-32
View all the points in a project 9-1
View selected points in the Workbench 9-2
Procedures
Select all records for display 2-8
Select files for display 2-7, 2-8
Select selected records for display 2-8
Process Control privilege 21-4
Process log files
Backup files B-15
Process names in status log B-13
Profile, saving and loading
Alarm sound manager 18-6
Program control 34-17
CIMPLICITY HMI processes 34-20
exiting 34-22
Getting started 34-17
Orderly startup and shutdown 34-19
Refreshing the process list 34-22
Releasing the connection 34-22
Starting all halted processes 34-21
Stopping a running process 34-21
Stopping all running processes 34-22
Using 34-18
Program Control
Starting A Halted Process 34-20
Project 3-5
Change in point cross reference window 11-13
Create new 2-14
Enable wizard 2-18
Open 2-16
Open in point cross reference window 11-2
Opening 3-3
Run 2-20
Stop 2-21
Switch to another 2-20
Update 2-21
Project log and error files B-1
Project login/logout
Security audit trail 36-39
Project Menu
Login panel 34-11
Show Users 34-3
Project properties
Alarm sound manager 18-7

xxv

Project Properties
Enable Project Broadcast 3-6
General 3-5
Options 3-5, 3-6
Protocols 3-5
Setting 3-5
Project setup
For WebGateway 38-3
Project Wizard
Adding a new device 3-9
Adding a new point 3-10
Adding a new port 3-7
Devices 3-8
Modifying a device 3-9
Modifying a point 3-10
Modifying a port 3-8
Points 3-10
Protocols and Ports 3-7
Removing a device 3-9
Removing a point 3-10
Step 1 of 3 3-7
Step 2 of 3 3-8
Step 3 of 3 3-10
Using 3-7
Project WIzard
Removing a port 3-8
PROJECT_ID 36-17
Projects properties
AMV OCX 28-10
Properties
Database logger 23-40
Viewing for point 11-10
Protocol
Changing for port 14-5
Quick enable in a project 5-2
PT_ENABLED 27-26
PT_ID 27-13, 27-34
PT_ORIGIN 27-13, 27-27
PT_SET_INTERVAL 27-27
PT_SET_TIME 27-27
PT_TYPE 27-28, 27-34
PTDL_QUANTIZATION 36-3
PTMDP_DO_EU_CONV 36-18
PTMGMT_PROC_ID 27-26
PTMRP 36-18
PtXRef
Add subsystems to 11-11
Build 11-3
Build database again 11-11
Rebuild database 11-12
Refresh point cross reference view 11-8
Staying current 11-11

xxvi

PtXRef Database
Full View 11-5
Text View 11-5
Tree View 11-5
Purge actions
Database logger, Maintenance actions 23-32

Q
Quality
Point support at runtime 6-33
Queue size, Modifying
Alarm printer configuration 20-11
Quick
Device setup 5-1
Port setup for a project 5-3
Quick Trend
Open 2-32

R
R1
And linear conversion 6-30
R2
And linear conversion 6-30
Range
Configuring limits 8-7
Range Low/High
Limits 8-7
RANGE_HIGH 27-28
RANGE_LOW 27-28
RAS
About 37-1
About the example 37-2
CIMPLICITY options, Server 37-14
Client setup, Windows 95 37-11
Client setup, Windows NT 37-9
Configuring automatic startup, Windows NT server
37-7
Configuring the CIMHOSTS.TXT file 37-13
Further configuration, Windows NT client 37-11
Further configuration, Windows NT server 37-7
Granting client dial-in permission, Windows NT
server 37-8
Installing, Windows NT client 37-9
Installing, Windows NT server 37-4
Limitations on support 37-15
Networking considerations 37-14
Requirements 37-3
Server setup, Windows NT 37-4
Testing the connection 37-13
Testing the connection, Ping 37-13
Testing the connection, Ping on client 37-13
Testing the connection, Ping on server 37-14

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Rate of Change
Alarming 8-20
Raw Value
And linear conversion 6-30
RAW_LIM_HIGH 27-28
RAW_LIM_LOW 27-28
RAW_LIMIT_ALARM 36-18
And range limits 8-7
RAW_VALUE 33-3
REAL 6-4
Rebuild
PtXRef database 11-12
Reconciling a table
Database logger 23-38
Reconciling a table, Creating database fields
Database logger 23-39
Reconciling a table, Removing unused Microsoft
Access fields
Database logger 23-39
Reconciling a table, Removing unused Oracle fields
Database logger 23-39
Reconciling a table, Removing unused SQL Server
fields
Database logger 23-39
Reconnect wait period
Database logger, Database disconnect recover 24-13
Record
Create new 2-25
Finding its name 2-9
Select for display 2-7
Select to change 2-26
REDUND_LINK_SLEEP 36-6
Redundant alarm printers
More about 20-9
Ref Count 11-7
Referencing CWSERV from a Networked NT Client
33-15
Refresh
Screen in point cross reference window 11-8
Workbench window 2-4
Refreshing the alarm list
Alarm viewer 30-24
AMV OCX 28-23
Refreshing the process list 34-22
Registering CIMPLICITY HMI
Diskette license transfer A-3
Network license transfer A-2
Related
Operators and custom conversion 6-31
Relation
And trigger points 6-19
Relational
Operators for expressions 7-43
Releasing the program control connection 34-22

GFK-1180H

Index

Remote Access of CWSERV on Windows NT 33-14


Remote Access Server See RAS
Remote configuration
CIMPLICITY HMI and Control 26-11
Remote configuration, Example
CIMPLICITY HMI and Control 26-11
Remote project
Enterprise projects 36-47
General properties 36-46
Remote Projects 36-44
Creating 36-45
Remote SQL Server data sources 24-6, 24-7
Remove
Field from display 2-13
Removing
Saved logins 34-16
Removing an alarm
Alarm block group 19-6
Removing CIMPLICITY software A-6
From Windows 95/98 A-6
From Windows NT A-6
Removing CIMPLICITY Software
Removing Windows 95 Registry Information 36-25
Removing Windows NT Registry Information 36-26
Removing point for all logging tables, from point
configuration 23-9
Removing point from one or more tables
Database logger, from point configuration 23-9
Removing Registry Information 36-25
Removing Windows 95 Registry Information 36-25
Removing Windows NT Registry Information 36-26
Renaming a table
Database logger 23-36
Reorder
Field display position 2-13
REP_TIMEOUT 27-29
REPEAT_TOUT 36-18
Repeats
For alarms 8-26
Replacement
Creating floppy diskette A-5
Floppy A-4
Reporting
Database logger 23-56
Reports, Automatic printing
Database logger 23-68
Reports, Automatic printing, CimView triggers
Database logger 23-70
Reports, Automatic printing, Event Manager triggers
Database logger 23-70
Reports, Automatic printing, Maintenance action
triggers
Database logger 23-70

xxvii

Reports, Automatic printing, Modifying CIMPLICITY


service for
Database logger 23-68
Reports, Automatic printing, Script
Database logger 23-69
Reports, Automatic printing, Triggering
Database logger 23-70
Requirements
RAS 37-3
Reserved
Characters when naming points 4-4
Words when naming points 4-3
Reset Condition
And value accum points 7-21
Reset Point
And average points 7-23
And equation w/override points 7-33
And max capture point 7-24
And min capture point 7-25
And trans high accum point 7-27
Reset Procedures
For alarms 8-28
RESET_ALLOWED 27-29
RESET_COND 27-29
RESET_PT 27-29
RESET_TIMEOUT 27-30
Resetting an alarm
Alarm viewer 30-26
Resolving point conflicts
CIMPLICITY HMI and Control 26-8
Resolving problems See also Log files, Status log and
Status log viewer
About CIMPLICITY HMI log files B-1
Backup process log files B-15
Checking project output and error files B-14
Checking system output and error files B-14
Project log files B-1
System log files B-1
Viewing log files B-1
Resource Attributes
Alarm Mgr 13-2
Description 13-2
Resource ID 13-2
Resource Type 13-2
Resource configuration
Adding a new user 13-4
Adding a user 13-4
Deleting a user 13-4
Resource definition 13-3
Viewing user properties 13-4
Resource Configuration 13-1
Creating a resource 13-3
RESOURCE_ID 27-30

xxviii

Resources
About 13-1
Configuring 13-1
Responses 6-11
Restrictions
Database logger dynamic configuration 2-23
Device points 6-11, 6-20
Dynamic point configuration 2-23
Dynamic port configuration 2-23
On characters when naming points 4-4
On words when naming points 4-3
Remote project dynamic configuration 2-23
Retries 6-11
REV_CONV_EQ 27-30
Reverse
Custom device point conversion 6-31
Review
Point in point cross reference window 11-10
Right
Justification for an analog point 8-3
Right Pane
Changing the view 2-6
Field selection 2-11
Point cross reference window 11-10
Role Attributes
Role Id 21-2
Role configuration
Creating a new role 21-3
Role properties 21-3
Role Configuration 21-1
Role privileges
Delete Alarm 21-4
Dynamic Configuration 21-4
Modify Alarm Setups 21-4
Point by Address 21-4
Process Control 21-4
Script control 21-4
Security features 36-36
Set Point 21-4
Setpoint Audit Trail 21-4
Trigger event 21-4
Role properties 21-3
Roles
About 21-1
Assigned to view alarms 8-24
Configuring 21-2
Create new for viewing alarms 8-25
Removing from viewing alarms 8-24
ROLLOVER_VAL 27-30
Routing
Alarms 8-24
RTR_ACCEPT_CONN 36-3
RTR_DISABLE_BCAST 36-3
RTR_MAX_OUTMESSAGE_COUNT 36-6
RTR_STANDALONE 36-4

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Run
CIMPLICITY HMI project 2-20
Runtime
Access overview 2-28
Availability triggers and device points 6-16
Availability triggers and virtual points 7-12
Monitor a points values 2-31
Notes for virtual points 7-45
Opening a CimView window 2-29
Opening windows 2-30
Point quality support 6-33
Unavailable values 8-7
Run-time overview
AMV OCX 28-2

S
Safety Points
For device points 6-15
For virtual points 7-12
SAFETY_PT 27-31
Sample CWSERV Commands 33-2
Sample reports, Install
Database logger 23-58
Sample Spreadsheets and Macros for CWSERV 33-10
Array point example 33-11
Single point example 33-10
SAMPLE_INTV 27-31
SAMPLE_INTV_UNIT 27-31
Saved
Initialization option 7-6
Saved logins
Adding 34-15
Managing 34-15
Removing 34-16
Saved or Initialized
Initialization option 7-6
Saving the current alarm setup
AMV OCX 28-33
Saving the current setup
Alarm viewer 30-33
Saving the document
Point control panel 32-7
Saving the layout
Alarm viewer 30-20
Saving the status log as a text file B-8
Scan Rate
And base rate 6-20
SCAN_RATE 27-31
Scientific
Operators for expressions 7-44
Width for an analog point 8-4
Screen Properties
CimView 31-16
Script control privilege 21-4

GFK-1180H

Index

Script, Creating for automatic report 23-69


Scripts
In point cross reference 11-1
Scroll bars
CimView 31-3
Search
For a record or file 2-8
Search Aids
Browser windows 9-4
Wildcard characters 9-3
Search string wildcards
Database logger 23-5
Searching for user information
Show Users 34-8
Second Converted Value
And linear conversion 6-30
Security
Setpoint 4-5
Security audit trail
Dynamic configuration changes 36-39
Point control panel alarm changes 36-38
Project login/logout 36-39
Security features 36-38
Setpoint downloads 36-39
Security features
About 36-36
Login password 36-36
Role privileges 36-36
Security audit trail 36-38
Security audit trail, Dynamic configuration
changes 36-39
Security audit trail, Point control panel alarm
changes 36-38
Security audit trail, Project login/logout 36-39
Security audit trail, Setpoint downloads 36-39
Setpoint password 36-37
Setpoint security 36-37
Select
Another project 2-20
CimView screen for a selected point 2-32
Existing project 2-17
Field in right pane 2-11
Fields to display 2-13
SelectAllAlarms
Alarm viewer method 29-6
Selected Subsystems
Option button 11-4
Selecting a status log printer B-10
Selecting a status log to view B-6
Selecting alarm list color and font
Alarm viewer 30-12
Selecting alarm list fields
Alarm viewer 30-9
Selecting alarms
Alarm viewer 30-23

xxix

Selecting alarms from the list


AMV OCX 28-22
Selecting Objects With Procedures 31-11
SelectPageAlarms
Alarm viewer method 29-6
SelectTopAlarm
Alarm viewer method 29-6
Serial alarm printers
Additional configuration 20-10
Server setup
RAS, Windows NT 37-4
Set Point privilege 21-4
setCaption (Method)
WebGateway, Web data applet 38-8
Setpoint
Configure limits 8-8
Security 4-5
Setpoint audit trail privilege
More about 21-4
Setpoint Audit Trail privilege 21-4
Setpoint downloads
Security audit trail 36-39
Setpoint Low/High
Limits 8-8
Setpoint Object Selected with keyboard 31-13
Setpoint Object Selected With the Mouse 31-12
Setpoint password
Security features 36-37
Setpoint security
Security features 36-37
SETPOINT_HIGH 27-32
SETPOINT_LOW 27-32
SETPOINT_SECURITY 36-4
setPointID (Method)
WebGateway, Web data applet 38-10
Setting CIMPLICITY startup options
Windows 95, CimView autostart 3-18
Setting CimView Window Options 31-14
Setting project options 3-12
Setting Project Properties 3-5
Setting run-time alarm properties 17-4
Setting run-time user properties 22-3
Setting Startup Options 3-12
Setup
Hardware in quick device setup 5-1
Quick device setup 5-1
Quick device setup for a project 5-3
Quick port setup for a project 5-3
Quick protocol setup 5-2
Setup.exe
And floppy disk installation A-4
SHORT_FILENAMES 36-19

xxx

Shortcut keys
Alarm viewer 30-4
Database logger, Main window 23-17
Status log viewer B-5
Shortcut Keys
CimView 31-9
Configuration Cabinet 3-4
Login panel 34-12
Show Users 34-6
Show Only Used Points
Check box 11-7
Help Menu 34-4
Search Menu 34-4
Show Users 34-2
Changing view options 34-6
Closing a project view 34-9
Help Menu 34-4
Menu options 34-3
Opening a project 34-7
Project Menu 34-3
Search Menu 34-4
Searching for user information 34-8
Shortcut keys 34-6
Starting 34-2
Toolbar buttons 34-5
View Menu 34-3
Window Menu 34-5
Window Menu 34-5
Single Point Example - CWSERV 33-10
SINT 6-4
Site wide installation
Creating application source directory 36-31
Creating job for CIMPLICITY HMI
installation 36-34
Creating SMS package for CIMPLICITY HMI
installation 36-33
Introduction 36-27
Site wide installation procedure
CIMPLICITY HMI 36-31
SIZE 33-4
SMS package
Creating for CIMPLICITY HMI site wide
installation 36-33
SNF file format 27-2
Sort
Points in point cross reference view 11-7
Sort/display properties
AMV OCX 28-11
Source
For points 4-2
SQL server
Configuring additional locks 24-9
Database management 24-9
Handling transaction log 24-10

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Truncating transaction log as CIMPLICITY


maintenance action 24-10
Truncating transaction log as system default 24-10
SQL Server configuration 24-5
SQL Server data source configuration 24-6
SQL Server installation 24-4
Stack
Maximum alarm 8-29
Stand-alone alarm viewer See also, Alarm Viewer
About 30-1
Configuring 30-2
Standard
Domain address 6-12
Standard Alarms 17-2
$ALARM_DISABLED 17-2
$ALARM_ENABLED 17-2
$ALARM_MODIFIED 17-2
$ALARM_RAWLIM 17-2
$ALARM_RESTORED 17-2
$AM_STATUS 17-2
$DEVICE 17-2
$DEVICE_DOWN 17-2
$DEVICE_FAILOVER 17-2
$DL_FILE_FULL 17-2
$DOWNLOAD 17-2
$DYN_CFG 17-2
$GMR_DEV_DOWN 17-2
$GMR_POINT_DISCREPANCY 17-2
$LOGON 17-3
$LOGOUT 17-3
$REDUND_DEV_DOWN 17-3
$RTR_LINK_DOWN 17-3
AMSI_ALARM 17-3
DB_CONN_DOWN 17-3
DB_START_FORWARD 17-3
MCP_PROC_DOWN 17-3
Start
CIMPLICITY HMI project 2-20
Point cross reference 11-2
Start as a viewer
CIMPLICITY options 3-13
Start project in list
CIMPLICITY options 3-14
Start: 2-2
Starting A Halted Process 34-20
Starting all halted processes 34-21
Starting CimView screens automatically at boot
Windows 95 3-16
Starting CWSERV 33-7
Starting the login panel 34-10
Startup options
CIMPLICITY options 3-14
Startup properites
Alarm sound manager 18-10
startup.exe 3-26

GFK-1180H

Index

STARTUP_TIMEOUT 36-4
STATE 33-3
Static alarm list button layout
Alarm viewer 30-13
Static mode, About
AMV OCX 28-2
Status bar
In Workbench 2-4
Status Bar
CimView 31-3
Status log viewer
Displaying message details B-7
Filtering messages B-11
Finding messages B-12
Finding the next message B-13
Help menu B-5
Log menu B-4
Menu options B-4
Printing the log file B-9
Process names B-13
Saving status log as a text file B-8
Selecting a log to view B-6
Selecting a printer B-10
Shortcut keys B-5
Toolbar buttons B-5
Using B-2
View menu B-4
Which status log file gets displayed B-3
Stop
Project 2-21
Stop a project
CIMPLICITY options 3-13
Stopping a running process 34-21
Stopping all running processes 34-22
Store
Virtual point values 7-8
Store alarm comments
More about 17-4
Store and forward
Database logger, Database disconnect recovery 24-13
Database logger, Logging properties 23-34
Database logger, Properties 23-44
Store and forward, Changing defaults, Database
disconnect recovery 24-15
Store and forward, Enabling
Database logger, Database disconnect recovery 24-14
Store and forward, Filenames
Database logger, Database disconnect recovery 24-14
Store and forward, Maximum records
Database logger, Database disconnect recovery 24-15
STRING 6-5
String Index 8-13
STRING_20 6-5
STRING_8 6-5

xxxi

Support
Hotline 1-2
Point quality 6-33
Supported device protocols
CIMPLICITY HMI and Control 26-2
SVC_RETRY_COUNT 36-19
SVC_RETRY_DELAY 36-19
Switch
projects 2-20
SYSNAME 36-4
System - CWSERV System Topic 33-12
System boot options
CIMPLICITY options 3-15
System log and error files B-1
System management 36-1
About 36-1
Deleting login information 36-24
Global parameters See also Global parameters
Device communications 36-20
Modified for all projects 36-5
Modified per project 36-7
Modified through configuration functions 36-2
Global parameters, Editing 36-2
Global parameters, Sample File 36-21
Logical names, Descriptions 36-24
Removing CIMPLICITY Software, Removing
Windows 95 Registry Information 36-25
Removing CIMPLICITY Software, Removing
Windows NT Registry Information 36-26
Removing Registry Information 36-25
System parameters
Logical names See also Logical names
Logical names, Editing the file 36-23
System utilities
Using Program Control See Program control
System Utilities
About 34-1
Login panel See Login panel
Show Users See Show Users

T
Tab
Advanced alarm 8-11
Advanced device 6-18
Advanced general for device points 6-14
Advanced general for virtual points 7-10
Advanced virtual 7-10
Basic alarm 8-9
Basic device 6-8
Basic general for device points 6-3
Basic general for virtual points 7-3
Basic virtual 7-6
Conversion for device points 6-26
Conversion for virtual points 7-36

xxxii

Limits 8-6
View 8-3
Table attributes to be logged 23-25, 23-27
Table browser
Database logger, From point configuration 23-11
Table characteristics
Database logger 23-6, 24-11
Table list, Filtering
Database logger 23-35
Table properties
Database logger 23-20
Table, Adding points
Database logger 23-49
Table, Copying
Database logger 23-36
Table, Creating
Database loger 23-19
Table, Deleting
Database logger 23-37
Table, Reconciling
Database logger 23-38
Table, Removing points
Database loggger 23-49
Table, Renaming
Database logger 23-36
Testing the connection
RAS 37-13
Testing the connection, Ping
RAS 37-13
Testing the connection, Ping on client
RAS 37-13
Testing the connection, Ping on server
RAS 37-14
Testing the connections
WebGateway 38-4
Text
Virtual point initialization 7-7
Text View
In point cross reference 11-5
Review point information in text view pcr
window 11-10
Timed/gated logging
Database logger, Logging conditions 23-24
Timed/Gated Logging
Notes about 23-29
On dgital point state-gated only 23-29
Periodic/Synchronized/On digital point
state-gated 23-30
Synchronized/On digital point state-gated 23-30
Timed/gated maintenance events 23-28
TimedGated Logging
Periodic/On digital point state-gated 23-29
Timer/Counter Point 7-28
Title Bar
CimView 31-3

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Toggling between lists


Alarm viewer 30-24
AMV OCX 28-23
Toolbar
View options button 11-7
Toolbar buttons
Alarm viewer 30-4
Database logger, Main window 23-17
Status log viewer B-5
Toolbar Buttons
CimView 31-8
Configuration Cabinet 3-4
Login panel 34-12
Show Users 34-5
Toolbar buttons, Database logger, Table window 23-48
Toolbars
CimView 31-3
Workbench 2-3
Tools
Finding record or file names 2-9
For record and file configuration 2-24
Runtime monitoring 2-28
Topics - CWSERV System Topic 33-12
Trans High Accum Points 7-26
Transaction log
Truncating as CIMPLICITY maintenance action
24-10
Truncating as system default 24-10
Transer CIMPLICITY License A-1
Transfer
License from one computer to another A-1
Transferring Licenses
Diskette transfer A-3
Network Transfer A-2
Transmissions 6-11
Tree View
In point cross reference 11-5
Review point information 11-10
Trend History
For a device point 6-16
For a virtual point 7-13
Trend report
Database logger 23-65
Database logger, Clearing error log 23-67
Database logger, Generating 23-67
Database logger, Setting parameters 23-66
TRIG_CK_PT 27-32
TRIG_PT 27-32
TRIG_REL 27-33
TRIG_VAL 27-33
Trigger
Example with virtual points 7-35
Trigger an automatic report 23-70
Trigger event privilege 21-4
Trigger Function

GFK-1180H

Index

Explanation for device points 6-21


Explanation for virtual points 7-34
Trigger Point
And equation w/override points 7-33
And max capture point 7-24
And min capture point 7-25
And trans high accum point 7-27
Equal relation 6-19
Greater than equal 6-19
Greater than relation 6-19
Less than 6-19
Less than equal 6-19
None relation 6-19
On change 6-20
Trigger Points
For device points 6-19
For virtual points 7-15
Triggered maintenance events 23-28
Troubleshooting
WebGateway 38-6
Type
Of points 4-2
TYPE 33-4

U
UDINT 6-4
UINT 6-4
Uninstall A-6
Unsolicited 6-10
Unsolicited On Change 6-10
Update
Criteria for a device point 6-9
Project after a change 2-21
Update Criteria
And trigger function for device points 6-21
And trigger function for virtual points 7-34
UPDATE_CRITERIA 27-33
Used Points
Viewing 11-5
User Attributes
Role Id 22-2
User Id 22-2
User Name 22-2
User configuration 22-1
Creating a new user 22-4
Run-time login failures 22-3
Setting run-time user properties 22-3
User General Properties 22-5
Password 22-6
Password Needed 22-5
Role 22-5
User Name 22-6
User properties
Run-time 22-3

xxxiii

User Resource Properties 22-7


Adding a single Resource 22-7
Adding all Resource 22-7
Deleting a Resource 22-8
Users
About 22-1
Default User 22-1
Roles and Privileges 22-1
Security 22-1
View of Resources 22-1
Using CIMPLICITY Software 3-1
Using CimView See CimView
Using client configuration 25-1
Using CWSERV With Microsoft Excel 33-6
Using the alarm list buttons
Alarm viewer 30-23
AMV OCX 28-23
Using the CIMPLICITY To Windows Server 33-1
Using the Project Wizard 3-7
Adding a new device 3-9
Adding a new point 3-10
Adding a new port 3-7
Devices 3-8
Modifying a device 3-9
Modifying a point 3-10
Modifying a port 3-8
Points 3-10
Removing a device 3-9
Removing a point 3-10
Removing a port 3-8
Step 1 of 3 3-7
Step 2 of 3 3-8
Step 3 of 3 3-10
Using the Project WIzard
Protocols and Ports 3-7
USINT 6-4

V
Valid
Operators and custom conversion 6-31
validating project connections
WebGateway 38-4
Validating web connections
WebGateway. 38-4
VALUE 33-3
Value Accum Point 7-21
Values
Store for virtual points 7-8
VARIANCE_VAL 27-33
VARS 27-34
View
A point in point cross reference 11-9
All files for an object 2-8
All records for an object 2-8

xxxiv

Change the left pane 2-5


Change the right pane 2-6
Open tab 8-2
Point Control Panel 2-32
Point cross reference window 11-4
Point information in tree view pcr window 11-10
Refresh in point cross reference window 11-8
Selected files for an object 2-8
Selected records for an object 2-8
View menu
Alarm viewer 30-3
View Menu
CimView 31-5
Login panel 34-12
Show Users 34-3
View Options
Dialog box 11-7
Viewing alarm comments
Alarm viewer 30-25
AMV OCX 28-24
Viewing log and error files B-1
Viewing the alarm list
Alarm viewer 30-23
Viewing the alarm stack
Alarm viewer 30-25
AMV OCX 28-24
Viewing the alarms CimView screen
Alarm viewer 30-26
AMV OCX 28-25
Viewing user properties for a resource 13-4

W
WARN_ENABLED 33-6
WARN_HIGH 33-5
WARN_LOW 33-5
Warning
Update 2-21
Wave file configuration
Alarm audio support 18-4
Web server requirements
WebGateway 38-2
WebGateway
About 38-1
Components 38-3
Error messages 38-6
Error messages,
#ERROR!ARAYNOTALLOWED 38-6
Error messages,
#ERROR!ARRAYOUTOFBOUNDS 38-6
Error messages,
#ERROR!BADSERVERRESPONSE 38-6
Error messages,
#ERROR!CIMPLICITYNOTRUNNING 38-6
Error messages, #ERROR!INVALIDPOINTID 38-7

CIMPLICITY HMI Users ManualMarch 1999

GFK-1180H

Error messages,
#ERROR!NOTIMPLEMENTED 38-7
Error messages, #ERROR!NOTLICENSED 38-7
Error messages, #ERROR!POINTIDSYNTAX 38-7
Error messages, #ERROR!POINTUNAVAILABLE
38-7
Error messages,
#ERROR!SERVERNEEDSRESTART 38-7
Error messages, #ERROR!URLEXCEPTION 38-7
Installation procedure 38-2
Installing 38-1
Project setup for 38-3
Testing the connections 38-4
Troubleshooting and error messages 38-6
Troubleshoting custom HTML pages 38-6
Validating project connections 38-4
Validating web connections 38-4
Web data applet 38-8
Web data applet, appendCaption (Method) 38-8
Web data applet, clearPoints (Method) 38-10
Web data applet, getCaption (method) 38-8
Web data applet, getPointStatus (read only
property) 38-11
Web data applet, getPointValue (read only
property) 38-11
Web data applet, pointGet (Method) 38-8
Web data applet, pointSet (Method) 38-10
Web data applet, setCaption (method) 38-8
Web data applet, setPointID (Method) 38-10
Web server requirements 38-2
Whats Running 3-21
Which status log file gets displayed B-3
Width
Display for an analog point 8-4
Wild Card Characters
For finding points in the Workbench 9-3
Wildcards
Database logger 23-5
Window
Open browse 2-9
Open multiple 2-4
Point cross reference 11-2
Refresh 2-4
Window buttons
CimView 31-3
Window buttons, using
Alarm sound manager 18-6
Window Components
CimView 31-2
Window Pop-up Menu
CimView 31-8
Windows 95/98
Removing CIMPLICITY software from A-6
Windows NT
Removing CIMPLICITY software from A-6

GFK-1180H

Index

Wizard
Enable 2-18
WORD 6-5
Words
Reserved when naming points 4-3

Z
Zero
Justification for an analog point 8-3

xxxv

Vous aimerez peut-être aussi