Вы находитесь на странице: 1из 0

GE Fanuc Automation

CIMPLICITY

Monitoring and Control Products


CIMPLICITY
Base System
User's Manual
GFK-1180J December 2000
ii CIMPLICITY User's ManualDecember 2000 GFK-1180J
GFL-005
Following is a list of documentation icons:
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 provides information when careful attention must be taken in order to avoid
damaging results.
Important flags important information.
To do calls attention to a procedure.
Note calls attention to information that is especially significant to understanding and
operating the equipment.
Tip provides a suggestion.
Guide provides additional directions for selected topics.
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, nor 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 NT, Windows 2000 and Windows 98 are registered trademarks of Microsoft Corporation
This manual was produced using Doc-To-Help

, by WexTech Systems, Inc.


Copyright 2000 GE Fanuc Automation North America, Inc.
GFK-1180J iii
Preface
Contents of this Manual
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.
Chapter 9: Changing the Workbench Point Display: Describes the many ways to change the point
information displayed in the Workbench.
Chapter 10: Using Point Attributes: Describes the different types of point attributes that help you
evaluate different perspectives of a point's status.
Chapter 11: Configuring Classes: Provides an in-depth description of classes (including the
relationship to class objects) and provides steps to configure them.
Chapter 12. Configuring Class Objects: Describes how to create a class object.
Chapter 13: 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 14: Point Cross Reference: Describes the CIMPLICITY HMI tool that facilitates keeping
track of where and how points are used.
Chapter 15. Device Configuration: Explains how to configure devices.
Chapter 16. Configuring Resources: Explains how to configure resources.
Chapter 17. Configuring Ports: Explains how to configure ports.
Chapter 18. Alarm Class Configuration: Explains how to configure alarm classes.
Chapter 19. Alarm String Configuration: Explains how to configure alarm strings.
iv CIMPLICITY User's ManualDecember 2000 GFK-1180J
Chapter 20. Alarm Configuration: Explains how to configure alarms.
Chapter 21. Alarm Audio Support: Shows you how to configure audible alarms.
Chapter 22. Alarm Blocking Configuration: Shows you how to implement hierarchical alarm
blocking.
Chapter 23. Alarm Printer Configuration: Shows you how to configure a printer to record alarm
messages.
Chapter 24. Configuring Roles: Explains how to configure roles.
Chapter 25. User Configuration: Explains how to configure users.
Chapter 26. Configuring the Database Logger: Describes the Database Logger features and how to
configure tables and reports.
Chapter 27. Managing Database Logging: Provides ODBC and SQL configuration and management.
Chapter 28. Client Configuration: Shows you how to configure default logins for CIMPLICITY
HMI Viewers on client computers.
Chapter 29: Using CIMPLICITY HMI with CIMPLICITY Control: Shows you how to import
variables from a Control folder into points in an HMI project.
Chapter 30. Import/Export Configuration: Documents the Import/Export utility.
Chapter 31. Using the Alarm Viewer OCX: Documents how to use the Alarm Viewer OCX in
CimView to display alarm information.
Chapter 32. Alarm Viewer Methods: Documents the methods you can use in CimEdit and CimView
in conjunction with the Alarm Viewer OCX.
Chapter 33. Using the Stand-Alone Alarm Viewer: Shows you how to use the stand-alone Alarm
Viewer to display alarm information.
Chapter 34. Using CimView: Explains the features of the graphic screen viewer.
Chapter 35. Using the Point Control Panel: Shows you how to use the Point Control Panel to
display point information.
Chapter 36. Using the CIMPLICITY to Windows Server (DDE): Discusses how to use CWSERV
with third-party software such as Microsoft Excel spreadsheets.
Chapter 37. System Utilities: Describes the Show Users and Program Control features of the System
Utilities option.
Chapter 38. Using Measurement Units: Explains measurement units and how to configure them.
Chapter 39. Using Global Parameters: Describes how to use the Global Parameters application and
lists and defines the global parameters for CIMPLICITY.
GFK-1180J v
Chapter 40. System Management: Discusses system management functions such as
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 41. 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 42. CIMPLICITY HMI Web Gateway: Shows you how to use this feature to let users
access your CIMPLICITY HMI data over the Internet.
Appendix A. Registering and Licensing CIMPLICITY Software: Provides the steps to register
CIMPLICITY software.
Appendix B. Removing CIMPLICITY Software: Describes how to remove CIMPLICITY software
from the Windows Registry.
Appendix C. Resolving Problems: Discusses how to use the Status Log Viewer and system log files
to find an resolve problems.
GFK-1180J Contents-vii
Contents
Welcome to CIMPLICITY 1-1
Welcome................................................................................................................................ 1-1
Distributor Telephone Numbers............................................................................................. 1-1
Customer Support................................................................................................................... 1-2
Using the Workbench 2-1
About the CIMPLICITY Workbench..................................................................................... 2-1
Opening the Workbench.......................................................................................... 2-1
Workbench at a Glance.......................................................................................................... 2-3
Multiple Workbench Windows.............................................................................................. 2-5
Opening Additional Workbench Windows on the Same Computer......................... 2-5
Refreshing a Project Display in an open Workbench............................................... 2-6
Workbench Display Options.................................................................................................. 2-7
Expanding / Collapsing the Left Pane View............................................................ 2-7
Changing the Right Pane View................................................................................ 2-8
Selecting Records or Files to Display in the Right Pane.......................................... 2-9
Selecting Fields to Display in the Right Pane........................................................ 2-14
Workbench Procedures for CIMPLICITY Projects............................................................. 2-16
Starting a CIMPLICITY Project............................................................................ 2-16
Switching from One Project to another using the same Workbench...................... 2-17
Copying an Existing Project to Create a New Project............................................ 2-18
Renaming a CIMPLICITY HMI Project................................................................ 2-19
Inserting a Project Shortcut in the Windows Start Menu....................................... 2-20
Stopping a CIMPLICITY Project.......................................................................... 2-21
Dragging Items from One CIMPLICITY Project into Another ............................. 2-22
Updating a CIMPLICITY Project.......................................................................... 2-24
Record and File Configuration............................................................................................. 2-27
Creating a New Record or File............................................................................... 2-28
Opening a Record or File for Modification............................................................ 2-29
Runtime Access.................................................................................................................... 2-31
Opening the CimView Screen................................................................................ 2-32
Opening Runtime Windows other than CimView.................................................. 2-33
Monitoring a Selected Point's Runtime Values...................................................... 2-34
Dragging Points into the Point Control Panel ........................................................ 2-35
Setting up a CIMPLICITY Project 3-1
Project Opened....................................................................................................................... 3-1
Project Properties................................................................................................................... 3-3
Opening the Project Properties Dialog Box............................................................. 3-3
Configuring Project Properties................................................................................. 3-4
Using the Project Properties Settings Tab................................................................ 3-7
CIMPLICITY Project Wizard................................................................................................ 3-8
Contents-viii CIMPLICITY User's ManualDecember 2000 GFK-1180J
Enabling the Project Wizard through the New Project Dialog Box.........................3-8
Enabling the Project Wizard Though the Workbench..............................................3-9
Project Shortcut in the Windows Start Menu.......................................................................3-10
CIMPLICITY Options.........................................................................................................3-11
Opening the CIMPLICITY Options Dialog Box...................................................3-11
Setting CIMPLICITY Projects Options.................................................................3-11
Setting Startup Options..........................................................................................3-14
Starting CimView Screens Automatically on a Windows 98 Viewer.....................3-18
CIMPLICITY Program Layers.............................................................................................3-23
About Configuration Updates...............................................................................................3-24
CIMPLICITY Login.............................................................................................................3-25
CIMPLICITY Project to Diskette........................................................................................3-27
CIMPLICITY Command Line Options................................................................................3-28
Understanding Points 4-1
About Points...........................................................................................................................4-1
Categorizing Points..................................................................................................4-2
Naming Points..........................................................................................................4-2
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
Device Point Basic Configuration..........................................................................................6-3
Selecting the Device Points Data Type...................................................................6-3
Using Arrays............................................................................................................6-6
Entering Addressing Specifications for a Device Point ...........................................6-8
Advanced Device Point Configuration.................................................................................6-14
Entering Advanced General Specifications for Device Points...............................6-14
Entering Advanced Device Point Specifications....................................................6-19
Reviewing the Trigger Function.............................................................................6-23
Reviewing the Delay Load Function......................................................................6-27
Point Conversions and Enumeration....................................................................................6-28
Displaying the Point Properties Conversion Tab...................................................6-29
Configuring Base Point Engineering Units............................................................6-30
Configuring the Conversion Type for a Device Point............................................6-33
Configuring a Point as an Enumeration Point........................................................6-37
Device Point Quality Support at Runtime............................................................................6-45
Configuring Virtual Points 7-1
About Virtual Point Configuration.........................................................................................7-1
New Virtual Points.................................................................................................................7-2
Virtual Point Basic Configuration..........................................................................................7-3
Selecting the Virtual Point's Data Type...................................................................7-3
Using Arrays............................................................................................................7-5
GFK-1180J Contents Contents-ix
Entering Initialization Specifications for a Virtual Point......................................... 7-6
Specifying how Virtual Point Values are Stored...................................................... 7-9
Advanced Virtual Point Configuration................................................................................. 7-11
Entering Advanced General Specifications for Virtual Points............................... 7-11
Configuring Advanced Virtual Calculations.......................................................... 7-16
Understanding the Trigger Function for Virtual Points.......................................... 7-41
Specifying Point Measurement Units or Point Enumeration.................................. 7-42
About the Expression Editor................................................................................................ 7-43
Alarm Functions..................................................................................................... 7-44
Arithmetic Operations............................................................................................ 7-45
Bitwise Operations................................................................................................. 7-46
Conversion Operation............................................................................................ 7-48
Logical Operations................................................................................................. 7-48
Relational Operations............................................................................................. 7-48
Scientific Operations.............................................................................................. 7-49
Runtime Notes for Virtual Points......................................................................................... 7-50
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-2
Point Limits............................................................................................................................ 8-7
Displaying the Limits Tab........................................................................................ 8-7
Configuring Range Limits........................................................................................ 8-8
Configuring Setpoint Limits for a Point................................................................... 8-9
Alarms in Point Configuration............................................................................................. 8-10
Configuring the Basic Alarm Tab.......................................................................... 8-10
Displaying the Advanced Alarm Tabs................................................................... 8-13
Configuring the Advanced Alarm Tab................................................................... 8-14
Routing Alarms...................................................................................................... 8-28
Setting Alarm Options............................................................................................ 8-31
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-6
Reviewing Point Field Definitions in the Workbench.............................................. 9-8
Using Point Attributes 10-1
About Point Attributes......................................................................................................... 10-1
User Defined Point Attributes.............................................................................................. 10-2
Viewing a Project's Existing Point Attribute Sets.................................................. 10-3
Creating a New Point Attribute Set........................................................................ 10-3
Editing an Existing Attribute Set ........................................................................... 10-9
Attributes Applied.............................................................................................................. 10-11
Quality Attributes............................................................................................................... 10-16
Runtime Attributes............................................................................................................. 10-20
Configuration Attributes..................................................................................................... 10-21
Point Attribute Security...................................................................................................... 10-38
Contents-x CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring Classes 11-1
Classes and Objects Overview.............................................................................................11-1
Class-Object Evolution and Construction Overview............................................................11-2
Class Configuration..............................................................................................................11-7
Step 1. Plan a Class..............................................................................................................11-8
Task 1. Determine the Class Application...............................................................11-9
Task 2. Determine the Data to be Collected...........................................................11-9
Task 3. Map a Layout of how Memory is Stored in Class Devices......................11-10
Task 4. Determine the Calculations needed for the Data.....................................11-11
Task 5. Define Class Scripts, Actions and Events................................................11-12
Step 2. Create a Class.........................................................................................................11-13
Step 3. Configure Class Attributes.....................................................................................11-15
Step 3. Configure Class Attributes Task 1. Review CIMPLICITY
Class Attributes....................................................................................................11-16
Step 3. Configure Class Attributes Task 2. Create a Custom Attribute................11-17
Step 3. Configure Class Attributes Task 3. Configure a Class Attribute Definition11-18
Step 3. Configure Class Attributes Task 4. Configure the Attribute's Field that
displays in the Object Dialog Box........................................................................11-20
Step 4. Configure Data Items.............................................................................................11-24
Step 4. Configure Data Items Task 1. Create a Data Item....................................11-26
Step 4. Configure Data Items Task 2. Begin Data Item Configuration................11-27
Step 4. Configure Data Items Task 3A. Use CIMPLICITY Class Attributes for
Configuration.......................................................................................................11-29
Step 4. Configure Data Items Task 2B. Use String Expressions in
Data Item Fields...................................................................................................11-31
Step 4. Configure Data Items Task 3C. Use Numeric Expressions
in Data Item Fields...............................................................................................11-35
Step 4. Configure Data Items Task 3D. Use Address Adjustment Expressions...11-40
Understanding Data Item Options........................................................................11-42
Step 5. Write Class Scripts.................................................................................................11-44
Step 5. Write Class Scripts Task 1. Create a Class Script....................................11-46
Step 5. Write Class Scripts Task 2. Write a Class Script through the Scripts Tab11-47
Step 6. Configure Class Actions.........................................................................................11-48
Step 6. Configure Class Actions Task 1. Create a Class Action...........................11-50
Step 6. Configure Class Actions Task 2. Define a Class Action..........................11-51
Step 7. Configure Class Events..........................................................................................11-55
Step 7. Configure Class Events Task 2. Create a Class Event..............................11-57
Step 7. Configure Class Events Task 2. Configure a Class Event........................11-58
Step 8. Configure a Class CimEdit Screen.........................................................................11-61
Step 8. Configure a Class CimEdit Screen Task 1. Place the required objects on a
screen. ..................................................................................................................11-62
Step 8. Configure a Class CimEdit Screen Task 2. Group the Objects................11-63
Step 8. Configure a Class CimEdit Screen Task 3. Configure the Top-level Group
Object...................................................................................................................11-65
Step 8. Configure a Class CimEdit Screen Task 4. Assign Properties to Objects
within the Group..................................................................................................11-68
Step 8. Configure a Class CimEdit Screen Task 5. Associate the
Screen with its Class............................................................................................11-71
Step 9. Create a Class Help File.........................................................................................11-74
Step 10. Export or Import a Class......................................................................................11-75
Step 10. Export or Import a Class Task 1. Export a Class...................................11-75
Step 10. Export or Import a Class Task 2. Import a Class...................................11-76
Definitions for Classes Terminology..................................................................................11-78
GFK-1180J Contents Contents-xi
Configuring Class Objects 12-1
About Point Objects............................................................................................................. 12-1
Definitions............................................................................................................. 12-2
What happens when an object is instantiated?....................................................... 12-3
About the Object Dialog Box................................................................................. 12-4
Create Point Object.............................................................................................................. 12-5
Configure Object Properties................................................................................................. 12-7
Assign Attribute Values......................................................................................... 12-8
Add Point Object to Project............................................................................................... 12-12
A Look at the Finished Sample Point Object..................................................................... 12-13
Working with Point Objects............................................................................................... 12-16
Using System Points 13-1
About System Points............................................................................................................ 13-1
Point Cross Reference 14-1
About Point Cross Reference............................................................................................... 14-1
Opening the Point Cross Reference Window......................................................... 14-2
Building a Points Cross Reference Database......................................................... 14-3
Viewing Points in the Point Cross Reference Window.......................................... 14-4
Focusing on One Point........................................................................................... 14-9
Maintaining a Current Point Cross Reference Database...................................... 14-12
Opening a Different CIMPLICITY HMI Project................................................. 14-14
Device Configuration 15-1
About Devices...................................................................................................................... 15-1
Device Configuration........................................................................................................... 15-1
Viewing a Device's Details in the Workbench....................................................... 15-2
Creating a New Device.......................................................................................... 15-3
Modifying an Existing Device............................................................................... 15-4
Configuring Device General Properties................................................................. 15-5
Configuring Device-Specific Properties................................................................ 15-6
Configuring Resources 16-1
About Resources.................................................................................................................. 16-1
Resource Configuration........................................................................................................ 16-2
Creating A New Resource...................................................................................... 16-2
Configuring a Resource Definition........................................................................ 16-3
Configuring Ports 17-1
About Ports.......................................................................................................................... 17-1
Port Configuration................................................................................................................ 17-2
Creating A New Port.............................................................................................. 17-3
Modifying an Existing Port.................................................................................... 17-4
Configuring Port General Properties...................................................................... 17-5
Configuring Port-Specific Properties..................................................................... 17-7
Procedure to Change a Port's Protocol ................................................................................. 17-8
Contents-xii CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarm Class Configuration 18-1
About Alarm Classes............................................................................................................18-1
Configuring Alarm Classes...................................................................................................18-1
Creating A New Alarm Class.................................................................................18-3
Audio Support........................................................................................................18-4
Alarm Class Color Assignments...........................................................................................18-5
Mapping Alarm Class Colors in RGB.DAT.........................................................................18-6
Alarm String Configuration 19-1
About Alarm Strings.............................................................................................................19-1
Alarm String Configuration..................................................................................................19-3
Step 1. View Existing Alarm Strings......................................................................19-3
Step 2A. Create an Alarm String............................................................................19-4
Step 2B. Open an Existing Alarm String Index Dialog Box..................................19-5
Step 3. Configure an Alarm String Index...............................................................19-6
Alarm Configuration 20-1
About Alarms.......................................................................................................................20-1
Viewing Alarms in the Alarms Folder....................................................................20-1
Reviewing CIMPLICITY Event Alarms................................................................20-2
Alarm Configuration.............................................................................................................20-4
Step 1. Create an Event Alarm...............................................................................20-4
Step 2A. Configure an Event Alarm Definition.....................................................20-5
Step 2B. Configure a Point Alarm Definition........................................................20-7
Step 3. Configure Alarm Routing...........................................................................20-9
Step 4. Configure Alarm Options.........................................................................20-10
Step 5. Select whether or not to Store Alarm Comments.....................................20-11
Using Alarm Audio Support 21-1
About Alarm Audio Support................................................................................................21-1
About Prioritizing Alarms......................................................................................21-2
Configuring Alarm Audio Support.......................................................................................21-3
About Alarm Sound Manager...............................................................................................21-5
Using the Alarm Sound Manager.........................................................................................21-5
Projects Properties.................................................................................................21-7
Option Properties...................................................................................................21-9
Startup Properties.................................................................................................21-10
Alarm Blocking Configuration 22-1
About Alarm Blocking.........................................................................................................22-1
Assigning Alarms...................................................................................................22-2
Choosing Blocking Modes.....................................................................................22-2
Assigning Alarm Priorities.....................................................................................22-2
Alarm Blocking Rules............................................................................................22-3
GFK-1180J Contents Contents-xiii
Alarm Blocking Configuration............................................................................................. 22-4
Creating A New Alarm Blocking Group................................................................ 22-4
Modifying an Existing Alarm Blocking Dialog Box.............................................. 22-5
Configuring an Alarm Blocking Group.................................................................. 22-6
Adding an Alarm.................................................................................................... 22-7
Removing an Alarm............................................................................................... 22-7
Modifying an Alarm............................................................................................... 22-8
Alarm Printer Configuration 23-1
About Alarm Printer Configuration...................................................................................... 23-1
Alarm Printer Configuration................................................................................................. 23-2
Adding an Alarm Printer........................................................................................ 23-3
Modifying an Existing Alarm Printer..................................................................... 23-4
Alarm Printer Properties....................................................................................................... 23-5
Configuring General Alarm Printer Properties....................................................... 23-5
Configuring Alarm Printer Layout Properties........................................................ 23-7
Configuring Alarm Printer Date/Time Format....................................................... 23-8
More about Redundant Alarm Printers............................................................................... 23-10
Additional Steps for Serial Printers.................................................................................... 23-11
Additional Steps for Network Printers............................................................................... 23-12
Modifying the Size of the Alarm Queue............................................................................. 23-13
Choosing Delete and Acknowledge Times......................................................................... 23-13
Configuring Roles 24-1
About Roles.......................................................................................................................... 24-1
Role Configuration............................................................................................................... 24-1
Beginning Role Configuration............................................................................... 24-2
Assigning Role Application Privileges.................................................................. 24-4
Assigning Role Calendar Privileges....................................................................... 24-5
Assigning Role Configuration Privileges............................................................... 24-6
User Configuration 25-1
About Users.......................................................................................................................... 25-1
User Configuration............................................................................................................... 25-2
Beginning User Configuration............................................................................... 25-2
Configuring User General Properties..................................................................... 25-5
Configuring User Resource Properties................................................................... 25-7
Runtime User Properties...................................................................................................... 25-8
Configuring Runtime User Properties.................................................................... 25-8
Configuring the Database Logger 26-1
About the Database Logger.................................................................................................. 26-1
Database Logger Configuration Overview........................................................................... 26-2
Understanding Hardware and Database Logger Performance................................ 26-3
Opening the Database Logger Window................................................................. 26-4
Understanding the Database Logger Configuration Hierarchy.............................. 26-5
Database Logger File Management Functions................................................................... 26-11
Creating a New CIMPLICITY Logging Table.................................................... 26-11
Opening an Existing Logging Table.................................................................... 26-13
Copying an Existing CIMPLICITY Logging Table to a New Logging Table..... 26-14
Renaming a CIMPLICITY Logging Table.......................................................... 26-15
Deleting a CIMPLICITY Logging Table............................................................. 26-16
Contents-xiv CIMPLICITY User's ManualDecember 2000 GFK-1180J
Filtering CIMPLICITY Table Lists.....................................................................26-17
Activating Dynamic Configuration......................................................................26-18
Reconciling a CIMPLICITY table with a Logging Database...............................26-19
Closing a CIMPLICITY Logging Table..............................................................26-21
Exiting the Database Logger Configuration Window..........................................26-22
Database Logger Default Logging Properties....................................................................26-23
Opening the Logging Properties Dialog Box.......................................................26-23
Entering Database Logger Default Parameters....................................................26-24
Entering Database Logger Defaults for Alarm, Event and Application Logs......26-27
Entering Database Logger Defaults for Point and Group Point Logs..................26-30
Point Data Logging............................................................................................................26-31
Step 1. Choose a CIMPLICITY Data Table........................................................26-32
Step 2. Add Points to a CIMPLICITY Data Log Table.......................................26-34
Step 3. Configure CIMPLICITY Point Data Logging Properties........................26-36
Step 4. Configure Logging Conditions for a Single Point....................................26-51
Group Point Logging..........................................................................................................26-56
Step 1. Choose a Group Log Table......................................................................26-57
Step 2. Add Points to a CIMPLICITY Group Table............................................26-59
Step 3. Configure Group Logging Properties.......................................................26-61
Step 4. Configure Logging Attributes for a Single Point .....................................26-68
Alarm Logging...................................................................................................................26-69
Step 1. Review System Alarms in the ALARM_LOG.........................................26-70
Step 2. Add Point Alarms and Alarms to the ALARM_LOG Table....................26-71
Step 3. Configure Alarm Logging Properties.......................................................26-74
Step 4. Configure Logging Conditions for a Single Alarm..................................26-81
Event Alarm Logging.........................................................................................................26-83
Step 1. Review System Alarms in the EVENT_LOG..........................................26-84
Step 2. Add Point Alarms and Alarms to the EVENT_LOG...............................26-86
Step 3. Configure Event Alarm Logging Properties.............................................26-89
Step 4. Configure Logging Conditions for a Single Event Alarm........................26-94
Event Management Logging...............................................................................................26-96
Step 1. Add Event Actions to the EM_LOG........................................................26-96
Step 2. Configure EM_LOG Properties...............................................................26-97
Application Logging.........................................................................................................26-103
CIMPLICITY Log Reports..............................................................................................26-104
UsIng Excel Reports..........................................................................................26-104
Installing MS Query to Use with Database Logging..........................................26-105
Reporting Individual Point Logged Data...........................................................26-109
Reporting Group Logged Data in a Trend Report..............................................26-112
Reporting Alarm or Event Alarms Logged Data................................................26-116
Automatic Report Printing Configuration........................................................................26-119
Step 1. Configure the CIMPLICITY Service to Access a Printer......................26-119
Step 2. Create a Script........................................................................................26-121
Step 3. Create an Event to Trigger an Automatic Report...................................26-123
Managing Database Logging 27-1
About Database Logging Management................................................................................27-1
ODBC Configuration............................................................................................................27-2
Using ODBC Drivers and Data Sources for Database Logging Overview............27-2
Configuring SQL Server Data Sources..................................................................27-4
Using CIMPLICITY SQL......................................................................................27-6
Configuring Microsoft Access Data Sources.........................................................27-7
Configuring Oracle.................................................................................................27-8
GFK-1180J Contents Contents-xv
Database Management for SQL Server.............................................................................. 27-10
Configuring Additional Locks............................................................................. 27-10
Checking if Microsoft SQL Server Service is Running....................................... 27-11
Handling Default Database Server Limitations.................................................... 27-11
Handling the Transaction Log.............................................................................. 27-12
About Creating Tables....................................................................................................... 27-14
Table Characteristics.......................................................................................................... 27-14
Column Definitions.............................................................................................. 27-14
Key Definitions.................................................................................................... 27-15
Database-Disconnect-Recovery.......................................................................................... 27-16
Using Reconnect Wait Period.............................................................................. 27-16
Using Store and Forward..................................................................................... 27-16
Client Configuration 28-1
About Client Configuration.................................................................................................. 28-1
Creating a New Client............................................................................................ 28-1
Configuring Client Properties................................................................................ 28-3
Using CIMPLICITY HMI with CIMPLICITY Control 29-1
About CIMPLICITY HMI and CIMPLICITY Control........................................................ 29-1
Supported Device Protocols................................................................................................. 29-2
Device Properties................................................................................................... 29-2
Associating Folders with Devices.......................................................................... 29-5
Import Process...................................................................................................................... 29-7
Import Rules......................................................................................................................... 29-7
Resolving Point Conflicts..................................................................................................... 29-9
New Point Conflicts............................................................................................. 29-10
Incorrect Information Conflict............................................................................. 29-11
Remote Configuration........................................................................................................ 29-12
Remote Association Configuration Example....................................................... 29-12
Import/Export Configuration 30-1
About Import/Export Configuration..................................................................................... 30-1
Import/Export Data File Format........................................................................................... 30-2
Editing CSV Files in Notepad................................................................................ 30-3
Editing CSV Files in Excel .................................................................................... 30-3
Import/Export Configuration Files....................................................................................... 30-4
Import Field Defaults (ie_deflds.cfg)..................................................................... 30-4
Export Field Formats (ie_formats.cfg)................................................................... 30-6
Import/Export Log File........................................................................................................ 30-8
Configuration Data Imported............................................................................................... 30-9
Configuration Data Exported............................................................................................. 30-12
Exporting Configuration Data.............................................................................. 30-12
Configuration Data Deleted................................................................................................ 30-15
Import/Export Field Names................................................................................................ 30-16
Including Required Fields.................................................................................... 30-16
Using Optional Fields.......................................................................................... 30-16
Logicmaster 90 Support..................................................................................................... 30-37
Contents-xvi CIMPLICITY User's ManualDecember 2000 GFK-1180J
Using the Alarm Viewer OCX 31-1
About the Alarm Viewer OCX.............................................................................................31-1
Configuration Overview.........................................................................................31-1
Run-Time Overview...............................................................................................31-2
Configuring an Alarm Viewer OCX in CimEdit..................................................................31-3
Configuring Alarm Viewer Control Properties.....................................................................31-4
Fields......................................................................................................................31-5
Buttons...................................................................................................................31-7
Projects................................................................................................................31-10
Sort/Display.........................................................................................................31-11
Count Layout........................................................................................................31-15
Date Format .........................................................................................................31-16
Fonts.....................................................................................................................31-18
Colors...................................................................................................................31-19
Creating Custom Buttons....................................................................................................31-20
Example...............................................................................................................31-21
Viewing the Alarm List......................................................................................................31-22
Selecting Alarms from the List.............................................................................31-22
Using the Alarm List Buttons.............................................................................................31-23
Changing the Setup Parameters............................................................................31-23
Refreshing the Alarm List....................................................................................31-23
Toggling Between Lists.......................................................................................31-23
Displaying User Help...........................................................................................31-23
Viewing the Alarm Stack.....................................................................................31-24
Viewing Alarm Comments...................................................................................31-24
Viewing the Alarm's CimView Screen.................................................................31-25
Acknowledging an Alarm.....................................................................................31-25
Resetting an Alarm...............................................................................................31-26
Deleting an Alarm................................................................................................31-26
Acknowledging and Resetting an Alarm..............................................................31-26
Acknowledging the First Alarm...........................................................................31-27
Acknowledging All Alarms..................................................................................31-27
Filtering Alarms..................................................................................................................31-28
Specifying a Default Setup for a Project..............................................................31-29
Loading an Alarm Setup......................................................................................31-29
Modifying the Current Alarm Setup.....................................................................31-30
Saving the Current Setup......................................................................................31-33
Creating A New Alarm Setup...............................................................................31-33
Deleting an Alarm Setup......................................................................................31-34
Declaring a Default Alarm Setup.........................................................................31-34
Using Default Alarm Setups...............................................................................................31-35
Alarm Viewer Methods 32-1
About Alarm Viewer Methods.............................................................................................32-1
Naming an Alarm Viewer Control .........................................................................32-1
Creating an Invoke Method Action........................................................................32-2
Alarm Viewer Methods........................................................................................................32-2
Using the Stand-alone Alarm Viewer 33-1
About the Stand-alone Alarm Viewer...................................................................................33-1
Alarm Viewer Opened..........................................................................................................33-2
GFK-1180J Contents Contents-xvii
Opening Alarm Viewer on a Configuration Server or Viewer............................... 33-2
Opening Alarm Viewer on a Runtime Server or Viewer........................................ 33-3
Alarm Viewer Login............................................................................................................. 33-4
Alarm Viewer Files.............................................................................................................. 33-6
Displaying a New Alarm Viewer File.................................................................... 33-6
Saving an Alarm Viewer File................................................................................. 33-6
Opening an Alarm Viewer File.............................................................................. 33-7
Specifying how an Alarm Viewer File will connect to a Project.......................... 33-10
Installing a Shortcut of an Alarm Viewer File..................................................... 33-12
Setting the Alarm Message Date/Time Format in Alarm Viewer......................... 33-13
Specifying the Placement of an Alarm Viewer Window...................................... 33-14
Copying an Alarm to Another Document............................................................. 33-15
Printing an Alarm Viewer Document................................................................... 33-16
Exiting the Alarm Viewer.................................................................................... 33-19
Alarm Count Layout........................................................................................................... 33-20
Configuring the Alarm Count Layout .................................................................. 33-20
Configuring the Alarm Count Color..................................................................... 33-21
Configuring the Alarm Count Fonts..................................................................... 33-23
Alarm List Layout.............................................................................................................. 33-25
Selecting Alarm List Fields.................................................................................. 33-25
Selecting the Alarm List Font and Background Color......................................... 33-28
Alarm Viewer Button Configuration.................................................................................. 33-32
Selecting the Button Display for Alarm Viewer................................................... 33-32
Creating Custom Buttons..................................................................................... 33-36
Alarm Viewer Button Functions......................................................................................... 33-39
Using Customized Help: Help Button.................................................................. 33-39
Configuring Filter Setups: Setup Button.............................................................. 33-40
Refreshing the Alarm Viewer List: Refresh Button............................................. 33-46
Toggling Between Alarm Viewer Static and Dynamic View: Toggle Button...... 33-46
Viewing the Alarm Stack: View Stack Button..................................................... 33-46
Viewing Alarm Comments: Comments Button.................................................... 33-47
Viewing an Alarm's CimView Screen: CimView Screen Button......................... 33-50
Acknowledging and Resetting Alarms: Ack and/or Reset Buttons...................... 33-52
Deleting an Alarm: Delete Button........................................................................ 33-56
Using CimView 34-1
About CimView................................................................................................................... 34-1
CimView Opened................................................................................................................. 34-2
Opening CimView on a Configuration Server or Viewer ...................................... 34-2
Opening Alarm Viewer on a Runtime Server or Viewer........................................ 34-3
Typical Windows Application Tasks Available in CimView............................................... 34-4
Opening Other CimView Screens.......................................................................... 34-4
Flushing Cached Screens....................................................................................... 34-5
Distributing Copies of CimView Screens and Files............................................... 34-5
Displaying the Toolbar, Menu and/or Status Bar................................................... 34-7
Going Back to Other CimView Screens................................................................. 34-8
Zooming the CimView Size................................................................................... 34-9
CIMPLICITY Runtime Features........................................................................................ 34-11
Opening the Point Control Panel through CimView............................................ 34-11
Opening Quick Trends through CimView............................................................ 34-12
Setpoint Actions................................................................................................................. 34-13
Executing Slider Setpoints................................................................................... 34-13
Entering a Value for a Setpoint............................................................................ 34-15
Help for a Selected Object................................................................................................. 34-16
Contents-xviii CIMPLICITY User's ManualDecember 2000 GFK-1180J
CimView Configuration Issues...........................................................................................34-16
Using the Point Control Panel 35-1
About the Point Control Panel..............................................................................................35-1
Procedure to Open the Point Control Panel..........................................................................35-1
Point Control Panel Files......................................................................................................35-4
Displaying a New Point Control Panel File............................................................35-4
Opening an Existing Point Control Panel File........................................................35-5
Saving a Point Control Panel File..........................................................................35-7
Installing a Shortcut of a Point Control Panel File.................................................35-8
Printing a Point Control Panel Document..............................................................35-9
Exiting the Point Control Panel............................................................................35-11
Procedures for any Point in the Point Control Panel ..........................................................35-12
Adding Points to the Point Control Panel ............................................................35-12
Changing Font Colors in the Point Control Panel ................................................35-17
Deleting a Point from the Point Control Panel .....................................................35-18
Manual Points in the Point Control Panel...........................................................................35-19
Adding Manual Points to the Point Control Panel ...............................................35-19
Enabling and Disabling Manual Mode Points......................................................35-20
Basic Point Properties in the Point Control Panel ..............................................................35-22
Using the Detail Tab in the (PCP) Point Properties Dialog Box..........................35-22
Opening a Point's Detailed Point Properties Dialog Box.....................................35-23
Alarms in the Point Control Panel ......................................................................................35-25
Adding Points with Disabled or Modified Alarms to the Point Control Panel.....35-25
Changing and Restoring Alarm Limits through the Point Control Panel..............35-26
Disabling an Alarm through the Point Control Panel ...........................................35-28
Enabling an Alarm through the Point Control Panel ............................................35-29
Arrays in the Point Control Panel.......................................................................................35-30
Using the CIMPLICITY To Windows Server (DDE) 36-1
About The CIMPLICITY To Windows Server....................................................................36-1
Command Syntax for CWSERV ..........................................................................................36-1
Microsoft Excel Example.......................................................................................36-2
Point Topic Attributes..........................................................................................................36-3
Using CWSERV with Microsoft Excel ................................................................................36-6
Displaying Point Data............................................................................................36-6
Starting CWSERV .................................................................................................36-7
Modifying Point Data.............................................................................................36-8
Sample Spreadsheets and Macros........................................................................36-10
Command Syntax for System Topic...................................................................................36-12
Formats................................................................................................................36-12
System Items........................................................................................................36-12
Topics..................................................................................................................36-12
Help......................................................................................................................36-13
Error Messages...................................................................................................................36-14
Remote Access of CWSERV on Windows NT..................................................................36-14
Creating a DDE Share..........................................................................................36-14
Referencing CWSERV from a Networked NT Client..........................................36-15
GFK-1180J Contents Contents-xix
System Utilities 37-1
About System Utilities......................................................................................................... 37-1
Using Show Users................................................................................................................ 37-2
Starting Show Users............................................................................................... 37-2
Show Users Menu Options..................................................................................... 37-3
Show Users Toolbar Buttons................................................................................. 37-5
Show Users Shortcut Keys..................................................................................... 37-5
Changing View Options......................................................................................... 37-6
Opening A Project in Show Users.......................................................................... 37-6
Searching for User Information.............................................................................. 37-8
Closing A Project View in Show Users................................................................. 37-8
Using the Login Panel .......................................................................................................... 37-9
Starting the Login Panel......................................................................................... 37-9
Login Panel Menu Options.................................................................................. 37-10
Login Panel Toolbar Buttons............................................................................... 37-11
Login Panel Shortcut Keys................................................................................... 37-11
Logging out of a Project ...................................................................................... 37-11
Logging in to a Project......................................................................................... 37-12
Changing Password.............................................................................................. 37-13
Managing Saved Logins....................................................................................... 37-14
Using Program Control ...................................................................................................... 37-16
Starting Program Control ..................................................................................... 37-16
Using CIMPLICITY Program Control ................................................................ 37-17
Orderly Startup and Shutdown............................................................................. 37-18
CIMPLICITY HMI Processes............................................................................. 37-19
Starting A Halted Process.................................................................................... 37-19
Stopping A Running Process............................................................................... 37-20
Starting All Halted Processes............................................................................... 37-20
Stopping All Running Processes.......................................................................... 37-21
Refreshing the Process List.................................................................................. 37-21
Releasing the Connection..................................................................................... 37-21
Exiting Program Control ...................................................................................... 37-21
Using Measurement Units 38-1
About Measurement Units.................................................................................................... 38-1
Configuring Measurement Systems and Units...................................................................... 38-2
Starting Measurement Units................................................................................... 38-3
Adding a New Measurement System..................................................................... 38-4
Copying a Measurement System............................................................................ 38-5
Renaming a Measurement System......................................................................... 38-5
Creating a Base Measurement Unit........................................................................ 38-6
Editing Base Measurement Unit Properties........................................................... 38-7
Defining an Equivalent Unit.................................................................................. 38-7
Copying a Measurement Unit .............................................................................. 38-10
Renaming a Measurement Unit............................................................................ 38-10
Deleting a Measurement Unit.............................................................................. 38-11
Specifying the Active Measurement System...................................................................... 38-12
Specifying the Active Measurement System From the Measurement Units
Configuration Window......................................................................................... 38-12
Specifying the Active Measurement System From the Project
Properties Dialog box.......................................................................................... 38-13
Contents-xx CIMPLICITY User's ManualDecember 2000 GFK-1180J
Some Guidelines for Measurement Units...........................................................................38-14
Floating Point Numbers vs. Integers....................................................................38-14
Derived Points......................................................................................................38-16
CimEdit Management of Animated Objects.........................................................38-17
CimView Scripts..................................................................................................38-18
Event Manager and Basic Control Engine...........................................................38-19
Using Global Parameters 39-1
About Global Parameters.....................................................................................................39-1
Finding the Global Parameters Application...........................................................39-2
Global Parameter Configuration...........................................................................................39-3
Editing a Global Parameter Value..........................................................................39-4
Adding a Global Parameter to the Workbench List...............................................39-6
Deleting a Global Parameter from the List.............................................................39-8
Global Parameters.............................................................................................................. 39-10
Device Communications Parameters..................................................................................39-53
Global Parameter Files.......................................................................................................39-55
Locating a Global Parameter File.........................................................................39-55
Reviewing a Sample GLB_PARMS.IDT File......................................................39-57
System Management 40-1
About System Management..................................................................................................40-1
Logical Names......................................................................................................................40-2
Modifying Base System Logical Names................................................................40-2
Modifying Device Communications Logical Names..............................................40-4
Editing the Log_names.cfg File.............................................................................40-5
Login Information Deleted...................................................................................................40-6
Registry Information Removed............................................................................................40-7
Removing Windows 95 Registry Information........................................................40-7
Removing Windows NT Registry Information......................................................40-8
Site Wide Installation...........................................................................................................40-9
About Microsoft System Management Server (SMS) ........................................................40-10
How Client Package Distribution Works.............................................................40-12
CIMPLICITY HMI Site Wide Installation Procedure........................................................40-14
Creating the Application Source Directory..........................................................40-14
Creating SMS Package for CIMPLICITY HMI installation................................40-16
Creating J ob for CIMPLICITY HMI Installation................................................40-17
CIMPLICITY Security Features........................................................................................40-19
Choosing to Use Login Passwords.......................................................................40-19
Reviewing Role Privilege Options.......................................................................40-19
Dealing with Setpoint Security.............................................................................40-20
Dealing with Setpoint Password...........................................................................40-20
Reviewing Security Audit Trail Options..............................................................40-21
OEM Key...........................................................................................................................40-23
Activating the OEM Key......................................................................................40-23
Terminating the OEM Key...................................................................................40-25
Remote Projects..................................................................................................................40-26
Viewing Existing Remote Projects.......................................................................40-26
Creating A New Remote Project..........................................................................40-27
Configuring Point Bridge Points........................................................................................40-30
Configuring Point Bridge Point Details...............................................................40-31
GFK-1180J Contents Contents-xxi
Using CIMPLICITY HMI with Remote Access 41-1
About Remote Access.......................................................................................................... 41-1
About the Examples in this Document................................................................... 41-2
Before You Start.................................................................................................................. 41-3
Server Setup (Windows NT)................................................................................................ 41-4
Installing the Remote Access Service.................................................................... 41-4
Further Configuration for the Server...................................................................... 41-7
Client Setup (Windows NT)................................................................................................. 41-9
Installing the Remote Access Service.................................................................... 41-9
Further Configuration for the Viewer .................................................................. 41-10
Client Setup (Windows 98)................................................................................................ 41-11
Configuring the CIMHOSTS.TXT File............................................................................. 41-13
Testing the Connection....................................................................................................... 41-13
Ping...................................................................................................................... 41-13
Configuring CIMPLICITY Options on the Server............................................................. 41-14
Networking Considerations................................................................................................ 41-14
RAS Client has a network card configured.......................................................... 41-14
Limitations on RAS Support.............................................................................................. 41-15
CIMPLICITY HMI WebGateway 42-1
About the CIMPLICITY HMI WebGateway....................................................................... 42-1
Installing the CIMPLICITY HMI WebGateway.................................................................. 42-2
Web Server Requirements..................................................................................... 42-2
Installation Procedure............................................................................................ 42-2
More about CIMPLICITY HMI WebGateway Components................................. 42-3
Project Setup........................................................................................................................ 42-4
Testing the Connections....................................................................................................... 42-5
Validating Project Connections............................................................................. 42-5
Validating Web Connections................................................................................. 42-5
Troubleshooting and Error Messages................................................................................... 42-7
Troubleshooting Custom HTML Pages................................................................. 42-7
Error Messages...................................................................................................... 42-7
CIMPLICITY HMI Web Data Applet................................................................................. 42-9
setCaption (Method) .............................................................................................. 42-9
getCaption (Method).............................................................................................. 42-9
appendCaption (Method)....................................................................................... 42-9
pointGet (Method) ............................................................................................... 42-10
pointSet (Method)................................................................................................ 42-11
clearPoints (Method)............................................................................................ 42-11
setPointID (Method) ............................................................................................ 42-11
getPointValue (Method)....................................................................................... 42-12
getPointStatus (Method) ...................................................................................... 42-12
Appendix A - Registering and Licensing CIMPLICITY Software A-1
About CIMPLICITY Registration......................................................................................... A-1
CIMPLICITY First Time Registration.................................................................................. A-2
Step 1. Prepare for CIMPLICITY Registration...................................................... A-2
Step 2. Complete First Time Registration............................................................... A-7
CIMPLICITY New Option Registration............................................................................... A-9
Contents-xxii CIMPLICITY User's ManualDecember 2000 GFK-1180J
CIMPLICITY Upgrade Registration................................................................................... A-11
Registering a CIMPLICITY Functional Upgrade................................................. A-11
Registering a CIMPLICITY Version Upgrade...................................................... A-13
CIMPLICITY License Transfer via the Network................................................................ A-18
CIMPLICITY License Transfer by Floppy Diskette........................................................... A-21
Step 1. Begin License Transfer on the Target Computer...................................... A-21
Step 2. Continue License Transfer from the Source Computer............................. A-25
Step 3. Complete License Transfer on the Target Computer ................................ A-29
CIMPLICITY with No License........................................................................................... A-32
CIMPLICITY Registration Removal .................................................................................. A-32
Appendix B Removing CIMPLICITY Software B-1
About CIMPLICITY Software Removal............................................................................... B-1
Removing CIMPLICITY from Windows 98........................................................... B-1
Removing CIMPLICITY from Windows NT and Windows 2000......................... B-1
Appendix C - Resolving Problems C-1
About CIMPLICITY HMI Log Files.....................................................................................C-1
System Log Files......................................................................................................C-1
Project Log Files......................................................................................................C-1
Viewing Log Files....................................................................................................C-1
Using the Status Log Viewer..................................................................................................C-2
Which Status Log File Gets Displayed....................................................................C-3
Status Log Viewer Menu Options............................................................................C-4
Status Log Viewer Toolbar Buttons.........................................................................C-5
Status Log Viewer Shortcut Keys............................................................................C-5
Selecting a Status Log to View...............................................................................................C-6
Displaying Status Log Message Details.................................................................................C-7
Saving the Status Log as a Text File......................................................................................C-8
Printing the Status Log File....................................................................................................C-9
Selecting a Status Log Printer ..............................................................................................C-10
Filtering the Status Log Messages........................................................................................C-11
Finding Status Log Messages...............................................................................................C-12
Finding the Next Status Log Message....................................................................C-13
Process Names in Status Log.................................................................................C-13
Checking System Output and Error Files.............................................................................C-14
Checking Process Output and Error Files.............................................................................C-15
Backup Process Log Files......................................................................................C-15
Index i
GFK-1180J 1-1
Welcome to CIMPLICITY
Welcome
Congratulations for selecting GE Fanuc Automation's 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:
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-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J 2-1
Using the Workbench
About the CIMPLICITY Workbench
Your CIMPLICITY HMI Workbench, which is at the center of your CIMPLICITY
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
2000 and NT interface is the capability for you to:
Work with multiple CIMPLICITY Workbench windows. See page 2-5.
Set the Workbench display to meet your needs. See page 2-7.
Easily deal with one or more projects. See page 2-16.
Configure any record or file in your project by quickly opening the appropriate
dialog box or window. See page 2-27.
Access all runtime information directly through the Workbench. See page 2-31.
Opening the Workbench
You open the Workbench the same way you open any Windows 2000 and NT
application.
To open the CIMPLICITY Workbench:
1. Click Start on the Windows NT or Windows 2000 Task bar.
2. Select Programs.
3. Select CIMPLICITY.
4. Select the project (e.g. Demo project) you want to open.
Result: The CIMPLICITY Workbench opens displaying the selected project.
2-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
CIMPLICITY HMI Workbench
First Opened Expanded to
view all points
Note: You can open a blank Workbench by selecting Workbench on the
CIMPLICITY\HMI start menu.
GFK-1180J Using the Workbench 2-3
Workbench at a Glance
Within the Windows, 2000 and NT familiar environment, the CIMPLICITY Workbench
provides you with all the unique CIMPLICITY Power Tools you need to create and
manage your project with maximum efficiency.
Also, you will recognize some of the Workbenchs tools from your Windows 2000 and
NT toolbars and file menus.
Quick Overview of the CIMPLICITY Workbench Features
Application
Folder
Expand
the tree
Collapse
the tree
Objects in
application
Files or records
associated with object
Points
Screens
Right pane
views
Left to right:
Configuration update
Status log
Project properties
Project wizard
Left to right:
Book Reader
Workbench Help
Properties
Field
chooser
Left to right:
Dynamic
update
Stop project
Start project
Fields chosen for display
Search
Status bar
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:
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.
Tip: Place the cursor over any object in the Workbench to display a brief description of
what it does.
2-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
You can also use various combinations of keystrokes in the Workbench to perform
commonly used functions:
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.
GFK-1180J Using the Workbench 2-5
Multiple Workbench Windows
The Workbench enables you to:
Open several Workbench windows at the same time.
You can open as many Workbench windows on one computer as its resources
allow. You can also open them on connected servers or development viewers.
The same or different CIMPLICITY projects can display in the open Workbench
windows.
Easily refresh the view in the Workbench in which you are working.
CIMPLICITY makes changes that are made to a project in any Workbench
window in every open version of that project. Refreshing your view insures that
what you are looking at is the current configuration.
Opening Additional Workbench Windows on the Same
Computer
You can open additional Workbench windows on the same computer. The multiple
Workbench windows can contain the same or different CIMPLICITY projects.
To open more than one Workbench window:
1. Click File on the Workbench menu bar.
2. Select New>Window.
File Menu
Result: A new Workbench opens with the same project that displayed in the first
Workbench. You can easily open another project.
See page 2-Error! Bookmark not defined. for the procedures to open a CIMPLICITY
project.
2-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Refreshing a Project Display in an open Workbench
When more than one Workbench window displays the same project, on the same or
different computers, you can keep your Workbench window current by refreshing it.
To refresh a project display in a an open Workbench:
Method 1
Press F5.
Method 2
1. Click View on the Workbench menu bar.
2. Select Refresh.
Result: The Workbench window displays the most current version of the displayed
CIMPLICITY project.
GFK-1180J Using the Workbench 2-7
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 2000 and NT Explorer.
To expand / collapse folders in the left pane:
Workbench Left Pane
Click to expand
the tree.
Click to collapse
the tree.
1. Click the + to expand the tree.
2. Click the to collapse it.
2-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Changing the Right Pane View
Right pane view options emulate the Windows 2000 and NT Explorer options, including:
Detailed lists with field information.
Lists of records or files.
Large icons.
Tree view.
To change the right pane view:
Method 1
1. Click Edit on the Workbench menu bar.
2. Select the View from the following options:
List
Details
Large Icons
Tree
Method 2
Click the standard Windows 2000 and NT button on the Workbench toolbar.
From left to right: List, Detail, Large Icons and Tree
view.
Result: The right pane view changes to reflect your choice.
Different Views in Right Pane
Large icon List
Tree
Detail
GFK-1180J Using the Workbench 2-9
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.
To view all the records (or files) for a selected icon:
1. Select an icon in the left pane.
2. Tell CIMPLICITY to automatically display all the records by either of the
following methods:
Method 1
A. Click View on the Workbench menu bar.
B. Select Autofill if there is no check mark on its left side.
2-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Result: CIMPLICITY 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 select 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 select a list of
records in the right. If you select Screens in the left, you will select 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. Click View on the Workbench menu bar.
B. Select Search.
GFK-1180J Using the Workbench 2-11
Method 2
A. Place the cursor in the right pane.
B. Click the right mouse button.
C. Select Search on the popup menu.
Method 3
Click the Search button on the Workbench toolbar.
The Search dialog box associated with the selected icon appears.
Search Dialog Box Example
This dialog box is for points.
Enter one or more
search criteria.
Open a Browser
window.
3. 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.
Result: The records or files you specify will display in the right pane until you
change your specifications.
2-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Tools for Finding the Names of Records or Files to List
CIMPLICITY 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.
CIMPLICITY Browsers
Throughout CIMPLICITY HMI you will find different buttons to open browsers that help
you find names or categories of records associated with a selected icon. They all appear in
the Workbench and are pointed out in the documentation when you need them.
Example
Button Opens a Browser for:
Points
Ports
Devices
Roles
Misc.
GFK-1180J Using the Workbench 2-13
To open a browser and find a selected object and/or category:
Click a Browse button when it appears at the right of a field. The appropriate
browser will open.
Workbench Explore Tool
To find a file by using the Workbenchs Explore tool:
1. Close the Search dialog box, if it is open.
2. Click Project on the Workbench menu bar.
3. Select Explore.
Project Drop Down Menu
A Windows 2000 and NT Explorer window opens and displays the open
projects directory.
4. Use the Windows 2000 and NT 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 2000 and NT Explorer window next to the Workbench.
6. Open the Search dialog box.
7. Type the name of the file in the Filename field.
Result: The appropriate entry appears in the Workbench right pane.
2-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. Select Fields for the Workbench Right Pane
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 View on the Workbench menu bar.
C. Select Field Chooser.
View Menu
Method 2
A. Click the right mouse button in the right pane.
C. Select Field Chooser from the popup menu.
Popup for Points
GFK-1180J Using the Workbench 2-15
Method 3
Click 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 Fields for the Workbench Right Pane
1. Select a field in the Available field column that you want to add to your display.
2. Click Add. The field will move over to the Display fields column.
3. Select any filed in the Display fields column that you do not want to display.
4. Click Remove. The field will move over to the Available field column.
5. Use the Move Up and Move Down buttons to change a selected field's 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.
6. Click OK. The fields display from left to right in the order you specified.
Example: A Points Field Chooser Dialog Box
Moves field further
right in the pane
Fields that will not display Fields that will display
Moves field further
left in the pane
Note: The Remove button is disabled if the field is required. The Move Down or
Move Up button is disabled if a field that will be affected by the move has to appear in
the furthest left position.
2-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Workbench Procedures for CIMPLICITY Projects
The Workbench provides you with a powerful tool for handling projects.
Through the Workbench you can:
Create a new project. See the "Setting up a CIMPLICITY Project" chapter in
this manual.
Open a project. . See the "Setting up a CIMPLICITY Project" chapter in this
manual.
Start a project running.
Switch to another open project.
Stop a project.
Drag and drop items from one project to another.
Update a project (either when it is not running or dynamically).
Starting a CIMPLICITY Project
To start an open CIMPLICITY project in the Workbench:
Method 1
Click the Run button on the Workbench toolbar.
Method 2
1. Click 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. Click OK.
Result: The project starts running when you use any of these methods.
GFK-1180J Using the Workbench 2-17
Switching from One Project to another using the same
Workbench
To switch to another running project in the Workbench:
1. Click File on the Workbench menu bar.
2. Select Running Projects List.
3. Select the project you want from the extended menu.
Note: Only projects that are running appear on this list. If no project is running, the
running Projects List option does not appear on the File menu.
Select a project
File Drop Down Menu
2-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Copying an Existing Project to Create a New Project
When you want to create a new project that will be similar to a project that is already
configured, you can simply copy the existing project to the new project.
To copy an existing project to create a new project:
1. Open the existing project.
2. Stop the project if it is running.
3. Click File on the Workbench menu bar.
4. Select Copy to Project.
A Copy Project to New Project dialog box opens.
5. Enter name in the Project Name field.
The name is automatically written in the New Subdirectory field.
6. Enter a name in the New Subdirectory field if you want it to be different from
the name that was automatically entered.
7. Select the new project's location in the Directory scroll field.
The new project's path displays in the Project path box.
Enter a unique
name
Browse to select the
project's path
Open Map Network
Drive dialog box.
Copy Project to New Project Dialog Box
Click to create
the project. New project path.
7. Click Create.
Result: The Workbench copies the existing project's entire configuration to the
new project. You can now open the new project and work with it.
GFK-1180J Using the Workbench 2-19
Renaming a CIMPLICITY HMI Project
If you need to rename a CIMPLICITY project, you can do it through the CIMPLICITY
Workbench.
To rename a CIMPLICITY HMI project:
1. Open the Project Properties dialog box as follows.
Method 1
A. Click Project on the Workbench menu bar.
B. Select Properties.
Method 2
Press Alt+P+P on the keyboard.
2. Select the General tab.
3. Enter the new project name in the Project Name field.
4. Click OK.
Result: The project's name is changed. The new name appears on the Workbench
title bar.
Rename Project: Example
3 Click OK.
Project name on
Workbench title bar.
New project name on Workbench title bar.
1 Display the General tab
in the Project Properties
dialog box.
2 Enter a new Project
Name.
2-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Inserting a Project Shortcut in the Windows Start Menu
The CIMPLICITY HMI Workbench provides you with an easy way to place your project
in the CIMPLICITY HMI Start menu. Once you do, a user can use the Start menu to open
the project's Workbench.
To create a CIMPLICITY HMI project shortcut:
1. Click File on the Workbench menu bar.
2. Select Install.
The Create Shortcut dialog box opens.
3. Select the folder (or create a new folder) in which you want the CIMPLICITY
HMI project to appear.
4. Click OK.
Result: The project will appear on the Start menu in the folder you selected.
GFK-1180J Using the Workbench 2-21
Stopping a CIMPLICITY Project
To stop a project:
Method 1
Click the Stop button on the Workbench toolbar.
Method 2
1. Click Project on the Workbench menu bar.
2. Select Stop.
Method 3
1. Press Alt+P on the keyboard.
2. Press S.
2-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Dragging Items from One CIMPLICITY Project into Another
When you have two projects (and two Workbenches) open, you can select certain items in
one Workbench and drag them into the other.
The items you can drag from one open project to another are:
Classes.
Devices.
Objects.
Points.
Screens.
Dragging a Device from one Project to another: Example
1 Select a device in the Workbench right
pane that you want to drag. 2 Drag the device into the device
application in a second open project..
3 Respond to any messages.
4 Press F5 to refresh the
screen.
The configured device
appears in the second
project's Workbench.
Retrieved records include
associated points.
To drag selected items from one project into another:
1. Open two projects in two Workbench windows.
2. Select the item(s) you want in the first project's Workbench right pane.
Note: Press Shift to select adjacent multiple items. Press Ctrl to select any
multiple items.
GFK-1180J Using the Workbench 2-23
3. Drag the items to the correct location in the second project's Workbench.
Result: CIMPLICITY copies the configured items to the second project.
CIMPLICITY has several built-in safeguards to insure that the dragged items will operate
correctly in the second project.
Safeguards include:
If other points are associated with a dragged device, a message will ask if you
want to copy those items over also.
Example
If you accidentally drag the items to the wrong location, the items will not be
copied and you will see an error message.
Example (Message displayed when copying a screen to an incorrect location)
If you drag an item that has associated items that you have not configured in the
second project, the items will not be copied and a message will explain why.
Example
If points you are dragging already exist in the second project, a message will ask
you if you want to overwrite them.
Example
2-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Guidelines for dragging items from one project to another:
1. Before dragging devices:
A. Make sure the device communication (devcom) is available in the second
project.
B. Create a port in the second project with the same name (and devcom ) as
exist in the originating project.
2. When dragging points:
A. Create any associated items; e.g. Point Attribute sets, resources and alarms,
in the second project before dragging.
B. Drag associated devices into the second project before dragging points.
C. Make sure you drag associated points, e.g. safety points and trigger points,
along with or before the selected points.
Updating a CIMPLICITY 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, a CIMPLICITY Configuration message
will warn you that the project is out of date. When you click 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 page 2-14 for details about opening the
Field Chooser dialog box.
GFK-1180J Using the Workbench 2-25
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. Click Project on the Workbench menu bar.
Project Menu
2. Select Configuration Update.
Method 2
1. Press Alt+P on the keyboard.
2. Press C.
Result: The Workbench will do a configuration update.
Note: Configuration Update is dimmed if the project is running.
2-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
Some restrictions in dynamic configuration functionality, which you should be
aware of.
Easy procedures for dynamic configuration.
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:
The calculation type for a Virtual point.
The service for a Virtual point.
Point Class Configuration Cannot make adjustments to a point class in
dynamic mode.
Port Configuration May only modify:
Base scan rate.
Enable/Disable state of the port.
Retry count.
Remote Projects Cannot create or modify remote projects in
Dynamic Update mode.
Classes Cannot modify a class.
To do dynamic configuration:
Method 1
Click the Dynamic button on the Workbench toolbar.
Method 2
1. Click 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-1180J Using the Workbench 2-27
Record and File Configuration
The CIMPLICITY 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.
You can open the associated New configuration application for any selected icon.
For: You can open
Screens A new CimEdit screen
The following: A related New dialog box
Points
Devices
Ports
Users
Roles
Resources
Remote projects
Clients
Project status log Notepad
System status log Microsoft Excel
Scripts Blank script window
Database Logger Database Logger Configuration window
Options Option window, e.g. Action Calendar
2-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 appropriate icon in the Workbench left pane.
2. Do any of the following:
Method 1
Double click the icon.
Method 2
A. Click File on the Workbench menu bar.
B. Select New.
C. Select Object on the extended menu.
File Drop Down Menu
GFK-1180J Using the Workbench 2-29
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.
Result: 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 click 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
A. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Press Alt+E.
B. Select Properties.
Method 4
A. Click the right mouse button.
A popup menu displays with menu items that reflect the selected object.
2-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
B. Select one of the following menu items:
Choose the
menu item For To Display
Edit
Edit
Screens CimEdit screen
Properties
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-1180J Using the Workbench 2-31
Runtime Access
The Workbench provides you with access to all of CIMPLICITY HMI runtime
monitoring tools.
This includes letting you:
Open any CimView screen
Monitor a point's runtime values in several ways, including using 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
Review runtime performance by opening runtime windows, including:
Alarm ViewerAlarm Viewer window
Point Control PanelPoint Control Panel window
Login PanelLogin Panel window
Show UsersShow Users window
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.
2-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 page 2-16 for details.
2. Select Screens 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. Click the right mouse button.
B. Select Open from the popup menu.
Result: The CimView screen you selected opens when you use either method.
GFK-1180J Using the Workbench 2-33
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.
Project is running.
2. Double click it or use any of the other methods available to open a runtime
window. See page 2-32 for details about opening a CimView screen.
Result: If the project is running, the runtime window opens.
If the project is not running, a Select a CIMPLICITY Project dialog box opens.
When you select the project that should run, CIMPLICITY starts the project and
activates the runtime window.
2-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Monitoring a Selected Point's 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
Popup menu for selected point
Quick Trend
CimView
Point Control Panel
GFK-1180J Using the Workbench 2-35
To view a points runtime values through the Workbench:
1. Select Points in the Workbenchs left pane.
2. Select the point in the right pane that you want to track.
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.
5. Release the mouse button.
CIMPLICITY HMI displays runtime information for the selected points.
Note: CIMPLICITY HMI does not duplicate any of the dragged points that already exist
in the open Point Control Panel
2-36 CIMPLICITY User's ManualDecember 2000 GFK-1180J
1 Open the Point
Control Panel.
2 Select points in the
Workbench.
Drag them into the
Point Control Panel.
3 The Point Control Panel
displays any points that were
there originally and all the
nonduplicate dragged points.
Dragging Points from the Workbench into an Open Control Panel: Example
GFK-1180J 3-1
Setting up a CIMPLICITY Project
Project Opened
You can open a CIMPLICITY project through:
The CIMPLICITY\HMI Start Menu on the Windows Taskbar or
An open Workbench.
Procedure to Open a Project through the Start Menu
To open a CIMPLICITY project through the Windows Start menu:
1. Click Start on the Windows NT or Windows 2000 Task bar.
2. Select Programs.
3. Select CIMPLICITY.
4. Select the project (e.g. Demo project) you want to open.
Result: The CIMPLICITY Workbench opens displaying the selected project.
Project in CIMPLICITY Workbench
3-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Procedure to Open a Project through the Workbench
To open a project through the Workbench:
Method 1
Click the Open button on the Workbench toolbar.
Method 2
1. Click File on the Workbench menu bar.
2. Select Open.
Method 3
Press Ctrl+O on the keyboard.
Result: The Open dialog box opens for you to select the project you want to open.
Select CIMPLICITY Project to Open
GFK-1180J Setting up a CIMPLICITY Project 3-3
Project Properties
You can configure properties for a project in the Project Properties dialog box. There are
several methods to open the Project Properties dialog box.
Opening the Project Properties Dialog Box
To open the Project Properties dialog box:
Method 1
Click the Project Properties button on the Workbench toolbar.
Method 2
1. Click Project on the Workbench menu bar.
2. Select Properties.
Method 3
Press Alt+P+P on the keyboard.
Result: The Project Properties dialog box opens when you use any method.
Use the Project Properties dialog box to choose or change General properties and Options
for a project.
Note: Click OK to accept changes; click Cancel to discard changes.
3-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring Project Properties
Project properties that you can configure range from selecting what applications and
protocols to activate in the Workbench to configuring default settings for selected
applications.
Three tabs in the Project Properties dialog box provide you with the tools to configure the
project properties. The tabs are:
General
Options
Settings
Project General Properties
The General properties you can change are:
Project Name
If you want to change the project name, enter the new name in this field.
Important: The project name should be different from the node name.
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.
GFK-1180J Setting up a CIMPLICITY Project 3-5
Project Options Properties
The Options properties you can change are:
Enable project broadcast
Check Enable project broadcast if you want to broadcast the project name to all
computers 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.
Enable project multicast
Check Enable project multicast if you want traffic sent once and to be received and
processed by multiple interested IP hosts, regardless of their location on an IP Inter-
network.
A host listens for a specific IP multicast address and receives all packets sent to that IP
address.
IP multicast is more efficient than IP unicast or broadcast for one-to-many delivery of
data.
Unlike unicast, only one copy of the data is sent.
Unlike broadcast, traffic:
Is only received and processed by computers that are listening for it.
Can potentially go through routers, bridges, bridge routers across the LAN
to some other network.
CIMPLICITY viewers will listen for both the project Broadcast and Multicast.
The default Multicast address is 224.0.0.29.
Caution: When multicasting is checked to operate across a LAN, several network factors
that are outside of CIMPLICITY must be configured correctly e.g. the network router
needs to be capable of and configured to allow multicast. Therefore, it is strongly
recommended that you consult the network administrator before selecting this option.
3-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Note: If this is a redundant project then the Broadcast option will be selected and the
user will not be able to select the Multicast option.
See the "Using Global Parameters" chapter in this manual for global parameters that
can be used for multicasting.
Computer name
Select the Computer name from the drop down menu that 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 in the Startup timeout field that CIMPLICITY HMI should
wait for the project to start before it times out.
The default is 10 minutes.
Configuration Security
Check Configuration security to restrict user configuration access to any or all of
CIMPLICITY's applications.
Result: CIMPLICITY activates its configuration security feature, as follows.
A Configuration tab appears in the Roles dialog box. This tab enables a user with Roles
configuration privileges to specify what applications users assigned to each role can
configure. See "Assigning Role Configuration Privileges" in the "Role Configuration"
chapter in this manual for more information.
A Configuration Login dialog box appears when a user attempts to open the Workbench.
If the user's role was not granted Workbench privileges, the user is denied access.
GFK-1180J Setting up a CIMPLICITY Project 3-7
1 A Configuration Login dialog box appears when a user
opens the Workbench.
Configuration Security is Enabled: Example
2 An error message
appears if the user's role
does not have
Workbench privileges.
Using the Project Properties Settings Tab
The Settings tab of the Project Properties dialog box enables you to enter general settings
for each application on the displayed list of applications.
To use the Settings tab:
1. Select the application whose settings you want to modify.
2. Click Settings.
Result: A dialog box that applies to your selection opens.
Selection Opens the Dialog Box:
Alarms Alarm Properties
Database Logger Logging Properties
Event Editor (Event Editor) Setup
Measurement Units Activate Measurement System
Points Point Setup
Users User Setup
See the chapter for each of the applications for details about its dialog box.
3-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
CIMPLICITY Project Wizard
CIMPLICITY provides you with a self-explanatory Project Wizard that you can use to
create a new project or as an additional tool when you configure an existing project.
You can enable the Project Wizard through the:
New Project dialog box or
Workbench
Enabling the Project Wizard through the New Project Dialog Box
To enable the CIMPLICITY Project Wizard through the New Project dialog box:
1. Choose either:
Method 1
Click the New Project button on the Workbench toolbar..
Method 2
A. Click File on the Workbench menu bar.
B. Select New>Project.
The New Project dialog box opens when you use either method.
2. Define the following:
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 Select the options you want to be available in this project
from the list of all installed options. Check each option
you want to select.
GFK-1180J Setting up a CIMPLICITY Project 3-9
Protocols Select the protocols you want to be available in this
project from the list of all installed protocols. Check 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, click Network. to define the network path.
3. Click Create
Result: The CIMPLICITY Project Wizard opens.
Enabling the Project Wizard Though the Workbench
To enable the CIMPLICITY Project Wizard through the Workbench:
Method 1
Click the Project Wizard button on the Workbench toolbar.
Method 2
1. Click Project on the Workbench menu bar.
2. Select Project Wizard.
Project Menu
Method 3
Press Ctrl+W on the keyboard.
Result: The CIMPLICITY Project Wizard opens when you use any method.
3-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Project Shortcut in the Windows Start Menu
The CIMPLICITY Workbench provides you with an easy way to place your project in the
CIMPLICITY\HMI Start menu. Once you do, a user can use the Start menu to open the
project's Workbench.
To create a CIMPLICITY HMI project shortcut:
1. Click File on the Workbench menu bar.
2. Select Install.
The Create Shortcut dialog box opens.
3. Select the folder (or create a new folder) in which you want the CIMPLICITY
HMI project to appear.
4. Click OK.
Result: The project will appear on the Start menu in the folder you selected.
GFK-1180J Setting up a CIMPLICITY Project 3-11
CIMPLICITY Options
CIMPLICITY software supports running multiple projects on a single computer.
You can configure:
Project options.
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.
Startup options.
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).
You do this configuration in the CIMPLICITY Options dialog box.
Opening the CIMPLICITY Options Dialog Box
To open the CIMPLICITY Options dialog box:
1. Click Start on the Windows taskbar.
2. Select CIMPLICITY>HMI>CIMPLICITY Options
.
Result: The CIMPLICITY Options dialog box opens.
The CIMPLICITY Options dialog box provides you with two tabs, Projects and
Startup Options, to set project options. If your CIMPLICITY project includes
WebView or ThinView you will see other tabs for those applications.
Setting CIMPLICITY Projects Options
When you use CIMPLICITY, you can:
To view CIMPLICITY projects on other computers.
Connect to another computer in your network
Stop a running project
Add projects to the list of projects
Start projects in the Projects list.
You do this on the Projects tab in the CIMPLICITY Options dialog box.
3-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Procedure to View CIMPLICITY Projects on other Computers
To view CIMPLICITY projects on other computers:
1. Select the Projects tab in the CIMPLICITY Options dialog box.
The tab displays the local computer in the Computer name field.
2. Click Start Viewer.
The router starts and VIEWER appears in the Running projects box.
The Computer name field now has computer names to which the local
computer has Viewer access.
3. Select another computer from the new Computer name drop down menu.
Note: If you type in the computer name click Connect to connect to the
computer.
Result: Projects that are running on the selected computer appear in the Running
projects box. You can now view them through CimView.
1 Click Start
Viewer.
Computer Started as Viewer: Example
The local
computer name
displays.
The router starts.
The local
computer can
now act as a
Viewer.
2 Select a
computer from
the new list.
The local computer
can view projects
that are running on
the selected
computer.
GFK-1180J Setting up a CIMPLICITY Project 3-13
Procedure to Connect to Another Computer
Important: You can only connect to a project on a remote computer in Windows NT or
Windows 2000.
To display the projects currently running on other servers in your network:
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 to which
your computer has access and that are currently running CIMPLICITY software.
Note: If the computer name does not appear in the list, type it in the Computer
Name field and click Connect.
Result: The projects that are currently running on the selected computer display in
the Running Projects field.
Procedure to Stop a Running Project
You may stop any project that is currently running on the computer to which you are
currently connected as a server.
To stop a running project:
1. Select the project in the Running projects list.
2. Click Stop.
If you are connected as a server, a confirmation dialog box opens.
3. Click Yes to confirm that you want to proceed with the shutdown.
Result: After the project is stopped, CIMPLICITY removes the name from the
Running projects list.
Procedure to Add a Project to the Projects List
To add projects to the Projects list:
1. Click Add.
The Open dialog box opens.
2. Use the Open dialog box to search for the project (.gef) file you want.
3. Click OK.
Result: The project you select is added to the Projects list.
Procedures to Start a Project in the Projects List
To start a project in the Projects list:
1. Select the project.
2. Click Start.
3. Verify that you want to start the project.
Result: The project you select is started. When startup is complete, CIMPLICITY
adds the project name to the Running projects list.
3-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Setting Startup Options
In CIMPLICITY you can:
Set the network options for the computer.
Select boot up options.
(Windows 98) Start CimView.
GFK-1180J Setting up a CIMPLICITY Project 3-15
Network Options
To specify network options:
1. Select the Startup Options tab in the CIMPLICITY Options dialog box.
2. Do one of the following:
Check Accept connections.
The local computer can connect to all other projects in the enterprise. Other
computers can connect to running projects on the local computer.
Check Accept connections and Use secure sockets.
The local computer can connect to only other secure projects in the
enterprise. Only secure computers can connect to running projects on the
local computer.
Leave both Accept connections and Use secure sockets unchecked.
The local computer will not connect to other projects in the enterprise,
Other computers in cannot connect to projects running on the local
computer.
3-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
System Boot Options
To configure boot up options for the local computer:
1. Display the Startup Options tab in the CIMPLICITY Options dialog box.
2. Check one of the following:
When Checked At boot Up
None CIMPLICITY does not start running on the local
computer.
Boot up configuration is done.
Viewer The CIMPLICITY router starts running and the local
computer can act as a Viewer. However, no local
CIMPLICITY projects start running.
Boot up configuration is done.
Start projects Selected projects start running.
Go to 3 in this procedure.
3. Click Add.
The CIMPLICITY Default Project dialog box opens.
4. Select a project from the project list.
Note: Click Browse to find projects that are not in the drop down list.
5. Click OK.
GFK-1180J Setting up a CIMPLICITY Project 3-17
The project appears in the Start projects box.
6. Add all the projects you want to start at boot up.
Note: If there are no projects in the list, only the Router starts.
Result: CIMPLICITY follows your specifications when the local computer boots
up.
Note: To delete a project from the list, select the project, and click Delete. The project
is removed from the list.
3-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Starting CimView Screens Automatically on a Windows 98
Viewer
On a Windows 98 computer, you can configure a CIMPLICITY project to automatically
start at system boot and display an initial CimView screen.
Steps include:
Step 1. Disable the Microsoft network password.
Step 2. Select Windows Logon as the primary network logon.
Step 3. Select a CimView screen to start at boot up.
Step 1. Disable the Microsoft Network Password
Step 1. Disable the Microsoft Network Login prompt:
1. Log on to Windows 98 with a User ID that is identical to the CIMPLICITY User
ID.
Example
If your CIMPLICITY project is configured for the user ADMINISTRATOR, log
in to Windows 98 as ADMINISTRATOR.
2. Open the Windows Control Panel.
3. Click the Passwords icon .
The Passwords Properties dialog box opens.
4. Click Change Windows Password.
GFK-1180J Setting up a CIMPLICITY Project 3-19
The Change Windows Password dialog box opens.
5. Enter the old Password (or leave it blank if you never entered a password).
6. Leave the New Password and Confirm New Password fields blank
7. Click OK.
The Change Windows Password dialog box closes.
8. Click OK to close the Passwords Properties dialog box.
Step 2. Select Windows Logon as the Primary Network Logon
To select Windows Logon as the Primary network logon:
1. Open the Windows Control Panel.
2. Click the Network icon .
The Network properties dialog box opens.
3. Select Windows Logon in the Primary Network Logon field.
4. Click OK.
Result: 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.
3-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Select a CimView Screen to Start at Boot Up
To select a CimView screen to start at boot up:
1. Display the Startup Options tab in the CIMPLICITY Options dialog box.
2. Check Start projects.
3. Make sure the project(s) you want to start at system boot are listed.
4. Click CimView.
The CimView Setup dialog box opens.
5. Configure the CimView setup as follows:
A. Enter the starting CimView screen in the Screen field.
Note: You can also click Browse to the right of this field to search for the
screen you want.
GFK-1180J Setting up a CIMPLICITY Project 3-21
B. Check Start at boot if you want the CimView screen to start automatically
when the system boots.
C. Check selected check boxes to define the screen's startup characteristics:
Always Maximized This option always maximizes the initial window
to fill the user's terminal screen.
The user cannot resize the primary window, and
the window will not rise to the top when a user
clicks on it (this prevents it from obscuring other
windows on the terminal screen).
No Exit This option does not let the user exit the primary
CimView window.
The Exit menu item is removed from the File
menu, and the Close menu item and Alt+F4
shortcut key are removed from the Control menu.
In addition, the Close Screen action is ignored in
the primary window.
Keypad 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.
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.
3-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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
See the CIMPLICITY CimEdit Operation
Manual (GFK-1396) for more information about
these options.
D. (Optional) Enter the name of cache files in the Cache File field, if you
want to pre-load the screen cache with selected files.
Note: You can also click Browse to the right of this field to search for the
cache file you want.
E. Click OK to save your changes and return to the CIMPLICITY Options
dialog box.
6. Click OK.
Result: The startup options are saved and the CIMPLICITY Options dialog box
closes.
GFK-1180J Setting up a CIMPLICITY Project 3-23
CIMPLICITY Program Layers
A CIMPLICITY project has two layers of programs:
User Application
Resident Process
The User Application layer consists of the following programs:
Alarm Viewer,
CimView,
CimEdit, and
CWSERV.
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 includes such programs as the:
Router,
Device drivers,
Point Management,
Point Data Logger and,
Alarm Management Resident Process.
If you are on a Viewer, the only process running in the Resident Process layer is the
Router.
3-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
About Configuration Updates
CIMPLICITY software configuration information is held in files in the project's 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 project's 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.
See "Updating a CIMPLICITY Project" in the "Using the Workbench" chapter in this
manual for details about updating a project, including dynamic configuration.
GFK-1180J Setting up a CIMPLICITY Project 3-25
CIMPLICITY Login
Two levels of logins are available when you use CIMPLICITY software.
1. The Microsoft Windows NT/2000 or Windows 98 login screen that is presented
when you start your computer.
2. The CIMPLICITY login dialog box that is presented when you select a
CIMPLICITY user application, Alarm Viewer, CimEdit, CimView, or
CWSERV.
You have a great deal of flexibility in determining when and how users will log in to
CIMPLICITY software.
Note: The CIMPLICITY Configuration Security feature changes how the login behaves.
Briefly, if configuration security is activated, users are presented with a CIMPLICITY
User Login dialog box when they attempt to open a CIMPLICITY project.
In addition, they will only be allowed access to the CIMPLICITY applications for which
their role is assigned privileges. See "Assigning Role Application Privileges" in the
"Configuring Roles" chapter in this manual for details.
Guidelines for CIMPLICITY login include:
On a server, if you Then Users
A. Define a CIMPLICITY username and
password that match the username and
password users enter when they log in
to Microsoft Windows NT/2000 or
Windows 98 or
Are automatically logged in to
CIMPLICITY when they log in to
Microsoft Windows NT/2000 or
Windows 98.
B. Define a CIMPLICITY username and
password that are different from the
username and password users enter
when they log in to Microsoft Windows
NT/2000 or Windows 98.
Are presented with a
CIMPLICITY User Login dialog
box when they attempt to open a
CIMPLICITY project or select a
CIMPLICITY application (Alarm
Viewer, CimEdit, CimView, or
CWSERV).
3-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
A. Define common usernames across all
projects or
Are automatically logged in to all
projects when they display a CimView
screen that has points from remote
projects.
B. Define different usernames across
projects.
Have to log in to each of those projects
when they display a CimView screen
that has points from remote projects.
A. Specify that remote projects are for
resident processes only or
Have to log in at the application level.
B. Specify that remote projects are not for
resident processes only.
Are automatically be logged in and
given the same privileges as the
CIMPLICITY User ID for the remote
login. See the "Remote Projects"
section in the "System Management"
chapter in this manual for details.
If a User Then the User
Checks the Save Username +
Password check box when selecting
any applications in the project
Will automatically be logged in to the
project with the saved username and
password.
A. Opens a CIMPLICITY application
while the login is active,
(The login remains active for a period
after the user exits all open
CIMPLICITY applications. The length
of time is specified by the system
manager or
Does not need to log in when an
application is opened.
B. Opens a CIMPLICITY application after
the login period has expired.
Needs to log in again.
On a Viewer, if a User: Then the:
Checks Reconnect at Startup. Viewer is automatically connected to
the project used by the application
whenever CIMPLICITY software is
started on the viewer.
Checks Save Username +Password
in the Login dialog box.
User will be automatically logged into
the project.
GFK-1180J Setting up a CIMPLICITY Project 3-27
CIMPLICITY Project to Diskette
Each CIMPLICITY HMI project has several subdirectories associated with it.
The standard project subdirectories are:
Subdirectory Hold
alarm_help Operator Help files for alarms (that you created and put them in this
directory).
arc Database Logger archive files.
data All the runtime configuration files.
lock The project lock file.
log All status log files, and program error files.
master All the master copies of configuration files.
screens All CimView screens (default directory).
scripts All Basic Control Engine scripts for a project.
To make a backup copy of your project on a diskette, do the following:
1. Open the Windows Explorer.
2. Locate the project directory for the project you want to back up.
3. (To save space on your diskette) delete all log files from the project's \log
directory before making the backup.
4. Copy the project's directory to the diskette.
Note: If the project is running, some files in this directory may be locked and will not be
deleted.
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.
If you try to back up a running project, an error message appears telling you there is a
sharing violation.
3-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 to display help information for this command line option are:
/help or -help or /? or -?.
A help message appears:
/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/2000.
/rstart <project> or -rstart <project> <computer> to start a project on a remote
computer.
Example
startup.exe /rstart z:projects\cimpdemo\cimpdemo.gef alnt04
/rstop <project> or -rstop <project< <computer> to stop a project on a remote
computer.
Example
startup.exe /rstop z:projects\cimpdemo\cimpdemo.gef alnt04
Note: If you are working with a redundant project use the :
/start and /stop options for the Master server.
/rstart and /rstop options for the slave.
GFK-1180J 4-1
Understanding Points
About Points
CIMPLICITY 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. Point Management's 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 user's ability to set point to only those points whose resources are
in the user's view.
See "Setpoint Security" in this chapter for more information.
4-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
Analog integer or floating points,
Boolean, or
Text.
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.
GFK-1180J Understanding Points 4-3
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.
4-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 that starts with a number (0-9).
You must enclose the Point ID in single quotes
when used in a point expression or equation
The @ character is invalid if it is the first
character in the Point ID.
Use freely The underscore character ( _ )
The period (.)
GFK-1180J Understanding Points 4-5
Setpoint Security
You can limit a user's ability to set points to only those points whose resources
are in the user's 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. Click Project on the Workbench menu bar.
2. Select Properties.
The Project Properties dialog box opens.
3. Select the Settings tab.
4. Select Points.
5. Click Settings .
Method 2
1. Press Alt+P on the keyboard.
2. Press P.
The Project Properties dialog box opens.
3. Select the Settings tab.
4. Select Points.
5. Click Settings .
Result: The Point Setup dialog box opens when you use either method.
4-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Check to restrict
user's setpoint
access
Check to require a
password for
setpoint functions
Enter a password
Point Setup Dialog Box: Security Section
To set security criteria in the Point Setup dialog box:
1. (Optional) Check Enable 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 user's view.
Example
RESOURCE_1 is an authorized resource for USER_X.
If: POINT_A has been defined for
RESOURCE_1 and Enable 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 Enable set point
security is enabled.
Then: USER_X cannot perform setpoints on
POINT_A.
2. (Optional) Configure Enable set point password to restrict access to the
setpoint functions. The CIMPLICITY HMI default is unrestricted access.
A. Check Enable 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 field to confirm it.
GFK-1180J Understanding Points 4-7
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 project's 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 user's view).
GFK-1180J 5-1
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). See the
CIMPLICITY 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 User's Manual provide depth descriptions of each part of the
process.
OPERATORINTERFACE
F1 F2
ESC F2 v SW1 SW2
XFER SRCH M O N SW3 SW4
RUN STO P I
F1 ^
O SW5 SW 6
SET C R SW7 SW 8
7 ABC 8 DEF 9 G HI SW9 SW10
SW12 SW11 6 PQ R 5 M NO 4 J KL
1 STU 2 VWX 3 YZ- SW13 SW14
0+/ ENTER ON / O FF
BATT. MSG.
IBM Compatible
1. Connect a device to a server.
2. Enable the device's protocol.
3. Add the device to the
CIMPLICITY HMI project.
Quick Install for a Device Point
4. Configure a
device point.
.
5-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 an HMI project:
1. Click Project on the Workbench menu bar.
2. Select Properties.
The Project dialog box opens.
3. Select the General tab.
4. Scroll up and/or down in the Protocols box to find the protocol that will be
used.
5. Check the protocol's 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.
GFK-1180J Quick Device Setup 5-3
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 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 device's port. (If a port doesn't already exist.)
Step 3. Configure the device's port. (If a port doesn't already exist.)
Step 4. Configure the device.
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.
5-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
4. Enter a unique name in the Device field.
Select a Port
browser
Select a Port
browser
Recent selected
ports
5. Enter the port, if it is configured and go to Step 4.
Go to Step 2 if you need to configure a port.
Step 2. Select a protocol for the device's port:
Select a Port
Browser
Open New Port
dialog box.
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-1180J Quick Device Setup 5-5
Step 3. Configure the device's port:
1. Select the General tab of the Port Properties dialog box.
Protocol tab depends on selected protocol
Example: Port PropertiesDialog Box with TCP/IP Protocol
General tab (for
all ports)
2. Enter the interval length between scans in the Scan Rate field. The time type
options are:
Seconds
Minutes
Hours
3. 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.
1. Click OK.
Result: A filled in New Device dialog box appears.
5-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Protocol tab depends on selected protocol
Example: Device PropertiesDialog Box with TCP/IP Protocol
General tab (for
all ports)
Included in
CIMPLICITY HMI
$SYSTEM
$MAC_FR
$PTM_FR
2. (Optional) Enter a description of the device in the Description field, 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
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.
GFK-1180J Quick Device Setup 5-7
6. Either:
Check the Enabled checkbox
Check the Yes radio button for the Enabled option.
The method depends on the protocol.
7. Enter the required information on the device's Protocol tab. Required entries
depend on the protocol you are using. See the CIMPLICITY HMI Device
Communications Manual (GFK-1181) for details on the addressing supported
for your particular device and protocol.
Result: 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.
GFK-1180J 6-1
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.
Configure a point's data type
Configure a point's address on the device
3. (Optional) Begin advanced configuration in order to take advantage of
CIMPLICITY HMI software capabil ities 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
4. (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.
Note: CIMPLICITY HMI provides you with a Manual Mode feature that enables a user
to disconnect a point's 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.
6-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Device browser
Device popup
New Device point Device name
Select one class
4. Enter a unique Point ID.
5. Check Device as the point type.
6. Specify the Device associated with the point.
GFK-1180J Configuring Device Points 6-3
7. Check a point Class(ification).
Your device point can be one of three classifications:
Analog
Boolean
Text
8. Click OK.
Result: The Point Properties dialog box opens.
Device Point Basic 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 point's data type.
Configure device addressing.
Selecting the Device Points Data Type
You find the device point's 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.
Exampl e
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 basi c information for a device point:
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
3. Select one Data Type from the drop down list that appears for the point type
you selected:
6-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Analog Points
General TabBasic ViewAnalog Point
DINT
INT
REAL
SINT
UDINT
UINT
USINT
3D_BCD
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.
GFK-1180J Configuring Device Points 6-5
Boolean Points
General TabBasic ViewBoolean Point
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
Text Points
General TabBasic ViewText Point
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 An 80-character alphanumeric string
4. Enter:
The number of array elements, if the point is an array
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.
6-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
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.
GFK-1180J Configuring Device Points 6-7
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
J ohnson 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.
6-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Entering Addressing Specifications for a 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 Device
Communications Manual (GFK-1181).
About Basic Custom Addressing for Device Points
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.
Customized Device Addressing
. 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.
Note: You can easily change the Device ID by entering a differend ID or using
the Select a Device browser or Device popup to select another.
1 Enter the Device
ID in the New
Point dialog box.
2 The Device ID appears on the
Device tab in the Point
Properties dialog box.
Select a Device
browser
Device
popup
2. Enter the Address that is consistent with the selected protocol. For further
information on addressing for the protocol and device, see the CIMPLICITY
HMI Device Communications Manual (GFK-1181).
GFK-1180J Configuring Device Points 6-9
Device TabBasic ViewUpdate Criteria
Availability depends on
protocol:
On Change
On Scan
On Demand On Scan
On Demand On Change
Unsolicited
Poll Once
Boolean
points only
Entry depends on
protocol
3. (For Boolean points only) Enter an Address Offset (bit offset) if the first bit of
the point's data is not the first bit of the address. Address offsets start at 0, which
is the least significant bit.
Exampl e
A digital point is located in the third (3
rd
) bit of Register 5 on a Series 90-70
The Address is %R5
The Address Offset is 2.
4. 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.
6-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Value Updated: The point's value is updated at the point's 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
Data Collected: Whenever the point's value is needed by an
application.
Value Updated: At the point's scan interval, whether or not the
value changes.
On Demand On Change
Data Collected: Whenever the point's 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 point's value has changed.
This mode is only valid if the device is capable
of sending unsolicited updates of point values
and the device communications protocol
supports it. See the CIMPLICITY HMI 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 point's value has changed.
This mode is only valid if the device is capable
of sending unsolicited updates of point values
and the device communications protocol
supports it. See the CIMPLICITY HMI 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
GFK-1180J Configuring Device Points 6-11
Diagnostic Point Addressing
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 all messages sent to the device.
Responses Number of all responses received from the
device (successfully or not).
This includes responses that can be unsolicited
with no data that can be mapped or that can
contain protocol errors.
Retries Number of times a message had to be resent
Failures Number of periods of communication failure.
A failure period includes retries that are back to
back and continues until a retry is successful.
When a retry is successful and a failure occurs
again, the next retry begins a new failure period.
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 port's base scan rate, displayed in
CimView screens, trended, logged, alarmed, etc.
Important: You cannot write to diagnostic points. Always configure them for Read
access.
6-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
To create a di agnostic point when the enabler uses custom addressing:
1. Check 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 Data Type Description
$TRANSMISSIONS UDINT Number of messages
sent$RESPONSES UDINT Number of messages
received
$FAILURES UDINT Number of
communication failures
$RETRIES UDINT Number of retries
$DEVICE_DOWN BOOL Device down status
$DEVICE_UP BOOL Device up status
Device TabBasic ViewDiagnostic Data
Entry Choices
For UDINT
$TRANSMISSIONS
$RESPONSES
$FAILURES
$RETRIES
For BOOL
$DEVICE_DOWN
$DEVICE_UP
GFK-1180J Configuring Device Points 6-13
Standard Domain Addressing
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:
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 point's 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."
Note: Use the following values to configure diagnostic data for devices with standard
addressing:
Description
Data
Type Domain Type
Domain
Offset
Number of messages sent UDINT Standard Diag. Double Words 0
Number of messages received UDINT Standard Diag. Double Words 1
Number of communication failures UDINT Standard Diag. Double Words 2
Number of retries UDINT Standard Diag. Double Words 3
Device up status BOOL Standard Diagnostic Bits 0
Device down status BOOL Standard Diagnostic Bits 1
6-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 HMI's 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
Entering Advanced General Specifications for Device Points
There are several general choices you can make to add to your device point's
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.
Associating a point attribute set with the point.
Selecting to log the point's data.
For analog and Boolean points
Entering trend history criteria.
GFK-1180J Configuring Device Points 6-15
Advanced General Tab in the Device 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 di alog box in advanced
mode:
Click Advanced on the basic General tab. When the tab is in advanced view, the
Basic button displays.
Advanced General tab in Point Properties dialog box
Trend history and Alarm tabs display for
Analog and Boolean points only.
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-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 disabl e 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 Allows data to be exported to the Enterprise server so
it will be available to other projects
3. 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 (but not REAL)
B. Device or virtual
Important: The point cannot be an array point.
GFK-1180J Configuring Device Points 6-17
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 Availabi lity 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 specifi cations 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-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Exampl e:
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.
Attribute Sets for Device Points
CIMPLICITY HMI enables a project developer to create sets of point attributes that use
16 bits and that can be applied to one or more points in a project.
You can associate any point attribute set that was created in the Attribute Set dialog box
with a device point.
All of the attribute fields in the selected attribute set will then be available to associate
with that point in any expression that takes a Point ID.
To associate a user defined point attribute set with a device point:
1. Click the Browse button to the right of the Attribute Set field.
The Attribute Set browser opens.
2. Select an attribute set for the point.
Note: You can conveniently create new attribute sets or edit the selected attribute by
clicking the Popup button and selecting New or Edit from the menu.
See the "User Defined Point Attributes" section of the "Using Point Attributes" chapter in
this manual for details about creating and editing point attribute sets.
GFK-1180J Configuring Device Points 6-19
Point Data Log Checked in the Point Properties Dialog
You can select to log a device point's data on the advanced General tab in the Point
Properties dialog box.
To specify data logging:
1. Check Log data.
Click either to add the point to the default
CIMPLICITY DATA_LOG.
2. Click OK or Appl y.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
See the "Database Logger" chapter in this manual for information about configuring
log tables.
Entering 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:
Trigger settings
Scan rate
Analog deadband
Poll after set
Delay load
Note: You can configure addressing in either basic or advanced mode.
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.
6-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
Click Advanced on the basic Device tab. If the tab is in advanced view, the Basic
button will display.
Advanced Device tab on Point Properties dialog box
Scan Rate selected.
Trigger settings selected.
Analog deadband for
Analog points only.
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.
GFK-1180J Configuring Device Points 6-21
Exampl e
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
"Update Criteria for a Device Point" in this chapter.
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.
Point popup
Select a Point
browser
None
Equal
Greater Than
Greater Than Equal
Less Than Equal
Less Than
On Change
2. Select, in the Relation field, how the trigger point will be evaluated.
Your choices are:
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.
On Change Whenever the Trigger Point is changed.
3. 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 point's scan rate while the trigger condition is true.
6-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Scan Rate
Enter the frequency at which the CIMPLICITY device communications option will read
this point's data, based on the port's 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.
Exampl e
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 in the Scan Rate field.
Analog Deadband
An Analog Deadband filters out changes in the raw value of this point. A point value
change less than OR EQUAL TO the deadband value will be ignored. The raw value
must change more than 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.
Note: An explicit deadband of 0 is the same as selecting an On Change update criteria.
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 point's 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.
Delay Load
Delay Load is checked when the point will write to the point database, but will not reside
in memory until called into use by an application.
GFK-1180J Configuring Device Points 6-23
Reviewing 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:
Device point that represents the condition and is configured to be updated
On Change
Virtual point that represents the condition
6-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
Option 2. Update Criteri a for D1 is set to On Scan, and A1 i s configured so that it i s
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-1180J Configuring Device Points 6-25
Option 3. When the Update Criteri a 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-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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-1180J Configuring Device Points 6-27
Reviewing the Delay Load Function
When the Delay Load box is checked on the Device tab in the Point Properties dialog
box, the point is only loaded into memory when demanded by an application. The point is
written to the point database, but does not use memory on your system until loaded.
There may be a delay time when the point is demanded and loading; therefore, this option
is not recommended for points that are accessed often.
There are a number of benefits to using the delay-load option, along with some
disadvantages and non-supported functions. They are as follows:
Benefits Disadvantages Non-Supported Functions
Loaded when needed
No memory usage until
point is loaded
Written to point database
Available in point list
Slower access
Trigger settings and
Alarm options are not
available
Trend buffering
Alarming
Cannot be used within
another point's
configuration, e.g. Safety
point, Trigger,
Availability Trigger
point, etc.
Cannot be used in a
calculation point equation
6-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Point Conversions and Enumeration
CIMPLICITY software enables you to
Either
(For an analog device point) Select the base engineering units for an analog
device point and specify a linear or custom conversion for an analog device
point, or
(For an analog virtual point) Select the base engineering units for an analog
virtual point
Or
Configure the point as an enumeration point.
You do this on the Conversion tab that appears in the Point Properties Advanced General
tab group.
An enumeration point provides the text replacement for the value of a point. You can
configure one or more Point Enumeration sets in the Point Enumeration application and
then associate an analog or digital point with a set on the Conversion tab. See page 6-37
for details.
1. Display the Conversion tab.
Either
2. Configure base base engineering units for a point.
3. (For device points) Configure the conversion type.
Or
4. Configure the point as an enumeration point.
GFK-1180J Configuring Device Points 6-29
Displayi ng the Point Properties Conversion Tab
Step 1. Displ ay the Conversion tab:
1. Click Advanced on the General tab.
2. Select the Conversion tab that appears if you are configuring an analog point.
Device tab only
6-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring Base Point Engineering Units
Fill in the Measurement units field to define the units that CIMPLICITY converts to
and / or from the projects base measurement units.
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.
However, configured deadbands and analog deadbands will not be converted via
measurement units or otherwise.
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.
Select a Measurement
Unit browser
Measurement
popup
Device points only
Choose any of the following methods to configure engineering units for a point:
Method 1. Use the Popup Menu.
Method 2. Use the Select a Measurement dialog box.
Method 3. Use the New Measurement dialog box.
Method 4. Leave the Base Units field blank.
GFK-1180J Configuring Device Points 6-31
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 unit from the list of available
measurement units.
Result: The unit appears in the Unit field and the label for the unit
automatically displays in the Label field.
Method 2
1. Click the Browser button to the right of the Unit field.
The Select a Measurement Unit browser opens.
2. Select the measurement unit.
3. Click OK.
Result: The unit appears in the Unit field and the label for the unit
automatically displays in the Label field.
6-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 in the Unit ID field.
4. Click OK.
The Measurement Unit Properties dialog box appears.
5. (Optional) Enter a Description.
6. Enter the Display label that will appear when the measurement unit is selected.
7. Click Appl y.
Result: The new unit is added to the list of available units.
Method 4
Leave the base units for the point blank and enter your own label in the Label field.
Result: You can configure point enumeration for either a virtual or device point.
GFK-1180J Configuring Device Points 6-33
Configuring the Conversion Type for a Device Point
CIMPLICITY supports the following types of Engineering Unit (EU) conversions for
device 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.
Example
A 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.
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. Check 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.
6-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
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. Check 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
GFK-1180J Configuring Device Points 6-35
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 LT, GT, EQ, LE, GE, NE
Exampl e
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: Note when creating a custom conversion:
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.
A conversion that inverts the sign, (e.g. a FWD Conversion =%P(-1) and REV
Conversion =%P(-1)) will not work correctly if you configure setpoint, range or
alarm limits
6-36 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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
Because integer arithmetic was used throughout, the result is
an integer.
(%P/2)*10 (3/2)*10 = (1)*10 = 10
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)*10.0 (3/2)*10.0 = (1)*10.0 = 10.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 (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.
(%P/2.0)*10.0 (3/2.0)*10.0 = (1.5)*10.0 = 15.0
GFK-1180J Configuring Device Points 6-37
Configuring a Point as an Enumeration Point
When a point is configured as an enumeration point, the value of the point will display as
enumerated text (a STRING point of 32 elements) in applications including:
Point Control Panel,
CimView,
Database Logging and
BCE.
Point enumeration is particularly useful for points where a value that is translated into
text is more easily understandable than the numeric value, e.g. ON/OFF vs. 0/1.
If the value of the point does not correspond to a configured enumeration, the point will
be treated as being out of range and will be displayed as unavailable.
Guidelines for enumerated points include:
1. Analog points of the following base data types may use enumeration sets:
SINT,
USINT,
INT,
UINT,
DINT,
UDINT and
BOOL.
These data types will be referenced as discrete data types.
2. Points that are not supported include:
Array points.
Points with EU conversion. The result of their evaluation is a REAL data type,
which does not have discrete values.
3. Discrete points with 1 element only can use enumeration sets.
4. A point can be configured so that the value can be set to any of the case-sensitive
enumerated text values.
If the point is set to a value that is not part of the case-sensitive enumeration,
CIMPLICITY generates an error.
Steps to create an enumeration point include:
Step 1. Create an enumeration set (if the set does not already exist).
Step 2. Select the enumeration set that will be associated with the point.
6-38 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Create an Enumeration Set
To create an enumeration set:
1. Do one of the following:
Method 1Work through the Workbench
Click the Point Enumerations icon in the Points tree in
the Workbench left pane.
Method 2Work through the Point Properties dialog box
A. Click the Popup menu button to the right of the Point enumeration
field.
B. Select New in the popup menu.
A New Point Enumeration dialog box opens when you use either method.
2. Enter a name for the Enumeration set in the Enumeration ID field.
GFK-1180J Configuring Device Points 6-39
3. Click OK.
A Point Enumeration dialog box opens.
4. Enter a description in the Description field.
5. Click New.
The New Value dialog box opens.
6. Enter a value in the Value field.
If the Enumeration set is associated with a point, its accompanying text will
display in applications, e.g. Point Control Panel, when this value is reached.
If the point is a setpoint, the value you enter will be set when its accompanying
text is selected.
7. Click OK.
The Value properties dialog box opens.
8. Enter text that will be associated with the value.
9. Check Setpoint Allowed to allow a point that is associated with the
Enumeration set to be set to the selected value.
6-40 CIMPLICITY User's ManualDecember 2000 GFK-1180J
10. Click OK
The Point Enumeration dialog box appears displaying the information you just
entered.
11. Continue adding values until the Enumeration set is complete.
12. Click OK.
Result: the Point Enumeration set is now available to be associated with one or
more points.
Important: The values that you enter in the text field are case sensitive. Anyone
working with those values must enter them exactly as configured.
GFK-1180J Configuring Device Points 6-41
Step 2. Associate a Point with an Enumeration Set
To associate a point with an enumeration set:
If the Conversion tab is displaying, go to 4 in this procedure.
1. Open the point's Properties dialog box.
2. Click Advanced on the General tab to put the Point Properties dialog box in
advanced mode.
3. Select the Conversion tab.
4. Click the Browser button to the right of the Point enumeration field.
The Select a Point Enumeration browser opens.
5. Select a Point enumeration set.
6. Click OK.
6-42 CIMPLICITY User's ManualDecember 2000 GFK-1180J
The selected enumeration set displays in the Point field.
7. Click OK.
Result: The point is now an enumerated point.
Enumeration Point Application Examples
You associate a UINT analog point (that allows setpoints) with an enumeration set called
THROTTLE_VALVE.
The positions are:
Value Text
0 UNAVAILABLE
1 CLOSED
2 PARTLY CLOSED
3 HALF OPEN
4 PARTLY OPEN
5 OPEN
See page 6-37 for details about configuring an Enumeration Set and enumerated point.
GFK-1180J Configuring Device Points 6-43
Point Control Panel
During runtime in the Point Control Panel, if the point value:
Equals one of the defined numeric values, the associated text displays in the
Value column.
Can be set, the case-sensitive text value is entered in the Point Control Panel
Point Properties dialog box.
Enumeration Point in Point Control Panel
1 Select an enumeration set for a
point.
2 The enumerated value appears
when a point displays in the Point
Control Panel.
Note: Enter the case
sensitive enumerated value
to set the point if setpoint
capability is enabled.
See "Using the Point Control Panel" in this manual for details about the Point
Control Panel.
CimEdit/CimView
You can use the enumerated values in:
CimEdit, to configure the enumerated point
CimView, to set the point's value.
To use the example enumerated values:
1. Configure a text object on the CimEdit screen.
A. Place the text object.
B. Open the object's Properties dialog box.
C. Enter VALVE POSITION in the String field on the Text tab.
D. Enter the point, S90_VALVE_POSITION, in the Expression field.
E. Check Setpoint Action.
2. Place a valve on the CimEdit screen:
6-44 CIMPLICITY User's ManualDecember 2000 GFK-1180J
A. Click the Object Explorer button on the CimEdit toolbar.
B. Find Valves Symbols Factory folder in the left pane.
C. Double-click a valve to place it on the screen.
3. Open the Expression List Attribute Animation dialog box for the valve as
follows:
A. Open the valve's Properties dialog box.
B. Select the Color Animation tab.
C. Click Enter.
4. Enter the case sensitive enumerated values to display each valve position.
5. Test the animation in CimView.
A. Open the runtime screen.
B. Enter a case sensitive enumerated value (e.g. CLOSED) in the text field.
Result: The valve screen changes to reflect changes in enumerated values.
CimEdit/CimView Point Enumeration Example
2 Enter case sensitive
enumerated values to
animate the valve (in
CimEdit).
3 The valve responds to the
enumerated text (in
CimView).
1 Place a valve with text
(that allows setpoints) on
a CimEdit screen.
See the CimEdit Operation Manual GFK-1396 for details about configuring color
animation.
GFK-1180J Configuring Device Points 6-45
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
point's 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 system's integrity.
Exampl e
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.
Note: A point with manual mode enabled can be changed, regardless of the current value
or state of an associated availability trigger or safety point.
GFK-1180J 7-1
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.
Select the virtual point's data type
Enter initialization specifications
3. (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
4. (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.
7-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. Enter a unique Point ID.
5. Select a point Class(ification).
Your virtual point can be one of three classifications:
Analog
Boolean
Text
6. Click OK.
The Point Properties dialog box opens.
GFK-1180J Configuring Virtual Points 7-3
Virtual Point Basic 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 point's data type
Enter initialization specifications
Selecting the Virtual Point's Data Type
The data type choices available to you for a virtual point depend on the type you selected
when you created it.
To enter general basic information for an analog point:
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.
3. Select one Data Type from the drop down list that appears for the point type
you selected:
Analog Points
General TabBasic ViewAnalog Point
DINT
INT
REAL
SINT
UDINT
UINT
USINT
DINT
INT
REAL
SINT
UDINT
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.
7-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Boolean Points
General TabBasic ViewBoolean Point
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
Text Points
General TabBasic ViewText Point
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 An 80-character alphanumeric string
4. Enter:
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.
GFK-1180J Configuring Virtual Points 7-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.
Point Properties Dialog Box General Tab
1 =Single Point
Equal or greater than
2 =Array point
Important: Array points are not supported by all CIMPLICITY software functions.
Support for array points is as follows:
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.
7-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
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:
every time a point changes.
when the project shuts down normally.
Saved or Initialized 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.
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).
GFK-1180J Configuring Virtual Points 7-7
4. The Calculation TypeNone is the basic configuration default. See
"Configuring Points: Advanced" in this manual for information about other
calculations.
Basic Virtual TabAnalog and Boolean Points: Example Boolean point
Analog point
None
Initialized
Saved
Saved or Initialized
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
None
Initialized
Saved
Saved or Initialized
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
(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:
every time a point changes.
when the project shuts down normally.
Saved or Initialized 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-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
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.
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.
Sets STRING[0] to A
Sets STRING[1] to B, etc.
Guidelines: 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.
GFK-1180J Configuring Virtual Points 7-9
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 project's Point Setup dialog box.
Follow procedures for two easy steps:
Step 1. Open the Point Setup dialog box.
Step 2. Specify how CIMPLICITY HMI should store values.
Step 1. Open the Point Setup dialog box:
Method 1
1. Click Project on the Workbench menu bar.
2. Select Properties.
The Project Properties dialog box opens.
3. Select the Settings tab.
4. Select Points.
5. Click Settings.
Method 2
1. Press Alt+P on the keyboard.
2. Press P.
The Project Properties dialog box opens.
3. Select the Settings tab.
4. Select Points.
5. Click Settings.
Result: The Point Setup dialog box opens when you use either method.
Recommended:
De-select after configuration
7-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2. Select how CIMPLICITY HMI should store values:
1. (Optional) Select one of the following :
Check 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 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.
2. (Optional) Check 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
project's run-time 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.
Recommended:
De-select after configuration
GFK-1180J Configuring Virtual Points 7-11
Advanced Virtual Point Configuration
Once your basic virtual point is up and running, you can add to and refine your
configuration in order to take advantage of the CIMPLICITY HMI's diagnostic and
monitoring powers.
You can
Configure advanced general specifications.
Configure a derived point with advanced CIMPLICITY HMI calculations.
Specify safety and availability trigger.
Configure measurement unit formats.
Specify range and setpoint limits (Analog points).
Configure alarms.
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. (Click Advanced.)
There are several general choices you can make to add to your virtual point's
configuration.
They include:
For analog, Boolean or text points
Enable the point or associated alarm. See "Setting Point Limits and Alarms" in
this chapter for information about configuring an alarm.
Select a point to be a safety point.
Associate an attribute set with the point.
Select a point to be an availability trigger.
Associate a point with a trend.
Selecting to log the point's data.
For analog and Boolean points
Enter trend history criteria.
7-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Advanced General Tab in the Virtual Point Properties Dialog
Box
To put the General tab of the Point Properties dialog box in advanced
mode:
Click Advanced on the basic General tab. If the tab is in advanced view,
the Basic button will display.
Advanced General tab in Point Properties dialog box
Trend history and Alarm tabs display for
Analog and Boolean points only.
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. the Advanced
To enable or disable a virtual 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
GFK-1180J Configuring Virtual Points 7-13
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
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
Attribute Sets for Virtual Points
CIMPLICITY HMI enables a project developer to create sets of point attributes that use
16 bits and that can be applied to one or more points in a project.
You can associate any point attribute set that was created in the Attribute Set dialog box
with a device point.
All of the attribute fields in the selected attribute set will then be available to associate
with that point in any expression that takes a Point ID.
To associate a user defined point attribute set with a virtual point:
1. Click the Browse button to the right of the Attribute Set field.
The Attribute Set browser opens.
2. Select an attribute set for the point.
7-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Note: You can conveniently create new attribute sets or edit the selected attribute by
clicking the Popup button and selecting New or Edit from the menu.
See the "User Defined Point Attributes" section of the "Using Point Attributes" chapter in
this manual for details about creating and editing point attribute sets.
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:
Availability Trigger Configured Point is
Evaluates to a non-zero value Available or derived
Or Unavailable
Evaluates to zero Unavailable
Important: Availability triggers only apply to virtual points that have no calculation
expression.
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
GFK-1180J Configuring Virtual Points 7-15
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.
Point Data Log Checked in the Point Properties Dialog
You can select to log a virtual point's data on the advanced General tab in the Point
Properties dialog box.
To specify data logging for a virtual point:
1. Check Log data.
Click either to add the point to the default
CIMPLICITY DATA_LOG.
2. Click OK or Apply.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
See the "Database Logger" chapter in this manual for information about configuring
log tables.
7-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. :
Note: Virtual points are updated on project start based on the results of entries in the
Initialization and Calculation fields that are on the Virtual tab of the Point Properties
dialog box.
Advanced Virtual Tab Initial Value SpecificationAnalog Point: Example
Selections (and associated entries) provide criteria for virtual point updates.
The calculation types are:
Equation Analog and Boolean. See page 7-17.
Delta Accum. See page 7 -19.
Value Accum. See page 7-23.
Average. See page 7-25.
Max Capture. See page 7-27.
Min Capture. See page 7-30.
Trans-High Accum. See page 7-31.
Equation w/Override. See page 7-33.
Timer/Counter. See page 7-35.
Histogram. See page 7-38.
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.
Note: Almost all of the calculations allow you to enter a trigger point.
GFK-1180J Configuring Virtual Points 7-17
For calculation points, you only need Saved and Initial values for Delta Accum,
Timer/Counter and Value Accum points. This is because all other calculation points are
validated at startup and any saved or initial value is immediately overwritten.
Trigger Points
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.
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
point's value.
Steps to define equation points include:
Step 1. Select Equation in the Calculation field.
Step 2. Enter an expression for the Equation point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset point.
Step 1. Select Equation in the Calculation field.
Select Equation in the Calculation field on the Virtual tab of the Point Properties
dialog box.
Point browser
menu
Expression
dialog
Point menu
7-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Point browser
menu
Expression
dialog
Point menu
Virtual TabPoint Properties Dialog Box
Step 2. Enter an expression for the Equation point:
Enter an expression in the Expression field on the Virtual tab of the Point Properties
dialog box.
Result: The expression calculates the value of the Equation point.
The expression may contain:
One or more Point IDs along with
Constant values, operations, and functions.
Rules for defining an expression are:
1. Avoid introducing loops (circular references between points) in your
expressions.
Example of what to AVOID:
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.
2. Use proper formatting for array points.
Example of the correct format
VIRTUAL_PT1 = DEVICE_PT[0] / 2.0
3. 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'
GFK-1180J Configuring Virtual Points 7-19
Step 3. (Optional) Define a trigger point for the Equation point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the equation updates depends on whether or not you
defined the trigger point as follows:
If a trigger point is: The value of the Equation point
is updated whenever Value of the:
Defined Trigger point is updated.
Not defined One of the source points in the Expression field is
updated.
Step 4. (Optional) Define a reset point for the Equation point:
Enter a Point ID in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Equation point is reset as follows:
If : And: Then:
An Initial Equation
Point value is
The Current
value of the
Expression is
The Equation point
value is reset to the:
When the trigger point is not defined
1 Not defined Available Current value
2 Not defined Unavailable Zero
3 Defined Unavailable Initial value
4 Defined Available Current value
When the trigger point is defined
1 Not defined Zero
2 Defined Initial value
Delta Accum Points
A Delta Accum point is an increasing representation of a source expression. A decrement
in the source expression value is also considered to be an increase to the Delta Accum.
A Delta Accum point is particularly useful when used with a PLC to keep an incrementing
tally as the PLC count increments and rolls over.
Note: You can also use a Delta Accum point with a global virtual point. However, in
most cases, the virtual point should be configured so that when it reaches the rollover
level it emulates a PLC and rolls over to the initial value.
Steps to define a Delta Accum point are:
Step 1. Select Delta Accum in the Calculation field.
Step 2. Enter an expression for the Delta Accum point.
Step 3. Enter a maximum acceptable delta value.
Step 4. (Optional) Enter a rollover value.
7-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. (Optional) Define a trigger point.
Step 6. (Optional) Define a reset point.
Guidelines: For a Delta Accum point:
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 first updated after the first two expression updates are received.
Continues to have Delta values added until a Reset Condition is reached.
Is writeable.
Is always calculated as follows:
1. If the old source is less than the new source,
New Delta Accum = Old Delta Accum + (New source - old
source)
2. If the source has rolled over so the new source is less than the old source,
New Delta Accum = Old Delta Accum + (Source rollover value +
1) - old source value + new source value
Example
Note: A rollover value, which is used in this example, is the maximum acceptable
value for a source point. When the maximum value is incremented by 1 unit, the
source point rolls over to 0.
A Delta Accum point has a value of 100 and a Rollover value of 1000.
1. The source changes from 100 to 999.
The new Delta Accum value=999.
999=100+(999-100)
2. The source next changes from 999 to 20. (The source point has rolled over.)
The new Delta Accum changes to 1022 based on the formulas calculation:
999+(1000 + 1) - 999 + 20 = 1022
Step 1. Select Delta Accum in the Calculation field:
1. Select Delta Accum in the Calculation field on the Virtual tab of the Point
Properties dialog box.
Point browser
menu
Expression
dialog
Point menu
GFK-1180J Configuring Virtual Points 7-21
Step 2. Enter an expression for the Delta Accum Point:
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.
Step 3. Enter a maximum acceptable delta value:
If incoming data suddenly, for example, overloads the computer to the degree
that the variance between the Delta Accum increment and the source becomes
high enough that the Delta Accum misses a source rollover, the Delta Accum
value ceases to be an accurate representation of the source activity.
The Variance field provides a way to alert the operator if this situation occurs.
When the difference between the new source value and the old source value
exceeds the entry in the Variance field, the Delta Accum value does not
increment. Instead a message is logged to the status log that this situation
occurred.
Enter the maximum acceptable delta value in the Variance field that can be added to
the Delta Accum point value.
Result: If the delta value is greater than the Variance value, the:
1. New delta value is not added.
2. System logs the following message to the Status Log with Success status:
Variance value exceeded for accumulator point : <point_id>
Step 4. (Optional) Enter a rollover value for a Delta Accum point:
(Optional) Enter the rollover value for the source expression point in the Rollover
field.
Example
A Delta Accum point has a:
Rollover value of 99.
Current value of 98.
The previous source expression has a value of 97.
If a new value of 3 is received, the new delta accum is calculated as:
98+(100 - 97)+ 3= 104
If you do not specify a Rollover value, the size of the data type for the Delta
Accum point determines 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.
When the maximum value is exceeded the following message is logged to the
Status Log with Success status:
Rollover occurred for accumulator point : <point_id>
7-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Note: If the source expression is a floating or Boolean point, rollover is not applied.
Step 5. (Optional) Define a trigger point for a Delta Accum point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Delta Accum point updates depends on whether or
not you defined the trigger point as follows:
If a trigger point is: The value of the Delta Accum point
is updated whenever the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
Step 6: (Optional) Define a reset point for a Delta Accum point:
(Optional) Enter a Point ID in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime 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 Not defined Unavailable Zero
2 Not defined Available Zero
3 Defined Unavailable Initial value
4 Defined Available Initial value
When the trigger point is defined
1 Not defined Zero
2 Defined Initial value
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.
GFK-1180J Configuring Virtual Points 7-23
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] Eighth hour production count
A Safety Point called HOUR:
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.
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.
Steps to define a Value Accum point are:
Step 1. Select Value Accum in the Calculation field.
Step 2. Enter an expression for the Value Accum point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset point.
7-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Select Value Accum in the Calculation field:
Select Value Accum in the Calculation field on the Virtual tab of the Point
Properties dialog box.
Point browser
menu
Expression
dialog
Point menu
Step 2. Enter an expression for the Value Accum point:
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.
Step 3. Define a trigger point for the Value Accum point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Value Accum point updates depends on whether or
not you defined the trigger point as follows:
If a trigger point is: The value of the Value Accum point
is updated whenever the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
GFK-1180J Configuring Virtual Points 7-25
Step 4. Define a reset point for the Value Accum point:
(Optional) Enter a Point Id in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Value Accum point is reset as follows:
If: And: Then:
An Initial Value
Accum Point
Value is
The Current
value of the
Expression is
The Value Accum point
value is reset to the:
When the trigger point is not defined
1 Not defined Unavailable Zero
2 Not defined Available Zero
3 Defined Unavailable Initial value
4 Defined Available Initial value
When the trigger point is defined
1 Not defined Zero
2 Defined Initial value
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
or simply as
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.
Steps to define an Average point are:
Step 1. Select Average in the Calculation field.
Step 2. Enter an expression for the Average point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset 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.
Important: Average points are not supported in redundancy.
7-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Select Average in the Calculation field:
Select Average in the Calculation field of the Virtual tab:
Point browser
menu
Expression
dialog
Point menu
Step 2. Enter an expression for the Average point:
Enter an expression that calculates the value of the Average point in the Expression
field on the Virtual tab of the Point Properties dialog box..
The expression may contain:
One or more Point IDs as well as
Constant values, operations, and functions.
Step 3. Define a trigger point for the Average point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Average point updates depends on whether or not
you defined the trigger point as follows:
Trigger point The Value of the Average Point is
Updated When the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
GFK-1180J Configuring Virtual Points 7-27
Step 4. Define a reset point for the Average point:
Enter a Point ID in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Average point is reset as follows:
If: And: Then:
An Initial
Average Point
Value is
The Current
value of the
Expression is
The Average point value
is reset to the:
When the trigger point is not defined
1 Not defined Unavailable Zero
2 Not defined Available Current value of the source
point
3 Defined Unavailable Initial value
4 Defined Available Average of the source and
initialized value
When the trigger point is defined
2 Not defined Unavailable*
1 Defined Initial value*
* When the trigger point is defined, the result will either be the source value
or the average of the source and initialized value.
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.
Steps to define the Max Capture point are:
Step 1. Select Max Capture in the Calculation field.
Step 2. Enter an expression for the Max Capture point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset point.
Important: Max Capture points are not supported in redundancy.
7-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Select Max Capture in the Calculation field:
Select Max Capture in the Calculation field on the Virtual tab of the Point
Properties dialog box.
Point browser
menu
Expression
dialog
Point menu
Step 2. Enter an expression for the Max Capture point:
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.
Step 3. Define a trigger point for the Max Capture point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Max Capture point updates depends on whether or
not you defined the trigger point as follows:
Trigger point The Value of the Max Capture Point is
Updated When the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
GFK-1180J Configuring Virtual Points 7-29
Step 4. Define a reset point for the Max Capture point:
Enter a Point Id in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Max Capture point is reset as follows:
If; And: Then:
An Initial Max
Capture Point
Value is
The Current
value of the
Expression is
The Max Capture point
value is reset to the:
When the trigger point is not defined
1 Not defined Unavailable Smallest possible value for
the point type. e.g. for INT
the value is -32768
2 Not defined Available Current value
3 Defined Unavailable Initial value
4 Defined Available Whichever has the Max
value
When the trigger point is defined
1 Not defined Smallest possible value for
the point type. e.g. for INT
the value is -32768
2 Defined Initial value
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-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Steps to define the Min Capture point are:
Step 1. Select Min Capture in the Calculation field.
Step 2. Enter an expression for the Min Capture point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset point.
Important: Min Capture points are not supported in redundancy.
Step 1. Select Min Capture in the Calculation field:
Select Min Capture in the Calculation field on the Virtual tab of the Point
Properties dialog box.
Point browser
menu
Expression
dialog
Point menu
Step 2. Enter an expression for the Min Capture point:
Enter an expression that calculates the value of the Min Capture point.
The expression may contain:
One or more Point IDs along with
Constant values, operations, and functions.
Step 3. Define a trigger point for the Min Capture point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Min Capture point updates depends on whether or
not you defined the trigger point as follows:
Trigger point The Value of the Min Capture Point is
Updated When the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
GFK-1180J Configuring Virtual Points 7-31
Step 4. Define a reset point for the Min Capture point:
Enter a Point Id in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Min Capture point is reset as follows:
If: And: Then:
An Initial Min
Capture Value is
The Current
value of the
Expression is
The Min Capture point
value is reset to the:
When the trigger point is not defined
1 Not defined Unavailable Initial value
2 Not defined Available Current value
3 Defined Unavailable Max possible value for the
point type. E.g. for INT the
value is +32767
4 Defined Available Whichever has the Min value
When the trigger point is defined
1 Not defined Max possible value for the
point type. E.g. for INT the
value is +32767 for INT the
value
2 Defined Initial 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,
the Trans_High Accum 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.
Example
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.
Steps to define a Trans High Accum point are:
Step 1. Select Trans-High Accum in the Calculation field.
Step 2. Enter an expression for the Trans-High Accum point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset point.
7-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Important: Transition points are not supported in redundancy.
Step 1. Select Trans-High Accum in the Calculation field:
Select Trans_High Accum in theCalculation Type field on the Virtual tab.
Point browser
menu
Expression
dialog
Point menu
Step 2. Enter an expression for the Trans-High Accum point:
Enter an expression in the Expression field on the Virtual tab of the Point Properties
dialog box.
Result: The expression will be monitored for transitions.
The expression may contain:
One or more Point IDs as well as
Constant values, operations, and functions.
Step 3. Define a trigger point for the Trans-High Accum point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Trans-High Accum point updates depends on
whether or not you defined the trigger point as follows:
Trigger point The Value of the Min Capture Point is
Updated When the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
GFK-1180J Configuring Virtual Points 7-33
Step 4. Define a reset point for the Trans-High Accum point:
Enter a Point ID in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Trans-High Accum point is reset as follows:
If: And: Then:
An Initial
Trans High Accum
Value is
The Current
value of the
Expression is
The Trans High Accum
point value is reset to the:
When the trigger point is not defined
1 Not defined Unavailable Zero
2 Not defined Available Zero
3 Defined Unavailable Initial value
4 Defined Available Initial value
When the trigger point is defined
1 Not defined Zero
2 Defined Initial value
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 point's value.
In addition, applications may change the value of an Equation w/Override point. The
changed value remains in effect until one of the source points in the Expression changes
and the Expression is recalculated, or until an application supplies a new value for the
point.
Steps to define equation w/Override points include:
Step 1. Select Equation w/Override in the Calculation field.
Step 2. Enter an expression for the Equation w/Override point.
Step 3. (Optional) Define a trigger point.
Step 4. (Optional) Define a reset point.
7-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Select Equation w/Override in the Calculation field.
Select Equation w/Override in the Calculation field on the Virtual tab of the Point
Properties dialog box.
Point browser
menu
Expression
dialog
Point menu
Virtual TabPoint Properties Dialog Box
Step 2. Enter an expression for the Equation w/Override point:
Enter an expression in the Expression field on the Virtual tab of the Point Properties
dialog box.
Result: The expression 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 for defining an expression are:
1. Avoid introducing loops (circular references between points) in your
expressions.
Example of what to AVOID:
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.
2. Use proper formatting for array points.
Example of the correct format
VIRTUAL_PT1 = DEVICE_PT[0] / 2.0
3. 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'
GFK-1180J Configuring Virtual Points 7-35
Step 3. (Optional) Define a trigger point for the Equation w/Override point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the equation w/override updates depends on whether or
not you defined the trigger point as follows:
Trigger point The Value of the Equation w/Override is
Updated When the Value of the:
Defined Trigger point is updated.
Not defined Value of the source point in the Expression
field is updated.
Step 4. (Optional) Define a reset point for the Equation w/Override point:
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Equation /Override point is reset as follows:
If: And: Then:
An Initial Equation
w/Override Point
Value is
The Current
value of the
Expression is
The Equation w/Override
point value is reset to the:
When the trigger point is not defined
1 Not defined Unavailable Zero
2 Not defined Available Current value
3 Defined Unavailable Current value
4 Defined Available Current value
When the trigger point is defined
1 Not defined Zero
2 Defined Initial value
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.
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.
7-36 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Time is stored in the number of seconds since 00:00:00 on J anuary 1, 1970 GMT
(Greenwich Mean Time). If you computer's clock is set for another time zone, this value
is translated accordingly. For example, if your computer's clock is set for Eastern
Standard Time, the base time is 19:00:00 31 December 1969.
Steps to define a Timer/Counter point are:
Step 1. Define the point type.
Step 2. Select Timer/Counter in the Calculation field.
Step 3. Enter an expression for the Timer/Counter point.
Step 4. Define the Timing for the Timer/Counter point.
Step 5. (Optional) Define a reset point.
Step 1. Define the Point Type for 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.
General TabPoint Properties Dialog Box
Data type and Element for
Timer/Counter point.
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
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.
GFK-1180J Configuring Virtual Points 7-37
Step 2. Select Timer/Counter in the Calculation field:
1. Select the Virtual tab.
2. Select Timer/Counter in the Calculation Type field.
Point browser
menu
Expression
dialog
Point menu
Virtual TabPoint Properties Dialog Box
Step 3. Enter an expression for the Timer/Counter point:
Enter an expression that will serve as the "edge trigger" for the Timer/Counter on the
Virtual tab of the Point Properties dialog box.
The expression may contain:
One or more Point IDs as well as
Constant values, operations, and functions.
Step 4. Define the timing for the Timer/Counter point:
1. Enter a Start Time that is at least 00:00:01 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
2. 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.
7-38 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. Define a reset point for the Timer/Counter point:
Enter a Point ID that will cause the Timer/Counter point to be reset.
Result: At runtime, when the reset point updates, the elements of the
Timer/Counter point are reset to 0.
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.
Histogram Points
A Histogram point records the frequency at which the value of the source point,
identified in the Expression field, updates 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)
GFK-1180J Configuring Virtual Points 7-39
Steps to define a Histogram point are:
Step 1. Select Histogram in the Calculation field.
Step 2. Enter an expression for the Histogram point.
Step 3. (Optional) Define a Trigger point.
Step 4. (Optional) Define a Reset point.
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 in the Calculation field:
Select Histogram in the Calculation field on the Virtual tab.
Point browser
menu
Expression
dialog
Point menu
Virtual TabPoint Properties Dialog Box
Step 2. Enter an expression for the Histogram point:
Enter an expression in the Expression field on the Virtual tab of the Point Properties
dialog box.
Result: The expression calculates the value of the Histogram point.
The expression may contain:
One or more Point IDs as well as
Constant values, operations, and functions.
Step 3. Define a trigger point for the Histogram point:
(Optional) Enter a Point ID in the Trigger Point field.
Result: When the value of the Histogram point updates depends on whether or not
you defined the trigger point as follows:
Trigger point The Value of the Histogram is Updated
When the Value of the:
Defined Trigger point is updated.
Not defined Source point in the Expression field is updated.
7-40 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. Define a reset point for the Histogram point:
Enter a Point ID in the Reset Point field.
Result: Based on whether there is an entry in the Reset Point field, at runtime the
Histogram point is reset as follows:
If: And: Then:
An Initial Histogram
Value is
The Current
value of the
Expression is
Each Array element of the
Histogram is reset to:
When the trigger point is not defined
1 Not defined Unavailable Zero
2 Not defined Available Zero
3 Defined Unavailable Initial value
4 Defined Available Initial value
When the trigger point is defined
1 Not defined Zero
2 Defined Initial value
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:
Element Contents
HIST_CYCLE_TIME[0] X<50 (underflow bucket)
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 (overflow bucket)
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
GFK-1180J Configuring Virtual Points 7-41
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.
If the trigger point is a :
Device 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.
Virtual point There is no update criteria that can be changed.
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:
Device point that represents the condition and is configured to be updated
On Change.
Virtual point that represents the condition
7-42 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Specifying Point Measurement Units or Point Enumeration
CIMPLICITY software enables you to
Either
(For an analog device point) Select the base engineering units for an analog
device point and specify a linear or custom conversion for an analog device
point, or
(For an analog virtual point) Select the base engineering units for an analog
virtual point
Or
Configure the point as an enumeration point.
See "Point Conversions and Enumeration" in the "Configuring Device Points" chapter in
this manual for detailed information about available options and configuration.
GFK-1180J Configuring Virtual Points 7-43
About the Expression Editor
There are several places in Virtual Points 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 Edit 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 Popup Menu 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.
Tip: When you use a device Point ID in the Expression Editor for virtual points, the raw
value of the point is used by default.
7-44 CIMPLICITY User's ManualDecember 2000 GFK-1180J
If you want to use the engineering units value, enter EU_CONV(<point_id>) in the
expression.
Point ID
popup
Point's
Configuration
dialog box
New Point
dialog box
Double click an
available
operator
Input box
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.
GFK-1180J Configuring Virtual Points 7-45
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>)
AL1 or 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>)
Important: ANA is not supported for Enterprise
points.
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).
7-46 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 Rounds a floating-point expression to the nearest
integer that is smaller than the expression.
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>.
IFELSE Performs a logical if A is TRUE, then B, else C.
Format is:
If (expr1) THEN (expr2) ELSE (expr3)
Or
(expr1) ? (expr2) : (expr3)
SHL Performs a binary left shift on an expression.
GFK-1180J Configuring Virtual Points 7-47
Format is (expr1) SHL (expr2).
For example, 2 SHL 1 returns a value of 4.
Note: When SHL goes out of range the:
Point becomes unavailable.
Point Control Pane is starred.
Core status log notes that it is unavailable.
SHR Performs a binary right shift on an expression.
Format is (expr1) SHR (expr2).
For example, 2 SHR 1 returns a value of 1.
Note: When SHR goes out of range the:
Point becomes unavailable.
Point Control Pane is starred.
Core status log notes that it is unavailable.
Note: The IFELSE statement is not available from the operation keys. However, you
can enter it manually.
7-48 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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, 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-1180J Configuring Virtual Points 7-49
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-50 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Runtime Notes for Virtual Points
If the value entered is out of range for:
A global point for a selected Point Type, the value rolls over based on the data
type range.
A virtual point, the point keeps its last value and remains as such until the next
valid value (the value that is within range).
All other calculation types keep their last available value.
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.
GFK-1180J 8-1
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:
1. A Point View.
Associate a CimView screen with any point so you can quickly review its status
through the Workbench.
Configure an analog point's display characteristics for applications such as
CimView
2. Point Limits.
Specify the display range limits in applications such as CimView
Specify setpoint limits
3. Alarms for points.
Enter a basic alarm message
Configure advanced alarming including:
A detailed alarm definition
An alarm class that prioritizes the point's 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-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Point View
For any point that you configure, you can
Select a CimView screen name that will appear on that point's popup menu in the
Workbench.
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 point's popup menu in the
Workbench:
1. Click Advanced on the General tab.
2. Select the View tab that appears.
3. 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 point's 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.
Point Properties Dialog Box: View Tab
Screen CIMPLICITY associates with the point.,
e.g. the name displays on the point's popup
menu in the Workbench .
Configuring Analog Point Display Characteristics
For an analog point, you can configure the display:
J ustification,
Width and
High/Low limits.
You do this on the View tab of the Point Properties dialog box.
GFK-1180J Configuring Point View, Limits and Alarms 8-3
View Tab Displayed
To display the View tab:
1. Click Advanced on the General tab.
2. Select the View tab that appears.
Analog Point Justification when Displayed
You can specify an analog point's justification when it displays in standard CIMPLICITY
HMI software, such as CimView.
To select an analog point's 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
J ustification when point value displays in
standard CIMPLICITY applications, e.g.
CimView.
Point Properties Dialog Box: View Tab
8-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 View tab of the Point Properties dialog box.
Minimum width when point value displays in
standard CIMPLICITY applications, e.g.
CimView.
Point Properties Dialog Box: View Tab
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 Point's 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.
GFK-1180J Configuring Point View, Limits and Alarms 8-5
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.
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 J ustification 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.
Example of Analog Point Display
2 CimEdit Object Properties dialog boxText Tab
Select "Configured" when configuring a text object that
uses the point.
1 Point Properties dialog box View tab
A. Select the point's justification.
B. Enter the minimum width.
3 The point value displays in CimView.
1254387
A point's point type is UDINT
8-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Analog Display Low and Display High Limits
Display low and Display high graphics limits are used by CimView and Trending..
Low and high limits display when the point
value is used in CimView and Trending.
Point Properties Dialog Box: View Tab
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 point's 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.
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
"Configuring Range Limits" in this chapter.
GFK-1180J Configuring Point View, Limits and Alarms 8-7
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.
For device and virtual analog points, you can specify:
Range limits and
setpoint limits.
You do this on the Limits tab of the Point Properties dialog box.
Displaying the Limits Tab
The Limits tab is available for a point's advanced general configuration.
To display the Limits tab:
1. Click Advanced on the General tab of the Point Properties dialog box.
2. Select the Limits tab that appears if you are configuring an analog point.
Exclude
meaningless data.
Define range for
allowed setpoints.
Point Properties Dialog Limits Tab
8-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
2. Enter the low and high limits in the Range limits box for the converted value of
the point.
Exclude meaningless data.
Point Properties Dialog Limits Tab
Values below the low range limit and above the high range limit will display as
the point unavailable value.
Note: Range limits apply to only the first element of n array point.
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 point's 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.
GFK-1180J Configuring Point View, Limits and Alarms 8-9
Guidelines for Unavailable Values during Runtime
When the project is running, values exceeding the range limits are handled as follows:
If a range limit is exceeded at runtime:
The point value on CimView screens displays the default text until the point
comes back within raw limits.
Point Control Panel displays asterisks (******) for the point value until the
point comes back within raw limits.
If a 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 point's value first exceeds its range limits.
When the point value returns to within its range limits, the Alarm State
will be set to Normal.
NO No alarm will be generated.
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.
Define range for allowed setpoints.
Point Properties Dialog Limits Tab
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-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarms in Point Configuration
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 point's 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.
Step 1. Select the Alarm tab.
Step 2. Enter a basic alarm message.
Step 3. Enter basic alarm limits.
Step 1. Select the Alarm Tab
Step 1. Select the Alarm tab:
One field displays when you first select the Alarm tab..
Alarm TabBasic ViewFirst Opened
GFK-1180J Configuring Point View, Limits and Alarms 8-11
Step 2. Enter a Basic Alarm Message
Step 2. Enter a basic alarm message:
1. Enter a message in the Alarm Message field that will be displayed with the
alarm in AlarmViewer. This message may contain text plus variable information
that is determined when the alarm is generated.
The Advanced Alarm tab (and associated tabs) displays.
2. Click Basic to display only the Alarm message and Alarm limits fields.
Result: The Alarm tab converts to basic view, including the Alarm Message and
basic Alarm Limits fields. The associated tab Alarm tabs disappear.
8-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Note: You can type in variables for the alarm message or select them from the field's
popup menu. See "Alarm Definition" in this chapter. However, using several of the
available alarm message variables can involve advanced configuration.
Step 3. Enter 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.
Step 3. Enter basic alarm limits:
Enter one of the following types of limits based on whether you are configuring an analog
or Boolean point.
Enter 1 to 4 limits for an analog point.
Select either 1 or 0 for a Boolean point.
Point Properties Dialog Box Alarm Tab (Basic)
Analog point
Boolean point
GFK-1180J Configuring Point View, Limits and Alarms 8-13
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. Click Advanced.
The Advanced Alarm tab appears.
A detailed alarm definition can be entered or changed and be given an assigned Alarm
Class and string index.
8-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring the Advanced Alarm Tab
Note: You can configure a basic alarm message that has absolute limits in basic or
advanced configuration.
The advanced Alarm tab provides you with the ability to enter:
A detailed alarm definition.
An alarm class that prioritizes the point's alarm.
Criteria for evaluating the alarm values.
Alarm limit values.
An alarm delay.
The specification to log the alarm.
A deadband that defines the tolerance for alarm conditions.
A help file.
Note: You create an event alarm in the Alarms folder. See the "Alarm Configuration"
chapter in this manual for details. You can modify point alarms in both the Point
Properties dialog box and the Alarm Definition dialog box in the Alarms forlder.
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:
Message with optional variables.
Class.
String.
Point Properties Dialog Box Advanced Alarm Tab
GFK-1180J Configuring Point View, Limits and Alarms 8-15
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. The total
display length for all fixed text and variables is 80 characters.
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 field's popup menu. Type
them all as capital letters (CAPS).
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.
Example
An alarm string is configured so that the string for
Warning High is WARNING and
Alarm High is EMERGENCY.
The Alarm High and Warning High limits are 400 and 350 degrees.
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
8-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
If the temperature goes to 402 degrees, the alarm will be updated and the
message will read:
CONDITION: EMERGENCY - TEMP IS AT 402 DEGREES
2. Enter an Alarm Class to group alarms with similar characteristics. An alarm's
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.
Important: If you specify an Alarm Class, you must specify an Alarm
Message.
3. Enter a String Index number to identify the alarm text, if you are using
%STATE in your alarm message.
2 The associated
text appears
as the Alarm
Limits
1 Enter the String Index
When %STATE is used:
Alarm String popup
Select an Alarm
String browser
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
GFK-1180J Configuring Point View, Limits and Alarms 8-17
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. Click 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.
4. Select the Alarm Class tab.
5. Name the new class in the Class ID field.
6. (Optional) Describe the class.
7. Select a priority number in the Order field. CIMPLICITY HMI gives alarms
with a 1-order number the highest priority.
8-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
Normal State
Alarm State
Acknowledged State
GFK-1180J Configuring Point View, Limits and Alarms 8-19
Step 3. Select sound for the alarm:
1. (Optional) Select the Audio tab.

Wave path and file
Beep
specifications
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 on the Audio tab
of the Alarm Class Configuration dialog box..
B. Find the .WAV file you want to use in the Windows Open dialog box.
Beep
A. Enter a Frequency between 37 and 32767 on the Audio tab of the Alarm
Class Configuration dialog box. 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.
8-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
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 point's value is updated.
Rate of Change Detect either a faster or slower than expected change in the
value of a point.
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 point's value is updated, its current value is compared with the
alarm values. An alarm is generated when the point's value transitions from one
Alarm State to another.
The transitions are:
State Description
Alarm High Point value Alarm High value.
Warning High Alarm High value >Point value Warning High
value
Normal Warning High value >Point value >Warning
Low value
Warning Low Warning Low value Point value >Alarm Low
value
Alarm Low Point value Alarm Low value
GFK-1180J Configuring Point View, Limits and Alarms 8-21
If the point is in normal state, the Point Manager resets alarms for the point.
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 Empty
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.
Note: If the point has:
Engineering units (EU) and
Deviation alarming,
an alarm is generated when the difference between the:
Current converted value of the point and
Converted value of the deviation point (if the deviation point also has
EU)
exceeds an alarm limit.
8-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
On Update Alarming
On Update alarming is used to generate an alarm whenever the point's value is updated.
If you choose the On Update alarm criteria, you cannot define Alarm Values. Each time
the point's value is updated, an alarm is generated.
Rate of Change Alarming
Important: Unsigned analogs (UDINT, UINT, USINT, 3D_BCD and 4D_BCD) cannot
have rate of change alarms. If you try to configure a rate of change alarm you will see an
"Invalid point type for rate of change alarm" error message.
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. Make sure Delay alarm has not been checked.
The Delay alarm checkbox disappears when Rate of Change is selected as the
alarm criteria.
2. Select Rate of Change in the Alarm Type field on the advanced Limits tab.
3. Select the time interval from:
Seconds
Minutes
Hours
4. 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.
Important: The minimum Rate of Change interval is 5 seconds.
GFK-1180J Configuring Point View, Limits and Alarms 8-23
5. Define the values for the Alarm Limits.
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 Slower than expected changes
In the Alarm Limits, you can specify:
Values that are To check for:
Positive Increasing values
Negative Decreasing values.
Use the following table as a guide:
Alarm Limit Limit Value
Rate of Change
value is ...
Point value is ....
Alarm High Positive Alarm High Increasing too fast
Alarm High Negative Alarm High Decreasing too fast
Warning High Positive Warning High Increasing too fast
Warning High Negative Warning High Decreasing too fast
Warning Low Positive Warning Low Increasing too slowly
Warning Low Negative Warning Low Decreasing too slowly
Alarm Low Positive Alarm Low Increasing too slowly
Alarm Low Negative Alarm Low Decreasing too slowly
8-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J Configuring Point View, Limits and Alarms 8-25
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 or Deviation alarms.
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 on the Alarm tab.
2. Select for the time interval one of the following:
Seconds
Minutes
Hours
3. Select seconds or minutes.
Important: The minimum interval is 5 seconds.
When the alarm condition is detected for the point the:
1. Point Manager sends the information immediately to the Alarm Manager and all
other Point Management Interested Processes such as CimView and the Event
Manager.
2. Alarm Manager generates the Alarm Delay.
Note: Delay alarm is not available when Rate of Change criteria is selected.
8-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Log Alarm Checked in the Point Properties Dialog Box
You can select to log a device point's data on the advanced General tab in the Point
Properties dialog box.
To specify alarm logging:
1. Check if and when you want an alarm to be logged in the Alarm Logging box on
the Alarm tab. You can select any or all of the options:
Generate
Acknowledge
Delete
Reset
The alarm will be logged when any of the checked actions occur.
Click either to add the point to the default
CIMPLICITY ALARM_LOG.
2. Click OK or Apply.
Result: CIMPLICITY adds the point to its default ALARM_LOG. You can apply
these and more specifications in the Database Logger.
See the "Database Logger" chapter in this manual for information about configuring
log tables.
GFK-1180J Configuring Point View, Limits and Alarms 8-27
Alarm Conditions 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 point's 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).
If the point has EU, the EU converted deadband is used for all calculations.
Alarm Viewer 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".
An Alarm help file:
Is an ASCII text file.
Can be up to sixty (60) lines.
Can have a maximum of 70 bytes per line. (A character can be 1 or 2 bytes,
depending on the system you are using.)
Can be used for several points.
Files are located in the %SITE_ROOT%\alarm_help directory.
Example
You create a help file in Notepad that you save as AlrmHelp.txt. Rename the file
AlrmHelp.hlp or Alrmhelp.txt.hlp (to distinguish it from compiled help files).
8-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
Note: You can also configure alarm routing in the point alarm's Alarm Definition dialog
box in the Alarms folder. The configuration displays in both dialog boxes. See the "Alarm
Configuration" chapter in this manual for details about configuring alarms in the Alarms
folder.
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. Click Add. The role will move over to Configured Roles For Alarm column.
4. Click OK.
Alarm Routing: Add Roles through Point Properties
Result: Users assigned the selected role can now view alarms generated by the
point.
GFK-1180J Configuring Point View, Limits and Alarms 8-29
Roles Removed from Viewing Alarms
1. Select the Alarm Routing tab in the Point Properties dialog box.
2. Select a user role in the Configured roles for alarms column.
3. Click Remove. The role will move over to the Available Roles column.
4. Click OK.
Alarm Routing: Remove Roles through Point Properties
Result: Users assigned the selected role can no longer view alarms generated by
the point.
8-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
News Roles Created that are Available to View Alarms
To create a new role:
1. Click New.
The New Role dialog box opens.
2. Enter the new Role ID.
3. Click 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. Click OK to create the new Role and return to the Alarm Routing properties.
GFK-1180J Configuring Point View, Limits and Alarms 8-31
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
Automatic actions.
Manual reset permission.
Deletion requirements.
Maximum stacked alarms.
You have the ability in CIMPLICITY HMI to enter your specifications for each stage in
the sequence.
Note: You can also configure alarm options in the point alarm's Alarm Definition dialog
box in the Alarms folder. The configuration displays in both dialog boxes. See the "Alarm
Configuration" chapter in this manual for details about configuring alarms in the Alarms
folder.
Automatic Actions
Automatic actions on the Alarm Options tab include:
Alarm Repeats.
Automatic acknowledgements.
Automatic reset.
8-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 Alarm Line Printer (AMLP) processes. Setting a
repeat timeout will cause the point's alarm to be reprinted on the Alarm Line Printer until
it is acknowledged, reset or deleted.
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 Automatic Acknowledgements
An alarm can be acknowledged manually or automatically
Alarm acknowledgement is configured on the Alarm Options tab of the point's 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
acknowledge 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-1180J Configuring Point View, Limits and Alarms 8-33
Alarm 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 point's Properties
dialog box.
To allow the alarm 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 be:
Manually reset (if manual reset is allowed) or
Reset by the process that detected the condition that generated the alarm.
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 .
8-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 point's Properties dialog
box, the alarm will not be deleted until it is acknowledged and reset (these actions may
occur in any order).
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 Point Properties dialog box.
An entry of 0 means that the alarm will not be stacked.
At run-time, as occurrences are generated for the alarm, occurrences 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-1180J 9-1
Changing the Workbench Point
Display
About the Workbench Point Display
The Workbench provides you with a central location in which you can:
Customize the point list display in your project.
Display selected fields associated with the points
Note: You can also use the Workbench to monitor runtime behavior, to include:
Opening the Point Control Panel to monitor and control runtime point behavior.
Displaying a Quick Trend chart for a selected point.
See "Using the Workbench" in this manual for more information.
Customizing the Point List in the Workbench
You can display, in the Workbench right pane, a list of:
All of the points in your project or
Selected points.
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. Click View on the Workbench menu bar.
B. Select AutoFill if there is no check mark on its left side.
9-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. Click View on the Workbench menu bar.
B. Select Search.
GFK-1180J Changing the Workbench Point Display 9-3
Method 2
A. Place the cursor in the Workbench right pane.
B. Click the right mouse button.
C. Select Search.
Method 3
Click the Search button on the Workbench toolbar.
The Point search dialog box appears when you use any method.
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.
Use wild cards for any
entry:
?one character.
*multiple characters.
Point Search Dialog Box Entry Examples
One or more criteria.
Open a
Browser
window.
Point to list.
Description that appears
in a Point Properties
dialog box, General tab,
Description field.
9-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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-1180J Changing the Workbench Point Display 9-5
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.
Browser Window Examples
Resource browser
Display
filters.
Double-click
to select.
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-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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-1180J Changing the Workbench Point Display 9-7
Method 2
A. Click View on the Workbench menu bar.
B. Select Field Chooser.
View Drop Down Menu
Method 3
Click Field Chooser 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
Moves field further
right in the pane
Fields that will not display Fields that will display
Moves field further
left in the pane
Indicates if point has
changed and project
needs configuration
update
Shows when point
was last modified
3. Select a field in the Available field column that you want to add to your display.
4. Click 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. Click Remove. The field will move over to the Available field column.
9-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
7. 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
8. Click OK. The fields display from left to right in the order you specified.
Reviewing Point Field Definitions in the Workbench
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 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.
GFK-1180J Changing the Workbench Point Display 9-9
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.
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.
9-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J 10-1
Using Point Attributes
About Point Attributes
CIMPLICITY HMI provides you with different types of point attributes that help you
evaluate different perspectives of a point's status.
The types of available point attributes are:
User defined.
Runtime.
Quality.
Configuration.
Attributes can be used in expressions in:
Event Editor,
CimEdit for CimView,
Point Control Panel opened from a CimView screen,
Custom applications making point requests, and
BCE scripts.
CIMPLICITY lists the attributes that are available to each point in the Select a Point
Browser. You can open the Select a Point Browser from any expression field. See page
10-11 for details.
10-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
User Defined Point Attributes
CIMPLICITY HMI enables a project developer to create sets of point attributes that use
16 bits and that can be applied to one or more points in a project.
Attribute sets are a powerful tool for aiding in point evaluation.
You can
1. Create several user defined fields, (attribute definitions) within a set, then
2. Associate the attribute set with a point. (The same attribute set can be associated
with more than one point.), then
3. Associate your user-defined fields with that point in expressions in:
Event Editor,
CimEdit for CimView,
Point Control Panel opened from a CimView screen,
Custom applications making point requests, and
BCE scripts.
Exampl e
The processes for a machine point called MACH_TEMP are different depending on
whether or not a man is online. You:
1. Create an attribute set call PROC.
2. Include an attribute field called MOL (man-on-line).
3. Associate the attribute set PROC with the machine's MACH_TEMP point.
4. Create a CimView screen object that displays the value of the MOL field.
During runtime, the CimView screen will alert users whether or not a man is online
for the point MACH_TEMP provided your application has set the attribute.
USER_FLAGS (Attribute)
A CIMPLICITY HMI provided attribute, USER_FLAGS, enables any point to access its
entire 16-bit user set at once. This capability does not require additional configuration.
Associated Point Type Device or Virtual
Access Read only
Value Type UINT
Expression Syntax PointID.USER_FLAGS
The value of USER_FLAGS can be logged. See the "Configuring the Database Logger"
chapter in this manual for details about logging point attributes.
GFK-1180J Using Point Attributes 10-3
Viewing a Project's Existing Point Attribute Sets
The Workbench displays the point attribute sets in the right pane.
To view a project's exi sting point attribute sets:
1. Expand the Points folder in the left pane of the Workbench.
2. Select Point attributes .
Result: The Workbench right pane displays the list of Point attribute sets in the right
pane.
Creating a New Point Attribute Set
Steps to create a new point attribute set include:
Step 1. Open the New Attribute Set Dialog box.
Step 2. Name a new attribute set.
Step 3. Add fields to the new attribute set.
Step 4. Associate the attribute set with one or more points.
Step 5. Use an attribute set, for example, in a CimView screens.
Step 1. Open a New Attribute Set dialog box
In the Workbench
1. Expand the Points folder in the left pane of the Workbench.
2. Do one of the following:
Method 1
Double-click Attribute Sets.
Method 2
A. Select Attribute Sets.
B. Click File on the Workbench menu bar.
C. Select New.
Method 3
A. Select Attribute Sets.
B. Press CTRL+N on the keyboard.
Method 4
Click the New icon on the Workbench toolbar.
Method 5
A. Right-click an attribute set in the Workbench right pane.
A Popup menu appears.
B. Select New.
10-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Popup menu
Open a New Attribute Set Dialog Box
Drop down menu
Keyboard
Ctrl+N
New object button
In the advanced General tab of a Point Properties dialog box
CIMPLICITY HMI provides you with an easy way to create a new attribute set
through the Point Properties dialog box while you are configuring a point.
1. Select the General tab in the Point Properties dialog box for the point you are
configuring.
2. Click Advanced to put the General tab in advanced mode.
3. Click the Popup button to the right of the Attribute Set field.
4. Select New from the popup menu.
Result: The New Attribute Set dialog box opens when you use any method.
GFK-1180J Using Point Attributes 10-5
Step 2. Name a New Attribute Set
1. Enter the name of the new attribute set in the Set Name field.
The name can:
Be up to 32 characters long.
Have alphanumeric characters and underscores only
Alphabetic characters can be in any position.
Digits can be in any position other than the first position.
Underscores can be in any position.
2. Click OK .
Result: The system verifies that the attribute set name does not already exist, and that
no invalid characters have been used.
If the attribute set name you entered is valid, an Attribute Set dialog box for the new
attribute set opens.
10-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Add Fields to the new Attribute Set
1. Click Add in the Attribute Set dialog box.
A blank Attribute Field dialog box opens.
2. Enter a name in the Field name field.
The name can:
Be up to 16 characters long.
Have alphanumeric characters and underscores only:
Alphabetic characters can be in any position.
Digits can be in any position other than the first position.
Underscores can be in any position.
3. Enter the bit position at which the attribute should start in the Start field.
You can choose from 0 through 15.
4. Enter the size of the attribute field in the Size field.
The allowable size depends on the position at which you started the field.
Exampl e
If you enter 7 in the Start field, the maximum field size is 9.
5. Check any of the following checkboxes to define the field characteristics.
Checkbox When checked
Save on shutdown Attribute values will be preserved across project
restarts.
Writeable device flag Data will be sent to the associated devcom when the
attribute field is set.
Read only Restricts the field to read-only when it is displayed
on a CimView screen.
Restrict write by role Allows only the roles that have been granted Modify
attribute privileges in the Roles Properties dialog
box to perform a setpoint on this attribute field.
See the "Role Configuration" chapter in the
CIMPLICITY HMI User's Manual (GFK-1180) for
information about granting Modify attribute
privileges.
GFK-1180J Using Point Attributes 10-7
6. Click OK .
The Attribute Field dialog box closes and the Attribute Sets dialog box displays
the Field Name with its Field Start and Size information.
7. Continue to add attributes until you have listed all the attributes that should be
associated with a selected point.
Note: Step 4 (next) assumes that you know how to configure points. For in depth
information about configuring points, see the points chapters in the CIMPLICITY HMI
User's Manual (GFK-1180).
Step 4. Associate the Attribute Set with One or More Points
1. Open the Properties dialog box for the point with which you want to associate
the point set.
2. Select the General tab.
3. Enter the Attribute Set name that you want to associate with the point in the
Attribute Set field.
.
Result: The point now has an associated attribute set. Each field in the set can be used
to associate additional information with the point.
Note: Step 5 (next) assumes that you know how to configure CimEdit screens. For in
depth information about configuring CimEdit, see the CIMPLICITY HMI CimEdit
Manual (GFK-1396).
10-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. Use an Attribute Set Field, for Example, in a CimView
Screen
1. Open the CimEdit screen on which the attribute set will be used.
2. Create the object that will contain an attribute field value.
3. Display the relevant expression field in the object's Properties dialog box.
4. Enter Point ID.Attribute Field Name.
Exampl e
A Point ID is call TANK_TEMP.
An attribute set that was assigned to TANK_TEMP is called S90_LINE_PROC.
A field in the attribute set is MACH_UP.
You want to create an object in CimEdit that shows the status of the MACH_UP
attribute for TANK_TEMP.
You enter TANK_TEMP.MACH_UP in a relevant expression field in the object's
Properties dialog box.
Result: During runtime, the object will reflect the field value and will adhere to the
field characteristics that were specified in the Attribute Field dialog box.
GFK-1180J Using Point Attributes 10-9
Editing an Existing Attribute Set
To edit an existing attribute set:
In the Workbench
1. Expand the Points folder in the left pane of the Workbench.
2. Select Attribute Sets.
3. Do one of the following.
Method 1
Double click an attribute set in the right pane of the Workbench.
Method 2
A. Select an attribute set in the right pane of the Workbench.
B. Click the right mouse button.
C. Select Properties from the popup menu.
Method 3
A. Select an attribute set in the right pane of the Workbench.
B. Click the Properties icon on the Workbench toolbar.
Popup menu
Opening an Existing Point Attribute Set Dialog Box
Drop down menu
Keyboard
Alt+Enter
Properties button
In the advanced General tab of a Point Properties dialog box
CIMPLICITY provides you with an easy way to edit an existing attribute set through
the Point Properties dialog box while you are configuring a point.
1. Select the General tab in the Point Properties dialog box for the point you are
configuring..
2. Click Advanced to put the General tab in advanced mode.
3. Click the Browse button to the right of the Attribute Set field to select the
attribute set you want to use.
4. Click the Popup button to the right of the Attribute Set field.
10-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
5. Select Edit from the popup menu.
The Attribute Set dialog box associated with the selected attribute set opens.
Continue in the open Attribute Set dialog box
5. Double-click a Field Name.
The Attribute Field dialog box for the selected field opens.
6. Edit any of the fields, except the Field Name.
7. Click OK.
Result: The Attribute Field dialog box closes and the field is changed.
GFK-1180J Using Point Attributes 10-11
Attributes Applied
CIMPLICITY provides four categories of point attributes:
User
Quality
Runtime
Configuration
These attributes can be referenced in many CIMPLICITY applications in the same
fashion as a configured point ID. See page 10-1.
The general syntax for referencing a point attribute is:
<point ID>.<point attribute>
Where
<point ID> is a normally configured point ID
<point attribute> is one of the point attributes described in this chapter
You can also use the CIMPLICITY Point browser to simply select an attribute that is
available for a selected point and apply it to the application in which you are working.
Exampl e
You have a device point called, for example, S90_550.
You want to review the point's values and the time that the values are read on a CimView
screen. See page 10-20 for details about the TIMESTAMP attribute.
The following steps enable you to easily configure the point attribute.
Step 1. Configure the point value display for CimView.
Step 2. Configure the timestamp display for CimView.
Step 3. View the point's values and timestamps in CimView.
Step 1. Configure the Point Value Display for CimView
1. Click the Text button in CimEdit.
2. Place the cursor on the screen where you want the text object to appear.
The Properties - Object dialog box opens.
3. Select the Text tab.
4. Enter Point Value in the String field.
5. Open the Select a Point browser as follows:
A. Click the Menu button to the right of the Expression field.
B. Select Browse Point ID from the popup menu.
The Select a Point browser opens.
10-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
6. Select S90_550 from the list of points.
7. Click OK to close the browser.
S90_550 appears in the Expression field.
8 Click OK to close the Properties - Object dialog box.
Result: The text Point Value appears on the CimEdit screen.
GFK-1180J Using Point Attributes 10-13
Step 2. Configure the Timestamp Display for CimView
1. Click the Text button in CimEdit.
2. Place the cursor on the screen where you want the text object to appear.
The Properties - Object dialog box opens.
3. Select the Text tab.
4. Enter Point Time in the String field.
5. Open the Select a Point browser as follows:
A. Click the Browser button to the right of the Expression field.
B. Select Browse Point ID from the popup menu.
The Select a Point browser opens.
6. Select S90_550.TIMESTAMP as follows:
A. Expand S90_550 in the list of points.
B. Select TIMESTAMP in the list that appears.
Point
expanded.
Tree under
point.
10-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
7. Click OK to close the browser.
S90_550.TIMESTAMP appears in the Expression field.
8 Click OK to close the Properties - Object dialog box.
Result: The text Point Time appears under Point Value on the CimEdit screen.
GFK-1180J Using Point Attributes 10-15
Step 3. View the Point's Values and Timestamps in CimView
Click the Test Screen button on the CimEdit toolbar.
Result: The Point value displays; the time the value was read displays below.
10-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Quality Attributes
CIMPLICITY provides attributes that enable a user to assess the quality of a point in
order to evaluate the quality of the data it sends or receives.
The quality attributes are:
QUALITY
QUALITY.MANUAL_MODE
QUALITY.ALARMED
QUALITY.ALARMS_ENABLED
QUALITY.DISABLE_WRITE
QUALITY.IS_IN_RANGE
QUALITY.LAST_UPD_MAN
QUALITY.STALE_DATA
QUALITY (Attribute)
QUALITY is not configuration data, as with value attributes, but is used to dynamically
change the behavior of a point, or dynamically reflect runtime information about the
point.
QUALITY is the sum of all its current binary values in decimal format.
Associated Point Type Device
Access Read Only
Value Type UINT
Expression Syntax PointID.QUALITY
QUALITY can also be configured to display the state of each of its individual indicators.
Following are the CIMPLICITY HMI read-only indicators located at each of the 16 bit
positions.
Indicator Bit Position
MANUAL_MODE 0x01
LAST_UPD_MAN 0x02
IS_AVAILABLE 0x04
IS_IN_RANGE 0x08
STALE_DATA 0x10
ALARMS_ENABLED 0x20
DISABLE_WRITE 0x40
ALARMED 0x80
GFK-1180J Using Point Attributes 10-17
QUALITY.MANUAL_MODE (Attribute)
QUALITY.MANUAL_MODE can be used as an attribute that references the QUALITY
indicator called MANUAL_MODE.
QUALITY.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 point's 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 system's integrity.
Exampl e
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 attributes 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.
Associated Point Type Device
Access Writefor users who have Modify attributes
privileges. These privileges are enabled in
the Roles Properties dialog box. See the
"Role Configuration" chapter in this
manual.
Value Type Boolean
Expression Syntax PointID.QUALITY.MANUAL_MODE
Description Enables a user to place a point in manual
mode. The user can then manually set the
point's value.
1The point is in manual mode.
0The point is actively connected to a
device.
QUALITY.ALARMED (Attribute)
Associated Point Type Device or Virtual for system wide use
Access Read only
Value Type Boolean
Expression Syntax PointID.QUALITY.ALARMED
Description Reflects whether a point is currently in an
alarm state including exceeding range limits
1The point is in an alarm state.
0The point is not in an alarm state
10-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
QUALITY.ALARMS_ENABLED (Attribute)
Associated Point Type Device or Virtual.
Access Write
Value Type Boolean
Expression Syntax PointID.QUALITY.ALARMS_ENABLED
Description Enables a user to control the generation of
alarms other than range limit alarms and to
see if someone else disabled them.
1The alarm is enabled.
0The alarm is disabled.
Exampl e
If someone disabled an alarm in the Point
Control Panel, QUALITY.ALARMS_ENABLED
should reflect that by becoming 0.
See the "Using the Point Control Panel"
chapter in this manual for details about
enabling and disabling alarms in the Point
Control Panel.
QUALITY.DISABLE_WRITE (Attribute)
Associated Point Type Device or Virtual
Access Writefor users who have Modify attributes
privileges. These privileges are enabled in
the Roles Properties dialog box. See the
"Role Configuration" chapter in this
manual.
Value Type Boolean
Expression Syntax PointID.QUALITY.DISABLE_WRITE
Description Enables a user to inhibit writes via Point
Management to a point.
1Writing is disabled.
0Writing is enabled.
QUALITY.IS_AVAILABLE (Attribute)
Associated Point Type Device or Virtual
Access Read only
Value Type Boolean
Expression Syntax PointID.QUALITY.IS_AVAILABLE
Description Displays whether or not the point is
available.
1The point is available.
0The point is not available.
GFK-1180J Using Point Attributes 10-19
QUALITY.IS_IN_RANGE (Attribute)
Associated Point Type Device or Virtual
Access Read only
Value Type Boolean
Expression Syntax PointID.QUALITY.IS_AVAILABLE
Description Reflects if a point exceeds the range limits
that are defined for it.
1The point is in range.
0The point exceeds the range limits.
See the "Configuring Point View, Limits and
Alarms" chapter in this manual for more
information about setting range limits for a
point.
QUALITY.LAST_UPD_MAN (Attribute))
Associated Point Type Device or Virtual
Access Read Only
Value Type Boolean
Expression Syntax PointID.LAST_UPD_MAN
Description Displays whether or not a value came from a
manual override.
Returned Values 1 =The value came from a manual override
0 =The value came from a device
QUALITY.STALE_DATA (Attribute)
Associated Point Type Device or Virtual
Access Read only
Configured on the General tab of the Port
Properties dialog box.
Value Type Boolean
Expression Syntax PointID.STALE_DATA
Description When Enable stale data is checked in the
Port Properties dialog box, the point will
remain available in most circumstances that
would have made it unavailable. However,
this attribute will report that the point value
is stale. It is the last known good value and
may or may not have changed.
Note: Some devices may report some points
as stale even without enabling this attribute.
Returned Values 1 =The point value is stale.
0 =The point is not known to be stale.
See "Enable Stale Data" in the "Configuring
Ports" chapter to see a table that displays a
point's availability when events occur and
Enable stale data is configured as on or off.
10-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Runtime Attributes
CIMPLICITY provides you with an attribute that enables you to view the date and time a
point's value is updated.
TIMESTAMP
Associated Point Type Device
Access Read only
Value Type System generated
Expression Syntax PointID.TIMESTAMP
Description Displays the date and time that the point's
value is updated.
Default Display MM/DD/YY HHHH:MM:SS:TTT A
Note: TTT =milliseconds; A =AM or PM
GFK-1180J Using Point Attributes 10-21
Configuration Attributes
Following is a list of configuration attributes.
$RAW_VALUE FORMAT_PREC
ACCESS_FLAG FR_ID
ACK_TOUT INIT_VALUE
ADDR LOCAL
ADDR_OFFSET MEASUREMENT_UNIT_ID
ALARM_CIRTERIA PROCESS_ID
ALARM_DELAY PTMGMT_PROCESS_ID
ALARM_HIGH POINT_SET_TIME
ALARM_HIGH_N POINT_SET_INTERVAL
ALARM_LOW POINT_STATE
ALARM_LOW_N RATE_TIME_INTERVAL
ALARM_STATE RANGE_HIGH
ANALOG_DEADBAND RANGE_HIGH_N
ANALOG_DEADBAND_N RANGE_LOW
CALCULATION_TYPE RANGE_LOW_N
CLR_TOUT REP_TOUT
CONV_TYPE RESET_POINT_ID
DEADBAND ROLLOVER_VAL
DEADBAND_N SCAN_POINT
DEL_OPT SCAN_RATE
DESCRIPTION SETPOINT_HIGH
DEVIATION_PTID SETPOINT_HIGH_N
DEVICE_ID SETPOINT_LOW
DISPLAY_LIM_HIGH SETPOINT_LOW_N
DISPLAY_LIM_HIGH_N SETPT_CHECK_PTID
DISPLAY_LIM_LOW TRIGGER_POINT
DISPLAY_LIM_LOW_N TRIGGER_TYPE
DP_FLAG TRIGGER_VALUE
EU_LABEL VARIANCE_VALUE
EU_EXPRESSION WARNING_HIGH
EU_REV_EXP WARNING_HIGH_N
EXTRA WARNING_LOW
FLAGS WARNING_LOW_N
FORMAT_WID
10-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
$RAW_VALUE
$RAW_Value
Associated Point Type All
Value Type Length of normal point
Access Same as associated point.
CIMPLICITY Field Name Raw Value
Description Provides the raw value of a point when
using point enumeration or EU conversion
(device points only).
ACCESS_FLAG
Associated Point Type All
Value Type 1 character
Access Read only
CIMPLICITY Field Name Access
Description Device read/write access.
Returned values 0 =Read only
2 =Read/Write
ACK_TOUT
Associated Point Type All
Value Type Integer
Access Read only
CIMPLICITY Field Name Acknowledge Timeout
Description Time in minutes before the point's alarm is
automatically acknowledged.
Returned Values -1=Acknowledge immediately
0=No auto acknowledge
>0=Minutes to wait for automatic
acknowledge
ADDR
Associated Point Type Device
Value Type 256 characters
Access Read only
CIMPLICITY Field Name Address
Description Actual address of the point within the
device.
GFK-1180J Using Point Attributes 10-23
ADDR_OFFSET
Associated Point Type Device
Value Type Integer
Access Read only
CIMPLICITY Field Name Address Offset
Description offset in memory from the first bit of the
Point address.
ALARM_CRITERIA
Associated Point Type All
Value Type Integer
Access Read only
CIMPLICITY Field Name Alarm Criteria
Description Method to be used for evaluating alarm
conditions.
Returned Values 1=Absolute
2 =Deviation
4 =Rate of Change
16 =On Update
ALARM_DELAY
Associated Point Type All
Value Type Integer
Access Read only
CIMPLICITY Field Name Delay Alarms
Description Determine if the generation of alarms by the
point should be delayed.
Returned Values 0 =Alarms are not delayed
1 =Alarms are delayed by the length of time
specified by the attribute
RATE_TIME_INTERVAL.
ALARM_HIGH
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Alarm High
Description High alarm limit
10-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
ALARM_HIGH_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Alarm High_N
Description High alarm limit
ALARM_LOW
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Alarm Low
Description Low alarm limit
ALARM_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Alarm Low
Description Low alarm limit
ALARM_STATE
Associated Point Type All
Value Type 2 bytes
Access Read only
CIMPLICITY Field Name Enable Alarm
Description Enable/Disable alarm.
Returned Values 0 =Disable
1 =Enable
ANALOG_DEADBAND
Associated Point Type Device
Value Type 10 characters
Access Read only
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.
GFK-1180J Using Point Attributes 10-25
ANALOG_DEADBAND_N
Associated Point Type Device
Value Type REAL
Access Read only
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.
CALCULATION_TYPE
Associated Point Type Derived (Virtual)
Value Type 1 character
Access Read only
CIMPLICITY Field Name Calc Types
Description Method for determining the derived point
value.
Returned Values 0 =Equation
1 =Delta Accumulator
2 =Value Accumulator
3 =Average
4 =Maximum
5 =Minimum
7 =Transition High Accumulator
8 =Equation with Override
9=Timer/Counter
10 =Histogram
CLR_TOUT
Associated Point Type All
Value Type Integer
Access Read only
CIMPLICITY Field Name Reset Timeout
Description Time in minutes before this point's alarm is
automatically reset.
Returned Values -1=Reset immediately
0=No automatic reset
>0=Minutes before automatic reset
10-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
CONV_TYPE
Associated Point Type Device
Value Type 2 bytes
Access Read only
CIMPLICITY Field Name Conversion Type
Description Point EU conversion type.
Returned Values 0 =None
1 =Linear conversion
2 =Custom conversion
DEADBAND
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Alarm Deadband
Description Tolerance around alarm limits.
DEADBAND_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Alarm Deadband
Description Tolerance around alarm limits.
DEL_OPT
Associated Point Type All
Value Type 2 characters
Access Read only
CIMPLICITY Field Name Deletion Requirements
Description Alarm delete options.
Returned Values AR =Acknowledge and Reset
A =Acknowledge
R =Reset
DESCRIPTION
Associated Point Type All
Value Type 40 characters
Access Read only
CIMPLICITY Field Name Description
Description Description of point
GFK-1180J Using Point Attributes 10-27
DEVIATION_PTID
Associated Point Type All
Value Type 32 characters
Access Read only
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
Associated Point Type Device
Value Type 32 characters
Access Read only
CIMPLICITY Field Name Device ID
Description Device where the point data originates.
Must be a configured Device ID.
DISPLAY_LIM_HIGH
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Disp. Limit (hi)
Description Largest value to display in CimView
screens.
DISPLAY_LIM_HIGH_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Disp. Limit (hi)
Description Largest value to display in CimView
screens.
DISPLAY_LIM_LOW
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Disp. Limit (low)
Description Smallest value to display in CimView
screens.
10-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
DISPLAY_LIM_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Disp. Limit (low)
Description Smallest value to display in CimView
screens.
DP_FLAG
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 1 character
Access Read only
CIMPLICITY Field Name Startup Condition
Description Source for the initial value of the point when
the software is started or reset.
Returned Values 0 =Not Applicable
1 =Init
2 =Saved
3 =Saved or Init
EU_LABEL
Associated Point Type All
Value Type 8 characters
Access Read only
CIMPLICITY Field Name Eng. Units
Description Units that the data represents.
EU_EXPRESSION
Associated Point Type Device
Value Type 300 characters
Access Read only
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.
GFK-1180J Using Point Attributes 10-29
EU_REV_EXP
Associated Point Type Device
Value Type 300 characters
Access Read only
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.
EXTRA
Associated Point Type All
Value Type Unsigned double integer (UDINT)
Access Read only
CIMPLICITY Field Name Extra info
Description Provides an extra field that can be used to
return additional point information in a
CIMPLICITY application.
FLAGS
Associated Point Type Device
Value Type 1 character
Access Read only
CIMPLICITY Field Name Poll After Set/ Delay Load
Bit 0 =Poll After Set
Bit 1 =Delay Load
Description Determines if polling should be done after a
setpoint.
Returned Values 0 =Do not poll (default)
1 =Scan Immediately
2 =Delay Load
3 =Scan Immediately and Delay Load
FORMAT_WID
Associated Point Type All
Value Type 2 Bytes
Access Read only
CIMPLICITY Field Name Display Width
Description Number of spaces for display of point value
in CimView.
10-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
FORMAT_PREC
Associated Point Type All
Value Type 2 Bytes
Access Read only
CIMPLICITY Field Name Display Precision
Description Precision of the display of point value in
FR_ID
Associated Point Type All
Value Type 32 characters
Access Read only
CIMPLICITY Field Name Resource ID
Description Resource ID for this point. Must be a
configured Resource ID.
INIT_VALUE
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 32 characters
Access Read only
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.
LOCAL
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type Boolean
Access Read only
CIMPLICITY Field Name Local Value
Description Determines if value is reported to Point
Manager.
Returned Values 0 =Report value
1 =Do not report value
MEASUREMENT_UNIT_ID
Associated Point Type All
Value Type 32 characters
Access Read only
CIMPLICITY Field Name Measurement unit ID
Description The base measurement unit ID configured
for the point.
GFK-1180J Using Point Attributes 10-31
PROCESS_ID
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 32 characters
Access Read only
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_PROCESS_ID
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 32 characters
Access Read only
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
POINT_SET_TIME
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 8 characters
Access Read only
CIMPLICITY Field Name Start Time
Description For Timer/Counter points, start time used by
Derived Point Processor to update the Point
Manager with information on the number of
events, cumulative duration and time of the
last HIGH event occurrence.
POINT_SET_INTERVAL
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 8 characters
Access Read only
CIMPLICITY Field Name Interval
Description The frequency at which the Derived Point
Processor updates the Point Manager with
information.
10-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
POINT_STATE
Associated Point Type Device
Value Type Boolean
Access Read only
CIMPLICITY Field Name Enabled
Description Determines if the point is enabled or
disabled.
Returned Values 0 =Disabled
1 =Enabled
RATE_TIME_INTERVAL
Associated Point Type All
Value Type Integer
Access Read only
CIMPLICITY Field Name Interval
Description The time interval for Rate of Change alarms
or Delay Alarm.
RANGE_HIGH
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Range high
Description Maximum value allowed for the converted
(or base) value of a point.
RANGE_HIGH_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Range high
Description Maximum value allowed for the converted
(or base) value of a point.
RANGE_LOW
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Range low
Description Minimum value allowed for the converted
(or base) value of a point.
GFK-1180J Using Point Attributes 10-33
RANGE_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Range low
Description Minimum value allowed for the converted
(or base) value of a point.
REP_TOUT
Associated Point Type All
Value Type Integer
Access Read only
CIMPLICITY Field Name Repeat Timeout
Description Time in minutes before the point's alarm is
automatically re-sent to alarm line printers.
The alarm will be re-sent only if it is still
active.
Returned Values 0=Never
>0=Minutes before automatic re-send
RESET_POINT_ID
Associated Point Type Derived (Virtual)/Global (Virtual)
Value Type 32 characters
Access Read only
CIMPLICITY Field Name Reset Point
Description Point that will cause this derived point to
reset. Must be a configured Point ID.
ROLLOVER_VAL
Associated Point Type Derived (Virtual)
Value Type Integer
Access Read only
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.
10-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
SCAN_POINT
Associated Point Type Device
Value Type 2 bytes
Access Read only
CIMPLICITY Field Name Update Criteria
Description Value determining when point data is passed
to the CIMPLICITY point database after the
device is read.
Returned Values 0 =Unsolicited
1 =On Change
2 =On Scan
4 =On Demand On Scan
5 =On Demand On Change
6 =Unsolicited On Change
7 =Poll Once On Change
8 =On Demand Unsolicited
9 =On Demand Poll Once
10 =On Demand Unsolicited On Change
11 =On Demand Poll Once On Change
SCAN_RATE
Associated Point Type Device
Value Type 2 bytes
Access Read only
CIMPLICITY Field Name Scan Rate
Description Frequency of point sampling. This is a
multiple of the base scan rate set for the
system.
SETPOINT_HIGH
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Setpoint high
Description Maximum value a point is allowed to be set.
GFK-1180J Using Point Attributes 10-35
SETPOINT_HIGH_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Setpoint high
Description Maximum value a point is allowed to be set.
SETPOINT_LOW
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Setpoint low
Description Minimum value a point is allowed to be set.
Note: If the Setpoint low field is
configured as zero, SETPOINT_LOW
reports it as unavailable.
SETPOINT_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Setpoint low
Description Minimum value a point is allowed to be set.
Note: If the Setpoint low field is
configured as zero, SETPOINT_LOW
reports it as unavailable.
SETPT_CHECK_PTID
Associated Point Type All
Value Type 32 characters
Access Read only
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.
Also serves as an index for the Delta
Accumulator array.
10-36 CIMPLICITY User's ManualDecember 2000 GFK-1180J
TRIGGER_POINT
Associated Point Type Device/Derived (Virtual)
Value Type 32 characters
Access Read only
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
on the same project as the points it triggers.
TRIGGER_TYPE
Associated Point Type Device
Value Type 2 bytes
Access Read only
CIMPLICITY Field Name Relation
Description Determines how the trigger is evaluated.
Returned Values 0 =No Trigger
1 =On Change
2 =Equal
3 =Less Than
4 =Greater Than
5 =Less Than or Equal
6 =Greater Than or Equal
TRIGGER_VALUE
Associated Point Type Device
Value Type 16 characters
Access Read only
CIMPLICITY Field Name Value
Description Value the trigger is compared with to
determine if the TRIGGER_TYPE condition
is met.
GFK-1180J Using Point Attributes 10-37
VARIANCE_VALUE
Associated Point Type Derived (Virtual)
Value Type Integer
Access Read only
CIMPLICITY Field Name Variance value
Description Delta accumulator variance value.
WARNING_HIGH
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Warning High
Description High warning limit
WARNING_HIGH_N
Associated Point Type All
Value Type Real
Access Read only
CIMPLICITY Field Name Warning High
Description High warning limit
WARNING_LOW
Associated Point Type All
Value Type 10 characters
Access Read only
CIMPLICITY Field Name Warning Low
Description High warning limit
WARNING_LOW_N
Associated Point Type All
Value Type REAL
Access Read only
CIMPLICITY Field Name Warning Low
Description High warning limit
10-38 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Point Attribute Security
Most point attributes are read-only. If users attempt to perform setpoint actions against
the read-only points, an error message displays.
Some quality point attributes are writeable if the role has been granted the privilege in the
Roles Properties dialog box. If any roles without the privilege attempt to perform setpoint
actions against the point attribute, an error message displays.
See the "Role Configuration" chapter in the CIMPLICITY HMI User's Manual (GFK-
1180) for information about granting privileges for writing to some point attributes.
GFK-1180J 11-1
Configuring Classes
Classes and Objects Overview
Instead of repeating configuration, which may include creating complex
CimEdit/CimView screens, for several objects that have similar requirements, you can
now do the basic configuration once and use it over and over.
Important: It is extremely important for you to have mastered CIMPLICITY project
configuration before you begin to configure classes and objects. If you have, you will
find that class/object configuration is straightforward. If you have not, you will most
likely run into problems.
The CIMPLICITY tools that provide this capability are Classes and Objects.
Classes A Class is a template that contains the definitions for points (data items),
actions, events, scripts, CimEdit screens and help files. These definitions,
along with class attribute, provide the flexibility to use as the basis for
configuring and interacting with objects that have similar requirements.
Note: A class can be exported in a single .soc file. See page 11-75 for
details.
Objects An Object is one instance that is created using a class as a template. An
object can be whatever you define it to be. Object configuration takes
advantage of the work that went into creating the class. This can greatly
reduce repetition that would otherwise be required if configuration for each
object was done independently. See the "Configuring Class Objects"
chapter in this manual for details.
Object 1 Object N
1 A class (.soc file)
can have several
components
including a
CimEdit screen
and help file.
2 One or more
objects can be
created from the
class.
Components combined in a Class .soc file
Object 2
Attributes
Points
Actions
Scripts
Events
CimEdit
Screen
Attributes
Points
Actions
Scripts
Events
CimEdit
Screen
Attributes
Points
Actions
Scripts
Events
CimEdit
Screen
Note: A custom help file can be created with third party tools and
also associated with the class.
Class
Attributes
Data Items
Actions
Scripts
Events
CimEdit
Screen
11-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Class-Object Evolution and Construction Overview
When you construct a class you are building a template that contains the definitions for
points, events, actions and scripts.
Configuration is very similar to configuring actual points, events, actions or scripts. The
primary difference is that in several places in your configuration you enter attributes
(variables) as the value. These attributes serve as placeholders for actual values, which
are applied when an object designer creates an object from the class template.
The key to making a Class a valuable tool that can be used as a template for creating
several objects is to anticipate the range of values, events and actions that will be required
for the object's performance.
The evolution and construction of a class into objects can be divided into five phases.
Phase 1. Plan the class
Phase 2. Configure the class
Phase 3. Enter specifications for an object based on the class
Phase 4. Repeat Phase 3 and 4 to create all of the objects that are needed. See the
"Configuring Class Objects" chapter in this manual for details
Tip: Examples that are provided are based on a sample class GefTank that is included
with CIMPLICITY.
You can find the sample class (GefTank.soc) file and associated graphic screen
(GefTank.cim) file in your CIMPLICITY directory at:
\\CIMPLICITY\HMI\Classes\Sample directory
See page 11-76 for the procedure to import a class (.soc) file into a project.
Note: In the next chapter, "Configuring Class Objects," the sample class is used as a
basis for a sample point object.
Phase 1. Plan the Class
Because a point class is a template for objects that may be created in remote as well as
local projects, it is essential that you plan the class to anticipate all possible object
requirements.
1. Determine the application in the production facility.
2. Determine the data to be collected.
3. Map out the layout of how memory is stored in the devices from which data is
collected.
4. Determine the calculations needed for the data.
5. Determine the CIMPLICITY features, e.g. points, scripts, actions and events,
required to collect and calculate data.
GFK-1180J Configuring Classes 11-3
Phase 2. Configure the Class
When you have determined the range of object requirements you can begin to configure
all of the necessary class components. You do the configuration in the Point Class dialog
box, which gives you an enormous amount of flexibility to fine-tune your class as it is
developed. You also take advantage of CimEdit's linked object capability to create a class
CimEdit screen from which object CimEdit screens can be instantly created.
The class provides you with the tools to configure:
Tool Use
Attributes (variables) Categories to which values will be assigned
when instantiating the object.
Provide the flexibility required to insure that the
class the range of possible values among the
objects.
Note: When you configure the class, you
specify how the attribute can and will be dealt
with by an object designer.
Data items Definitions for points that are associated with the
object.
Numeric Expressions Data calculations that define numeric rules for an
object.
String Expressions String substitution support.
Scripts Apply to all objects in the class.
Events Apply to all objects in the class for triggering
actions.
Actions Apply to all objects in the class
CimEdit Graphic File CimEdit screen associated with Point Class that
will hold a source object for linked containers.
As a result, CimEdit screens can be instantly
created and populated with values for any object
in the class.
Help File Custom file designed to provide help during
object creation.
11-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Example: Summary of class configuration features.
1. A class includes the tools to create a template that incorporates a wide variety of
CIMPLICITY features.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
String
Exp.
String
Exp.
Actions Events
String Exp.=String
Expressions
2. You have access to these tools through a Class dialog box and CimEdit.
Associate a
CimEdit screen
Help file
Access to Class configuration tools.
Note: One exception, custom help, is created with third party documentation tools.
End of example.
GFK-1180J Configuring Classes 11-5
Phase 3. Enter Specifications for an Object in the Class
When you have developed the class to your specifications, you can create one or more
objects by using the class as a template.
You will create an object through the Objects application. The process, which is
described in the "Creating a Class Object" chapter in this manual, begins with creating an
object and specifying its specific values in an Object dialog box.
An Object dialog box's features depend on the class developer's configuration. This
includes the:
Number of available configuration options.
Layout of the Object dialog box.
Features available for modification.
Example: An object dialog box based on the sample GefTank class.
Default values, fields and tabs (in addition to
General) are defined in the Class configuration.
End of example.
When an object designer clicks OK in an Object Properties dialog CIMPLICITY creates
an instance of the object. At this point, the features that have been configured for the
class are attached to the object, with values the class designer entered in the Object dialog
box and read-only values that were configured at the class level.
CIMPLICITY displays the object's features, which you can access, in their respective
application folders throughout the Workbench.
If the object designer has associated the class CimEdit screen with the object, the object's
values replace any class variables and can be viewed in CimView.
Example: An object instantiated
11-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
When an object designer instantiates an object so it appears in the Objects application,
its:
A. Features display with normally configured features, e.g. points, throughout the
Workbench.
B. Values display on the object's CimView screen.
For an instantiated object
(e.g. Tank_1)
1 Configuration features
appear associated with
the object in the
Workbench.
2 Values display in
CimView.
B
A
End of example.
GFK-1180J Configuring Classes 11-7
Class Configuration
You can configure a class and create objects from the class through two convenient
dialog boxesthe Class dialog box and the Object dialog boxand through CimEdit.
A key to insuring a smooth transition from class to objects is to anticipate the objects'
requirements. Once you have determined the application for the class and the possible
range of values that will be required by objects created from the class, the configuration
is straightforward and similar to configuration you have done for other the CIMPLICITY
applications.
Important: You can modify a class before and after it has been applied. However, you
cannot change the class dynamically.
What you configure for the class depends on the purpose for the class. In general, once
you have mapped out a plan you can configure the options for the class in any order.
The steps for a standard class configuration are as follows. The order of these steps is
designed to take advantage of all the options for the class, e.g. scripts are used in actions;
actions are used in events.
Step 1. Plan a class. See page 11-8.
Step 2. Create a class. See page 11-13.
Step 3. Configure class attributes. See page 11-15.
Step 4. Configure data items. See page 11-24.
Step 5. Write class scripts. See page 11-44.
Step 6. Configure class actions. See page 11-48.
Step 7. Configure class events. See page 11-55.
Step 8. Create a class CimEdit screen. See page 11-61.
Step 9. Create a class help file. See page 11-74.
Step 10. Export or import a class. See page 11-75.
Step 11. Create an object. See the "Configuring Class Objects" chapter in this
manual.
Before you configure a class, you should be familiar with how to configure each of the
features in a CIMPLICITY application.
Information appears throughout the CIMPLICITY documentation. Specific references
include:
Base System User's Manual, GFK-1180
"Configuring Device Points"
"Configuring Virtual Points"
"Configuring Point View, Limits and Alarms"
CimEdit Operation Manual, GFK-1396
Basic Control Engine Event Editor Operation Manual, GFK-1282
Basic Control Engine Reference Manual, GFK-1283
11-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Plan a Class
Planning your class first is critical before beginning configuration. This is because as a
class developer you are, in one configuration, providing the foundation for, possibly,
several objects and processes. As a result, you need to anticipate the range of
requirements, even if the objects or processes have similar characteristics.
A class will be most effective when its application supports multiple objects or processes
that have similar or identical characteristics..
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
1
String
Exp.
String
Exp.
Actions Events
String Exp.=String
Expressions
Important: A class cannot be changed dynamically. The project must be stopped to
make modifications.
General planning includes:
Task 1. Determine the application in the production facility. See page 11-9.
Task 2. Determine the specific data to be collected. See page 11-9.
Task 3. (Where applicable) Map out the layout of how memory is stored in the
devices from which data is collected. See page 11-10.
Task 4. Determine the basic calculations needed for the data. See page 11-11.
Task 5. Determine the CIMPLICITY features, e.g. points, scripts, actions and events,
required to collect and calculate data. See page 11-12.
GFK-1180J Configuring Classes 11-9
Task 1. Determine the Class Application
How you configure a class begins with how the class will be applied. Determining if
configuration for more than one process can be streamlined by using a class template
enables you to decide if using a class as a template is an effective configuration decision.
Points to consider include if:
There are several objects (processes) that appear to have similar requirements.
The type of data to be collected is identical. The values do not have to be
identical.
The type of calculations is identical.
(Where applicable) If the PLC layout is consistent among the objects.
Several plants in a company use tanks that collect similar data.
Multiple processing
tanks.
Identical data to be
collected from
processing tanks.
Identical data
calculations.
Consistent PLC layout.
End of example.
Task 2. Determine the Data to be Collected
The class template can provide point definitions (class data items) for any data that will
be collected at the object level.
In order to insure that the class includes the requirements for all the objects that are
created, it is important to determine the specific data that will be collected. Performing
this task before you concern yourself with configuration makes it more likely that you
will include all the possibilities in your class configuration.
The type of data depends entirely on the purpose of the application.
Example: Determine the data to be collected.
The data to be collected from each tank is.
1 Level.
2 Average input flow rate.
3 Average output flow rate.
4 Average temperature.
3 2
1
4
End of example.
11-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Task 3. Map a Layout of how Memory is Stored in Class Devices
CIMPLICITY classes provide an address adjustment feature that automates applying
addresses to device points if you configure data in blocks in contiguous memory location.
You can use this feature to configure address adjustment for more than one block.
During configuration, you, the class developer, create address adjustment expressions,
which specify the adjustment rule. An object designer then specifies one or more base
addresses. CIMPLICITY will automatically apply any additional addresses.
Mapping out the layout while planning enables you to easily determine if and how
address adjustment can be applied during configuration.
Example: Map a layout of how memory is stored in class devices.
Two tanks are connected to one PLC, with information divided into two distinct sections.
Block 1
Tank 1 data is mapped to the first four addresses
Tank 2 data is mapped to the next four addresses.
Block 2
Tank 1 data is mapped to the first two addresses.
Tank 2 data is mapped to the next two addresses.
Information from each of the tanks is mapped in the same order. Because there is a
standard convention for mapping information, address adjustment expressions can be
used to offset data item addresses.
1
2 3
4
9 10
5
6 7
8
11 12
PLC Addresses Mapped in Two Contiguous Blocks
Block 2: PLC
Addressing
Block 1: PLC
Addressing
%R100 1. Level
%R101 2. Input flow rate
%R102 3. Output flow rate
%R103 4. Temperature
%R104 5. Level
%R105 6. Input flow rate
%R106 7. Output flow rate
%R107 8. Temperature
%Q0 9. Input valve
%Q1 10. Output valve
%Q2 11. Input valve
%Q3 12. Output valve
End of example.
GFK-1180J Configuring Classes 11-11
Task 4. Determine the Calculations needed for the Data
CIMPLICITY classes provide you with the tools to create the definitions for points (class
data items) that can calculate data and numeric expressions that provide rules for object
data items (e.g. alarm high limits).
These definitions can contain variables, which can be substituted for real values at the
object level. You, the class developer, have control over what can be modified at the
object level.
Because the values among objects that are configured from the class may cover a wide
range, e.g. an Alarm high for one may be 500, for another may be 28,000, determining
the requirements during planning will make those requirements obvious.
Example: Determine calculations needed for the data.
3 2
1 Alarm High/Low.
2 Average input flow rate.
3 Average output flow rate.
4 Average temperature.
4
1
Feature Required for
Device Point Alarms Alarm High limits
Alarm low limits
Device Points Input value
Output value
Temperature
Tank level
Virtual Points Average input flow rate
Average output flow rate
End of example.
11-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Task 5. Define Class Scripts, Actions and Events
CIMPLICITY classes provide you with the tools to write scripts and configure actions
and events that are triggered based on rules you specify.
Example: Determine events, actions and scripts.
3 2
1 Events for Level Alarm High/
Low.
2 Input flow rate action.
3 Output flow rate action.
1
Feature Required for
Events Trigger actions when alarms are:
Generated,
Acknowledged and
Reset.
Actions Triggered by the above events to:
Empty the tank.
Fill the tank.
Run a script.
Script Set an alarm message point to the value of the alarm
message that triggered the event.
End of example.
GFK-1180J Configuring Classes 11-13
Step 2. Create a Class
By selecting the Classes icon in the Workbench left pane you can view the
existing Point Classes and create new ones.
Step 2. Create a class:
1. Open the New Class dialog box using any of the following methods:
Method 1. File menu
A. Click the Classes icon in the Workbench directory.
B. Click File on the menu bar.
C. Select New>Object.
Method 2. Popup menu
A. Right-click the Classes icon in the Workbench left pane.
B. Select New from the popup menu.
Method 3.Quickest
Double-click the Classes icon in the Workbench left pane.
Press
Ctrl+N.
Methods to Open the New Point Class Dialog Box
The New Class dialog box opens using any of the above methods.
2. Enter a unique name for the class In the Class ID field.
The Class ID
11-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Is limited to 32 characters.
Can be composed of:
Alphanumeric characters.
Underscores.
Must begin with an alphabetic character.
Cannot have spaces.
3. Click OK.
Result: The Class dialog box displays.
GFK-1180J Configuring Classes 11-15
Step 3. Configure Class Attributes
There are two types of class attributes, CIMPLICTY Attributes and Custom Attributes.
A class developer can enter values for these attributes, which will server as default
values. The object designer can, in some instances, override the default value.
Class attributes can be used to drive the way that objects are created or to store
information.
Note: CIMPLICITY also provides numeric data item attributes that can be used for
numeric expressions. See page 11-35 for details.
See the "Configuring Device Points," "Configuring Virtual Points" and "Configuring
Point View, Limits and Alarms" chapters in the Base System User's Manual, GFK-1180
for information about configuring points, which will be created from data items.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
3
String
Exp.
String
Exp.
Actions Events
String Exp.=String
Expressions
When you create an attribute, you can specify the:
Instantiation Type for each attribute. Your specification controls a object
designer's options when creating an object. If the attribute is:
Required A user must provide a value for this attribute. Failure to
provide the value will cause object instantiation to fail.
Optional The attribute has a default value in the class, which the user
can override for the object being created. The attribute does
not have to be explicitly specified to create the object.
Static The attribute has a default static value in the class. The value
appears in a read-only field during object configuration. All
objects in this class have the same value for this attribute.
Tabs and layout for the Object dialog box in which a object designer enters the
information.
Class attributes include:
CIMPLICITY class attributes, which display in the Attributes tab of the Class
dialog box. CIMPLICITY class attributes can be edited, duplicated, or deleted as
needed to configure your class.
Custom attributes that you configure to meet class requirements.
11-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Tasks to configure class attributes include:
Task 1. Review standard CIMPLICITY class attributes. See page 11-16.
Task 2. Create a custom attribute. See page 11-17.
Task 3. Configure a class attribute. See page 11-18.
Task 4. Configure the attribute's field for the Object dialog box. See page 11-20.
Step 3. Configure Class Attributes
Task 1. Review CIMPLICITY Class Attributes
When you select the Attributes tab in the Class dialog box the default CIMPLICITY
attributes display in the list control box.
Note: The first character in CIMPLICITY class attributes is a $.
Default
CIMPLICITY
attributes begin
with a $.
When a class developer enters a value for the attribute, the value serves as the default for
the corresponding data item(s) and/or in the Object dialog box in which a object designer
enters values.
CIMPLICITY class attributes are:
Class Attribute Provides the:
$ADDRESS Base address for data items.
Note: $ADDRESS can also be used to support address
adjustment expressions. See page 11-40.
$ALARM_CLASS Default alarm class for data items with alarms.
If not specified: Alarms will not be created for the data
items (object points).
Note: The class developer can change
$ALARM_CLASS from Optional to Required to
override this default behavior.
$DESCRIPTION Default description for all data items.
$DEVICE_ID Default Device ID for all data items.
GFK-1180J Configuring Classes 11-17
$EU_LABEL Default engineering units label for all data items.
$RESOURCE_ID Default Resource ID for all data items.
$SCREEN_ID Default Screen ID for all data items.
Step 3. Configure Class Attributes
Task 2. Create a Custom Attribute
In addition to CIMPLICITY attributes, you can create custom attributes for a class.
Task 1. Create a custom attribute:
1. Click New on the Attributes tab in the Class dialog box.
The New Attribute dialog box displays.
2. Enter a unique name in the Attribute ID field.
Uppercase
alphabetic required
for first character.
Numeric and
Underscores
are allowed.
The Attribute ID:
Is limited to 16 characters.
Can be composed of
Uppercase alphabetic characters,
Numeric characters and
Underscores.
Must begin with an alphabetic character.
Cannot have spaces.
3. Click OK.
Result: An Attribute dialog box displays.
11-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Configure Class Attributes
Task 3. Configure a Class Attribute Definition
Note: You can configure both CIMPLICITY and custom class attributes. CIMPLICITY
attribute features that cannot be modified display in read-only fields.
You can configure a class attribute by:
Creating a new custom attribute,
Modifying custom attributes or CIMPLICITY attributes and
Duplicating an existing attribute and modifying the duplicated attribute.
Open the Attribute
dialog box.
Duplicate attribute's
properties.
Delete the
attribute.
For a selected
attribute:
Open a New
Attribute dialog
box.
CIMPLICITY
attributes
begin with $.
Custom
attributes.
The top part of the dialog box provides fields for you to define the attribute. Your
definition can provide default values and determines the options available to a object
designer when creating an object from the class.
Task 3. Configure a cl ass attribute definition:
1. Open either a new or existing Attribute dialog box in which you will fill in or
modify the top part.
Read-only for
CIMPLICITY
class attributes.
Field Definition Part of the Attribute Dialog Box: GefTank Class Example
2. (Optional) Enter the default value for the attribute in the Value field.
Acceptable values:
Must be within the range for the attribute type
Are limited to 80 characters.
Cannot contain the vertical bar '|' character.
GFK-1180J Configuring Classes 11-19
3. Select the data type of the value from the Data type drop-down list: Data types
are:
Analog
Boolean
String
4. Select the option from the Instantiation type drop-down list that controls how a
user will deal with the attribute when an object is being created:
Option When an object is created, a user:
Required Must provide a value for this attribute.
Failure to provide a value when creating an object will generate an
error.
Optional Can override a class default value, if there is one. The attribute
does not have to be specified to create the object.
Static Cannot change the value.
All objects of this class will have the same value for this attribute.
5. Check Reference if you want to identify the value of this attribute as the value
of another attribute.
Important: The Value field in the Attribute dialog box must contain the
attribute ID of the value to be referenced.
6. Go to Task 4 to configure the attribute's field layout in the Object dialog box.
Example: Configure a Class Attribute Definition
1 Class
Enter and
define an
attribute value
in the Attribute
dialog box.
Defines the field
layout in the
Object dialog
box (next task).
11-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
The default entry
appears in an
Object dialog
box.
2 Object
End of example.
Step 3. Configure Class Attributes
Task 4. Configure the Attribute's Field that displays in the Object
Dialog Box
An object designer configures an object based on the class you are creating in an Object
dialog box. The specifications you make in the Object Builder Group of the class
attribute's Attribute dialog box determine where and how the attribute appears in the
Object dialog box.
Task 4. Configure the attribute's fi eld that displays in the Object di alog box:
1. Open the appropriate Attribute dialog box (if it is not open), in which you will
fill in or modify the fields in the Object Builder box. See page 11-18 for details.
Field Definition Part of an Attribute Dialog Box: GefTank Class Example
2. (Optional) Enter a meaningful description that is up to 20 characters in the
Prompt field.
GFK-1180J Configuring Classes 11-21
Your entry appears as the field name for the class attribute in the Object dialog
box.
The class attribute ID appears as the field name if there is no entry.
2. (Optional) Enter a tip up to 80 characters in the Help string field.
Your entry appears as a tool tip in the Object dialog box when the user places
the cursor over the field.
3. (Optional) Select a browser in the Browser type field if you want the user to
have access to a browser in the Object dialog box. When a browser is selected,
the appropriate Browser button will appear to the right of the field in the Object
dialog box. Browser options include:
Option Button that will display
Alarm Class
Resource
Device
Role
Point
User
Port
4. Specify the order in which the field will appear on the Object dialog box tab in
the Order field.
Lower numbers appear before higher numbers.
Class attributes with the same order number (for the same tab) are sorted
alphabetically by Prompt (field name).
5. Use the Property page field to specify the tab on which the attribute will
display in the Object dialog box as follows.
Either
Select General which is the default tab or
Enter a new name.
The name you enter will appear as a tab in the Object dialog box.
The General tab has a limit of 8 attributes (fields).
Additional tabs have a limit of 9 attributes each.
6. Click OK or Cancel.
11-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Result:
OK A new class attribute is added to the list of attributes and existing
attributes are modified. In addition:
Existing objects based on this class are reevaluated to reflect the new
class structure.
You will be prompted to configure new required values for each
existing object.
Expressions that contain an existing attribute are re-evaluated.
Points are modified when a configuration update is performed on the
project.
Cancel Cancels the procedure.
Note: CIMPLICITY attribute fields that cannot be modified display as read-only.
However, when you duplicate a CIMPLICITY class attribute, all of the fields in the
Attribute dialog box for the new attribute can be modified.
GFK-1180J Configuring Classes 11-23
Example: Configure a class attribute for an Object dialog box field.
1 Class
Enter field name,
position and other
specifications
in the Attribute
dialog box.
The field appears in
the Object dialog
box as specified.
2 Object
$DEVICE_ID
(CIMPLICITY Attribute)
Field for
$DEVICE_ID
Attribute
Attribute definition
(previous task).
End of example.
11-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. Configure Data Items
A data item is a definition that becomes a CIMPLICITY point when an object is created
from the class.
Configuring a data item for a class is similar to configuring a CIMPLICITY point. The
dialog boxes that you are accustomed to using to configure device and virtual points are
almost identical to the dialog boxes that you use to configure the point definitions for the
class.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
4
String Exp.=String
Expressions
Actions Events
String
Exp.
String
Exp.
A data item:
Can be used in any application that supports points, for example:
Database Logger
Event Editor
BCE
Point Control Panel
CimView
Other CIMPLICITY Software Options
Can include a subset of expressions of type: string or numeric. Note that a limited
number of string substitutions and numeric expressions are supported.
Displays in the Workbench right pane as a point with its associated object.
Tasks to configure data items include:
Task 1. Create a data item. See page 11-26.
Task 2. Begin data item configuration. See page 11-27.
Task 3. Take advantage of data item class features including using:
3A. Class attributes for configuration. See page 11-29.
3B. String expressions in data item fields. See page 11-31.
3C. Numeric expressions in data item fields. See page 11-35.
3D. Address adjustment expressions. See page 11-40.
Example: Data Item to point.
GFK-1180J Configuring Classes 11-25
AVERAGE_INFLOW is a data item in the GefTank class.
An object designer creates an object Tank_1 from the GefTank class.
AVERAGE_INFLOW appears as a point in the Workbench right pane either:
In a Tank_1 folder (Tree View display) or as
Tank_1.AVERAGE_INFLOW in other views.
Configure the data
item in the Class
dialog box
1 Class
AVERAGE_INFLOW
Data item
Appears as a point in the
Workbench when an
object is created.
Workbench
Other views.
Workbench
Tree view.
2 Object
AVERAGE_INFLOW
Point
A In the Tree View, the
point displays as a
point in the object
folder.
B In other views, the
point includes its
object in the display.
A
B
End of example.
Note: Usually you will configure a data item that creates one of the several point types
available in CIMPLICITY.
Two additional options are available that reduce memory usage:
J ust-in-Time device point type and
Delay-Load device point type.
See page 11-42 for details.
11-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. Configure Data Items
Task 1. Create a Data Item
Each new data item represents a CIMPLICITY point definition. Points are created when
an object is created. The points are associated with the object.
Task 1. Create a data item:
1. Select the Data Items tab in the Class dialog box.
2. Click New.
A New Data Item dialog box opens.
3. Enter a unique name for the Data Item.
Uppercase
alphabetic required
for first character.
Numeric and
Underscores
are allowed.
Point for
object will be
as selected.
New Data Item: Template that wil become a Point for an Object
The Data Item ID:
Is limited to 16 characters.
Can be composed of
Uppercase alphabetic characters,
Numeric characters and
Underscores.
Must begin with an alphabetic character.
Cannot contain spaces.
GFK-1180J Configuring Classes 11-27
3. Check Device or Virtual to create a data item definition that will become a
device or virtual point.
4. Check Analog, Boolean or Text to select the data item class.
Your selection will be the point's class.
5. Click OK.
Result: The Data Item dialog box opens. The available tabs and options in the dialog
box depend on your Type and Class selections.
Note: You can also duplicate an existing data item and modify it.
Step 4. Configure Data Items
Task 2. Begin Data Item Configuration
The tabs and available options in the Data Item dialog box depend upon your Type and
Class selections in the New Data Item dialog box. This is the same as when you
configure points.
The basic difference between configuring a data item and configuring a point, comes
from the fact that the data item is a template for what could be several points (one per
object) if several objects are created from the Class.
As a result
A value entered in the Data Item dialog box may be:
A static value that applies to all objects or
An expression that anticipates the requirements of the several objects.
The following values are omitted from data item configuration. This is because
typically the class developer will not know the devices or resources that are
configured for the objects in a project.
Instead, the object designer enters the following in the Object dialog box:
Value Comes from the
Device ID $DEVICE_ID CIMPLICITY class attribute.
Resource ID $RESOURCE_ID CIMPLICITY class attribute.
In addition, the object designer specifies:
Alarm Routing The strategy is specified when the object is created.
See page 11-18 for details about the Object dialog box.
See "Configuring Device Points" and "Configuring Virtual Points" chapters in this
manual for details about configuring device and virtual points.
11-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Task 2. Begin data item configuration:
Open the Data Item dialog box for a new or existing data item.
Data Item Dialog Box: Device Analog Point Example
Note: The Data Item dialog box does not contain a
Device ID field.
Unique for data items.
Result: You can continue configuration, taking advantage of CIMPLICITY class
attributes, string and numeric expressions, where appropriate.
GFK-1180J Configuring Classes 11-29
Step 4. Configure Data Items
Task 3A. Use CIMPLICITY Class Attributes for Configuration
CIMPLICITY class attributes can be used as default global values for data items. This
simplifies data item configuration because you can leave the appropriate fields blank in
the data item dialog box.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
4
String Exp.=String
Expressions
String
Exp.
String
Exp.
Actions Events
See page 11-16 for a list of CIMPLICITY Class attributes.
Example: Use a class attribute ($ADDRESS).
A Create a class
attribute if it
doesn't currently
exist.
B Enter the attribute
in a Data Item
field that allows
string
expressions.
1Class
A
B
11-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
A In the Base Address
field the $ADDRESS
value is default..
The Base Address
can be changed in
the Object dialog
box.
B The Address appears
as a read-only field in
the Point Properties
dialog box.
The actual point
address depends on
whether you
configured an
address adjustment
based on how the
data is stored.
2 Object
Base Address field.
The $ADDRESS
value is default.
A
B
End of example.
GFK-1180J Configuring Classes 11-31
Step 4. Configure Data Items
Task 2B. Use String Expressions in Data Item Fields
There are two types of expressions that you can use in selected data item fields.
Expression Type At the Object Level the
String Substitution strategy in a field that takes string entries is very
similar to the use of variables in CimEdit expressions.
You, the class developer, enter a string variable in a data item
field.
A string value is substituted at the object level. The type of string
you use and where you use it determines whether it can be edited
in the Point Properties dialog box at the object level.
You enter string expressions in fields that accept non-numeric
characters, e.g. the Description field or fields that require point
ID's. See the next page for details.
Numeric See page 11-35 for details for numeric expressions.
You can configure data items to include a subset of expressions based on simple
expression processing. Expressions can be used to set the value of a data item attribute.
String Exp.=String
Expressions
Class
Scripts
CIMPLICITY
Class
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Data Items
Custom
Attributes
String
Expressions
CimEdit Screen
CIMPLICITY
Variables
Numeric
Expressions
4
String
Exp.
String
Exp.
Actions Events
About String Expressions
You can incorporate simple string substitution in data item fields that use character
strings. You enter a class attribute as a variable in a string expression in the edit field
when you configure the data item.
Available variables include:
All class attributes are available as variables. You can define your own
variables, or you can use the CIMPLICITY attributes.
CIMPLICITY predefined variables, which are:
$OBJECT Object ID, e.g. TANK1.
$ID ID of the data item, e.g. LEVEL.
$CLASS Class ID, e.g. GefTank.
11-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Use brackets {} to enclose variable values. (Brackets are also used for variables in
CimEdit.)
See the CimEdit Operation Manual, GFK1396, "Using Variables" chapter for detailed
information about variables.
Supported String Substitution for Data Items
String substitution is supported for the following data item attributes, which you enter in
the associated Data Item dialog box field.
For Attribute Supporting String Substitution
All Data Items Description
Safety Point
Screen
Availability Trigger
Measurement Units Label
Derived Data Items Expression
Reset Point
Device Data Items Address
Device ID
Point Alarm Data Items Alarm Message
Alarm Class
Deviation Point
String Substitution Limitations
Nested substitution is not supported.
Exampl e
You have the created the following variables:
VAR1="{VAR2}"
VAR2=HELLO WORLD
And the expression:
{VAR1}
The expression after substitution will be the string {VAR2}.
The expression will not be reevaluated to yield the result HELLO WORLD.
GFK-1180J Configuring Classes 11-33
Procedure to use a String Expression
To use a string expression in a data item field:
Enter a class attribute or CIMPLICITY variable enclosed in brackets {} in the
appropriate field in the Data Item dialog box.
See page 11-18 for procedures to open an Attribute dialog box.
See page 11-27 for procedures to open a Data Item dialog box.
Result: The string expression or variable will be replaced with the attribute's value at
the object level when an object is configured.
Example: Use a string expression as a point description.
A Create a class
attribute if it
doesn't currently
exist.
B Enter the attribute
in a Data Item
field that allows
string
expressions.
1Class
A
B
11-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
A (Optional) Change
the default value
that appears in the
Object dialog box.
B The value in the
Object dialog box
displays in the
object's Point
Properties dialog
box.
2Object
A
B
End of example.
GFK-1180J Configuring Classes 11-35
Step 4. Configure Data Items
Task 3C. Use Numeric Expressions in Data Item Fields
There are two types of expressions that you can use in selected data item fields.
Expression Type At the Object Level
String See page 11-31 for string expressions.
Numeric Value in a field that takes numeric expressions is calculated at the
object level. The calculation uses the values of class custom
attributes that are used in the expression.
You configure numeric expressions on the Expressions tab in the
Data Item dialog box. This tab is unique for data items. It does not
appear in the Point Properties dialog box.
Numeric expressions are created with CIMPLICITY numeric data item attributes and can
consist of one or two operands. Operands can be either a constant value or a custom
attribute with a numeric data type.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Data Items
Numeric
Expressions
CimEdit Screen
4
String Exp.=String
Expressions
String
Exp.
String
Exp.
Actions Events
11-36 CIMPLICITY User's ManualDecember 2000 GFK-1180J
CIMPLICITY Numeric data item attributes available for Numeric
Expressions
CIMPLICITY provides numeric data item attributes that can support numeric
expressions. You can add any of the numeric data item attributes to a data item. Once
added, the attribute can be used in a numeric expression for that data item.
The following CIMPLICITY numeric data item attributes can be used for numeric
expressions.
CIMPLICITY
Numeric Data Item
Attribute
Provides For
$ADDRESS_ADJ Address adjustment Device points
See page 11-40 for details about
address adjustment.
$ALARM_DELAY Alarm delay.
Alarm configuration;
time in seconds
$ALARM_HIGH Alarm high limit Analog points
$ALARM_LOW Alarm low limit Analog points
$CONV_LIMIT_HIGH Second conversion
limit
Analog points
$CONV_LIMIT_LOW First conversion limit Analog points
See "Point Conversions in the
"Configuring Device Points"
chapter in this manual for details
about point conversion.
$DISPLAY_HIGH Display high limit Analog points
$DISPLAY_LOW Display low limit Analog points
$FORMAT_JUST Format justification Analog points
0 =Zero filled
1 =J ustify left (default)
2 =J ustify right
$FORMAT_PREC Format precision Floating point or Analog points
with EU conversion
$FORMAT_WIDTH Format width Analog points
$RANGE_HIGH Range high limit Analog points
$RANGE_LOW Range low limit Analog points
$RAW_LIMIT_HIGH Second raw limit Point Conversion / Analog points
$RAW_LIMIT_LOW First raw limit Point Conversion / Analog points
$SETPOINT_HIGH Setpoint high limit Analog points
$SETPOINT_LOW Setpoint low limit Analog points
$TREND_DURATION Trend duration Analog points only; time in
seconds
$TREND_SAMPLES Trend samples
$WARNING_HIGH Warning high limit Analog points
$WARNING_LOW Warning low limit Analog points
GFK-1180J Configuring Classes 11-37
Procedure to add a Numeric Expression to a Data Item
To add a numeric expression:
1. Select the Expressions tab in the Data Item dialog box.
Data Item Dialog Box Expression Tab: GefTank Class Example
2. Click New
The New Expression box opens.
3. Select an Attribute ID from the drop-down list. The list includes the supported
CIMPLICITY numeric data item attributes. See the previous section.
4. Click OK.
11-38 CIMPLICITY User's ManualDecember 2000 GFK-1180J
The Expression dialog box opens.
Configured Expression Dialog Box: GefTank Example
5. Specify the first operand by checking either:
A. Attribute IDSelect the attribute from the dropdown list.
Note: The analog attributes on the Attributes tab are operand
B. NumberEnter a value in the field.
6. (Optional) Select an operator to include a second operand.
Operators include:
-
*
/
+
none
7. (Optional) Specify a second operand by checking either:
A. Attribute IDSelect the attribute from the dropdown list
B. NumberEnter a value in the field.
8. Click OK.
Result: The expression is added to the data item's list of available numeric
expressions.
The numeric expressions provide rules for defining the point properties.
GFK-1180J Configuring Classes 11-39
Example: Add a numeric expression to a data item.
1 Create a New
Expression
B Select a
CIMPLICITY
numeric attribute
to create a new
expression.
A Click New on the
Expression tab in
the Data Item
dialog box.
A
B
A Class attribute
options for the
expression
operands come
from the
Attributes tab in
the Class dialog
box.
3 Configure
the
Expression
C The
CIMPLICITY
numeric
attribute
appears in the
point's
configured
expression list.
B Expression
operands can
be class
attributes or
numbers.
A
B
B
C
End of example.
11-40 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. Configure Data Items
Task 3D. Use Address Adjustment Expressions
Address adjustment expressions provide a powerful tool that automates applying
addresses to devices at the object level.
Address adjustment expressions are based on the ADDRESS_ADJ expression target.
This function is most useful when a final address is provided for the object by adding the
offset number to the value in the object's Address attribute.
Task 2D. Use address adjustment expressions:
1. Make sure your PLC stores data in contiguous blocks (or in blocks that are
equally spaced apart).
Exampl e
You have two tanks with data mapped in two contiguous blocks.
1
2 3
4
9 10
5
6 7
8
11 12
PLC Addresses Mapped in Two Contiguous Blocks
Block 2: PLC
Addressing
Block 1: PLC
Addressing
%R107 8. Temperature 7
Address adjustment
%R100 1. Level
%R101 2. Input flow rate
%R102 3. Output flow rate
%R103 4. Temperature
%R104 5. Level
%R105 6. Input flow rate
%R106 7. Output flow rate
1
2
3
4
5
6
%Q0 9. Input valve
%Q1 10. Output valve
%Q2 11. Input valve
%Q3 12. Output valve
1
2
3
2. Use class attributes to enable the object designer to enter the base address for
each block as follows:
A. Use the CIMPLICITY $ADDRESS attribute for the first block.
B. Create class attributes for the second and any additional blocks.
Exampl e
An attribute that will be used in address adjustment is named
OUTPUT_ADDR.
C. (Optional) Enter a base address in the Attribute dialog box.
Note: All address adjustment attributes appear as fields in the Object dialog
box. When an object designer creates an object, base addresses can be entered
for that object. If you enter a base address, that address appears as the default in
the Object dialog box. See page 11-18 for details about the Object dialog box.
GFK-1180J Configuring Classes 11-41
3. Determine the offset for addresses that are above the base address using the
formula.
Offset = PLC Address - Base Address.
Exampl e
5=%R105-%R100
3. Create an address adjustment expression as follows:
A. Select the Expressions tab in the Data item dialog box.
B. Click New.
The New Expression dialog box opens.
C. Select $ADDRESS_ADJ from the drop-down list.
D. Click OK.
The Expression dialog box displays.
E. Check Number and enter the address-offset in the Number field, e.g. 1.
F. Click OK.
4. Create an additional address adjustment expression as follows:
A. Select the Device tab in the Data Item dialog box.
B. Enter the name of the custom (address adjustment) attribute in brackets in
the Address field, e.g. {OUTPUT_ADDR}.
11-42 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Data Item Dialog Box Section: Address Adjustment Example
This is necessary to ensure that the custom attribute OUTPUT_ADDR is used
for the base address instead of defaulting to the CIMPLICITY attribute,
$ADDRESS.
C. Select the Expressions tab.
D. Click New.
A New Expression dialog box opens.
E. Select $ADDRESS_ADJ from the drop-down list.
F. Click OK.
The Expressions dialog box opens.
G. Check Number and enter the address-offset in the Number field; e.g. 1.
H. Click OK.
Result: CIMPLICITY will automatically assign device points with addresses when
an object designer enters the base address for the one or more configured blocks in
the Object dialog box. The addresses will be calculated based on the adjustments
you specified in the Expression dialog box.
Understanding Data Item Options
You can create a data item that will behave like any other device point created in
CIMPLICITY. Within class configuration, you can also create:
Option Definition
J ust-in-time Data item point configuration is created by the Point Manager
when an application requests it. When the application is done,
the data item is removed from the Point Manager. It is not
written to the point database.
J IT Data Items can be used in:
CimView,
Point Control Panel,
Trending, and
Scripting.
Delay-load Point is not be loaded into memory in the Point Manager or
Devcom at project startup. Rather the point is loaded into
memory only when it is demanded by an application. When
GFK-1180J Configuring Classes 11-43
the point ceases to be demanded it will be unloaded from
memory in the Point Manager and Devcom.
There are a number of benefits, disadvantages and non-supported functions as defined
below:
Data Item
Benefits Disadvantages
Non-Supported
Functions
Configured
Accessible any time
Quick access
Written to point database
Available in point list
Definition can be
modified
Uses memory in point
database
Project uses more
memory
Configuration updates
can be lengthy on larger
systems
Noneall functions
supported
Just-in-Time
Created on demand when
needed
No memory usage until
point is created
Project uses less disk
space
Point database is reduced
Not available in point
lists
Slowest access
Device points only
Does not reside in point
database
Definition cannot be
modified
Exclusive to classes
Trigger settings and
Alarm options are not
available
Note: Are not recommended
for points that are accessed
often.
Trend buffering
Alarming
Attribute set
Analog deadband
Cannot be used
within another point's
configuration, e.g.
Safety point, Trigger,
Availability Trigger
point, etc.
Cannot be used in a
calculation point
equation
Cannot use another
point within its
configuration, e.g.
Safety point, Trigger,
Availability Trigger
point, etc.
Cannot be marked as
an enterprise point.
Delay-Load
Loaded when needed
No memory usage until
point is loaded
Written to point database
Available in point list
Definition can be modified
Slower access
Configuration updates
can be lengthy on larger
systems
Trigger settings and
Alarm options are not
available
Trend buffering
Alarming
Cannot be used
within another point's
configuration, e.g.
Safety point, Trigger,
Availability Trigger
point, etc.
Cannot be used in a
calculation point
equation
11-44 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. Write Class Scripts
Class scripts:
Can be created and modified in the CIMPLICITY Program Editor by opening it
through the Class dialog box and
Are stored in the Workbench Scripts folder, with a class$ prefix, as soon as
they are created.
Actions Events
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
5
String
Exp.
String
Exp.
String Exp.=String
Expressions
The class$ script can also be modified in the CIMPLICITY Program Editor by
opening it through the Workbench Scripts folder.
As a result an object designer can use the script editor for editing and debugging of the
scripts.
Tasks to write class scripts include:
Task 1. Create a class script. See page 11-46.
Task 2. Write a class script through the Scripts tab. See page 1147.
Example: Access a script for a class.
A class named GefTank has a script named level.bcl.
The script resides in the Scripts directory with the name GefTank$Level.bcl.
The script, Level.bcl/GefTank$Level.bcl, can be modified in the CIMPLICITY
Program Editor. You will see the modifications when you open the Program Editor
through either the Class dialog box or the Scripts folder.
GFK-1180J Configuring Classes 11-45
Create a script in the
CIMPLICITY Program
Editor through the
Class dialog box.
The script can be
modified in the
CIMPLICITY Program
Editor through the:
A Class dialog box and
B Scripts folder.
1 Class
2 Class/Object
Class and Object
The script is
associated with the
class in the Scripts
folder.
A
B
End of example.
11-46 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. Write Class Scripts
Task 1. Create a Class Script
You can create scripts that are included with the class and perform as written at the object
level.
Task 1. Create a cl ass script:
1. Click New on the Scripts tab in the Class dialog box.
The New Script Name dialog box opens.
2. Enter a unique name
Numeric and Underscores are
allowed.
A Script name is
Is up to 15 characters.
Can have alphanumeric characters.
Can have underscores.
Cannot have spaces.
3. Click OK.
Result: A CIMPLICITY Program Editor window opens.
Note: You can also duplicate an existing script and modify it.
GFK-1180J Configuring Classes 11-47
Step 5. Write Class Scripts
Task 2. Write a Class Script through the Scripts Tab
You can write a class script by:
Creating a new class script
Modifying an existing class script.
Duplicating an existing class script and modifying the duplicated script.
Open the
CIMPLICITY
Program Editor.
Duplicate script's
properties.
Delete the
script.
For a selected
script:
Open a New
Script Name
dialog box.
Task 2. Write a cl ass script through the Scripts tab:
1. Open either a New Script name dialog box or display a selected script in the
Program Editor.
2. Write or modify the script as you would any CIMPLICITY script.
3. Save the modifications.
4. Close the CIMPLICITY Program Editor window.
Result: The script immediately appears in the Workbench Scripts folder as:
Class$Scriptname.bcl
Where
Class$ is the name of the class to which the script belongs.
Scriptname.bcl is the name entered in the New Script Name dialog box.
You can modify the script either through the Scripts folder or through the Class
dialog box.
11-48 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 6. Configure Class Actions
Class actions:
Are created through the Class dialog box.
Appear in the Event Editor window when an object is created.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
Actions Events
CimEdit Screen
6
String
Exp.
String
Exp.
String Exp.=String
Expressions
In the Event Editor, actions:
Are associated with an object. A object designer cannot change the
association.
Cannot be modified. All fields are read-only.
Cannot be deleted.
Can be associated with a non-object event. This enables an object to
instantiate actions that can be called from other events.
Tasks to configure a class action are:
Task 1. Create a class action. See page 11-50.
Task 2. Define a class action. See page 11-51.
GFK-1180J Configuring Classes 11-49
Example: Configure a class action.
A Open an
Action dialog
box through
the Class
dialog box.
B Configure the
action.
1 Class
A
B
A The action is
associated with an
object when the object
is created.
B The associated action
displays in the Event
Editor. It cannot be
modified.
2 Object
A
B
End of example.
11-50 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 6. Configure Class Actions
Task 1. Create a Class Action
Task 2. Create a cl ass action:
1. Click New on the Actions tab in the Class dialog box.
The New Action dialog box appears.
2. Enter a unique name for the Action ID.
The Action ID:
Is limited to 16 characters.
Can be composed of
Uppercase alphabetic characters,
Numeric characters and
Underscores.
Must begin with an alphabetic character.
Uppercase
alphabetic required
for first character.
Numeric and
Underscores
are allowed.
3. Click OK.
The New Action dialog box opens.
GFK-1180J Configuring Classes 11-51
Step 6. Configure Class Actions
Task 2. Define a Class Action
You can define a class action by:
Creating a new class action.
Modifying an existing class action.
Duplicating an existing class action and modifying the duplicated action.
Open the New
Action dialog box.
Duplicate action's
properties.
Delete the
action.
For a selected
action:
Open a New
Action dialog
box.
All CIMPLICITY action types (found in the Event Editor) are available except for:
Alarm Lookup and
Recipe Upload/Download.
The difference between configuring a class action and a standard action is that you:
Select a data item instead of a point ID when you configure an action that
requires a point ID.
The CIMPLICITY $OBJECT variable is automatically entered when you select
the data item.
Note: The user can associate a non-object event with an object action. This allows an
object to instantiate actions that can be called from other events.
11-52 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Task 2. Define a class action:
1. Open a new or existing Action dialog box.
Exampl e
2. Select an action from the list of available actions.
Actions available for classes include:
Log Only
Point Alarm Acknowledge
Point Alarm Disable
Point Alarm Enable
Run Script
Set Point
Source Transition Set
Transition Set
3. Fill in the fields that display, based on the selected action. See page 11-54 for
supported string substitution for action fields.
Your entries are based on the class configuration
Exampl e
A. If a Point ID field displays, e.g., for a Set Point action:
i. Click the Browser button to the right of the Point ID field.
The Select a Data Item browser appears displaying the list of data items
created for the class.
ii. Select a Data Item.
iii. Click OK.
GFK-1180J Configuring Classes 11-53
The CIMPLICITY $OBJECT variable appears in the Point ID field
before the data item as follows:
{$OBJECT).DataItem
Data Item Browser
Automatically entered
when a Data Item is
selected.
Data Item
B. If a Run Script action is chosen:
i. Click the Browser button to the right of the Script name field.
The Select a Script File browser displays the scripts that have been
written for the class.
ii. Select a script to associate with the action.
iii. Click OK.
Result: The name of the class script appears in the Script name field.
Script written for the class.
4. Click OK.
11-54 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Result: The action, which is modified or created, displays on the Actions tab in the
Class dialog box.
Supported String Substitution for Action Fields
String substitution is supported for the following action fields, which you enter in the
associated Action dialog box field.
Point ID.
Resource ID.
Point value.
See page 11-32 for limitations when using string substitutions.
GFK-1180J Configuring Classes 11-55
Step 7. Configure Class Events
Class events provide a wide degree of flexibility for changing the business rules of a
system.
Actions
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
Events
String
Exp.
String
Exp.
7
String Exp.=String
Expressions
Class events:
Are created through the Class dialog box.
Appear in the Event Editor window when an object is created. In the Event
Editor, events:
Are associated with an object. A object designer cannot change the
association.
Cannot be modified. All fields are read-only.
Cannot be deleted.
Creating class events is similar to creating events in the Event Editor. All existing event
types that are supported in the event editor are available for class event configuration.
Tasks to configure class events include:
Task 1. Create a class event. See page 11-57.
Task 2. Configure class events. See page 11-58.
11-56 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Example: Use a class event.
A Open an Event
dialog box
through the
Class dialog
box.
B Configure the
event.
1 Class
A
B
A The event is
associated with an
object when the
object is created.
B The associated
event displays in the
Event Editor. It
cannot be modified.
2 Object
A
B
End of example.
GFK-1180J Configuring Classes 11-57
Step 7. Configure Class Events
Task 2. Create a Class Event
Task 2. create a class event:
1. Click New on the Events tab in the Class dialog box.
The New Event dialog box appears.
2. Enter a unique name for the Event ID.
Uppercase
alphabetic required
for first character.
Numeric and
Underscores
are allowed.
The Event ID:
Is limited to 16 characters.
Can be composed of
Uppercase alphabetic characters,
Numeric characters and
Underscores.
Must begin with an alphabetic character.
Note: You can also duplicate an existing event and modify it.
11-58 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 7. Configure Class Events
Task 2. Configure a Class Event
Task 2. Configure a cl ass event:
1. Open an Event dialog box for a new or selected event.
2. Enter basic configuration for the class event.
A. Select the Events tab.
B. Select an Event type.
All of the event types available in the Events folder are available for a class
event. Event types are:
Alarm Acknowledged
Alarm Deleted
Alarm Generated
Alarm Reset
Point Change
Point Equals
Point Transition High
Point Transition Low
Point Unavailable
Point Update
Run Once
Timed
See "CIMPLICITY Basic Control Engine Event Editor and BCEUI
Operation Manual, GFK-1282, for a description of each of the event types.
C. Fill in the fields that display, based on the selected event. See page 11-60
for supported string substitutions for event fields.
Exampl e
The Alarm Acknowledged event type is selected. Configuration
includes:
i. Click the Browser button to the right of the Alarm ID field.
The Select a Data Item browser appears displaying the list of data items
displayed for the class.
B. Select a Data Item.
C. Click OK.
GFK-1180J Configuring Classes 11-59
D. The CIMPLICITY $OBJECT variable appears in the Point ID field
before the data item as follows:
{$OBJECT).DataItem
Note: You can enter a string expression directly in the field.
E. (Optional) Select or enter a Resource ID.
F. (Optional) Select or enter an alarm class in the Class ID field.
3. Select actions that will be associated with the class event.
A. Select the Actions tab in the Event dialog box.
B. Open an Action-Event dialog box by using any of the same methods you
used to open the Event dialog box (1 in this procedure).
C. Click the Browser button to the right of the Action ID field.
The Select an Action browser opens displaying the actions that have been
created for the class.
D. Select an action that will be associated with the event.
11-60 CIMPLICITY User's ManualDecember 2000 GFK-1180J
E. Click OK.
The action appears in the Action ID field.
F. Check Log Flag to have the action logged to a database table.
G. Click OK.
The action appears in the list of actions associated with the event.
H. Specify the sequence in which the event's actions occur by using the Move
up and Move down buttons to place the actions in the order you want
them to occur.
4. Select the Advanced tab in the Event dialog box.
5. Configure advanced specifications the same as you configure them for an event
in the Events folder.
5. Click OK.
Result: When an object is created from the class, the event appears in the
CIMPLICITY Event Editor window as:
ObjectName.EventID
Where
ObjectName is the name of the object that has been created.
EventID is the name entered in the New Event dialog box.
Supported String Substitution for Event Fields
String substitution is supported for the following event fields, which you enter in the
associated Event dialog box field.
Point ID.
Alarm ID.
Resource ID.
Alarm Class.
Point Value.
See page 11-32 for limitations when using string substitutions.
GFK-1180J Configuring Classes 11-61
Step 8. Configure a Class CimEdit Screen
In addition to creating the components that will enable an object designer to quickly
create an object from a class (e.g. points, events, actions and scripts) you can create a
class CimEdit screen which, when used for an object, will provide an operator with the
necessary visual interface.
Class
Scripts
String
Expressions
CIMPLICITY
Class
Attributes
Custom
Attributes
Attributes
CIMPLICITY
Numeric
Attributes
Numeric
Expressions
Data Items
CimEdit Screen
8
String Exp.=String
Expressions
String
Exp.
String
Exp.
Actions Events
When you configure a class CimEdit screen an object designer can drag an existing
object from the Workbench to a new CimEdit screen.
The source object from the class CimEdit screen appears on the new screen. Object
values are substituted for variables, e.g. $OBJECT, that were configured on the source
screen.
Tip: It is recommended that you configure the following in the order they are listed:
1. Other class components.
2. One object that you can use to test the screen you are creating.
3. The class CimEdit screen.
Important: This step provides an overview of how to configure a CimEdit screen for a
class. It assumes that you are familiar with CimEdit configuration, which is essential for
creating an effective class CimEdit screen. For details about CimEdit configuration, see
the "CimEdit Operation Manual," GFK-1396.
Tasks to create a class CimEdit screen for a class include:
Task 1. Place the required objects on the screen. See page 11-62.
Task 2. Group the objects into a top-level group. See page 11-63.
Task 3. Enter class specifications for the top-level group. See page 11-65.
Task 4. Apply class attributes (variables) to CimEdit objects within the top-level
group. See page 11-68.
Task 5. Associate the CimEdit screen with its class. See page 11-71.
11-62 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 8. Configure a Class CimEdit Screen
Task 1. Place the required objects on a screen.
You can use any of the thousands of CimEdit objects on a class CimEdit screen. The type
and number of objects you place on the screen depends on the class requirements..
Tip: Configure the other Before you configure a Class CimEdit screen,configure the
Example: Objects placed on a Class CimEdit screen.
Objects Placed on a CimEdit Screen: Geftank Class Example
Text
Trend ActiveX
Tank group
object from the
Object Explorer
Text
End of example.
GFK-1180J Configuring Classes 11-63
Step 8. Configure a Class CimEdit Screen
Task 2. Group the Objects.
When you group the objects you create a new object called a group object. This group
becomes the source object for the class object graphic that appears on object CimEdit
screens.
Task 2. Group the objects:
1. Click the Select button on the CimEdit toolbar.
2. Draw a box around all of the objects as follows.
A. Hold the left mouse button down.
B. Drag the cursor around all of the objects to be included in the group.
A gray dotted line appears around the objects.
Selecting
objects in
CimEdit.
3. Release the left mouse button.
The objects are selected.
11-64 CIMPLICITY User's ManualDecember 2000 GFK-1180J
4. Click the Group button on the CimEdit toolbar.
Result: The individual objects are grouped together into a top-level group object.
Object
group
See the "Creating a Preliminary Layout" chapter in the CimEdit Operation
Manual, GFK-1396, for other methods to create groups.
GFK-1180J Configuring Classes 11-65
Step 8. Configure a Class CimEdit Screen
Task 3. Configure the Top-level Group Object
A CimEdit class group object requires a name. The class group object becomes the
source for graphics that are created for CIMPLICITY class objects.
In addition, a variable must be assigned to the class (group) object that CIMPLICITY
will substitute with the appropriate (class) object name.
Task 3. Configure the top-level group object:
1. Open the Object - Group Properties dialog box as follows:
A. Right-click the group object.
B. Select Properties from the popup menu.
2. Name the top-level group object as follows.
A. Select the General tab.
B. Enter a name, e.g. object, in the Name Field.
C. Click Appl y.
(Object) displays on the title bar of the Properties - Group dialog box.
1 Enter an
Object name.
2 Click Apply.
3 The name displays on the
Title bar.
Name a Group Object: GefTank Class Example
3. Assign the CIMPLICITY $OBJECT variable to the top level group object as
follows:
A. Select the Variables tab in the Properties - Group dialog box.
B. Enter $OBJECT in the Variable field. See page 11-31 for details about
$OBJECT.
11-66 CIMPLICITY User's ManualDecember 2000 GFK-1180J
C. Check Public.
D. Click OK.
Result: When an object that is created from the class is dragged into CimEdit, a class
object graphic is created. The name of the object is substituted for {$OBJECT} in
expressions during runtime.
GFK-1180J Configuring Classes 11-67
Example: Source and class object names used.
1 Source Object Name
Enter a name for the
group object in the
source object's
Properies dialog box.
B Object
The name displays
on the Class Object
tab in the object's
Properties dialog
box.
A Class
A
B
2 Object Name
B Object
The object name
displays on the
Variables tab in the
object's Properties
dialog box.
Enter $OBJ ECT on
the Variables tab in
the source object's
Properties dialog
box.
A Class
A
B
End of example.
11-68 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 8. Configure a Class CimEdit Screen
Task 4. Assign Properties to Objects within the Group
You can assign expressions and variables to a group of objects and objects that are
included in the top-level group the same way you assign them on any CimEdit screen.
The values you enter are values from the Class configuration, e.g. data items that become
point IDs when an object is created from the class.
Task 4. Assign properties to obj ects within the group:
1. Put the top level group in Group Edit mode as follows:
A. Select the top-level group.
B. Click the Group Edit button on the CimEdit toolbar.
The Container toolbar appears. You can now select any object in the group.
If the object is a nested group, you can configure or open that group.
2. Right-click a group or object to which you want to attach an expression.
3. Select Properties on the popup menu.
Container toolbar
4. Select the appropriate tab for configuration.
5. Enter {$OBJECT}.data item
Where
{$OBJECT} references the object that is created from the class.
Data item specifies the class data item that will become a point that is
associated with the class object.
GFK-1180J Configuring Classes 11-69
Exampl e
{$OBJECT}.LEVEL
5. Click Appl y or OK.
6. Follow the same procedure to create as many objects as should be available to
an object designer.
Result: When a class object is dragged into CimEdit the selected class object
graphic will include, but not display, the configuration. During runtime CimView
substitutes the class object name for {$OBJECT} in order to use the object's point
ID.
11-70 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Example: Create a source object expression.
1 Class
A Apply class
attributes and data
items to CimEdit
object expression
fields in the source
Properties dialog
box.
2 Object
Configuration is:
B Not visible in the
class object
dialog box.
C Controls the
CimView display.
A
B
C
End of example.
GFK-1180J Configuring Classes 11-71
Step 8. Configure a Class CimEdit Screen
Task 5. Associate the Screen with its Class
You can associate the CimEdit screen with the class at any time during configuration.
You simply enter the screen name on the General tab in the Class dialog box.
Task 5. Associate the CimEdit screen with its class:
1. Open the Class dialog box for the class with which the screen will be associated.
2. Select the General tab.
3. Enter the CimEdit screen name in the Graphics file field that will be associated
with the class
The selected CimEdit screen contains the source objects that are available to
object designers.
4. Enter the name, in the Default Graphic field, of the CimEdit object that appears
as the default when a class object is dragged to a new CimEdit screen.
CimEdit file that
contains class
object graphics.
Graphic that gets
placed when an
object is dragged
to a new CimEdit
screen.
Result: When an object that is created from the class is dragged from the
Workbench into a new CimEdit screen, a class object graphic, which is linked to
the class source graphic appears.
An object designer can select another object in the default object's Properties dialog
box.
11-72 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Example: Use class CimEdit screens with more than one object.
Object Name:
Output Valve
Object Name:
Object
A
A Configure
objects on
class CimEdit
screen.
B
1 Class
B Select Output
Valve as the
default graphic.
GFK-1180J Configuring Classes 11-73
2 Object
A The default
CimEdit object
appears when
a class object
is dragged to a
new screen.
B Object
designers
can select a
different
graphic on
the Class
Object tab.
A
B
End of example.
11-74 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 9. Create a Class Help File
You can associate a custom help (.hlp) file that is created using a third party tool with a
class. The help file will assist object designers when they are configuring point objects
based on the point class.
In order to make the help file specific to the class you are creating, it is recommended
that you write the help file after you configure the other class components.
Note: Refer to the documentation from your help-based software for details about
creating custom help files.
Compatible software sources include, but are not limited to:
RoboHELP.
Doc-To-Help.
Step 9. Associate a custom help file with a cl ass:
1. Select the General tab in the Class dialog box.
2. Enter the name of the help file in the Help file field.
Result: When an object designer presses F1 or clicks Help in the Object dialog
box, the table of contents for the specified help file appears.
GFK-1180J Configuring Classes 11-75
Step 10. Export or Import a Class
The power of the class becomes particularly apparent when you export a class from one
project and import it into another.
Tasks include:
Task 1. Export a class to a .soc file. See page 11-75.
Task 2. Import a class. See page 11-76.
Step 10. Export or Import a Class
Task 1. Export a Class
You can export a point class using the class popup menu options.
Exported point class files:
Have a .soc extension
Can be imported into other CIMPLICITY projects.
To export a point class:
1. Right-click the Classes icon in the Workbench left pane.
2. Select Export from the popup menu.
3. Navigate to the location where you will save the point class file.
4. Enter <ClassName>.soc
Where
<ClassName>is the name of the class.
.soc is the class file extension.
11-76 CIMPLICITY User's ManualDecember 2000 GFK-1180J
4. Click Save.
Result: CIMPLICITY includes the class components in the .soc file as follows:
Component Folder Retrieved from:
Class configuration Classes
Scripts (.bcl) files Scripts
CimEdit (.cim) files Screens
.soc File
Attributes
Class
Configuration
When a .soc file is exports, CIMPLICITY gathers the
class components from the Workbench.
Data Items
Scripts
Actions
Events
.bcl files
.cim file
A class developer can now modify the class to meet any different requirements for the
project.
An object designer can immediately create objects with associated CimEdit/CimView
screens.
Step 10. Export or Import a Class
Task 2. Import a Class
You can import a point class that has been exported to a .soc file into another
CIMPLICITY project using the class popup menu options.
To import a point class to a project:
1. Right-click the Classes icon in the Workbench left pane.
2. Select Import from the popup menu.
The Open dialog box opens.
3. Navigate to the location of the point class .soc file that will be imported.
GFK-1180J Configuring Classes 11-77
4. Double-click the selected .soc file.
The Workbench displays.
5. Press F5 to refresh the screen.
Result: CIMPLICITY distributes the .soc file components as follows:
Component Folder Distributed to:
Class configuration Classes
Scripts (.bcl) files Scripts
CimEdit (.cim) files Screens
.soc File
Attributes
Class
Configuration
When a .soc file is imported, CIMPLICITY distributes the class
components in the Workbench.
Data Items
Scripts
Actions
Events
.bcl files
.cim file
A class developer can now modify the class to meet any different requirements for the
project.
An object designer can immediately create objects with associated CimEdit/CimView
screens.
11-78 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Definitions for Classes Terminology
Following are some definitions that are useful in understanding point classes and objects.
Attribute
A category of information to which a value will be assigned. The category is the general
information, while the value is the more specific information.
Exampl e:
1. An attribute called 'Manufacturer' is configured, and
2. When the object is created, the value of the Attribute 'Manufacturer' is specified
as 'General Electric'.
Class
An object type: a group of objects that have the same properties, operations, and
behaviors. In this case, the class is defined for configuring a group of points.
Class developer
Person responsible for planning and building a class. The Class developer will determine
the application for which the class will be used and then accordingly plan the associated
attributes, data items and graphics.
Data Item
A data item is a template for a point definition. A data item becomes a CIMPLICITY
point when the class is instantiated into an object.
Instantiation
Producing a particular object from its point class template. This involves allocation of a
structure with the types specified by the template and initialization of attributes with
either default values or those provided by the user.
Just-in-Time Data Item
J ust-in-Time (J IT) data items are not written to the point database when an object is
instantiated; rather, the point configuration is created on demand. J IT data items are
exclusive to point classes.
Object
In object-oriented design or programming, a self-contained item with instructions for the
operations to be performed on it. In this case, a point object that will conform to the point
class template for all configured data items, attributes, and graphics.
Object Developer
Person who will create an object by assigning values to the class attributes and select
associated graphics from the graphics library in order to support an application.
Operator
Person who will use the data and view the graphics screens from the instantiated object as
an integral part of monitoring and maintaining an application.
Classes can contain two member types:
Data Items
Configured data items
J ust-in-time (J IT) data items
Attributes
CIMPLICITY attributes.
Custom attributes.
GFK-1180J 12-1
Configuring Class Objects
About Point Objects
A Point Object is a group of points and associated attributes that are based on a point
class template. An object is an "instance" of a class. Once class attribute values have been
specified in the Object dialog box and expression evaluation takes place, the object is
created and related points are configured and added to the point database. The exceptions
to the rule are data items that have the "J ust-in-Time" (J IT) option checked: J IT points are
not created until requested by an application.
Objects can be added and modified at runtime as long as the class file is the same in the
master and data directories. Point classes, on the other hand, cannot be modified at
runtime. Once changes are made to a point class, the project must be stopped and a
configuration update must be performed to effect changes, and then the project must be
restarted.
One of the benefits of instantiating a point object from a point class is the association of a
graphics file. You can create a graphics file in CimEdit and associate it with a point class,
so that multiple objects instantiated from the class will have access to the graphics file.
This is a convenient feature when creating objects for multiple pieces of identical
equipment or processes within your factory.
An Object:
Uses a point class as a template for points and attributes.
Is an instance of a point class.
Can be dragged and dropped onto a CimEdit screen to display associated graphics
file and point data.
Can be added and modified during project runtime.
Simplifies and expedites point configuration.
Important: Before you can configure a point object, you must create a point class. See
"Configuring Point Classes" for information and instructions.
12-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Definitions
Here are some definitions that are useful in understanding point classes and objects.
Attribute
A category of information to which a value will be assigned. The category is the general
information, while the value is the more specific information.
Exampl e
1. An attribute called 'Manufacturer' is configured, and
2. When the object is created, the value of the Attribute 'Manufacturer' is specified
as 'General Electric'.
Class
An object type: a group of objects that have the same properties, operations, and
behaviors. In this case, the class is defined for configuring a group of points.
Class Designer
Person responsible for planning and building a class. The Class Designer will determine
the application for which the class will be used and then accordingly plan the associated
attributes, data items and graphics.
Data Item
A data item is a template for a point definition. A data item becomes a CIMPLICITY
point when the class is instantiated into an object.
Instantiation
Producing a particular object from its point class template. This involves allocation of a
structure with the types specified by the template and initialization of attributes with
either default values or those provided by the user.
Just-in-Time Data Item
J ust-in-Time (J IT) data items are not written to the point database when an object is
instantiated; rather, the point configuration is created on demand. J IT data items are
exclusive to point classes.
Object
In object-oriented design or programming, a self-contained item with instructions for the
operations to be performed on it. In this case, a point object that will conform to the point
class template for all configured data items, attributes, and graphics.
Object Developer
Person who will create an object by assigning values to the class attributes and select
associated graphics from the graphics library in order to support an application.
Operator
Person who will use the data and view the graphics screens from the instantiated object as
an integral part of monitoring and maintaining an application.
GFK-1180J Configuring Class Objects 12-3
What happens when an object is instantiated?
The following diagram illustrates the process when an object is instantiated.
Object is added
to project.
Write
Object
Object Construction Process
New object
Custom values
Expressions
evaluated
Attributes
Data items
Graphic file
Points
configured
User enters custom
values for attributes
CIMPLICITY HMI
CimView PCP Trend
Graphic and configured points can
be viewed in CIMPLICITY.
Point Class
Object dialog
Expressions
Points
Object
12-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
About the Object Dialog Box
Before you begin to assign values to the fields in the Object dialog box, it is important to
understand its relationship to the point class attributes. The configuration of the Object
dialog box is dynamic and changes based on the values assigned in the Attribute dialog
box during the creation of a point class. Numbers correspond to those listed on the
illustration.
Attribute properti es determine:
1. Fields and field position on Object property pages.
2. Titles for property pages (tabs).
3. Prompt or field name for the attribute on the Object property page.
4. Help string when cursor is hovered over the field in the Object dialog box.
5. The Browser type when the Browse or Popup buttons are used next to a field
(guides you in selecting the correct value for the field).
Note: If the point class has at least one data item with alarm criteria, the alarm routing
page (tab) will be automatically added to the Object properties dialog box. This enables
you to configure the default alarm routing.
1
2
Object dialog as it corresponds to Class Attribute properties
Specifies the device to be used
by the data items (required).
3
4
5
GFK-1180J Configuring Class Objects 12-5
Create Point Object
You can create new point objects using the Objects applet in the Workbench
directory. In the CIMPLICITY environment there is more than one method for accessing
the New Object dialog box as described belowsee figure.
To create a point object:
Method 1 File menu
1. Click on the Objects applet in the Workbench directory.
2. Click File on the menu bar.
3. Select New>Object from the pullout menu.
Method 2 Popup menu
1. Right-click on the Objects applet in the Workbench directory.
2. Select New from the popup menu.
Method 3Quickest
Double-click on the Objects applet in the Workbench directory.
Result: Using any of the above methods, the New Object dialog box will display.
Continue from Methods 1-2-3
1. In the Object ID field, type a unique name for the object.
2. In the Class ID field, click to browse for the point class that will be used as
the template.
Note: If a point class must be created, click and select New from the pullout
menu. Go to "Configuring Point Classes" Configuring Point Classes chapter for
information and instructions on creating a point class.
3. Click OK.
Result: The Object properties dialog box displays.
12-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Example of double-click method
Popup
Browse
1. Double-click the
Objects applet.
3. Browse for or create a new
point class to be used as the
template for the object.
2. Type a unique
name for the
Object ID.
Important: The Object ID must be no more than 15 characters in length. It can contain
alphanumeric characters and underscores, and must begin with an alphabetic character.
Guide For our sample point object, we are creating an object called Tank1 based on the
GefTank point classsee figure above.
GFK-1180J Configuring Class Objects 12-7
Configure Object Properties
The type of information available to you is dependent upon the Attribute properties of the
point class. Since you customize the information to suit your needs for point
configuration, the fields, instantiation types, browser types and property pages (tabs) will
vary class to class.
When you originally create a new object, the blank Object properties dialog box will
display, with the object ID noted in the title barsee figure.
Blank Object properties dialog box
Object ID noted in
title bar.
Indicates class
has one or more
data items with
alarm criteria.
Note: The above figure is representative of the dialog box that displays when using our
sample point class as a template. This does not necessarily represent the dialog box that
will display when you create an object based on your configured point class.
12-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Assign Attribute Values
In the Object properties dialog box, assign values for each of the attributes as needed to
construct the point data. For our sample point object, we are assigning values to support
the configuration of points for the data that we want to collect and evaluate.
Data to be col lected and evaluated:
tank level
input flow rate
output flow rate
temperature
alarm for high level
alarm for low level
warning for high level
warning for low level
GFK-1180J Configuring Class Objects 12-9
General tab values
To assign values:
1. In the Maximum Level field, we entered 100. The mixing tanks in our factory
have a maximum capacity of 100 Liters.
2. In the Base Address field, we entered %R100. This is the base address for our
register inputs on Tank1 before the address adjustment expression is calculated.
3. In the Output Address field, we entered %Q0. This is the base address for our
discrete outputs on Tank 1 before the address adjustment expression is
calculated.
4. In the Description field, we entered Mixing Tank.
5. In the Device ID field, we browsed for and selected the appropriate device for
Tank 1.
6. In the EU Label field, we entered L for Liters.
7. In the Resource ID field, we browsed for and selected the appropriate resource
for Tank.
Result: The values entered will be used during object construction for point
configuration.
Popup
Attribute values for sample point object
Browse
Tank level.
Base address for
register inputs.
Base address for
discrete outputs.
Tank description.
Device for data items.
Label for engineering
units.
Resource for data items.
12-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarm tab values
To assign values:
1. In the Alarm High field, we entered 100 so that an alarm will generate when the
tank reaches 100 liters.
2. In the Warning High field, we entered 90 so that a warning will generate when
the tank reaches 90 liters.
3. In the Warning Low field, we entered 50 so that a warning will generate when
the tank reaches 50 liters.
4. In the Alarm Low field, we entered 10 so that an alarm will generate when the
tank reaches 10 liters.
5. In the Alarm Class field, we browsed for and selected the appropriate alarm
class for Tank 1.
Result: The values entered will be used during object construction for point
configuration.
Popup
Attribute values for sample point object
Browse
GFK-1180J Configuring Class Objects 12-11
Alarm Routing tab values
When creating the point class, if one or more data items contain alarm criteria, the Alarm
Routing page (tab) will automatically display in the Object properties dialog box. This
enables you to configure default alarm routing for your object.
The alarm routing configuration is applied to all data items with alarms in the point class.
Alarm routing can always be changed for an object data item using point configuration.
To assign values:
In the Configured roles for alarm list, we added SYSMGR and USER. These users will
have access privileges to respond to alarms.
Result: The value entered will be used during object construction for point
configuration.
Adds or removes
roles from list.
Launches Role
Properties dialog box.
Launches New Role
dialog box.
Configured roles that
have privilege to
respond to alarms.
Alarm routing values for sample point object
Note: You can also modify role properties and create new roles from this page.
12-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Add Point Object to Project
Once all of the required values have been assigned and any optional values to support
your point object, add the point object to your project.
To add point object to project:
Click OK in the Object properties dialog box.
Result:
The point object will display in the right pane of the Workbench.
Points are configured based on values provided in the Object properties dialog box.
Points are added to the point database.
Click OK to add
the object to your
project.
Click on the
Points applet to
view the
configured points.
Points
configured
for Tank1
Object.
Add point object to project
View configured points
Tip: Click on the Points icon in the Workbench directory to see configured points.
GFK-1180J Configuring Class Objects 12-13
A Look at the Finished Sample Point Object
Once all of the required and necessary optional attributes have been configured, the
sample point object is added to our project. Here is a look at the finished object as viewed
in CimView, the Point Control Panel, and in a Quick Trend graph.
There is enormous flexibility in the ability to modify properties and points. You can
dynamically modify eligible properties using the Object dialog box or point and property
dialog boxes accessed through the different applications.
Sample Point Object in CimView
In order to view our sample point object in CimView, we right-clicked on the object in
the right pane of the Workbench, and selected QuickView from the popup menusee
figure.
Tank graphic
Description
EU Label
Quick Trend
Configured point
Object viewed in CimView
Tank level
12-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Sample point object in the Point Control Panel
In order to view and monitor points configured for our sample point object, we simply
right-clicked on the object in the right pane of the Workbench and selected Point Control
Panel from the popup menusee figure.
Configured points viewed in the Point Control Panel
Click to add configured
points for another object.
Tip: Objects can be dragged and dropped into the Point Control Panel for quick viewing
of configured points.
GFK-1180J Configuring Class Objects 12-15
Sample point object in a Quick Trend graph
In order to view configured points in a Quick Trend graph for our sample points object,
we clicked on the Trend control on our Tank object in CimViewsee figure.
Configured points and
values on trend graph.
Configured points view in Quick Trend graph
Tip: Right-click on the object in the right pane of the Workbench and select Quick
Trends from the popup menu to view configured points in a trend graph.
12-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Working with Point Objects
Once you have created one or more point objects in your project, you can perform several
functions directly from the Workbench.
You can:
view point objects.
examine configured points in the Point Control Panel.
view configured points in a Quick Trend graph.
drag and drop an object onto a CimEdit screen to view graphic file.
view runtime data in CimView.
edit point object properties dynamically.
modify object data items using point properties.
search for a point object by object ID, class ID, or description.
delete point objects.
duplicate point objects.
GFK-1180J Configuring Class Objects 12-17
View Point Objects
To view point objects in the Workbench:
Method 1 View menu
1. In the left pane of the Workbench, click the Objects applet .
2. Click View on the menu bar.
3. Select from one of four view options:
Large icons
List
Details
Tree
Method 2 Toolbar buttons
1. In the left pane of the Workbench, click the Objects applet .
2. Click one of four buttons on the toolbar for viewing option:
a. List view
b. View details
c. Large icons
d. View tree
Result: Using either method, the point objects will display the selected view in the right
pane of the Workbenchsee figure.
Workbench views of point objects
Click on Objects
applet to view point
objects in right pane
of the Workbench.
Details view
Select one of four
views from the View
menu or toolbar.
List view
Tree view
Large icons view
12-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
View Configured Points in Point Control Panel
You can view the configured points in the Point Control Panelsee figure.
To view configured points in the Point Control Panel:
Method 1 Popup menu
1. Click on the Objects applet in the Workbench.
2. Right-click on the object in the right-pane of the Workbench.
3. Select Point Control Panel from the popup menu.
Method 2- Drag and drop
1. Expand the Runtime folder in the Workbench.
2. Double-click on the Point Control Panel applet.
3. Click on the Objects applet in the Workbench.
4. Drag the object from the right pane of the Workbench on the Point Control
Panel screen.
Result: Using either of the above methods, the points configured for the object will
display in the Point Control Panel.
Note: In order to view runtime data in the Point Control Panel, make sure that your
project is running.
Configured points in object viewed in Point Control Panel
1. Click on
Objects applet.
2. Right-click
on object.
3. Select Point
Control Panel from
popup menu.
Configured points
for Tank1 object.
GFK-1180J Configuring Class Objects 12-19
Add Configured Points to the Point Control Panel
You can add configured points from other objects to the Point Control Panel viewsee
figure.
To add configured points from an object:
Method 1 Edit menu
1. In the Point Control Panel, click Edit on the menu bar.
2. Select Add Objects to display the Select a Object dialog box.
3. Double-click the object.
Method 2 Popup menu
1. Right-click on the object in the right pane of the Workbench.
2. Select Point Control Panel from the popup menu.
Method 3 Drag and drop
1. Open the Point Control Panel.
2. Drag and drop objects from the right pane of the Workbench into the Point
Control Panel.
Method 4 Toolbar button
1. In the Point Control Panel, click Add Objects button to display the Select
a Object dialog box.
2. Double-click the object.
Result: Using any of the above methods, points configured for the object will display in
the Point Control Panel.
Adding configured points from another object
1. Click Add Object button. 2. Double-click the object.
Points configured for the object
display in the Point Control Panel.
12-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Note: In order to view runtime data in the Point Control Panel, make sure that your
project is running.
GFK-1180J Configuring Class Objects 12-21
View Configured Points in a Quick Trend Graph
You can view the configured point in a Quick Trend graphsee figure.
To view configured points in a Quick Trend graph:
1. Click on the Objects applet in the Workbench.
2. Right-click on the object in the right-pane of the Workbench.
3. Select Quick Trends from the popup menu.
Result: The points configured for the object will display in the a Quick Trend graph.
Note: In order to view runtime data in the Quick Trend graph, make sure that your
project is running.
Configured points in object viewed on Quick Trend graph
1. Click the
Objects applet.
2. Right-click
the Object.
3. Select Quick
Trends.
Configured
points shown in
trending graph.
12-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Drag and Drop Object into CimEdit
You can drag and drop objects that have an associated graphic file into CimEdit. The
graphic will take shape and display point data on screen as configuredsee figure.
To drag and drop object:
1. Double-click on the Screens applet in the Workbench to display a blank
CimEdit screen.
2. Click on the Objects applet in the Workbench.
3. Drag the object from the right pane of the Workbench onto the CimEdit screen.
Result: The graphic will take shape and the configured points will display. You can
modify eligible properties in CimEdit.
Note: Your project must be running to perform the above procedure.
Drag and drop object onto CimEdit screen
1. Double-click Screens
applet to launch a new
CimEdit screen.
2. Click Objects applet.
3. Hold down the left mouse button
and drag the object onto the CimEdit
screen to display the graphic and
configured points.
Configured points
Tank graphic
GFK-1180J Configuring Class Objects 12-23
View Runtime Data in CimView
To view runtime data:
Method 1
With your graphic displayed in CimEdit, click the Runtime button on the
toolbar.
Method 2
1. Click on the Objects applet in the Workbench.
2. Right-click on the object to be viewed in the right pane of the Workbench.
3. Select QuickView from the popup menu.
Result: Using either method, runtime data for the configured points are displayed in
CimViewsee figure.
Continue from Methods 1-2
1. To trigger another object in CimView, right-click on the graphic.
2. Select Trigger Smart Object from the popup menu.
3. In the Select a Object window, double-click on the object to be viewed in
CimView.
A. To view runtime data in CimView
B. To trigger a different object
B1. Right-click on
graphic.
B2. Select Trigger
Smart Object.
B3. Double-click on object
you want to view.
A1. Right-click
on object in
Workbench.
A2. Select
QuickView.
12-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Edit Point Object Properties
You can dynamically edit an object's properties during runtime. All of the properties in
the Object dialog box are eligible for modification.
To edit object properties:
Method 1 Edit menu
1. Click the Objects applet in the Workbench.
2. Click on the object in the right pane of the Workbench window.
3. Click Edit on the menu bar.
4. Select Properties.
Method 2 Popup menu
1. Click the Objects applet in the Workbench.
2. Right-click on the object in the right pane of the Workbench window.
3. Select Properties.
Method 2 Quickest
1. Click the Objects applet in the Workbench.
2. Double-click on the object in the right pane of the Workbench window.
Result: Using any of the above methods, the Object properties dialog box displays.
Continue from Methods 1-2-3 above
1. Edit properties as needed.
2. Click Appl y or OK to effect changes.
GFK-1180J Configuring Class Objects 12-25
Modify Object Data Items Using Point Properties
Once an object is created, its points are configured based on values provided in the
Object properties dialog box. You can modify a configured point like you would any
other point using the Point Properties dialog box. There are, however, certain properties
that cannot be modified and those fields will appear dimmed in the dialog boxsee
figure.
All properties are eligible for revision with the following exceptions:
Attributes that are expression targets.
Data type.
Number of elements.
Device ID and addressing.
Virtual point equations.
To modify an object data item (configured point):
Method 1 Popup menu
1. In the left pane of the Workbench, click the Points applet .
2. Scroll through the points list in the right pane of the Workbench until you locate
the point to be modified.
3. Right-click on the point and select Properties from the popup menu.
Method 2 Quickest
1. In the left pane of the Workbench, click the Points applet .
2. Scroll through the points list in the right pane of the Workbench until you locate
the point to be modified.
3. Double-click on the point.
1. Click
Points applet.
2. Double-
click point. Dimmed fields are not
eligible for modification.
Active fields are eligible
for modification.
Example of object data item modified through Point Properties
Result:
The Point Properties dialog box will display.
Modify eligible properties as needed (active fields only).
Inactive fields (dimmed) are not eligible for modification.
12-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Search Function
You can search for a point object by object ID, class ID, or description using the Object
search dialog boxsee figure.
To search for a point object:
Method 1 View menu
1. In the left pane of the Workbench, click the Objects applet .
2. Click View on the menu bar.
3. Select Search.
Method 2 Popup menu
1. Right-click on the Objects applet in the left pane of the Workbench.
2. Select Search from the popup menu.
Method 3 - Quickest
1. In the left pane of the Workbench, click the Objects applet .
2. Click on the toolbar.
Result: From any of the above methods, the Object search dialog box displayssee
figure.
Continue from Methods 1-2-3
1. Type data in one or more of the following fields:
Object ID
Class IDtype in data or use the Browse button.
Description
2. Click OK to view the search result in the right pane of the Workbench.
4. Click OK to view
search result in
right pane of
Workbench.
Search for Point Object
Search result
3. Type Object ID, Class ID or
description for search criteria.
2. Click Search
button.
1. Select
Objects
applet.
GFK-1180J Configuring Class Objects 12-27
Delete Point Object
To delete a point object:
Method 1 Edit menu
1. In the left pane of the Workbench, click the Objects applet .
2. Click on the point object to be deleted in the right pane.
3. Click Edit on the menu bar.
3. Select Delete.
Method 2 Popup menu
1. In the left pane of the Workbench, click the Objects applet .
2. Right-click on the point object to be deleted in the right pane.
3. Select Delete from the popup menu.
Method 3 Delete key
1. Select the point object to be deleted in the right pane of the Workbench.
2. Press Delete on your keyboard.
Method 4 Delete button
1. Select the point object to be deleted in the right pane of the Workbench.
2. Click on the toolbar.
Result: From any of the above methods, a confirmation box will display.
Continue from Methods 1-2-3-4
1. Click Yes in the confirmation box to delete the selected point object from the
Workbench.
or
Click No to cancel the operation.
Caution: All points configured for the object will be deleted from the point database.
12-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Duplicate Point Object
You can duplicate a point object in a project and modify it using the Object properties
dialog box. This function comes in handy if you have one or more point objects that have
a number of identical propertiessee figure.
To duplicate a point object:
Method 1 Edit menu
1. In the left pane of the Workbench, click the Objects applet .
2. From the right pane, select the point object to be duplicated.
3. Click Edit on the menu bar.
3. Select Duplicate.
Method 2 Popup menu
1. In the left pane of the Workbench, click the Objects applet .
2. Right-click on the point object in the right pane to be duplicated.
3. Select Duplicate from the popup menu.
Method 3 Toolbar button
1. In the left pane of the Workbench, click the Objects applet .
2. Click on the object to be duplicated.
3. Click on the toolbar.
Result: From any of the above methods, the Duplicate Object dialog box displayssee
figure.
Continue from Methods 1-2-3
1. In the Destination object field, type a unique name for the new object.
2. Click OK.
Result: The duplicated object will display in the right pane of the Workbench, and can
be modified using the Object properties dialog box.
GFK-1180J 13-1
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.
$LOCAL.COMPUTER $PROJ ECT.DATE.AMPM
$LOCAL.WINUSER $LOCAL.DATETIME
$PROJ ECT.COMPUTER $LOCAL.DATE.YEAR
$PROJ ECT $LOCAL.DATE.MONTH
$PROJ ECT.AVAILABLE $LOCAL.DATE.DAY
$PROJ ECT.LOGGEDIN $LOCAL.DATE.WEEKDAY
$PROJ ECT.DEVICES $LOCAL.DATE.DAYOFYEAR
$PROJ ECT.USERS $LOCAL.DATE.WEEK
$PROJ ECT.DATETIME $LOCAL.DATE.HOUR
$PROJ ECT.DATE.YEAR $LOCAL.DATE.HOUR12
$PROJ ECT.DATE.MONTH $LOCAL.DATE.MINUTE
$PROJ ECT.DATE.DAY $LOCAL.DATE.SECOND
$PROJ ECT.DATE.WEEKDAY $LOCAL.DATE.SECOFDAY
$PROJ ECT.DATE.DAYOFYEAR $LOCAL.DATE.AMPM
$PROJ ECT.DATE.WEEK $USER.ALARMS
$PROJ ECT.DATE.HOUR $ALARM.TOTAL
$PROJ ECT.DATE.HOUR12 $ALARM.ACKED
$PROJ ECT.DATE.MINUTE $ALARM.UNACKED
$PROJ ECT.DATE.SECOND $ALARM.ACTIVE
$PROJ ECT.DATE.SECOFDAY $CLASS_<Alarm class name>.ALARMS
$PROJ ECT.DATE.AMPM $CLASS_<Alarm class name>.UNACKED
13-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
$LOCAL.COMPUTER
Point Type Local Point
Data Type STRING (15)
Access Read Only
Description Local Computer Name
$LOCAL.WINUSER
Point Type Local Point
Data Type STRING (20)
Access Read Only
Description Windows user name
$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 || !$PROJ ECT.AVAILABLE
1: Logged in && $PROJ ECT.AVAILABLE
GFK-1180J Using System Points 13-3
$PROJECT.DEVICES
Point Type Server Point
Data Type Integer
Access Read Only
Description Number of devices online
$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
Point Type Server Point
Data Type Integer
Access Read Only
Description Current day in the month (1-31)
13-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
$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
Point Type Server Point
Data Type Integer
Access Read Only
Description Current hour in the day (1-12)
$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)
GFK-1180J Using System Points 13-5
$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
Point Type Local Point
Data Type Integer
Access Read Only
Description Local Date and Time in seconds from 1/1/1970
$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)
13-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
$LOCAL.DATE.DAYOFYEAR
Point Type Local Point
Data Type Integer
Access Read Only
Description Current day in the year (1-366)
$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
Point Type Local Point
Data Type Integer
Access Read Only
Description Second past the minute (0-59)
$LOCAL.DATE.SECOFDAY
Point Type Local Point
Data Type Integer
Access Read Only
Description Second past midnight (0-86399)
GFK-1180J Using System Points 13-7
$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
Point Type Server Point
Data Type Integer
Access Read Only
Description Alarms acknowledged
$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
13-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
$CLASS_<Alarm class name>.UNACKED
Point Type Server Point
Data Type Integer
Access Read Only
Description Unacknowledged alarm count by class
GFK-1180J 14-1
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 project's 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:
Review where it is located and how it is used
Make modifications
3. 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.
14-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 Point Cross Reference.
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.
Result: The result of using either method depends on the status of the project's
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
To update the PtXRef Database before the PtXRef Point Explorer window
opens:
Simply click the Yes button.
GFK-1180J Point Cross Reference 14-3
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. Click the Build button on the Point Cross Reference tool bar.
Method 2
1. click 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.
1. Select the subsystems to be included in the PtXRef database.
2. Click OK.
14-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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
Tree view
Text only
Full view
List of points
GFK-1180J Point Cross Reference 14-5
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.
14-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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
Point count
Valid point
type
Point ID
Title bar
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.
GFK-1180J Point Cross Reference 14-7
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. Click 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
Left pane sorted
by Point ID
Only used points
will display
Tree view enabled
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
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.
14-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. Click 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. click PtXRef on the Point Cross Reference menu bar.
2. Select Refresh.
Result: CIMPLICITY HMI scans the point table and displays the current
information.
GFK-1180J Point Cross Reference 14-9
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
Subsystem Point use
Text view
Tree view
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)
14-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. Click 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:
Points Resource ID, Elements, Description
Scripts What scripts are using the point
Event What events are using the point
GFK-1180J Point Cross Reference 14-11
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. Right-click the instance you want to modify.
4. Select Open from the popup menu.
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
Database Logger Database Logger Configuration window
14-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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
1. Click the Build button on the Point Cross Reference tool bar.
2. The Build PtXRef Database dialog box appears.
3. Check the subsystems you want to include in the database.
Method 2
1. Click 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
GFK-1180J Point Cross Reference 14-13
To rebuild the PtXRef database:
1. Click 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.
14-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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. Click theOpen button on the Point Cross Referencetoolbar.
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. Click 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 down menu.
GFK-1180J 15-1
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.
Device Configuration
The Workbench displays a project's existing devices in the right pane.
To view a project's existing devices:
1. Expand the Equipment folder in the left pane of the Workbench.
2. Select Devices .
The Workbench right pane displays the following fields for devices:
Device ID The physical device identifier
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
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Device ID. The Device ID is required. See the "Selecting Fields to Display in the
Right Pane" in the "Using the Workbench" chapter in this manual for information about
the Field Chooser"
The Device list is initially sorted by Device ID. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
15-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Viewing a Device's Details in the Workbench.
You can quickly review several configuration details about a device in the Workbench
right pane, e.g. associated Point Ids
To review device configuration details in the Workbench:
1. Expand the Equipment folder in the Workbench left pane.
2. Expand Devices.
The existing devices appear in a list under Devices.
3. Select the device.
Workbench: Device Selected Example
Devices
expanded
Device selected to
review configuration
details
The Workbench right pane displays the following fields for devices:
Point ID All Point IDs that are associated with that device
Device ID ID of the selected device (which is the source of the
point data)
Resource Resource associated with the device
Point Type Type of point (e.g. UINT, INT)
Description A description that may have been entered for the
point in its Point Properties dialog box
Note: Information in the displayed fields comes from the associated point configuration.
Use the Workbench Field Chooser to remove or redisplay any of the fields, except the
Point ID. The Point ID is required
The Device list is initially sorted by Point ID. You can click on any of the other column
titles at the top of the list to sort the list by that attribute.
GFK-1180J Device Configuration 15-3
Creating a New Device
To create a new device definition:
1. Expand the Equipment folder in the left pane of the Workbench.
2. Do one of the following.
Method 1
Double-click Devices.
Method 2
A. Select Devices.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Devices.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Devices.
B. Click the New icon on the Workbench menu bar.
The New Device dialog box opens when you use any method.
New Device Dialog Box
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 device's 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 Popup button
to create a new port, edit the current port, or browse for another
port.
Click 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.
15-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Modifying an Existing Device
You modify an existing device by simply opening the device's Device dialog box and
make the modifications.
To open an existing Device dialog box:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Equipment.
3. Select Devices.
4. Do one of the following.
Method 1
Double-click a device in the right pane of the Workbench.
Method 2
A. Select a device in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select a device in the right pane of the Workbench.
B. Click the Properties button on the Workbench menu bar.
A Device dialog box associated with the selected device opens when you use any
method.
GFK-1180J Device Configuration 15-5
Configuring Device General Properties
On the General tab on the Device dialog box, 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 click the the Pop-up button to display a popup menu that provides you
with the options 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 device's 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 click the Popup button to display a popup menu that provides you with
the options to create a new resource, edit the current resource, or browse for another
resource.
Model Type
Select the type of device from the drop-down list. The list of model types depends on the
protocol.
15-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring 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.
GFK-1180J 16-1
Configuring Resources
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.
16-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Resource Configuration
The Workbench displays a project's existing resources in the right pane.
To view a project's existing resources:
1. Expand the Security folder in the left pane of the Workbench.
2. Select Resources .
The Workbench right pane displays the following attributes for each Resource:
Resource A name that uniquely identifies each resource.
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.
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields,
except the Resource. The Resource is required. See the "Selecting Fields to Display
in the Right Pane" in the "Using the Workbench" chapter in this manual for
information about the Field Chooser"
The Resource list is initially sorted by Resource. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
Creating A New Resource
1. Expand the Security folder in the left pane of the Workbench.
2. Do one of the following.
Method 1
Double-click Resources.
Method 2
A. Select Resources.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Resources.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Resources.
GFK-1180J Configuring Resources 16-3
B. Click the New icon on the Workbench menu bar.
The New Resource dialog box opens when you use any method.
New Resource Dialog Box
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.
Configuring a 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
The list of users that can view alarm or point information for this resource.
16-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
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:
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.
GFK-1180J 17-1
Configuring Ports
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.
17-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Port Configuration
The Workbench displays a project's existing ports in the right pane.
To view a project's existing ports:
1. Expand the Equipment folder in the left pane of the Workbench.
2. Select Ports .
The Workbench right pane displays the following fields for each Port:
Port The physical port identifier.
Protocol ID The protocol used for device communications.
Description Text that gives users more information about the port.
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except the
Port. The Port is required. See the "Selecting Fields to Display in the Right Pane" in the
"Using the Workbench" chapter in this manual for information about the Field Chooser"
The Port list is initially sorted by Port. You can click on any of the other column titles at the
top of the list to sort the list by that attribute.
You can create a maximum of sixteen (16) ports per project. If you attempt to create more
ports after that, an error message displays.
GFK-1180J Configuring Ports 17-3
Creating A New Port
To create a new port:
1. Expand the Equipment folder in the left pane of the Workbench.
2. Do one of the following.
Method 1
Double-click Ports.
Method 2
A. Select Ports.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Ports.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Ports.
B. Click the New icon on the Workbench menu bar.
Result: The New Port dialog box opens when you use any method.
New Port Dialog Box
Enter the following information to define the port:
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.
Click 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 port-specific properties.
17-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Modifying an Existing Port
To modify an existing port, you simply open the selected port's Port Properties dialog box and
make your modifications.
To open an existing Port Properties dialog box:
1. Expand the Equipment folder in the left pane of the Workbench.
2. Select Ports .
3. Do one of the following.
Method 1
Double-click a port in the right pane of the Workbench.
Method 2
A. Select a port in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select a port in the right pane of the Workbench.
B. Click the Properties icon on the Workbench menu bar.
A Port Properties dialog box associated with the selected port opens when you use
any method.
GFK-1180J Configuring Ports 17-5
Configuring Port General Properties
The General properties let you define the following for a new port:
Description
A Description can be 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
Retry Count specifies 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
Check the Enable check box to enable communications on this port.
Uncheck this check box to disable communications on this port.
Guide: When a port is dynamically disabled, communication to all devices associated to that
port will stop.
By default, when the port is dynamically disabled:
The associated devices will be marked Down and their associated points will be
marked Unavailable.
Setpoints and processing of unsolicited data will not be allowed for the associated
devices.
17-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Tip: As an alternative to this default action, you may configure a Global Parameter,
ALLOW_UPDATE_WHEN_DISABLED, to keep the associated devices alive.
If ALLOW_UPDATE_WHEN_DISABLED is configured, then when the port is dynamically
disabled:
The device is not marked Down.
Polling stops.
Setpoints and unsolicited messages will still be processed.
See the "System Management" chapter in this manual for a description of CIMPLICITY
HMI's global parameters.
Enable Stale Data
Check Enable stale data to keep the point available in most circumstances that would have
made it unavailable. However the point value will be stale, meaning it is the last known value
and may or may not have changed in the device.
The following table displays a point's availability when events occur and
QUALITY.STALE_DATA is configured as on or off.
Point Availability when Stale Data is Configured:
Event On Off
Poll Failure Available Unavailable
Process Shutdown Available Unavailable
System Shutdown Not Applicable Unavailable
Ind. Point Unavailable Unavailable Unavailable
Out of PTMRP Range Limits Range Bit / Available Unavailable
DC Sends Device State Available Unavailable
DynCfg Disable Point/Device Unavailable
Tip: Use QUALITY.STALE_DATA (Attribute) to report if the point value is stale.
GFK-1180J Configuring Ports 17-7
Configuring 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 about:
Allen-Bradley Communications
Allen-Bradley Data Highway Plus
Allen Bradley DF-1 Communications
Allen-Bradley Intelligent Antenna Communications
APPLICOM Device
APPLICOM Database
CCM2
DDE
FloPro/FloNet
Genius
Honeywell IPC 620 Communications
J ohnson N2
Mitsubishi A-Series Serial
Mitsubishi TCP/IP
MMS Ethernet
Modbus Plus
Modbus RTU
Modbus TCP/IP
OMRON Host Link
OMRON TCP/IP
OPC Client
Series 90 Protocol (SNP and SNPX)
Series 90 TCP/IP
Series 90 TCP/IP Triplex Communications
Seriplex
Sharp TCP/IP
Siemens TI Serial Communications
Smarteye Electronic Assembly
SNP and SNPX Communications
Square D SyMax SyNet
Toyopuc Ethernet Device Communications Module
Note: The following port types require no port-specific properties.
APPLICOM
DDE
FloPro/FloNet
Mitsubishi TCP/IP(MELSEC_A or MELSEC_B)
OMRON TCP/IP
Shart TCP/IP
17-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Procedure to Change a Port's Protocol
In your CIMPLICITY HMI project configuration, device and point data are protocol
dependent. You cannot delete a port then re-add it using another protocol if device and point
data for the original port still exist.
To change a port's protocol:
1. Export the point data for the port using the Import/Export utility if you plan to re-use
the same point data.
2. Delete the point data for the port.
3. Delete the device data for the port.
4. Delete the port.
5. Create the port with the new protocol.
6. Define the devices for the port.
7. If you exported the point data, then use the Import/Export utility to import the point
data. Otherwise, define new points.
GFK-1180J 18-1
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 alarm's 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 project's
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.
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.
18-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J Alarm Class Configuration 18-3
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.
Click 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.
18-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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."
GFK-1180J Alarm Class Configuration 18-5
Alarm Class Color Assignments
The default mappings for Alarm Colors are:
Number Red Green Blue Color
0 0 0 0 Black
1 255 0 0 Red
2 0 255 0 Lime
3 0 0 255 Blue
4 128 0 0
Maroon
5 0 128 0
Green
6 128 0 128
Purple
7 255 255 255
White
8 0 128 128 Teal
9 128 128 128 Gray
10 128 128 0 Olive
11 32 64 64 Dark
12 224 176 160 Rose
13 255 0 255
Fuchsia
14 0 255 255 Aqua
15 255 255 0
Yellow
18-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J 19-1
Alarm String Configuration
About Alarm Strings
You use Alarm Strings to name alarm states. An alarm displays the string for its alarm
state when %State is included in the alarm message.
Alarm messages are configured in the Point Properties and Alarm Definition dialog
boxes.
For analog points, you can define up to four alarm values for a point. Each value
corresponds to an alarm state; each state has a corresponding alarm string:
Point Value Alarm State %State field Display
Greater than or equal to Alarm High.
Alarm High Alarm High Msg
Greater than or equal to Warning High
and
Less than Alarm High.
Warning
High
Warning High Msg
Less than or equal to Warning Low
and
Greater than Alarm Low.
Warning
Low
Warning Low Msg
Less than or equal to Alarm Low.
Alarm Low Alarm Low Msg
Less than Warning High
and
Greater than Warning Low.
Normal Normal Msg
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 point's value is in the Normal state. Also,
note the following:
Point Value Alarm State %State field Display
1
Alarm state Alarm High Msg
0
Alarm state Warning High Msg
19-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 when the
corresponding values are defined:
Alarm High VERY HOT
Warning High HOT
Warning Low COLD
Alarm Low VERY COLD
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
An index number, which is specified when a set is defined, identifies each set of alarm
strings. You can configure up to 99 alarm string sets, numbered 1 through 99. When you
configure a point you can select the set that applies to the point for inclusion in the point's
alarm message.
The CIMPLICITY default configuration includes a set of alarm strings for Index number
1. The Index number 1 alarm string is the default when you add a device point. This string
may be modified but should never be deleted.
GFK-1180J Alarm String Configuration 19-3
Alarm String Configuration
The Workbench displays a project's existing alarm strings (message groups) in the right
pane.
Steps to configure an alarm string include:
Step 1. View existing alarm strings.
Step 2. Either:
Create an alarm string or
Open an existing Alarm String Index dialog box.
Step 3. Configure the alarm string.
Step 1. View Existing Alarm Strings
Step 1. View a project's existing alarm strings:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms .
3. Select Alarm Strings .
The Workbench right pane displays the following fields for each Alarm String
Index:
Index
Alarm High Msg
Warning High Msg
Warning Low Msg
Alarm Low Msg
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Index. The Index is required. See the "Selecting Fields to Display in the Right Pane"
in the "Using the Workbench" chapter in this manual for information about the Field
Chooser"
The Alarm Definition list is initially sorted by Index. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
19-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2A. Create an Alarm String
You create a new Alarm String in a new Alarm String Index dialog box.
Step 2A. Create an Alarm String Index dialog box:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms.
3. Do one of the following.
Method 1
Double-click Alarm Strings.
Method 2
A. Select Alarm Strings.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Alarm Strings.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Alarm Strings.
B. Click the New icon on the Workbench menu bar.
The Alarm String Index dialog box opens when you use any method.
GFK-1180J Alarm String Configuration 19-5
Step 2B. Open an Existing Alarm String Index Dialog Box
To modify an existing Alarm String Index, you simply open the selected Alarm string
Index's dialog box and make your modifications.
Step 2B. Open an existing Alarm String Index dialog box:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms.
3. Select Alarm Strings.
4. Do one of the following.
Method 1
Double-click an Alarm String in the right pane of the Workbench.
Method 2
A. Select an Alarm String in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select an Alarm String in the right pane of the Workbench.
B. Click the Properties icon on the Workbench menu bar.
An Alarm String Index dialog box associated with the selected alarm string
opens when you use any method.
19-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Configure an Alarm String Index
When you configure an alarm string index you enter the values that you want to display to
describe an alarm state. In addition, you can give the alarm a priority by specifying how
severe each state is.
New alarm string
writable index
Existing alarm string
Read-only index
String that displays
for each alarm state.
A higher severity
number gives
thealarm a higher
the priority.
Step 3. Configure an alarm string index:
1. (For new alarm strings) Use the next available alarm string index number
(default) in the Alarm string index field or enter a new, unique index number.
The new alarm string index number:
Must be from 1 to 99 and
Cannot conflict with an existing Alarm String Index.
2. Enter a string value for each of the alarm states: Alarm high, Warning high,
Warning low, Alarm low and Normal.
The string can contain up to 16 characters. The value you enter will display
when the point is in the related alarm state.
3. Enter a number from 32767 to +32767 in the Severity field for each alarm
state. The higher the number, the more severe the alarm. CIMPLICITY treats
more severe alarms with higher priority.
GFK-1180J Alarm String Configuration 19-7
The Point Manager
4. Click OK to accept or click Cancel to cancel the changes.
Result: The alarm string you entered displays when the point is in the related
alarm state. The CIMPLICITY ActiveX AMV control can display and sort alarms
according to the alarm severity.
Alarm Severity Displayed in the ActiveX Alarm Control: Example
1 Enter the Alarm state severity in the
Alarm String Index dialog box.
1
2 Check the Severity field
for a CIMPLICITY AMV
control.
(Control Properties dialog
box when the control is
placed in CimEdit)
3 The alarm severity
displays in the control.
A user can sort alarms
by severity.
Alarm String
configuration
AMV control in CimEdit
configuration
2
3
CimView
AMV Alarm Control
GFK-1180J 20-1
Alarm Configuration
About Alarms
CIMPLICITY HMI software generates alarms for:
1. Alarm messages about system events, such as device failures, program
You create and modify system event alarms in the Alarm Definition dialog box
through the Alarms folder.
Note: CIMPLICITY comes with several configured Event alarms.
2. Points that are in an alarm state.
You create point alarms in the Point Properties dialog box. You can modify them
in the Point Properties dialog box or through the Alarms folder.
Viewing Alarms in the Alarms Folder
You can view all of the alarms, event and point, that have been configured for the
CIMPLICITY project in the Workbench Alarms folder.
To view alarms in the Alarms folder:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Select Alarms .
The Workbench right pane displays the following fields for each alarm:
20-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarm ID The unique Alarm identifier for each alarm in your
configuration.
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 runtime parameters (see page 20-Error!
Bookmark not defined.).
Note: The Alarm ID must have an Alarm Type of
$CIMBASIC otherwise the alarm message may not be
displayed correctly.
Message Fixed text and runtime parameters that are displayed when
the alarm is generated.
Description A description of the alarm.
Tip: Use the Workbench Field Chooser to remove or redisplay any of the fields, except
the Alarm ID. The Alarm ID is required. See the "Selecting Fields to Display in the Right
Pane" in the "Using the Workbench" chapter in this manual for information about the
Field Chooser"
The Alarm Definition list is initially sorted by Alarm ID. You can click any of the other
column titles at the top of the list to sort the list by that attribute.
Reviewing CIMPLICITY Event Alarms
A set of CIMPLICITY event alarms is included in your base configuration. These alarms
are not associated with any single CIMPLICITY point ID during configuration.
CIMPLICITY event alarms may be modified, but they should never be deleted. They are:
CIMPLICITY Event Alarms Function During Runtime
$ALARM_DISABLED Alarm is disabled for the specified point.
$ALARM_ENABLED Alarm is enabled for the specified point
$ALARM_MODIFIED Alarm limits are modified for the specified point.
$ALARM_RAWLIM Range limits exceeded 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 Indicates if the device is up (able to
communicate) or down. When the device is up
Normal displays. When the device is down is is
in Alarm State.
Configure a separate resource for each device.
This helps separate the alarms, which would get
stacked with the same resource.
$DEVICE_DOWN Device failure message for specified device.
GFK-1180J Alarm Configuration 20-3
$DEVICE_FAILOVER Reserved for future use.
$DL_FILE_FULL Log file full message for specified log file.
$DOWNLOAD Setpoint was downloaded to specified device.
$DYN_CFG The specified entity has been changed
dynamically.
$GMR_DEV_DOWN Device down message for Series 90 TCP/IP PLC
redundancy.
$GMR_POINT_DISCREPANCY Point discrepancy alarm for Series 90 TCP/IP
PLC redundancy.
$LOGIN_FAILURE Specified user failed to log in to the specified
CIMPLICITY project.
$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.
20-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarm Configuration
Step 1. (For event alarms) Create an event alarm.
Step 2. Configure an alarm (definition).
A. For Event alarms.
B. For Point alarms.
Step 3. Configure alarm routing.
Step 4. Configure alarm options.
Step 5. Select whether or not to store alarm comments.
Step 1. Create an Event Alarm
Step 1. Create an event alarm :
1. Expand the Advanced folder in the left pane of the Workbench.
2. Do one of the following.
Method 1
Double-click Alarms.
Method 2
A. Select Alarms.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Alarms.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Alarms.
B. Click the New button on the Workbench toolbar.
Result: The New Alarm dialog box opens when you use any method.
3. Enter the name of the new event alarm in the Alarm ID field.
4. Click OK.
Result: 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.
GFK-1180J Alarm Configuration 20-5
Step 2A. Configure an Event Alarm Definition
You can configure an alarm definition for a new alarm or modify any existing event alarm
definition, including CIMPLICITY event alarms.
Step 2A. Configure an event alarm definition:
1. Open an event alarm's Alarm Definition dialog box, if it is not already open, as
follows:
A. Select Alarms .
B. Do one of the following.
Method 1
Double-click an event alarm in the right pane of the Workbench.
Method 2
A. Select an event alarm in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select an event alarm in the right pane of the Workbench.
B. Click the Properties button on the Workbench toolbar.
An Alarm Definition dialog box associated with the selected alarm opens
when you use any method.
2. (Optional) Enter a description of the alarm.
Your entry displays in the Description column in the Workbench right pane.
3. Enter a valid Alarm Class ID in the Alarm class field.
Alarms with similar characteristics can be grouped by class. Classes can be
prioritized. When a user sorts alarms by class in the Alarm Viewer, the alarm's
class determines the order in which this alarm appears relative to other alarms.
20-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Click the Browser button to the right of the Alarm Class field to
open the Select an Alarm Class Browser and select the Class ID.
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.
See the "Alarm Class Configuration" chapter in this manual for more
information about alarm classes.
4. Do one of the following for the Alarm type:
Do not change the alarm type for an existing alarm.
For a new alarm, either:
Leave the Alarm Type field blank or
Select $CIMBASIC as the alarm type.
See the CIMPLICITY HMI Integrator's Toolkit Operation Manual (GFK-1461)
for detailed information on Alarm Types.
5. (Optional) Enter the name of a Help file that users can display when they click
Help in the Alarm Viewer.
The Help file:
Is a text file you create with a text editor (for example, Notepad) and
Can be used for several alarms.
The help file can have:
Up to 8 characters in its name.
Up to 60 lines of ASCII text.
A maximum of 70 bytes per line. (A character can be 1 or 2 bytes,
depending on the system you are using.)
The Help file must be in the project's alarm_help directory.
6. Enter the text that will display as the alarm message in the Alarm message
field.
An alarm message can have:
Any combination of fixed text, and variable runtime parameters (see page
20-Error! Bookmark not defined.).
An 80-character total display length for all fixed text and variable
parameters.
7. Check if and when you want an alarm to be logged in the Alarm Logging box.
You can select any or all of the options:
Condition Alarm data is logged when the alarm:
Generate Occurs.
Acknowledge Is acknowledged by the operator or the system.
Reset Is reset by the operator or the system.
Delete Is manually deleted from the system.
Tip: You can also enter alarm logging specifications in the Database Logger.
GFK-1180J Alarm Configuration 20-7
Step 2B. Configure a Point Alarm Definition
Note: Because a point alarm is attached to a specific point, you create the alarm in the
point's Point Properties dialog box. Your alarm configuration also displays in the Alarms
folder. It can be modified either in the point's Point Properties dialog box or in the Alarm
Definition dialog box.
Step 2B. Configure a point alarm definition:
1. Open a point alarm's Alarm Definition dialog box, if it is not already open, as
follows:
A. Select Alarms .
B. Do one of the following.
Method 1
Double-click a point alarm in the right pane of the Workbench.
Method 2
A. Select a point alarm in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select a point alarm in the right pane of the Workbench.
B. Click the Properties button on the Workbench toolbar.
An Alarm Definition dialog box associated with the selected alarm opens
when you use any method.
2. Modify the configuration using the same criteria that you use when you are in the
Point Properties dialog box.
The one feature you cannot configure in the Alarm Definition dialog box is
Alarm Logging. You can specify when an alarm will be logged in either the
point's Point Properties dialog box or in the Database Logger.
See "Configuring the Advanced Alarm Tab" in the "Point View, Limits and
Alarms" chapter in this manual for detailed information.
20-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
All point alarm entries can
be made in either dialog
box except Alarm Logging.
Alarm Definition
dialog box
Point Properties
dialog box
Point Alarm
Specify in the Point
Properties dialog
box or in the
Database Logger.
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-1180J Alarm Configuration 20-9
Step 3. Configure Alarm Routing
Configuration for Alarm Routing is the same for both event alarms and point alarms.
See "Routing Alarms" in the "Point View, Limits and Alarms" chapter in this manual for
detailed information about configuring alarm routing.
Alarm routing configuration is the same for event and point alarms.
Event alarm
Point alarm
20-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. Configure Alarm Options
Configuration for Alarm Options is the same for both event alarms and point alarms.
See "Setting Alarm Options" in the Point View, Limits and Alarms" chapter in this
manual for detailed information about configuring alarm options.
Alarm options configuration is the same for event and point alarms.
Event alarm
Point alarm
GFK-1180J Alarm Configuration 20-11
Step 5. Select whether or not to Store Alarm Comments
You can choose to store runtime alarm comments that a user enters while the alarm is
being displayed in the Alarm Viewer. Normally, these comments are deleted when the
alarm is deleted. CIMPLICITY saves the 20 most recent alarm comments in a file in the
project's alarm_help directory.
Guidelines for storing alarm comments include:
Each comment can contain up to 720 characters.
Up to 20 comments are stored in an alarm comment file. When the 21
st
comment is
placed in the file, the first (oldest) comment is removed.
If you intend to enable 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
alarm's help file.
Step 5. Select whether or not to store alarm comments:
1. Click Project on the Workbench toolbar.
2. Select Properties.
The Project Properties dialog box opens.
3. Select the Settings tab.
4. Select Alarms.
5. Click Settings.
The Alarm Properties dialog box opens.
20-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
6. Check Store alarm comments to enable the option and save alarm comments
beyond the life of alarms.
7. Click OK.
Note: Click Cancel to cancel the changes.
Result: Up to 20 alarm comments are stored in a file in the project's alarm_help
directory.
GFK-1180J 21-1
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, 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.
21-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
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.
If more than one project has the highest priority, then the order in which
the projects are displayed in the Alarm Sound Manager window
determines the project priority.
When you prioritize alarms by Project priority, the determination of the highest
priority alarm is:
The sound for the alarm with highest priority Alarm Class in the highest
priority project is played first.
If more than one project has the highest priority, then the order in which
the projects are displayed in the Alarm Sound Manager window
determines the project priority.
Examples
Suppose you have three projects, each with two Alarm Classes as follows:
Project Priority Alarm Class Priority Alarm Class Priority
PROJ 1 3 ALM1A 1 ALM1B 2
PROJ 2 2 ALM2A 1 ALM2B 2
PROJ 3 1 ALM3A 1 ALM3B 2
In addition, you currently have one alarm generated for each class in each project.
If you prioritize audio alarms by Alarm Class, the alarm order is:
ALM3A, ALM2A, ALM1A, ALM3B, ALM2B, ALM1B
If you prioritize audio alarms by Project priority, the alarm order is:
ALM3A, ALM3B, ALM2A, ALM2B, ALM1A, ALM1B
GFK-1180J Using Alarm Audio Support 21-3
Configuring Alarm Audio Support
You configure Alarm Audio support in the Alarm Class configuration.
To configure Alarm Audio support for an Alarm Class:
1. Double-click the Alarm Class icon in your project's 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:
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.
21-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 project's directory.
You can also use a special variable called WIN_DIR, which expands to the Windows
NT/98 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:
Enter the Frequency of the sound. Select a value between 37 and
32767 Hertz.
Remember, 1000 milliseconds equals 1
second.
Enter the Duration of the sound in milliseconds. Select a value
between 1 and 10000 milliseconds.
For both Windows NT and Windows 98.
Enter the Number of beeps to play when the alarm is generated.
Select a value between 1 and 10.
If you enter a value greater than 1, the Delay field is enabled.
Use the Delay field to enter the delay between the beeps in
milliseconds. Select a value between 0 and 10000 milliseconds.
GFK-1180J Using Alarm Audio Support 21-5
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.
21-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J Using Alarm Audio Support 21-7
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.
21-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Examples:
For example, if you connect to PROJ 1 with priority 3, PROJ 2 with priority 2, and
PROJ 3 with priority 1, then the list of projects looks like this:
PROJ 3
PROJ 2
PROJ 1
If you connect to PROJ 1 with priority 3, PROJ 2 with priority 1 and PROJ 3 with
priority 1, then the list of projects looks like this:
PROJ 2
PROJ 3
PROJ 1
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.
GFK-1180J Using Alarm Audio Support 21-9
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.
21-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J 22-1
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.
22-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 $ALARM_MODIFIED system alarm
is identified by the Alarm ID and the Resource ID of the affected
device.
Note: A possible exception is for $DEVICE_DOWN. You can use the Global
parameter DEVICE_DOWN_DEVICE_REF to put only the Device ID as the
alarm reference.
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.
GFK-1180J Alarm Blocking Configuration 22-3
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.
22-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarm Blocking Configuration
The Workbench displays a project's existing alarm blocking groups in the right
pane of the Workbench.
To view a project's existing alarm blocking groups:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms .
3. Select Alarm Blocking .
The Workbench right pane displays the following fields for each alarm blocking
group:
Group ID The identifier for the class
Group Description Optional description of the group
Peer block Identifies whether Peer Blocking is enabled or disabled.
Note: Use the Workbench Field Chooser to remove or redisplay any of the
fields, except the Group ID. The Group ID is required. See the "Selecting Fields
to Display in the Right Pane" in the "Using the Workbench" chapter in this
manual for information about the Field Chooser"
The Alarm Definition list is initially sorted by Group ID. You can click on any
of the other column titles at the top of the list to sort the list by that attribute.
Creating A New Alarm Blocking Group
To open a new Alarm Blocking dialog box
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms.
3. Do one of the following.
Method 1
Double-click Alarm Blocking.
Method 2
A. Select Alarm Blocking.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Alarm Blocking.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Alarm Blocking.
B. Click the New icon on the Workbench menu bar.
The Alarm Blocking dialog box opens when you use any method.
GFK-1180J Alarm Blocking Configuration 22-5
Modifying an Existing Alarm Blocking Dialog
Box
To modify an existing Alarm Blocking group, you simply open the selected
group's Alarm Blocking dialog box and make your modifications.
To open an existing Alarm Blocking dialog box:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms.
3. Select Alarm Blocking.
4. Do one of the following.
Method 1
Double-click an Alarm Blocking Group in the right pane of the
Workbench.
Method 2
A. Select an Alarm Blocking Group in the right pane of the
Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select an Alarm Blocking Group in the right pane of the
Workbench.
B. Click the Properties icon on the Workbench menu bar.
An Alarm Blocking dialog box associated with the selected alarm blocking group
opens when you use any method.
22-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring an Alarm Blocking Group
You can resize the width of the Alarm ID, Priority and Resource ID fields to suit
your needs.
Enter the following information to create a new Alarm block group:
Group ID
Enter a new, unique Alarm group name. The group name can be up to 32
characters long.
Description
Enter a description of the Alarm group. The description can be up to 64
characters long.
Peer block
Set this check box to enforce Peer Blocking Mode for this group. Clear this
check box if you want to use Non-Peer Blocking Mode.
The Blocking Mode and alarm priorities determine the alarm blocking hierarchy
at run-time
Alarms
This input box displays the current list of alarms in the Alarm block group.
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.
GFK-1180J Alarm Blocking Configuration 22-7
Adding an Alarm
You can enter the name of an Alarm ID in the Alarm ID field in the Alarm
Blocking dialog box 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 in the group's Alarm Blocking dialog
box.
2. Press Delete.
22-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Modifying an Alarm
You can modify an alarm's name, priority and Resource ID in the list. All you
need to do is:
1. Select the field you want to edit in the Alarms list in the group's
Alarm Blocking dialog box.
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.
Non-point alarms will be assigned the new Resource ID.
GFK-1180J 23-1
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.
23-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Alarm Printer Configuration
The Workbench displays a project's existing alarm printers in the right pane.
To view a project's existing alarm printers:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms .
3. Select Alarm Printer .
The Workbench right pane displays the following attributes for each Alarm Printer:
Name The name of the alarm printer.
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.
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields,
except the Name. The Name is required. See the "Selecting Fields to Display in the
Right Pane" in the "Using the Workbench" chapter in this manual for information
about the Field Chooser"
The Alarm Printer list is initially sorted by Name. You can click on any of the other
column titles at the top of the list to sort the list by that attribute.
GFK-1180J Alarm Printer Configuration 23-3
Adding an Alarm Printer
To add a new alarm printer, you can do one of the following:
To a new alarm printer: :
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms.
3. Do one of the following.
Method 1
Double-click Alarm Printer.
Method 2
A. Select Alarm Printer.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Alarm Printer.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Alarm Printer.
B. Click the New icon on the Workbench menu bar.
The New Alarm Log Printer dialog box opens when you use any method.
New Alarm Log Printer Dialog Box
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 11
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 dialog box for the
new alarm printer opens.
23-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Modifying an Existing Alarm Printer
To modify an existing Alarm Printer, you simply open the selected alarm printer's
dialog box and make your modifications.
To open an existing Alarm Printer's dialog box:
1. Expand the Advanced folder in the left pane of the Workbench.
2. Expand Alarms.
3. Select Alarm Printer.
4. Do one of the following.
Method 1
Double-click an Alarm Printer in the right pane of the Workbench.
Method 2
A. Select an Alarm Printer in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select an Alarm Printer in the right pane of the Workbench.
B. Click the Properties icon on the Workbench menu bar.
An Alarm Printer dialog box associated with the selected alarm string opens when
you use any method.
GFK-1180J Alarm Printer Configuration 23-5
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.
Configuring General Alarm Printer Properties
The General tab of the Alarm Printer dialog box enables you to define basic
specifications 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.
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:
23-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
Click the Browser button - - to the right of the input field to display
the Select Alarm Class browser and use it to select the Alarm Class.
Click the Pop-up Menu button - - to create a new Alarm Class, edit
the current Alarm Class, or browse for an Alarm Class.
Output
Enter the device name for the alarm printer. You can:
Enter the name of a local port on the project's computer (for example -
LPT1 or COM1) where you have attached the alarm printer.
Note: If you are connecting to serial port COM10 and above, the format is
\\.\COM<n>.
Enter a file name to write alarms to a file. If you wish, you may also
enter a period followed by a three character file extension (for example,
alarms.fil).
If you do not enter a file extension, none is automatically provided.
The file is placed in the project's \log directory.
GFK-1180J Alarm Printer Configuration 23-7
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.
Configuring Alarm Printer Layout Properties
The Layout tab of the Alarm Printer dialog box enables you to determine whether a
header should be printed at the top of a page.
Print Headers
Set this check box if you want to print a header at the top of each page.
If you have more than one alarm printer process sending messages to the same printer
or file, clear this check box. When you clear the check box, the Page length field
is disabled.
Page Length
Enter the number of lines per page that can be printed. The number must be an
integer between 1 and 999.
23-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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
Configuring Alarm Printer Date/Time Format
Use the Date/Time Format tab on the Alarm Printer dialog box to choose how the
alarm printer will print the date and time.
You can define the following:
Header Date
Alarm Date/Time
View Guidelines for constructing date and time formats
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-1180J Alarm Printer Configuration 23-9
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.
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.
d Numeric day with no leading zero.
dd Numeric day with leading zero.
ddd Short text day of the week.
dddd Long text day of the week.
y Last two digits of year. For digits 00 through 09, only the last digit is
displayed.
yy Last two digits of year. For digits 00 through 09, both digits are displayed.
yyyy All four digits of year
For example, if you enter dddd dd mmmm yyyy, the sample date will be
Saturday 05 March 1994.
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.
M Minutes with no leading zero.
MM Minutes with leading zero.
S Seconds with no leading zero.
SS Seconds with leading zero.
T Hundredths of seconds with no leading zero.
TT Hundredths of seconds with leading zeros.
P, A, p, or a AM/PM indicator.
For example, if you enter HHHH:MM:SS:TT p, the sample time will be
13:05:06:08 PM.
You may use colons, spaces or any other delimiter of your choice to separate the time
fields.
23-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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 let's 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, let's look at a redundant configuration with a network line printer
(\\ABC\NET1). The primary computer is COMP1 and the secondary computer is
COMP2.
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-1180J Alarm Printer Configuration 23-11
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:
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.
23-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J Alarm Printer Configuration 23-13
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.
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.
GFK-1180J 24-1
Configuring Roles
About Roles
Each user in CIMPLICITY is assigned a role.
A role specifies what privileges its users have when they work in CIMPLICITY HMI. Types
of privileges include:
Application privileges, such as triggering events in the Event Manager and setting
points in Points.
Action Calendar configuration (if the Action Calendar option is part of your
CIMPLICITY HMI product.)
Configuration privileges that enables you to specify, for each application, whether or
not users can do configuration.
The CIMPLICITY HMI default configuration includes the following three roles:
SYSMGR
USER
OPER
Role Configuration
The Workbench displays a project's existing roles in the right pane.
When you enter specifications for a role you
Begin role configuration by adding a new role or modifying an existing role.
Assign role application privileges.
Assign role calendar privileges.
Assign role configuration privileges.
24-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Beginning Role Configuration
You can begin role configuration by:
Adding a new role.
Open an existing role's Properties dialog box.
Procedure to View a Project's Existing Roles
To view a project's exi sting roles:
1. Expand the Security folder in the left pane of the Workbench.
2. Select Roles .
The Workbench right pane displays the Role ID for each Role.
Procedure to Create a New Role
To create a new role:
1. Expand the Security folder in the left pane of the Workbench.
2. Do one of the following.
Method 1
Double-click Roles.
Method 2
A. Select Roles.
B. Click File on the Workbench menu bar.
C. Select New.
Method 3
A. Select Roles.
B. Press Ctrl+N on the keyboard.
Method 4
A. Click the New icon on the Workbench toolbar.
The New Role dialog box opens when you use any method.
GFK-1180J Configuring Roles 24-3
New Role Dialog Box
To create a new role:
1. Enter the name of the new role in the Role ID field.
2. Click OK.
Result: 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 open.
Procedure to Open a Properties Dialog Box for an Existing Role
You can easily modify a role's application and configuration privileges by opening its
Properties dialog box.
To open an existing rol e's Properti es di alog box:
1. Expand the Securities folder.
2. Select Roles in the left pane of the Workbench.
3. Do one of the following.
Method 1
Double click a role in the right pane of the Workbench
Method 2
A. Select a role in the right pane of the Workbench.
B. Click the right mouse button.
C. Select Properties from the popup menu.
Method 3
A. Select a role in the right pane of the Workbench
B. Click the Properties icon on the Workbench toolbar.
The Role Properties dialog box associated with the selected role opens.
24-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Assigning Role Application Privileges
The Privileges tab on the Role Properties dialog box let you define the application privileges
for a new role.
When checked a:
Privilege Allows a Role to:
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.
Trigger Event Trigger Event Manager events 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.
Delete alarms Delete alarms from the Alarm Viewer.
Modify alarm setups Modify alarm setups in Alarm Viewer.
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 Use point by address points in CimEdit expressions.
Disable / modify alarms Disable or modify a point's alarms in the Point Control
Panel.
Modify Attributes Change the MANUAL_MODE point quality attribute.
Change the QUALITY.DISABLE_WRITE point
attribute.
Write to a user defined field attribute if Restrict write by
role is checked in the Field Attribute dialog box.
GFK-1180J Configuring Roles 24-5
See the "Monitoring Point Attributes" chapter in the CIMPLICITY HMI CimEdit Manual
(GFK-1396) for more information about the MANUAL_MODE and
QUALITY.DISABLE_WRITE attributes.
See " Using the Point Control Panel" chapter in the CIMPLICITY HMI User's Manual (GFK-
1180) for more information about enabling and disabling manual mode in the Point Control
Panel.
More about 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).
Assigning Role Calendar Privileges
The Calendar tab in the Role Properties dialog box is available if your CIMPLICITY HMI
product includes the Action Calendar option.
Area Resource Security
When area resource security is: Users will be able to:
Checked Only see areas whose Resource ID is assigned to the user
Unchecked See all areas.
Configuration
When configuration is: Users will be able to:
Checked Configure a schedule for any areas they can see.
Unchecked View schedules, but no configuration is possible.
24-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Assigning Role Configuration Privileges
Important: You need to activate configuration security in order for the Configuration tab to
display in the Role Properties dialog box. Configuration security will require users to logon to
a CIMPLICITY project. Therefore, their privileges will be affected by the roles to which they
are assigned.
You activate security by checking the Configuration Security check box on the Options tab
of the Project Properties dialog box. See "Options Properties" in "Setting Up a CIMPLICITY
Project" in this manual.
The Configuration tab in the Role Properties dialog box enables you to specify the type of
configuration privileges available to users who are assigned to the role.
To specify role configuration privileges:
Either:
1. Check the application's check box to allow a role's users to configure an application,
or
2. Uncheck the application's check box to prevent a role's users from configuring an
application.
Result: Access to any unchecked application is denied to a user for all unchecked boxes.
GFK-1180J Configuring Roles 24-7
Exampl e
The Point box is unchecked for a role in the Role Properties dialog box. When a user
attempts to open a point's dialog box by displaying the point's popup menu in the
Workbench, point access is dimmed.
Configuration access
denied.
GFK-1180J 25-1
User Configuration
About Users
The Users application enables you to configure users for your CIMPLICITY HMI project.
A User is an individual person working with a CIMPLICITY HMI project.
For each CIMPLICITY HMI user you can specify the following:
Security.
A user may be assigned a password. If a password is configured and enabled, then a user
cannot access CIMPLICITY project functions without entering both the User ID and
password.
Roles and Privileges.
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.
Resources availability.
Resources availability.
A user's view determines the resource data to which the user has access. Alarms for
resources outside a user's view will not appear on the user's Alarm Viewer window.
Note: The default User configuration includes:
ADMINISTRATOR (role: SYSMGR)
The default user does not require a password to access CIMPLICITY project functions.
25-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
User Configuration
When you enter specifications for a user you
Begin user configuration by adding a new user or modifying an existing user.
Configure User general (security) requirement.
Configure User resource availability.
Beginning User Configuration
You can begin user configuration by:
Adding a new user.
Modifying an existing user's configuration.
Procedure to View a Project's Existing Users
The Workbench displays a project's existing users in the right pane.
To view a project's existing users:
1. Expand the Security folder in the left pane of the Workbench.
2. Click Users .
The Workbench right pane displays the following attributes for each User:
User ID A name that uniquely identifies each user.
Enabled Indicates if the account is enabled or disabled.
Password If a password is defined, it is displayed in this field.
Role ID The role assigned to the user. This determines the privileges
assigned to the user.
User Name The user's name.
Note: Use the Workbench Field Chooser to remove or redisplay any of the fields, except the
User ID. The User ID is required. See the "Selecting Fields to Display in the Right Pane" in
the "Using the Workbench" chapter in this manual for information about the Field Chooser"
The User list is initially sorted by User ID. You can click on any of the other column titles at
the top of the list to sort the list by that attribute.
GFK-1180J User Configuration 25-3
Procedure to Create a New User
To create a new user:
1. Expand the Security folder in the left pane of the Workbench.
2. Do one of the following.
Method 1
Double-click Users.
Method 2
A. Select Users.
B. Click File on the Workbench menu bar.
B. Select New.
Method 3
A. Select Users.
B. Press Ctrl+N on the keyboard.
Method 4
A. Select Users.
B. Click the New icon on the Workbench menu bar.
Result: The New User dialog box opens when you use any method.
New User Dialog Box Filled In
To fill in the New User dialog box:
1. Enter the name of the new user in the User ID field.
2. Click OK.
Result: The system verifies that the User ID does not already exist, and that no invalid
characters have been used. The User Properties dialog box opens is the User ID is
approved.
25-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Procedure to Open a Properties Dialog Box for an Existing User
To modify an existing user, you simply open the selected user's User Properties dialog box
and make your modifications.
To open an existing User Properties dialog box:
1. Expand the Security folder in the left pane of the Workbench.
2. Select Users .
3. Do one of the following.
Method 1
Double-click a user in the right pane of the Workbench.
Method 2
A. Select a user in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
B. Select Properties.
Method 3
A. Select a user in the right pane of the Workbench.
B. Click the Properties button on the Workbench menu bar.
A User Properties dialog box associated with the selected user opens when you use
any method.
GFK-1180J User Configuration 25-5
Configuring User General Properties
The General properties let you define the following for a new user.
Note: If you change a user's configuration dynamically, the user must log out then log back in
for the changes to take effect.
Role
Enter the user's role in the Role field.
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 click the Popup Menu button to create a new role, edit the current role, or
Browser for another role.
Password needed
Check Password needed to require the user to enter a password at login.
Password and Confirm Password
Password and Confirm Password are enabled when the Password Needed checkbox is
checked.
1. Enter the user's password in the Password field.
2. Re-enter the password in the Confirm Password field.
Result: Asterisks are displayed in place of the characters you type.
If, at some future date, you uncheck Password Needed, the Password field will retain the
original password, but the user does not need to enter it when logging in.
25-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
The following runtime rules also apply to user passwords:
During runtime a user:
Is prompted to change the password when the current password expires.
Can change the password from the CIMPLICITY Login Panel.
Can use the ChangePassword command in the Basic Control Engine to change the
password in CimView.
(In a Server Redundancy configuration) can only change the password when the
Primary computer is running.
User name
Enter the user's name or descriptive text about the user.
Enabled
Either:
Check Enabled to enable the user account or.
Uncheck Enabled, to disable the account.
Result: When Enabled is unchecked the account is not available for user login.
Important: 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 in the Password Expires field.
Result: After the elapsed number of days, the user will be required to change the password
prior to logging in.
Note: In a Server Redundancy configuration, Automatic Password Expiration is not
supported.
GFK-1180J User Configuration 25-7
Configuring User Resource Properties
The Resources tab in the User Properties dialog box enables you to define the resources for
which the user can view alarms. The resources currently assigned to the user are displayed on
the Resources tab in the User Properties dialog box. You can add or remove resources for the
selected user.
Note: If you change a user's resources dynamically, the user must log out then log back in to
access the changed resources.
Procedure to Add a Single Resource for a User
To add a resource to the user's list:
1. Select a resource in the Available box.
2. Click Add.
Result: The new resource will appear in the Configured box.
Procedure to Add All Resources for a User
To add all the currently configured resources to the user's list:
Click Add All.
Result: All the resources appear in the Configured box.
Procedure to Remove a Resource from a User
To remove a resource from the user's list:
1. Select a resource in the configured box.
2. Click Remove.
Result: The resource is removed from the Configured box.
Note: You can also use the Shift and Ctrl keys in combination with the mouse to select more
than one resource for deletion.
25-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Runtime User Properties
You can use the User Setup dialog box to change the runtime properties for alarms in your
project.
To open the User Setup dialog box:
1. Click Project on the Workbench menu bar.
2. Select Properties.
The Project Properties dialog box opens.
3. Select the Settings tab.
4. Select Alarms.
5. Click Settings.
The User Setup dialog box opens.
Configuring Runtime User Properties
The runtime user properties let you specify how many failed login attempts can occur before
CIMPLICITY automatically disables the account.
Note: Automatic account disabling is not supported on Servers using Server Redundancy.
To specify automatic account enable or disable:
1. Either:
Option 1Disable automatic account disabling
Check No account disable.
Option 2Enable automatic account disabling:
1. Check Account Disable.
2. Enter the number of failed login attempts before disabling the account.
2. Click OK.
Result: The dialog box closes and your changes are saved.
GFK-1180J User Configuration 25-9
Procedure to Dynamically Re-enable a Disabled Account
If Account Disable is checked 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 re-enable a disabled account:
1. Click the Dynamic mode button on the Workbench toolbar.
2. Open the User Configuration application.
3. Re-enable the user account.
GFK-1180J 26-1
Configuring the Database
Logger
About the Database Logger
The CIMPLICITY Database Logger provides you with a seamless way to analyze the
your system processes and equipment performance by logging data to and reporting data
from a wide variety of ODBC (Open Database Connectivity)-compliant databases.
You can log:
Alarms,
Event alarms,
Single points,
Groups of points,
Event Management and
External applications.
The configuration is straightforward. You do not need to know about SQL or other
ODBC database internals to configure Database Logger logging tables.
In the Database Logger you easily:
Use existing tables or create new tables that will log selected items for any one
of the processes.
Enter specifications for how, when and to what ODBC data source you want to
log data.
When you start the project in which you configured the Database Logger, the
Database Logger creates tables you configured based on the attributes you specified.
When a project starts, the Database Logger:
Creates or repair any missing or damaged databases.
Creates any missing tables.
Creates any missing columns in the tables.
Creating a report is also straightforward. CIMPLICITY provides sample reports that you
use in Excel. You can use these sample reports to quickly generate a report or as a basis
to create new reports.
26-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Note: The Database Logger option uses the standard ODBC interface to log your
production data.
Refer to the Readme file that accompanies this release for a list of supported database
interfaces.
Database Logger Supported ODBC Interfaces
The Database Logger option uses the standard ODBC interface to log your production
data.
Refer to the Readme file that accompanies this release for a list of supported database
interfaces.
Database Logger Configuration Overview
Database Logger configuration is straightforward. The following list provides a logical
order for reviewing the details when you are learning how to configure one or more log
tables.
To review Database Logger configuration:
1. Understand hardware and database logger performance.
2. Open the Database Logger window
3. Review the Database Logger configuration hierarchy.
4. Review available Database Logger file management functions.
5. Configure Database Logger defaults.
6 Configure any or all of the following database logs:
A. Points,
B. Groups of points,
C. Alarms,
D. Event alarms,
E. Event Management and
F. External applications.
7. Use CIMPLICITY Log reports.
GFK-1180J Configuring the Database Logger 26-3
Understanding Hardware and Database Logger Performance
On a 400 MHz Pentium II with 200 MB memory:
SQL Server For Database Logging Peaks at Around
On-node 265 writes per second (2 field writes)
Off-node 100 writes per second (2 field writes).
However, off-node is dependent on your network configuration as
well.
Table Type Write Definition
DATA One point being logged.
If you have 20 points, you are doing 20 independent writes (when
is configurable individually for each point). The size of each write
(number of fields) depends on how many attributes you are
logging.
Fields include:
1 for timestamp
1 for the point ID
Anything else you are logging (e.g., value, engineering units).
The more attributes you have, the slower the writes will be.
GROUP Is based on your table's logging conditions. The number of points
and the attributes being logged (configurable independently for
each point) determine how big the writes will be (how many fields
there will be).
Fields include:
1 for the timestamp
Anything else you are logging.
Exampl e
If you are logging the value of two points, your group log table
will have 3 fields, timestamp and two fields for the points' values.
Bulk Insertion Peak Performance:
CIMPLICITY Database
Logger using bulk insertion.
Avg.
bytes/write
Approx.
Writes/sec
Approx.
Total hroughput/sec
On-node 28 900-1000 25-30Kb
Off-Node 28 700-800 20-25Kb
26-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Opening the Database Logger Window
You can easily open the Database Logger in the CIMPLICITY Workbench.
To open the Database Logger:
1. Select Database Logger in the left pane of the
Workbench.
2. Do one of the following:
Method 1
Double-click Database Logger in the left or right
pane.
Method 2
A. Select Database Logger in the right pane of the Workbench.
B. Click Edit on the Workbench menu bar.
C. Select Properties.
Method 3
A. Right-click Database Logger in the right pane of the Workbench.
B. Select Properties from the popup menu.
Method 4
A. Select Database Logger in the right pane of the Workbench.
B. Press Alt+Enter on the keyboard.
Result: The Database Logger window opens when you use any of these methods.
GFK-1180J Configuring the Database Logger 26-5
Understanding the Database Logger Configuration Hierarchy
When you open the Database Logger Configuration window, you see a list of the
currently configured point data and group tables as well as the Alarm Log and Event Log
tables.
CIMPLICITY Database Logger Configuration Window
Opens a log table for:
Alarms
Data (Single points)
Event (alarms)
Event Manager
External application
Group (of points)
The icon to the left of each table indicates its type as follows:
Icon Table Log:
ALARM_LOG Selected alarms that appear in the Alarm
Viewer.
Data Selected point values individually.
EM_LOG Event Manager activities.
EVENT_LOG Selected system alarms that do not appear in
the Alarm Viewer.
External application Actions in certain CIMPLICITY
applications, e.g., Tracker.
Group Selected point values in parallel.
In order to configure how, when and where logs will collect and report data you can start
at the Database Logger level to specify certain properties and become more specific in
your configuration as follows:
Level 1. Configure Database Logger defaults that apply to all tables in the Database
Logger.
Level 2. Configure Table defaults that apply to a selected table in the Database
Logger. Override selected Database Logger defaults, if necessary.
Level 3. Configure Item logging conditions for selected items. These conditions
override a table default, if necessary.
When you complete your configuration to can easily create a report for reviewing logged
data.
26-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Level 1 ConfigurationDatabase Logger Defaults
Configuration Create Database Logger defaults for all the tables, including:
Several basic parameters and
Data logging sources for alarm and point logs.
Configuration Tool Logging Properties dialog box.
See page 26-23 for detailed configuration procedures.
GFK-1180J Configuring the Database Logger 26-7
Level 2 ConfigurationDatabase Logger Table
Configuration Configure and create defaults for individual tables including:
Default logging conditions,
Logging attributes,
Connection,
Maintenance events,
Maintenance actions and
Advanced specifications.
Note: The specific configuration depends on the process being
configured. Table defaults can override Database Logger defaults.
Configuration Tool Table Properties dialog box.
Review configuration steps for: See page (in this chapter):
Single point data logging 31
Group point logging 56
Alarm logging 69
Event alarm logging 83
Event Management logging 96
Application logging 96
26-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Level 3 ConfigurationItem in a Database Logger Table
Configuration Enter logging conditions that are different from the table defaults
for individual items in the table.
Configuration Tool Item's Properties dialog box.
Result: When configuration for any table is completed you can open Excel and
generate reports from the samples that are included in CIMPLICITY or create your
own reports.
Note: The Event Manager Log (EM_LOG) and logs for external applications require
new reports.
Configure logging conditions for a: See page (in this chapter):
Single point 51
Alarm 81
Event alarm 94
GFK-1180J Configuring the Database Logger 26-9
Log Reports included with CIMPLICITY
Configuration Create reports to display the data logged as a result of
configuration in the Database Logger.
Configuration Tool Reports created on site or
Excel reports supplied with CIMPLICITY that report:
Alarms Alarms reported in the Alarm Viewer or
Other alarms
Data Points logged individually
Trends Points logged in parallel
Review configuration steps for: See page( in this chapter):
Individual point log reports 109
Group point trend log reports 112
Alarm or event alarm reports 116
26-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Overview of Database Logger Configuration Levels
The following chart displays the four basic configuration levels for the Database Logger.
For
Event Management
Configure
EM_LOG
For
Point Groups
Open a
Group log table
2 External
Application
Report specific to
application
1 Open
the Database Logger
Configuration window.
Configure
Database Logger
defaults in a Properties
dialog box at this level.
Alarm Report
Trend Report
and Chart
Data Report
Add
Point IDs
Values logged
in parallel.
Add
Point IDs
Values logged
individually.
Add
Alarm IDs
Add
Alarm IDs
Report created
on site.
4 Use
provided Excel
reports (or create
reports) to display
selected data.
3 Add
Alarm IDs or
Point IDs to the
table.
Configure
tables and items
in a Properties
dialog box at
each level.
2 Open
individual
Logging
Tables based
on what needs
to be logged.
For
Event Alarms
Open
EVENT_LOG
For
Points
Open a
Data log table
For
Alarms
Open
ALARM_LOG
Logging Table Columns Guidelines
Guidelines for logging table columns include:
A table can have, at most, 250 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.
GFK-1180J Configuring the Database Logger 26-11
Database Logger File Management Functions
The Database Logger window provides you with the ability to carry out several file
management functions for managing CIMPLICITY tables, including:
Create a new logging table.
Open an existing logging table.
Copy an existing logging table to a new logging table.
Rename a logging table.
Delete a logging table.
Filter table lists.
Activate dynamic configuration.
Reconcile a CIMPLICITY table with a logging database.
Close a logging table
Exit the Database Logger Configuration window.
Creating a New CIMPLICITY Logging Table
You can create as many new CIMPLICITY data, group or applications tables as you
need.
To create new logging tables:
1. Do one of the following:
Method 1
Click the New Table button on the Database Logger Configuration
window toolbar.
Method 2
A. Click File on the Database Logger Configuration window menu bar.
B. Select New Table.
Method 3
A. Right-click any icon in the Database Logger Configuration windows list.
B. Select New in the popup menu.
The New Table dialog box opens when you use any method.
26-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
2. Enter a name for the table in the Table identifier field.
The name:
Can contain
Alphanumeric characters (A through Z, 0 through 9) and
Underscores ( _ ).
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 click OK.
Cannot be the name of a currently existing table.
3. Check the type of table to create in the Table type box.
4. Click OK.
Result: A Table Properties dialog box opens for you to configure the new table.
Important: You can only create new group, data and application log tables.
Only one alarm table (ALARM_LOG), event table (EVENT_LOG) and Event Manager
(EM_LOG) table exist in the Data Logger. You cannot delete these tables, and you cannot
create additional Alarm, Event or Event Manager tables.
GFK-1180J Configuring the Database Logger 26-13
Opening an Existing Logging Table
You open existing logging tables through the Database Logger Configuration window.
To open an existing logging table:
1. Select the logging table you want to open.
2. Do one of the following.
Method 1
Click the Open Table button on the Database Logger
Configuration window toolbar.
Method 2
Double-click the selected table.
Method 3
A. Click File on the Database Logger Configuration window menu bar.
B. Select Open Table.
Method 4
A. Right-click the selected table.
B. Select Open in the popup menu.
Method 4
Press Ctrl+O on the keyboard.
Result: The selected table opens when you use any method.
26-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Copying an Existing CIMPLICITY Logging Table to a New
Logging Table
If you want to create a new table that is the same as or similar to an existing table, you
can copy the existing table to a new table and then make any required changes to the new
table.
Any CIMPLICITY logging table with four exceptions can be copied.
CIMPLICITY tables you can copy are:
CIMPLICITY data logs and
CIMPLICITY group logs.
Tables that cannot be copied are:
ALARM_LOG,
EM_LOG,
EVENT_LOG and
External application log.
To copy an existing CIMPLICITY logging table to a new table:
1. Select the logging table you want to copy.
2. Do one of the following.
Method 1
Click the Copy Table button on the Database Logger Configuration
window toolbar.
Method 2
A. Click File on the Database Logger configuration window menu bar.
B. Select Copy Table.
Method 3
A. Right-click the selected table.
B. Select Copy in the popup menu.
Method 4
Press Ctrl+C on the keyboard.
A Copy table dialog box opens.
3. Enter the name of the new table in the New table ID field.
4. Click OK.
Result: The new table ID appears in the list of tables. You can now configure it as
you would any table.
GFK-1180J Configuring the Database Logger 26-15
Renaming a CIMPLICITY Logging Table
Any Logging table with three exceptions can be renamed.
CIMPLICITY tables you can rename are:
CIMPLICITY data logs and
CIMPLICITY group logs.
CIMPLICITY tables you cannot rename are:
ALARM_LOG,
EM_LOG,
EVENT_LOG and
External application log.
To rename a CIMPLICITY logging table:
1. Select the logging table you want to rename.
2. Do one of the following.
Method 1
A. Click File on the Database Logger configuration window menu bar.
B. Select Rename Table.
Method 2
A. Right-click the selected table.
B. Select Rename in the popup menu.
Method 3
Press Ctrl+R on the keyboard.
A Rename table dialog box appears.
3. Enter the new name for the table in the New table ID field.
4. Click OK.
Result: The new table ID appears in the list of tables.
26-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Deleting a CIMPLICITY Logging Table
Any Logging table with three exceptions can be deleted.
Tables you cannot delete are:
ALARM_LOG
EM_LOG
EVENT_LOG
To delete a CIMPLICITY logging table:
1. Select the logging table you want to delete.
2. Do one of the following.
Method 1
Click the Delete Table button on the Database Logger
Configuration.
Method 2
A. Click File on the Database Logger configuration window menu bar.
B. Select Delete Table.
Method 3
A. Right-click the selected table.
B. Select Delete in the popup menu.
A message appears to inform you of the number of items in the table and
confirm deletion.
3. Click OK.
Result: The selected table is deleted.
GFK-1180J Configuring the Database Logger 26-17
Filtering CIMPLICITY Table Lists
You can filter the list in the Database Logger Configuration window or in any open table.
To filter a list in the Database Logger:
1. Do one of the following.
Method 1
Click the Filter button on the Database Logger Configuration
window or a table's toolbar.
Method 2
A. Click View on the Database Logger Configuration window or a table's
menu bar.
B. Select Filter...
2. Enter a full or partial ID in the <type>Identifier field.
Use the ? and * wildcards to perform partial string searches.
3. Either:
A. Click OK to filter the list according to the information you've entered, or
B. Click Cancel to cancel the filter function.
Tip: To display all the items in the table, enter an asterisk (*) in the <Type>Identifier
field.
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.
26-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Activating Dynamic Configuration
You can dynamically configure several logging properties through the Database Logger.
You can:
Add, remove or modify all point table configuration.
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 dynami c configuration in the Database Logger:
Click the Dynamic button on any tables toolbar.
When you activate Dynamic Configuration, CIMPLICITY 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-1180J Configuring the Database Logger 26-19
Reconciling a CIMPLICITY table with a Logging Database.
Because you can change the fields to report data in both the CIMPLICITY table
(Database Logger configuration) and the logging database, the Database Logger provides
you with a tool to review the fields you have specified in each and reconcile the
differences.
To reconcile differences in fields between a CIMPLICITY table and logging
database:
1. Open the CIMPLICITY table in the Database Logger that you want to reconcile.
2. Click Edit on the tables menu bar.
3. Select Reconcile Table.
The Reconcile table dialog box opens.
Red
Red
Red
Black
All others are Green.
4. Review the icons that display differences between the CIMPLICITY table
(Database Logger configuration) and the logging database as follows.
Field in the
CIMPLICITY Field in the
Icon
Database
Logger
Logging
Database Comment
(G,G) Yes Yes
(R line) Yes Yes Types dont
match.
(R, G) No Yes Unused
(G, R) Yes No Uncreated
(Black) Removed Removed
Note: G=Green, R=Red
26-20 CIMPLICITY User's ManualDecember 2000 GFK-1180J
5. Create uncreated fields that are in the CIMPLICITY table but not in the logging
database.
A. Select the fields that display the (G,R) icon.
Tip: Press the Shift or Ctrl key to select multiple fields, or click Select
Uncreated to select all the uncreated fields in the table.
B. Click Create.
Result: The fields are created in the logging database. The fields icons
change to: (G, G).
6. Remove unused fields that are in not in the Database Logger, but are in the
logging database.
For Microsoft Access
A. Select the fields that display the (R, G) icon.
Tip: Press the Shift or Ctrl key to select multiple fields, or click Select
Unused to select all the unused fields in the table.
B. Click Remove.
SQL Server and Oracle
SQL Server and Oracle do not directly support dropping columns in a database
table.
A. Copy the table to a temporary table.
B. Drop the table from the database.
C. Recreate the table with the fields you wish to use.
D. Copy the data from the temporary table to the new table.
E. Delete the temporary table.
F. Consult your SQL Server or Oracle documentation for details on how to do
this.
Result: The unused fields are removed from the database. The fields icons
change to (Black).
7. Click Drop Table to drop the table from the database.
The table is not dropped from the CIMPLICITY Database Logger.
GFK-1180J Configuring the Database Logger 26-21
Closing a CIMPLICITY Logging Table
When a CIMPLICITY logging table is open, you can close the table and
Option 1. Return to the Database Logger Configuration window.
Option 2. Exit the Database Logger from an open table.
Option 1. Close a table and return to the Database Logger Configuration
window:
Method 1
Click the Close Table button on the tables toolbar.
Method 2
1. Click File on the logging tables menu bar.
2. Select Close Table.
Method 3
1. Right-click on any item in the table.
2. Select Close from the popup menu.
Method 4
Press Alt+F+C on the keyboard.
Result: The table closes and returns to the Database Logger Configuration
window.
Option 2. Exit the Database Logger from an open table:
Click the Close Window button on the top right corner of the table.
Result: The Database Logger closes.
26-22 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Exiting the Database Logger Configuration Window
You can exit Database Logger from an open table or from the Database Logger
Configuration window.
To exit the Database Logger Configuration window:
Method 1
1. Click File on the logging tables menu bar.
2. Select Exit.
Method 2
Click the Close Window button on the top right corner of the window.
Method 3
Press Alt+F+X on the keyboard.
Result: The Database Logger Configuration window closes.
Note: You can also exit the Database Logger Configuration window by clicking the
Close Window button on the top right corner of any open table.
GFK-1180J Configuring the Database Logger 26-23
Database Logger Default Logging Properties
The Database Logger Configuration window provides you with the capability to set
global defaults that specify:
General Parameters.
Connect and Store and forward specifications for Alarm, Event and external
application connections.
Connect and Store and forward specifications for Data and Group connections.
You can change these defaults for any individual table when you are configuring that
table's properties.
Opening the Logging Properties Dialog Box
There are several methods to open the Logging Properties dialog box in the Database
Logger Configuration window as follows.
To open the Logging Properties dialog box:
Method 1
Click the Logging Properties button on the Database Logger Configuration
window toolbar.
Method 2
1. Click Edit on the Database Logger Configuration window menu bar.
2. Select Logging Properties
Method 3
1. Click the right mouse button.
2. Select Logging Properties from the popup menu.
Result: The Logging Properties dialog box opens when you use any method.
26-24 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Entering Database Logger Default Parameters
Because there are several parameters that may be the same for all your logging tables, the
Database Logger provides you with the ability to specify defaults. The default you set
will be the initial value a table uses. However, you can change the values for individual
tables.
To specify default general parameters:
1. Select the Parameters tab in the Logging Properties dialog box.
2. Enter an interval (in minutes) the Database Logger should wait between disk
scans in the Disk full scan rate (min) field.
Guidelines
The Database Logger scans the disk at intervals to determine if it is full. The
Disk full scan rate (min) determines how long the Database Logger waits after
completing one scan before it scans the disk again.
The default for the Disk full scan rate affects tables for which you have enabled
Disk Space Low maintenance event.
See page 26-43 in this chapter for details about Disk Space Low.
Database Logger Default: 30
Note: The Disk Full condition is only useful for Microsoft Access
databases. The SQL Server forces pre-allocation of disk space for data tables.
3. Enter a Database queue size that supports the 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 the points' logging conditions all occur
simultaneously.
Guidelines
The default queue size is the size of the queue of logged data for each table in
the Database queue size field.
If the database queue for a table overflows a message is logged to your
project's Status Log and additional write requests are dropped until there is
room in the queue for them.
GFK-1180J Configuring the Database Logger 26-25
If there is 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 pre-
allocates 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:
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 Default: 20
4. Enter a value in ticks (100 ticks=1 second) in the Point data logging scan
rate (ticks) field that is:
Faster than the fastest table scan rate in ticks at which the Point Data
Logger will submit data for logging.
Large enough so that all the data for a PLC scan comes into the database
together.
Guidelines
The Point Data Logging scan rate is the rate at which the Point Data Logger
submits data for logging.
Database Logger Default: 100
5. Enter the system path to the directory that holds the files created by table
maintenance export and purge actions in the Maintenance Action Export Path
field, if it is different from the default.
Guidelines
Database Logger Default: 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.
6. Check Enable Measurement Systems to have the Database Logger log data
for point values using the active measurement system converted value.
Note: The Database Logger logs values for device points and virtual points as
follows:
Device points If Enable Measurement Systems is not checked or if
no measurement system is active, the database logger logs
the EU converted value.
If Enable Measurement Systems is checked and if the a
measurement system is active, the database logger logs
the data in the specified units.
Note: You can also log the raw value for device points
by checking Raw Value on the Log Attribute tab in a
table's Properties dialog box.
26-26 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Virtual points The database logger logs the derived value of the point.
Exampl e
If you configure a point to be in inches, if you are using a metric system and
that point is showing as centimeters, the Database Logger is still going to
log it as inches unless you check Enable Measurement Systems.
See the "Using Measurement Units" chapter in this manual for details abou
tactive measurement unit configuration.
Database Logger Default: Is not checked.
7. Check Timestamp filtering to limit the number of characters in a table's
timestamp column. You can choose to either round or truncate the timestamp.
Option 1Rounding up or down
A. Check Round to round the actual time is rounded in the timestamp to the
nearest specified number of units.
B. Enter the nearest number and unit to which the timestamp will be rounded
in the timestamps to the nearest fields.
Exampl e
You specify that timestamps be rounded to the nearest 5 seconds.
The time is 10:50:22:05. It will be rounded to 10:50:20.
The time is 10:50:24:05. It will be rounded to 10:50:25.
Option 2Truncating
A. Check Truncate to truncate the actual time in the timestamp to the nearest
specified unit.
B. Enter the unit to which the timestamp will be truncated.
Exampl e
You specify that timestamps be truncated to seconds.
The time is 10:50:22:05. It will be truncated to 10:50:22.
The time is 10:50:24:55. It will be truncated to 10:50:24.
Database Logger Default: Enable timestamp filtering is unchecked.
Result: The pathname you enter is validated when the Parameters tab is closed.
GFK-1180J Configuring the Database Logger 26-27
Entering Database Logger Defaults for Alarm, Event and
Application Logs
You can specify a single global ODBC data source that will be used when logging to
Alarm, Event and Application database files.
Note: When you configure each table, you can choose to use these defaults or you can
specify an ODBC data source that is unique for that table.
The parameters that you specify as defaults deal with the:
1. Connect information
2. Store and forward specifications.
To enter Database Logger defaults for alarm, event and appl ication logs:
1. Select the Default Alarm Connection tab in the Logging Properties dialog box.
2. Select an ODBC data source from the drop down list in the ODBC data
source, field. You can select from available options or configure an existing or
a new ODBC data source:
A. Select from the one or more Microsoft Access or SQL Server options in the
drop down menu. Basic options include:
CIMPLICITY Alarm Logging A Microsoft Access data source
that logs data to the CIMPLOG.MDB
file in the ARC directory of your
CIMPLICITY project.
CIMPLICITY Point Logging A Microsoft Access data source
that logs data to the
POINTLOG.MDB file in the ARC
directory of your CIMPLICITY
project.
CIMPLICITY SQL Server Logging A Microsoft SQL Server data
source that logs data to an on-node
26-28 CIMPLICITY User's ManualDecember 2000 GFK-1180J
SQL Server database. You must
install SQL Server to use this data
source. (CIMPLICITY offers
CIMPLICITY SQL for your
convenience.)
If you have an Oracle database, you
may see the ODBC data source
that you created for Oracle.
B. Configure an existing or add a new ODBC data source.
i. Click the ODBC Data Source button to the right of the ODBC data
source field.
The ODBC Data Source Administrator opens.
ii. Select the System DSN tab.
iii. Configure the new ODBC data source based on the data source
procedures.
iv. Close the ODBC Data Source Administrator.
v. Select the new ODBC data source from the drop down menu.
3. Enter the username in the Database user field who will connect to the selected
database driver.
Important: This field is required if you are connecting to a SQL Server.
4. Enter the Password needed to connect to the selected database driver.
Important: This field is required if you are connecting to a SQL Server.
5. Enter a value between 0 (continuous retries) and 24 hours in the Reconnect
wait period field.
This value specifies the amount of time that the Database Logger waits between
reconnect attempts when the connection to the database is lost.
The default is 30 seconds.
GFK-1180J Configuring the Database Logger 26-29
6. Check Enable store and forward to have the ALARM_LOG table perform
store and forward functions.:
Check one of the two following options.
Option Check if you want:
No Limit 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 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.
7. Either:
Click OK or
Select another tab in the Logging Properties dialog box.
Result: The Database Logger validates your entries. You will be prompted if
additional information is required to connect to the database.
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.
A SQL Server, you may be prompted for a database name.
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.
26-30 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Entering Database Logger Defaults for Point and Group Point
Logs
You can specify a single global ODBC data source that will be used when logging data to
CIMPLICITY data and group tables.
Note: When you configure each table, you can choose to use these defaults or you can
specify an ODBC data source that is unique for that table.
The parameters that you specify as defaults deal with the:
1. Connect information
2. Store and forward specifications.
To specify default point and group connection parameters:
1. Select the Default Point Connection tab in the Logging Properties dialog box.
2. Configure the default parameters for the CIMPLICITY point and group log
tables the same way you configure the parameters for the CIMPLICITY alarm,
event and application log tables. See page 26-27 in this chapter for details.
GFK-1180J Configuring the Database Logger 26-31
Point Data Logging
Point data logging provides you with a straightforward process for creating and
maintaining records to analyze the performance of selected points. The point performance
represents the actual performance of equipment and processes in your system. As a result,
point logging provides you with an in depth record that can help you determine if action
is required to improve the performance of any equipment or process in your system.
Steps to configure point logging include:
Step 1. Choose a data table.
Step 2. Add points to a data table.
Step 3. Configure point logging properties.
Step 4. Configure logging conditions for a single point.
Important: When using fully qualified points, you must provide remote project login
configuration with the project.
1. Expand the Security folder in the Workbench left pane.
2. Expand the Advanced folder.
3. Select Remote Projects .
4. Configure the fully qualified local project as a remote project.
26-32 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 1. Choose a CIMPLICITY Data Table
Data Logging enables you to log point data individually.
You can display, print and analyze that information in a report that you create or in an
Excel CIMPLICITY Data Report that is included in CIMPLICITY. See page 26-109 for
details about CIMPLICITY Data Reports.
1Click the Database Logger icon to
open the Database Logger
Configuration window.
Logging Points Individually Overview
4Open SQLDATA.XLS or SQLDATA97.XLS in Excel. (In the
CIMPLICITY\HMI\ REPORT\ directory). Generate a Data Report.
3Configure:
Table properties.
Logging conditions
for single point.
2Double-click
DATA_LOG to open
the table.
Note: Data logged for points includes: Point ID, Time the point value was logged
(timestamp), Resource, Value and other optional attributes that you select.
Indexes, Columns, Rows in CIMPLICITY Data Log Tables
Indexes in Data logging tables include a:
Primary key index on the joined timestamp and Point ID columns and
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.
GFK-1180J Configuring the Database Logger 26-33
Columns in CIMPLICITY data logging tables include:
A timestamp column,
A Point ID column and
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.
26-34 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2. Add Points to a CIMPLICITY Data Log Table
You can add points to a data or group log through either the:
Option 1. Point Properties dialog box or
Option 2. Database Logger.
Option 1. Add a points data to a CIMPLICITY data table:
1. Select Points in the left pane of the Workbench.
2. Select, in the right pane, the virtual or device point for which you want to log
values.
3. Open the points Properties dialog box.
4. Select the General tab.
5. Check Log data
Click either to add the point to the default
CIMPLICITY DATA_LOG.
6. Click OK or Appl y.
Result: CIMPLICITY adds the point to its default DATA_LOG. You can apply
more specifications in the Database Logger.
You can add points to a data or group log table through the Database Logger
Configuration window and in a data log or group log table's window. .
Option 2. Add points to a CIMPLICITY data log table:
1. Do one of the following in the Database Logger Configuration window or a data
log table (e.g. DATA_LOG) window.
In the Database Logger Configuration window
A. Select a CIMPLICITY data log table.
B. Do one of the following:
Method 1
Click the Add Item button on the Database Logger Configuration
window toolbar.
Method 2
GFK-1180J Configuring the Database Logger 26-35
i. Click Edit on the Database Logger Configuration window menu bar.
ii. Select Add Points
Method 3
i. Right-click a CIMPLICITY data table.
ii. Select Add Points from the popup menu.
In a CIMPLICITY data log table (e.g. DATA_LOG)
Do one of the following.
Method 1
Click the Add Item button on the data log table toolbar.
Method 2
A. Click File on the data table menu bar.
B. Select Add Points
Method 3
A. Right-click in the data table window.
B. Select Add Points from the popup menu.
The Select a Point browser opens when you use any method.
1 Select the Point
IDs to add to the
DATA_LOG or
GROUP_LOG.
2 Click OK.
Piont Browser Example
2. Select the Point IDs you want to add.
3. Click OK.
Result: The Point IDs display in the data table window and will be logged
according to your specifications.
26-36 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Configure CIMPLICITY Point Data Logging Properties
You configure the point logging properties for all points in a data log table in a Table
Properties dialog box. You can adjust the logging conditions for a single point in the
(Database Loggers) Point Properties dialog box..
The tasks to configure the point logging properties include:
Task 1. Open a CIMPLICITY data log table Properties dialog box.
Task 2. Configure data logging conditions.
Task 3. Configure data logging attributes.
Task 4. Configure data log maintenance events.
Task 5. Configure maintenance actions.
Task 6. Configure the CIMPLICITY point data log connection.
Task 7. Do advanced configuration for a data log table.
Step 3. Task 1Data Log Table
Open a Table Properties Dialog Box.
Task 1. Open a Data Log Table Properties di alog box:
1. Either:
Select a data table (e.g. DATA_LOG) in the Database Logger
Configuration window, or
Open the data log table's window. See page 26-13 for details.
2. Do one of the following.
Method 1
Click the Table Properti es button on either windows toolbar.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click a data table in the Database Logger Configuration window or
any Point ID in the data table's window.
B. Select Table Properties from the popup menu.
Result. The data table, e.g. DATA_LOG Table Properties dialog box opens when
you use any method.
GFK-1180J Configuring the Database Logger 26-37
Step 3. Task 2Data Log Table
Configure Default Logging Conditions
Logging Conditions determine when data will be logged into the table.
Note: For a CIMPLICITY data log table, you can change the table's default logging
conditions for an individual point in the (Database Loggers) Point Properties dialog box.
See page 26-51 for details.
Task 2. Configure data table logging conditions:
1. Select the Default Logging Conditions tab.
The conditions you check define the default conditions for when the value of the
points in the table will be logged.
2. Specify Timed/gated logging intervals, as follows.
A. Check Periodic to log data into the table at regular intervals.
i. Enter the time value in the Periodic field, and
ii. Select the time interval.
Valid intervals are DAYS, HOURS, MINUTES, SECONDS, or
TICKS (100 ticks =1 second).
B. Check Synchronized to log data at a particular time of day.
i. Enter the time in the input field, and
ii. Select AM or PM.
C. Check On digital point state to log data while a digital point is in a certain
state.
i. Select the state to check for and
ii. Enter the digital Point ID in the input field.
Valid states are HIGH, LOW, and TRANSITION.
26-38 CIMPLICITY User's ManualDecember 2000 GFK-1180J
If a periodic time interval is not specified, logging will be triggered
when the selected digital point transitions to the selected state, or any
time the digital point transitions (if transition is selected).
If you select a TRANSITION point state, together with a periodic or
synchronized time, the gate will be ignored.
See page 26-52 for more information about timed/gated logging.
3. Specify Data triggered logging as follows.
A. Select to log data when a selected point value is updated as follows:
i. Check On point value update.
ii. Check either:
Point being logged
Each point that was added to the table after Point being logged
was checked (and does not have a customized logging condition) is
logged when its value is updated.
Specific point
Specified point is updated. Enter a Point ID for this option.
Click the Browser button to open the Select a Point
browser or
Click the Popup Menu button to display options for
selecting a point.
The conditions you check define the conditions for when the values of
all the points in the table will be logged.
iii. Use the Deadband option if you want to filter out changes in the value
of the selected point type before triggering a logging eventfor either
the point being logged or the specific point.
a. Check Deadband.
b. Enter a Deadband value that is a floating-point number.
c. Specify if the entered value should be evaluated, to trigger another
logging event, as an:
Absolute value or
Percent of the last value.
The point's value must change more than the Deadband value before
another logging event will be triggered.
GFK-1180J Configuring the Database Logger 26-39
Exampl e 1. Absolute Value
An Absolute Deadband value is 5.0.
Point Value Result
200.0 First logging event
201.3 No Logging event
204.2 No Logging event
205.1 Logging event triggered.
Exampl e 2. Percent Value
A Percentage Deadband value is 5.0
Point Value Result
200.0 First logging event
201.3 No Logging event
204.2 No Logging event
205.1 No Logging event
210.2 Logging event triggered.
Note: An explicit deadband of 0 specifies that the point must have actually
changed as opposed to having been updated by the point manager.
B. Check On point alarm state to log point values when a specified point
goes into one or more selected alarm states.
Enter the Point ID in the Point Alarm field.
Click the Browser button to open the Select a Point browser or
Click the Popup Menu button to display options for selecting a
point.
Important: 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.
C. Check one or more of the alarm states (e.g., Alarm high).
Note: The values for these alarm states are specified on the Alarm tab in
the selected points Properties dialog box.
Point Properties dialog box
Alarm tab
Data log Properties dialog box
Default Logging Conditions tab
Group log Properties dialog box
Logging Conditions tab
Alarm Limits Used as Logging Conditions
26-40 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Guidelines for selecting triggered logging:
You can combine On point value update logging with On point alarm state
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.
You can combine triggers. When you combine triggers, logging occurs when either
of the triggers occurs.
Exampl e
You want to log a set of points when POINT_A is updated or when POINT_B is in Alarm
High state. Do the following.
1. Check the On point value update check box.
2. Enter POINT_A in the Point field.
3. Check the On point alarm state check box.
4. Check the Alarm High check box.
5. Enter POINT_B in the Point field.
Note: If a device point is configured as On Scan, the point value is updated on every
scan even though its value remains unchanged.
Tip: Click Use Defaults to reset the Logging Conditions to their default values. The
default is to log data periodically every 5 minutes.
GFK-1180J Configuring the Database Logger 26-41
Step 3. Task 3Data Log Table
Configure Logging Attributes
Logging Attributes for a data log table (e.g. DATA_LOG) enables you to:
Select the current point attributes that will be logged to the table.
Log the name of the CIMPLICITY project.
Task 3. Configure a CIMPLICITY data log table's logging attributes:
1. Select the Logging Attributes tab.
2. Check any of the following point attributes to log:
Point Attribute Log the:
Default point attributes/
Point attributes
Point Value Point's current value.
Select a Data Type. The Database Logger will
attempt to force the logged data into the type you
select.
Options are:
INT
UINT
DINT
UDINT
REAL
STRING (255)
Previous Value Previous value recorded in this table for this point.
Select a Data Type.
Raw Value Point's raw value.
Select a Data Type.
Alarm State Point's alarm state when the value is being logged.
26-42 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Resource Point's Resource ID.
Time Last Logged Time the point was last logged in this table.
Engineering Units Point's engineering units.
Quality Is the value of the QUALITY attribute. See "Quality
(Attribute)" in the "Using Point Attributes" chapter in
this manual for detailed information about quality
points.
User Flags Value of the USER_FLAGS attribute. See "User
Defined Point Attributes" in the "Using Point
Attributes" chapter in this manual for detailed
information about user defined point attributes.
Table attributes
Project name Project name.
Tip: Click Use Defaults to reset the Logging Attributes to their default values. The
defaults are to:
Log Point Value (STRING(255) in the DATA_LOG) and
Not log the Project Name.
Step 3. Task 4Data Log Table
Configure Maintenance Events
Maintenance Events define when export, purge, and command actions will be performed
on the table.
You can specify that maintenance be triggered when:
A condition, such as low disk space, occurs or
On a periodic or gated interval
Any specified event will trigger maintenance actions.
Task 4. Specify maintenance events:
1. Select the Maintenance Events tab in a data Table Properties dialog box.
GFK-1180J Configuring the Database Logger 26-43
2. Specify one or more of the Timed/gated maintenance intervals, as follows.
A. Check Periodic to trigger maintenance at regular intervals.
i. Enter the time value in the Periodic field, and
ii. Select the time interval.
Valid intervals are days, hours, minutes or seconds.
B. Check Synchronized to trigger maintenance at a particular time of day.
i. Enter the time in the input field, and
ii. Select AM or PM.
C. Check On digital point state to log data while a digital point is in a certain
state.
i. Select the state to check for and
ii. Enter a digital Point ID in the input field.
Valid states are HIGH, LOW, and TRANSITION.
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 are
triggered when the specified digital point transitions to the selected
state, or any time the digital point transitions (if transition is selected).
See page 26-52 for more information about timed/gated events.
3. Specify if and when maintenance events should be triggered.
Use either or both of the following conditions.
A. A drives space falls below a specified size:
i. Check Disk space low.
ii. Select the drive in the Drive field.
iii. Specify the megabytes in the Space remaining field.
Maintenance events occur when space falls below the specified threshold.
Note: The disk is checked at an interval that you specify on the Parameters
tab the Logging Properties dialog box. See page 26-24 for details.
B. The logging count exceeds a specified number.
i. Check Logging count.
ii. Enter the number records. Maintenance actions will be executed when
the number of records logged to the table reaches a multiple of this
number.
Exampl e
You specify 500.
Maintenance actions are executed when the count reaches 500, 1000,
1500, etc.
Note: If you check both conditions maintenance is triggered when either
condition occurs.
26-44 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Task 5Data Log Table
Configure Maintenance Actions
Maintenance Actions define the type of actions that take place when a Maintenance
Event occurs.
You can configure the data log table to:
Export records to an export file,
Purge records from a logging table and/or
Incorporate command line actions.
Task 5. Configure one or more maintenance actions:
1. Select the Maintenance Actions tab in a CIMPLICITY data log Table Properties
dialog box.
2. Specify that the Database Logger delete data from a logging table when a
maintenance event occurs, as follows.
A. Check Delete records
B. Select the number of records you want to retain in the table in one of the
following ways.
By Count Delete all but the last (most recent) <n>records in the
table.
By Time Delete all but the records entered in the table for the last
<n>days, hours, or minutes.
C. Do the following if you want to save the purged data to a CSV format file
before removing it from the table.
i. Check the Save deleted in file check box
ii. Enter the name of the CSV file.
3. Specify an export action.
A. Check Export records.
B. Select the type of export you want to perform.
You can choose to export one of the following:
GFK-1180J Configuring the Database Logger 26-45
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.
The Database Logger exports the data you specify from a
logging table to a CSV (Comma Separated Value) format
file when a maintenance event occurs.
4. Incorporate one or more Command Line actions as follows.
Check Execute SQL command and enter a SQL command in the
accompanying field.
Exampl e
You may want to count records in the data table from the current time
minus one day (point values logged in the last 24 hours).
To do this you could enter:
INSERT INTO MYTABLE VALUES NOW(), SELECT COUNT(*) FROM
DATA_LOG
Where:
DATA_LOG is the data log table.
Check Run a program and enter a program pathname in the accompanying
field.
You may include command-line arguments for the program.
Exampl e
You have configured purge actions to save the records to a .CSV file. You
write a program that transfers the files to a zip drive. You enter:
D:\Deleted\ Backupdeletedcsv.bat
Where
D:\Deleted\ is the path to the program
Backupdeletedcsv.bat is the program that will be run when a
maintenance event occurs.
Check Compact database to compact the Microsoft Access database
where the table resides during a maintenance event.
Warning: 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.
26-46 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Tip: The default maintenance actions include purging all records except those created
within the last day. Click Use Defaults to use the default maintenance actions.
Step 3. Task 6Data Log Table
Configure the Connection
Connection defines the database connection and the Store and Forward properties for the
table.
You can:
Use the default connections that are specified on the Default Point Connection
tab in the Logging Properties dialog box or
Specify connections that are specific to the Data Log table.
Task 6. Configure data table connections:
Option 1. Use the default connections
1. Select the Connection tab.
2. Check Use default point connection.
Result: The Connection tab is dimmed and unavailable for configuration. The
data log table uses the connections specified on the Default Point Connection tab
in the Logging Properties dialog box.
Option 2. Specify connections that are specific for the data table.
1. Select the Connection tab.
2. Uncheck Use default point logging if it is checked.
GFK-1180J Configuring the Database Logger 26-47
The fields on the Logging Properties tab become available to entries.
3. Select an ODBC data source from the drop down list in the ODBC data
source, field. You can select from available options or configure an existing or
a new ODBC data source:
A. Make a selection from the one or more Microsoft Access or SQL Server
options in the drop down menu. Basic options include:
CIMPLICITY Alarm Logging
A Microsoft Access data source that logs data to the CIMPLOG.MDB file
in the ARC directory of your CIMPLICITY project.
CIMPLICITY Point Logging
A Microsoft Access data source that logs data to the POINTLOG.MDB
file in the ARC directory of your CIMPLICITY project.
CIMPLICITY SQL Server Logging
A Microsoft SQL Server data source that logs data to an on-node SQL
Server database. You must install SQL Server to use this data source.
(CIMPLICITY offers CIMPLICITY SQL for your convenience.)
If you have an Oracle database, you may see the ODBC data source
that you created for Oracle.
B. Configure an existing or add a new ODBC data source.
i. Click the ODBC Data Source button to the right of the ODBC
data source field.
The ODBC Data Source Administrator opens.
26-48 CIMPLICITY User's ManualDecember 2000 GFK-1180J
ii. Select the System DSN tab.
iii. Configure the new ODBC data source based on the data source
procedures.
iv. Close the ODBC Data Source Administrator.
v. Select the new ODBC data source from the drop down menu.
4. Enter the username in the Database user field who will connect to the selected
database driver.
Important: This field is required if you are connecting to a SQL Server.
5. Enter the Password needed to connect to the selected database driver.
Important: This field is required if you are connecting to a SQL Server.
6. Enter a value between 0 (continuous retries) and 24 hours in the Reconnect
wait period field.
This value specifies the amount of time that the Database Logger waits between
reconnect attempts when the connection to the database is lost.
The default is 30 seconds.
7. For Store and Forward either:
A. Uncheck Enable Store and Forward.
ALARM_LOG will not perform store and forward functions.
B. Check Enable Store and Forward.
The feature is enabled. Check one of the two following options.
Option Check if you want
No Limit 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.
GFK-1180J Configuring the Database Logger 26-49
Max number of stored records 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.
Step 3. Task 7Data Log Table
Advanced Configuration
The Advanced tab in the data log's Table Properties dialog box enables you to:
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
To do advanced configuration for a data log table:
1. Select the Advanced tab in the data log's Table Properties dialog box.
2. Select whether to log data to the table. Either:
Check Disable logging actions to stop logging data to the selected table,
or
Leave Disable logging actions unchecked to have data logged to the table
when the CIMPLICITY project is running.
3. Specify the logging queue size. Either
Check Use default to use the universal size specified on the Parameters tab
in the Database Logger's Logging Properties dialog box, or
Specify a queue size for the selected table, if it has special requirements, as
follows:
A. Uncheck Use default.
26-50 CIMPLICITY User's ManualDecember 2000 GFK-1180J
B. Enter a number in the Write queue size field that supports the worst-
case logging during activity bursts.
For example, if 10 points are being logged to the table, you should have
a queue size of at least 10 in case the points' logging conditions all
occur simultaneously.
4. Take advantage of the Database Logger's bulk insertion capability (Microsoft
SQL Server or MSDE only) as follows:
A. Check Use bulk insertion.
B. Select the Maximum number of insertions that your system can handle.
C. Select the interval between insertions in the Bulk insertion rate field.
The Database Logger will be triggered to insert records, based on whichever
specification occurs first.
Exampl e
You specify the:
Maximum number of insertions is 1000.
Bulk insertion rate is 60 seconds.
As a result:
If the Database Logger collects 1000 records within 60 seconds, it
inserts the records into the log.
If 60 seconds go by before 1000 records are reached, the Database
Logger inserts whatever records have been collected.
GFK-1180J Configuring the Database Logger 26-51
Step 4. Configure Logging Conditions for a Single Point
You can change the logging conditions for a single point from the default conditions
specified for the Data Logging table.
To configure the logging conditions for a single point:
1. Open a CIMPLICITY data table's window.
2. Select the point you want to log under different conditions from the default.
3. Do one of the following.
Method 1
Double-click the selected Point ID.
Method 2
Click the Item Properties button on the window's toolbar.
Method 3
A. Click Edit on the window's menu bar.
B. Select Point Properties
Method 4
A. Click the right mouse button.
B. Select Properties from the popup menu.
The (Database Loggers) Point Properties dialog box opens when you use any
method displaying either the default logging conditions or conditions that were
previously checked for the selected alarm.
3. Select the logging conditions that apply to the selected point. See page 26-37 for
details about logging conditions.
4. Click OK.
Result: The selected point will be logged when its logging conditions occur.
26-52 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Notes on Timed/Gated Logging and Timed/Gated Maintenance
Timed/gated events for both maintenance and point logging contain three options that can
be used either separately or combined. The following is a summary of the behavior for
each possible combination.
Option 1. Periodic only.
Option 2. Synchronized only.
Option 3. Periodic and synchronized.
Option 4. On digital point state only.
Option 5. Periodic and on digital point state.
Option 6. Synchronized and on digital point state.
Option 7. Periodic, synchronized and on digital point state.
Option 1. Periodic Onl y
Logging/Maintenance actions will be executed at the time interval specified.
Table Properties Dialog Box: Maintenance Events Tab
Periodic only
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
Option 2. Synchronized Onl y
Logging/Maintenance actions are executed at the specified time of day.
Table Properties Dialog Box: Maintenance Events Tab
Synchronized only
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
Option 3. Periodic and Synchronized
Logging/Maintenance actions are executed:
Periodically at the specified time interval (periodic).
Beginning at the specified time of the day (synchronized).
GFK-1180J Configuring the Database Logger 26-53
Table Properties Dialog Box: Maintenance Events Tab
Periodic and Synchronized
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
Option 4. On Digital Point Onl y
Digital Point State Logging/Maintenance Actions are Executed When
the Selected Digital Point Transitions to the:
HIGH HIGH state.
LOW LOW state.
TRANSITION HIGH or LOW state.
Table Properties Dialog Box: Maintenance Events Tab
On digital point state only
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
high
low
transition
26-54 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Option 5. Periodic and on Digital Point State
Logging/Maintenance actions are executed:
For the Selected
Digital Point State
When the Selected
Digital Point
Transitions to the:
And at the Specified
Time Interval while
the Digital Point
Stays in the:
HIGH HIGH state HIGH state
LOW LOW state LOW state.
TRANSITION HIGH or LOW state HIGH or LOW state.
Table Properties Dialog Box: Maintenance Events Tab
Periodic and On digital point state
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
Option 6. Synchronized and On Digital Point State
Logging/Maintenance actions are executed:
For the Selected
Digital Point State
At the Specified Day Time
if the Digital Point is in the:
HIGH HIGH state
LOW LOW state.
TRANSITION HIGH or LOW state.
Table Properties Dialog Box: Maintenance Events Tab
Synchronized and On digital point state
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
GFK-1180J Configuring the Database Logger 26-55
Option 7. Periodic, Synchronized and On Digital Point State
Logging/Maintenance actions are executed:
For the Selected
Digital Point State
At the Specified Day
Time if the Digital
Point is in the
And at the Specified
Time Interval while
the Digital Point
Stays in the:
HIGH HIGH state HIGH state
LOW LOW state LOW state.
TRANSITION HIGH or LOW state HIGH or LOW state.
Table Properties Dialog Box: Maintenance Events Tab
Periodic, Synchronized and On digital point
state
high
low
transition
Note: Fields also appear for Timed/gated logging on a:
Data log table's Default Logging Conditions tab.
Group log table's Logging Conditions tab.
26-56 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Group Point Logging
Group Point logging provides you with a straightforward process for creating and
maintaining records to analyze the performance of selected points, whose values and
selected attributes are logged at the same time. The point performance represents the
actual performance of equipment and processes in your system. As a result, point logging
provides you with an in depth record that can help you determine if action is required to
improve the performance of any equipment or process in your system.
Steps to configure group logging include:
Step 1. Choose a CIMPLICITY group log table (e.g. GROUP_LOG).
Step 2. Add points to a group log table.
Step 3. Configure group logging properties.
Step 4. Configure logging attributes for a single point.
Important: When using fully qualified points, you must provide remote project login
configuration with the project.
1. Expand the Security folder in the Workbench left pane.
2. Expand the Advanced folder.
3. Select Remote Projects .
4. Configure the fully qualified local project as a remote project.
GFK-1180J Configuring the Database Logger 26-57
Step 1. Choose a Group Log Table
The Database Logger provides you with the ability to log values for groups of points in
parallel in a group log table.
Group Logging enables you to log data 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.
You can display, print and analyze that information in a report that you create or in an
Excel CIMPLICITY Trend Report that is included in CIMPLICITY. See page 26-112 for
details.
1Click the Database Logger icon to
open the Database Logger
Configuration window.
Logging Group Points Overview
4Open SQLGgroup.XLS or SQLGROUP97.XLS in Excel. (In the
CIMPLICITY\HMI\ REPORT\ directory). Generate a Trend Report.
3Configure:
Table properties.
Attributes for a point.
2Double-click
GROUP_LOG to
display the table.
Note: Data logged for groups of points includes the time the values are logged
(timestamp) and Point ID values.
Point data can be logged as follows:
At a specified time of day.
Periodically at a specified time interval.
26-58 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Periodically at a specified time interval while a digital point is HIGH or LOW.
In response to an event.
When the alarm state on a point changes.
Whenever a point's value is updated.
Group Tables
Indexes in Group logging tables include 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.
Columns in Group logging tables include a:
A timestamp column.
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.
Note: A table can have, at most 250 columns.
Important: Since the Microsoft Access format does not support sub-second timestamp
data, you cannot log points to a Group table at sub-second rates. Attempting to do so will
cause the duplicate-keyed records to be dropped from the database.
GFK-1180J Configuring the Database Logger 26-59
Step 2. Add Points to a CIMPLICITY Group Table
You can add points to a group log through the Database Logger Configuration window
and in a Group Log window. .
Option 2. Add points to a group tabl e:
1. Do one of the following in the Database Logger Configuration window or the
group table's window.
In the Database Logger Configuration window
A. Select a group table (e.g., GROUP_LOG).
B. Do one of the following:
Method 1
Click the Add Item button on the Database Logger Configuration
window toolbar.
Method 2
i. Click Edit on the Database Logger Configuration window menu bar.
ii. Select Add Points
Method 3
i. Right-click a group table.
ii. Select Add Points from the popup menu.
In a group table window
Do one of the following.
Method 1
Click the Add Item button on the window's toolbar.
Method 2
A. Click File on the window's menu bar.
B. Select Add Points
Method 3
A. Right-click in the group table's window.
B. Select Add Points from the popup menu.
26-60 CIMPLICITY User's ManualDecember 2000 GFK-1180J
The Select a Point browser opens when you use any method.
1 Select the Point
IDs to add to the
DATA_LOG or
GROUP_LOG.
2 Click OK.
Piont Browser Example
2. Select the Point IDs you want to add.
3. Click OK.
Result: The Point IDs display in the group table's window and will be logged
according to your specifications.
GFK-1180J Configuring the Database Logger 26-61
Step 3. Configure Group Logging Properties
You configure the point logging properties for all points in a in a CIMPLICITY group
table's Table Properties dialog box. (You can adjust the logging conditions for a single
point in the (Database Loggers) Point Properties dialog box.).
The tasks to configure the point logging properties include:
Task 1. Open the CIMPLICITY group Table Properties dialog box.
Task 2. Configure logging conditions.
Task 3. Configure logging attributes.
Task 4. Configure maintenance events.
Task 5. Configure maintenance actions.
Task 6. Configure the CIMPLICITY group point log connection.
Task 7. Configure advanced properties for a group log table.
Step 3. Task 1Group Log Table
Open a Table Properties Dialog Box.
Task 1. Open a group Table Properties dialog box:
1. Either:
Select a group table (e.g., GROUP_LOG) in the Database Logger
Configuration window, or
Open the group table (e.g., GROUP_LOG) window. See page 26 -13 for
details.
2. Do one of the following.
Method 1
Click the Table Properti es button on either windows toolbar.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click a group table in the Database Logger Configuration window or
any Point ID in the group table's window.
B. Select Table Properties from the popup menu.
Result. The group table's (e.g., GROUP_LOG) Table Properties dialog box opens
when you use any method.
26-62 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Task 2Group Log Table
Configure Logging Conditions
Logging Conditions determine when data will be logged into the table
Note: Because, the points in a group table are logged in parallel, the logging conditions
are the same for all. However, you can select attributes that will be logged for individual
points.
Task 2. Configure group table logging conditions:
1. Select the Logging Conditions tab.
The conditions you check define the conditions for when the values of all the
points in the table will be logged.
2. Specify logging conditions the same way you specify them for a data log table.
See page 26-37 for details.
4. Check On point alarm state to log point values when a specified point goes
into one or more selected alarm states.
Step 3. Task 3Group Log Table
Configure Logging Attributes
Logging Attributes for a group table (e.g. GROUP_LOG) enables you to:
Select the current point attributes that will be logged to the table.
Log the name of the CIMPLICITY project.:
The checked logging attributes will be the default logging attributes for additional points
you add to the group table.
Note: You can also specify that selected attributes be logged for individual points in the
group table. See page 26-68 for details.
GFK-1180J Configuring the Database Logger 26-63
Task 3. Configure a group log tabl e's logging attributes:
1. Select the Logging Attributes tab.
2. Check any of the following point attributes to log:
Point Attribute Log the:
Default point attributes/
Point attributes
Point Value Point's current value.
Previous Value Previous value recorded in this table for this point.
Raw Value Point's raw value.
Alarm State Point's alarm state when the value is being logged.
Resource Point's Resource ID.
Time Last Logged Time the point was last logged in this table.
Engineering Units Point's engineering units.
Quality Is the value of the QUALITY attribute. See "Quality
(Attribute)" in the "Using Point Attributes" chapter in
this manual for detailed information about quality
points.
User Flags Value of the USER_FLAGS attribute. See "User
Defined Point Attributes" in the "Using Point
Attributes" chapter in this manual for detailed
information about user defined point attributes.
Table attributes
Project name Project name.
Tip: Click Use Defaults to reset the Logging Attributes to their default values. The
defaults are to:
Log Point and
Not log the Project Name.
26-64 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Task 4Group Log Table
Configure Maintenance Events
Maintenance Events define when export, purge, and command actions will be performed
on the table.
You can specify that maintenance be triggered when:
A condition, such as low disk space, occurs or
On a periodic or gated interval
Any specified event will trigger maintenance actions.
Task 4. Specify maintenance events for a group log tabl e:
1. Select the Maintenance Events tab in group Table Properties dialog box.
2. Specify events the same way you specify them for a data log.table See page 26-
42 for the procedure.
Step 3. Task 5Group Log Table
Configure Maintenance Actions
Maintenance Actions define the type of actions that take place when a Maintenance
Event occurs.
You can configure a group table to:
Export records to an export file,
Purge records from a logging table and/or
Incorporate command line actions.
GFK-1180J Configuring the Database Logger 26-65
Task 5. Configure one or more group log table maintenance actions:
1. Select the Maintenance Actions tab in the group log Table Properties dialog box.
2. Specify actions the same way you specify them for a data log.table. See page 26-
44 for the procedure.
Step 3. Task 6Group Log Table
Configure a CIMPLICITY Group Table Connection
Connection defines the database connection and the Store and Forward properties for the
table.
You can:
Use the default connections that are specified on the Default Point Connection
tab in the Logging Properties dialog box or
Specify connections that are specific to the data or group logging table.
26-66 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Task 6. Configure a group log tabl e connection:
Option 1. Use the default connections
1. Select the Connection tab.
2. Check Use default point connection.
Result: The Connection tab is dimmed and unavailable for configuration. The
CIMPLICITY group table uses the connections specified on the Default Point
Connection tab in the Logging Properties dialog box.
Option 2. Specify connections that are specific for the group table.
1. Select the Connection tab.
2. Uncheck Use default point point connection if it is checked.
The fields on the Connection tab become available for entries.
2. Specify the connection the same way you specify it for a data log table. See page
26 -46 for the procedure.
GFK-1180J Configuring the Database Logger 26-67
Step 3. Task 7Group Log Table
Advanced Configuration
The Advanced tab in the group log's Table Properties dialog box enables you to:
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
To do advanced configuration for a group log tabl e:
1. Select the Advanced tab in the group log's Table Properties dialog box.
2. Do advanced configuration the same way you do for a data log table. See page
26-49 for the procedure.
26-68 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. Configure Logging Attributes for a Single Point
You can specify the logging attributes for a single point from the default attributes
specified for the group logging table.
To configure the logging attributes for a single point in a group tabl e:
1. Open a group table (e.g. GROUP_LOG) window.
2. Select the point for which you want to log different attributes from the default.
3. Do one of the following.
Method 1
Double-click the selected Point ID.
Method 21
Click the Item Properties button on the group log table toolbar.
Method 3
A. Click Edit on the window's menu bar for the group log table.
B. Select Point Properties
Method 4
A. Click the right mouse button.
B. Select Properties from the popup menu.
The (Database Loggers) Point Properties dialog box opens when you use any
method displaying either the default logging conditions or conditions that were
previously checked for the selected alarm.
3. Check the attributes that you want logged for the selected point.
4. Click OK.
Result: The attributes you select will be logged for the selected point. The selection
does not change if you change the table defaults.
GFK-1180J Configuring the Database Logger 26-69
Alarm Logging
Alarm logging provides you with a straightforward process for creating and maintaining
records to analyze the alarm state of equipment and processes in your system. As a result,
alarm logging helps you determine if action is required to repair or maintain your system.
The Database Logger enables you to:
Log data about selected alarms or all alarms to an alarm log table.
Save the log files, until specified criteria occur.
Have the logged data discarded, based on specified criteria.
Save the logged data to another file for future analysis.
You can display, print and analyze that information in a report that you create or in an
Excel CIMPLICITY Alarm Report that is included in CIMPLICITY. See page 26-116 for
details about CIMPLICITY Alarm Reports.
Note: Data logged for alarms includes: Alarm ID, Time the Alarm was Generated,
Alarm Class, Resource, Alarm Message, Logged By and other optional attributes that you
select.
Steps to configure alarm logging include:
Step 1. Review system alarms included in the alarm log table.
Step 2. Add additional alarms to the alarm log table.
Step 3. Configure alarm logging properties.
Step 4. Configure logging conditions for a single alarm.
26-70 CIMPLICITY User's ManualDecember 2000 GFK-1180J
1Click the Database Logger icon to
open the Database Logger
Configuration window.
Logging Alarms Overview
4Open SQLALARM.XLS or SQLALARM97.XLS in Excel. (In the
CIMPLICITY\HMI\ REPORT\ directory). Generate an Alarm Report.
3Configure
Table Properties.
Logging conditions
for an alarm.
2Double-click
ALARM_LOG to
display the table.
Note: You cannot copy or create a second ALARM_LOG.
Step 1. Review System Alarms in the ALARM_LOG
The following system alarms are recorded in the Alarm Log table:
Alarm ID Description
$DEVICE Specified device has a problem.
$DEVICE_DOWN Specified device has failed.
$DEVICE_FAILOVER Device failover for Server Redundancy.
$GMR_DEV_DOWN Specified Series 90 TCP/IP redundant device is
down.
$GMR_POINT_DISCREPANCY Specified Series 90 TCP/IP redundant point has
discrepancy.
$REDUND_DEV_DOWN Redundant device down for Server Redundancy.
AMSI_ALARM Reserved for future use.
DB_CONN_DOWN Connection lost to specified database for
Database Logger.
GFK-1180J Configuring the Database Logger 26-71
DB_START_FORWARD Forwarding files found for Database Logger
Store and Forward.
MCP_PROC_DOWN Specified CIMPLICITY process has terminated
unexpectedly.
Indexes, Columns, Rows in the ALARM_LOG Table
Indexes in Alarm logging tables include a:
Primary key index on the joined timestamp and sequence number columns and
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.
Columns in Alarm logging tables include:
Columns that are specific to that table.
An additional column for each table attribute that you have selected.
Rows in all Alarm logging tables include:
A timestamp column and
An auto increment sequence number that ensures that each row is unique.
Step 2. Add Point Alarms and Alarms to the ALARM_LOG Table
You can add the following to the CIMPLICITY alarm log table:
Option 1. Point alarms via the Point Properties dialog box.
Option 2. Alarms through the Database Logger.
Option 1.
Add Point Alarms to the ALARM_LOG Table via a Point
Properties Dialog Box
1. Select Points in the left pane of the Workbench. .
2. Select the point for which you want to log alarms in the right pane.
3. Open the points Properties dialog box.
4. Select the Alarm tab.
5. Check if and when you want an alarm to be logged in the Alarm Logging box on
the Alarm tab of the Point Properties dialog box. You can select any or all of the
options:
Condition Alarm data is logged when the alarm:
Generate Occurs.
Acknowledge Is acknowledged by the operator or the system.
Reset Is reset by the operator or the system.
Delete Is manually deleted from the system.
26-72 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Click either to add the point to the default
CIMPLICITY ALARM_LOG.
6. Click OK or Appl y.
Result: CIMPLICITY adds the point to its default ALARM_LOG. You can apply
more specifications in the Database Logger.
Option 2.
Add Alarms to ALARM_LOG through the Database Logger
You can add alarms to the CIMPLICITY ALARM_LOG table through the Database
Logger Configuration window and in the ALARM_LOG window.
1. Do one of the following in the Database Logger Configuration window or the
ALARM_LOG window. .
In the Database Logger Configuration window
A. Select ALARM_LOG
B. Do one of the following:
Method 1
Click the Add Item button on the Database Logger Configuration
window toolbar.
Method 2
i. Click Edit on the Database Logger Configuration window menu bar.
ii. Select Add Alarms
Method 3
i. Right-click ALARM_LOG.
ii. Select Add Alarms from the popup menu.
GFK-1180J Configuring the Database Logger 26-73
In the ALARM_LOG window
Do one of the following.
Method 1
Click the Add Item button on the ALARM_LOG toolbar.
Method 2
A. Click File on the ALARM_LOG window menu bar.
B. Select Add Alarms
Method 3
A. Right-click in the ALARM_LOG window.
B. Select Add Alarms from the popup menu.
The Select an Alarm Definition browser opens when you use any method.
1 Select the alarms
to add to the
ALARM_LOG.
2 Click OK.
Alarm Browser Example
2. Select the Alarm IDs you want to add.
3. Click OK.
Result: The alarms display in the ALARM_LOG window and will be logged
according to your specifications.
26-74 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Configure Alarm Logging Properties
You configure the alarm logging properties for all included alarms in the ALARM_LOG
Table Properties dialog box. (You can adjust the logging conditions for a single alarm in
the Alarm Properties dialog box.). See page 26-81 for details.
The tasks to configure the alarm logging properties include:
Task 1. Open the ALARM_LOG Table Properties dialog box.
Task 2. Configure default logging conditions.
Task 3. Configure logging attributes.
Task 4. Configure maintenance events.
Task 5. Configure maintenance actions.
Task 6. Configure the ALARM_LOG connection.
Task 7. Configure advanced properties for the ALARM_LOG table.
Step 3. Task 1ALARM_LOG Table
Open a Table Properties dialog box.
You can use the same methods to open the ALARM_LOG Table Properties dialog box in
the open ALARM_LOG table or the Database Logger Configuration window. .
Step 1. Open the ALARM_LOG Table Properties dialog box:
1. Either:
Select ALARM_LOG in the Database Logger Configuration window, or
Open the ALARM_LOG window. See page 26-13 for procedures to open
an existing table.
2. Do one of the following.
Method 1
Click the Table Properti es button on either windows toolbar.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click ALARM_LOG in the Database Logger Configuration window
or any alarm in the ALARM_LOG window.
B. Select Table Properties from the popup menu.
Result. The ALARM_LOG Table Properties dialog box opens when you use any
method.
GFK-1180J Configuring the Database Logger 26-75
Step 3. Task 2ALARM_LOG Table
Configure Default Logging Conditions
Logging Conditions determine when data will be put into the log table. .
Note: You can change the conditions you specify in the ALARM_LOG Table Properties
for a single alarm. See page 26-81 for detials.
Step 2. Configure ALARM_LOG default logging conditions:
1. Select the Default Logging Conditions tab.
The conditions you check define the default conditions for when the alarms in
the table will be logged.
2. Modify the existing default conditions, if required.
The conditions are:
Condition Alarm data is logged when the alarm:
Generate Occurs.
Acknowledge Is acknowledged by the operator or the system.
Reset Is reset by the operator or the system.
Delete Is manually deleted from the system.
26-76 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Task 3ALARM_LOG Table
Configure Logging Attributes
Logging Attributes for an ALARM_LOG table enables you to log the name of the
CIMPLICITY project. :
Step 3. Configure the ALARM_LOG logging attributes:
1. Select the Logging Attributes tab in the Table Properties dialog box.
2. Check Project name to log the project name.
Tip: Click Use Defaults to set the logging attributes to their default value. The
ALARM_LOG will be set to not log the Project Name.
Warning: If you select or de-select 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-1180J Configuring the Database Logger 26-77
Step 3. Task 4ALARM_LOG Table
Configure Maintenance Events
Maintenance Events define when export, purge, and command actions will be performed
on the table. .
You can specify that maintenance be triggered when:
A condition, such as low disk space, occurs or
On a periodic or gated interval
Step 4. Specify maintenance events for an ALARM_LOG table:
1. Select the Maintenance Events tab in the ALARM_LOG Table Properties dialog
box.
2. Specify events the same way you specify them for a data log.table See page 26-
42 for the procedure.
Step 3. Task 5ALARM_LOG Table
Configure Maintenance Actions
Maintenance Actions define the type of actions that take place when a Maintenance
Event occurs.
You can configure the ALARM_LOG table to:
Export records to an export file,
Purge records from a logging table and/or
Incorporate command line actions.
26-78 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. Configure one or more maintenance actions:
1. Select the Maintenance Actions tab in the ALARM_LOG Table Properties
dialog box.
2. Configure the maintenance actions the same way you configure maintenance
actions for a CIMPLICITY data table. See page 26-44 for the procedure.
Step 3. Task 6ALARM_LOG Table
Configure the Connection
Connection defines the database connection and the Store and Forward properties for the
table.
You can:
Use the default connection that is specified on the Default Alarm Logging tab of
the Logging Properties dialog box or
Specify connections that are specific to the Alarm Logging table. .
Step 6. Configure ALARM_LOG table connection:
Option 1Use the default connection
1. Select the Connection tab.
2. Check Use default alarm logging.
GFK-1180J Configuring the Database Logger 26-79
Result: The Connection tab is dimmed and unavailable for configuration.
ALARM_LOG uses the properties specified on the Default Alarm Logging tab in
the Logging Properties dialog box.
Option 2Specify logging properties that are specific for the ALARM_LOG table.
1. Select the Connection tab.
2. Uncheck Use default alarm connection.
The fields on the Connection tab become available.
2. Enter specifications the same way you do for a CIMPLICITY data log table. See
page 26-46 for the procedure.
26-80 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3. Task 7ALARM_LOG Table
Advanced Configuration
The Advanced tab in the ALARM_LOG Table Properties dialog box enables you to:
Disable all logging actions for the table that you are configuring
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
To do advanced configuration for the ALARM_LOG table:
1. Select the Advanced tab in the ALARM_LOG Table Properties dialog box.
2. Do advanced configuration the same way you do for a data log.table. See page
26-49 for the procedure.
GFK-1180J Configuring the Database Logger 26-81
Step 4. Configure Logging Conditions for a Single Alarm
You can change the logging conditions for a single alarm from the default conditions
specified for the Alarm Logging table. .)
To configure the logging conditions for a single alarm:
1. Select the alarm you want to log under different conditions from the default.
2. Do one of the following.
Method 1
Double-click the selected Alarm ID.
Method 2
Click the Item Properties button on the ALARM_LOG toolbar.
Method 2
A. Click Edit on the ALARM_LOG menu bar.
B. Select Alarm Properties
Method 3
A. Click the right mouse button.
B. Select Properties from the popup menu.
The Alarm Properties dialog box opens when you use any method displaying
either the default logging conditions or conditions that were previously checked
for the selected alarm.
3. Check the logging conditions that apply to the selected alarm.
26-82 CIMPLICITY User's ManualDecember 2000 GFK-1180J
See page 26-75 for logging condition definitions.
4. Click OK.
Result: The selected alarm will be logged in the ALARM_LOG when its logging
conditions occur.
GFK-1180J Configuring the Database Logger 26-83
Event Alarm Logging
Event Alarm Logging enables you to log alarms for events that do not need to be
acknowledged or reset. These events are normally system-based events, such as logging
in and logging out. They do not appear in the Alarm Viewer. As a result, Event Logging
is a convenient way for you to track a system issue that you are concerned about, but for
which you do not want to have alarms appear in the Alarm Viewer where
acknowledgement and resetting issues arise. :
The Database Logger enables you to:
Log data about the specially selected alarms to an ALARM_LOG table.
Save the log files, until specified criteria occur.
Have the logged data discarded, based on specified criteria.
Save the logged data to another file for future analysis.
You can display, print and analyze that information in a report that you create or in an
Excel CIMPLICITY Alarm Report that is included in CIMPLICITY. See page 26-116 for
details about CIMPLICITY Alarm Reports.
Steps to configure event alarm logging include:
Step 1. Review system alarms included in the EVENT_LOG table.
Step 2. Add additional alarms to the EVENT_LOG table.
Step 3. Configure event logging properties.
Step 4. Configure logging conditions for a single event alarm.
26-84 CIMPLICITY User's ManualDecember 2000 GFK-1180J
1Click the Database Logger icon to
open the Database Logger
Configuration window.
Logging Event Alarms Overview
4Open SQLALARM.XLS or SQLALARM97.XLS in Excel. (In the
CIMPLICITY\HMI\ REPORT\ directory). Generate an Alarm Report.
3Configure:
Table properties.
Logging conditions
for an event alarm.
2Double-click
EVENT_LOG to
display the table.
Note: You cannot copy or create a second EVENT_LOG.
Step 1. Review System Alarms in the EVENT_LOG
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.
GFK-1180J Configuring the Database Logger 26-85
$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 project.
$LOGON Specified user has logged in to a specified
CIMPLICITY project.
$LOGOUT Specified user has logged out of a specified
CIMPLICITY project.
$RTR_LINK_DOWN Router link has been lost to specified node.
DEMO_SPEED Carwash Demo speed alarm is generated.
Indexes, Columns, Rows in the EVENT_LOG Table
Indexes in the EVENT_LOG include a:
Primary key index on the joined timestamp and sequence number columns and
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.
Columns in Event logging tables include:
Columns that are specific to that table.
An additional column for each table attribute you have selected.
Rows in all Event logging tables include:
A timestamp column and
An auto increment sequence number that ensures that each row is unique.
26-86 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2. Add Point Alarms and Alarms to the EVENT_LOG
You can add the following to the EVENT_LOG:
Option 1. Point alarms via the Point Properties dialog box.
Option 2. Alarms through the Database Logger.
Option 1.
Add Point Alarms to the EVENT_LOG via a Point Properties
Dialog Box
Option 1. Add a points alarms to the EVENT_LOG:
1. Select Points in the left pane of the Workbench. .
2. Select the point for which you want to log alarms in the right pane.
3. Open the points Properties dialog box.
4. Select the General tab.
5. Check Log Alarm.
On the General Tab in the Point Properties Dialog Box
Check to log
the selected
point to the
EVENT_LOG
Opens the Alarm Logging
dialog box.
6. Click Settings.
The Alarm Logging dialog box opens.
7. Check EVENT_LOG to log the point to the Event Log.
8. Check, in the Log alarm on box, when the point should be logged.
You can choose one or more of the options that will cause the point value to be
logged. Options include (for the point's alarm):
Generation
Acknowledge
Reset
GFK-1180J Configuring the Database Logger 26-87
Delete
9. Click OK.
Result: The points alarms will be logged to the Event Log based on the specified
alarm status.
Tip: Click Table attributes to open the Event Logs Table Properties dialog box.
Configuration in this dialog box affects the entire Event Log.
Option 2.
Add Event Alarms through the Database Logger
You can add alarms to the EVENT_LOG through the Database Logger Configuration
window and in the EVENT_LOG. .
Option 2. Add alarms to the EVENT_LOG:
1. Do one of the following in the Database Logger Configuration window or the
EVENT_LOG window.
In the Database Logger Configuration window
A. Select EVENT_LOG
B. Do one of the following:
Method 1
Click the Add Item button on the Database Logger Configuration
window toolbar.
Method 2
i. Click Edit on the Database Logger Configuration window menu bar.
ii. Select Add Alarms
Method 3
i. Right-click EVENT_LOG.
ii. Select Add Alarms from the popup menu.
In the EVENT_LOG window
Do one of the following.
Method 1
Click the Add Item button on the EVENT_LOG toolbar.
Method 2
A. Click File on the EVENT_LOG menu bar.
B. Select Add Alarms
Method 3
A. Right-click in the EVENT_LOG window.
B. Select Add Alarms from the popup menu.
The Select an Alarm Definition browser opens when you use any method.
26-88 CIMPLICITY User's ManualDecember 2000 GFK-1180J
1 Select the alarms
to add to the
ALARM_LOG.
2 Click OK.
Alarm Browser Example
2. Select the Alarm IDs you want to add.
3. Click OK.
Result: The alarms display in the EVENT_LOG window and will be logged
according to your specifications.
GFK-1180J Configuring the Database Logger 26-89
Step 3. Configure Event Alarm Logging Properties
You configure the event logging properties for all alarms in the EVENT_LOG Table
Properties dialog box. (You can adjust the logging conditions for a single alarm in the
Alarm Properties dialog box.). .)..
The tasks to configure the event logging properties include:
Task 1. Open the EVENT_LOG window.
Task 2. Configure logging attributes.
Task 3. Configure maintenance events.
Task 4. Configure maintenance actions.
Task 5. Configure the EVENT_LOG connection.
Task 6. Configure advanced properties for the EVENT_LOG table.
Step 3. Task 1EVENT_LOG
Open the Table Properties Dialog Box
You can use the same methods to open the EVENT_LOG Table Properties dialog box in
the open EVENT_LOG table or the Database Logger Configuration window. .
Step 1. Open the EVENT_LOG Table Properties dialog box:
1. Either:
Select EVENT_LOG in the Database Logger Configuration window, or
Open the EVENT_LOG window. See page 26-13 for procedures to open an
existing table.
2. Do one of the following.
Method 1
Click the Table Properti es button on either windows toolbar.
Method 2
A. Click Edit on either windows menu bar.
B. Select Table Properties
Method 3
A. Right-click EVENT_LOG in the Database Logger Configuration window or
any alarm in the EVENT_LOG window.
B. Select Table Properties from the popup menu.
Result. The EVENT_LOG Table Properties dialog box opens when you use any
method.
26-90 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3 Task 2EVENT_LOG Table
Configure Logging Attributes
Logging Attributes for a CIMPLICITY EVENT_LOG table enables you to log the name
of the CIMPLICITY project.
Step 2. Configure the EVENT_LOG table logging attributes:
1. Select the Logging Attributes tab in the EVENT_LOG Table Properties dialog
box.
2. Check Project name to log the project name.
Tip: Click Use Defaults to set the logging attributes to their default value. The
EVENT_LOG will be set to not log the Project Name.
Warning: If you select or de-select 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.
Step 3. Task 3EVENT_LOG
Configure Maintenance Events
Maintenance Events define when export, purge, and command actions will be performed
on the table. .
You can specify that maintenance be triggered when:
A condition, such as low disk space, occurs or
On a periodic or gated interval
GFK-1180J Configuring the Database Logger 26-91
Step 3. Specify maintenance events:
1. Select the Maintenance Events tab in the EVENT_LOG Table Properties dialog
box.
2. Specify events the same way you specify them for an DATA_LOG. See page
26-42 for the procedure.
26-92 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 3 Task 4EVENT_LOG
Configure EVENT_LOG Maintenance Actions
Maintenance Actions define the type of actions that take place when a Maintenance
Event occurs.
You can configure the EVENT_LOG table to:
Export records to an export file,
Purge records from a logging table and/or
Incorporate command line actions.
Step 4. Configure one or more maintenance actions:
1. Select the Maintenance Actions tab in the EVENT_LOG Table Properties dialog
box.
2. Configure the maintenance actions the same way you configure maintenance
actions for a data log table. See page 26-44 for the procedure.
Step 3. Task 5EVENT_LOG
Configure the Connection
Connection defines the database connection and the Store and Forward properties for the
table. .
You can:
Use the default connection that is specified on the Default Point Logging tab of
the Logging Properties dialog box or
Specify logging properties that are specific to the Data or Group Logging table.
Step 5. Configure the EVENT_LOG connection:
Option 1Use the default connection
1. Select the Logging Properties tab.
2. Check Use default alarm connection.
GFK-1180J Configuring the Database Logger 26-93
Result: The Connection tab is dimmed and unavailable for configuration. The
event log uses the properties specified on the Default Alarm Connection tab in the
Logging Properties dialog box.
Option 2Specifya connection that is specific for the EVENT_LOG.
1. Select the Connection tab.
2. Enter specifications the same way you do for a data log table. See page 26-46
for the procedure.
Step 3. Task 6EVENT_LOG Table
Advanced Configuration
The Advanced tab in the EVENT_LOG Table Properties dialog box enables you to:
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
26-94 CIMPLICITY User's ManualDecember 2000 GFK-1180J
To do advanced configuration for an EVENT_LOG table:
1. Select the Advanced tab in the EVENT_LOG Table Properties dialog box.
2. Do advanced configuration the same way you do for a data log.table. See page
26-49 for the procedure.
Step 4. Configure Logging Conditions for a Single Event Alarm
You can change the logging conditions for a single alarm from the default conditions
specified for the Event Logging table. .)
To configure the logging conditions for a single alarm in the EVENT_LOG:
1. Select the alarm you want to log under different conditions from the default.
2. Do one of the following.
Method 1
Double-click the selected Alarm ID.
Method 2
Click the Item Properties button on the EVENT_LOG toolbar.
Method 2
A. Click Edit on the EVENT_LOG menu bar.
B. Select Alarm Properties
Method 3
A. Click the right mouse button.
B. Select Properties from the popup menu.
The Alarm Properties dialog box opens when you use any method displaying
either the default logging conditions or conditions that were previously checked
for the selected alarm.
GFK-1180J Configuring the Database Logger 26-95
3. Check the logging conditions that apply to the selected alarm.
See page 26-75 for logging condition definitions.
4. Click OK.
Result: The selected alarm will be logged in the EVENT_LOG when its logging
conditions occur.
26-96 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Event Management Logging
The CIMPLICITY Database Logger enables you to keep a record of event management
event actions using the EM_LOG table. When the event triggers actions that have been
selected to be logged, the Event Manager sends a message to the logger to log..
The steps to configure the event actions logging properties include
Step 1. Add event actions to the EM_LOG.
Step 2. Configure EM_LOG properties.
Step 1. Add Event Actions to the EM_LOG
You add event actions to the EM_LOG through the Event Editor window.
To add events to the EM_LOG:
1. Expand the Basic Control Engine folder in the left pane of the Workbench.
2. Double-click Event Editor .
The Event Editor window opens.
3. Select the Event ID in the left pane to which you want to attach the action.
4. Left-click the Action ID column.
5. Open the New Event-Action dialog box using any of the following methods.
Method 1
Click the New Event_Action button on the CIMPLICITY Event
Editor toolbar.
Method 2
A. Click File on the CIMPLICITY Event Editor menu bar.
B. Select New Event_Action.
GFK-1180J Configuring the Database Logger 26-97
Method 3
A. Click the right mouse button in the right pane.
B. Select New Event_Action from the popup menu.
Method 4
Press Ctrl+N on the keyboard.
The New Event-Action dialog box opens when you use any of these methods.
6. Enter a name for the Action ID.
7. Check Log Flag.
8. Click OK.
Result: When the selected event triggers the action, the Event Manager sends the
data to the Database Logger.
Step 2. Configure EM_LOG Properties
You configure the event action logging properties in the EM_LOG Properties dialog box.
.).
The tasks to configure the Event Management action logging properties include:
Task 1. Open the EM_LOG Properties dialog box.
Task 2. Configure logging attributes.
Task 3. Configure maintenance events.
Task 4. Configure maintenance actions
Task 5. Configure the EM_LOG connection.
Task 6. Configure advanced properties for the EM_LOG.
Step 2. Task 1EM_LOG
Open the EM_LOG Properties Dialog Box
You open the EM_LOG Properties dialog box in the Database Logger Configuration
window.
Task 1. Open the EM_LOG Properties dialog box:
1. Select EM_LOG in the Database Logger Configuration window.
26-98 CIMPLICITY User's ManualDecember 2000 GFK-1180J
2. Do one of the following.
Method 1
Click the Table Properti es button on the Database Logger
Configuration window toolbar.
Method 2
A. Click the right mouse button.
B. Select Properties from the popup menu.
Method 3
A. Click Edit on the Database Logger Configuration window menu bar.
B. Select Table Properties
Result: The EM_LOG Table Properties dialog box opens when you use any
method.
Step 2. Task 2EM_LOG
Configure Logging Attributes
Logging Attributes for an EM_LOG enables you to log the name of the CIMPLICITY
project.
Step 2. Configure EM_LOG logging attributes:
1. Select the Logging Attributes tab in the Table Properties dialog box.
2. Check Project name to log the project name.
Tip: Click Use Defaults to set the logging attributes to their default value. The
EM_LOG will be set to not log the Project Name.
Warning: If you select or de-select 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-1180J Configuring the Database Logger 26-99
Step 2. Task 3EM_LOG
Configure Maintenance Events
Maintenance Events define when export, purge, and command actions will be performed
on the table.
You can specify that maintenance be triggered when:
A condition, such as low disk space, occurs or
On a periodic or gated interval
Task 3. Specify maintenance events:
1. Select the Maintenance Events tab in the EM_LOG Table Properties dialog box.
2. Specify events the same way you specify them for a data log table. See page 26-
42 for the procedure.
Step 2 Task 4EM_LOG
Configure Maintenance Actions
Maintenance Actions define the type of actions that take place when a Maintenance
Event occurs.
You can configure the EM_LOG table to:
Export records to an export file,
Purge records from a logging table and/or
Incorporate command line actions.
You do this configuration on the Maintenance Actions tab.
26-100 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 5. Configure one or more maintenance actions:
1. Select the Maintenance Actions tab in the EM_LOG Table Properties dialog
box.
2. Configure the maintenance actions the same way you configure maintenance
actions for the data log table. See page 26-44 for the procedure.
Step 2 Task 5EM_LOG
Configure a connection
Logging Properties define the database connection and the Store and Forward properties
for the table.
You can:
Use the default connection that is specified on the Default Point Logging tab of
the Logging Properties dialog box. The default is CIMPLICITY Alarm Logging.
Specify connections that are specific to the Data or Group Logging table.
Task 5. Configure EM_LOG logging properties:
Option 1Use the default connection
1. Select the Connection tab.
2. Check Use default point logging.
GFK-1180J Configuring the Database Logger 26-101
Result: The Connection tab is dimmed and unavailable for configuration. The
EM_LOG uses the properties specified on the Default Alarm Logging tab in the
Logging Properties dialog box.
Option 2Specify logging properties that are specific for the EM_LOG.
1. Select the Connection tab.
2. Enter specifications the same way you do for the data log table. See page 26-46
for the procedure.
Step 3. Task 6EM_LOG Table
Advanced Configuration
The Advanced tab in the EM_LOG Table Properties dialog box enables you to:
Disable logging actions for the table that you are configuring.
Override the queue size that is specified in the Database Logger's Logging
Properties dialog box.
Select and control bulk insertion for Microsoft SQL Server or MSDE.
26-102 CIMPLICITY User's ManualDecember 2000 GFK-1180J
To do advanced configuration for an EVENT_LOG table:
1. Select the Advanced tab in the EM_LOG Table Properties dialog box.
2. Do advanced configuration the same way you do for a data log.table. See page
26-49 for the procedure.
GFK-1180J Configuring the Database Logger 26-103
Application Logging
Application Logging enables you to log actions of certain CIMPLICITY applications,
such as the Basic Control Engine. 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.
Tip: You can configure the following properties for an Application logging table.
Logging attributes.
Maintenance actions.
Maintenance events.
Logging properties.
Follow the same steps that you follow for the EM_LOG. See page 26-96 for details.
Indexes, Columns, Rows in Application Logging Tables
Indexes in Application logging tables include a: :
Primary key index on the joined timestamp and sequence number columns and
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.
Columns in Application logging tables include::
Columns that are specific to that table.
An additional column for each table attribute you have selected.
Rows in all Application logging tables include:
A timestamp column and
An auto increment sequence number that ensures that each row is unique.
26-104 CIMPLICITY User's ManualDecember 2000 GFK-1180J
CIMPLICITY Log Reports
Because the CIMPLICITY 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.
CIMPLICITY Database Logger provides three sample reports. These reports are written
in both Microsoft Excel version 5.0 and Microsoft Excel for Office 97 format.
The files are stored in the Report subdirectory of your CIMPLICITY distribution
directory.
The report files are:
Excel 5 Version A Report for Use with CIMPLICITY
SQLALARM.XLS Alarm tables.
SQLDATA.XLS Data tables.
SQLGROUP.XLS Group tables.
Excel for Office 97 Version A Report for Use with CIMPLICITY
SQLALARM97.XLS Alarm tables.
SQLDATA97.XLS Data tables.
SQLGROUP97.XLS Group tables.
These samples are fully functional as shipped.
You can:
Use the reports with either Access or SQL Server to report on any tables you
have configured.
Copy and modify the reports to meet your specific needs.
Save generated reports in Excel for later use, print them, or perform further
analysis on your data.
UsIng Excel Reports
The procedure to use the Excel reports is straightforward. It includes:
1. Install MS Query.
2. Open reports for:
Individual point logged data.
Group logged data trends.
Alarms or event alarms.
3. Specify the table and basic parameters to be included in the report.
4. Generate the report.
GFK-1180J Configuring the Database Logger 26-105
Installing MS Query to Use with Database Logging
Both the Microsoft Excel Version 5 CD and Microsoft Office 97 CD include an option
called MS Query. This option is required in order to use Microsoft Excel with
CIMPLICITY Database Logging.
You can install MS Query either when you install Microsoft Excel or, if Excel is already
installed as an added feature.
Step 1. Install MS Query.
Step 2. Place MS Query files in the correct location for the Database Logger.
Step 3a. Install the Sample Reports using Microsoft Excel 5.0 or
Step 3b. Specify the MS Query file location in Excel for Office 97.
Step 1. Install MS Query
From a Microsoft Office 97 CD
1. Either:
A. Install Excel or
B. Select Add/Remove Programs.
2. Select Data Access.
3. Click Change Option.
4. 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 software.
5. Continue with your installation.
From a Microsoft Excel Version 5 CD:
1. Either:
A. Install Excel or
B. Select Add/Remove Programs (options).
2. Select Converters, Filters and Data Access in the list of options.
3. Click Change Option.
4. Select Data Access.
5. Click Change Option.
6. 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 software.
7. Continue with your installation.
26-106 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2. Place MS Query files in the Correct Location for
Database Logger.
1. Locate xlodbc.xla and xlodbc32.dll.
They are most likely in the \Excel\Library\MSQuery directory.
2. Create the path
C:\Program Files\Microsoft Office\Office\Library\MSQuery.
3. Copy xlodbc.xla and xlodbc32.dll from their current directory to the new
path.
Step 3a. Install the Sample Reports using Microsoft Excel 5.0
To select the MS Query Add-In:
1. Open Microsoft Excel.
2. Click File on the Microsoft Excel menu bar.
3. Select Open.
The Open browser opens.
4. Find the Report folder in the CIMPLICITY \HMI directory.
5. Open a report that is compatible with your version of Microsoft Excel.
A message box appears asking you if you want to enable the macros.
6. Click Enabl e Macros.
The selected report opens.
GFK-1180J Configuring the Database Logger 26-107
7. Click Tools on the Microsoft Excel menu bar.
8. Select Add-Ins
The Add-Ins dialog box opens.
9. Check MS Query Add-in.
10. Click Browse to select the XLODBC.XLA add-in path:
C:\Program Files\Microsoft Office\Office\Library\MSQuery.
11. Replace any existing XLODBC.XLA add-in, if you are prompted to do so.
12. Save your updated report.
13. Repeat these steps for all three report files. You will need to do this only once
for each report.
14. Click OK.
Step 3b. Specify the MS Query file location in Excel for Office
97
Note: Follow this step if you receive an error message that Excel cannot find the
XLODBC.XLA file.
To specify the MS Query file location in the Visual Basic Editor:
1. Click Tools on the Excel menu bar.
2. Select Macro.
3. Select Visual Basic Editor from the extended menu.
The Visual Basic Editor opens.
4. Click Tools on the Visual Basic Editor menu bar.
5. Select Reference.
The References - VBAProject dialog box opens.
26-108 CIMPLICITY User's ManualDecember 2000 GFK-1180J
6. Look for an entry Missing XLODBC.XLA.
7. Select Missing XLODBC.XLA.
8. Click Browse
9. Point XLODBC.XLA to the correct location.
C:\Program Files\Microsoft Office\Office\Library\MSQuery.
GFK-1180J Configuring the Database Logger 26-109
Reporting Individual Point Logged Data
You can use the CIMPLICITY Data Report to report point data that has been logged to
the DATA_LOG.
Because the CIMPLICITY Data Report provides data on 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.
Once you have installed the Data Report you can view data in the following steps.
Step 1. Open either the SQLDATA.XLS or SQLDATA97.XLS Excel file.
Step 2. Set the CIMPLICITY Data Report parameters.
Step 3. Generate a CIMPLICITY Data report.
Step 4. View point data.
Step 1. Open the SQLDATA.XLS or SQLDATA97.XLS Excel file
1. Open Microsoft Excel.
2. Click File on the Microsoft Excel menu bar.
3. Select Open.
The Open browser opens.
4. Find the Reports folder in the CIMPLICITY \HMI directory.
5. Open SQLDATA.XLS or SQLDATA97.XLS.
Result: The Control worksheet in the CIMPLICITY Data Report workbook
displays.
26-110 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2. Set the CIMPLICITY Data Report Parameters
1. Click Set Parameters .
The Set Report Parameters dialog box opens.
2. Enter the name of a CIMPLICITY DATA_LOG table or DATA_LOG in the
ODBC Table field.
3. (Optional) Enter a Point ID if you want to display data for a single point. If no
Point ID is entered, data for all points in the log displays.
4. (Optional) Enter a Start Time to display data logged from that time forward. If
no time is specified, the earliest data will be included.
5. (Optional) Enter an End Time to display data logged up to the specified time. If
no time is specified, the latest data will be included.
6. Select the ODBC Data Source to be used in generating the report. Your
selection must 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, click Browse
to find one.
7. Click either:
A. OK to save the parameters or
B. Cancel to cancel your entries.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
Step 3. Generate a CIMPLICITY Data Report
Click Generate Report.
Result: While the report is being generated, progress messages will be displayed on the
status display of the report. The completed report displays on the Data worksheet.
GFK-1180J Configuring the Database Logger 26-111
Step 4. View Point Data
Select the Data worksheet in the CIMPLICITY Data Report workbook.
The data report contains a column for each attribute in the logging table. The columns
may be named as follows:
Column Displays the:
timestamp Time that the point was logged.
point_id Point identifier of the point being logged
PROJ ECT Name of the CIMPLICITY project logging the point data.
_ALRM Alarm state of the point being logged.
_ENG Engineering units label of the point being logged.
_PREV Previous logged value of the point being logged.
VAL Current value of the point being logged.
TIME Timestamp of the previous time the point was logged.
RAW Raw value of the point being logged.
RES Resource of the point being logged.
Tip: If you save your spreadsheet after generating a report, the data will be available the
next time you view the report.
26-112 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Reporting Group Logged Data in a Trend Report
The Trend report provides for group tables:
The same functionality that the Data Report provides for single point values and
A static trend representation of the point values in the report..
Once you have installed the Trend Report you can view data in the following steps.
Step 1. Open either the SQLGROUP.XLS or SQLGROUP97.XLS file.
Step 2. Set the CIMPLICITY Trend Report parameters.
Step 3. Generate a CIMPLICITY Trend Report.
Step 4. View the data in a CIMPLICITY Trend Report.
Step 5. View charted trends in a CIMPLICITY Trend Report.
Step 1. Open the SQLGROUP.XLS or SQLGROUP97.XLS File
1. Open Microsoft Excel.
2. Click File on the Microsoft Excel menu bar.
3. Select Open.
The Open browser opens.
4. Find the Reports folder in the CIMPLICITY \HMI directory.
5. Open SQLALARM.XLS or SQLALARM97.XLS.
Result: The Control worksheet in the CIMPLICITY Alarm Report workbook
displays.
GFK-1180J Configuring the Database Logger 26-113
Step 2. Set the CIMPLICITY Trend Report Parameters
1. Click Set Parameters .
The Set Report Parameters dialog box opens.
2. Enter a GROUP_LOG table in the ODBC Table field.
4. (Optional) Enter a Start Time to display data logged from that time forward. If
no time is specified, the earliest data will be included.
5. (Optional) Enter an End Time to display data logged up to the specified time. If
no time is specified, the latest data will be included.
6. Select the ODBC Data Source to be used in generating the report. Your
selection must 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, click Browse
to find one.
7. Click either:
A. OK to save the parameters or
B. Cancel to cancel your entries.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
Step 3. Generate a CIMPLICITY Trend Report
Click Generate Report..
Result: While the report is being generated, progress messages will be displayed on the
status display of the report. The completed report displays on the Data worksheet.
26-114 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. View the Report Data for GROUP_LOG Data
Select the Data worksheet in the CIMPLICITY Alarm Report workbook..
The 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.
Appended to the prefix of each column is a:
Variable extension based on the attribute
Number indicating the array index (0 for non-array points).
The data is as follows:
Data Displays the:
timestamp The time that the point was logged..
<point_id> Values of Point ID in group.
GFK-1180J Configuring the Database Logger 26-115
Step 5. View Charted Trends in a CIMPLICITY Trend Report
1. Select the Chart tab.
A worksheet that is configured with Excel charting capability displays.
2. Use Microsoft Excel's charting tools to customize the chart's display.
Result: The chart displays the selected report data and format.
26-116 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Reporting Alarm or Event Alarms Logged Data
You can use the CIMPLICITY Alarm Report to report data that has been logged to
ALARM_LOG and
EVENT_LOG tables.
Once you have installed the Alarm Report you can view data in the following steps..
Step 1. Open either the SQLALARM.XLS or SQLALARM97.XLS Excel file.
Step 2. Set the report parameters.
Step 3. Generate a report.
Step 4. View the data.
Step 1. Open the SQLALARM.XLS or SQLALARM97.XLS Excel
file
1. Open Microsoft Excel..
2. Click File on the Microsoft Excel menu bar.
3. Select Open.
The Open browser opens.
4. Find the Report folder in the CIMPLICITY \HMI directory.
5. Open SQLALARM.XLS or SQLALARM97.XLS.
Result: The Control worksheet in the CIMPLICITY Alarm Report workbook
displays.
GFK-1180J Configuring the Database Logger 26-117
Step 2. Set the CIMPLICITY Alarm Report Parameters
1. Click Set Parameters.
The Set Report Parameters dialog box opens.
2. Select either the ALARM_LOG or EVENT_LOG table in the ODBC Table field.
3. (Optional) Enter an Alarm Class if you want to display alarms only for that
class.
4. (Optional) Enter a Start Time to display data logged from that time forward. If
no time is specified, the earliest data will be included.
5. (Optional) Enter an End Time to display data logged up to the specified time. If
no time is specified, the latest data will be included.
6. Select the ODBC Data Source to be used in generating the report. Your
selection must 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, click Browse
to find one.
7. Click either:
A. OK to save the parameters or
B. Cancel to cancel your entries.
Tip: Save your spreadsheet after setting the report parameters if you want the parameters
to be set the next time you run the report.
Step 3: Generate a Report for ALARM_LOG or EVENT_LOG
Data
Click Generate Report..
Result: Progress messages display on the status display of the report while the report is
being generated. The completed report displays on the Data worksheet.
26-118 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 4. View the Report Data for ALARM_LOG or EVENT_LOG
Select the Data worksheet in the CIMPLICITY Alarm Report workbook..
Alarm Data Log Example: Excel Spreadsheet Report
The report contains the following columns:
Column Definition
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 Setting Alarm
Report 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.
Tip: If you save the CIMPLICITY Alarm Report after you generate it, the same data will
be display the next time you open the report and select the Data worksheet.
GFK-1180J Configuring the Database Logger 26-119
Automatic Report Printing Configuration
Important: You can only use the automatic report printing capability with Microsoft
Access and SQL Server databases.
You can use OLE automation from CIMPLICITY scripts to trigger the running and
printing of reports from Microsoft Excel spreadsheets that you have configured to
produce reports
The CIMPLICITY script may be:
Triggered by Database Logger Maintenance Events, or
Triggered by any event in the Event Manager, or
Attached to an object a user can trigger on a CimView screen.
The steps to implement automatic report printing include:
Step 1. Configure the CIMPLICITY Service to access a printer.
Step 2. Create a script to generate the report and print it.
Step 3. Create an event to trigger the script.
Step 1. Configure the CIMPLICITY Service to Access a Printer
The CIMPLICITY service needs access to a user-defined printer to print reports.
To grant access to a user-defined printer:
1. Open the Windows Control Panel.
2. Click the Services icon .
The Services dialog box opens.
3. Double-click the CIMPLICITY Service.
4. Choose one of the following options to continue:
For systems with single users:
A. Click This Account in the Service dialog box, under Log On As.
B. Select a CIMPLICITY user account.
26-120 CIMPLICITY User's ManualDecember 2000 GFK-1180J
C. Enter the correct password and confirm it, if the account requires a
password.
Service Dialog Box: One user example
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.
For systems with multiple users:
A. Click System Account in the Service dialog box, under Log On As.
B. Check the Allow Service to Interact with Desktop check box.
Service Dialog Box: One user example
5. Click OK to accept your changes and close the Service dialog box.
6. Click OK to close the Services dialog box.
7. Close the Control Panel.
Result: Service access is configured according to your specifications.
GFK-1180J Configuring the Database Logger 26-121
Step 2. Create a Script
You will need to create a script to open the Microsoft Excel spreadsheet for your report,
generate the report and print it.
To create a script:
1. Expand the Basic Control Engine folder in the left pane of the CIMPLICITY
Workbench.
2. Double-click Scripts.
The CIMPLICITY Program Editor opens.
3. Create the script to run the report and print it.
You can use the sample script below as a template.
4. Compile the script and create an executable.
Note: 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:
26-122 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Sub Main ()
'---------------------------------------------------------------------------------
-------
' This section sets REPORT_TRIGGER back to 0 so that the script doesn't continue
to run.
' This is not needed if the report is triggered directly from a CimView screen or
by a
' TIMED event in the Database Logger or Event Manager.
'
Dim PT As New point
PT.id = "\\PROJECT\REPORT_TRIGGER"
PT.value = 0
PT.set
'---------------------------------------------------------------------------------
-------
' The code from this point on is for printing.
' This example uses one of the existing Excel spreadsheets for extracting and
printing
' the data from the cimplog.mdb alarm database.
' You will need to customize this code so that it prints what you need. It is
also
' possible in some applications to run a specific macro from the command line.
' You can then use the SHELL command.
'
Dim Excel As Object
Set Excel = CreateObject ("Excel.Application")
'
' Open the workbook for alarm reporting
Excel.application.workbooks.open "C:\CIMPICITY\REPORT\SQLALARM.XLS"
Excel.application.workbooks("SQLALARM.XLS").activate
'
' Run the macro to get the data
Excel.application.Run "SQLALARM.XLS!GenerateReport"
'
' Print the data
Excel.application.workbooks("SQLALARM.XLS").worksheets("Data").activate
Excel.application.workbooks("SQLALARM.XLS").activesheet.printout
'
' Quit without saving the data
Excel.application.workbooks("SQLALARM.XLS").saved = TRUE
Excel.application.quit
End Sub
GFK-1180J Configuring the Database Logger 26-123
Step 3. Create an Event to Trigger an Automatic Report
There are many ways to trigger a script to run and print a report from Database Logger
tables.
Following are two options.
Option 1. Use the Database Logger Maintenance Actions
Option 2. Use the Event Manger
Option 1. Use the Database Logger Maintenance Actions
To trigger a report automaticall y from a maintenance action:
1. Open the Database Logger in the project's Workbench.
2. Open the Table Properties dialog box for the table whose report will be printed.
3. Select the Maintenance Events tab for the table.
4. Specify the event(s) you want to trigger the script.
5. Select the Maintenance Actions tab for the table.
6. Check Run program.
7. Enter the fill path and name of the executable you created from the script.
8. Click OK.
The Database Logger saves your changes and closes the Table Properties dialog box.
Result: The report automatically generates and prints whenever any of the
maintenance events you specified occur.
Option 2. Use the Event Manager
Two suggestions for using the Event Manager include:
1. Trigger a report automatically from an event.
2. Let users trigger a report from a CimView screen
To trigger a report automaticall y from an event:
1. Open the Event Editor in the project's Workbench..
2. Create any event you wish to trigger the report.
3. Create an action for this event to run the script.
Result: The report automatically generates and prints whenever the event occurs.
To let users trigger a report from a CimVi ew screen:
1. Open a screen in CimEdit.
2. Select or create the object you want to trigger the report.
3. Display the object's property sheets.
4. On the Script tab, click Edit.
5. 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.
6. Close the Edit Script window.
26-124 CIMPLICITY User's ManualDecember 2000 GFK-1180J
7. Display the Events tab.
8. Create a new event and assign it a new procedure.
9. In the Procedure Information dialog box, create an Invoke Script action and
specify the script you created.
10. Click OK to save the new procedure information.
11. Click OK to save the object's properties.
Result: When a user executes the event you configured, the report automatically
generates and prints.
GFK-1180J 27-1
Managing Database Logging
About Database Logging Management
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.
27-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
ODBC Configuration
When you install CIMPLICITY if you:
Install the (MSDE) database server option, a Microsoft SQL 7 compatible
database server, the ODBC driver will be SQL Server data sources.
Do not install the server, CIMPLICITY 5.0 redistributes ODBC using Microsoft
data access components version 2.
You do not need to purchase or configure additional software to use these drivers.
Tip: Install the database server because, as a SQL server, it provides better scalability
when you want to go to a more robust SQL server to support Enterprise type solutions.
For improved performance and network extensibility, you may wish to log to a third-
party database product such as Microsoft SQL Server or Oracle.
Using ODBC Drivers and Data Sources for Database Logging
Overview
An overview of ODBC configuration options for database logging includes:
ODBC drivers.
CIMPLICITY default ODBC data sources.
Custom ODBC data sources.
ODBC configuration and moving projects.
ODBC Drivers for Database Logging
ODBC Applications use an ODBC driver to communicate with database applications.
The drivers supported for use with the CIMPLICITY HMI Database Logger are:
Driver Description
Microsoft Access An entry-level database which requires no additional
software to use.
Microsoft Access is currently supported only for Intel-
based computers using Windows NT.
Microsoft SQL Server
or
CIMSQL
or
Default Database Server
(MSDE)
A high-performance database for larger applications.
You must purchase SQL Server to use this driver.
Microsoft ODBC for Oracle
or
Merant 360 32 Bit Oracle 8
A high-performance database for large applications.
You must purchase Oracle and Merant DataDirect
ODBC Driver for Oracle to use this driver.
Oracle is currently supported for Intel-based computers
running Windows NT.
GFK-1180J Managing Database Logging 27-3
CIMPLICITY Default 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:
Data Source Description
CIMPLICITY Logging - Alarms If you:
Installed the database server when you
installed HMI, this data source will use the
Microsoft SQL Server driver and log onto
the local SQL server.
Did not install the database server, the data
source uses the Microsoft Access driver to
log to CIMPLOG.MDB in your distribution
ARC directory.
CIMPLICITY Logging - Points If you:
Installed the database server when you
installed HMI, this data source will use the
Microsoft SQL Server driver and log onto
the local SQL server.
Did not install the database server, the data
source uses the Microsoft Access driver to
log to POINTLOG.MDB in your distribution
ARC directory.
CIMPLICITY SQL Server Logging The data source uses the Microsoft SQL Server
driver to log to an on-node (local) SQL Server.
Custom ODBC 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:
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.
Note: 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 each Viewer.
27-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
ODBC Configuration and 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 CIMPLICITY data sources, you may need to
modify your configuration depending on whether the default data sources use
SQL Server or Access.
Note: Normally there will not be any additional configuration. However, if you
install CIMPLICITY differently on one machine from a machine to which you
move the project, you may need to adjust the new machine.
Exampl e
You installed the database server on Machine A. However, you did not install
the database server on Machine B. You moved the project to machine B.
CIMPLICITY logging expects to log to Access. In fact it won't because ODBC
is pointing to the SQL database server. You will need to reconfigure Machine B
to point to the correct data source.
If the project uses custom data sources, these must be reconfigured on the target
machine.
Configuring SQL Server Data Sources
The only configuration you normally need to do for the SQL server is to specify the name
of remote computers from which data may be logged.
To configure the SQL Server data source for CIMPLICITY logs:
1. Click Start on the Windows task bar.
2. Select Settings>Control Panel.
3. Click the ODBC Sources icon .
The ODBC Data Source Administrator dialog box opens.
4. Select the System DSN tab.
5. Select either:
CIMPLICITY Logging - Alarms or
CIMPLICITY Logging - Points.
6. Click Configure.
A first Microsoft SQL Server DSN Configuration wizard displays.
GFK-1180J Managing Database Logging 27-5
7. Configure the first Microsoft SQL Server DSN Configuration wizard as follows:
A. Select the Server as follows:
For Select
The local machine (local)
A remote machine The computer name from the drop down list.
Select:
(local) for the local machine
Computer name for a remote
machine.
B. Click Next.
A second Microsoft SQL Server DSN Configuration wizard opens.
8. Configure the second Microsoft SQL Server DSN Configuration wizard as
follows:
A. Check With SQL Server authentication using a login ID and
password.
B. Check Connect to SQL Server to obtain default settings for the
additional
C. Enter sa in the Login ID field. (The field may display your user name when
the dialog box appears.)
27-6 CIMPLICITY User's ManualDecember 2000 GFK-1180J
D. Leave the Password field blank.
Enter sa. Leave blank.
E. Click Next.
9. Finish configuration leaving the defaults on the remaining dialog boxes.
Using CIMPLICITY SQL
CIMPLICITY HMI offers you an easy way to include a robust SQL Server in your
configuration. The option is CIMPLICITY SQL.
Consult the CIMPLICITY SQL manual (GFK-1752) for detailed information about
purchasing and installing CIMPLICITY SQL. You can also use these directions to install
SQL Server.
GFK-1180J Managing Database Logging 27-7
Configuring Microsoft Access Data Sources
To configure an ODBC data source for use with the Microsoft Access file
format:
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 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. Either:
Click Sel ect... to select an existing database file, or
Click Create... to create a new .MDB file.
8. Specify a file name In the Select Database or New Database dialog,, 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.
27-8 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Configuring Oracle
When you install CIMPLICITY, you will be installing Microsoft data access components
version 2.5. This version of Microsoft data access components comes complete with
Microsoft ODBC for Oracle. There is no charge.
Note: CIMPLICITY supports two Oracle drivers:
1. Microsoft ODBC for Oracle, which is supplied, and
2. Merant Data Direct Connect 3.60 for Windows 9x - NT.
Oracle Software Requirements
Oracle databases can be supported on Intel-compatible computers with Microsoft
Windows NT v4.0 or higher.
The 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 Al low Service to Interact with Desktop:
1. Open the Control Panel.
2. Double-click Services .
The Services dialog box opens.
3. Either:
Double-click CIMPLICITY HMI Service in the list of services, or
Click Startup....
The (CIMPLICITY HMI) Service dialog box opens.
3. Select System Account in the Log On As box.
4. Check Allow Service to Interact with Desktop.
5. Click OK.
The (CIMPLICITY HMI) Services dialog box closes.
6. Click Close.
The Services dialog box closes.
GFK-1180J Managing Database Logging 27-9
Oracle Used with CIMPLICITY
To prepare the Oracle database for use with CIMPLICITY HMI projects:
1. Install the Oracle client utilities (either Administrator or User). Follow the
directions in the Oracle documentation to do this.
2. Configure the CIMPLICITY Service to interact with the desktop.
3. Create a new system ODBC data source for Oracle.
4. Double-click Database Logger in the Workbench left or
right pane.
The Database Logger window opens.
5. Click Edit on the Database Logger window menu bar.
6. Select Logging Properties.
The Logging Properties dialog box opens.
7. Select the Alarm Logging.
8. Select your newly created ODBC data source as the ODBC data source.
9. Select the Point Logging tab.
10. Select your newly created ODBC data source as the ODBC data source.
Guidelines when using Oracle:
Database aliases configured on the client node must also be configured on the
server node.
In the ODBC data source for Oracle, enter the alias name in the Server name
field.
All three of the Oracle services must be started on the Oracle server node.
27-10 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Database Management for SQL Server
Database management for SQL server includes:
Configuring additional locks.
Checking if Microsoft SQL Server Service is running.
Handling default database server limitations.
Handling 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-1180J Managing Database Logging 27-11
Checking if Microsoft SQL Server Service is Running
If you install the database server, access to a Service Manager appears under the
Database Logger folder in the Workbench. Use this tool to make sure the service is
running. Microsoft SQL Server service must be running for logging to work.
To make sure the SQL Server is running:
1. Expand the Database Logger in the Workbench left pane.
2. Double-click Service Manager.
The SQL Server Service Manager dialog box appears.
3. Click the Start/Continue button, if it is enabled, to start the Microsoft SQL
Server.
Check if the SQL Server is
running.
Handling Default Database Server Limitations
The default Database Server has the following limitations:
The maximum per database is 2 Gigabytes.
Performance begins to degrade after 5 connections.
Connections can include:
1. Alarm Logging (DLRP).
2. Point Logging (PTDL).
When forwarding data (in store and forward), forward is a separate connection
to the database.
3. Alarm Logging forward connection.
4. Point Logging forward connection.
If the table is enabled for bulk insertion, bulk insertion requires a dedicated
connection to the database in order to work. As a result, maintenance actions for
bulk insert tables will need to allocate a separate connection. Once the action is
completed, it will free the connection.
27-12 CIMPLICITY User's ManualDecember 2000 GFK-1180J
5. Bulk insertion maintenance action.
6. Bulk insertion forward connection.
If there are too many tables enabled for bulk insertion there, resulting in too many
connections at once, there will be a performance degrade.
If your system configuration regularly exceeds 5 connection, it is recommended that you
upgrade to CIMPLICITY SQL, which is a more robust server.
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.
Procedure to Truncate 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 tab.
5. Select Truncate Log on Checkpoint option.
6. Click OK.
7. Close the Manage Databases dialog.
The change takes place the next time the SQL Server is restarted.
GFK-1180J Managing Database Logging 27-13
Procedure to Truncate the Log as a CIMPLICITY Maintenance
Action
To define a CIMPLICITY Maintenance Action that periodical l y 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 tab.
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.
1. Select the Maintenance Events page.
2. Configure the event that will trigger the action.
This change takes place the next time you update the project's configuration and then
restart the project.
It is recommended truncating the log as a system default.
To set truncate the log as a system default:
1. Open the SQL Enterprise Manager.
2. Select the database you are logging to.
3. Right-click on the database.
4. Select Properties from the popup menu.
5. Select the Options tab.
6. Make sure that Truncate Log On Checkpoint is checked.
27-14 CIMPLICITY User's ManualDecember 2000 GFK-1180J
About Creating Tables
When a project is started, the Database Logger creates any tables you have configured for
that project based on the attributes you have specified. This means you don't have to
know anything about databases to log data from your CIMPLICITY project.
Specifically, when a project starts, the Database Logger will:
Attempt to create or repair any missing or damaged databases.
Create any missing tables.
Create any missing columns in the tables.
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.
Key definitions.
Column Definitions
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.
Note: Points with Engineering Units conversion are stored in floating point format
GFK-1180J Managing Database Logging 27-15
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 and Oracle do not support sub-second
timestamp data, you cannot log points to a Data or Group table at sub-second rates.
Attempting to do so will cause the duplicate-keyed records to be dropped from the
database.
27-16 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Database-Disconnect-Recovery
If the Database Logger loses its connection to a 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
Data to be saved locally then forwarded to the database when the reconnection is
made.
Using Reconnect Wait Period
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.
Note: The DB_CONN_DOWN alarm is not stacked by default, but you can change it in
Alarm Configuration.
Using Store and Forward
The Store and Forward feature is available for supported 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.
GFK-1180J Managing Database Logging 27-17
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.
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.
Important: Store and Forward is supported only for local Microsoft Access databases,
not remote Access databases.
Store and Forward Enabled
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.
27-18 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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:
<prcnam>_<dbmsid>_<date>_<time>.sql
Where
<prcnam> is process name
Exampl e
For point logging (group and data logs), the process name is MAC_PTDL.
For alarm logging, the process name is MAC_DL
<dbms_id> is the database's DBMS ID,
<date> is the date and
<time> is the time the file was created.
Exampl e
MAC_PTDL_$PTLOG_20000913_174548.SQL
How Maximum Number of Records Works
Once the maximum number of records have been stored, the Database Logger will not
store any more records until it can forward some of the currently stored records.
For example, you configure Store and Forward for a maximum of five records.
After the Database Logger loses its connection to the database, it stores five
records and logs the "Number of stored records exceeded" message to the Status
Log:
The Database Logger then reconnects to the database and is able to forward
three of the stored records before it loses its connection again.
The Database Logger will now store three records and log the "Number of
stored records exceeded" message to the Status Log:
If the Database Logger is shut down, and there are still records in the storage files, when
the Database logger restarts, these records are not counted against the maximum. Under
these conditions, you can have more than the maximum number of records stored to disk.
Note: You specify the maximum number of stored records on the Connection tabs in the
Database Logger Logging Properties dialog box.
GFK-1180J Managing Database Logging 27-19
Procedure to Change 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 project's 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.
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.
GFK-1180J 28-1
Client Configuration
About Client Configuration
The Client Configuration utility enables you 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 for specified users.
Use the Windows Logon Username as the default user for logging in to a
CIMPLICITY HMI project.
Only have access for an associated CIMPLICITY HMI User ID if it has the
correct Authorization Code.
Creating a New Client
When you create a new client you simply enter a client name in the New Client dialog
box.
To open the New Client dialog box:
1. Expand the Security folder in the Workbench left pane.
2. Expand the Advanced folder.
Method 1
Double-click the Client icon in the Workbench.
Method 2
1. Right click the Client icon.
2. Select New from the Popup menu.
Method 3
1. Click File on the Workbench menu bar.
2. Select New.
Method 4
1. Select the Client icon.
2. Press Ctrl+N on the keyboard.
Result: The New Client dialog box opens when you use any of thse methods.
28-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Continue
1. Enter the name of the computer for the new client.
2. Select OK.
Result: The Client Properties dialog box opens.
GFK-1180J Client Configuration 28-3
Configuring Client Properties
CIMPLICITY HMI provides you with several options for configuring client properties
that enable you to restrict access from a client location.
Follow the procedures for these steps to configure client properties.
Step 1: Open a Node ID's Client Properties dialog box.
Step 2: Specify automatic access capability based on User Identification.
Step 3: (Optional) Enter a unique client Authorization Code.
Step 4: Close the Client Properties dialog box.
Step 1. Open a Node ID's Client Properties dialog box:
1. Expand the Security folder in the Workbench left pane.
2. Expand the Advanced folder.
3. Select the Client icon.
4. Open a Node Id's Client Properties dialog box using any of the following
methods.
Method 1
Double click a selected Node Id.
Method 2
A. Right click a Node ID.
B. Select Properties from the popup menu.
Method 3
A. Select a Node ID.
B. Press Alt+Enter on the keyboard.
Result: The Client Properties dialog box opens when you use any method.
28-4 CIMPLICITY User's ManualDecember 2000 GFK-1180J
Step 2: Specify automatic access capability based on User Identification.
Choose one of the following four cominations of Default User Id field entries and
Trusted check box selection to control client access based on user identification.
Option In the Default User ID field Trusted Check Box Client Access
1. Enter a User ID from the list of
users available for the project.
Leave it unchecked Users from the Client
computer with the default
User ID are automatically
logged in.
2. Leave it blank. Check it Users whose Windows
Logon Username match
any CIMPLICITY User ID
in the project are
automatically logged in. All
other users have to enter a
User ID and Password (if
required) in the
CIMPLICITY Login dialog
box.
3. Enter a User ID from the list of
users available for the project.
Check it Users whose Windows
Logon Username match the
specified CIMPLICITY
User ID in the project are
automatically logged in
with that User ID. All other
users have to enter a User
ID and Password (if
required) in the
CIMPLICITY Login dialog
box.
4. Leave it blank. Leave it unchecked All users from the Client
computer have to manually
log into CIMPLICITY
HMI.
Tip: 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 click the Popup button that provides you with the options to create a
new user or browse for an existing user.
GFK-1180J Client Configuration 28-5
Step 3: (Optional) Enter a unique client Authorization Code:
1. Run the CIMPLICITY HMI Genauthcode application on the client to find its
unique Authorization Code.
a. Open a DOS window on the client PC.
b. Type genauthcode at the prompt.
The PC's authorization code
Type genauthcode.
c. Record the Authorization Code that appears.
2. Enter the code in the Authorization Code field on the server.
Result: Only the PC with the entered Authorization Code will automatically be
logged in with the User ID and/or Trusted specifications.
Note: Genauthcode requires adminstrative privileges on Windows NT.
Step 4: Close the Client Properties dialog box:
Either:
Click OK to close the Client Properties dialog box and create the new client
properties,
Or
click Cancel to close the dialog box without creating the new client properties.
GFK-1180J 29-1
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 project's
Workbench.
To open the CIMPLICITY Control Workbench, just double-click or open the
CIMPLICITY Control icon.
29-2 CIMPLICITY User's ManualDecember 2000 GFK-1180J
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.
GFK-1180J Using CIMPLICITY HMI with CIMPLICITY Control 29-3
Import Options
You can select various options that customize the import of points from Control.
You can customize the following:
Point ID Pr